diff options
| author | PTPi <PTPi> | 2011-02-22 19:42:29 +0000 |
|---|---|---|
| committer | PTPi <PTPi> | 2011-02-22 19:42:29 +0000 |
| commit | 1a92f66717e28a396f333babd3161d88d36fc321 (patch) | |
| tree | f64b8e0cba630e94a4d135a4fcbace80641a2728 | |
| parent | 56dc690684a3db928207e4163743e3a62b727541 (diff) | |
| download | groff-1a92f66717e28a396f333babd3161d88d36fc321.tar.gz | |
Added support for sub-subheads from patch supplied by Petr Man.
Updated docs.
24 files changed, 359 insertions, 101 deletions
diff --git a/contrib/mom/BUGS b/contrib/mom/BUGS index 736a759f..3bddc48a 100644 --- a/contrib/mom/BUGS +++ b/contrib/mom/BUGS @@ -1,4 +1,4 @@ - Copyright 2004, 2005, 2006, 2007, 2008, 2009 + Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc. Copying and distribution of this file, with or without modification, @@ -24,6 +24,15 @@ Also, please--no html email. That, too, gets nuked. Version 6 ========= +ENDNOTE_STRING_CAPS not disabling caps when arg given. +---Fixed--- + +Superfluous blank line before paragraphs with paraheads. +---Fixed--- + +Paraheads causing line numbering to overprint two line numbers. +---Fixed--- + Endless loop when DOC_LEAD_ADJUST is disabled. ---Fixed--- diff --git a/contrib/mom/ChangeLog b/contrib/mom/ChangeLog index 812e552b..52f95539 100644 --- a/contrib/mom/ChangeLog +++ b/contrib/mom/ChangeLog @@ -1,3 +1,7 @@ +* Sun Feb 20 2011 + +o Added support for sub-subheads from patch supplied by Petr Man. + * Fri Feb 11 2011 o Moved register #UNADJUSTED_DOC_LEAD to top of TRAPS macro. diff --git a/contrib/mom/NEWS b/contrib/mom/NEWS index dbbb6458..a7edb064 100644 --- a/contrib/mom/NEWS +++ b/contrib/mom/NEWS @@ -1,10 +1,14 @@ - Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010 + Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc. Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright notice and this notice are preserved. +Release 1.6-a +------------- +Support for sub-subheads added. + Release 1.6 ----------- Complete overhaul of refer handling. If you've been using mom and diff --git a/contrib/mom/momdoc/appendices.html b/contrib/mom/momdoc/appendices.html index 7aa92408..a4ce21ad 100644 --- a/contrib/mom/momdoc/appendices.html +++ b/contrib/mom/momdoc/appendices.html @@ -2,7 +2,7 @@ <!-- This file is part of groff, the GNU roff type-setting system. -Copyright (C) 2004, 2005, 2006, 2009, 2010 Free Software Foundation, Inc. +Copyright (C) 2004, 2005, 2006, 2009, 2010, 2011 Free Software Foundation, Inc. Written by Peter Schaffter. Permission is granted to copy, distribute and/or modify this document diff --git a/contrib/mom/momdoc/color.html b/contrib/mom/momdoc/color.html index 45e74163..0018e85f 100644 --- a/contrib/mom/momdoc/color.html +++ b/contrib/mom/momdoc/color.html @@ -2,7 +2,7 @@ <!-- This file is part of groff, the GNU roff type-setting system. -Copyright (C) 2004, 2005, 2006, 2009, 2010 Free Software Foundation, Inc. +Copyright (C) 2004, 2005, 2006, 2009, 2010, 2011 Free Software Foundation, Inc. Written by Peter Schaffter. Permission is granted to copy, distribute and/or modify this document diff --git a/contrib/mom/momdoc/cover.html b/contrib/mom/momdoc/cover.html index e1b4d3ea..744d415e 100644 --- a/contrib/mom/momdoc/cover.html +++ b/contrib/mom/momdoc/cover.html @@ -2,7 +2,7 @@ <!-- This file is part of groff, the GNU roff type-setting system. -Copyright (C) 2004, 2005, 2006, 2009, 2010 Free Software Foundation, Inc. +Copyright (C) 2004, 2005, 2006, 2009, 2010, 2011 Free Software Foundation, Inc. Written by Peter Schaffter. Permission is granted to copy, distribute and/or modify this document diff --git a/contrib/mom/momdoc/definitions.html b/contrib/mom/momdoc/definitions.html index 0c26715d..3bc37bdb 100644 --- a/contrib/mom/momdoc/definitions.html +++ b/contrib/mom/momdoc/definitions.html @@ -2,7 +2,7 @@ <!-- This file is part of groff, the GNU roff type-setting system. -Copyright (C) 2004, 2005, 2006, 2009, 2010 Free Software Foundation, Inc. +Copyright (C) 2004, 2005, 2006, 2009, 2010, 2011 Free Software Foundation, Inc. Written by Peter Schaffter. Permission is granted to copy, distribute and/or modify this document diff --git a/contrib/mom/momdoc/docelement.html b/contrib/mom/momdoc/docelement.html index c7bea507..5da69632 100644 --- a/contrib/mom/momdoc/docelement.html +++ b/contrib/mom/momdoc/docelement.html @@ -2,7 +2,7 @@ <!-- This file is part of groff, the GNU roff type-setting system. -Copyright (C) 2004, 2005, 2006, 2009, 2010 Free Software Foundation, Inc. +Copyright (C) 2004, 2005, 2006, 2009, 2010, 2011 Free Software Foundation, Inc. Written by Peter Schaffter. Permission is granted to copy, distribute and/or modify this document @@ -82,6 +82,11 @@ FDL in the main directory of the groff source package. <li><a href="#subhead">SUBHEAD</a></li> <li><a href="#subhead-control">Subhead control</a></li> </ul> +<h3 class="toc toc-docproc-header"><a class="header-link" href="#subsubhead-intro">Subsubheads</a></h3> +<ul class="toc-docproc" style="margin-top: .5em;"> + <li><a href="#subsubhead">SUBSUBHEAD</a></li> + <li><a href="#subsubhead-control">Subsubhead control</a></li> +</ul> <h3 class="toc toc-docproc-header"><a class="header-link" href="#parahead-intro">Paragraph heads</a></h3> <ul class="toc-docproc" style="margin-top: .5em;"> <li><a href="#parahead">PARAHEAD</a></li> @@ -1120,9 +1125,9 @@ See <a href="#control-macro-args">Arguments to the control macros</a>. </p> <span class="pre defaults"> -.HEAD_FAMILY default = prevailing document family; default is Times Roman -.HEAD_FONT default = bold -.HEAD_SIZE default = +1 (point) +.HEAD_FAMILY default = prevailing document family +.HEAD_FONT default = bold, underlined (TYPESET); roman,underlined (TYPEWRITE) +.HEAD_SIZE default = +1 (TYPESET); 0 (TYPEWRITE) .HEAD_COLOR default = black .HEAD_QUAD default = CENTER </span> @@ -1141,8 +1146,9 @@ To change this behaviour, do .HEAD_CAPS OFF </span> HEAD_CAPS is a toggle macro, therefore you can use any argument you -like instead of <kbd>OFF</kbd> (<b>END, QUIT, Q, X</b>...). To turn -HEAD_CAPS back on, simply invoke it without an argument. +like instead of <kbd>OFF</kbd> to disable it (e.g. <b>END, QUIT, Q, +X</b>...). To turn HEAD_CAPS back on, simply invoke it without an +argument. </p> <h4 id="head-space" class="docs" style="margin-top: -.25em;">3. Pre-head space</h4> @@ -1349,7 +1355,7 @@ Subheads should be used any place you want titles to introduce sections of a document below heads. If you wish, mom can number subheads for you. Subhead numbers can also be included hierarchically in numbered -<a href="#parahead-intro">paraheads</a>. +<a href="#subsubhead-intro">subsubheads</a>. </p> <p> @@ -1387,9 +1393,10 @@ surround each line with double-quotes. <div class="box-tip"> <p class="tip"> <span class="note">Note:</span> -If a subhead falls near the bottom of an output page and mom is -unable to fit the head <i>plus at least one line of text underneath -it</i>, she will set the subhead at the top of the next page. +If a subhead falls near the bottom of an output page and mom +is unable to fit the subhead <i>plus at least one line of text +underneath it</i>, she will set the subhead at the top of the next +page. </p> </div> @@ -1398,13 +1405,14 @@ it</i>, she will set the subhead at the top of the next page. <p class="defaults"> In addition to the usual family/font/size/quad control macros, there -are macros to manage subhead numbering. +are macros to manage subhead numbering and vertical placement. </p> <ol style="margin-top: .5em; padding-bottom: .5em;"> <li><a href="#subhead-general">Family/font/size/colour/quad</a></li> <li><a href="#number-subheads">Numbering</a></li> <li><a href="#reset-subhead-number">Reset subhead numbering</a></li> + <li><a href="#subhead-baseline-adjust">Baseline adjustment</a></li> <li><a href="#subhead-inlines">Vertical inline escapes inside subheads</a></li> </ol> </div> @@ -1417,9 +1425,9 @@ See <a href="#control-macro-args">Arguments to the control macros</a>. </p> <span class="pre defaults" style="padding-bottom: -1em;"> -.SUBHEAD_FAMILY default = prevailing document family; default is Times Roman -.SUBHEAD_FONT default = bold -.SUBHEAD_SIZE default = +.5 (point) +.SUBHEAD_FAMILY default = prevailing document family +.SUBHEAD_FONT default = bold (TYPESET); italic, ie underlined (TYPEWRITE) +.SUBHEAD_SIZE default = +.5 (TYPESET); 0 (TYPEWRITE) .SUBHEAD_COLOR default = black .SUBHEAD_QUAD default = LEFT </span> @@ -1475,7 +1483,32 @@ Your next subhead will be numbered “4” and subsequent subheads will be numbered in ascending order from “4”. </p> -<h4 id="subhead-inlines" class="docs" style="margin-top: -.25em;">4. Vertical inline escapes inside subheads</h4> +<h4 id="subhead-baseline-adjust" class="docs" style="margin-top: -.25em;">4. Baseline adjustment</h4> + +<p> +For aesthetic reasons and to clarify document structure, mom raises +subheads slightly above the +<a href="definitions.html#baseline">baseline</a> +on which they would otherwise fall. In +<a href="docprocessing.html#printstyle">PRINTSTYLE <kbd>TYPESET</kbd></a>, +the amount is 1/8 of the prevailing +<a href="definitions.html#leading">leading</a>. In +<a href="docprocessing.html#printstyle">PRINTSTYLE <kbd>TYPEWRITE</kbd></a>, +it’s 1/5 of the prevailing leading. +</p> + +<p> +If you would prefer mom not exhibit this behaviour, or if you would +like to change the amount by which she raises the subhead, use the +macro <kbd>.SUBHEAD_BASELINE_ADJUST</kbd>. With an argument of 0 (zero), +subhead baseline adjustment will be disabled. Any other numeric +argument, with a +<a href="definitions.html#unitofmeasure">unit of measure</a> +appended directly onto the argument, will cause mom to raise your +subheads by the amount you specify. +</p> + +<h4 id="subhead-inlines" class="docs" style="margin-top: -.25em;">5. Vertical inline escapes inside subheads</h4> <p> See @@ -1487,6 +1520,183 @@ The information there applies equally to subheads. <!-- ==================================================================== --> +<h2 id="subsubhead-intro" class="macro-group">Subsubheads</h2> + +<ul style="margin-left: -.5em;"> + <li><a href="#subsubhead">Tag: SUBSUBHEAD</a></li> + <li><a href="#subsubhead-control">Subsubhead control macros</a></li> +</ul> + +<p> +Subsubheads should be used any place you want titles to introduce +sections of a document below subheads. If you wish, mom can +number subsubheads for you. Subsubhead numbers can also be included +hierarchically in numbered +<a href="#parahead-intro">paraheads</a>. +</p> + +<p> +By default, subsubheads are flush left. In +<a href="docprocessing.html#printstyle">PRINTSTYLE <kbd>TYPESET</kbd></a>, +they are set in italic, slightly larger than paragraph text. In +<a href="docprocessing.html#printstyle">PRINTSTYLE <kbd>TYPEWRITE</kbd></a>, +they are set roman at the same size as the prevailing type. A +single linespace precedes them in both printstyles, and a tiny space +adjustment raises them slightly above text that comes afterwards for +greater clarity in document structuring. +</p> + +<p> +If these defaults don’t suit you, you can change them with the +subsubhead control macros. +</p> + +<!-- -SUBSUBHEAD- --> + +<div class="macro-id-overline"> +<h3 id="subsubhead" class="macro-id">SUBSUBHEAD</h3> +</div> + +<div class="box-macro-args"> +Macro: <b>SUBSUBHEAD</b> <kbd class="macro-args">"<text of subsubhead>" [ "<2nd line>" [ "<3rd line>" ... ] ]</kbd> +</div> + +<p> +The argument to SUBSUBHEAD is the text of the subsubhead, surrounded by +double-quotes. If you need additional lines for a subsubhead, simply +surround each line with double-quotes. +</p> + +<div class="box-tip"> +<p class="tip"> +<span class="note">Note:</span> +If a subsubhead falls near the bottom of an output page and mom +is unable to fit the subsubhead <i>plus at least one line of text +underneath it</i>, she will set the subsubhead at the top of the next +page. +</p> +</div> + +<div class="defaults-container" style="background-color: #ded4bd; border: none;"> +<h3 id="subsubhead-control" class="docs defaults">SUBSUBHEAD control macros and defaults</h3> + +<p class="defaults"> +In addition to the usual family/font/size/quad control macros, there +are macros to manage subsubhead numbering. +</p> + +<ol style="margin-top: .5em; padding-bottom: .5em;"> + <li><a href="#subsubhead-general">Family/font/size/colour/quad</a></li> + <li><a href="#number-subsubheads">Numbering</a></li> + <li><a href="#reset-subsubhead-number">Reset subsubhead numbering</a></li> + <li><a href="#subsubhead-baseline-adjust">Baseline adjustment</a></li> + <li><a href="#subsubhead-inlines">Vertical inline escapes inside subsubheads</a></li> +</ol> +</div> + +<h4 id="subsubhead-general" class="docs" style="margin-top: -1.5em; margin-bottom: .5em;">1. Family/font/size/quad</h4> + +<div class="defaults-container" style="padding-bottom: 8px;"> +<p class="defaults" style="padding-top: 6px;"> +See +<a href="#control-macro-args">Arguments to the control macros</a>. +</p> +<span class="pre defaults" style="padding-bottom: -1em;"> +.SUBSUBHEAD_FAMILY default = prevailing document family +.SUBSUBHEAD_FONT default = italic (TYPESET); roman (TYPEWRITE) +.SUBSUBHEAD_SIZE default = +.5 (TYPESET); 0 (TYPEWRITE) +.SUBSUBHEAD_COLOR default = black +.SUBSUBHEAD_QUAD default = LEFT +</span> +</div> + +<h4 id="number-subsubheads" class="docs" style="margin-top: -1.25em;">2. Number subsubheads</h4> + +<p> +If you’d like your subsubheads numbered, simply invoke +<kbd>.NUMBER_SUBSUBHEADS</kbd> with no argument. Mom will number +all subsequent subsubheads automatically (in ascending order, +naturally). +</p> + +<p> +If, in addition to numbering subsubheads, you also request that +<a href="#head-intro">heads</a> +be numbered, the head number will be included in the subsubhead +number (separated by a period [dot]). +</p> + +<p> +Should you wish to stop subsubhead numbering, invoke +<kbd>.NUMBER_SUBSUBHEADS</kbd> with any argument (<kbd>OFF, QUIT, END, +X</kbd>...). Subsubhead numbering will cease, and the subsubhead number +will not be included in the numbering of paraheads. +</p> + +<p> +See also +<a href="#prefix-chapter-number">Prefixing chapter numbers</a> +if you’d like chapter numbers prepended to the subsubhead numbers. +</p> + +<h4 id="reset-subsubhead-number" class="docs" style="margin-top: -.25em;">3. Reset subsubhead numbering</h4> + +<p> +Should you wish to reset the subsubhead number to “1”, +invoke +<span class="pre-in-pp"> + .RESET_SUBSUBHEAD_NUMBER +</span> +with no argument. If, for some reason, you want mom to use a +subsubhead number that is not the next in ascending order (i.e. the +last subsubhead number + 1), invoke <kbd>.RESET_SUBSUBHEAD_NUMBER</kbd> +with the number you want, e.g. +<br/> +<span class="pre-in-pp"> + .RESET_SUBSUBHEAD_NUMBER 4 +</span> + +Your next subsubhead will be numbered “4” and subsequent +subsubheads will be numbered in ascending order from “4”. +</p> + +<h4 id="subsubhead-baseline-adjust" class="docs" style="margin-top: -.25em;">4. Baseline adjustment</h4> + +<p> +For aesthetic reasons and to clarify document structure, mom raises +subsubheads slightly above the +<a href="definitions.html#baseline">baseline</a> +on which they would otherwise fall. In +<a href="docprocessing.html#printstyle">PRINTSTYLE <kbd>TYPESET</kbd></a>, +the amount is 1/8 of the prevailing +<a href="definitions.html#leading">leading</a>. In +<a href="docprocessing.html#printstyle">PRINTSTYLE <kbd>TYPEWRITE</kbd></a>, +it’s 1/5 of the prevailing leading. +</p> + +<p> +If you would prefer mom not exhibit this behaviour, or if you would +like to change the amount by which she raises the subsubhead, use the +macro <kbd>.SUBSUBHEAD_BASELINE_ADJUST</kbd>. With an argument of 0 (zero), +subsubhead baseline adjustment will be disabled. Any other numeric +argument, with a +<a href="definitions.html#unitofmeasure">unit of measure</a> +appended directly onto the argument, will cause mom to raise your +subsubheads by the amount you specify. +</p> + +<h4 id="subsubhead-inlines" class="docs" style="margin-top: -.25em;">5. Vertical inline escapes inside sububheads</h4> + +<p> +See +<a href="#head-inlines">Vertical inline escapes inside heads</a>. +The information there applies equally to subsubheads. +</p> + +<div class="rule-short"><hr/></div> + +<!-- ==================================================================== --> + <h2 id="parahead-intro" class="macro-group">Paragraph heads</h2> <ul style="margin-left: -.5em;"> @@ -1521,8 +1731,8 @@ parahead control macros. <div class="box-tip"> <p class="tip"> <span class="tip">Tip:</span> -If you really need a heading level below subhead (a sub-subhead) -that isn’t joined to the body of a paragraph, you can trick +If you really need a heading level below subsubheads that +isn’t joined to the body of a paragraph, you can trick PARAHEAD into giving you one by creating a paragraph that contains only a parahead, like this: <br/> @@ -1585,9 +1795,9 @@ See <a href="#control-macro-args">Arguments to the control macros</a>. </p> <span class="pre defaults"> -.PARAHEAD_FAMILY default = prevailing document family; default is Times Roman -.PARAHEAD_FONT default = bold italic -.PARAHEAD_SIZE default = +.5 (point) +.PARAHEAD_FAMILY default = prevailing document family +.PARAHEAD_FONT default = bold italic (TYPESET); italic, ie underlined (TYPEWRITE) +.PARAHEAD_SIZE default = -.25 (TYPESET); 0 (TYPEWRITE) .PARAHEAD_COLOR default = black* *If you colourize paragraph text, paraheads will appear in the same @@ -1615,9 +1825,6 @@ do: <span class="pre-in-pp"> .PARAHEAD_INDENT 2.5P </span> -</p> - -<p> Mom’s default indent for paragraph heads is 1/2 the first-line indent of normal paragraphs (both printstyles). However, as stated above, if you choose to change the indent, you must give an absolute @@ -1629,6 +1836,18 @@ PP_INDENT.) <div class="box-tip"> <p class="tip"> +<span class="tip">Tip:</span> +If you want to make the parahead indent equal to the paragraph +indent, a convenient way to do it is +<br/> +<span class="pre-in-pp"> + .PARAHEAD INDENT \n[#PP_INDENT] +</span> +</p> +</div> + +<div class="box-tip"> +<p class="tip"> <span class="note">Note:</span> Paragraph heads in “first paragraphs”, as defined in <a href="#para-indent-first">Indenting initial paragraphs</a>, @@ -1734,10 +1953,11 @@ Macro: <b>PREFIX_CHAPTER_NUMBER</b> <kbd class="macro-args"><none> | <c </div> <p> -If you’ve requested numbering of heads, subheads and/or paragraph -heads (with +If you’ve requested numbering of heads, subheads, subsubheads +and/or paragraph heads (with <a href="#number-heads">NUMBER_HEADS</a>, -<a href="#number-subheads">NUMBER_SUBHEADS</a> +<a href="#number-subheads">NUMBER_SUBHEADS,</a> +<a href="#number-subheads">NUMBER_SUBSUBHEADS</a> and/or <a href="#number-paraheads">NUMBER_PARAHEADS</a>) and you’d like mom, in addition, to prefix @@ -5336,10 +5556,11 @@ See <a href="#control-macro-args">Arguments to the control macros</a>. </p> <span class="pre defaults"> -.ENDNOTE_STRING_FAMILY default = prevailing document family; default is Times Roman +.ENDNOTE_STRING_FAMILY default = prevailing document family .ENDNOTE_STRING_FONT default = bold .ENDNOTE_STRING_SIZE* default = +1 .ENDNOTE_STRING_QUAD default = centred +.ENDNOTE_STRING_COLOR default = black *Relative to the size of the endnotes text (set with ENDNOTE_PT_SIZE) </span> diff --git a/contrib/mom/momdoc/docprocessing.html b/contrib/mom/momdoc/docprocessing.html index 5896d1cc..a2a45e91 100644 --- a/contrib/mom/momdoc/docprocessing.html +++ b/contrib/mom/momdoc/docprocessing.html @@ -2,7 +2,7 @@ <!-- This file is part of groff, the GNU roff type-setting system. -Copyright (C) 2004, 2005, 2010, 2009, 2010 Free Software Foundation, Inc. +Copyright (C) 2004, 2005, 2006, 2009, 2010, 2011 Free Software Foundation, Inc. Written by Peter Schaffter. Permission is granted to copy, distribute and/or modify this document diff --git a/contrib/mom/momdoc/goodies.html b/contrib/mom/momdoc/goodies.html index 69d402c3..cfcdb9ad 100644 --- a/contrib/mom/momdoc/goodies.html +++ b/contrib/mom/momdoc/goodies.html @@ -2,7 +2,7 @@ <!-- This file is part of groff, the GNU roff type-setting system. -Copyright (C) 2004, 2005, 2006, 2009, 2010 Free Software Foundation, Inc. +Copyright (C) 2004, 2005, 2006, 2009, 2010, 2011 Free Software Foundation, Inc. Written by Peter Schaffter. Permission is granted to copy, distribute and/or modify this document diff --git a/contrib/mom/momdoc/graphical.html b/contrib/mom/momdoc/graphical.html index f6c063de..ce98f365 100644 --- a/contrib/mom/momdoc/graphical.html +++ b/contrib/mom/momdoc/graphical.html @@ -2,7 +2,7 @@ <!-- This file is part of groff, the GNU roff type-setting system. -Copyright (C) 2004, 2005, 2006, 2009, 2010 Free Software Foundation, Inc. +Copyright (C) 2004, 2005, 2006, 2009, 2010, 2011 Free Software Foundation, Inc. Written by Peter Schaffter. Permission is granted to copy, distribute and/or modify this document diff --git a/contrib/mom/momdoc/headfootpage.html b/contrib/mom/momdoc/headfootpage.html index d411874a..f974b283 100644 --- a/contrib/mom/momdoc/headfootpage.html +++ b/contrib/mom/momdoc/headfootpage.html @@ -2,7 +2,7 @@ <!-- This file is part of groff, the GNU roff type-setting system. -Copyright (C) 2004, 2005, 2006, 2009, 2010 Free Software Foundation, Inc. +Copyright (C) 2004, 2005, 2006, 2009, 2010, 2011 Free Software Foundation, Inc. Written by Peter Schaffter. Permission is granted to copy, distribute and/or modify this document diff --git a/contrib/mom/momdoc/images.html b/contrib/mom/momdoc/images.html index e3af015f..67e8ace5 100644 --- a/contrib/mom/momdoc/images.html +++ b/contrib/mom/momdoc/images.html @@ -2,7 +2,7 @@ <!-- This file is part of groff, the GNU roff type-setting system. -Copyright (C) 2004, 2005, 2006, 2009, 2010 Free Software Foundation, Inc. +Copyright (C) 2004, 2005, 2006, 2009, 2010, 2011 Free Software Foundation, Inc. Written by Peter Schaffter. Permission is granted to copy, distribute and/or modify this document diff --git a/contrib/mom/momdoc/inlines.html b/contrib/mom/momdoc/inlines.html index 1349abcb..bbb9d6eb 100644 --- a/contrib/mom/momdoc/inlines.html +++ b/contrib/mom/momdoc/inlines.html @@ -2,7 +2,7 @@ <!-- This file is part of groff, the GNU roff type-setting system. -Copyright (C) 2004, 2005, 2006, 2009, 2010 Free Software Foundation, Inc. +Copyright (C) 2004, 2005, 2006, 2009, 2010, 2011 Free Software Foundation, Inc. Written by Peter Schaffter. Permission is granted to copy, distribute and/or modify this document diff --git a/contrib/mom/momdoc/intro.html b/contrib/mom/momdoc/intro.html index 34dd571c..be911683 100644 --- a/contrib/mom/momdoc/intro.html +++ b/contrib/mom/momdoc/intro.html @@ -2,7 +2,7 @@ <!-- This file is part of groff, the GNU roff type-setting system. -Copyright (C) 2004, 2005, 2006, 2009, 2010 Free Software Foundation, Inc. +Copyright (C) 2004, 2005, 2006, 2009, 2010, 2011 Free Software Foundation, Inc. Written by Peter Schaffter. Permission is granted to copy, distribute and/or modify this document diff --git a/contrib/mom/momdoc/letters.html b/contrib/mom/momdoc/letters.html index 95a2e709..4cfb2193 100644 --- a/contrib/mom/momdoc/letters.html +++ b/contrib/mom/momdoc/letters.html @@ -2,7 +2,7 @@ <!-- This file is part of groff, the GNU roff type-setting system. -Copyright (C) 2004, 2005, 2006, 2009, 2010 Free Software Foundation, Inc. +Copyright (C) 2004, 2005, 2006, 2009, 2010, 2011 Free Software Foundation, Inc. Written by Peter Schaffter. Permission is granted to copy, distribute and/or modify this document diff --git a/contrib/mom/momdoc/macrolist.html b/contrib/mom/momdoc/macrolist.html index c320d158..12bfcb9d 100644 --- a/contrib/mom/momdoc/macrolist.html +++ b/contrib/mom/momdoc/macrolist.html @@ -2,7 +2,7 @@ <!-- This file is part of groff, the GNU roff type-setting system. -Copyright (C) 2004, 2005, 2006, 2009, 2010 Free Software Foundation, Inc. +Copyright (C) 2004, 2005, 2006, 2009, 2010, 2011 Free Software Foundation, Inc. Written by Peter Schaffter. Permission is granted to copy, distribute and/or modify this document diff --git a/contrib/mom/momdoc/rectoverso.html b/contrib/mom/momdoc/rectoverso.html index 1fbd1460..97a67e77 100644 --- a/contrib/mom/momdoc/rectoverso.html +++ b/contrib/mom/momdoc/rectoverso.html @@ -2,7 +2,7 @@ <!-- This file is part of groff, the GNU roff type-setting system. -Copyright (C) 2004, 2005, 2006, 2009, 2010 Free Software Foundation, Inc. +Copyright (C) 2004, 2005, 2006, 2009, 2010, 2011 Free Software Foundation, Inc. Written by Peter Schaffter. Permission is granted to copy, distribute and/or modify this document diff --git a/contrib/mom/momdoc/refer.html b/contrib/mom/momdoc/refer.html index e356f4fc..2998b81a 100644 --- a/contrib/mom/momdoc/refer.html +++ b/contrib/mom/momdoc/refer.html @@ -2,7 +2,7 @@ <!-- This file is part of groff, the GNU roff type-setting system. -Copyright (C) 2004, 2005, 2006, 2009, 2010 Free Software Foundation, Inc. +Copyright (C) 2004, 2005, 2006, 2009, 2010, 2011 Free Software Foundation, Inc. Written by Peter Schaffter. Permission is granted to copy, distribute and/or modify this document diff --git a/contrib/mom/momdoc/reserved.html b/contrib/mom/momdoc/reserved.html index a2b08b45..d8cd524c 100644 --- a/contrib/mom/momdoc/reserved.html +++ b/contrib/mom/momdoc/reserved.html @@ -2,7 +2,7 @@ <!-- This file is part of groff, the GNU roff type-setting system. - Copyright (C) 2004, 2005, 2006, 2009, 2010 Free Software Foundation, Inc. + Copyright (C) 2004, 2005, 2006, 2009, 2010, 2011 Free Software Foundation, Inc. Written by Peter Schaffter. Permission is granted to copy, distribute and/or modify this document @@ -644,6 +644,7 @@ mom uses, along with brief descriptions of their functions. START Sets doc defaults and prints info collected with doc info macros SUBHEAD Subheads + SUBSUBHEAD Subsubheads <span style="display: block; margin-top: -.75em; margin-bottom: -1em;">*Headers/footers</span> BREAK_QUOTE Manually break a footnoted quote that crosses @@ -811,6 +812,8 @@ mom uses, along with brief descriptions of their functions. HDRFTR_VERSO User-defined, single string verso header/footer HEADERS Turns headers on or off + HEADER_GAP Space between header and running text + HEADER_MARGIN Space from top of page to header HEADERS_AND_FOOTERS Enables and permits the creation of headers and footers that appear on the same page @@ -831,8 +834,6 @@ mom uses, along with brief descriptions of their functions. endnotes -Heads- - HEADER_GAP Space between header and running text - HEADER_MARGIN Space from top of page to header HEAD_CAPS Print section titles in caps? (boolean) HEAD_SPACE Give HEADs 2 line-spaces before. If OFF, only 1. Default is on. @@ -843,6 +844,12 @@ mom uses, along with brief descriptions of their functions. -Subheads- NUMBER_SUBHEADS Print subhead numbers RESET_SUBHEAD_NUMBER Reset subhead number + SUBHEAD_BASELINE_ADJUST Amount to raise subhead above baseline + +-Subsubheads- + NUMBER_SUBSUBHEADS Print subhead numbers + RESET_SUBSUBHEAD_NUMBER Reset subhead number + SUBSUBHEAD_BASELINE_ADJUST Amount to raise subhead above baseline -Para heads- NUMBER_PARAHEADS Print parahead numbers @@ -1509,27 +1516,27 @@ mom uses, along with brief descriptions of their functions. line numbering is enabled #LINES_PER_PAGE # of lines (at DOC_LEAD) that fit on page after #B_MARGIN is set - #LN Are line numbers on? (boolean) - MN-active Are we doing a margin note? (boolean) - MN-curr Current margin note - MN-div-<n>-depth Depth of margin note <n> - MN-hy Hyphenation flag of margin notes + #LN Test 1st arg to NUMBER_LINES for digit or string + MN-active Are we doing a margin note? (boolean) + MN-curr Current margin note + MN-div-<n>-depth Depth of margin note <n> + MN-hy Hyphenation flag of margin notes #MNinit Have margin notes been initialized? (boolean) #MNinit_DEFERRED Did we have to defer a margin note? (boolean) - MN-last-pos Baseline of previous margin note - MN-lead-adj Difference between the current DOC_LEAD and the - leading used in margin notes - MN-left Number of current left margin note - MN-left-start Horizontal start position of left margin note - MN-left-width Width of left margin note - MN-right Number of current right margin note - MN-right-start Horizontal start position of right margin note - MN-right-width Width of right margin note - MN-sep Gutter between margin notes and running text - MN-shifted Did we have to shift a margin note down? - (boolean) - MN-size Point size of margin notes - MN-spacing Leading of margin notes + MN-last-pos Baseline of previous margin note + MN-lead-adj Difference between the current DOC_LEAD and the + leading used in margin notes + MN-left Number of current left margin note + MN-left-start Horizontal start position of left margin note + MN-left-width Width of left margin note + MN-right Number of current right margin note + MN-right-start Horizontal start position of right margin note + MN-right-width Width of right margin note + MN-sep Gutter between margin notes and running text + MN-shifted Did we have to shift a margin note down? + (boolean) + MN-size Point size of margin notes + MN-spacing Leading of margin notes #MISC_<n> Used to print "next" misc lines in DO_COVER #MISC_COVER_NUM Number of cover misc items #MISC_DOCCOVER_NUM Number od doc cover misc items @@ -1576,9 +1583,10 @@ mom uses, along with brief descriptions of their functions. #NUMBER_HEAD Are heads numbered? (boolean) #NUMBER_PH Are paraheads numbered? (boolean) #NUMBER_SH Are subheads numbered? (boolean) + #NUMBER_SSH Are subsubheads numbered? (boolean) #NUM_COLS Number of columns per page #NUMBERED If set to 1, lets PARAHEAD know that - main- and subhead numbers have already been + main-, sub-, and subsubhead numbers have already been prefixed to the parahead string #NUM_FIELDS Incrementing register used to match #TOTAL_FIELDS @@ -1763,8 +1771,8 @@ mom uses, along with brief descriptions of their functions. #SAVED_WEIGHT_ADJ SAVED_UNDERSCORE_WEIGHT/2 #SEP_TYPE Set to 1 if LIST separator is ( or [ or { #SH_COLOR Colorize subheads? (boolean) - #SH_LEAD_ADJUST #DOC_LEAD/8 (TYPESET) or /2 (TYPEWRITE) - (used for subhead spacing) + #SH_BASELINE_ADJ #DOC_LEAD/8 (TYPESET) or /5 (TYPEWRITE) + (used for subhead vertical spacing) #SH_NUM Subhead number #SHIM Amount of lead required to advance to next valid baseline @@ -1786,6 +1794,8 @@ mom uses, along with brief descriptions of their functions. sometimes reports a fractionally larger space than is actually available for footnote text. + #SSH_BASELINE_ADJ #DOC_LEAD/8 (TYPESET) or /5 (TYPEWRITE) + (used for subsubhead vertical spacing) #START If 1, signals completion of START #START_FOR_FOOTERS Toggle set in START; signals to PRINT_HDRFTR that START has been invoked, diff --git a/contrib/mom/momdoc/tables-of-contents.html b/contrib/mom/momdoc/tables-of-contents.html index 82c744b9..66b487eb 100644 --- a/contrib/mom/momdoc/tables-of-contents.html +++ b/contrib/mom/momdoc/tables-of-contents.html @@ -2,7 +2,7 @@ <!-- This file is part of groff, the GNU roff type-setting system. -Copyright (C) 2004, 2005, 2006, 2009, 2010 Free Software Foundation, Inc. +Copyright (C) 2004, 2005, 2006, 2009, 2010, 2011 Free Software Foundation, Inc. Written by Peter Schaffter. Permission is granted to copy, distribute and/or modify this document @@ -552,12 +552,15 @@ entries, along with their defaults. <div id="toc-indent-note" class="box-tip"> <p class="tip"> <span class="note">Note:</span> -The table of contents _INDENT -macros set an absolute indent, relative to nothing, and therefore -require an appended +The table of contents _INDENT macros set an absolute indent, +relative to nothing, and therefore require an appended <a href="definitions.html#unitofmeasure">unit of measure</a>. +Furthermore, the size of the indent can only be changed when your +<a href="docprocessing.html#printstyle">PRINTSTYLE</a> +is <kbd>TYPESET</kbd>; the indent is fixed for <kbd>TYPEWRITE</kbd>. </p> </div> + <div id="index-toc-entry-control-macros" class="defaults-container" style="padding-bottom: 8px;"> <p class="defaults" style="padding-top: 6px;"> See @@ -567,31 +570,37 @@ See <span class="pre defaults"> <span id="toc-title"> .TOC_TITLE_FAMILY default = prevailing doc family -.TOC_TITLE_FONT default = bold italic -.TOC_TITLE_SIZE default = +0 -.TOC_TITLE_INDENT default = 0 for TYPESET and TYPEWRITE +.TOC_TITLE_FONT default = bold italic (TYPESET); roman (TYPEWRITE) +.TOC_TITLE_SIZE default = +1.5 +.TOC_TITLE_INDENT default = 0 </span> <span id="toc-head"> .TOC_HEAD_FAMILY default = prevailing doc family -.TOC_HEAD_FONT default = bold +.TOC_HEAD_FONT default = bold (TYPESET); roman (TYPEWRITE) .TOC_HEAD_SIZE default = +.5 -.TOC_HEAD_INDENT default = 18p for TYPESET; 2m for TYPEWRITE +.TOC_HEAD_INDENT default = 2 <a href="definitions.html#figurespace">figure spaces</a> + a period </span> <span id="toc-subhead"> .TOC_SUBHEAD_FAMILY default = prevailing doc family .TOC_SUBHEAD_FONT default = roman -.TOC_SUBHEAD_SIZE default = +0 -.TOC_SUBHEAD_INDENT default = 30p for TYPESET; 4m for TYPEWRITE +.TOC_SUBHEAD_SIZE default = 0 +.TOC_SUBHEAD_INDENT default = TOC_HEAD_INDENT + 2 <a href="definitions.html#figurespace">figure spaces</a> + a period +</span> +<span id="toc-subsubhead"> +.TOC_SUBSUBHEAD_FAMILY default = prevailing doc family +.TOC_SUBSUBHEAD_FONT default = italic (TYPESET); roman (TYPEWRITE) +.TOC_SUBSUBHEAD_SIZE default = 0 +.TOC_SUBSUBHEAD_INDENT default = TOC_SUBHEAD_INDENT + 2 <a href="definitions.html#figurespace">figure spaces</a> + a period </span> <span id="toc-parahead"> .TOC_PARAHEAD_FAMILY default = prevailing doc family -.TOC_PARAHEAD_FONT default = italic -.TOC_PARAHEAD_SIZE default = +0 -.TOC_PARAHEAD_INDENT default = 42p for TYPESET; 6m for TYPEWRITE +.TOC_PARAHEAD_FONT default = bold italic (TYPESET); roman (TYPEWRITE) +.TOC_PARAHEAD_SIZE default = 0 +.TOC_PARAHEAD_INDENT default = TOC_SUBSUBHEAD_INDENT + 2 <a href="definitions.html#figurespace">figure spaces</a> + a period </span> .TOC_PN_FAMILY default = prevailing doc family .TOC_PN_FONT default = roman -.TOC_PN_SIZE default = +0 +.TOC_PN_SIZE default = 0 </span> </div> diff --git a/contrib/mom/momdoc/toc.html b/contrib/mom/momdoc/toc.html index 1cc1573e..01da91a9 100644 --- a/contrib/mom/momdoc/toc.html +++ b/contrib/mom/momdoc/toc.html @@ -2,7 +2,7 @@ <!-- This file is part of groff, the GNU roff type-setting system. -Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc. +Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc. Written by Peter Schaffter (pschaffter@ncf.ca). Permission is granted to copy, distribute and/or modify this document @@ -19,7 +19,7 @@ FDL in the main directory of the groff source package. <head> <meta http-equiv="content-type" content="text/html;charset=utf-8"/> - <title>Mom, version 1.6 -- Table of Contents</title> + <title>Mom, version 1.6-a -- Table of Contents</title> <link rel="stylesheet" type="text/css" href="stylesheet.css" /> </head> @@ -30,7 +30,7 @@ FDL in the main directory of the groff source package. <div class="page"> <div class="version"> - mom, version 1.6 + mom, version 1.6-a </div> <h1 class="toc" style="margin-top: 9px;">Table of Contents</h1> @@ -308,17 +308,18 @@ FDL in the main directory of the groff source package. <li><a href="docelement.html#pp-intro">5.4.3 Paragraphs</a></li> <li><a href="docelement.html#head-intro">5.4.4 Main heads</a></li> <li><a href="docelement.html#subhead-intro">5.4.5 Subheads</a></li> - <li><a href="docelement.html#parahead-intro">5.4.6 Paragraph heads</a></li> - <li><a href="docelement.html#linebreak-intro">5.4.7 Linebreaks</a> – author linebreaks (section breaks)</li> - <li><a href="docelement.html#quote-intro">5.4.8 Quotes</a> – line for line poetic quotes or unformatted, verbatim text (e.g. blocks of code)</li> - <li><a href="docelement.html#blockquote-intro">5.4.9 Blockquotes</a> – cited material</li> - <li><a href="docelement.html#code">5.4.10 Code</a> – inserting code snippets</li> - <li><a href="docelement.html#list-intro">5.4.11 Lists</a> – nested lists</li> - <li><a href="docelement.html#number-lines-intro">5.4.12 Line numbering</a></li> - <li><a href="docelement.html#footnote-intro">5.4.13 Footnotes</a></li> - <li><a href="docelement.html#endnote-intro">5.4.14 Endnotes</a></li> - <li><a href="docelement.html#margin-notes-intro">5.4.15 Margin notes</a></li> - <li><a href="docelement.html#finis-intro">5.4.16 Document termination string</a> – FINIS</li> + <li><a href="docelement.html#subsubhead-intro">5.4.6 Subsubheads</a></li> + <li><a href="docelement.html#parahead-intro">5.4.7 Paragraph heads</a></li> + <li><a href="docelement.html#linebreak-intro">5.4.8 Linebreaks</a> – author linebreaks (section breaks)</li> + <li><a href="docelement.html#quote-intro">5.4.9 Quotes</a> – line for line poetic quotes or unformatted, verbatim text (e.g. blocks of code)</li> + <li><a href="docelement.html#blockquote-intro">5.4.10 Blockquotes</a> – cited material</li> + <li><a href="docelement.html#code">5.4.11 Code</a> – inserting code snippets</li> + <li><a href="docelement.html#list-intro">5.4.12 Lists</a> – nested lists</li> + <li><a href="docelement.html#number-lines-intro">5.4.13 Line numbering</a></li> + <li><a href="docelement.html#footnote-intro">5.4.14 Footnotes</a></li> + <li><a href="docelement.html#endnote-intro">5.4.15 Endnotes</a></li> + <li><a href="docelement.html#margin-notes-intro">5.4.16 Margin notes</a></li> + <li><a href="docelement.html#finis-intro">5.4.17 Document termination string</a> – FINIS</li> </ul></li> <li><a id="images" class="highlight" href="images.html#top">5.5 INSERTING IMAGES</a></li> <li><a id="hdrftr" class="highlight" href="headfootpage.html#top">5.6 PAGE HEADERS AND FOOTERS</a> @@ -357,7 +358,7 @@ FDL in the main directory of the groff source package. <ul> <li><a href="tables-of-contents.html#toc-behaviour">5.10.1 Table of contents behaviour</a></li> <li><a href="tables-of-contents.html#psselect">5.10.2 Using psselect to put tables of contents where you want them</a></li> - <li><a href="tables-of-contents.html#toc-control">5.10.3 Table of contents control macros</a></li> + <li><a href="tables-of-contents.html#index-toc-control">5.10.3 Table of contents control macros</a></li> </ul></li> <li><a id="ref" class="highlight" href="refer.html#top">5.11 BIBLIOGRAPHIES AND REFERENCES</a></li> <li><a id="letter" class="highlight" href="letters.html#top">5.12 WRITING LETTERS</a> diff --git a/contrib/mom/momdoc/typesetting.html b/contrib/mom/momdoc/typesetting.html index 272250ac..dad7d7ad 100644 --- a/contrib/mom/momdoc/typesetting.html +++ b/contrib/mom/momdoc/typesetting.html @@ -2,7 +2,7 @@ <!-- This file is part of groff, the GNU roff type-setting system. -Copyright (C) 2004, 2005, 2006, 2009, 2010 Free Software Foundation, Inc. +Copyright (C) 2004, 2005, 2006, 2009, 2010, 2011 Free Software Foundation, Inc. Written by Peter Schaffter. Permission is granted to copy, distribute and/or modify this document diff --git a/contrib/mom/momdoc/using.html b/contrib/mom/momdoc/using.html index 2d215df6..1c3170ac 100644 --- a/contrib/mom/momdoc/using.html +++ b/contrib/mom/momdoc/using.html @@ -2,7 +2,7 @@ <!-- This file is part of groff, the GNU roff type-setting system. -Copyright (C) 2004, 2005, 2006, 2009, 2010 Free Software Foundation, Inc. +Copyright (C) 2004, 2005, 2006, 2009, 2010, 2011 Free Software Foundation, Inc. Written by Peter Schaffter. Permission is granted to copy, distribute and/or modify this document |