@@ -13,12 +13,12 @@ Found a bug?
1313Bug reports are welcome! Please report all bugs on pandoc's github
1414[issue tracker].
1515
16−Before you submit a bug report, search the (open *and* closed) issues to make
17−sure the issue hasn't come up before. Also, check the [User's Guide] and [FAQs]
18−for anything relevant.
16+Before you submit a bug report, search the [open issues] *and* [closed issues]
17+to make sure the issue hasn't come up before. Also, check the [User's Guide] and
18+[FAQs] for anything relevant.
1919
20−Make sure you can reproduce the bug with the latest released version of pandoc
21−(or, even better, the development version).
20+Make sure you can reproduce the bug with the [latest released version] of pandoc
21+(or, even better, the [development version]).
2222
2323Your report should give detailed, *reproducible* instructions, including
2424
@@ -37,25 +37,25 @@ Out of scope?
3737A less than perfect conversion does not necessarily mean there's
3838a bug in pandoc. Quoting from the MANUAL:
3939
40−> Because Pandoc's intermediate representation of a document is less
40+> Because pandoc's intermediate representation of a document is less
4141> expressive than many of the formats it converts between, one should
4242> not expect perfect conversions between every format and every other.
4343> Pandoc attempts to preserve the structural elements of a document, but
4444> not formatting details such as margin size. And some document elements,
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
47−> to be perfect, conversions from formats more expressive than Pandoc's
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
47+> to be perfect, conversions from formats more expressive than pandoc's
4848> Markdown can be expected to be lossy.
4949
50−For example, both docx and odt can represent margin size, but because
51−pandoc's internal document model does not contain a representation of
50+For example, both `docx` and `odt` formats can represent margin size, but
51+because pandoc's internal document model does not contain a representation of
5252margin 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`.)
5454
5555So 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
5757representable 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].)
5959
6060Fixing bugs from the issue tracker
6161----------------------------------
@@ -63,7 +63,7 @@ Fixing bugs from the issue tracker
6363Almost all the bugs on the issue tracker have one or more associated
6464tags. These are used to indicate the *complexity* and *nature* of a
6565bug. 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].
6767
6868* [beginner-friendly] — The perfect starting point for new contributors. The
6969 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].
9292Have an idea for a new feature?
9393-------------------------------
9494
95−First, search [pandoc-discuss] and the issue tracker (both open and closed
96−issues) to make sure that the idea has not been discussed before.
95+First, search [pandoc-discuss] and the issue tracker (both [open issues] *and*
96+[closed issues]) to make sure that the idea has not been discussed before.
9797
9898Explain the rationale for the feature you're requesting. Why would this
9999feature be useful? Consider also any possible drawbacks, including backwards
@@ -136,7 +136,7 @@ Please follow these guidelines:
136136 below under [Tests](#tests).) If you are adding a new writer or reader,
137137 you must include tests.
138138
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`.
140140
1411418. All code must be released under the general license governing pandoc
142142 (GPL v2).
@@ -146,7 +146,7 @@ Please follow these guidelines:
146146
14714710. We aim for compatibility with ghc versions from 7.8.3 to the
148148 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
150150 `Tested-With` stanza of `pandoc.cabal`. We currently relax
151151 the "`-Wall` clean" requirement for GHC 7.10.x, because
152152 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
197197We recommend using the following `.ghci` file (which can be
198198placed in the source directory):
199199
200−```
201−:set -fobject-code
202−:set -XTypeSynonymInstances
203−:set -XScopedTypeVariables
204−:set -XOverloadedStrings
205−```
200+ :set -fobject-code
201+ :set -XTypeSynonymInstances
202+ :set -XScopedTypeVariables
203+ :set -XOverloadedStrings
206204
207205Profiling
208206---------
@@ -252,7 +250,7 @@ the pandoc library is in `src/`, the source for the tests is in
252250
253251The modules `Text.Pandoc.Definition`, `Text.Pandoc.Builder`, and
254252`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>.
256254
257255To build pandoc, you will need a working installation of the
258256[Haskell platform].
@@ -304,6 +302,10 @@ The library is structured as follows:
304302 - `Text.Pandoc.UUID` contains functions for generating UUIDs.
305303 - `Text.Pandoc.XML` contains functions for formatting XML.
306304
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
307309[pandoc-discuss]: http://groups.google.com/group/pandoc-discuss
308310[issue tracker]: https://github.com/jgm/pandoc/issues
309311[User's Guide]: http://pandoc.org/MANUAL.html
@@ -311,6 +313,7 @@ The library is structured as follows:
311313[EditorConfig]: http://editorconfig.org/
312314[Haskell platform]: http://www.haskell.org/platform/
313315[hsb2hs]: http://hackage.haskell.org/package/hsb2hs
316+[GitHub labels]: https://github.com/jgm/pandoc/labels
314317[beginner-friendly]: https://github.com/jgm/pandoc/labels/beginner-friendly
315318[enhancement]: https://github.com/jgm/pandoc/labels/enhancement
316319[bug]: https://github.com/jgm/pandoc/labels/bug