@@ -1,5 +1,5 @@
11.\"t
2−.TH PANDOC 1 "March 26, 2017" "pandoc"
2+.TH PANDOC 1 "October 27, 2017" "pandoc"
33.SH NAME
44pandoc - general markup converter
55.SH SYNOPSIS
@@ -11,18 +11,19 @@ Pandoc is a Haskell library for converting from one markup format to
1111another, and a command\-line tool that uses this library.
1212It can read Markdown, CommonMark, PHP Markdown Extra, GitHub\-Flavored
1313Markdown, MultiMarkdown, and (subsets of) Textile, reStructuredText,
14−HTML, LaTeX, MediaWiki markup, TWiki markup, TikiWiki markup, Haddock
15−markup, OPML, Emacs Org mode, DocBook, Muse, txt2tags, Vimwiki, EPUB,
16−ODT, and Word docx; and it can write plain text, Markdown, CommonMark,
17−PHP Markdown Extra, GitHub\-Flavored Markdown, MultiMarkdown,
18−reStructuredText, XHTML, HTML5, LaTeX (including \f[C]beamer\f[] slide
19−shows), ConTeXt, RTF, OPML, DocBook, OpenDocument, ODT, Word docx, GNU
20−Texinfo, MediaWiki markup, DokuWiki markup, ZimWiki markup, Haddock
21−markup, EPUB (v2 or v3), FictionBook2, Textile, groff man, groff ms,
22−Emacs Org mode, AsciiDoc, InDesign ICML, TEI Simple, Muse and Slidy,
23−Slideous, DZSlides, reveal.js or S5 HTML slide shows.
14+HTML, LaTeX, MediaWiki markup, TWiki markup, TikiWiki markup, Creole
15+1.0, Haddock markup, OPML, Emacs Org mode, DocBook, Muse, txt2tags,
16+Vimwiki, EPUB, ODT, and Word docx; and it can write plain text,
17+Markdown, CommonMark, PHP Markdown Extra, GitHub\-Flavored Markdown,
18+MultiMarkdown, reStructuredText, XHTML, HTML5, LaTeX (including
19+\f[C]beamer\f[] slide shows), ConTeXt, RTF, OPML, DocBook, OpenDocument,
20+ODT, Word docx, GNU Texinfo, MediaWiki markup, DokuWiki markup, ZimWiki
21+markup, Haddock markup, EPUB (v2 or v3), FictionBook2, Textile, groff
22+man, groff ms, Emacs Org mode, AsciiDoc, InDesign ICML, TEI Simple, Muse
23+and Slidy, Slideous, DZSlides, reveal.js or S5 HTML slide shows.
2424It can also produce PDF output on systems where LaTeX, ConTeXt,
25−\f[C]pdfroff\f[], or \f[C]wkhtmltopdf\f[] is installed.
25+\f[C]pdfroff\f[], \f[C]wkhtmltopdf\f[], \f[C]prince\f[], or
26+\f[C]weasyprint\f[] is installed.
2627.PP
2728Pandoc's enhanced version of Markdown includes syntax for footnotes,
2829tables, flexible ordered lists, definition lists, fenced code blocks,
@@ -236,11 +237,11 @@ Markdown), \f[C]markdown_strict\f[] (original unextended Markdown),
236237(DocBook), \f[C]t2t\f[] (txt2tags), \f[C]docx\f[] (docx), \f[C]odt\f[]
237238(ODT), \f[C]epub\f[] (EPUB), \f[C]opml\f[] (OPML), \f[C]org\f[] (Emacs
238239Org mode), \f[C]mediawiki\f[] (MediaWiki markup), \f[C]twiki\f[] (TWiki
239−markup), \f[C]tikiwiki\f[] (TikiWiki markup), \f[C]haddock\f[] (Haddock
240−markup), or \f[C]latex\f[] (LaTeX).
240+markup), \f[C]tikiwiki\f[] (TikiWiki markup), \f[C]creole\f[] (Creole
241+1.0), \f[C]haddock\f[] (Haddock markup), or \f[C]latex\f[] (LaTeX).
241242(\f[C]markdown_github\f[] provides deprecated and less accurate suppport
242243for Github\-Flavored Markdown; please use \f[C]gfm\f[] instead, unless
243−you use extensions that do not work with \f[C]gfm\f[].) If \f[C]+lhs\f[]
244+you need to use extensions other than \f[C]smart\f[].) If \f[C]+lhs\f[]
244245is appended to \f[C]markdown\f[], \f[C]rst\f[], \f[C]latex\f[], or
245246\f[C]html\f[], the input will be treated as literate Haskell source: see
246247Literate Haskell support, below.
@@ -491,7 +492,9 @@ In order of preference, pandoc will look for filters in
491492.IP "1." 3
492493a specified full or relative path (executable or non\-executable)
493494.IP "2." 3
494−\f[C]$DATADIR/filters\f[] (executable or non\-executable)
495+\f[C]$DATADIR/filters\f[] (executable or non\-executable) where
496+\f[C]$DATADIR\f[] is the user data directory (see
497+\f[C]\-\-data\-dir\f[], above).
495498.IP "3." 3
496499\f[C]$PATH\f[] (executable only)
497500.RE
@@ -1966,6 +1969,9 @@ We recommend tracking the changes in the default templates, and
19661969modifying your custom templates accordingly.
19671970An easy way to do this is to fork the pandoc\-templates repository and
19681971merge in changes after each pandoc release.
1972+.PP
1973+Templates may contain comments: anything on a line after \f[C]$\-\-\f[]
1974+will be treated as a comment and ignored.
19691975.SH PANDOC'S MARKDOWN
19701976.PP
19711977Pandoc understands an extended and slightly revised version of John
@@ -3801,6 +3807,49 @@ Use native pandoc \f[C]Span\f[] blocks for content inside
38013807For the most part this should give the same output as \f[C]raw_html\f[],
38023808but it makes it easier to write pandoc filters to manipulate groups of
38033809inlines.
3810+.SS Extension: \f[C]fenced_divs\f[]
3811+.PP
3812+Allow special fenced syntax for native \f[C]Div\f[] blocks.
3813+A Div starts with a fence containing at least three consecutive colons
3814+plus some attributes.
3815+The attributes may optionally be followed by another string of
3816+consecutive colons.
3817+The attribute syntax is exactly as in fenced code blocks (see
3818+[Extension\-fenced_code_attributes], above).
3819+As with fenced code blocks, one can use either attributes in curly
3820+braces or a single unbraced word, which will be treated as a class name.
3821+The Div ends with another line containing a string of at least three
3822+consecutive colons.
3823+The fenced Div should be separated by blank lines from preceding and
3824+following blocks.
3825+.PP
3826+Example:
3827+.IP
3828+.nf
3829+\f[C]
3830+:::::\ {#special\ .sidebar}
3831+Here\ is\ a\ paragraph.
3832+
3833+And\ another.
3834+:::::
3835+\f[]
3836+.fi
3837+.PP
3838+Fenced divs can be nested.
3839+Opening fences are distinguished because they \f[I]must\f[] have
3840+attributes:
3841+.IP
3842+.nf
3843+\f[C]
3844+:::\ Warning\ ::::::
3845+This\ is\ a\ warning.
3846+
3847+:::\ Danger
3848+This\ is\ a\ warning\ within\ a\ warning.
3849+:::
3850+::::::::::::::::::
3851+\f[]
3852+.fi
38043853.SS Extension: \f[C]raw_tex\f[]
38053854.PP
38063855In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
@@ -4691,17 +4740,19 @@ variants are supported:
46914740\f[C]markdown_attribute\f[], \f[C]fenced_code_blocks\f[],
46924741\f[C]definition_lists\f[], \f[C]intraword_underscores\f[],
46934742\f[C]header_attributes\f[], \f[C]link_attributes\f[],
4694−\f[C]abbreviations\f[], \f[C]shortcut_reference_links\f[].
4743+\f[C]abbreviations\f[], \f[C]shortcut_reference_links\f[],
4744+\f[C]spaced_reference_links\f[].
46954745.RS
46964746.RE
46974747.TP
4698−.B \f[C]gfm\f[] and \f[C]markdown_github\f[] (GitHub\-Flavored Markdown)
4748+.B \f[C]markdown_github\f[] (deprecated GitHub\-Flavored Markdown)
46994749\f[C]pipe_tables\f[], \f[C]raw_html\f[], \f[C]fenced_code_blocks\f[],
4700−\f[C]auto_identifiers\f[], \f[C]ascii_identifiers\f[],
4750+\f[C]gfm_auto_identifiers\f[], \f[C]ascii_identifiers\f[],
47014751\f[C]backtick_code_blocks\f[], \f[C]autolink_bare_uris\f[],
4702−\f[C]intraword_underscores\f[], \f[C]strikeout\f[],
4703−\f[C]hard_line_breaks\f[], \f[C]emoji\f[],
4704−\f[C]shortcut_reference_links\f[], \f[C]angle_brackets_escapable\f[].
4752+\f[C]space_in_atx_header\f[], \f[C]intraword_underscores\f[],
4753+\f[C]strikeout\f[], \f[C]emoji\f[], \f[C]shortcut_reference_links\f[],
4754+\f[C]angle_brackets_escapable\f[],
4755+\f[C]lists_without_preceding_blankline\f[].
47054756.RS
47064757.RE
47074758.TP
@@ -4712,14 +4763,36 @@ variants are supported:
47124763\f[C]footnotes\f[], \f[C]definition_lists\f[],
47134764\f[C]all_symbols_escapable\f[], \f[C]implicit_header_references\f[],
47144765\f[C]auto_identifiers\f[], \f[C]mmd_header_identifiers\f[],
4715−\f[C]shortcut_reference_links\f[].
4766+\f[C]shortcut_reference_links\f[], \f[C]implicit_figures\f[],
4767+\f[C]superscript\f[], \f[C]subscript\f[], \f[C]backtick_code_blocks\f[],
4768+\f[C]spaced_reference_links\f[], \f[C]raw_attribute\f[].
47164769.RS
47174770.RE
47184771.TP
47194772.B \f[C]markdown_strict\f[] (Markdown.pl)
4720−\f[C]raw_html\f[]
4773+\f[C]raw_html\f[], \f[C]shortcut_reference_links\f[],
4774+\f[C]spaced_reference_links\f[].
47214775.RS
47224776.RE
4777+.PP
4778+We also support \f[C]gfm\f[] (GitHub\-Flavored Markdown) as a set of
4779+extensions on \f[C]commonmark\f[]:
4780+.PP
4781+: \f[C]pipe_tables\f[], \f[C]raw_html\f[], \f[C]fenced_code_blocks\f[],
4782+\f[C]auto_identifiers\f[], \f[C]ascii_identifiers\f[],
4783+\f[C]backtick_code_blocks\f[], \f[C]autolink_bare_uris\f[],
4784+\f[C]intraword_underscores\f[], \f[C]strikeout\f[],
4785+\f[C]hard_line_breaks\f[], \f[C]emoji\f[],
4786+\f[C]shortcut_reference_links\f[], \f[C]angle_brackets_escapable\f[].
4787+.IP
4788+.nf
4789+\f[C]
4790+These\ can\ all\ be\ individually\ disabled.\ Note,\ however,\ that
4791+`commonmark`\ and\ `gfm`\ have\ limited\ support\ for\ extensions:
4792+extensions\ other\ than\ those\ listed\ above\ (and\ `smart`)\ will\ have
4793+no\ effect\ on\ `commonmark`\ or\ `gfm`.
4794+\f[]
4795+.fi
47234796.SS Extensions with formats other than Markdown
47244797.PP
47254798Some of the extensions discussed above can be used with formats other
@@ -5314,7 +5387,7 @@ pandoc\ \-\-print\-default\-data\-file\ sample.lua
53145387.fi
53155388.SH AUTHORS
53165389.PP
5317−© 2006\-2017 John MacFarlane (jgm\@berkeley.edu).
5390+Copyright 2006\-2017 John MacFarlane (jgm\@berkeley.edu).
53185391Released under the GPL, version 2 or greater.
53195392This software carries no warranty of any kind.
53205393(See COPYRIGHT for full copyright and warranty notices.) For a full list