7Ask on [pandoc-discuss].
13Bug reports are welcome! Please report all bugs on pandoc's github
16Before you submit a bug report, search the [open issues] *and* [closed issues]
17to make sure the issue hasn't come up before. Also, check the [User's Guide] and
18[FAQs] for anything relevant.
20Make sure you can reproduce the bug with the [latest released version] of pandoc
21(or, even better, the [development version]).
23Your report should give detailed, *reproducible* instructions, including
25 * the pandoc version (check using `pandoc -v`)
26 * the exact command line used
27 * the exact input used
29 * the output you expected instead
31A small test case (just a few lines) is ideal. If your input is large,
32try to whittle it down to a *minimum working example*.
37A less than perfect conversion does not necessarily mean there's
38a bug in pandoc. Quoting from the MANUAL:
40> Because pandoc's intermediate representation of a document is less
41> expressive than many of the formats it converts between, one should
42> not expect perfect conversions between every format and every other.
43> Pandoc attempts to preserve the structural elements of a document, but
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
46> model. While conversions from pandoc's Markdown to all formats aspire
47> to be perfect, conversions from formats more expressive than pandoc's
48> Markdown can be expected to be lossy.
50For example, both `docx` and `odt` formats can represent margin size, but
51because pandoc's internal document model does not contain a representation of
52margin size, this information will be lost on converting from docx
53to `odt`. (You can, however, customize margin size using `--reference-doc`.)
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
57representable in pandoc's Markdown, then it very likely is.
58(If in doubt, you can always ask on [pandoc-discuss].)
60Fixing bugs from the issue tracker
61----------------------------------
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
65bug. There is not yet a way to indicate priority. An up to date
66summary of issues can be found on [GitHub labels].
68* [good first issue] — The perfect starting point for new contributors. The
69 issue is generic and can be resolved without deep knowledge of the code
71* [enhancement] — A feature which would be desirable. We recommend
72 you discuss any proposed enhancement on pandoc-discuss before
74* [bug] — A problem which needs to be fixed.
75* [complexity:low] — The fix should only be a couple of lines.
76* [complexity:high] — The fix might require structural changes or in depth
77 knowledge of the code base.
78* [new:reader] — A request to add a new input format.
79* [new:writer] — A request to add a new output format.
80* [docs] — A discrepancy, or ambiguity in the documentation.
81* [status:in-progress] — Someone is actively working on or planning to work on the
83* [status:more-discussion-needed] — It is unclear what the correct approach
84 to solving the ticket is. Before starting on tickets such as this it
85 would be advisable to post on the ticket.
86* [status:more-info-needed] — We require more information from a user before
87 we can classify a report properly.
89Issues related to a specific format are tagged accordingly, e.g. feature request
90or bug reports related to Markdown are labelled with [format:markdown].
92Have an idea for a new feature?
93-------------------------------
95First, 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.
98Explain the rationale for the feature you're requesting. Why would this
99feature be useful? Consider also any possible drawbacks, including backwards
100compatibility, new library dependencies, and performance issues.
102It is best to discuss a potential new feature on [pandoc-discuss]
103before opening an issue.
105Patches and pull requests
106-------------------------
108Patches and pull requests are welcome. Before you put time into a nontrivial
109patch, it is a good idea to discuss it on [pandoc-discuss], especially if it is
110for a new feature (rather than fixing a bug).
112Please follow these guidelines:
1141. Each patch (commit) should make a single logical change (fix a bug, add
115 a feature, clean up some code, add documentation). Everything
116 related to that change should be included (including tests and
117 documentation), and nothing unrelated should be included.
1192. The first line of the commit message should be a short description
120 of the whole commit (ideally <= 50 characters). Then there should
121 be a blank line, followed by a more detailed description of the
1243. Follow the stylistic conventions you find in the existing
125 pandoc code. Use spaces, not tabs, and wrap code to 80 columns.
126 Always include type signatures for top-level functions.
127 Consider installing [EditorConfig], this will help you to follow the
128 coding style prevalent in pandoc.
1304. Your code should compile without warnings (`-Wall` clean).
1325. Run the tests to make sure your code does not introduce new bugs.
133 (See below under [Tests](#tests).) All tests should pass.
1356. It is a good idea to add test cases for the bug you are fixing. (See
136 below under [Tests](#tests).) If you are adding a new writer or reader,
137 you must include tests.
1397. If you are adding a new feature, include updates to `MANUAL.txt`.
1418. All code must be released under the general license governing pandoc
1449. It is better not to introduce new dependencies. Dependencies on
145 external C libraries should especially be avoided.
14710. We aim for compatibility with ghc versions from 8.0 to the
148 latest release. All pull requests and commits are tested
149 automatically on CircleCI.
154Tests can be run as follows:
156 cabal install --only-dependencies --enable-tests
157 cabal configure --enable-tests
161or, if you're using [stack],
166The test program is `test/test-pandoc.hs`.
168To run particular tests (pattern-matching on their names), use
171 cabal install pandoc --enable-tests
172 cabal test --test-options='-p markdown'
176 stack test --test-arguments='-p markdown'
178It is often helpful to add `-j4` (run tests in parallel)
179and `--hide-successes` (don't clutter output with successes)
180to the test arguments as well.
182If you add a new feature to pandoc, please add tests as well, following
183the pattern of the existing tests. The test suite code is in
184`test/test-pandoc.hs`. If you are adding a new reader or writer, it is
185probably easiest to add some data files to the `test` directory, and
186modify `test/Tests/Old.hs`. Otherwise, it is better to modify the module
187under the `test/Tests` hierarchy corresponding to the pandoc module you
188are changing. Alternatively, you may add a "command test" to
189the `/test/command/` hierarchy, following the pattern of the tests there.
191You can rebuild the golden tests in `tests/` by passing
192`--accept` to the test script. (If you're using stack, `stack
193test --test-arguments "--accept"`; or `make TESTARGS=--accept`).
194Then check the changed golden files for accuracy, and
195commit the changes. For docx or pptx tests, open the files in Word
196or Powerpoint to ensure that they weren't corrupted and that
197they had the expected result, and mention the Word/Powerpoint
198version and OS in your commit comment.
203To run benchmarks with cabal:
205 cabal configure --enable-benchmarks
213You can also build `weigh-pandoc` (`stack build pandoc:weigh-pandoc`)
214to get some statistics on memory usage. (Eventually this should
215be incorporated into the benchmark suite.)
220With a recent version of cabal, you can do `cabal repl` and get
221a ghci REPL for working with pandoc. With [stack], use
224We recommend using the following `.ghci` file (which can be
225placed in the source directory):
228 :set -XTypeSynonymInstances
229 :set -XScopedTypeVariables
230 :set -XOverloadedStrings
235To diagnose a performance issue with parsing, first try using
236the `--trace` option. This will give you a record of when block
237parsers succeed, so you can spot backtracking issues.
239To use the GHC profiler with cabal:
242 cabal install --enable-library-profiling --enable-executable-profiling
243 pandoc +RTS -p -RTS [file]...
249 stack install --profile
250 pandoc +RTS -p -RTS [file]...
256The default templates live in `data/templates`, which is a git
257subtree linked to <https://github.com/jgm/pandoc-templates.git>.
258The purpose of maintaining a separate repository is to allow
259people to maintain variant templates as a fork.
261You can modify the templates and submit patches without worrying
262much about this: when these patches are merged, we will
263push them to the main templates repository by doing
265 git subtree push --prefix=data/templates templates master
267where `templates` is a remote pointing to the templates
273Pandoc has a publicly accessible git repository on
274github: <http://github.com/jgm/pandoc>. To get a local copy of the source:
276 git clone https://github.com/jgm/pandoc.git
278The source for the main pandoc program is `pandoc.hs`. The source for
279the pandoc library is in `src/`, the source for the tests is in
280`test/`, and the source for the benchmarks is in `benchmark/`.
282The modules `Text.Pandoc.Definition`, `Text.Pandoc.Builder`, and
283`Text.Pandoc.Generic` are in a separate library `pandoc-types`. The code can
284be found in <http://github.com/jgm/pandoc-types>.
286To build pandoc, you will need a working installation of the
289The library is structured as follows:
291 - `Text.Pandoc` is a top-level module that exports what is needed
292 by most users of the library. Any patches that add new readers
293 or writers will need to make changes here, too.
294 - `Text.Pandoc.Definition` (in `pandoc-types`) defines the types
295 used for representing a pandoc document.
296 - `Text.Pandoc.Builder` (in `pandoc-types`) provides functions for
297 building pandoc documents programmatically.
298 - `Text.Pandoc.Generics` (in `pandoc-types`) provides functions allowing
299 you to promote functions that operate on parts of pandoc documents
300 to functions that operate on whole pandoc documents, walking the
302 - `Text.Pandoc.Readers.*` are the readers, and `Text.Pandoc.Writers.*`
304 - `Text.Pandoc.Biblio` is a utility module for formatting citations
306 - `Text.Pandoc.Data` is used to embed data files when the `embed_data_files`
307 cabal flag is used. It is generated from `src/Text/Pandoc/Data.hsb` using
308 the preprocessor [hsb2hs].
309 - `Text.Pandoc.Highlighting` contains the interface to the
310 skylighting library, which is used for code syntax highlighting.
311 - `Text.Pandoc.ImageSize` is a utility module containing functions for
312 calculating image sizes from the contents of image files.
313 - `Text.Pandoc.MIME` contains functions for associating MIME types
315 - `Text.Pandoc.Options` defines reader and writer options.
316 - `Text.Pandoc.PDF` contains functions for producing a PDF from a
318 - `Text.Pandoc.Parsing` contains parsing functions used in multiple readers.
319 - `Text.Pandoc.Pretty` is a pretty-printing library specialized to
321 - `Text.Pandoc.SelfContained` contains functions for making an HTML
322 file "self-contained," by importing remotely linked images, CSS,
323 and JavaScript and turning them into `data:` URLs.
324 - `Text.Pandoc.Shared` is a grab-bag of shared utility functions.
325 - `Text.Pandoc.Writers.Shared` contains utilities used in writers only.
326 - `Text.Pandoc.Slides` contains functions for splitting a markdown document
327 into slides, using the conventions described in the MANUAL.
328 - `Text.Pandoc.Templates` defines pandoc's templating system.
329 - `Text.Pandoc.UTF8` contains functions for converting text to and from
330 UTF8 bytestrings (strict and lazy).
331 - `Text.Pandoc.Asciify` contains functions to derive ascii versions of
332 identifiers that use accented characters.
333 - `Text.Pandoc.UUID` contains functions for generating UUIDs.
334 - `Text.Pandoc.XML` contains functions for formatting XML.
339If you've written a useful pandoc [lua filter](lua-filters.html),
340you may want to consider submitting a pull request to the
341[lua-filters repository](https://github.com/pandoc/lua-filters).
343[open issues]: https://github.com/jgm/pandoc/issues
344[closed issues]: https://github.com/jgm/pandoc/issues?q=is%3Aissue+is%3Aclosed
345[latest released version]: https://github.com/jgm/pandoc/releases/latest
346[development version]: https://github.com/pandoc-extras/pandoc-nightly/releases/latest
347[pandoc-discuss]: http://groups.google.com/group/pandoc-discuss
348[issue tracker]: https://github.com/jgm/pandoc/issues
349[User's Guide]: http://pandoc.org/MANUAL.html
350[FAQs]: http://pandoc.org/faqs.html
351[EditorConfig]: http://editorconfig.org/
352[Haskell platform]: http://www.haskell.org/platform/
353[hsb2hs]: http://hackage.haskell.org/package/hsb2hs
354[GitHub labels]: https://github.com/jgm/pandoc/labels
355[good first issue]:https://github.com/jgm/pandoc/labels/good%20first%20issue
356[enhancement]: https://github.com/jgm/pandoc/labels/enhancement
357[bug]: https://github.com/jgm/pandoc/labels/bug
358[complexity:low]: https://github.com/jgm/pandoc/labels/complexity:low
359[complexity:high]: https://github.com/jgm/pandoc/labels/complexity:high
360[docs]: https://github.com/jgm/pandoc/labels/docs
361[format:markdown]: https://github.com/jgm/pandoc/labels/format:markdown
362[new:reader]: https://github.com/jgm/pandoc/labels/new:reader
363[new:writer]: https://github.com/jgm/pandoc/labels/new:writer
364[status:in-progress]: https://github.com/jgm/pandoc/labels/status:in-progress
365[status:more-discussion-needed]: https://github.com/jgm/pandoc/labels/status:more-discussion-needed
366[status:more-info-needed]: https://github.com/jgm/pandoc/labels/status:more-info-needed
367[stack]: https://github.com/commercialhaskell/stack
keysesc to close
- j k
- move down, up
- enter
- open
- esc
- back, or up a level
- 1 2 3 4
- readme, files, commits, refs
- /
- filter
- y
- copy the clone command
- c
- compare the chosen commit with another (or shift-click both)
- ?
- show or hide this list