|author||John MacFarlane <email@example.com>||2015-08-08 15:18:31 -0700|
|committer||John MacFarlane <firstname.lastname@example.org>||2015-08-08 15:18:31 -0700|
Clarified what is "out of scope" in README and CONTRIBUTING.md.
Diffstat (limited to 'README')
1 files changed, 10 insertions, 0 deletions
@@ -40,6 +40,16 @@ representation of the document, and a set of writers, which convert
this native representation into a target format. Thus, adding an input
or output format requires only adding a reader or writer.
+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
+Markdown can be expected to be lossy.