@@ -13,12 +13,12 @@ Found a bug?
13Bug reports are welcome! Please report all bugs on pandoc's github
13Bug reports are welcome! Please report all bugs on pandoc's github
14[issue tracker].
14[issue tracker].
16−Before you submit a bug report, search the (open *and* closed) issues to make
16+Before you submit a bug report, search the [open issues] *and* [closed issues]
17−sure the issue hasn't come up before. Also, check the [User's Guide] and [FAQs]
17+to make sure the issue hasn't come up before. Also, check the [User's Guide] and
18−for anything relevant.
18+[FAQs] for anything relevant.
20−Make sure you can reproduce the bug with the latest released version of pandoc
20+Make sure you can reproduce the bug with the [latest released version] of pandoc
21−(or, even better, the development version).
21+(or, even better, the [development version]).
23Your report should give detailed, *reproducible* instructions, including
23Your report should give detailed, *reproducible* instructions, including
@@ -37,25 +37,25 @@ Out of scope?
37A less than perfect conversion does not necessarily mean there's
37A less than perfect conversion does not necessarily mean there's
38a bug in pandoc. Quoting from the MANUAL:
38a bug in pandoc. Quoting from the MANUAL:
40−> Because Pandoc's intermediate representation of a document is less
40+> Because pandoc's intermediate representation of a document is less
41> expressive than many of the formats it converts between, one should
41> expressive than many of the formats it converts between, one should
42> not expect perfect conversions between every format and every other.
42> not expect perfect conversions between every format and every other.
43> Pandoc attempts to preserve the structural elements of a document, but
43> Pandoc attempts to preserve the structural elements of a document, but
44> not formatting details such as margin size. And some document elements,
44> not formatting details such as margin size. And some document elements,
45−> such as complex tables, may not fit into Pandoc's simple document
45+> such as complex tables, may not fit into pandoc's simple document
46−> model. While conversions from Pandoc's Markdown to all formats aspire
46+> model. While conversions from pandoc's Markdown to all formats aspire
47−> to be perfect, conversions from formats more expressive than Pandoc's
47+> to be perfect, conversions from formats more expressive than pandoc's
48> Markdown can be expected to be lossy.
48> Markdown can be expected to be lossy.
50−For example, both docx and odt can represent margin size, but because
50+For example, both `docx` and `odt` formats can represent margin size, but
51−pandoc's internal document model does not contain a representation of
51+because pandoc's internal document model does not contain a representation of
52margin size, this information will be lost on converting from docx
52margin size, this information will be lost on converting from docx
53−to odt. (You can, however, customize margin size using `--reference-odt`.)
53+to `odt`. (You can, however, customize margin size using `--reference-doc`.)
55So before submitting a bug report, consider whether it might be
55So before submitting a bug report, consider whether it might be
56−"out of scope." If it concerns a feature of documents that isn't
56+"out of scope." If it concerns a feature of documents that isn't
57representable in pandoc's Markdown, then it very likely is.
57representable in pandoc's Markdown, then it very likely is.
58−(If in doubt, you can always ask on pandoc-discuss.)
58+(If in doubt, you can always ask on [pandoc-discuss].)
60Fixing bugs from the issue tracker
60Fixing bugs from the issue tracker
61----------------------------------
61----------------------------------
@@ -63,7 +63,7 @@ Fixing bugs from the issue tracker
63Almost all the bugs on the issue tracker have one or more associated
63Almost all the bugs on the issue tracker have one or more associated
64tags. These are used to indicate the *complexity* and *nature* of a
64tags. These are used to indicate the *complexity* and *nature* of a
65bug. There is not yet a way to indicate priority. An up to date
65bug. There is not yet a way to indicate priority. An up to date
66−summary of issues can be found [here](https://github.com/jgm/pandoc/labels).
66+summary of issues can be found on [GitHub labels].
68* [beginner-friendly] — The perfect starting point for new contributors. The
68* [beginner-friendly] — The perfect starting point for new contributors. The
69 issue is generic and can be resolved without deep knowledge of the code
69 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].
92Have an idea for a new feature?
92Have an idea for a new feature?
93-------------------------------
93-------------------------------
95−First, search [pandoc-discuss] and the issue tracker (both open and closed
95+First, search [pandoc-discuss] and the issue tracker (both [open issues] *and*
96−issues) to make sure that the idea has not been discussed before.
96+[closed issues]) to make sure that the idea has not been discussed before.
98Explain the rationale for the feature you're requesting. Why would this
98Explain the rationale for the feature you're requesting. Why would this
99feature be useful? Consider also any possible drawbacks, including backwards
99feature be useful? Consider also any possible drawbacks, including backwards
@@ -136,7 +136,7 @@ Please follow these guidelines:
136 below under [Tests](#tests).) If you are adding a new writer or reader,
136 below under [Tests](#tests).) If you are adding a new writer or reader,
137 you must include tests.
137 you must include tests.
139−7. If you are adding a new feature, include updates to MANUAL.txt.
139+7. If you are adding a new feature, include updates to `MANUAL.txt`.
1418. All code must be released under the general license governing pandoc
1418. All code must be released under the general license governing pandoc
142 (GPL v2).
142 (GPL v2).
@@ -146,7 +146,7 @@ Please follow these guidelines:
14710. We aim for compatibility with ghc versions from 7.8.3 to the
14710. We aim for compatibility with ghc versions from 7.8.3 to the
148 latest release. All pull requests and commits are tested
148 latest release. All pull requests and commits are tested
149− automatically on travis-ci.org, using GHC versions in the
149+ automatically on <travis-ci.org>, using GHC versions in the
150 `Tested-With` stanza of `pandoc.cabal`. We currently relax
150 `Tested-With` stanza of `pandoc.cabal`. We currently relax
151 the "`-Wall` clean" requirement for GHC 7.10.x, because
151 the "`-Wall` clean" requirement for GHC 7.10.x, because
152 there are so many warnings relating to the addition of type
152 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
197We recommend using the following `.ghci` file (which can be
197We recommend using the following `.ghci` file (which can be
198placed in the source directory):
198placed in the source directory):
201−:set -fobject-code
200+ :set -fobject-code
202−:set -XTypeSynonymInstances
201+ :set -XTypeSynonymInstances
203−:set -XScopedTypeVariables
202+ :set -XScopedTypeVariables
204−:set -XOverloadedStrings
203+ :set -XOverloadedStrings
@@ -252,7 +250,7 @@ the pandoc library is in `src/`, the source for the tests is in
253The modules `Text.Pandoc.Definition`, `Text.Pandoc.Builder`, and
251The modules `Text.Pandoc.Definition`, `Text.Pandoc.Builder`, and
254`Text.Pandoc.Generic` are in a separate library `pandoc-types`. The code can
252`Text.Pandoc.Generic` are in a separate library `pandoc-types`. The code can
255−be found in a <http://github.com/jgm/pandoc-types>.
253+be found in <http://github.com/jgm/pandoc-types>.
257To build pandoc, you will need a working installation of the
255To build pandoc, you will need a working installation of the
258[Haskell platform].
256[Haskell platform].
@@ -304,6 +302,10 @@ The library is structured as follows:
304 - `Text.Pandoc.UUID` contains functions for generating UUIDs.
302 - `Text.Pandoc.UUID` contains functions for generating UUIDs.
305 - `Text.Pandoc.XML` contains functions for formatting XML.
303 - `Text.Pandoc.XML` contains functions for formatting XML.
305+[open issues]: https://github.com/jgm/pandoc/issues
306+[closed issues]: https://github.com/jgm/pandoc/issues?q=is%3Aissue+is%3Aclosed
307+[latest released version]: https://github.com/jgm/pandoc/releases/latest
308+[development version]: https://github.com/pandoc-extras/pandoc-nightly/releases/latest
307[pandoc-discuss]: http://groups.google.com/group/pandoc-discuss
309[pandoc-discuss]: http://groups.google.com/group/pandoc-discuss
308[issue tracker]: https://github.com/jgm/pandoc/issues
310[issue tracker]: https://github.com/jgm/pandoc/issues
309[User's Guide]: http://pandoc.org/MANUAL.html
311[User's Guide]: http://pandoc.org/MANUAL.html
@@ -311,6 +313,7 @@ The library is structured as follows:
311[EditorConfig]: http://editorconfig.org/
313[EditorConfig]: http://editorconfig.org/
312[Haskell platform]: http://www.haskell.org/platform/
314[Haskell platform]: http://www.haskell.org/platform/
313[hsb2hs]: http://hackage.haskell.org/package/hsb2hs
315[hsb2hs]: http://hackage.haskell.org/package/hsb2hs
316+[GitHub labels]: https://github.com/jgm/pandoc/labels
314[beginner-friendly]: https://github.com/jgm/pandoc/labels/beginner-friendly
317[beginner-friendly]: https://github.com/jgm/pandoc/labels/beginner-friendly
315[enhancement]: https://github.com/jgm/pandoc/labels/enhancement
318[enhancement]: https://github.com/jgm/pandoc/labels/enhancement
316[bug]: https://github.com/jgm/pandoc/labels/bug
319[bug]: https://github.com/jgm/pandoc/labels/bug