diff options
| author | Kévin THIERRY <kevin.thierry@open.eurogiciel.org> | 2014-12-22 15:43:42 +0100 |
|---|---|---|
| committer | Kévin THIERRY <kevin.thierry@open.eurogiciel.org> | 2014-12-22 15:43:42 +0100 |
| commit | cce48620fcb1d1c2afd0933215b428060b07ff0c (patch) | |
| tree | b36418b8471c6dd3926ef20a69bd270a41120313 /contrib/mom/momdoc/headfootpage.html | |
| parent | f522c1ee6d7bd011af2bd90296ccfd9901ad12ab (diff) | |
| download | groff-cce48620fcb1d1c2afd0933215b428060b07ff0c.tar.gz groff-cce48620fcb1d1c2afd0933215b428060b07ff0c.tar.bz2 groff-cce48620fcb1d1c2afd0933215b428060b07ff0c.zip | |
Imported Upstream version 1.22.2upstream/1.22.2sandbox/kevinthierry/upstream
Diffstat (limited to 'contrib/mom/momdoc/headfootpage.html')
| -rw-r--r-- | contrib/mom/momdoc/headfootpage.html | 66 |
1 files changed, 34 insertions, 32 deletions
diff --git a/contrib/mom/momdoc/headfootpage.html b/contrib/mom/momdoc/headfootpage.html index d411874..4201cd4 100644 --- a/contrib/mom/momdoc/headfootpage.html +++ b/contrib/mom/momdoc/headfootpage.html @@ -2,8 +2,9 @@ <!-- This file is part of groff, the GNU roff type-setting system. -Copyright (C) 2004, 2005, 2006, 2009, 2010 Free Software Foundation, Inc. -Written by Peter Schaffter. +Copyright (C) 2004, 2005, 2006, 2009, 2010, +2011, 2012, 2013 Free Software Foundation, Inc. +Written by Peter Schaffter (peter@schaffter.ca). Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or @@ -14,6 +15,7 @@ Texts, and with no Back-Cover Texts. A copy of the Free Documentation License is included as a file called FDL in the main directory of the groff source package. --> + <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> @@ -160,7 +162,7 @@ page element. <div id="author-note" class="box-tip"> <p class="tip"> <span class="note">Author's note:</span> -Left to their own devices (i.e. if you’re happy with the way +Left to their own devices (ie if you’re happy with the way mom does things by default), headers are something you never have to worry about. You can skip reading this section entirely. But if you want to change them, be advised that headers have more macros to @@ -178,10 +180,10 @@ that identifies some aspect of the document as a whole. </p> <p> -”The left part (“header-left) lines up with the +The left part (“header-left”) lines up with the document’s left margin. The centre part (“header -centre“) is centred on the document’s line length. -”The right part (“header-right) lines up with the +centre”) is centred on the document’s line length. +The right part (“header-right”) lines up with the document’s right margin. Not all parts need contain a string, and if you don’t want headers at all, you can turn them off completely. @@ -334,7 +336,7 @@ bottom of each page), the vertical spacing and placement of page numbers, whether at the top or the bottom of the page, is managed exactly as if the page numbers were headers (or footers), and are controlled by the same macros. See -<a href="#pagination">Pagination control</a>. +<a href="#index-pagination-control">Pagination control</a>. </p> <div class="rule-short"><hr/></div> @@ -423,7 +425,7 @@ Macro: <b>HEADERS</b> <kbd class="macro-args">toggle</kbd> <a href="definitions.html#header">Page headers</a> are on by default. If you don’t want them, turn them off by invoking <kbd>.HEADERS</kbd> with any argument (<b>OFF, QUIT, -END, X...</b>), e.g. +END, X...</b>), eg <br/> <span class="pre-in-pp"> .HEADERS OFF @@ -439,8 +441,7 @@ appear at the bottom of the page. </p> <p> -<b>ADDITIONAL NOTE:</b> If HEADERS -are OFF, mom’s normal top +<b>ADDITIONAL NOTE:</b> If HEADERS are OFF, mom’s normal top margin for <a href="definitions.html#running">running text</a> (7.5 @@ -451,7 +452,7 @@ to the situation where footers have been explicitly turned on <kbd><a href="#footers">FOOTERS</a></kbd>). Explicitly invoking footers moves page numbering to the top of the page, where its placement and spacing are the same as -for headers. (I.e. the top margin of running text remains 7.5 +for headers (i.e. the top margin of running text remains 7.5 picas.) </p> @@ -470,7 +471,7 @@ Macro: <b>FOOTERS</b> <kbd class="macro-args">toggle</kbd> are off by default. If you want them instead of <a href="definitions.html#header">headers</a> (you can’t have both), turn them on by invoking -<kbd>.FOOTERS</kbd> without an argument, e.g. +<kbd>.FOOTERS</kbd> without an argument, eg <br/> <span class="pre-in-pp"> .FOOTERS @@ -537,8 +538,7 @@ to headers/footers) can be designed to your own specifications. </ul></li> <li><a href="#hdrftr-right">HEADER_RIGHT</a></li> <li><a href="#reserved-strings">Using mom’s reserved strings in header/footer definitions</a> - (e.g. <kbd>\E*[$TITLE]</kbd> when you want - <br/> + (eg <kbd>\E*[$TITLE]</kbd> when you want the title, <kbd>\E*[$AUTHOR]</kbd> when you want the author, etc.) </li> <li><a href="#page-number-symbol">Replacing header-left, centre or right with the page number</a></li> @@ -713,11 +713,12 @@ are: <span class="pre-in-pp"> \E*[$TITLE] —the current argument passed to .TITLE \E*[$DOCTITLE] —the current argument passed to .DOCTITLE + \E*[$DOC_TYPE] —the NAMED argument passed to .DOCTYPE \E*[$AUTHOR] —the current first argument passed to .AUTHOR \E*[$AUTHOR_1...9] —the current arguments passed to .AUTHOR \E*[$AUTHORS] —a comma-separated concatenated string of all the current arguments passed to .AUTHOR - (i.e. a list of authors) + (ie a list of authors) \E*[$CHAPTER_STRING] —the current argument passed to .CHAPTER_STRING, if invoked, otherwise, "Chapter" \E*[$CHAPTER] —the current argument (typically a number) passed @@ -937,7 +938,7 @@ to change the colour of the header rule. Replace HEADER_, above, with FOOTER_ to colourize footers. </p> -<div class="box-macro-args"> +<div id="hdrftr-plain" class="box-macro-args"> Macro: <b>HEADER_PLAIN</b> </div> @@ -1038,7 +1039,7 @@ or as defined by you with the simply invoke this macro (using the appropriate position) with no argument. If you wish to turn capitalization off (say, for the header-right string that mom capitalizes by default), invoke the -macro with any argument (e.g. <kbd>OFF, QUIT, END, X</kbd>...). +macro with any argument (eg <kbd>OFF, QUIT, END, X</kbd>...). </p> <p> @@ -1166,7 +1167,7 @@ you’d use HEADER_MARGIN to change their baseline placement. <p class="tip-top"> <span class="important" style="display: block; margin-bottom: -1em;">Important – FOOTER_MARGIN and bottom margins</span> <br/> -Mom requires a footer margin (i.e. the distance from the bottom of +Mom requires a footer margin (ie the distance from the bottom of the page at which to place footers) for proper operation, hence she sets one, even if you don’t. As stated above, her default footer margin is 3-picas. @@ -1176,9 +1177,9 @@ footer margin is 3-picas. If you use <a href="typesetting.html#b-margin">B_MARGIN</a> or -<a href="typesetting.html#page">PAGE</a>, +<a href="typesetting.html#page">PAGE</a> to set a bottom margin for your document (prior to -<a href="docprocessing.html#start">START</a>) +<a href="docprocessing.html#start">START</a>), and the margin’s too close to mom’s default footer margin (or a footer margin you set yourself with FOOTER_MARGIN), mom will not print your footers; additionally, @@ -1330,7 +1331,7 @@ Macro: <b>HEADER_RULE</b> <kbd class="macro-args">toggle</kbd> By default, mom prints a header separator rule underneath headers (or above footers). If you don’t want the rule, turn it off by invoking <kbd>.HEADER_RULE</kbd> with any argument (<kbd>OFF, QUIT, -END, X...</kbd>), e.g. +END, X...</kbd>), eg <br/> <span class="pre-in-pp"> .HEADER_RULE OFF @@ -1413,7 +1414,7 @@ to the bottom edge of the rule.) A unit of measure is required, and decimal fractions are allowed. Please note that HEADER_RULE_GAP has no effect on <a href="#hdrftr-gap">HEADER_GAP</a> -(i.e. HEADER_RULE_GAP is NOT added to HEADER_GAP when mom calculates +(ie HEADER_RULE_GAP is NOT added to HEADER_GAP when mom calculates the space between headers and the start of <a href="definitions.html#running">running text</a>). </p> @@ -1575,9 +1576,10 @@ Macro: <b>HEADER_RECTO</b> <kbd class="macro-args">LEFT | CENTER | RIGHT [ CAPS Macro: <b>HEADER_VERSO</b> <kbd class="macro-args">LEFT | CENTER | RIGHT [ CAPS ] "<header verso string>"</kbd> </div> -<div id="userdef-hdrftr" class="box-tip" style="margin-top: 1.5em; outline: 2px dashed #000089; margin-left: 3px; margin-right: 3px;"> +<div id="userdef-hdrftr" class="box-important"> + <p class="tip"> -<span class="tip" style="display: block; margin-bottom: -1.25em; color: #000056; font-size: 105%;">User-defined single string headers/footers (no recto/verso)</span> +<span class="tip" style="display: block; margin-bottom: -1.25em; color: #000056; font-size: 100%;">User-defined single string headers/footers (no recto/verso)</span> <br/> HEADER_RECTO may be used to create user-defined, single string headers (or footers, with FOOTER_RECTO), even when recto/verso is @@ -1692,7 +1694,7 @@ Notice that the quad argument, <kbd>LEFT</kbd>, is used in both cases. When padding a header, it doesn’t matter which quad argument you use, although you must be sure to supply one. Also note that mom does not interpret the <kbd>#</kbd> in -<kbd>\*[PAGE#]</kbd> as a padding marker (i.e. as a place to insert +<kbd>\*[PAGE#]</kbd> as a padding marker (ie as a place to insert whitespace). </p> @@ -1788,8 +1790,8 @@ three-part headers and footers. <p> <kbd>L | C | R</kbd> in the arguments to HEADERS_AND_FOOTERS refers -to whether you want the specific header or footer set flush left, -centered, or flush right. (You can also use the longer forms, +to whether you want the specific header or footer part on the left, +in the middle, or on the right. (You can also use the longer forms, <kbd>LEFT</kbd>, <kbd>CENTER</kbd> and <kbd>RIGHT</kbd>.) The string you give afterwards is whatever text you want, including mom’s @@ -1812,7 +1814,7 @@ to the style shown above to keep things manageable. <p> If you want to disable having both headers and footers on the same page, invoke <kbd>.HEADERS_AND_FOOTERS</kbd> with any argument -you want (e.g. <kbd>OFF, QUIT, END, X...</kbd>). Mom will restore +you want (eg <kbd>OFF, QUIT, END, X...</kbd>). Mom will restore her default behaviour of setting automatically generated page headers, with the page number, centered, at the bottom of the page. If you would prefer footers instead of headers after turning @@ -1914,7 +1916,7 @@ with control macros. <li><a href="#pagenum-style">PAGENUM_STYLE</a> – digits, roman numerals, etc</li> <li><a href="#pagenum-on-first-page">PAGENUM_ON_FIRST_PAGE</a> – applies only when footers are enabled</li> <li><a href="#draft-with-pagenumber">DRAFT_WITH_PAGENUMBER</a> – attach draft/revision information to page numbers</li> - <li><a href="#paginate-control">Pagination control macros and defaults</a></li> + <li><a href="#index-paginate-control">Pagination control macros and defaults</a></li> </ul> </div> @@ -1932,7 +1934,7 @@ Macro: <b>PAGINATE</b> <kbd class="macro-args">toggle</kbd> By default, mom paginates documents (in the bottom margin). If you’d prefer she not paginate, turn pagination off by invoking <kbd>.PAGINATE</kbd> with any argument (<kbd>OFF, NO, QUIT, END, -X...</kbd>), e.g. +X...</kbd>), eg <br/> <span class="pre-in-pp"> .PAGINATE NO @@ -2074,7 +2076,7 @@ See <span class="pre defaults"> .PAGENUM_FAMILY default = prevailing document family; default is Times Roman .PAGENUM_FONT default = roman -.PAGENUM_SIZE default = 0 (i.e. same size as paragraph text) +.PAGENUM_SIZE default = 0 (ie same size as paragraph text) .PAGENUM_COLOR default = black </span> </div> @@ -2153,7 +2155,7 @@ one blank page, you have to tell mom: </span> The optional argument, <kbd>DIVIDER</kbd>, must be given if you’re inserting a blank page before the start of any new -document section (i.e. a new chapter, or endnotes, a bibliography, +document section (ie a new chapter, or endnotes, a bibliography, or table of contents). Without the <kbd>DIVIDER</kbd> argument, mom simply inserts the blank pages and prepares the next page to receive <a href="definitions.html#running">running text</a>. |