@@ -1,7 +1,7 @@
11'\" t
2−.\" Automatically generated by Pandoc 2.13
2+.\" Automatically generated by Pandoc 2.14
33.\"
4−.TH "Pandoc User\[cq]s Guide" "" "May 13, 2021" "pandoc 2.14" ""
4+.TH "Pandoc User\[cq]s Guide" "" "May 21, 2021" "pandoc 2.14" ""
55.hy
66.SH NAME
77pandoc - general markup converter
@@ -2591,10 +2591,9 @@ YAML metadata or with \f[C]-M classoption=fleqn\f[R].
25912591.SS Variables for HTML slides
25922592.PP
25932593These affect HTML output when [producing slide shows with pandoc].
2594−.PP
2595−All reveal.js configuration options are available as variables.
2596−To turn off boolean flags that default to true in reveal.js, use
2597−\f[C]0\f[R].
2594+.TP
2595+\f[B]\f[CB]institute\f[B]\f[R]
2596+author affiliations: can be a list when there are multiple authors
25982597.TP
25992598\f[B]\f[CB]revealjs-url\f[B]\f[R]
26002599base URL for reveal.js documents (defaults to
@@ -2613,6 +2612,10 @@ base URL for Slideous documents (defaults to \f[C]slideous\f[R])
26132612\f[B]\f[CB]title-slide-attributes\f[B]\f[R]
26142613additional attributes for the title slide of reveal.js slide shows.
26152614See background in reveal.js and beamer for an example.
2615+.PP
2616+All reveal.js configuration options are available as variables.
2617+To turn off boolean flags that default to true in reveal.js, use
2618+\f[C]0\f[R].
26162619.SS Variables for Beamer slides
26172620.PP
26182621These variables change the appearance of PDF slides using
@@ -4793,7 +4796,9 @@ All of the metadata will appear in a single block at the beginning of
47934796the document.
47944797.PP
47954798Note that YAML escaping rules must be followed.
4796−Thus, for example, if a title contains a colon, it must be quoted.
4799+Thus, for example, if a title contains a colon, it must be quoted, and
4800+if it contains a backslash escape, then it must be ensured that it is
4801+not treated as a YAML escape sequence.
47974802The pipe character (\f[C]|\f[R]) can be used to begin an indented block
47984803that will be interpreted literally, without need for escaping.
47994804This form is necessary when the field contains blank lines or
@@ -5775,27 +5780,70 @@ Inline and regular footnotes may be mixed freely.
57755780.SS Citation syntax
57765781.SS Extension: \f[C]citations\f[R]
57775782.PP
5778−Markdown citations go inside square brackets and are separated by
5779−semicolons.
5780−Each citation must have a key, composed of `\[at]' + the citation
5781−identifier from the database, and may optionally have a prefix, a
5782−locator, and a suffix.
5783−The citation key must begin with a letter, digit, or \f[C]_\f[R], and
5784−may contain alphanumerics, \f[C]_\f[R], and internal punctuation
5785−characters (\f[C]:.#$%&-+?<>\[ti]/\f[R]).
5786−Here are some examples:
5783+To cite a bibliographic item with an identifier foo, use the syntax
5784+\f[C]\[at]foo\f[R].
5785+Normal citations should be included in square brackets, with semicolons
5786+separating distinct items:
57875787.IP
57885788.nf
57895789\f[C]
5790−Blah blah [see \[at]doe99, pp. 33-35; also \[at]smith04, chap. 1].
5791−
5792−Blah blah [\[at]doe99, pp. 33-35, 38-39 and *passim*].
5790+Blah blah [\[at]doe99; \[at]smith2000; \[at]smith2004].
5791+\f[R]
5792+.fi
5793+.PP
5794+How this is rendered depends on the citation style.
5795+In an author-date style, it might render as
5796+.IP
5797+.nf
5798+\f[C]
5799+Blah blah (Doe 1999, Smith 2000, 2004).
5800+\f[R]
5801+.fi
5802+.PP
5803+In a footnote style, it might render as
5804+.IP
5805+.nf
5806+\f[C]
5807+Blah blah.[\[ha]1]
57935808
5794−Blah blah [\[at]smith04; \[at]doe99].
5809+[\[ha]1]: John Doe, \[dq]Frogs,\[dq] *Journal of Amphibians* 44 (1999);
5810+Susan Smith, \[dq]Flies,\[dq] *Journal of Insects* (2000);
5811+Susan Smith, \[dq]Bees,\[dq] *Journal of Insects* (2004).
5812+\f[R]
5813+.fi
5814+.PP
5815+See the CSL user documentation for more information about CSL styles and
5816+how they affect rendering.
5817+.PP
5818+Unless a citation key start with a letter, digit, or \f[C]_\f[R], and
5819+contains only alphanumerics and internal punctuation characters
5820+(\f[C]:.#$%&-+?<>\[ti]/\f[R]), it must be surrounded by curly braces,
5821+which are not considered part of the key.
5822+In \f[C]\[at]Foo_bar.baz.\f[R], the key is \f[C]Foo_bar.baz\f[R].
5823+The final period is not \f[I]internal\f[R] punctuation, so it is not
5824+included in the key.
5825+In \f[C]\[at]{Foo_bar.baz.}\f[R], the key is \f[C]Foo_bar.baz.\f[R],
5826+including the final period.
5827+The curly braces are recommended if you use URLs as keys:
5828+\f[C][\[at]{https://example.com/bib?name=foobar&date=2000}, p. 33]\f[R].
5829+.PP
5830+Citation items may optionally include a prefix, a locator, and a suffix.
5831+In
5832+.IP
5833+.nf
5834+\f[C]
5835+Blah blah [see \[at]doe99, pp. 33-35 and *passim*; \[at]smith04, chap. 1].
57955836\f[R]
57965837.fi
57975838.PP
5798−\f[C]pandoc\f[R] detects locator terms in the CSL locale files.
5839+The first item (\f[C]doe99\f[R]) has prefix \f[C]see\f[R], locator
5840+\f[C]pp. 33-35\f[R], and suffix \f[C]and *passim*\f[R].
5841+The second item (\f[C]smith04\f[R]) has locator \f[C]chap. 1\f[R] and no
5842+prefix or suffix.
5843+.PP
5844+Pandoc uses some heuristics to separate the locator from the rest of the
5845+subject.
5846+It is sensitive to the locator terms defined in the CSL locale files.
57995847Either abbreviated or unabbreviated forms are accepted.
58005848In the \f[C]en-US\f[R] locale, locator terms can be written in either
58015849singular or plural forms, as \f[C]book\f[R],
@@ -5817,9 +5865,8 @@ singular or plural forms, as \f[C]book\f[R],
58175865\f[C]\[sc]\f[R]/\f[C]\[sc]\[sc]\f[R].
58185866If no locator term is used, \[lq]page\[rq] is assumed.
58195867.PP
5820−\f[C]pandoc\f[R] will use heuristics to distinguish the locator from the
5821−suffix.
5822−In complex cases, the locator can be enclosed in curly braces:
5868+In complex cases, you can force something to be treated as a locator by
5869+enclosing it in curly braces:
58235870.IP
58245871.nf
58255872\f[C]
@@ -5838,7 +5885,8 @@ Smith says blah [-\[at]smith04].
58385885\f[R]
58395886.fi
58405887.PP
5841−You can also write an in-text citation, as follows:
5888+You can also write an author-in-text citation, by omitting the square
5889+brackets:
58425890.IP
58435891.nf
58445892\f[C]
@@ -5847,6 +5895,20 @@ You can also write an in-text citation, as follows:
58475895\[at]smith04 [p. 33] says blah.
58485896\f[R]
58495897.fi
5898+.PP
5899+This will cause the author\[cq]s name to be rendered, followed by the
5900+bibliographical details.
5901+Use this form when you want to make the citation the subject of a
5902+sentence.
5903+.PP
5904+When you are using a note style, it is usually better to let citeproc
5905+create the footnotes from citations rather than writing an explicit
5906+note.
5907+If you do write an explicit note that contains a citation, note that
5908+normal citations will be put in parentheses, while author-in-text
5909+citations will not.
5910+For this reason, it is sometimes preferable to use the author-in-text
5911+style inside notes when using a note style.
58505912.SS Non-pandoc extensions
58515913.PP
58525914The following Markdown syntax extensions are not enabled by default in
@@ -6626,6 +6688,11 @@ A heading at the slide level always starts a new slide.
66266688.IP \[bu] 2
66276689Headings \f[I]below\f[R] the slide level in the hierarchy create
66286690headings \f[I]within\f[R] a slide.
6691+(In beamer, a \[lq]block\[rq] will be created.
6692+If the heading has the class \f[C]example\f[R], an
6693+\f[C]exampleblock\f[R] environment will be used; if it has the class
6694+\f[C]alert\f[R], an \f[C]alertblock\f[R] will be used; otherwise a
6695+regular \f[C]block\f[R] will be used.)
66296696.IP \[bu] 2
66306697Headings \f[I]above\f[R] the slide level in the hierarchy create
66316698\[lq]title slides,\[rq] which just contain the section title and help to