git.iko.soy/typeable/pandoc
on master help sign in
Update man page and date on MANUAL.
5e6879dJohn MacFarlane
MANUAL.txt+1−1
@@ -1,6 +1,6 @@
1% Pandoc User's Guide
1% Pandoc User's Guide
2% John MacFarlane
2% John MacFarlane
3−% January 18, 2018
3+% March 2, 2018
4
4
5Synopsis
5Synopsis
6========
6========
man/pandoc.1+143−10
@@ -1,5 +1,5 @@
1.\"t
1.\"t
2−.TH PANDOC 1 "January 18, 2018" "pandoc 2.1.1"
2+.TH PANDOC 1 "March 2, 2018" "pandoc 2.1.2"
3.SH NAME
3.SH NAME
4pandoc - general markup converter
4pandoc - general markup converter
5.SH SYNOPSIS
5.SH SYNOPSIS
@@ -175,7 +175,8 @@ When using an HTML/CSS\-to\-PDF\-engine, \f[C]\-\-css\f[] affects the
175output.
175output.
176If \f[C]wkhtmltopdf\f[] is used, then the variables
176If \f[C]wkhtmltopdf\f[] is used, then the variables
177\f[C]margin\-left\f[], \f[C]margin\-right\f[], \f[C]margin\-top\f[],
177\f[C]margin\-left\f[], \f[C]margin\-right\f[], \f[C]margin\-top\f[],
178+\f[C]margin\-bottom\f[], \f[C]footer\-html\f[], \f[C]header\-html\f[]
178−\f[C]margin\-bottom\f[], and \f[C]papersize\f[] will affect the output.
179+and \f[C]papersize\f[] will affect the output.
179.PP
180.PP
180To debug the PDF creation, it can be useful to look at the intermediate
181To debug the PDF creation, it can be useful to look at the intermediate
181representation: instead of \f[C]\-o\ test.pdf\f[], use for example
182representation: instead of \f[C]\-o\ test.pdf\f[], use for example
@@ -821,6 +822,7 @@ line, or when resources used in a document must be downloaded).
821Produce a standalone HTML file with no external dependencies, using
822Produce a standalone HTML file with no external dependencies, using
822\f[C]data:\f[] URIs to incorporate the contents of linked scripts,
823\f[C]data:\f[] URIs to incorporate the contents of linked scripts,
823stylesheets, images, and videos.
824stylesheets, images, and videos.
825+Implies \f[C]\-\-standalone\f[].
824The resulting file should be "self\-contained," in the sense that it
826The resulting file should be "self\-contained," in the sense that it
825needs no external files and no net access to be displayed properly by a
827needs no external files and no net access to be displayed properly by a
826browser.
828browser.
@@ -1044,6 +1046,34 @@ default \f[C]reference.odt\f[]:
1044Then open \f[C]custom\-reference.odt\f[] in LibreOffice, modify the
1046Then open \f[C]custom\-reference.odt\f[] in LibreOffice, modify the
1045styles as you wish, and save the file.
1047styles as you wish, and save the file.
1046.RE
1048.RE
1049+.TP
1050+.B PowerPoint
1051+Any template included with a recent install of Microsoft PowerPoint
1052+(either with \f[C]\&.pptx\f[] or \f[C]\&.potx\f[] extension) should
1053+work, as will most templates derived from these.
1054+.RS
1055+.PP
1056+The specific requirement is that the template should contain the
1057+following four layouts as its first four layouts:
1058+.IP "1." 3
1059+Title Slide
1060+.IP "2." 3
1061+Title and Content
1062+.IP "3." 3
1063+Section Header
1064+.IP "4." 3
1065+Two Content
1066+.PP
1067+All templates included with a recent version of MS PowerPoint will fit
1068+these criteria.
1069+(You can click on \f[C]Layout\f[] under the \f[C]Home\f[] menu to
1070+check.)
1071+.PP
1072+You can also modify the default \f[C]reference.pptx\f[]: first run
1073+\f[C]pandoc\ \-\-print\-default\-data\-file\ reference.pptx\ >\ custom\-reference.pptx\f[],
1074+and then modify \f[C]custom\-reference.pptx\f[] in MS PowerPoint (pandoc
1075+will use the first four layout slides, as mentioned above).
1076+.RE
1047.RE
1077.RE
1048.TP
1078.TP
1049.B \f[C]\-\-epub\-cover\-image=\f[]\f[I]FILE\f[]
1079.B \f[C]\-\-epub\-cover\-image=\f[]\f[I]FILE\f[]
@@ -2341,6 +2371,18 @@ This extension can be enabled/disabled for the following formats:
2341\f[C]html\f[]
2371\f[C]html\f[]
2342.RS
2372.RS
2343.RE
2373.RE
2374+.SS Extension: \f[C]styles\f[]
2375+.PP
2376+Read all docx styles as divs (for paragraph styles) and spans (for
2377+character styles) regardless of whether pandoc understands the meaning
2378+of these styles.
2379+This can be used with docx custom styles.
2380+Disabled by default.
2381+.TP
2382+.B input formats
2383+\f[C]docx\f[]
2384+.RS
2385+.RE
2344.SS Extension: \f[C]amuse\f[]
2386.SS Extension: \f[C]amuse\f[]
2345.PP
2387.PP
2346In the \f[C]muse\f[] input format, this enables Text::Amuse extensions
2388In the \f[C]muse\f[] input format, this enables Text::Amuse extensions
@@ -2741,7 +2783,7 @@ Here \f[C]mycode\f[] is an identifier, \f[C]haskell\f[] and
2741with value \f[C]100\f[].
2783with value \f[C]100\f[].
2742Some output formats can use this information to do syntax highlighting.
2784Some output formats can use this information to do syntax highlighting.
2743Currently, the only output formats that uses this information are HTML,
2785Currently, the only output formats that uses this information are HTML,
2744−LaTeX, Docx, and Ms.
2786+LaTeX, Docx, Ms, and PowerPoint.
2745If highlighting is supported for your output format and language, then
2787If highlighting is supported for your output format and language, then
2746the code block above will appear highlighted, with numbered lines.
2788the code block above will appear highlighted, with numbered lines.
2747(To see which languages are supported, type
2789(To see which languages are supported, type
@@ -5204,9 +5246,42 @@ reveal.js.
5204By default, these writers produce lists that display "all at once." If
5246By default, these writers produce lists that display "all at once." If
5205you want your lists to display incrementally (one item at a time), use
5247you want your lists to display incrementally (one item at a time), use
5206the \f[C]\-i\f[] option.
5248the \f[C]\-i\f[] option.
5207−If you want a particular list to depart from the default (that is, to
5249+If you want a particular list to depart from the default, put it in a
5250+\f[C]div\f[] block with class \f[C]incremental\f[] or
5251+\f[C]nonincremental\f[].
5252+So, for example, using the \f[C]fenced\ div\f[] syntax, the following
5253+would be incremental regardless of the document default:
5254+.IP
5255+.nf
5256+\f[C]
5257+:::\ incremental
5258+
5259+\-\ Eat\ spaghetti
5260+\-\ Drink\ wine
5261+
5262+:::
5263+\f[]
5264+.fi
5265+.PP
5266+or
5267+.IP
5268+.nf
5269+\f[C]
5270+:::\ nonincremental
5271+
5272+\-\ Eat\ spaghetti
5273+\-\ Drink\ wine
5274+
5275+:::
5276+\f[]
5277+.fi
5278+.PP
5279+While using \f[C]incremental\f[] and \f[C]nonincremental\f[] divs are
5280+the recommended method of setting incremental lists on a per\-case
5281+basis, an older method is also supported: putting lists inside a
5282+blockquote will depart from the document default (that is, it will
5208display incrementally without the \f[C]\-i\f[] option and all at once
5283display incrementally without the \f[C]\-i\f[] option and all at once
5209−with the \f[C]\-i\f[] option), put it in a block quote:
5284+with the \f[C]\-i\f[] option):
5210.IP
5285.IP
5211.nf
5286.nf
5212\f[C]
5287\f[C]
@@ -5215,7 +5290,7 @@ with the \f[C]\-i\f[] option), put it in a block quote:
5215\f[]
5290\f[]
5216.fi
5291.fi
5217.PP
5292.PP
5218−In this way incremental and nonincremental lists can be mixed in a
5293+Both methods allow incremental and nonincremental lists to be mixed in a
5219single document.
5294single document.
5220.SS Inserting pauses
5295.SS Inserting pauses
5221.PP
5296.PP
@@ -5286,7 +5361,7 @@ This is recommended especially for bibliographies:
5286.fi
5361.fi
5287.SS Speaker notes
5362.SS Speaker notes
5288.PP
5363.PP
5289−reveal.js has good support for speaker notes.
5364+Speaker notes are supported in reveal.js and PowerPoint (pptx) output.
5290You can add notes to your Markdown document thus:
5365You can add notes to your Markdown document thus:
5291.IP
5366.IP
5292.nf
5367.nf
@@ -5302,8 +5377,11 @@ This\ is\ my\ note.
5302\f[]
5377\f[]
5303.fi
5378.fi
5304.PP
5379.PP
5305−To show the notes window, press \f[C]s\f[] while viewing the
5380+To show the notes window in reveal.js, press \f[C]s\f[] while viewing
5306−presentation.
5381+the presentation.
5382+Speaker notes in PowerPoint will be available, as usual, in handouts and
5383+presenter view.
5384+.PP
5307Notes are not yet supported for other slide formats, but the notes will
5385Notes are not yet supported for other slide formats, but the notes will
5308not appear on the slides themselves.
5386not appear on the slides themselves.
5309.SS Columns
5387.SS Columns
@@ -5532,7 +5610,62 @@ To see a list of highlight styles, type
5532\f[C]pandoc\ \-\-list\-highlight\-styles\f[].
5610\f[C]pandoc\ \-\-list\-highlight\-styles\f[].
5533.PP
5611.PP
5534To disable highlighting, use the \f[C]\-\-no\-highlight\f[] option.
5612To disable highlighting, use the \f[C]\-\-no\-highlight\f[] option.
5535−.SH CUSTOM STYLES IN DOCX OUTPUT
5613+.SH CUSTOM STYLES IN DOCX
5614+.SS Input
5615+.PP
5616+The docx reader, by default, only reads those styles that it can convert
5617+into pandoc elements, either by direct conversion or interpreting the
5618+derivation of the input document\[aq]s styles.
5619+.PP
5620+By enabling the \f[C]styles\f[] extension in the docx reader
5621+(\f[C]\-f\ docx+styles\f[]), you can produce output that maintains the
5622+styles of the input document, using the \f[C]custom\-style\f[] class.
5623+Paragraph styles are interpreted as divs, while character styles are
5624+interpreted as spans.
5625+.PP
5626+For example, using the \f[C]custom\-style\-reference.docx\f[] file in
5627+the test directory, we have the following different outputs:
5628+.PP
5629+Without the \f[C]+styles\f[] extension:
5630+.IP
5631+.nf
5632+\f[C]
5633+$\ pandoc\ test/docx/custom\-style\-reference.docx\ \-f\ docx\ \-t\ markdown
5634+This\ is\ some\ text.
5635+
5636+This\ is\ text\ with\ an\ *emphasized*\ text\ style.\ And\ this\ is\ text\ with\ a
5637+**strengthened**\ text\ style.
5638+
5639+>\ Here\ is\ a\ styled\ paragraph\ that\ inherits\ from\ Block\ Text.
5640+\f[]
5641+.fi
5642+.PP
5643+And with the extension:
5644+.IP
5645+.nf
5646+\f[C]
5647+$\ pandoc\ test/docx/custom\-style\-reference.docx\ \-f\ docx+styles\ \-t\ markdown
5648+
5649+:::\ {custom\-style="FirstParagraph"}
5650+This\ is\ some\ text.
5651+:::
5652+
5653+:::\ {custom\-style="BodyText"}
5654+This\ is\ text\ with\ an\ [emphasized]{custom\-style="Emphatic"}\ text\ style.
5655+And\ this\ is\ text\ with\ a\ [strengthened]{custom\-style="Strengthened"}
5656+text\ style.
5657+:::
5658+
5659+:::\ {custom\-style="MyBlockStyle"}
5660+>\ Here\ is\ a\ styled\ paragraph\ that\ inherits\ from\ Block\ Text.
5661+:::
5662+\f[]
5663+.fi
5664+.PP
5665+With these custom styles, you can use your input document as a
5666+reference\-doc while creating docx output (see below), and maintain the
5667+same styles in your input and output files.
5668+.SS Output
5536.PP
5669.PP
5537By default, pandoc\[aq]s docx output applies a predefined set of styles
5670By default, pandoc\[aq]s docx output applies a predefined set of styles
5538for blocks such as paragraphs and block quotes, and uses largely default
5671for blocks such as paragraphs and block quotes, and uses largely default