diff options
| author | fiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b> | 2007-07-21 20:30:40 +0000 |
|---|---|---|
| committer | fiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b> | 2007-07-21 20:30:40 +0000 |
| commit | 2f7a38e1ab54d564555856a9354d1462ff8ca815 (patch) | |
| tree | 9c7b9ff59d20e00867c54c7003b3c9c103ac3acc /README | |
| parent | 6d8f0e29d99cd44e8c7c9fafa3b116ae3a83a49e (diff) | |
| download | pandoc-2f7a38e1ab54d564555856a9354d1462ff8ca815.tar.gz | |
Changed system for indicating man page title, section,
header and footer. Documented in README.
git-svn-id: https://pandoc.googlecode.com/svn/trunk@745 788f1e2b-df1e-0410-8736-df70ead52e1b
Diffstat (limited to 'README')
| -rw-r--r-- | README | 21 |
1 files changed, 15 insertions, 6 deletions
@@ -645,16 +645,25 @@ title block appears in the document, the title prefix will be used by itself as the HTML title. The man page writer extracts a title, man page section number, and -other header and footer information from the title line. These should -be separated by pipe characters (`|`), as follows: +other header and footer information from the title line. The title +is assumed to be the first word on the title line, which may optionally +end with a (single-digit) section number in parentheses. (There should +be no space between the title and the parentheses.) Anything after +this is assumed to be additional footer and header text. A single pipe +character (`|`) should be used to separate the footer text from the header +text. Thus, - % title | section number (1-9) | footer left | header center + % pandoc(1) -For example, +will yield a man page with the title `pandoc` and section 1. - % pandoc | 1 | Pandoc User Manuals | Version 4.0 + % pandoc(1) Pandoc User Manuals -The middle of the man page footer is used for the date. +will also have "Pandoc User Manuals" in the footer. + + % pandoc(1) Pandoc User Manuals | Version 4.0 + +will also have "Version 4.0" in the header. Markdown in HTML blocks ----------------------- |