07d51d9e30
Polyglot markup is HTML5 that is also valid XHTML. See <https://www.w3.org/TR/html-polyglot>. With this change, pandoc's html5 writer creates HTML that is both valid HTML5 and valid XHTML. See jgm/pandoc-templates#237 for prior discussion. * Add xml namespace to `<html>` element. * Make all `<meta>` elements self closing. See <https://www.w3.org/TR/html-polyglot/#empty-elements>. * Add `xml:lang` attribute on `<html>` element, defaulting to blank, and always include `lang` attribute, even when blank. See <https://www.w3.org/TR/html-polyglot/#language-attributes>. * Update test files for template changes. The key justification for having language values default to blank: it turns out the HTML5 spec requires it (as I read it). Under [the HTML5 spec, section "3.2.5.3. The lang and xml:lang attributes"](https://www.w3.org/TR/html/dom.html#the-lang-and-xmllang-attributes), providing attributes with blank contents both: * Has meaning, "unknown", and * Is a MUST (written as "must") if a language value is not provided ... > The lang attribute (in no namespace) specifies the primary language > for the element's contents and for any of the element's attributes that > contain text. Its value must be a valid BCP 47 language tag, or the > empty string. Setting the attribute to the empty string indicates that > the primary language is unknown. In short, it seems that where a language value is not provided then a blank value MUST be provided for Polyglot Markup conformance, because the HTML5 spec stipulates a "must". So although the Polyglot Markup spec is unclear on this issue it would seem that if it was correctly written, it would therefore require blank attributes. Further justifications are found at https://github.com/jgm/pandoc-templates/issues/237#issuecomment-275584181 (but the HTML5 spec justification given above would seem to be the clincher). In addition to having lang-values-default-to-blank I recommend that, when an author does not provide a lang value, then upon on pandoc command execution a warning message like the following be provided: > Polyglot markup stipulates that 'The root element SHOULD always specify > the language'. It is therefore recommended you specify a language value in > your source document. See > <https://www.w3.org/International/articles/language-tags/> for valid > language values. |
||
|---|---|---|
| benchmark | ||
| data | ||
| deb | ||
| doc | ||
| lib/fonts | ||
| macos | ||
| man | ||
| prelude | ||
| src/Text | ||
| test | ||
| tools | ||
| trypandoc | ||
| windows | ||
| .editorconfig | ||
| .gitignore | ||
| .travis.yml | ||
| appveyor.yml | ||
| BUGS | ||
| changelog | ||
| CONTRIBUTING.md | ||
| COPYING.md | ||
| COPYRIGHT | ||
| INSTALL.md | ||
| Makefile | ||
| MANUAL.txt | ||
| pandoc.cabal | ||
| pandoc.hs | ||
| README.md | ||
| RELEASE-CHECKLIST | ||
| RELEASE-CHECKLIST.md | ||
| Setup.hs | ||
| stack.full.yaml | ||
| stack.pkg.yaml | ||
| stack.yaml | ||
Pandoc
The universal markup converter
Pandoc is a Haskell library for converting from one markup format to
another, and a command-line tool that uses this library. It can read
Markdown, CommonMark, PHP Markdown Extra, GitHub-Flavored Markdown,
MultiMarkdown, and (subsets of) Textile, reStructuredText, HTML,
LaTeX, MediaWiki markup, TWiki markup, Haddock markup, OPML, Emacs
Org mode, DocBook, txt2tags, EPUB, ODT and Word docx; and it can
write plain text, Markdown, CommonMark, PHP Markdown Extra,
GitHub-Flavored Markdown, MultiMarkdown, reStructuredText, XHTML,
HTML5, LaTeX including [`beamer`] slide shows, ConTeXt, RTF, OPML,
DocBook, OpenDocument, ODT, Word docx, GNU Texinfo, MediaWiki
markup, DokuWiki markup, ZimWiki markup, Haddock markup,
EPUB v2 or v3, FictionBook2, Textile, groff man pages,
Emacs Org mode, AsciiDoc, InDesign ICML, TEI Simple, and Slidy,
Slideous, DZSlides, reveal.js or S5 HTML slide shows. It can also
produce PDF output on systems where LaTeX, ConTeXt, or wkhtmltopdf is
installed.
Pandoc's enhanced version of Markdown includes syntax for footnotes,
tables, flexible ordered lists, definition lists, fenced code blocks,
superscripts and subscripts, strikeout, metadata blocks, automatic tables of
contents, embedded LaTeX math, citations, and Markdown inside HTML block
elements. (These enhancements, described
further under Pandoc's Markdown, can be disabled using the
markdown_strict input or output format.)
In contrast to most existing tools for converting Markdown to HTML, which use regex substitutions, pandoc has a modular design: it consists of a set of readers, which parse text in a given format and produce a native 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.
Installing
Here's how to install pandoc.
Documentation
Pandoc's website contains a full User's Guide. It is also available here as pandoc-flavored Markdown. The website also contains some examples of the use of pandoc and a limited online demo.
Contributing
Pull requests, bug reports, and feature requests are welcome. Please make sure to read the contributor guidelines before opening a new issue.
License
© 2006-2016 John MacFarlane (jgm@berkeley.edu). Released under the GPL, version 2 or greater. This software carries no warranty of any kind. (See COPYRIGHT for full copyright and warranty notices.)