git.iko.soy/typeable/pandoc
on master help sign in
Clarified what is "out of scope" in README and CONTRIBUTING.md.
commitf78b5a4a5a885f45a0934e436647af5d8a52c1fc authorJohn MacFarlane <jgm@berkeley.edu> dateSat 8 Aug 2015, 15:18 (11 years ago) parent2eec8cf
2 files changed+36
CONTRIBUTING.md+26 README+10
CONTRIBUTING.md+26
@@ -25,6 +25,32 @@ including
2525A small test case (just a few lines) is ideal. If your input is large,
2626try to whittle it down to the minimum necessary to illustrate the problem.
2727
28+Out of scope?
29+-------------
30+
31+A less than perfect conversion does not necessarily mean there's
32+a bug in pandoc. Quoting from the README:
33+
34+> Because Pandoc's intermediate representation of a document is less
35+> expressive than many of the formats it converts between, one should
36+> not expect perfect conversions between every format and every other.
37+> Pandoc attempts to preserve the structural elements of a document, but
38+> not formatting details such as margin size. And some document elements,
39+> such as complex tables, may not fit into Pandoc's simple document
40+> model. While conversions from Pandoc's Markdown to all formats aspire
41+> to be perfect, conversions from formats more expressive than Pandoc's
42+> Markdown can be expected to be lossy.
43+
44+For example, both docx and odt can represent margin size, but because
45+pandoc's internal document model does not contain a representation of
46+margin size, this information will be lost on converting from docx
47+to odt. (You can, however, customize margin size using `--reference-odt`.)
48+
49+So before submitting a bug report, consider whether it might be
50+"out of scope." If it concerns a feature of documents that isn't
51+representable in pandoc's Markdown, then it very likely is.
52+(If in doubt, you can always ask on pandoc-discuss.)
53+
2854Fixing bugs from the issue tracker
2955----------------------------------
3056
README+10
@@ -40,6 +40,16 @@ representation of the document, and a set of writers, which convert
4040this native representation into a target format. Thus, adding an input
4141or output format requires only adding a reader or writer.
4242
43+Because Pandoc's intermediate representation of a document is less
44+expressive than many of the formats it converts between, one should
45+not expect perfect conversions between every format and every other.
46+Pandoc attempts to preserve the structural elements of a document, but
47+not formatting details such as margin size. And some document elements,
48+such as complex tables, may not fit into Pandoc's simple document
49+model. While conversions from Pandoc's Markdown to all formats aspire
50+to be perfect, conversions from formats more expressive than Pandoc's
51+Markdown can be expected to be lossy.
52+
4353Using `pandoc`
4454--------------
4555