git.iko.soy/typeable/pandoc
on master help sign in
Updated man page and MANUAL date.
e7c3ea4John 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−% July 17, 2016
3+% September 26, 2016
4
4
5Synopsis
5Synopsis
6========
6========
man/pandoc.1+90−10
@@ -1,5 +1,5 @@
1.\"t
1.\"t
2−.TH PANDOC 1 "June 4, 2016" "pandoc 1.17.2"
2+.TH PANDOC 1 "September 26, 2016" "pandoc 1.17.3"
3.SH NAME
3.SH NAME
4pandoc - general markup converter
4pandoc - general markup converter
5.SH SYNOPSIS
5.SH SYNOPSIS
@@ -1103,6 +1103,7 @@ Use KaTeX to display embedded TeX math in HTML output.
1103The \f[I]URL\f[] should point to the \f[C]katex.js\f[] load script.
1103The \f[I]URL\f[] should point to the \f[C]katex.js\f[] load script.
1104If a \f[I]URL\f[] is not provided, a link to the KaTeX CDN will be
1104If a \f[I]URL\f[] is not provided, a link to the KaTeX CDN will be
1105inserted.
1105inserted.
1106+Note: KaTeX seems to work best with \f[C]html5\f[] output.
1106.RS
1107.RS
1107.RE
1108.RE
1108.TP
1109.TP
@@ -1353,6 +1354,11 @@ themes for LaTeX \f[C]beamer\f[] documents
1353.RS
1354.RS
1354.RE
1355.RE
1355.TP
1356.TP
1357+.B \f[C]themeoptions\f[]
1358+options for LaTeX beamer themes (a list).
1359+.RS
1360+.RE
1361+.TP
1356.B \f[C]navigation\f[]
1362.B \f[C]navigation\f[]
1357controls navigation symbols in \f[C]beamer\f[] documents (default is
1363controls navigation symbols in \f[C]beamer\f[] documents (default is
1358\f[C]empty\f[] for no navigation symbols; other valid values are
1364\f[C]empty\f[] for no navigation symbols; other valid values are
@@ -1365,6 +1371,12 @@ enables on "title pages" for new sections in \f[C]beamer\f[] documents
1365(default = true).
1371(default = true).
1366.RS
1372.RS
1367.RE
1373.RE
1374+.TP
1375+.B \f[C]beamerarticle\f[]
1376+when true, the \f[C]beamerarticle\f[] package is loaded (for producing
1377+an article from beamer slides).
1378+.RS
1379+.RE
1368.SS Variables for LaTeX
1380.SS Variables for LaTeX
1369.PP
1381.PP
1370LaTeX variables are used when creating a PDF.
1382LaTeX variables are used when creating a PDF.
@@ -3039,10 +3051,8 @@ This form is necessary when the field contains blank lines:
3039\-\-\-
3051\-\-\-
3040title:\ \ \[aq]This\ is\ the\ title:\ it\ contains\ a\ colon\[aq]
3052title:\ \ \[aq]This\ is\ the\ title:\ it\ contains\ a\ colon\[aq]
3041author:
3053author:
3042−\-\ name:\ Author\ One
3054+\-\ Author\ One
3043−\ \ affiliation:\ University\ of\ Somewhere
3044−\-\ name:\ Author\ Two
3055+\-\ Author\ Two
3045−\ \ affiliation:\ University\ of\ Nowhere
3046tags:\ [nothing,\ nothingness]
3056tags:\ [nothing,\ nothingness]
3047abstract:\ |
3057abstract:\ |
3048\ \ This\ is\ the\ abstract.
3058\ \ This\ is\ the\ abstract.
@@ -3064,11 +3074,29 @@ field:
3064\f[]
3074\f[]
3065.fi
3075.fi
3066.PP
3076.PP
3077+Variables can contain arbitrary YAML structures, but the template must
3078+match this structure.
3067−Note: The \f[C]author\f[] variable in the default templates expects a
3079+The \f[C]author\f[] variable in the default templates expects a simple
3068−simple list or string.
3080+list or string, but can be changed to support more complicated
3081+structures.
3082+The following combination, for example, would add an affiliation to the
3083+author if one is given:
3084+.IP
3085+.nf
3086+\f[C]
3087+\-\-\-
3088+title:\ The\ document\ title
3089+author:
3090+\-\ name:\ Author\ One
3091+\ \ affiliation:\ University\ of\ Somewhere
3092+\-\ name:\ Author\ Two
3093+\ \ affiliation:\ University\ of\ Nowhere
3094+\&...
3095+\f[]
3096+.fi
3097+.PP
3069−To use the structured authors in the example, you would need a custom
3098+To use the structured authors in the example above, you would need a
3070−template.
3099+custom template:
3071−For example:
3072.IP
3100.IP
3073.nf
3101.nf
3074\f[C]
3102\f[C]
@@ -4772,6 +4800,58 @@ To see a list of language names that pandoc will recognize, type
4772\f[C]pandoc\ \-\-version\f[].
4800\f[C]pandoc\ \-\-version\f[].
4773.PP
4801.PP
4774To disable highlighting, use the \f[C]\-\-no\-highlight\f[] option.
4802To disable highlighting, use the \f[C]\-\-no\-highlight\f[] option.
4803+.SH CUSTOM STYLES IN DOCX OUTPUT
4804+.PP
4805+By default, pandoc\[aq]s docx output applies a predefined set of styles
4806+for blocks such as paragraphs and block quotes, and uses largely default
4807+formatting (italics, bold) for inlines.
4808+This will work for most purposes, especially alongside a
4809+\f[C]reference.docx\f[] file.
4810+However, if you need to apply your own styles to blocks, or match a
4811+preexisting set of styles, pandoc allows you to define custom styles for
4812+blocks and text using \f[C]div\f[]s and \f[C]span\f[]s, respecitively.
4813+.PP
4814+If you define a \f[C]div\f[] or \f[C]span\f[] with the attribute
4815+\f[C]custom\-style\f[], pandoc will apply your specified style to the
4816+contained elements.
4817+So, for example,
4818+.IP
4819+.nf
4820+\f[C]
4821+<span\ custom\-style="Emphatically">Get\ out,</span>\ he\ said.
4822+\f[]
4823+.fi
4824+.PP
4825+would produce a docx file with "Get out," styled with character style
4826+\f[C]Emphatically\f[].
4827+Similarly,
4828+.IP
4829+.nf
4830+\f[C]
4831+Dickinson\ starts\ the\ poem\ simply:
4832+
4833+<div\ custom\-style="Poetry">
4834+|\ A\ Bird\ came\ down\ the\ Walk\-\-\-
4835+|\ He\ did\ not\ know\ I\ saw\-\-\-
4836+</div>
4837+\f[]
4838+.fi
4839+.PP
4840+would style the two contained lines with the \f[C]Poetry\f[] paragraph
4841+style.
4842+.PP
4843+If the styles are not yet in your reference.docx, they will be defined
4844+in the output file as inheriting from normal text.
4845+If they are already defined, pandoc will not alter the definition.
4846+.PP
4847+This feature allows for greatest customization in conjunction with
4848+pandoc filters.
4849+If you want all paragraphs after block quotes to be indented, you can
4850+write a filter to apply the styles necessary.
4851+If you want all italics to be transformed to the \f[C]Emphasis\f[]
4852+character style (perhaps to change their color), you can write a filter
4853+which will transform all italicized inlines to inlines within an
4854+\f[C]Emphasis\f[] custom\-style \f[C]span\f[].
4775.SH CUSTOM WRITERS
4855.SH CUSTOM WRITERS
4776.PP
4856.PP
4777Pandoc can be extended with custom writers written in lua.
4857Pandoc can be extended with custom writers written in lua.