git.iko.soy/typeable/pandoc
on master help sign in
Deprecated --custom-header in documentation.

Removed old "Custom Headers" section in README. git-svn-id: https://pandoc.googlecode.com/svn/trunk@1800 788f1e2b-df1e-0410-8736-df70ead52e1b

commit96e0995258c94ebb0fc4780f6fc7b15275846ed4 authorfiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b> dateSun 10 Jan 2010, 02:40 (17 years ago) parent2a4e5f9
3 files changed+10−29
compare with master
unifiedsplit
README+4−21 man/man1/markdown2pdf.1.md+4−4 man/man1/pandoc.1.md+2−4
README+4−21
@@ -273,9 +273,8 @@ For further documentation, see the `pandoc(1)` man page.
273273 LaTeX *commands*, even if `-R` is not specified.)
274274
275275`-C` or `--custom-header` *filename*
276−: can be used to specify a custom document header. To see the headers
277− used by default, use the `-D` option: for example, `pandoc -D html`
278− prints the default HTML header. Implies `--standalone`.
276+: can be used to specify a custom document header. Implies `--standalone`.
277+ *Note: this option is deprecated. Use of `--template` is preferred.*
279278
280279`--toc` or `--table-of-contents`
281280: includes an automatically generated table of contents (or, in the
@@ -479,7 +478,7 @@ When the `-s/--standalone` option is used, pandoc uses a template to
479478add header and footer material that is needed for a self-standing
480479document. To see the default template that is used, just type
481480
482− pandoc --print-default-template=FORMAT
481+ pandoc -D FORMAT
483482
484483where `FORMAT` is the name of the output format. A custom template
485484can be specified using the `--template` option. You can also override
@@ -532,7 +531,7 @@ templates.
532531Templates may contain conditionals. The syntax is as follows:
533532
534533 $if(variable)$
535− X
534+ X
536535 $else$
537536 Y
538537 $endif$
@@ -1173,22 +1172,6 @@ LaTeX, not as markdown.
11731172Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
11741173and ConTeXt.
11751174
1176−Custom headers
1177−==============
1178−
1179−When run with the "standalone" option (`-s`), `pandoc` creates a
1180−standalone file, complete with an appropriate header. To see the
1181−default headers used for html and latex, use the following commands:
1182−
1183− pandoc -D html
1184−
1185− pandoc -D latex
1186−
1187−If you want to use a different header, just create a file containing
1188−it and specify it on the command line as follows:
1189−
1190− pandoc --custom-header=MyHeaderFile
1191−
11921175Producing S5 with Pandoc
11931176========================
11941177
man/man1/markdown2pdf.1.md+4−4
@@ -55,7 +55,8 @@ The following options are most relevant:
5555\--template=*FILE*
5656: Use *FILE* as a custom template for the generated document. Implies
5757 `-s`. See the section TEMPLATES in `pandoc`(1) for information about
58− template syntax.
58+ template syntax. Use `pandoc -D latex` to print the default LaTeX
59+ template.
5960
6061-V KEY=VAL, \--variable=*KEY:VAL*
6162: Set the template variable KEY to the value VAL when rendering the
@@ -75,9 +76,8 @@ The following options are most relevant:
7576: Include (LaTeX) contents of *FILE* at the end of the document body.
7677
7778-C *FILE*, \--custom-header=*FILE*
78−: Use contents of *FILE*
79− as the LaTeX document header (overriding the default header, which can be
80− printed using `pandoc -D latex`). Implies `-s`.
79+: Use contents of *FILE* as the document header. *Note: This option is
80+ deprecated. Users should transition to using `--template` instead.*
8181
8282# SEE ALSO
8383
man/man1/pandoc.1.md+2−4
@@ -198,10 +198,8 @@ to Pandoc. Or use `html2markdown`(1), a wrapper around `pandoc`.
198198: Include contents of *FILE* at the end of the document body.
199199
200200-C *FILE*, \--custom-header=*FILE*
201−: Use contents of *FILE* as the document header (overriding the
202− default header, which can be printed by using the `-D` option).
203− Implies `-s`. Note: This option is deprecated. Users should
204− transition to using `--template` instead.
201+: Use contents of *FILE* as the document header. *Note: This option is
202+ deprecated. Users should transition to using `--template` instead.*
205203
206204\--reference-odt=*filename*
207205: Use the specified file as a style reference in producing an ODT.