aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorJohn MacFarlane <jgm@berkeley.edu>2011-07-22 22:49:38 -0700
committerJohn MacFarlane <jgm@berkeley.edu>2011-07-22 22:49:38 -0700
commitfd34dcba851ad1567b8969676174fc03a3afb958 (patch)
treecae6623f2a01f9398ffdc7dfd84248a2c459d67c /README
parent94405121abff5eb2ed8ddf7be5457a4dc6619d3b (diff)
downloadpandoc-fd34dcba851ad1567b8969676174fc03a3afb958.tar.gz
Changed default template naming scheme.
Instead of latex.template, we now have default.latex. An appropriate extension is added automatically if the value of `--template` has no extension. So, `pandoc --template=special -t latex` looks for `special.latex`, while `pandoc --template=special -t man` looks for `special.man`.
Diffstat (limited to 'README')
-rw-r--r--README14
1 files changed, 9 insertions, 5 deletions
diff --git a/README b/README
index 3173075eb..a870de8ab 100644
--- a/README
+++ b/README
@@ -324,13 +324,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.
@@ -498,7 +502,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