diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 58 |
1 files changed, 45 insertions, 13 deletions
@@ -1,6 +1,6 @@ % Pandoc User's Guide % John MacFarlane -% January 29, 2011 +% July 30, 2011 Synopsis ======== @@ -238,9 +238,11 @@ Options no link to the jsMath load script will be inserted; it is then up to the author to provide such a link in the HTML template. -`--mathjax=`*URL* +`--mathjax`[=*URL*] : Use [MathJax] to display embedded TeX math in HTML output. The *URL* should point to the `MathJax.js` load script. + If a *URL* is not provided, a link to the MathJax CDN will + be inserted. `--gladtex` : Enclose TeX math in `<eq>` tags in HTML output. These can then @@ -265,9 +267,6 @@ Options show in the output, so that the slide show will work even when no internet connection is available. -`--xetex` -: Create LaTeX outut suitable for processing by XeTeX. - `--chapters` : Treat top-level headers as chapters in LaTeX, ConTeXt, and DocBook output. @@ -327,13 +326,17 @@ Options `--template=`*FILE* : Use *FILE* as a custom template for the generated document. Implies `--standalone`. See [Templates](#templates) below for a description - of template syntax. If this option is not used, a default - template appropriate for the output format will be used. See also - `-D/--print-default-template`. + of template syntax. If no extension is specified, an extension + corresponding to the writer will be added, so that `--template=special` + looks for `special.html` for HTML output. If the template is not + found, pandoc will search for it in the user data directory + (see `--data-dir`). If this option is not used, a default + template appropriate for the output format will be used (see + `-D/--print-default-template`). `-V` *KEY=VAL*, `--variable=`*KEY:VAL* : Set the template variable *KEY* to the value *VAL* when rendering the - document in standalone mode. This is only useful when the + document in standalone mode. This is generally only useful when the `--template` option is used to specify a custom template, since pandoc automatically sets the variables used in the default templates. @@ -379,6 +382,10 @@ Options user data directory (see `--data-dir`, below). If it is not found there, sensible defaults will be used. +`--epub-cover-image=`*FILE* +: Use the specified image as the EPUB cover. It is recommended + that the image be less than 1000px in width and height. + `--epub-metadata=`*FILE* : Look in the specified XML file for metadata for the EPUB. The file should contain a series of Dublin Core elements, @@ -431,6 +438,12 @@ Options user data directory (see `--data-dir`), or, if that is not present, the Chicago author-date style. +`--natbib` +: Use natbib for citations in LaTeX output. + +`--biblatex` +: Use biblatex for citations in LaTeX output. + `--data-dir=`*DIRECTORY* : Specify the user data directory to search for pandoc data files. If this option is not specified, the default user data directory @@ -491,7 +504,7 @@ document. To see the default template that is used, just type where `FORMAT` is the name of the output format. A custom template can be specified using the `--template` option. You can also override the system default templates for a given output format `FORMAT` -by putting a file `templates/FORMAT.template` in the user data +by putting a file `templates/default.FORMAT` in the user data directory (see `--data-dir`, above). Templates may contain *variables*. Variable names are sequences of @@ -530,6 +543,11 @@ depending on the output format, but include: : date of document, as specified in title block `lang` : language code for HTML documents +`slidy-url` +: base URL for Slidy documents (defaults to + `http://www.w3.org/Talks/Tools/Slidy2`) +`s5-url` +: base URL for S5 documents (defaults to `ui/default`) Variables may be set at the command line using the `-V/--variable` option. This allows users to include custom variables in their @@ -560,6 +578,13 @@ consecutive items: $for(author)$$author$$sep$, $endfor$ +If you use custom templates, you may need to revise them as pandoc +changes. We recommend tracking the changes in the default templates, +and modifying your custom templates accordingly. An easy way to do this +is to fork the pandoc-templates repository +(<http://github.com/jgm/pandoc-templates>) and merge in changes after each +pandoc release. + Pandoc's markdown ================= @@ -1372,6 +1397,9 @@ correct output, converting straight quotes to curly quotes, `---` and `--` to Em-dashes, and `...` to ellipses. Nonbreaking spaces are inserted after certain abbreviations, such as "Mr." +Note: if your LaTeX template uses the `csquotes` package, pandoc will +detect automatically this and use `\enquote{...}` for quoted text. + Inline formatting ----------------- @@ -1805,6 +1833,7 @@ creating and modifying CSL styles can be found at <http://citationstyles.org/downloads/primer.html>. A repository of CSL styles can be found at <https://github.com/citation-style-language/styles>. +See also <http://zotero.org/styles> for easy browsing. Citations go inside square brackets and are separated by semicolons. Each citation must have a key, composed of '@' + the citation @@ -1883,7 +1912,9 @@ block. Each level-one header and horizontal rule begins a new slide. The file produced by pandoc with the `-s/--standalone` option embeds a link to javascripts and CSS files, which are assumed to be available at the relative path `ui/default` (for S5) or at the Slidy website at -`w3.org` (for Slidy). If the `--offline` option is specified, the +`w3.org` (for Slidy). (These paths can be changed by setting the +`slidy-url` or `s5-url` variables; see `--variable`, above.) +If the `--offline` option is specified, the scripts and CSS will be included directly in the generated file, so that it may be used offline. @@ -1963,7 +1994,8 @@ any kind. (See COPYRIGHT for full copyright and warranty notices.) Other contributors include Recai Oktaş, Paulo Tanimoto, Peter Wang, Andrea Rossato, Eric Kow, infinity0x, Luke Plant, shreevatsa.public, Puneeth Chaganti, Paul Rivier, rodja.trappe, Bradley Kuhn, thsutton, -Nathan Gass, Jonathan Daugherty, Jérémy Bobbio, Justin Bogner. +Nathan Gass, Jonathan Daugherty, Jérémy Bobbio, Justin Bogner, qerub, +Christopher Sawicki, Kelsey Hightower. [markdown]: http://daringfireball.net/projects/markdown/ [reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html @@ -1981,7 +2013,7 @@ Nathan Gass, Jonathan Daugherty, Jérémy Bobbio, Justin Bogner. [groff man]: http://developer.apple.com/DOCUMENTATION/Darwin/Reference/ManPages/man7/groff_man.7.html [Haskell]: http://www.haskell.org/ [GNU Texinfo]: http://www.gnu.org/software/texinfo/ -[Emacs Org-Mode]: http://org-mode.org +[Emacs Org-Mode]: http://orgmode.org [EPUB]: http://www.idpf.org/ [GPL]: http://www.gnu.org/copyleft/gpl.html "GNU General Public License" |