Update slides variables in README.

This reflects the inclusion of all reveal.js variables in <https://github.com/jgm/pandoc-templates/pull/134>.
This commit is contained in:
Andrew Dunning 2015-10-14 18:26:53 -04:00
parent b8bdfdad90
commit f472515a93

40
README
View file

@ -1077,6 +1077,9 @@ Language variables
Variables for slides Variables for slides
-------------------- --------------------
Variables are available for [producing slide shows with pandoc],
including all [reveal.js configuration options].
`slidy-url` `slidy-url`
: base URL for Slidy documents (defaults to : base URL for Slidy documents (defaults to
`http://www.w3.org/Talks/Tools/Slidy2`) `http://www.w3.org/Talks/Tools/Slidy2`)
@ -1090,33 +1093,16 @@ Variables for slides
`revealjs-url` `revealjs-url`
: base URL for reveal.js documents (defaults to `reveal.js`) : base URL for reveal.js documents (defaults to `reveal.js`)
`theme` `theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
: reveal.js or LaTeX beamer theme
`transition`
: reveal.js transition: `cube`, `page`, `concave`, `zoom`, `linear`, `fade`, or `none`
`center`
: enables vertical centering of slides in reveal.js if set to `true`
`maxScale`
: bounds for smallest/largest possible content scale in reveal.js (default: 1.5)
`slideNumber`
: enables display of the page number of the current slide in reveal.js
`controls`
: disables controls in reveal.js slide shows if set to `false`
`progress`
: disables progress bar in reveal.js slide shows if set to `false`
`colortheme`, `fonttheme`, `innertheme`, `outertheme`
: themes for LaTeX [`beamer`] documents : themes for LaTeX [`beamer`] documents
[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration
Variables for LaTeX Variables for LaTeX
------------------- -------------------
LaTeX variables are used when [creating a PDF].
`fontsize` `fontsize`
: font size (e.g. `10pt`, `12pt`) for LaTeX documents : font size (e.g. `10pt`, `12pt`) for LaTeX documents
@ -3284,7 +3270,7 @@ For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
assumed to be available at the relative path `s5/default` (for S5), `slideous` assumed to be available at the relative path `s5/default` (for S5), `slideous`
(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at (for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`, `w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
`slideous-url`, `revealjs-url`, or `s5-url` variables; see `--variable`, `slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for slides],
above.) For DZSlides, the (relatively short) javascript and css are included in above.) For DZSlides, the (relatively short) javascript and css are included in
the file by default. the file by default.
@ -3381,15 +3367,15 @@ files it does not find in the user data directory.
For dzslides, the CSS is included in the HTML file itself, and may For dzslides, the CSS is included in the HTML file itself, and may
be modified there. be modified there.
For reveal.js, themes can be used by setting the `theme` variable, All [reveal.js configuration options] can be set through variables.
for example: For example, themes can be used by setting the `theme` variable:
-V theme=moon -V theme=moon
Or you can specify a custom stylesheet using the `--css` option. Or you can specify a custom stylesheet using the `--css` option.
To style beamer slides, you can specify a beamer "theme" or "colortheme" To style beamer slides, you can specify a `theme`, `colortheme`,
using the `-V` option: `fonttheme`, `innertheme`, and `outertheme`, using the `-V` option:
pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf