[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 01/01: Doc updates and fixes.
|
From: |
Peter Schaffter |
|
Subject: |
[groff] 01/01: Doc updates and fixes. |
|
Date: |
Sat, 21 Feb 2015 20:04:44 +0000 |
PTPi pushed a commit to branch master
in repository groff.
commit 2944eb896deb261d8750ccf594ce8ea756767eb0
Author: Peter Schaffter <address@hidden>
Date: Sat Feb 21 15:04:38 2015 -0500
Doc updates and fixes.
---
contrib/mom/momdoc/docelement.html | 43 +++++++----
contrib/mom/momdoc/headfootpage.html | 131 ++++++++++++++++++++++++++--------
contrib/mom/momdoc/macrolist.html | 8 +-
3 files changed, 131 insertions(+), 51 deletions(-)
diff --git a/contrib/mom/momdoc/docelement.html
b/contrib/mom/momdoc/docelement.html
index 3f20962..50017d6 100644
--- a/contrib/mom/momdoc/docelement.html
+++ b/contrib/mom/momdoc/docelement.html
@@ -404,8 +404,8 @@ as is the argument to _RULE_WEIGHT macros.
<p>
As of version 2.1, it is possible to group control macros for a
-particular tag into a single <kbd>_STYLE</kbd> macro. For example,
-rather than setting the family, size, and indent of
+particular tag into a single <kbd><element>_STYLE</kbd> macro.
+For example, rather than setting the family, size, and indent of
<a href="#blockquote-intro">BLOCKQUOTES</a>
with
<br/>
@@ -422,27 +422,41 @@ you can enter the same style parameter changes with
SIZE -2 \
INDENT 4P
</span>
-<kbd>_STYLE</kbd> macros use “keyword/value” pairs
-(<kbd>FAMILY</kbd> is a keyword, <kbd>H</kbd> is a value), and may
-be entered entirely on one line, or, as the example shows, broken
-into several readable lines using the backslash. The macro itself
-and all but the last keyword/value pair require the backslash if
-using this style.
+<kbd><element>_STYLE</kbd> macros use
+“keyword/value” pairs (<kbd>FAMILY</kbd> is a keyword,
+<kbd>H</kbd> is a value), and may be entered entirely on one line,
+or, as the example shows, broken into several readable lines using
+the backslash. The macro itself and all but the last keyword/value
+pair require the backslash when this style is used.
</p>
<p>
Not all the control macros for a particular tag may be available
-with a <kbd>_STYLE</kbd> macro. Generally speaking, though, if a
-tag has control macros for
+with an <kbd><element>_STYLE</kbd> macro. Generally speaking,
+though, if a tag has control macros for
<br/>
<span class="pre-in-pp">
- FAMILY FONT SIZE LEAD AUTOLEAD
+ FAMILY FONT SIZE
+ LEAD AUTOLEAD
QUAD INDENT
- COLOR CAPS SMALLCAPS UNDERLINE/UNDERSCORE
+ COLOR
+ CAPS SMALLCAPS
+ UNDERLINE/UNDERSCORE
</span>
-those parameters may be used within a <kbd>_STYLE</kbd> macro.
+those parameters may be used within an
+<kbd><element>_STYLE</kbd> macro.
</p>
+<div class="box-tip">
+<p class="tip">
+<span class="note">Note:</span>
+If you need to reverse the sense of <kbd>CAPS</kbd>,
+<kbd>SMALLCAPS</kbd> or <kbd>UNDERSCORE/UNDERLINE</kbd>, which
+do not take a value after the keyword, use <kbd>NO_CAPS</kbd>,
+<kbd>NO_SMALLCAPS</kbd> and <kbd>NO_UNDERSCORE/NO_UNDERLINE</kbd>.
+</p>
+</div>
+
<div class="rule-short"><hr/></div>
<!-- ==================================================================== -->
@@ -3001,9 +3015,6 @@ is created like this:
Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
sed diam nonumy eirmod tempor invidunt ut labore.
</span>
-</p>
-
-<p>
Alternatively, you may use the single-purpose macro,
<kbd>.QUIT_LISTS</kbd>, to get yourself out of a list structure. In
the example above, the two <kbd>.LIST OFF</kbd> lines could be
diff --git a/contrib/mom/momdoc/headfootpage.html
b/contrib/mom/momdoc/headfootpage.html
index c310e29..c678696 100644
--- a/contrib/mom/momdoc/headfootpage.html
+++ b/contrib/mom/momdoc/headfootpage.html
@@ -204,7 +204,7 @@ type selected with
You can, however, supply whatever strings you like—including
page numbers—to go in any part of headers. What’s more,
you can set the family, font, size, colour and capitalization style
-(caps or caps/lower-case) for each header part individually.
+(caps, caps/lower-case, or smallcaps) for each header part individually.
</p>
<p>
@@ -242,7 +242,7 @@ All caps no no yes
Size* -.5 (points) -.5 (points) -2 (points)
(-2 if all caps) (-2 if all caps) (-.5 if not all caps)
-*Relative to the point size of type in paragraphs
+*Relative to the point size of <a href="definitions.html#running">running
text</a>
</span>
</div>
@@ -251,10 +251,10 @@ You can, of course, change any of the defaults using the
appropriate
control macros. And should you wish to design headers from the
ground up, mom has a special macro,
<a href="#hdrftr-plain">HEADER_PLAIN</a>,
-that removes all type adjustments to headers. The straightforward
-type specs for paragraphs are used instead, providing a simple
+that removes all type adjustments to headers. The
+type specs for running text are used instead, providing a simple
reference point for any alterations you want to make to the family,
-font, size and capitalization style of any header part.
+font, size, and capitalization style of any header part.
</p>
<h3 id="vertical-spacing" class="docs">Vertical placement and spacing of
headers/footers</h3>
@@ -547,9 +547,9 @@ to headers/footers) can be designed to your own
specifications.
<ul style="margin-left: -.5em;">
<li><a href="#hdrftr-style-global">Global changes</a>
<ul style="margin-left: -.5em;">
+ <li><a href="#hdrftr-plain">HEADER_PLAIN</a> – disable default
adjustments to header parts</li>
<li><a href="#hdrftr-global-family">HEADER_FAMILY</a> – family for
entire header</li>
<li><a href="#hdrftr-global-size">HEADER_SIZE</a> – size for
entire header</li>
- <li><a href="#hdrftr-plain">HEADER_PLAIN</a> – disable default
adjustments to header parts</li>
<li><a href="#hdrftr-color">HEADER_COLOR</a> – colourize the
header</li>
</ul></li>
<li><a href="#hdrftr-style-part">Part-by-part changes</a>
@@ -558,6 +558,7 @@ to headers/footers) can be designed to your own
specifications.
<li><a href="#_font">_FONT</a> – left, centre or right font</li>
<li><a href="#_size">_SIZE</a> – left, centre or right size</li>
<li><a href="#_caps">_CAPS</a> – left, centre or right all
caps</li>
+ <li><a href="#_smallcaps">_SMALLCAPS</a> – left, centre or right
smallcaps</li>
<li><a href="#_color">_COLOR</a> – left, centre or right
colour</li>
</ul></li>
</ul></li>
@@ -837,13 +838,34 @@ of the header at once.
<div class="macro-list-container">
<ul style="padding-top: 6px; padding-bottom: 6px; margin-left: -.5em;">
+ <li><a href="#hdrftr-plain">HEADER_PLAIN</a></li>
<li><a href="#hdrftr-global-family">HEADER_FAMILY</a></li>
<li><a href="#hdrftr-global-size">HEADER_SIZE</a></li>
- <li><a href="#hdrftr-plain">HEADER_PLAIN</a></li>
<li><a href="#hdrftr-color">HEADER_COLOR</a></li>
</ul>
</div>
+<div id="hdrftr-plain" class="box-macro-args">
+Macro: <b>HEADER_PLAIN</b>
+</div>
+
+<p>
+By default, mom makes adjustments to the font, size, and
+capitalization style of each part of headers to achieve an
+aesthetically pleasing look. Should you wish to design your own
+headers from the ground up without worrying how changes to the
+various elements of header style interact with mom’s defaults,
+invoke <kbd>.HEADER_PLAIN</kbd> by itself, with no argument. Mom
+will disable her default behaviour for headers, and reset all
+elements of header style to the same family, font, point size and
+colour as she uses in paragraphs.
+</p>
+
+<p>
+Replace HEADER_, above, with FOOTER_ to disable mom’s default
+behaviour for the various elements of footer style.
+</p>
+
<div id="hdrftr-global-family" class="box-macro-args">
Macro: <b>HEADER_FAMILY</b> <kbd class="macro-args"><family></kbd>
</div>
@@ -937,27 +959,6 @@ to change the colour of the header rule.
Replace HEADER_, above, with FOOTER_ to colourize footers.
</p>
-<div id="hdrftr-plain" class="box-macro-args">
-Macro: <b>HEADER_PLAIN</b>
-</div>
-
-<p>
-By default, mom makes adjustments to the font, size, and
-capitalization style of each part of headers to achieve an
-aesthetically pleasing look. Should you wish to design your own
-headers from the ground up without worrying how changes to the
-various elements of header style interact with mom’s defaults,
-invoke <kbd>.HEADER_PLAIN</kbd> by itself, with no argument. Mom
-will disable her default behaviour for headers, and reset all
-elements of header style to the same family, font, point size and
-colour as she uses in paragraphs.
-</p>
-
-<p>
-Replace HEADER_, above, with FOOTER_ to disable mom’s default
-behaviour for the various elements of footer style.
-</p>
-
<h4 id="hdrftr-style-part" class="docs">3. Part by part changes</h4>
<p>
@@ -972,7 +973,9 @@ appropriate.
<li><a href="#_font">HEADER_<POSITION>_FONT</a></li>
<li><a href="#_size">HEADER_<POSITION>_SIZE</a></li>
<li><a href="#_caps">HEADER_<POSITION>_CAPS</a></li>
+ <li><a href="#_smallcaps">HEADER_<POSITION>_SMALLCAPS</a></li>
<li><a href="#_color">HEADER_<POSITION>_COLOR</a></li>
+ <li><a href="#grouping">Grouping style parameters for the individual
header/footer parts</a></li>
</ul>
</div>
@@ -1046,6 +1049,24 @@ Replace HEADER_, above, with FOOTER_ to change a footer
part’s
capitalization style.
</p>
+<div id="_smallcaps" class="box-macro-args">
+Macro: <b>HEADER_<POSITION>_SMALLCAPS</b> <kbd
class="macro-args">toggle</kbd>
+</div>
+
+<p>
+HEADER_<POSITION>_SMALLCAPS is a
+<a href="definitions.html#toggle">toggle macro</a>.
+If you want any part of headers to be set in smallcaps, simply
+invoke this macro (using the appropriate position) with no argument.
+If you wish to turn the smallcaps off, invoke the macro with any
+argument (eg <kbd>OFF, QUIT, END, X</kbd>...).
+</p>
+
+<p>
+Replace HEADER,_ above, with FOOTER_ to invoke smallcaps for footer
+parts.
+</p>
+
<div id="_color" class="box-macro-args">
Macro: <b>HEADER_<POSITION>_COLOR</b> <kbd
class="macro-args"><colorname></kbd>
</div>
@@ -1092,6 +1113,45 @@ Replace HEADER_, above, with FOOTER_ to set the colours
for the
various elements of footers.
</p>
+<h5 id="grouping" class="docs">Grouping style parameters for the individual
header parts</h5>
+
+<p>
+Instead of using control macros for the style parameters
+of an individual header part, the parameters may be
+<a href="docelement.html#grouping">grouped</a>
+by invoking <kbd>HEADER_<POSITION>_STYLE</kbd> with a list of
+keyword/value pairs. Acceptable keywords are
+<kbd>FAMILY FONT SIZE COLOR CAPS</kbd> and <kbd>SMALLCAPS</kbd>.
+Keyword/value pairs may appear on the same line as the macro, or
+separated into several lines using the backslash character
+(<kbd>\</kbd>). If you use the latter style, all but the final
+parameter must be terminated with the backslash.
+</p>
+
+<p>
+Thus, to set the header-left part in Helvetica bold, red, 1 point larger
+than
+<a href="definitions.html#running">running text</a>
+and all caps, you could do either
+<br/>
+<span class="pre-in-pp">
+ .HEADER_LEFT_STYLE FAMILY H FONT B SIZE +1 COLOR red CAPS
+</span>
+or
+<br/>
+<span class="pre-in-pp">
+ .HEADER_LEFT_STYLE \
+ FAMILY H \
+ FONT B \
+ SIZE +1 \
+ COLOR red \
+ CAPS
+</span>
+If you need to reverse the sense of <kbd>CAPS</kbd>
+or <kbd>SMALLCAPS</kbd>, use <kbd>NO_CAPS</kbd> or
+<kbd>NO_SMALLCAPS</kbd>.
+</p>
+
<!-- -HDRFTR_VERTICAL- -->
<h4 id="hdrftr-vertical" class="docs">3. Header/footer vertical placement and
spacing</h4>
@@ -2071,16 +2131,25 @@ draft-style copy.
<p class="defaults" style="padding-top: 6px;">
See
<a href="docelement.html#control-macro-args">Arguments to the control
macros</a>.
+<br/>
+The following control macros may also be
+<a href="docelement.html#grouping">grouped</a>
+using PAGENUMBER_STYLE.*
</p>
<span class="pre defaults">
-.PAGENUM_FAMILY default = prevailing document family; default is Times Roman
+.PAGENUM_FAMILY default = prevailing document family
.PAGENUM_FONT default = roman
-.PAGENUM_SIZE default = 0 (ie same size as paragraph text)
+.PAGENUM_SIZE default = +0 (ie same size as paragraph text)
.PAGENUM_COLOR default = black
</span>
</div>
-<h4 id="pagenum-pos" class="docs" style="margin-top: -1em;">2. Page number
position</h4>
+<p style="margin-top: -2em">
+*Note: Do not confuse PAGENUMBER_STYLE with
+<a href="#pagenum-style">PAGENUM_STYLE</a>.
+</p>
+
+<h4 id="pagenum-pos" class="docs" style="margin-top: 0em;">2. Page number
position</h4>
<div class="box-macro-args" style="margin-top: 1em;">
Macro: <b>PAGENUM_POS</b> <kbd class="macro-args">TOP | BOTTOM LEFT
| CENTER | RIGHT</kbd>
diff --git a/contrib/mom/momdoc/macrolist.html
b/contrib/mom/momdoc/macrolist.html
index c9648a9..198d35a 100644
--- a/contrib/mom/momdoc/macrolist.html
+++ b/contrib/mom/momdoc/macrolist.html
@@ -183,7 +183,7 @@ elsewhere in the documentation.
<td><a href="typesetting.html#slant-inline">\*[SLANT]</a></td><td>-- invoke
pseudo italic inline</td>
</tr>
<tr>
-<td><a href="typesetting.html#slant-inline">\*[SLANTX]</a></td><td>-- off
pseudo italic inline</td>
+<td><a href="typesetting.html#slant-inline">\*[SLANTX]</a></td><td>-- turn off
pseudo italic inline</td>
</tr>
<tr><td style="padding-left: 0;">Pseudo bold</td></tr>
<tr>
@@ -193,7 +193,7 @@ elsewhere in the documentation.
<td><a href="typesetting.html#bolder-inline">\*[BOLDER]</a></td><td>-- invoke
pseudo bold inline</td>
</tr>
<tr>
-<td><a href="typesetting.html#bolder-inline">\*[BOLDERX]</a></td><td>-- off
pseudo bold inline</td>
+<td><a href="typesetting.html#bolder-inline">\*[BOLDERX]</a></td><td>-- turn
off pseudo bold inline</td>
</tr>
<tr><td style="padding-left: 0;">Pseudo condensed</td></tr>
<tr>
@@ -203,7 +203,7 @@ elsewhere in the documentation.
<td><a href="typesetting.html#cond-inline">\*[COND]</a></td><td>-- invoke
pseudo condensing inline</td>
</tr>
<tr>
-<td><a href="typesetting.html#cond-inline">\*[CONDX]</a></td><td>-- off pseudo
condensing inlines</td>
+<td><a href="typesetting.html#cond-inline">\*[CONDX]</a></td><td>-- turn off
pseudo condensing inline</td>
</tr>
<tr><td style="padding-left: 0;">Pseudo extended</td></tr>
<tr>
@@ -213,7 +213,7 @@ elsewhere in the documentation.
<td><a href="typesetting.html#ext-inline">\*[EXT]</a></td><td>-- invoke pseudo
extending inline</td>
</tr>
<tr>
-<td><a href="typesetting.html#ext-inline">\*[EXTX]</a></td><td>-- off pseudo
condensing inlinee</td>
+<td><a href="typesetting.html#ext-inline">\*[EXTX]</a></td><td>-- turn off
pseudo condensing inline</td>
</tr>
</table>
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 01/01: Doc updates and fixes.,
Peter Schaffter <=