aboutsummaryrefslogtreecommitdiff
path: root/MANUAL.txt
diff options
context:
space:
mode:
authorschrieveslaach <schrieveslaach@online.de>2017-06-12 15:52:29 +0200
committerGitHub <noreply@github.com>2017-06-12 15:52:29 +0200
commit635f299b441e238ccd34e3ad61c5e36f0ca30067 (patch)
tree11cfc34402975bad208f9a48d075fe2ace959e70 /MANUAL.txt
parent181c56d4003aa83abed23b95a452c4890aa3797c (diff)
parent23f3c2d7b4796d1af742a74999ce67924bf2abb3 (diff)
downloadpandoc-635f299b441e238ccd34e3ad61c5e36f0ca30067.tar.gz
Merge branch 'master' into textcolor-support
Diffstat (limited to 'MANUAL.txt')
-rw-r--r--MANUAL.txt140
1 files changed, 91 insertions, 49 deletions
diff --git a/MANUAL.txt b/MANUAL.txt
index 9b5c27b77..df08e4b40 100644
--- a/MANUAL.txt
+++ b/MANUAL.txt
@@ -523,10 +523,15 @@ Reader options
`--extract-media=`*DIR*
-: Extract images and other media contained in a docx or epub container
- to the path *DIR*, creating it if necessary, and adjust the images
- references in the document so they point to the extracted files.
- This option only affects the docx and epub readers.
+: Extract images and other media contained in or linked from
+ the source document to the path *DIR*, creating it if
+ necessary, and adjust the images references in the document
+ so they point to the extracted files. If the source format is
+ a binary container (docx, epub, or odt), the media is
+ extracted from the container and the original
+ filenames are used. Otherwise the media is read from the
+ file system or downloaded, and new filenames are constructed
+ based on SHA1 hashes of the contents.
`--abbreviations=`*FILE*
@@ -588,7 +593,15 @@ General writer options
: Print a system default data file. Files in the user data directory
are ignored.
+`--eol=crlf`|`lf`|`native`
+
+: Manually specify line endings: `crlf` (Windows), `lf`
+ (MacOS/linux/unix), or `native` (line endings appropriate
+ to the OS on which pandoc is being run). The default is
+ `native`.
+
`--dpi`=*NUMBER*
+
: Specify the dpi (dots per inch) value for conversion from pixels
to inch/centimeters and vice versa. The default is 96dpi.
Technically, the correct term would be ppi (pixels per inch).
@@ -678,6 +691,18 @@ General writer options
repeatedly to include multiple files. They will be included in the
order specified. Implies `--standalone`.
+`--resource-path=`*SEARCHPATH*
+
+: List of paths to search for images and other resources.
+ The paths should be separated by `:` on linux, unix, and
+ MacOS systems, and by `;` on Windows. If `--resource-path`
+ is not specified, the default resource path is the working
+ directory. Note that, if `--resource-path` is specified,
+ the working directory must be explicitly listed or it
+ will not be searched. For example:
+ `--resource-path=.:test` will search the working directory
+ and the `test` subdirectory, in that order.
+
Options affecting specific writers
----------------------------------
@@ -828,47 +853,51 @@ Options affecting specific writers
: Use the specified file as a style reference in producing a
docx or ODT file.
- Docx: For best results, the reference docx should be a modified
- version of a docx file produced using pandoc. The contents
- of the reference docx are ignored, but its stylesheets and
- document properties (including margins, page size, header,
- and footer) are used in the new docx. If no reference docx
- is specified on the command line, pandoc will look for a
- file `reference.docx` in the user data directory (see
- `--data-dir`). If this is not found either, sensible
- defaults will be used.
-
- To produce a custom `reference.docx`, first get a copy of
- the default `reference.docx`: `pandoc
- --print-default-data-file reference.docx >
- custom-reference.docx`. Then open `custom-reference.docx`
- in Word, modify the styles as you wish, and save the file.
- For best results, do not make changes to this file other
- than modifying the styles used by pandoc: [paragraph]
- Normal, Body Text, First Paragraph, Compact, Title,
- Subtitle, Author, Date, Abstract, Bibliography, Heading 1,
- Heading 2, Heading 3, Heading 4, Heading 5, Heading 6,
- Heading 7, Heading 8, Heading 9, Block Text, Footnote Text,
- Definition Term, Definition, Caption, Table Caption,
- Image Caption, Figure, Figure With Caption, TOC Heading;
- [character] Default Paragraph Font, Body Text Char,
- Verbatim Char, Footnote Reference, Hyperlink; [table]
- Normal Table.
-
- ODT: For best results, the reference ODT should be a modified
- version of an ODT produced using pandoc. The contents of
- the reference ODT are ignored, but its stylesheets are used
- in the new ODT. If no reference ODT is specified on the
- command line, pandoc will look for a file `reference.odt` in
- the user data directory (see `--data-dir`). If this is not
- found either, sensible defaults will be used.
-
- To produce a custom `reference.odt`, first get a copy of
- the default `reference.odt`: `pandoc
- --print-default-data-file reference.odt >
- custom-reference.odt`. Then open `custom-reference.odt` in
- LibreOffice, modify the styles as you wish, and save the
- file.
+ Docx
+
+ : For best results, the reference docx should be a modified
+ version of a docx file produced using pandoc. The contents
+ of the reference docx are ignored, but its stylesheets and
+ document properties (including margins, page size, header,
+ and footer) are used in the new docx. If no reference docx
+ is specified on the command line, pandoc will look for a
+ file `reference.docx` in the user data directory (see
+ `--data-dir`). If this is not found either, sensible
+ defaults will be used.
+
+ To produce a custom `reference.docx`, first get a copy of
+ the default `reference.docx`: `pandoc
+ --print-default-data-file reference.docx >
+ custom-reference.docx`. Then open `custom-reference.docx`
+ in Word, modify the styles as you wish, and save the file.
+ For best results, do not make changes to this file other
+ than modifying the styles used by pandoc: [paragraph]
+ Normal, Body Text, First Paragraph, Compact, Title,
+ Subtitle, Author, Date, Abstract, Bibliography, Heading 1,
+ Heading 2, Heading 3, Heading 4, Heading 5, Heading 6,
+ Heading 7, Heading 8, Heading 9, Block Text, Footnote Text,
+ Definition Term, Definition, Caption, Table Caption,
+ Image Caption, Figure, Captioned Figure, TOC Heading;
+ [character] Default Paragraph Font, Body Text Char,
+ Verbatim Char, Footnote Reference, Hyperlink; [table]
+ Table.
+
+ ODT
+
+ : For best results, the reference ODT should be a modified
+ version of an ODT produced using pandoc. The contents of
+ the reference ODT are ignored, but its stylesheets are used
+ in the new ODT. If no reference ODT is specified on the
+ command line, pandoc will look for a file `reference.odt` in
+ the user data directory (see `--data-dir`). If this is not
+ found either, sensible defaults will be used.
+
+ To produce a custom `reference.odt`, first get a copy of
+ the default `reference.odt`: `pandoc
+ --print-default-data-file reference.odt >
+ custom-reference.odt`. Then open `custom-reference.odt` in
+ LibreOffice, modify the styles as you wish, and save the
+ file.
`--epub-cover-image=`*FILE*
@@ -1310,6 +1339,11 @@ including all [reveal.js configuration options].
: color for internal links, citation links, external links, and links in table
of contents: uses any of the [predefined LaTeX colors] (for beamer only).
+`aspectratio`
+: aspect ratio of slides (for beamer only, `1610` for 16:10, `169` for 16:9,
+ `149` for 14:9, `141` for 1.41:1, `54` for 5:4, `43` for 4:3 which is the
+ default, and `32` for 3:2).
+
[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration
Variables for LaTeX
@@ -3071,7 +3105,8 @@ definition, which may occur elsewhere in the document (either
before or after the link).
The link consists of link text in square brackets, followed by a label in
-square brackets. (There can be space between the two.) The link definition
+square brackets. (There cannot be space between the two unless the
+`spaced_reference_links` extension is enabled.) The link definition
consists of the bracketed label, followed by a colon and a space, followed by
the URL, and optionally (after a space) a link title either in quotes or in
parentheses. The label must not be parseable as a citation (assuming
@@ -3522,6 +3557,13 @@ implied by pandoc's default `all_symbols_escapable`.
Allow a list to occur right after a paragraph, with no intervening
blank space.
+#### Extension: `spaced_reference_links` ####
+
+Allow whitespace between the two components of a reference link,
+for example,
+
+ [foo] [bar].
+
#### Extension: `hard_line_breaks` ####
Causes all newlines within a paragraph to be interpreted as hard line
@@ -4059,7 +4101,7 @@ Syntax highlighting
===================
Pandoc will automatically highlight syntax in [fenced code blocks] that
-are marked with a language name. The Haskell library [highlighting-kate] is
+are marked with a language name. The Haskell library [skylighting] is
used for highlighting, which works in HTML, Docx, Ms, and LaTeX/PDF output.
To see a list of language names that pandoc will recognize, type
`pandoc --list-highlight-languages`.
@@ -4072,7 +4114,7 @@ type `pandoc --list-highlight-styles`.
To disable highlighting, use the `--no-highlight` option.
-[highlighting-kate]: https://github.com/jgm/highlighting-kate
+[skylighting]: https://github.com/jgm/skylighting
Custom Styles in Docx Output
============================
@@ -4139,7 +4181,7 @@ which you can modify according to your needs, do
Authors
=======
-© 2006-2016 John MacFarlane (jgm@berkeley.edu). Released under the
+© 2006-2017 John MacFarlane (jgm@berkeley.edu). Released under the
[GPL], version 2 or greater. This software carries no warranty of
any kind. (See COPYRIGHT for full copyright and warranty notices.)