From 0c8ab8a12f69cdb2868ffe223aa938044fd447b4 Mon Sep 17 00:00:00 2001 From: John MacFarlane Date: Thu, 19 Nov 2020 13:04:46 -0800 Subject: Update README.md, man page. --- man/pandoc.1 | 36 ++++++++++++++++++++---------------- 1 file changed, 20 insertions(+), 16 deletions(-) (limited to 'man') diff --git a/man/pandoc.1 b/man/pandoc.1 index 3670d8877..5a4c833d2 100644 --- a/man/pandoc.1 +++ b/man/pandoc.1 @@ -1,7 +1,7 @@ '\" t -.\" Automatically generated by Pandoc 2.11.1 +.\" Automatically generated by Pandoc 2.11.2 .\" -.TH "Pandoc User\[cq]s Guide" "" "November 7, 2020" "pandoc 2.11.1.1" "" +.TH "Pandoc User\[cq]s Guide" "" "November 19, 2020" "pandoc 2.11.2" "" .hy .SH NAME pandoc - general markup converter @@ -1000,21 +1000,24 @@ By default inline links are used. The placement of link references is affected by the \f[C]--reference-location\f[R] option. .TP -\f[B]\f[CB]--reference-location = block\f[B]\f[R]|\f[B]\f[CB]section\f[B]\f[R]|\f[B]\f[CB]document\f[B]\f[R] +\f[B]\f[CB]--reference-location=block\f[B]\f[R]|\f[B]\f[CB]section\f[B]\f[R]|\f[B]\f[CB]document\f[B]\f[R] Specify whether footnotes (and references, if \f[C]reference-links\f[R] is set) are placed at the end of the current (top-level) block, the current section, or the document. The default is \f[C]document\f[R]. Currently only affects the markdown writer. .TP +\f[B]\f[CB]--markdown-headings=setext\f[B]\f[R]|\f[B]\f[CB]atx\f[B]\f[R] +Specify whether to use ATX-style (\f[C]#\f[R]-prefixed) or Setext-style +(underlined) headings for level 1 and 2 headings in Markdown output. +(The default is \f[C]atx\f[R].) ATX-style headings are always used for +levels 3+. +This option also affects Markdown cells in \f[C]ipynb\f[R] output. +.TP \f[B]\f[CB]--atx-headers\f[B]\f[R] -Use ATX-style headings in Markdown output. -The default is to use setext-style headings for levels 1 to 2, and then -ATX headings. -(Note: for \f[C]gfm\f[R] output, ATX headings are always used.) This -option also affects markdown cells in \f[C]ipynb\f[R] output. +\f[I]Deprecated synonym for \f[CI]--markdown-headings=atx\f[I].\f[R] .TP -\f[B]\f[CB]--top-level-division=[default|section|chapter|part]\f[B]\f[R] +\f[B]\f[CB]--top-level-division=default\f[B]\f[R]|\f[B]\f[CB]section\f[B]\f[R]|\f[B]\f[CB]chapter\f[B]\f[R]|\f[B]\f[CB]part\f[B]\f[R] Treat top-level headings as the given division type in LaTeX, ConTeXt, DocBook, and TEI output. The hierarchy order is part, chapter, then section; all headings are @@ -1839,7 +1842,7 @@ epub-cover-image: cover.jpg reference-links: true # block, section, or document reference-location: block -atx-headers: false +markdown-headings: setext # accept, reject, or all track-changes: accept @@ -2365,7 +2368,8 @@ including a title block in the document itself, you can set the \f[C]title-meta\f[R], \f[C]author-meta\f[R], and \f[C]date-meta\f[R] variables. (By default these are set automatically, based on \f[C]title\f[R], -\f[C]author\f[R], and \f[C]date\f[R].) +\f[C]author\f[R], and \f[C]date\f[R].) The page title in HTML is set by +\f[C]pagetitle\f[R], which is equal to \f[C]title\f[R] by default. .RE .TP \f[B]\f[CB]subtitle\f[B]\f[R] @@ -2888,10 +2892,10 @@ paper size, e.g.\ \f[C]letter\f[R], \f[C]A4\f[R], \f[C]landscape\f[R] \f[B]\f[CB]pdfa\f[B]\f[R] adds to the preamble the setup necessary to generate PDF/A of the type specified, e.g.\ \f[C]1a:2005\f[R], \f[C]2a\f[R]. -If no type is specified (i.e.\ the value is set to True, by -e.g.\ \f[C]--metadata=pdfa\f[R] or \f[C]pdfa: true\f[R] in a YAML -metadata block), \f[C]1b:2005\f[R] will be used as default, for reasons -of backwards compatibility. +If no type is specified (i.e.\ the value is set to True, by e.g. +\f[C]--metadata=pdfa\f[R] or \f[C]pdfa: true\f[R] in a YAML metadata +block), \f[C]1b:2005\f[R] will be used as default, for reasons of +backwards compatibility. Using \f[C]--variable=pdfa\f[R] without specified value is not supported. To successfully generate PDF/A the required ICC color profiles have to @@ -6314,7 +6318,7 @@ Bear in mind that bibliography files have to be in either BibTeX (for .PP A few other metadata fields affect bibliography formatting: .TP -\f[B]\f[CB]link-citation\f[B]\f[R] +\f[B]\f[CB]link-citations\f[B]\f[R] If true, citations will be hyperlinked to the corresponding bibliography entries (for author-date and numerical styles only). .TP -- cgit v1.2.3