"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "MANUAL.txt" between
pandoc-2.11.1.1.tar.gz and pandoc-2.11.2.tar.gz

About: Pandoc converts files from one markup format into another.

MANUAL.txt  (pandoc-2.11.1.1):MANUAL.txt  (pandoc-2.11.2)
--- ---
title: Pandoc User's Guide title: Pandoc User's Guide
author: John MacFarlane author: John MacFarlane
date: November 7, 2020 date: November 19, 2020
--- ---
# Synopsis # Synopsis
`pandoc` [*options*] [*input-file*]... `pandoc` [*options*] [*input-file*]...
# Description # Description
Pandoc is a [Haskell] library for converting from one markup format to Pandoc is a [Haskell] library for converting from one markup format to
another, and a command-line tool that uses this library. another, and a command-line tool that uses this library.
skipping to change at line 964 skipping to change at line 964
limited degree LaTeX (which uses standard commands for accented limited degree LaTeX (which uses standard commands for accented
characters when possible). roff man output uses ASCII by default. characters when possible). roff man output uses ASCII by default.
`--reference-links` `--reference-links`
: Use reference-style links, rather than inline links, in writing Markdown : Use reference-style links, rather than inline links, in writing Markdown
or reStructuredText. By default inline links are used. The or reStructuredText. By default inline links are used. The
placement of link references is affected by the placement of link references is affected by the
`--reference-location` option. `--reference-location` option.
`--reference-location = block`|`section`|`document` `--reference-location=block`|`section`|`document`
: Specify whether footnotes (and references, if `reference-links` is : Specify whether footnotes (and references, if `reference-links` is
set) are placed at the end of the current (top-level) block, the set) are placed at the end of the current (top-level) block, the
current section, or the document. The default is current section, or the document. The default is
`document`. Currently only affects the markdown writer. `document`. Currently only affects the markdown writer.
`--markdown-headings=setext`|`atx`
: Specify whether to use ATX-style (`#`-prefixed) or
Setext-style (underlined) headings for level 1 and 2
headings in Markdown output. (The default is `atx`.)
ATX-style headings are always used for levels 3+.
This option also affects Markdown cells in `ipynb` output.
`--atx-headers` `--atx-headers`
: Use ATX-style headings in Markdown output. The default is : *Deprecated synonym for `--markdown-headings=atx`.*
to use setext-style headings for levels 1 to 2, and then ATX headings.
(Note: for `gfm` output, ATX headings are always used.) `--top-level-division=default`|`section`|`chapter`|`part`
This option also affects markdown cells in `ipynb` output.
: Treat top-level headings as the given division type in
`--top-level-division=[default|section|chapter|part]` LaTeX, ConTeXt, DocBook, and TEI output. The hierarchy
order is part, chapter, then section; all headings are
: Treat top-level headings as the given division type in LaTeX, ConTeXt, shifted such that the top-level heading becomes the
DocBook, and TEI output. The hierarchy order is part, chapter, then section specified type. The default behavior is to determine the
; best division type via heuristics: unless other conditions
all headings are shifted such that the top-level heading becomes the specifi apply, `section` is chosen. When the `documentclass`
ed variable is set to `report`, `book`, or `memoir` (unless the
type. The default behavior is to determine the best division type via `article` option is specified), `chapter` is implied as the
heuristics: unless other conditions apply, `section` is chosen. When the setting for this option. If `beamer` is the output format,
`documentclass` variable is set to `report`, `book`, or `memoir` (unless the specifying either `chapter` or `part` will cause top-level
`article` option is specified), `chapter` is implied as the setting for this headings to become `\part{..}`, while second-level headings
option. If `beamer` is the output format, specifying either `chapter` or remain as their default type.
`part` will cause top-level headings to become `\part{..}`, while
second-level headings remain as their default type.
`-N`, `--number-sections` `-N`, `--number-sections`
: Number section headings in LaTeX, ConTeXt, HTML, Docx, or EPUB output. : Number section headings in LaTeX, ConTeXt, HTML, Docx, or EPUB output.
By default, sections are not numbered. Sections with class By default, sections are not numbered. Sections with class
`unnumbered` will never be numbered, even if `--number-sections` `unnumbered` will never be numbered, even if `--number-sections`
is specified. is specified.
`--number-offset=`*NUMBER*[`,`*NUMBER*`,`*...*] `--number-offset=`*NUMBER*[`,`*NUMBER*`,`*...*]
skipping to change at line 1351 skipping to change at line 1359
: Set the `citation-abbreviations` field in the document's metadata to : Set the `citation-abbreviations` field in the document's metadata to
*FILE*, overriding any value set in the metadata. (This is equivalent to *FILE*, overriding any value set in the metadata. (This is equivalent to
`--metadata citation-abbreviations=FILE`.) `--metadata citation-abbreviations=FILE`.)
If *FILE* is a URL, it will be fetched via HTTP. If *FILE* is not If *FILE* is a URL, it will be fetched via HTTP. If *FILE* is not
found relative to the working directory, it will be sought found relative to the working directory, it will be sought
in the resource path and finally in the `csl` subdirectory in the resource path and finally in the `csl` subdirectory
of the pandoc user data directory. of the pandoc user data directory.
`--natbib` `--natbib`
: Use [`natbib`] for citations in LaTeX output. This option is not for use : Use [`natbib`] for citations in LaTeX output. This option
with the `--citeproc` option or with PDF output. It is intended for is not for use with the `--citeproc` option or with PDF
use in producing a LaTeX file that can be processed with [`bibtex`]. output. It is intended for use in producing a LaTeX file
that can be processed with [`bibtex`].
`--biblatex` `--biblatex`
: Use [`biblatex`] for citations in LaTeX output. This option is not for use : Use [`biblatex`] for citations in LaTeX output. This option
with the `--citeproc` option or with PDF output. It is intended for is not for use with the `--citeproc` option or with PDF
use in producing a LaTeX file that can be processed with [`bibtex`] or [`bib output. It is intended for use in producing a LaTeX file
er`]. that can be processed with [`bibtex`] or [`biber`].
## Math rendering in HTML {.options} ## Math rendering in HTML {.options}
The default is to render TeX math as far as possible using Unicode characters. The default is to render TeX math as far as possible using
Formulas are put inside a `span` with `class="math"`, so that they may be styled Unicode characters. Formulas are put inside a `span` with
differently from the surrounding text if needed. However, this gives acceptable `class="math"`, so that they may be styled differently from the
results only for basic math, usually you will want to use `--mathjax` or another surrounding text if needed. However, this gives acceptable
of the following options. results only for basic math, usually you will want to use
`--mathjax` or another of the following options.
`--mathjax`[`=`*URL*] `--mathjax`[`=`*URL*]
: Use [MathJax] to display embedded TeX math in HTML output. : Use [MathJax] to display embedded TeX math in HTML output.
TeX math will be put between `\(...\)` (for inline math) TeX math will be put between `\(...\)` (for inline math)
or `\[...\]` (for display math) and wrapped in `<span>` tags or `\[...\]` (for display math) and wrapped in `<span>` tags
with class `math`. Then the MathJax JavaScript will render it. with class `math`. Then the MathJax JavaScript will render it.
The *URL* should point to the `MathJax.js` load script. The *URL* should point to the `MathJax.js` load script.
If a *URL* is not provided, a link to the Cloudflare CDN will If a *URL* is not provided, a link to the Cloudflare CDN will
be inserted. be inserted.
`--mathml` `--mathml`
: Convert TeX math to [MathML] (in `epub3`, `docbook4`, `docbook5`, `jats`, : Convert TeX math to [MathML] (in `epub3`, `docbook4`,
`html4` and `html5`). This is the default in `odt` output. Note that `docbook5`, `jats`, `html4` and `html5`). This is the
currently only Firefox and Safari (and select e-book readers) natively default in `odt` output. Note that currently only Firefox
support MathML. and Safari (and select e-book readers) natively support
MathML.
`--webtex`[`=`*URL*] `--webtex`[`=`*URL*]
: Convert TeX formulas to `<img>` tags that link to an external script : Convert TeX formulas to `<img>` tags that link to an external script
that converts formulas to images. The formula will be URL-encoded that converts formulas to images. The formula will be URL-encoded
and concatenated with the URL provided. For SVG images you can for and concatenated with the URL provided. For SVG images you can for
example use `--webtex https://latex.codecogs.com/svg.latex?`. example use `--webtex https://latex.codecogs.com/svg.latex?`.
If no URL is specified, the CodeCogs URL generating PNGs If no URL is specified, the CodeCogs URL generating PNGs
will be used (`https://latex.codecogs.com/png.latex?`). will be used (`https://latex.codecogs.com/png.latex?`).
Note: the `--webtex` option will affect Markdown output Note: the `--webtex` option will affect Markdown output
skipping to change at line 1625 skipping to change at line 1637
epub-subdirectory: EPUB epub-subdirectory: EPUB
epub-metadata: meta.xml epub-metadata: meta.xml
epub-fonts: epub-fonts:
- foobar.otf - foobar.otf
epub-chapter-level: 1 epub-chapter-level: 1
epub-cover-image: cover.jpg epub-cover-image: cover.jpg
reference-links: true reference-links: true
# block, section, or document # block, section, or document
reference-location: block reference-location: block
atx-headers: false markdown-headings: setext
# accept, reject, or all # accept, reject, or all
track-changes: accept track-changes: accept
html-q-tags: false html-q-tags: false
css: css:
- site.css - site.css
# none, all, or best # none, all, or best
ipynb-output: best ipynb-output: best
skipping to change at line 2099 skipping to change at line 2111
--- ---
author: author:
- Aristotle - Aristotle
- Peter Abelard - Peter Abelard
... ...
Note that if you just want to set PDF or HTML metadata, without Note that if you just want to set PDF or HTML metadata, without
including a title block in the document itself, you can including a title block in the document itself, you can
set the `title-meta`, `author-meta`, and `date-meta` set the `title-meta`, `author-meta`, and `date-meta`
variables. (By default these are set automatically, based variables. (By default these are set automatically, based
on `title`, `author`, and `date`.) on `title`, `author`, and `date`.) The page title in HTML
is set by `pagetitle`, which is equal to `title` by default.
`subtitle` `subtitle`
: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx : document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx
documents documents
`abstract` `abstract`
: document summary, included in LaTeX, ConTeXt, AsciiDoc, and docx : document summary, included in LaTeX, ConTeXt, AsciiDoc, and docx
documents documents
`keywords` `keywords`
skipping to change at line 2173 skipping to change at line 2186
::: {lang=fr-CA} ::: {lang=fr-CA}
> Cette citation est écrite en français canadien. > Cette citation est écrite en français canadien.
::: :::
More text in English. ['Zitat auf Deutsch.']{lang=de} More text in English. ['Zitat auf Deutsch.']{lang=de}
`dir` `dir`
: the base script direction, either `rtl` (right-to-left) : the base script direction, either `rtl` (right-to-left)
or `ltr` (left-to-right). or `ltr` (left-to-right).
For bidirectional documents, native pandoc `span`s and `div`s For bidirectional documents, native pandoc `span`s and
with the `dir` attribute (value `rtl` or `ltr`) can be used to `div`s with the `dir` attribute (value `rtl` or `ltr`) can
override the base direction in some output formats. be used to override the base direction in some output
This may not always be necessary if the final renderer formats. This may not always be necessary if the final
(e.g. the browser, when generating HTML) supports the renderer (e.g. the browser, when generating HTML) supports
[Unicode Bidirectional Algorithm]. the [Unicode Bidirectional Algorithm].
When using LaTeX for bidirectional documents, only the `xelatex` engine When using LaTeX for bidirectional documents, only the
is fully supported (use `--pdf-engine=xelatex`). `xelatex` engine is fully supported (use
`--pdf-engine=xelatex`).
[BCP 47]: https://tools.ietf.org/html/bcp47 [BCP 47]: https://tools.ietf.org/html/bcp47
[Unicode Bidirectional Algorithm]: https://www.w3.org/International/articles/inl ine-bidi-markup/uba-basics [Unicode Bidirectional Algorithm]: https://www.w3.org/International/articles/inl ine-bidi-markup/uba-basics
[Language subtag lookup]: https://r12a.github.io/app-subtags/ [Language subtag lookup]: https://r12a.github.io/app-subtags/
### Variables for HTML ### Variables for HTML
`document-css` `document-css`
: Enables inclusion of most of the [CSS] in the `styles.html` : Enables inclusion of most of the [CSS] in the `styles.html`
[partial](#partials) (have a look with [partial](#partials) (have a look with
skipping to change at line 2253 skipping to change at line 2267
border-bottom: none; border-bottom: none;
} }
</style> </style>
--- ---
[CSS]: https://developer.mozilla.org/en-US/docs/Learn/CSS [CSS]: https://developer.mozilla.org/en-US/docs/Learn/CSS
### Variables for HTML math ### Variables for HTML math
`classoption` `classoption`
: when using [KaTeX](#option--katex), you can render display math equations : when using [KaTeX](#option--katex), you can render display
flush left using [YAML metadata](#layout) or with `-M classoption=fleqn`. math equations flush left using [YAML metadata](#layout) or with
`-M classoption=fleqn`.
### Variables for HTML slides ### Variables for HTML slides
These affect HTML output when [producing slide shows with pandoc]. These affect HTML output when [producing slide shows with pandoc].
All [reveal.js configuration options] are available as variables. All [reveal.js configuration options] are available as variables.
To turn off boolean flags that default to true in reveal.js, use `0`. To turn off boolean flags that default to true in reveal.js, use `0`.
`revealjs-url` `revealjs-url`
: base URL for reveal.js documents (defaults to : base URL for reveal.js documents (defaults to
skipping to change at line 2366 skipping to change at line 2381
`classoption` `classoption`
: option for document class, e.g. `oneside`; repeat for multiple options: : option for document class, e.g. `oneside`; repeat for multiple options:
--- ---
classoption: classoption:
- twocolumn - twocolumn
- landscape - landscape
... ...
`documentclass` `documentclass`
: document class: usually one of the standard classes, [`article`], [`book`], : document class: usually one of the standard classes,
and [`report`]; the [KOMA-Script] equivalents, `scrartcl`, `scrbook`, [`article`], [`book`], and [`report`]; the [KOMA-Script]
and `scrreprt`, which default to smaller margins; or [`memoir`] equivalents, `scrartcl`, `scrbook`, and `scrreprt`, which
default to smaller margins; or [`memoir`]
`geometry` `geometry`
: option for [`geometry`] package, e.g. `margin=1in`; : option for [`geometry`] package, e.g. `margin=1in`;
repeat for multiple options: repeat for multiple options:
--- ---
geometry: geometry:
- top=30mm - top=30mm
- left=20mm - left=20mm
- heightrounded - heightrounded
skipping to change at line 2393 skipping to change at line 2409
repeat for multiple options: repeat for multiple options:
--- ---
hyperrefoptions: hyperrefoptions:
- linktoc=all - linktoc=all
- pdfwindowui - pdfwindowui
- pdfpagemode=FullScreen - pdfpagemode=FullScreen
... ...
`indent` `indent`
: if true, pandoc will use document class settings for indentation (the defaul : if true, pandoc will use document class settings for
t LaTeX template indentation (the default LaTeX template otherwise removes
otherwise removes indentation and adds space between paragraphs) indentation and adds space between paragraphs)
`linestretch` `linestretch`
: adjusts line spacing using the [`setspace`] : adjusts line spacing using the [`setspace`]
package, e.g. `1.25`, `1.5` package, e.g. `1.25`, `1.5`
`margin-left`, `margin-right`, `margin-top`, `margin-bottom` `margin-left`, `margin-right`, `margin-top`, `margin-bottom`
: sets margins if `geometry` is not used (otherwise `geometry` : sets margins if `geometry` is not used (otherwise `geometry`
overrides these) overrides these)
`pagestyle` `pagestyle`
skipping to change at line 2419 skipping to change at line 2436
`papersize` `papersize`
: paper size, e.g. `letter`, `a4` : paper size, e.g. `letter`, `a4`
`secnumdepth` `secnumdepth`
: numbering depth for sections (with `--number-sections` option : numbering depth for sections (with `--number-sections` option
or `numbersections` variable) or `numbersections` variable)
#### Fonts #### Fonts
`fontenc` `fontenc`
: allows font encoding to be specified through `fontenc` package (with `pdflat : allows font encoding to be specified through `fontenc` package (with
ex`); `pdflatex`); default is `T1` (see [LaTeX font encodings guide])
default is `T1` (see [LaTeX font encodings guide])
`fontfamily` `fontfamily`
: font package for use with `pdflatex`: : font package for use with `pdflatex`:
[TeX Live] includes many options, documented in the [LaTeX Font Catalogue]. [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
The default is [Latin Modern][`lm`]. The default is [Latin Modern][`lm`].
`fontfamilyoptions` `fontfamilyoptions`
: options for package used as `fontfamily`; repeat for multiple options. : options for package used as `fontfamily`; repeat for multiple options.
For example, to use the Libertine font with proportional lowercase For example, to use the Libertine font with proportional lowercase
(old-style) figures through the [`libertinus`] package: (old-style) figures through the [`libertinus`] package:
skipping to change at line 2490 skipping to change at line 2507
#### Front matter #### Front matter
`lof`, `lot` `lof`, `lot`
: include list of figures, list of tables : include list of figures, list of tables
`thanks` `thanks`
: contents of acknowledgments footnote after document title : contents of acknowledgments footnote after document title
`toc` `toc`
: include table of contents (can also be set using `--toc/--table-of-contents` : include table of contents (can also be set using
) `--toc/--table-of-contents`)
`toc-depth` `toc-depth`
: level of section to include in table of contents : level of section to include in table of contents
#### BibLaTeX Bibliographies #### BibLaTeX Bibliographies
These variables function when using BibLaTeX for [citation rendering]. These variables function when using BibLaTeX for [citation rendering].
`biblatexoptions` `biblatexoptions`
: list of options for biblatex : list of options for biblatex
skipping to change at line 2532 skipping to change at line 2550
[`report`]: https://ctan.org/pkg/report [`report`]: https://ctan.org/pkg/report
### Variables for ConTeXt ### Variables for ConTeXt
Pandoc uses these variables when [creating a PDF] with ConTeXt. Pandoc uses these variables when [creating a PDF] with ConTeXt.
`fontsize` `fontsize`
: font size for body text (e.g. `10pt`, `12pt`) : font size for body text (e.g. `10pt`, `12pt`)
`headertext`, `footertext` `headertext`, `footertext`
: text to be placed in running header or footer (see [ConTeXt Headers and Foot : text to be placed in running header or footer (see [ConTeXt Headers and
ers]); Footers]); repeat up to four times for different placement
repeat up to four times for different placement
`indenting` `indenting`
: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Inde : controls indentation of paragraphs, e.g. `yes,small,next` (see
ntation]); [ConTeXt Indentation]); repeat for multiple options
repeat for multiple options
`interlinespace` `interlinespace`
: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]); : adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
repeat for multiple options repeat for multiple options
`layout` `layout`
: options for page margins and text arrangement (see [ConTeXt Layout]); : options for page margins and text arrangement (see [ConTeXt Layout]);
repeat for multiple options repeat for multiple options
`linkcolor`, `contrastcolor` `linkcolor`, `contrastcolor`
: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt : color for links outside and inside a page, e.g. `red`, `blue` (see
Color]) [ConTeXt Color])
`linkstyle` `linkstyle`
: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, ` : typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`,
type`, `cap`, `small` `type`, `cap`, `small`
`lof`, `lot` `lof`, `lot`
: include list of figures, list of tables : include list of figures, list of tables
`mainfont`, `sansfont`, `monofont`, `mathfont` `mainfont`, `sansfont`, `monofont`, `mathfont`
: font families: take the name of any system font (see [ConTeXt Font Switching : font families: take the name of any system font (see
]) [ConTeXt Font Switching])
`margin-left`, `margin-right`, `margin-top`, `margin-bottom` `margin-left`, `margin-right`, `margin-top`, `margin-bottom`
: sets margins, if `layout` is not used (otherwise `layout` : sets margins, if `layout` is not used (otherwise `layout`
overrides these) overrides these)
`pagenumbering` `pagenumbering`
: page number style and location (using [`setuppagenumbering`]); : page number style and location (using [`setuppagenumbering`]);
repeat for multiple options repeat for multiple options
`papersize` `papersize`
: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]); : paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
repeat for multiple options repeat for multiple options
`pdfa` `pdfa`
: adds to the preamble the setup necessary to generate PDF/A of the type : adds to the preamble the setup necessary to generate PDF/A
specified, e.g. `1a:2005`, `2a`. If no type is specified (i.e. the value of the type specified, e.g. `1a:2005`, `2a`. If no type is
is set to True, by e.g. `--metadata=pdfa` or `pdfa: true` in a YAML metadata specified (i.e. the value is set to True, by e.g.
block), `1b:2005` will be used as default, for reasons of backwards `--metadata=pdfa` or `pdfa: true` in a YAML metadata block),
compatibility. Using `--variable=pdfa` without specified value is not suppor `1b:2005` will be used as default, for reasons of backwards
ted. compatibility. Using `--variable=pdfa` without specified value
To successfully generate PDF/A the required ICC color profiles have to is not supported. To successfully generate PDF/A the required
be available and the content and all included files (such as images) ICC color profiles have to be available and the content and all
have to be standard conforming. The ICC profiles and output intent included files (such as images) have to be standard conforming.
may be specified using the variables `pdfaiccprofile` and `pdfaintent`. The ICC profiles and output intent may be specified using the
See also [ConTeXt PDFA] for more details. variables `pdfaiccprofile` and `pdfaintent`. See also [ConTeXt
PDFA] for more details.
`pdfaiccprofile` `pdfaiccprofile`
: when used in conjunction with `pdfa`, specifies the ICC profile to use : when used in conjunction with `pdfa`, specifies the ICC profile to use
in the PDF, e.g. `default.cmyk`. If left unspecified, `sRGB.icc` is in the PDF, e.g. `default.cmyk`. If left unspecified, `sRGB.icc` is
used as default. May be repeated to include multiple profiles. Note that used as default. May be repeated to include multiple profiles. Note that
the profiles have to be available on the system. They can be obtained the profiles have to be available on the system. They can be obtained
from [ConTeXt ICC Profiles]. from [ConTeXt ICC Profiles].
`pdfaintent` `pdfaintent`
: when used in conjunction with `pdfa`, specifies the output intent for : when used in conjunction with `pdfa`, specifies the output intent for
the colors, e.g. `ISO coated v2 300\letterpercent\space (ECI)` the colors, e.g. `ISO coated v2 300\letterpercent\space (ECI)`
If left unspecified, `sRGB IEC61966-2.1` is used as default. If left unspecified, `sRGB IEC61966-2.1` is used as default.
`toc` `toc`
: include table of contents (can also be set using `--toc/--table-of-contents` : include table of contents (can also be set using
) `--toc/--table-of-contents`)
`whitespace` `whitespace`
: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`]) : spacing between paragraphs, e.g. `none`, `small` (using
[`setupwhitespace`])
`includesource` `includesource`
: include all source documents as file attachments in the PDF file : include all source documents as file attachments in the PDF file
[ConTeXt Paper Setup]: https://wiki.contextgarden.net/PaperSetup [ConTeXt Paper Setup]: https://wiki.contextgarden.net/PaperSetup
[ConTeXt Layout]: https://wiki.contextgarden.net/Layout [ConTeXt Layout]: https://wiki.contextgarden.net/Layout
[ConTeXt Font Switching]: https://wiki.contextgarden.net/Font_Switching [ConTeXt Font Switching]: https://wiki.contextgarden.net/Font_Switching
[ConTeXt Color]: https://wiki.contextgarden.net/Color [ConTeXt Color]: https://wiki.contextgarden.net/Color
[ConTeXt Headers and Footers]: https://wiki.contextgarden.net/Headers_and_Footer s [ConTeXt Headers and Footers]: https://wiki.contextgarden.net/Headers_and_Footer s
[ConTeXt Indentation]: https://wiki.contextgarden.net/Indentation [ConTeXt Indentation]: https://wiki.contextgarden.net/Indentation
skipping to change at line 3028 skipping to change at line 3053
#### Extension: `raw_markdown` #### #### Extension: `raw_markdown` ####
In the `ipynb` input format, this causes Markdown cells In the `ipynb` input format, this causes Markdown cells
to be included as raw Markdown blocks (allowing lossless to be included as raw Markdown blocks (allowing lossless
round-tripping) rather than being parsed. Use this only round-tripping) rather than being parsed. Use this only
when you are targeting `ipynb` or a markdown-based when you are targeting `ipynb` or a markdown-based
output format. output format.
#### Extension: `citations` {#org-citations} #### Extension: `citations` {#org-citations}
Some aspects of [Pandoc's Markdown citation syntax](#citations) are also accepte Some aspects of [Pandoc's Markdown citation syntax](#citations)
d are also accepted in `org` input.
in `org` input.
#### Extension: `ntb` #### #### Extension: `ntb` ####
In the `context` output format this enables the use of [Natural Tables In the `context` output format this enables the use of [Natural Tables
(TABLE)](https://wiki.contextgarden.net/TABLE) instead of the default (TABLE)](https://wiki.contextgarden.net/TABLE) instead of the default
[Extreme Tables (xtables)](https://wiki.contextgarden.net/xtables). [Extreme Tables (xtables)](https://wiki.contextgarden.net/xtables).
Natural tables allow more fine-grained global customization but come Natural tables allow more fine-grained global customization but come
at a performance penalty compared to extreme tables. at a performance penalty compared to extreme tables.
# Pandoc's Markdown # Pandoc's Markdown
skipping to change at line 3135 skipping to change at line 3160
#### Extension: `space_in_atx_header` #### #### Extension: `space_in_atx_header` ####
Many Markdown implementations do not require a space between the Many Markdown implementations do not require a space between the
opening `#`s of an ATX heading and the heading text, so that opening `#`s of an ATX heading and the heading text, so that
`#5 bolt` and `#hashtag` count as headings. With this extension, `#5 bolt` and `#hashtag` count as headings. With this extension,
pandoc does require the space. pandoc does require the space.
### Heading identifiers ### ### Heading identifiers ###
See also the [`auto_identifiers` extension](#extension-auto_identifiers) above. See also the [`auto_identifiers`
extension](#extension-auto_identifiers) above.
#### Extension: `header_attributes` #### #### Extension: `header_attributes` ####
Headings can be assigned attributes using this syntax at the end Headings can be assigned attributes using this syntax at the end
of the line containing the heading text: of the line containing the heading text:
{#identifier .class .class key=value key=value} {#identifier .class .class key=value key=value}
Thus, for example, the following headings will all be assigned the identifier Thus, for example, the following headings will all be assigned the identifier
`foo`: `foo`:
skipping to change at line 3257 skipping to change at line 3283
If the `>` character is followed by an optional space, that space If the `>` character is followed by an optional space, that space
will be considered part of the block quote marker and not part of will be considered part of the block quote marker and not part of
the indentation of the contents. Thus, to put an indented code the indentation of the contents. Thus, to put an indented code
block in a block quote, you need five spaces after the `>`: block in a block quote, you need five spaces after the `>`:
> code > code
#### Extension: `blank_before_blockquote` #### #### Extension: `blank_before_blockquote` ####
Standard Markdown syntax does not require a blank line before a block Standard Markdown syntax does not require a blank line before a
quote. Pandoc does require this (except, of course, at the beginning of the block quote. Pandoc does require this (except, of course, at
document). The reason for the requirement is that it is all too easy for a the beginning of the document). The reason for the requirement
`>` to end up at the beginning of a line by accident (perhaps through line is that it is all too easy for a `>` to end up at the beginning
wrapping). So, unless the `markdown_strict` format is used, the following does of a line by accident (perhaps through line wrapping). So,
unless the `markdown_strict` format is used, the following does
not produce a nested block quote in pandoc: not produce a nested block quote in pandoc:
> This is a block quote. > This is a block quote.
>> Nested. >> Nested.
## Verbatim (code) blocks ## Verbatim (code) blocks
### Indented code blocks ### ### Indented code blocks ###
A block of text indented four spaces (or one tab) is treated as verbatim A block of text indented four spaces (or one tab) is treated as verbatim
skipping to change at line 3328 skipping to change at line 3355
Optionally, you may attach attributes to fenced or backtick code block using Optionally, you may attach attributes to fenced or backtick code block using
this syntax: this syntax:
~~~~ {#mycode .haskell .numberLines startFrom="100"} ~~~~ {#mycode .haskell .numberLines startFrom="100"}
qsort [] = [] qsort [] = []
qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++ qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
qsort (filter (>= x) xs) qsort (filter (>= x) xs)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and Here `mycode` is an identifier, `haskell` and `numberLines` are
`startFrom` is an attribute with value `100`. Some output formats can use this classes, and `startFrom` is an attribute with value `100`. Some
information to do syntax highlighting. Currently, the only output formats output formats can use this information to do syntax
that uses this information are HTML, LaTeX, Docx, Ms, and PowerPoint. If highlighting. Currently, the only output formats that uses this
highlighting is supported for your output format and language, then the code information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
block above will appear highlighted, with numbered lines. (To see which highlighting is supported for your output format and language,
languages are supported, type `pandoc --list-highlight-languages`.) Otherwise, then the code block above will appear highlighted, with numbered
the code block above will appear as follows: lines. (To see which languages are supported, type `pandoc
--list-highlight-languages`.) Otherwise, the code block above
will appear as follows:
<pre id="mycode" class="haskell numberLines" startFrom="100"> <pre id="mycode" class="haskell numberLines" startFrom="100">
<code> <code>
... ...
</code> </code>
</pre> </pre>
The `numberLines` (or `number-lines`) class will cause the lines The `numberLines` (or `number-lines`) class will cause the lines
of the code block to be numbered, starting with `1` or the value of the code block to be numbered, starting with `1` or the value
of the `startFrom` attribute. The `lineAnchors` (or of the `startFrom` attribute. The `lineAnchors` (or
skipping to change at line 3601 skipping to change at line 3630
{ some code, part of Definition 2 } { some code, part of Definition 2 }
Third paragraph of definition 2. Third paragraph of definition 2.
Each term must fit on one line, which may optionally be followed by Each term must fit on one line, which may optionally be followed by
a blank line, and must be followed by one or more definitions. a blank line, and must be followed by one or more definitions.
A definition begins with a colon or tilde, which may be indented one A definition begins with a colon or tilde, which may be indented one
or two spaces. or two spaces.
A term may have multiple definitions, and each definition may consist of one or A term may have multiple definitions, and each definition may
more block elements (paragraph, code block, list, etc.), each indented four consist of one or more block elements (paragraph, code block,
spaces or one tab stop. The body of the definition (including the first line, list, etc.), each indented four spaces or one tab stop. The
aside from the colon or tilde) should be indented four spaces. However, body of the definition (including the first line, aside from the
as with other Markdown lists, you can "lazily" omit indentation except colon or tilde) should be indented four spaces. However, as with
other Markdown lists, you can "lazily" omit indentation except
at the beginning of a paragraph or other block element: at the beginning of a paragraph or other block element:
Term 1 Term 1
: Definition : Definition
with lazy continuation. with lazy continuation.
Second paragraph of the definition. Second paragraph of the definition.
If you leave space before the definition (as in the example above), If you leave space before the definition (as in the example above),
skipping to change at line 3633 skipping to change at line 3663
Term 2 Term 2
~ Definition 2a ~ Definition 2a
~ Definition 2b ~ Definition 2b
Note that space between items in a definition list is required. Note that space between items in a definition list is required.
(A variant that loosens this requirement, but disallows "lazy" (A variant that loosens this requirement, but disallows "lazy"
hard wrapping, can be activated with `compact_definition_lists`: see hard wrapping, can be activated with `compact_definition_lists`: see
[Non-pandoc extensions], below.) [Non-pandoc extensions], below.)
[^3]: I have been influenced by the suggestions of [David Wheeler](https://just [^3]: I have been influenced by the suggestions of [David
atheory.com/2009/02/modest-markdown-proposal/). Wheeler](https://justatheory.com/2009/02/modest-markdown-proposal/).
### Numbered example lists ### ### Numbered example lists ###
#### Extension: `example_lists` #### #### Extension: `example_lists` ####
The special list marker `@` can be used for sequentially numbered The special list marker `@` can be used for sequentially numbered
examples. The first list item with a `@` marker will be numbered '1', examples. The first list item with a `@` marker will be numbered '1',
the next '2', and so on, throughout the document. The numbered examples the next '2', and so on, throughout the document. The numbered examples
need not occur in a single list; each new list using `@` will take up need not occur in a single list; each new list using `@` will take up
where the last stopped. So, for example: where the last stopped. So, for example:
skipping to change at line 5253 skipping to change at line 5284
[Citation Style Language], listed in the [Zotero Style Repository]. [Citation Style Language], listed in the [Zotero Style Repository].
These files are specified using the `--csl` option or the `csl` These files are specified using the `--csl` option or the `csl`
(or `citation-style`) metadata field. By default, pandoc will (or `citation-style`) metadata field. By default, pandoc will
use the [Chicago Manual of Style] author-date format. (You can use the [Chicago Manual of Style] author-date format. (You can
override this default by copying a CSL style of your choice override this default by copying a CSL style of your choice
to `default.csl` in your user data directory.) to `default.csl` in your user data directory.)
The CSL project provides further information on [finding and The CSL project provides further information on [finding and
editing styles]. editing styles].
The `--citation-abbreviations` option (or the The `--citation-abbreviations` option (or the
`citation-abbreviations` metadata field) may be used to `citation-abbreviations` metadata field) may be used to specify
specify a JSON file containing abbreviations of journals a JSON file containing abbreviations of journals that should be
that should be used in formatted bibliographies when used in formatted bibliographies when `form="short"` is
`form="short"` is specified. The format of the file specified. The format of the file can be illustrated with an
can be illustrated with an example: example:
{ "default": { { "default": {
"container-title": { "container-title": {
"Lloyd's Law Reports": "Lloyd's Rep", "Lloyd's Law Reports": "Lloyd's Rep",
"Estates Gazette": "EG", "Estates Gazette": "EG",
"Scots Law Times": "SLT" "Scots Law Times": "SLT"
} }
} }
} }
skipping to change at line 5344 skipping to change at line 5375
render the bibliography. In order to do so, specify bibliography render the bibliography. In order to do so, specify bibliography
files as outlined above, and add `--natbib` or `--biblatex` files as outlined above, and add `--natbib` or `--biblatex`
argument to `pandoc` invocation. Bear in mind that bibliography argument to `pandoc` invocation. Bear in mind that bibliography
files have to be in either BibTeX (for `--natbib`) files have to be in either BibTeX (for `--natbib`)
or BibLaTeX (for `--biblatex`) format. or BibLaTeX (for `--biblatex`) format.
## Other relevant metadata fields ## Other relevant metadata fields
A few other metadata fields affect bibliography formatting: A few other metadata fields affect bibliography formatting:
`link-citation` `link-citations`
: If true, citations will be : If true, citations will be
hyperlinked to the corresponding bibliography entries hyperlinked to the corresponding bibliography entries
(for author-date and numerical styles only). (for author-date and numerical styles only).
`lang` `lang`
: The `lang` field will affect how the style is localized, : The `lang` field will affect how the style is localized,
for example in the translation of labels and the use for example in the translation of labels and the use
of quotation marks. (For backwards compatibility, of quotation marks. (For backwards compatibility,
`locale` may be used instead of `lang`, but this use `locale` may be used instead of `lang`, but this use
is deprecated.) is deprecated.)
skipping to change at line 5413 skipping to change at line 5444
- Get in bed - Get in bed
- Count sheep - Count sheep
To produce an HTML/JavaScript slide show, simply type To produce an HTML/JavaScript slide show, simply type
pandoc -t FORMAT -s habits.txt -o habits.html pandoc -t FORMAT -s habits.txt -o habits.html
where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`. where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the For Slidy, Slideous, reveal.js, and S5, the file produced by
`-s/--standalone` option embeds a link to JavaScript and CSS files, which are pandoc with the `-s/--standalone` option embeds a link to
assumed to be available at the relative path `s5/default` (for S5), `slideous` JavaScript and CSS files, which are assumed to be available at
(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at the relative path `s5/default` (for S5), `slideous` (for
`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`, Slideous), `reveal.js` (for reveal.js), or at the Slidy website
`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for HTML s at `w3.org` (for Slidy). (These paths can be changed by setting
lides], the `slidy-url`, `slideous-url`, `revealjs-url`, or `s5-url`
above.) For DZSlides, the (relatively short) JavaScript and CSS are included in variables; see [Variables for HTML slides], above.) For
the file by default. DZSlides, the (relatively short) JavaScript and CSS are included
in the file by default.
With all HTML slide formats, the `--self-contained` option can be used to
produce a single file that contains all of the data necessary to display the With all HTML slide formats, the `--self-contained` option can
slide show, including linked scripts, stylesheets, images, and videos. be used to produce a single file that contains all of the data
necessary to display the slide show, including linked scripts,
stylesheets, images, and videos.
To produce a PDF slide show using beamer, type To produce a PDF slide show using beamer, type
pandoc -t beamer habits.txt -o habits.pdf pandoc -t beamer habits.txt -o habits.pdf
Note that a reveal.js slide show can also be converted to a PDF Note that a reveal.js slide show can also be converted to a PDF
by printing it to a file from the browser. by printing it to a file from the browser.
To produce a Powerpoint slide show, type To produce a Powerpoint slide show, type
 End of changes. 33 change blocks. 
130 lines changed or deleted 148 lines changed or added

Home  |  About  |  Features  |  All  |  Newest  |  Dox  |  Diffs  |  RSS Feeds  |  Screenshots  |  Comments  |  Imprint  |  Privacy  |  HTTP(S)