git.iko.soy/typeable/pandoc
on master help sign in
Update man page.
commitb220165462a825aebf56d1fcc74174b721ce5e09 authorJohn MacFarlane <jgm@berkeley.edu> dateThu 17 Dec 2020, 11:19 (6 years ago) parentff58237
2 files changed+62−15
MANUAL.txt+1−1 man/pandoc.1+61−14
MANUAL.txt+1−1
@@ -1,7 +1,7 @@
11---
22title: Pandoc User's Guide
33author: John MacFarlane
4−date: November 19, 2020
4+date: December 17, 2020
55---
66
77# Synopsis
man/pandoc.1+61−14
@@ -1,7 +1,7 @@
11'\" t
2−.\" Automatically generated by Pandoc 2.11.2
2+.\" Automatically generated by Pandoc 2.11.3
33.\"
4−.TH "Pandoc User\[cq]s Guide" "" "November 19, 2020" "pandoc 2.11.2" ""
4+.TH "Pandoc User\[cq]s Guide" "" "December 17, 2020" "pandoc 2.11.3" ""
55.hy
66.SH NAME
77pandoc - general markup converter
@@ -933,13 +933,6 @@ Note that, if \f[C]--resource-path\f[R] is specified, the working
933933directory must be explicitly listed or it will not be searched.
934934For example: \f[C]--resource-path=.:test\f[R] will search the working
935935directory and the \f[C]test\f[R] subdirectory, in that order.
936−.RS
937−.PP
938−\f[C]--resource-path\f[R] only has an effect if (a) the output format
939−embeds images (for example, \f[C]docx\f[R], \f[C]pdf\f[R], or
940−\f[C]html\f[R] with \f[C]--self-contained\f[R]) or (b) it is used
941−together with \f[C]--extract-media\f[R].
942−.RE
943936.TP
944937\f[B]\f[CB]--request-header=\f[B]\f[R]\f[I]NAME\f[R]\f[B]\f[CB]:\f[B]\f[R]\f[I]VAL\f[R]
945938Set the request header \f[I]NAME\f[R] to the value \f[I]VAL\f[R] when
@@ -1034,7 +1027,8 @@ become \f[C]\[rs]part{..}\f[R], while second-level headings remain as
10341027their default type.
10351028.TP
10361029\f[B]\f[CB]-N\f[B]\f[R], \f[B]\f[CB]--number-sections\f[B]\f[R]
1037−Number section headings in LaTeX, ConTeXt, HTML, Docx, or EPUB output.
1030+Number section headings in LaTeX, ConTeXt, HTML, Docx, ms, or EPUB
1031+output.
10381032By default, sections are not numbered.
10391033Sections with class \f[C]unnumbered\f[R] will never be numbered, even if
10401034\f[C]--number-sections\f[R] is specified.
@@ -1426,6 +1420,9 @@ Set the \f[C]bibliography\f[R] field in the document\[cq]s metadata to
14261420\f[I]FILE\f[R], overriding any value set in the metadata.
14271421If you supply this argument multiple times, each \f[I]FILE\f[R] will be
14281422added to bibliography.
1423+If \f[I]FILE\f[R] is a URL, it will be fetched via HTTP.
1424+If \f[I]FILE\f[R] is not found relative to the working directory, it
1425+will be sought in the resource path (see \f[C]--resource-path\f[R]).
14291426.TP
14301427\f[B]\f[CB]--csl=\f[B]\f[R]\f[I]FILE\f[R]
14311428Set the \f[C]csl\f[R] field in the document\[cq]s metadata to
@@ -1433,8 +1430,9 @@ Set the \f[C]csl\f[R] field in the document\[cq]s metadata to
14331430(This is equivalent to \f[C]--metadata csl=FILE\f[R].) If \f[I]FILE\f[R]
14341431is a URL, it will be fetched via HTTP.
14351432If \f[I]FILE\f[R] is not found relative to the working directory, it
1436−will be sought in the resource path and finally in the \f[C]csl\f[R]
1437−subdirectory of the pandoc user data directory.
1433+will be sought in the resource path (see \f[C]--resource-path\f[R]) and
1434+finally in the \f[C]csl\f[R] subdirectory of the pandoc user data
1435+directory.
14381436.TP
14391437\f[B]\f[CB]--citation-abbreviations=\f[B]\f[R]\f[I]FILE\f[R]
14401438Set the \f[C]citation-abbreviations\f[R] field in the document\[cq]s
@@ -1443,8 +1441,9 @@ metadata to \f[I]FILE\f[R], overriding any value set in the metadata.
14431441\f[C]--metadata citation-abbreviations=FILE\f[R].) If \f[I]FILE\f[R] is
14441442a URL, it will be fetched via HTTP.
14451443If \f[I]FILE\f[R] is not found relative to the working directory, it
1446−will be sought in the resource path and finally in the \f[C]csl\f[R]
1447−subdirectory of the pandoc user data directory.
1444+will be sought in the resource path (see \f[C]--resource-path\f[R]) and
1445+finally in the \f[C]csl\f[R] subdirectory of the pandoc user data
1446+directory.
14481447.TP
14491448\f[B]\f[CB]--natbib\f[B]\f[R]
14501449Use \f[C]natbib\f[R] for citations in LaTeX output.
@@ -3376,6 +3375,43 @@ This extension can be enabled/disabled for the following formats:
33763375.TP
33773376output formats
33783377\f[C]odt\f[R], \f[C]opendocument\f[R]
3378+.SS Extension: \f[C]xrefs_name\f[R]
3379+.PP
3380+Links to headings, figures and tables inside the document are
3381+substituted with cross-references that will use the name or caption of
3382+the referenced item.
3383+The original link text is replaced once the generated document is
3384+refreshed.
3385+This extension can be combined with \f[C]xrefs_number\f[R] in which case
3386+numbers will appear before the name.
3387+.PP
3388+Text in cross-references is only made consistent with the referenced
3389+item once the document has been refreshed.
3390+.PP
3391+This extension can be enabled/disabled for the following formats:
3392+.TP
3393+output formats
3394+\f[C]odt\f[R], \f[C]opendocument\f[R]
3395+.SS Extension: \f[C]xrefs_number\f[R]
3396+.PP
3397+Links to headings, figures and tables inside the document are
3398+substituted with cross-references that will use the number of the
3399+referenced item.
3400+The original link text is discarded.
3401+This extension can be combined with \f[C]xrefs_name\f[R] in which case
3402+the name or caption numbers will appear after the number.
3403+.PP
3404+For the \f[C]xrefs_number\f[R] to be useful heading numbers must be
3405+enabled in the generated document, also table and figure captions must
3406+be enabled using for example the \f[C]native_numbering\f[R] extension.
3407+.PP
3408+Numbers in cross-references are only visible in the final document once
3409+it has been refreshed.
3410+.PP
3411+This extension can be enabled/disabled for the following formats:
3412+.TP
3413+output formats
3414+\f[C]odt\f[R], \f[C]opendocument\f[R]
33793415.SS Extension: \f[C]styles\f[R]
33803416.PP
33813417When converting from docx, read all docx styles as divs (for paragraph
@@ -5920,6 +5956,12 @@ be indented four spaces.
59205956Use Project Gutenberg conventions for \f[C]plain\f[R] output: all-caps
59215957for strong emphasis, surround by underscores for regular emphasis, add
59225958extra blank space around headings.
5959+.SS Extension: \f[C]sourcepos\f[R]
5960+.PP
5961+Include source position attributes when parsing \f[C]commonmark\f[R].
5962+For elements that accept attributes, a \f[C]data-pos\f[R] attribute is
5963+added; other elements are placed in a surrounding Div or Span elemnet
5964+with a \f[C]data-pos\f[R] attribute.
59235965.SS Markdown variants
59245966.PP
59255967In addition to pandoc\[cq]s extended Markdown, the following Markdown
@@ -6079,6 +6121,11 @@ references:
60796121\f[R]
60806122.fi
60816123.PP
6124+If both an external bibliography and inline (YAML metadata) references
6125+are provided, both will be used.
6126+In case of conflicting \f[C]id\f[R]s, the inline references will take
6127+precedence.
6128+.PP
60826129Note that \f[C]pandoc\f[R] can be used to produce such a YAML metadata
60836130section from a BibTeX, BibLaTeX, or CSL JSON bibliography:
60846131.IP