aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--.editorconfig2
-rw-r--r--CONTRIBUTING.md55
-rw-r--r--COPYRIGHT2
-rw-r--r--MANUAL.txt4
-rw-r--r--Setup.hs2
-rw-r--r--benchmark/benchmark-pandoc.hs2
-rw-r--r--doc/filters.md6
-rw-r--r--doc/using-the-pandoc-api.md2
-rw-r--r--linux/control.in2
-rw-r--r--man/pandoc.12
-rw-r--r--pandoc.cabal2
-rw-r--r--pandoc.hs4
-rw-r--r--src/Text/Pandoc/Lua/Util.hs2
-rw-r--r--src/Text/Pandoc/Readers/CommonMark.hs4
-rw-r--r--src/Text/Pandoc/Writers/CommonMark.hs4
15 files changed, 50 insertions, 45 deletions
diff --git a/.editorconfig b/.editorconfig
index 5f40572b0..4eaaa8c44 100644
--- a/.editorconfig
+++ b/.editorconfig
@@ -11,6 +11,6 @@ trim_trailing_whitespace = true
[*.{markdown,md}]
trim_trailing_whitespace = false
-[tests/*]
+[test/*]
insert_final_newline = false
trim_trailing_whitespace = false
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index e4eb1852a..c104c7381 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -13,12 +13,12 @@ Found a bug?
Bug reports are welcome! Please report all bugs on pandoc's github
[issue tracker].
-Before you submit a bug report, search the (open *and* closed) issues to make
-sure the issue hasn't come up before. Also, check the [User's Guide] and [FAQs]
-for anything relevant.
+Before you submit a bug report, search the [open issues] *and* [closed issues]
+to make sure the issue hasn't come up before. Also, check the [User's Guide] and
+[FAQs] for anything relevant.
-Make sure you can reproduce the bug with the latest released version of pandoc
-(or, even better, the development version).
+Make sure you can reproduce the bug with the [latest released version] of pandoc
+(or, even better, the [development version]).
Your report should give detailed, *reproducible* instructions, including
@@ -37,25 +37,25 @@ Out of scope?
A less than perfect conversion does not necessarily mean there's
a bug in pandoc. Quoting from the MANUAL:
-> Because Pandoc's intermediate representation of a document is less
+> Because pandoc's intermediate representation of a document is less
> expressive than many of the formats it converts between, one should
> not expect perfect conversions between every format and every other.
> Pandoc attempts to preserve the structural elements of a document, but
> not formatting details such as margin size. And some document elements,
-> such as complex tables, may not fit into Pandoc's simple document
-> model. While conversions from Pandoc's Markdown to all formats aspire
-> to be perfect, conversions from formats more expressive than Pandoc's
+> such as complex tables, may not fit into pandoc's simple document
+> model. While conversions from pandoc's Markdown to all formats aspire
+> to be perfect, conversions from formats more expressive than pandoc's
> Markdown can be expected to be lossy.
-For example, both docx and odt can represent margin size, but because
-pandoc's internal document model does not contain a representation of
+For example, both `docx` and `odt` formats can represent margin size, but
+because pandoc's internal document model does not contain a representation of
margin size, this information will be lost on converting from docx
-to odt. (You can, however, customize margin size using `--reference-odt`.)
+to `odt`. (You can, however, customize margin size using `--reference-doc`.)
So before submitting a bug report, consider whether it might be
-"out of scope." If it concerns a feature of documents that isn't
+"out of scope." If it concerns a feature of documents that isn't
representable in pandoc's Markdown, then it very likely is.
-(If in doubt, you can always ask on pandoc-discuss.)
+(If in doubt, you can always ask on [pandoc-discuss].)
Fixing bugs from the issue tracker
----------------------------------
@@ -63,7 +63,7 @@ Fixing bugs from the issue tracker
Almost all the bugs on the issue tracker have one or more associated
tags. These are used to indicate the *complexity* and *nature* of a
bug. There is not yet a way to indicate priority. An up to date
-summary of issues can be found [here](https://github.com/jgm/pandoc/labels).
+summary of issues can be found on [GitHub labels].
* [beginner-friendly] — The perfect starting point for new contributors. The
issue is generic and can be resolved without deep knowledge of the code
@@ -92,8 +92,8 @@ or bug reports related to Markdown are labelled with [format:markdown].
Have an idea for a new feature?
-------------------------------
-First, search [pandoc-discuss] and the issue tracker (both open and closed
-issues) to make sure that the idea has not been discussed before.
+First, search [pandoc-discuss] and the issue tracker (both [open issues] *and*
+[closed issues]) to make sure that the idea has not been discussed before.
Explain the rationale for the feature you're requesting. Why would this
feature be useful? Consider also any possible drawbacks, including backwards
@@ -136,7 +136,7 @@ Please follow these guidelines:
below under [Tests](#tests).) If you are adding a new writer or reader,
you must include tests.
-7. If you are adding a new feature, include updates to MANUAL.txt.
+7. If you are adding a new feature, include updates to `MANUAL.txt`.
8. All code must be released under the general license governing pandoc
(GPL v2).
@@ -146,7 +146,7 @@ Please follow these guidelines:
10. We aim for compatibility with ghc versions from 7.8.3 to the
latest release. All pull requests and commits are tested
- automatically on travis-ci.org, using GHC versions in the
+ automatically on <travis-ci.org>, using GHC versions in the
`Tested-With` stanza of `pandoc.cabal`. We currently relax
the "`-Wall` clean" requirement for GHC 7.10.x, because
there are so many warnings relating to the addition of type
@@ -197,12 +197,10 @@ a ghci REPL for working with pandoc. With [stack], use
We recommend using the following `.ghci` file (which can be
placed in the source directory):
-```
-:set -fobject-code
-:set -XTypeSynonymInstances
-:set -XScopedTypeVariables
-:set -XOverloadedStrings
-```
+ :set -fobject-code
+ :set -XTypeSynonymInstances
+ :set -XScopedTypeVariables
+ :set -XOverloadedStrings
Profiling
---------
@@ -252,7 +250,7 @@ the pandoc library is in `src/`, the source for the tests is in
The modules `Text.Pandoc.Definition`, `Text.Pandoc.Builder`, and
`Text.Pandoc.Generic` are in a separate library `pandoc-types`. The code can
-be found in a <http://github.com/jgm/pandoc-types>.
+be found in <http://github.com/jgm/pandoc-types>.
To build pandoc, you will need a working installation of the
[Haskell platform].
@@ -304,6 +302,10 @@ The library is structured as follows:
- `Text.Pandoc.UUID` contains functions for generating UUIDs.
- `Text.Pandoc.XML` contains functions for formatting XML.
+[open issues]: https://github.com/jgm/pandoc/issues
+[closed issues]: https://github.com/jgm/pandoc/issues?q=is%3Aissue+is%3Aclosed
+[latest released version]: https://github.com/jgm/pandoc/releases/latest
+[development version]: https://github.com/pandoc-extras/pandoc-nightly/releases/latest
[pandoc-discuss]: http://groups.google.com/group/pandoc-discuss
[issue tracker]: https://github.com/jgm/pandoc/issues
[User's Guide]: http://pandoc.org/MANUAL.html
@@ -311,6 +313,7 @@ The library is structured as follows:
[EditorConfig]: http://editorconfig.org/
[Haskell platform]: http://www.haskell.org/platform/
[hsb2hs]: http://hackage.haskell.org/package/hsb2hs
+[GitHub labels]: https://github.com/jgm/pandoc/labels
[beginner-friendly]: https://github.com/jgm/pandoc/labels/beginner-friendly
[enhancement]: https://github.com/jgm/pandoc/labels/enhancement
[bug]: https://github.com/jgm/pandoc/labels/bug
diff --git a/COPYRIGHT b/COPYRIGHT
index cef0b8b5c..10e33ebaf 100644
--- a/COPYRIGHT
+++ b/COPYRIGHT
@@ -146,7 +146,7 @@ Copyright (C) 2017 Albert Krewinkel
Released under the GNU General Public License version 2 or later.
----------------------------------------------------------------------
-The dzslides template contains javascript and CSS from Paul Rouget's
+The dzslides template contains JavaScript and CSS from Paul Rouget's
dzslides template.
http://github.com/paulrouget/dzslides
diff --git a/MANUAL.txt b/MANUAL.txt
index 204543f67..d90d9583c 100644
--- a/MANUAL.txt
+++ b/MANUAL.txt
@@ -470,7 +470,7 @@ Reader options
Those who would prefer to write filters in python can use the
module [`pandocfilters`], installable from PyPI. There are also
pandoc filter libraries in [PHP], [perl], and
- [javascript/node.js].
+ [JavaScript/node.js].
In order of preference, pandoc will look for filters in
@@ -571,7 +571,7 @@ Reader options
[`pandocfilters`]: https://github.com/jgm/pandocfilters
[PHP]: https://github.com/vinai/pandocfilters-php
[perl]: https://metacpan.org/pod/Pandoc::Filter
-[javascript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
+[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
General writer options
----------------------
diff --git a/Setup.hs b/Setup.hs
index 1f9e45bfe..1df0c94f1 100644
--- a/Setup.hs
+++ b/Setup.hs
@@ -1,5 +1,5 @@
{-
-Copyright (C) 2006-2015 John MacFarlane <jgm@berkeley.edu>
+Copyright (C) 2006-2017 John MacFarlane <jgm@berkeley.edu>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
diff --git a/benchmark/benchmark-pandoc.hs b/benchmark/benchmark-pandoc.hs
index 6a749be30..d9347c539 100644
--- a/benchmark/benchmark-pandoc.hs
+++ b/benchmark/benchmark-pandoc.hs
@@ -1,5 +1,5 @@
{-
-Copyright (C) 2012-2014 John MacFarlane <jgm@berkeley.edu>
+Copyright (C) 2012-2017 John MacFarlane <jgm@berkeley.edu>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
diff --git a/doc/filters.md b/doc/filters.md
index 0c9b77328..f4c14c009 100644
--- a/doc/filters.md
+++ b/doc/filters.md
@@ -313,8 +313,10 @@ For a more Pythonic alternative to pandocfilters, see
the [panflute](http://scorreia.com/software/panflute/) library.
Don't like Python? There are also ports of pandocfilters in
[PHP](https://github.com/vinai/pandocfilters-php),
-[perl](https://metacpan.org/pod/Pandoc::Filter), and
-[javascript/node.js](https://github.com/mvhenderson/pandoc-filter-node).]
+[perl](https://metacpan.org/pod/Pandoc::Filter),
+[javascript/node.js](https://github.com/mvhenderson/pandoc-filter-node),
+[Groovy](https://github.com/dfrommi/groovy-pandoc), and
+[Ruby](https://heerdebeer.org/Software/markdown/paru/).
Starting with pandoc 2.0, pandoc includes built-in support for
writing filters in lua. The lua interpreter is built in to
diff --git a/doc/using-the-pandoc-api.md b/doc/using-the-pandoc-api.md
index 8eb34d091..a09cc81aa 100644
--- a/doc/using-the-pandoc-api.md
+++ b/doc/using-the-pandoc-api.md
@@ -21,7 +21,7 @@ Pictorially:
[input format] ==reader==> [Pandoc AST] ==writer==> [output format]
```
-This architecture allows pandoc to perform $M \times n$
+This architecture allows pandoc to perform $M \times N$
conversions with $M$ readers and $N$ writers.
The Pandoc AST is defined in the
diff --git a/linux/control.in b/linux/control.in
index 2bd61caff..de0be6c58 100644
--- a/linux/control.in
+++ b/linux/control.in
@@ -22,5 +22,5 @@ Description: general markup converter
MediaWiki, DokuWiki, ZimWiki, Textile, groff man, groff
ms, plain text, Emacs Org-Mode, AsciiDoc, Haddock markup,
EPUB (v2 and v3), FictionBook2, InDesign ICML, Muse, and
- several kinds of HTML/javascript slide shows (S5, Slidy,
+ several kinds of HTML/JavaScript slide shows (S5, Slidy,
Slideous, DZSlides, reveal.js).
diff --git a/man/pandoc.1 b/man/pandoc.1
index 25f42da8f..20ca79b1f 100644
--- a/man/pandoc.1
+++ b/man/pandoc.1
@@ -485,7 +485,7 @@ writing filters in Haskell.
Those who would prefer to write filters in python can use the module
\f[C]pandocfilters\f[], installable from PyPI.
There are also pandoc filter libraries in PHP, perl, and
-javascript/node.js.
+JavaScript/node.js.
.PP
In order of preference, pandoc will look for filters in
.IP "1." 3
diff --git a/pandoc.cabal b/pandoc.cabal
index 77e484949..4bddc7d40 100644
--- a/pandoc.cabal
+++ b/pandoc.cabal
@@ -25,7 +25,7 @@ description: Pandoc is a Haskell library for converting from one markup
RTF, MediaWiki, DokuWiki, ZimWiki, Textile, groff man,
groff ms, plain text, Emacs Org-Mode, AsciiDoc,
Haddock markup, EPUB (v2 and v3), FictionBook2, InDesign
- ICML, Muse, and several kinds of HTML/javascript slide
+ ICML, Muse, and several kinds of HTML/JavaScript slide
shows (S5, Slidy, Slideous, DZSlides, reveal.js).
.
In contrast to most existing tools for converting Markdown
diff --git a/pandoc.hs b/pandoc.hs
index 7b749229c..ad0e914be 100644
--- a/pandoc.hs
+++ b/pandoc.hs
@@ -3,7 +3,7 @@
{-# LANGUAGE ScopedTypeVariables #-}
{-# LANGUAGE TupleSections #-}
{-
-Copyright (C) 2006-2016 John MacFarlane <jgm@berkeley.edu>
+Copyright (C) 2006-2017 John MacFarlane <jgm@berkeley.edu>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
@@ -22,7 +22,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
{- |
Module : Main
- Copyright : Copyright (C) 2006-2016 John MacFarlane
+ Copyright : Copyright (C) 2006-2017 John MacFarlane
License : GNU GPL, version 2 or above
Maintainer : John MacFarlane <jgm@berkeley@edu>
diff --git a/src/Text/Pandoc/Lua/Util.hs b/src/Text/Pandoc/Lua/Util.hs
index 1b6338e64..6b1d51159 100644
--- a/src/Text/Pandoc/Lua/Util.hs
+++ b/src/Text/Pandoc/Lua/Util.hs
@@ -19,7 +19,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
{-# LANGUAGE FlexibleInstances #-}
{- |
Module : Text.Pandoc.Lua.Util
- Copyright : © 2012–2016 John MacFarlane,
+ Copyright : © 2012–2017 John MacFarlane,
© 2017 Albert Krewinkel
License : GNU GPL, version 2 or above
diff --git a/src/Text/Pandoc/Readers/CommonMark.hs b/src/Text/Pandoc/Readers/CommonMark.hs
index 2dba18c9f..62a7f4119 100644
--- a/src/Text/Pandoc/Readers/CommonMark.hs
+++ b/src/Text/Pandoc/Readers/CommonMark.hs
@@ -1,5 +1,5 @@
{-
-Copyright (C) 2015 John MacFarlane <jgm@berkeley.edu>
+Copyright (C) 2015-2017 John MacFarlane <jgm@berkeley.edu>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
@@ -18,7 +18,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
{- |
Module : Text.Pandoc.Readers.CommonMark
- Copyright : Copyright (C) 2015 John MacFarlane
+ Copyright : Copyright (C) 2015-2017 John MacFarlane
License : GNU GPL, version 2 or above
Maintainer : John MacFarlane <jgm@berkeley.edu>
diff --git a/src/Text/Pandoc/Writers/CommonMark.hs b/src/Text/Pandoc/Writers/CommonMark.hs
index 7ea76a373..9dc7158fe 100644
--- a/src/Text/Pandoc/Writers/CommonMark.hs
+++ b/src/Text/Pandoc/Writers/CommonMark.hs
@@ -1,6 +1,6 @@
{-# LANGUAGE OverloadedStrings #-}
{-
-Copyright (C) 2015 John MacFarlane <jgm@berkeley.edu>
+Copyright (C) 2015-2017 John MacFarlane <jgm@berkeley.edu>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
@@ -19,7 +19,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
{- |
Module : Text.Pandoc.Writers.CommonMark
- Copyright : Copyright (C) 2015 John MacFarlane
+ Copyright : Copyright (C) 2015-2017 John MacFarlane
License : GNU GPL, version 2 or above
Maintainer : John MacFarlane <jgm@berkeley.edu>
generated by cgit v1.2.3 (git 2.39.1) at 2024-09-19 06:54:23 +0000