diff --git a/README.md b/README.md index 9fa80cb..44f8ed5 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,6 @@ styledef: numbersections: true fontsize: 12pt commandline: - smart: true columns: "`75`" filter: - run: deemph.py @@ -58,6 +57,7 @@ Installation - [pandoc](http://johnmacfarlane.net/pandoc/index.html) - [Python 3](https://www.python.org/downloads/) +- [setuptools for Python3](http://stackoverflow.com/questions/14426491/python-3-importerror-no-module-named-setuptools) (included in some Python 3 distributions) *To upgrade an existing installation:* @@ -133,7 +133,7 @@ Notes: numbersections: true fontsize: 12pt commandline: - smart: true + no-wrap: true filter: - run: deemph.py postflight: @@ -150,7 +150,7 @@ style: Notes ... ``` -it would run pandoc with filter `deemph.py` and command line option `--smart` on the following input and then execute `latexmk.py`. +it would run pandoc with filter `deemph.py` and command line option `--no-wrap` on the following input and then execute `latexmk.py`. ``` yaml --- @@ -252,7 +252,7 @@ Arbitrary pandoc command line options can be set using metadata via `commandline `commandline` contains one field for each pandoc command line option. The field name is the unabbreviated name of the relevant pandoc command line option (e.g. `standalone`). -- For pandoc flags, the value should be boolean (`true`, `false`), e.g. `smart: true`. +- For pandoc flags, the value should be boolean (`true`, `false`), e.g. `no-wrap: true`. - For pandoc key-values, the value should be a quoted inline code span, e.g. `` include-in-header: "`path/to/my/header`" ``. `false` plays a special role. `false` means that the pandoc command line option with the field's name, if set, should be unset. `false` can be used for both flags and key-value options (e.g. `include-in-header: false`). @@ -260,12 +260,12 @@ Arbitrary pandoc command line options can be set using metadata via `commandline Example: commandline: - smart: true + no-wrap: true slide-level: "`3`" - no-wrap: false + number-sections: false include-in-header: false -This passes the following options to pandoc `--smart --slide-level=3` and removes any `--no-wrap` and `--include-in-header=...` options. +This passes the following options to pandoc `--no-wrap --slide-level=3` and removes any `--number-sections` and `--include-in-header=...` options. These pandoc command line options cannot be set via `commandline`: @@ -276,6 +276,9 @@ These pandoc command line options cannot be set via `commandline`: - `filter` - `template` - `output` +- `help` +- `version` +- *pandoc reader options* -- fix in progress Passing messages to external processes ====================================== diff --git a/README.rst b/README.rst index ca26a0c..690e429 100644 --- a/README.rst +++ b/README.rst @@ -3,7 +3,7 @@ panzer user guide ================= :Author: Mark Sprevak -:Date: 24 May 2015 +:Date: 25 May 2015 panzer ====== @@ -59,7 +59,6 @@ Styles can also be defined locally inside the document: numbersections: true fontsize: 12pt commandline: - smart: true columns: "`75`" filter: - run: deemph.py @@ -85,6 +84,9 @@ Installation - `pandoc `__ - `Python 3 `__ +- `setuptools for + Python3 `__ + (included in some Python 3 distributions) *To upgrade an existing installation:* @@ -202,7 +204,7 @@ Example: numbersections: true fontsize: 12pt commandline: - smart: true + no-wrap: true filter: - run: deemph.py postflight: @@ -220,7 +222,7 @@ selected, ... it would run pandoc with filter ``deemph.py`` and command line option -``--smart`` on the following input and then execute ``latexmk.py``. +``--no-wrap`` on the following input and then execute ``latexmk.py``. .. code:: yaml @@ -377,7 +379,7 @@ The field name is the unabbreviated name of the relevant pandoc command line option (e.g. ``standalone``). - For pandoc flags, the value should be boolean (``true``, ``false``), - e.g. ``smart: true``. + e.g. ``no-wrap: true``. - For pandoc key-values, the value should be a quoted inline code span, e.g. ``include-in-header: "`path/to/my/header`"``. @@ -391,13 +393,14 @@ Example: :: commandline: - smart: true + no-wrap: true slide-level: "`3`" - no-wrap: false + number-sections: false include-in-header: false -This passes the following options to pandoc ``--smart --slide-level=3`` -and removes any ``--no-wrap`` and ``--include-in-header=...`` options. +This passes the following options to pandoc +``--no-wrap --slide-level=3`` and removes any ``--number-sections`` and +``--include-in-header=...`` options. These pandoc command line options cannot be set via ``commandline``: @@ -408,6 +411,9 @@ These pandoc command line options cannot be set via ``commandline``: - ``filter`` - ``template`` - ``output`` +- ``help`` +- ``version`` +- *pandoc reader options* -- fix in progress Passing messages to external processes ======================================