diff options
Diffstat (limited to 'MANUAL.txt')
| -rw-r--r-- | MANUAL.txt | 75 |
1 files changed, 44 insertions, 31 deletions
diff --git a/MANUAL.txt b/MANUAL.txt index 6e0920888..7c401f105 100644 --- a/MANUAL.txt +++ b/MANUAL.txt @@ -1,6 +1,6 @@ % Pandoc User's Guide % John MacFarlane -% January 7, 2018 +% January 18, 2018 Synopsis ======== @@ -370,7 +370,7 @@ General options : Generate a bash completion script. To enable bash completion with pandoc, add this to your `.bashrc`: - eval "$(pandoc --bash-completion)" + eval "$(pandoc --bash-completion)" `--verbose` @@ -1314,7 +1314,7 @@ as the following: `toc-title` : title of table of contents (works only with EPUB, - opendocument, odt, docx) + opendocument, odt, docx, pptx) `include-before` : contents specified by `-B/--include-before-body` (may have @@ -1350,21 +1350,12 @@ Language variables format stored in the additional variables `babel-lang`, `polyglossia-lang` (LaTeX) and `context-lang` (ConTeXt). - Native pandoc `span`s and `div`s with the lang attribute + Native pandoc Spans and Divs with the lang attribute (value in BCP 47) can be used to switch the language in - that range. - -`otherlangs` -: a list of other languages used in the document - in the YAML metadata, according to [BCP 47]. For example: - `otherlangs: [en-GB, fr]`. - This is automatically generated from the `lang` attributes - in all `span`s and `div`s but can be overridden. - Currently only used by LaTeX through the generated - `babel-otherlangs` and `polyglossia-otherlangs` variables. - The LaTeX writer outputs polyglossia commands in the text but - the `babel-newcommands` variable contains mappings for them - to the corresponding babel. + that range. In LaTeX output, `babel-otherlangs` and + `polyglossia-otherlangs` variables will be generated + automatically based on the `lang` attributes of Spans + and Divs in the document. `dir` : the base direction of the document, either `rtl` (right-to-left) @@ -1732,7 +1723,7 @@ Typography Interpret straight quotes as curly quotes, `---` as em-dashes, `--` as en-dashes, and `...` as ellipses. Nonbreaking spaces are -inserted after certain abbreviations, such as "Mr." +inserted after certain abbreviations, such as "Mr." This extension can be enabled/disabled for the following formats: @@ -1969,6 +1960,14 @@ extensions to Emacs Muse markup. Some aspects of [Pandoc's Markdown citation syntax](#citations) are also accepted in `org` input. +#### Extension: `ntb` #### + +In the `context` output format this enables the use of [Natural Tables +(TABLE)](http://wiki.contextgarden.net/TABLE) instead of the default +[Extreme Tables (xtables)](http://wiki.contextgarden.net/xtables). +Natural tables allow more fine-grained global customization but come +at a performance penalty compared to extreme tables. + Pandoc's Markdown ================= @@ -2266,11 +2265,11 @@ this syntax: Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and `startFrom` is an attribute with value `100`. Some output formats can use this information to do syntax highlighting. Currently, the only output formats -that uses this information are HTML, LaTeX, Docx, and Ms. If highlighting -is supported for your output format and language, then the code block above -will appear highlighted, with numbered lines. (To see which languages are -supported, type `pandoc --list-highlight-languages`.) Otherwise, the code -block above will appear as follows: +that uses this information are HTML, LaTeX, Docx, Ms, and PowerPoint. If +highlighting is supported for your output format and language, then the code +block above will appear highlighted, with numbered 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"> <code> @@ -2607,9 +2606,9 @@ cases" involving lists. Consider this source: + First + Second: - - Fee - - Fie - - Foe + - Fee + - Fie + - Foe + Third @@ -3046,6 +3045,17 @@ template: $endif$ $endfor$ +Raw content to include in the document's header may be specified +using `header-includes`; however, it is important to mark up +this content as raw code for a particular output format, using +the [`raw_attribute` extension](#extension-raw_attribute)), or it +will be interpreted as markdown. For example: + + header-includes: + - ```{=latex} + \let\oldsection\section + \renewcommand{\section}[1]{\clearpage\oldsection{#1}} + ``` Backslash escapes ----------------- @@ -3386,14 +3396,17 @@ all output formats, not just LaTeX: $\tuple{a, b, c}$ -In LaTeX output, the macro definitions will not be passed -through as raw LaTeX. +Note that LaTeX macros will not be applied if they occur +inside inside a raw span or block marked with the +[`raw_attribute` extension](#extension-raw_attribute). -When `latex_macros` is disabled, the macro definitions will -be passed through as raw LaTeX, and the raw LaTeX and math will +When `latex_macros` is disabled, the raw LaTeX and math will not have macros applied. This is usually a better approach when you are targeting LaTeX or PDF. +Whether or not `latex_macros` is enabled, the macro definitions +will still be passed through as raw LaTeX. + Links ----- @@ -3532,7 +3545,7 @@ If you just want a regular inline image, just make sure it is not the only thing in the paragraph. One way to do this is to insert a nonbreaking space after the image: - \ + \ Note that in reveal.js slide shows, an image in a paragraph by itself that has the `stretch` class will fill the screen, |