diff options
| author | John MacFarlane <fiddlosopher@gmail.com> | 2011-12-29 13:24:05 -0800 |
|---|---|---|
| committer | John MacFarlane <fiddlosopher@gmail.com> | 2011-12-29 13:26:04 -0800 |
| commit | ea39a607eda7ea45906db44ccab4dc36bd43be89 (patch) | |
| tree | add6985ebdc2a09c9b5134e92b41feb2cae4d31c /README | |
| parent | 012405e8c3df0ce400b05f524d14de88cf5d5115 (diff) | |
| download | pandoc-ea39a607eda7ea45906db44ccab4dc36bd43be89.tar.gz | |
Added 'beamer' as an output format.
Beamer output uses the default LaTeX template, with some
customizations via variables.
Added `writerBeamer` to `WriterOptions`.
Added `--beamer` option to `markdown2pdf`.
Diffstat (limited to 'README')
| -rw-r--r-- | README | 47 |
1 files changed, 29 insertions, 18 deletions
@@ -14,10 +14,10 @@ Pandoc is a [Haskell] library for converting from one markup format to another, and a command-line tool that uses this library. It can read [markdown] and (subsets of) [Textile], [reStructuredText], [HTML], and [LaTeX]; and it can write plain text, [markdown], [reStructuredText], -[HTML], [LaTeX], [ConTeXt], [RTF], [DocBook XML], [OpenDocument XML], [ODT], -[GNU Texinfo], [MediaWiki markup], [EPUB], [Textile], [groff man] pages, -[Emacs Org-Mode], [AsciiDoc], and [Slidy], [DZSlides], or [S5] HTML -slide shows. +[HTML], [LaTeX], [LaTeX beamer], [ConTeXt], [RTF], [DocBook XML], +[OpenDocument XML], [ODT], [GNU Texinfo], [MediaWiki markup], [EPUB], +[Textile], [groff man] pages, [Emacs Org-Mode], [AsciiDoc], and [Slidy], +[DZSlides], or [S5] HTML slide shows. Pandoc's enhanced version of markdown includes syntax for footnotes, tables, flexible ordered lists, definition lists, delimited code blocks, @@ -151,20 +151,19 @@ Options `-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT* : Specify output format. *FORMAT* can be `native` (native Haskell), `json` (JSON version of native AST), `plain` (plain text), - `markdown` (markdown), `rst` (reStructuredText), - `html` (HTML), `latex` (LaTeX), `context` (ConTeXt), `man` (groff man), - `mediawiki` (MediaWiki markup), `textile` (Textile), `org` (Emacs - Org-Mode), `texinfo` (GNU Texinfo), `docbook` (DocBook XML), + `markdown` (markdown), `rst` (reStructuredText), `html` (HTML), `latex` + (LaTeX), `beamer` (LaTeX beamer), `context` (ConTeXt), `man` (groff + man), `mediawiki` (MediaWiki markup), `textile` (Textile), `org` + (Emacs Org-Mode), `texinfo` (GNU Texinfo), `docbook` (DocBook XML), `opendocument` (OpenDocument XML), `odt` (OpenOffice text document), `epub` (EPUB book), `asciidoc` (AsciiDoc), `slidy` (Slidy HTML and javascript slide show), `dzslides` (HTML5 + javascript slide show), - `s5` (S5 HTML and javascript slide show), or `rtf` (rich text - format). Note that `odt` and `epub` output will not be directed to - *stdout*; an output filename must be specified using the `-o/--output` - option. If `+lhs` is appended to `markdown`, `rst`, `latex`, or `html`, - the output will be rendered as literate Haskell source: - see [Literate Haskell support](#literate-haskell-support), - below. + `s5` (S5 HTML and javascript slide show), or `rtf` (rich text format). + Note that `odt` and `epub` output will not be directed to *stdout*; an + output filename must be specified using the `-o/--output` option. If + `+lhs` is appended to `markdown`, `rst`, `latex`, or `html`, the output + will be rendered as literate Haskell source: see [Literate Haskell + support](#literate-haskell-support), below. `-s`, `--standalone` : Produce output with an appropriate header and footer (e.g. a @@ -580,6 +579,14 @@ depending on the output format, but include: `http://www.w3.org/Talks/Tools/Slidy2`) `s5-url` : base URL for S5 documents (defaults to `ui/default`) +`font-size` +: font size (10pt, 11pt, 12pt) for LaTeX and beamer documents +`documentclass` +: document class for LaTeX documents +`theme` +: theme for beamer documents +`colortheme` +: colortheme for beamer documents Variables may be set at the command line using the `-V/--variable` option. This allows users to include custom variables in their @@ -1903,12 +1910,14 @@ document with an appropriate header: The bibliography will be inserted after this header. -Producing HTML slide shows with Pandoc -====================================== +Producing slide shows with Pandoc +================================= You can use Pandoc to produce an HTML + javascript slide presentation that can be viewed via a web browser. There are three ways to do this, -using [S5], [DZSlides], or [Slidy]. +using [S5], [DZSlides], or [Slidy]. You can also produce a PDF slide +show using [LaTeX beamer]: just pass the `--beamer` option to +`markdown2pdf`. Here's the markdown source for a simple slide show, `eating.txt`: @@ -1946,6 +1955,7 @@ for DZSlides. A title page is constructed automatically from the document's title block. Each level-one header and horizontal rule begins a new slide. +(If beamer is used, all headers begin a new slide.) For Slidy and S5, the file produced by pandoc with the `-s/--standalone` option embeds a link to javascripts and CSS files, which are assumed to @@ -2043,6 +2053,7 @@ Christopher Sawicki, Kelsey Hightower. [Slidy]: http://www.w3.org/Talks/Tools/Slidy/ [HTML]: http://www.w3.org/TR/html40/ [LaTeX]: http://www.latex-project.org/ +[LaTeX beamer]: http://www.tex.ac.uk/CTAN/macros/latex/contrib/beamer [ConTeXt]: http://www.pragma-ade.nl/ [RTF]: http://en.wikipedia.org/wiki/Rich_Text_Format [DocBook XML]: http://www.docbook.org/ |
