[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 03/03: Version 2.3 documentation.
|
From: |
Peter Schaffter |
|
Subject: |
[groff] 03/03: Version 2.3 documentation. |
|
Date: |
Sun, 4 Mar 2018 15:08:56 -0500 (EST) |
PTPi pushed a commit to branch master
in repository groff.
commit f28d6dba4d6d7888bda6d3c3a5d070f421cbc0db
Author: Peter Schaffter <address@hidden>
Date: Sun Mar 4 15:07:04 2018 -0500
Version 2.3 documentation.
---
contrib/mom/momdoc/appendices.html | 2 +-
contrib/mom/momdoc/color.html | 2 +-
contrib/mom/momdoc/cover.html | 4 +-
contrib/mom/momdoc/definitions.html | 2 +-
contrib/mom/momdoc/docelement.html | 52 +++--
contrib/mom/momdoc/docprocessing.html | 309 +++++++++++++++++++++++++++--
contrib/mom/momdoc/goodies.html | 106 +++++++++-
contrib/mom/momdoc/graphical.html | 2 +-
contrib/mom/momdoc/headfootpage.html | 2 +-
contrib/mom/momdoc/images.html | 2 +-
contrib/mom/momdoc/inlines.html | 2 +-
contrib/mom/momdoc/intro.html | 2 +-
contrib/mom/momdoc/letters.html | 2 +-
contrib/mom/momdoc/macrolist.html | 21 +-
contrib/mom/momdoc/rectoverso.html | 2 +-
contrib/mom/momdoc/refer.html | 2 +-
contrib/mom/momdoc/reserved.html | 2 +-
contrib/mom/momdoc/stylesheet.css | 8 +-
contrib/mom/momdoc/tables-of-contents.html | 2 +-
contrib/mom/momdoc/toc.html | 11 +-
contrib/mom/momdoc/typesetting.html | 16 +-
contrib/mom/momdoc/using.html | 2 +-
contrib/mom/momdoc/version-2.html | 2 +-
23 files changed, 495 insertions(+), 62 deletions(-)
diff --git a/contrib/mom/momdoc/appendices.html
b/contrib/mom/momdoc/appendices.html
index 3d197ce..27c6800 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-2017 Free Software Foundation, Inc.
+Copyright (C) 2004-2018 Free Software Foundation, Inc.
Written by Peter Schaffter (address@hidden).
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 39e0bfe..aaa0b39 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-2017 Free Software Foundation, Inc.
+Copyright (C) 2004-2018 Free Software Foundation, Inc.
Written by Peter Schaffter (address@hidden).
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 fdfa092..93c5652 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-2017 Free Software Foundation, Inc.
+Copyright (C) 2004-2018 Free Software Foundation, Inc.
Written by Peter Schaffter (address@hidden).
Permission is granted to copy, distribute and/or modify this document
@@ -783,7 +783,7 @@ starting position of a doc-cover, you’d do
<span class="pre-in-pp">
.DOC_COVER_FAMILY H
.DOC_COVER_COLOR blue
- .DOC_COVER_LEADING +2
+ .DOC_COVER_LEAD +2
.DOC_COVER_QUAD L
.DOC_COVER_ADVANCE 3i \" or .DOC_COVER_START_POS 3i
</span>
diff --git a/contrib/mom/momdoc/definitions.html
b/contrib/mom/momdoc/definitions.html
index 064fa03..a96991d 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-2017 Free Software Foundation, Inc.
+Copyright (C) 2004-2018 Free Software Foundation, Inc.
Written by Peter Schaffter (address@hidden).
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 0c03c2b..8dd954f 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-2017 Free Software Foundation, Inc.
+Copyright (C) 2004-2018 Free Software Foundation, Inc.
Written by Peter Schaffter (address@hidden).
Permission is granted to copy, distribute and/or modify this document
@@ -556,7 +556,7 @@ do so before invoking <kbd>.EPIGRAPH</kbd>, like this:
If you’re setting a document in
<a href="docprocessing.html#columns">columns</a>
and you’d like to add or subtract space <i>after</i> the
-epigraph, which is centered over the top of both columns, the place
+epigraph, which is centred over the top of both columns, the place
to do it is inside the epigraph, like this:
<br/>
<span class="pre-in-pp">
@@ -1436,7 +1436,7 @@ Here's an example of how you might style a level 1
heading:
BASELINE_ADJUST 3p \
NUMBER
</span>
-This creates a level-1 heading style that's bold, centered,
+This creates a level-1 heading style that's bold, centred,
underscored and numbered, raised by 3 points from the baseline.
</p>
</div>
@@ -1581,7 +1581,7 @@ the changes with the
<a href="#heading-style">HEADING_STYLE</a>
macro. The entire style need not be recreated, only those
parameters that differed from mom's defaults. Thus, if your HEADs
-were set flush left, instead of the oldstyle default, centered, but
+were set flush left, instead of the oldstyle default, centred, but
otherwise kept mom's settings, you need only do
<br/>
<span class="pre-in-pp">
@@ -2767,21 +2767,32 @@ and returns you to the left margin of running text.
If
<kbd><a href="typesetting.html#quad">QUAD CENTER</a></kbd>
is in effect when LIST is invoked, the list is set quad left but
-centered on the page as a block, based on the longest line of list
+centred on the page as a block, based on the longest line of list
text. Equally, if <kbd>QUAD RIGHT</kbd> in in effect, the list is
-set flush left but quadded right as a block. If you want a centered
+set flush left but quadded right as a block. If you want a centred
or right-quadded list in an otherwise left-quadded or justified
document, simply invoke <kbd>.QUAD <direction></kbd>
-before the list and reset it afterwards. Do not use
+before the list and reset the quad afterwards. Do not use
<kbd><a href="typesetting.html#lrc">CENTER</a></kbd>
or
-<kbd><a href="typesetting.html#lrc">RIGHT</a></kbd>
+<kbd><a href="typesetting.html#lrc">RIGHT</a></kbd>.
</p>
+<div class="box-tip">
+<p class="tip">
+<span class="note">Note:</span>
+Mom centres lists over the entire line length, disregarding
+<a href="typesetting.html#ib">IB</a>
+if it is in effect. If there are lines in the list that exceed
+the the margins of IB, they must be broken manually with
+<kbd>.BR</kbd> if you wish to keep them within the indented margins.
+</p>
+</div>
+
<p>
Finally, lists can be used in documents created with either the
<a href="docprocessing.html#top">document processing macros</a>
-or the
+or just the
<a href="typesetting.html#top">typesetting macros</a>.
</p>
@@ -3098,17 +3109,30 @@ replaced with a single <kbd>.QUIT_LISTS</kbd>.
</div>
<div class="box-macro-args">
-Macro: <b>ITEM</b> <kbd class="macro-args">[<enumerator>]</kbd>
+Macro: <b>ITEM</b> <kbd class="macro-args">[<enumerator>]
[<space>]</kbd>
</div>
+<p class="requires">
+• The argument to <kbd style="font-style:
normal"><space></kbd> requires a
+<a href="definitions.html#unitofmeasure">unit of measure</a>
+</p>
<p>
After you’ve initialized a list with
<a href="#list">LIST</a>,
precede each item you want in the list with <kbd>.ITEM</kbd>. Mom
takes care of everything else with respect to setting the item
-appropriate to the list you’re in. If you’ve chosen the
-<kbd>VARIABLE</kbd> argument when invoking LIST, ITEM must be
-followed by an enumerator character.
+appropriate to the list you’re in.
+</p>
+
+<p>
+If you’ve chosen the <kbd>VARIABLE</kbd> argument when
+invoking LIST, ITEM must be followed by an enumerator character.
+</p>
+
+<p>
+If you give ITEM a space argument, either by itself or after a
+variable enumerator character, the item will be spaced by the amount
+of the argument.
</p>
<p>
@@ -6091,7 +6115,7 @@ it’s impossible for mom to guess whether to align
the first lines of margin notes with a document
<a href="definitions.html#baseline">baseline</a>,
whether to align the last lines of margin notes with a document
-baseline, or whether to center them, vertically, so that neither
+baseline, or whether to centre them, vertically, so that neither
first nor last line aligns with anything!
</p>
diff --git a/contrib/mom/momdoc/docprocessing.html
b/contrib/mom/momdoc/docprocessing.html
index d4e8cf3..fef8983 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-2017 Free Software Foundation, Inc.
+Copyright (C) 2004-2018 Free Software Foundation, Inc.
Written by Peter Schaffter (address@hidden).
Permission is granted to copy, distribute and/or modify this document
@@ -68,7 +68,13 @@ FDL in the main directory of the groff source package.
</ul></li>
<li><a href="#docstyle-macros"><b>The docstyle macros (templates)</b></a>
<ul class="toc-docproc">
- <li><a href="#doctype">DOCTYPE</a></li>
+ <li><a href="#doctype">DOCTYPE (default, chapter, letter, named,
slides)</a></li>
+ <li><a href="#slides">DOCTYPE SLIDES</a></li>
+ <ul class="toc-docproc">
+ <li><a href="#newslide">NEWSLIDE</a></li>
+ <li><a href="#pause">PAUSE</a></li>
+ <li><a href="#transition">TRANSITION</a></li>
+ </ul>
<li><a href="#printstyle">PRINTSTYLE</a></li>
<li><a href="#copystyle">COPYSTYLE</a></li>
</ul></li>
@@ -1717,7 +1723,7 @@ and revision information in the headers) or a final copy.
</div>
<div class="box-macro-args">
-Macro: <b>DOCTYPE</b> <kbd class="macro-args">DEFAULT | CHAPTER | NAMED
"<name>" | LETTER</kbd>
+Macro: <b>DOCTYPE</b> <kbd class="macro-args">DEFAULT | CHAPTER | NAMED
"<name>" | LETTER | SLIDES</kbd>
</div>
<p>
@@ -1726,7 +1732,8 @@ The arguments <kbd>DEFAULT,</kbd> <kbd>CHAPTER</kbd> and
<a href="definitions.html#docheader">docheader</a>
and
<a href="definitions.html#header">page headers</a>.
-<kbd>LETTER</kbd> tells her that you want to write a letter.
+<kbd>LETTER</kbd> and <kbd>SLIDES</kbd> tells her you want to write
+a letter or create slides.
</p>
<p>
@@ -1734,7 +1741,7 @@ Mom’s default DOCTYPE is <kbd>DEFAULT</kbd>. If
that’s
what you want, you don’t have to give a DOCTYPE command.
</p>
-<p>
+<p id="default-doctype">
<kbd>DEFAULT</kbd> prints a
<a href="definitions.html#docheader">docheader</a>
containing the title, subtitle and author information given to the
@@ -1809,6 +1816,268 @@ section
for instructions on using mom to format letters.
</p>
+<h4 id="slides" class="docs" style="font-size: 100%; text-transform:
uppercase">Slides</h4>
+
+<p>
+PDF slides are a special kind of mom document, formatted for viewing
+in a PDF reader’s presentation mode. In most respects, they
+behave identically to the other document types. Key differences
+are:
+</p>
+<ul style="margin-top: -.5em">
+<li>headers, footers, and pagination are disabled by default</li>
+<li>type is set
+<a href="typesetting.html#quad">QUAD CENTER</a>
+by default</li>
+<li>
+<a href="#flex">flex-spacing</a>
+and
+<a href="#shim">shimming</a>
+are disabled by default; shimming may
+be re-enabled (with <kbd>NO_SHIM OFF</kbd>), but not flex-spacing</li>
+<li>there’s no need for
+<a href="#printstyle">PRINTSTYLE</a></li>
+</ul>
+
+<p>
+DOCTYPE SLIDES takes up to five optional arguments, which come
+immediately after SLIDES. They may be entered in any order.
+<br/>
+<span class="pre-in-pp">
+ DOCTYPE SLIDES \
+ ASPECT 4:3 | 16:9 \
+ HEADER "left" "centre" "right" \
+ FOOTER "left" "centre" "right" \
+ TRANSITION "<slide transition effect>" (mode + parameters) \
+ PAUSE "<text reveal effect>" (mode + parameters)
+</span>
+For convenience, you many want to enter each argument on a single
+line as shown above; all but the last must be terminated by a
+backslash.
+</p>
+
+<h5 class="docs" style="margin-top: .5em">Aspect</h5>
+
+<p>
+Slides can be formatted for one of two aspect ratios common to
+monitors and screens: 4:3 and 16:9. The default is 16:9.
+<span class="pre-in-pp">
+ 4:3 16:9
+ media size: 11" x 8.25" media size: 11" x 8.1875"
+ left/right margins: 36 points left/right margins: 36 points
+ top margin: 90 points top margin: 80 points
+ bottom margin: 84 points bottom margin: 72 points
+ base text size: 16 points base text size: 14 points
+ autoleading: 6 points, adjusted autoleading: 4 points, adjusted
+ (header/footer size: -3 points) (header/footer size: -2 points)
+</span>
+Note that both media sizes fit on either A4 or US LETTER papersizes.
+</p>
+
+<h5 class="docs" style="margin-top: .5em">Headers, footers, and pagination</h5>
+
+<p>
+If you want a header, footer, or both for your slides, pass SLIDES
+the <kbd>HEADER</kbd> and/or <kbd>FOOTER</kbd> argument(s). Both
+take three additional
+<a href="definitions.html#stringargument">string arguments</a>,
+which must be enclosed in double-quotes, defining the left, centre,
+and right parts of the header/footer. Any parts you want left blank
+should be entered as two double-quotes. For example,
+<span class="pre-in-pp">
+ HEADER "" "My slide presentation" ""
+</span>
+will result in a header with only the centre part.
+</p>
+
+<p>
+Normal pagination is disabled for slides. If you want your slides
+numbered, the slide number must be given to one of the header/footer
+parts with the
+<a href="definitions.html#inlines">inline escape</a>
+<br/>
+<kbd>\*[SLIDE#]</kbd>. For example:
+<span class="pre-in-pp">
+ HEADER "" "My slide presentation" "" \
+ FOOTER "" "" "\*[SLIDE#]"
+</span>
+will give you a centred header with numbering at the bottom right of
+the slide.
+</p>
+
+<p>
+The overall family, size, and colour of headers may be set with
+HEADER_FAMILY, HEADER_SIZE, and HEADER_COLOR. If you request
+FOOTERS, you may use the FOOTER_ equivalent of these macros.
+If you request both headers and footers, use one or the other but
+not both. For example, in a header/footer situation, HEADER_FAMILY
+would determine the family for both headers and footers, but if you
+attempted to do this
+<span class="pre-in-pp">
+ .HEADER_FAMILY T
+ .FOOTER_FAMILY H
+</span>
+FOOTER_FAMILY would take precedence, and your header family would be
+“<kbd>H</kbd>”.
+</p>
+
+<p>
+All other formatting of individual header/footer parts must be
+entered as inline escapes inside the double-quotes. If you want,
+say, your headers to be red but your footer page numbering to be
+black and two points larger, this is how you’d do it:
+<span class="pre-in-pp">
+ .HEADER_COLOR red
+ .DOCTYPE SLIDES \
+ HEADER "" "My slide presentation" "" \
+ FOOTER "" "" "\*[black]\*S[+2]\*[SLIDE#]\*S[-2]"
+</span>
+</p>
+
+<div class="box-tip">
+<p class="tip">
+<span class="note">Note:</span>
+Do not use mom’s
+<a href="inlines.html#inline-size-mom"><kbd>\*[SIZE ±n]</kbd></a>
+inline escape to change point size in the strings passed to HEADER
+or FOOTER. Prefer either mom’s <kbd>\*S[±n]</kbd> or
+groff's <kbd>\s[±n]</kbd>.
+</span>
+</p>
+</div>
+
+<h5 class="docs" style="margin-top: .5em">Transition</h5>
+
+<p>
+“Transition” refers to how new slides appear during a
+presentation. The official PDF specification lists a number of modes,
+each with a choice of configurable parameters. Modes include Box,
+Blinds, Wipe, Fade, and several others. Parameters include things
+like duration, dimension, and direction. There are a total of
+twelve modes; for each one there are from one to six configurable
+parameters. Consult <kbd>man gropdf(1)</kbd> for a complete listing
+of modes and parameters.
+</p>
+
+<p>
+If you pass SLIDES the <kbd>TRANSTION</kbd> argument, you must
+at a minimum follow it with a mode. Afterwards, you may give as
+many or as few parameters as you wish. Parameters are, in order,
+<span class="pre-in-pp">
+ 1. duration
+ 2. dimension
+ 3. motion
+ 4. direction
+ 5. scale
+ 6. bool
+</span>
+You don't have to fill them all out. If you only need the first
+three, that's all you need to input. If you need the first and
+third, enter the second as a period (dot), which is used any time
+you want to leave a parameter at its current default or when it
+isn’t applicable. For example, if you want a Box transition
+that lasts 1 second, filling the screen from the centre outwards,
+you'd enter
+<span class="pre-in-pp">
+ TRANSITION "Box 1 . O"
+</span>
+because Box does not take a “dimension” parameter but it
+does take a motion parameter.
+</p>
+
+<p>
+Notice that the entire string (mode+parameters) must be enclosed in
+double-quotes.
+</p>
+
+<div class="box-tip">
+<p class="tip">
+<span class="note">Note:</span>
+Not all PDF viewers support all modes. Any that are not supported
+are replaced by the “R” mode, which simply replaces one
+slide with the next unless the PDF viewer has a different default
+transition mode.
+</span>
+</p>
+</div>
+
+<h5 class="docs" style="margin-top: .5em">Pause</h5>
+
+<p>
+A “pause” occurs when material on a slide is halted (see
+<a href="#pause">PAUSE</a>),
+awaiting a mouse click, PgDown, Next, or the spacebar to reveal
+subsequent material. All the same modes and parameters as
+<kbd>TRANSITION</kbd> may be used. The manner of entering them is
+is identical, including that the entire mode+parameter string must
+be enclosed in double-quotes.
+</p>
+
+<div class="macro-id-overline">
+<h3 id="slide-macros" class="macro-id">SLIDE MACROS</h3>
+</div>
+
+<div id="newslide" class="box-macro-args">
+Macro: <b>NEWSLIDE</b> <kbd class="macro-args">["<transition mode and
parameters>"]</kbd>
+</div>
+
+<p>
+Unless you want material from one slide to flow onto the next, you
+need to tell mom when to start a new slide with the macro NEWSLIDE.
+Without any arguments, the new slide will appear with the default
+TRANSTION you gave to DOCTYPE SLIDES.
+</p>
+
+<p>
+If you would like a different transition, you may pass NEWSLIDE a
+new mode and associated parameters, following the same rules as the
+TRANSITION argument to DOCTYPE. Note that the new effect becomes
+the default. If you wish to return to the original transition, you
+must give it explicitly to the appropriate NEWSLIDE.
+</p>
+
+<div id="pause" class="box-macro-args">
+Macro: <b>PAUSE</b> <kbd class="macro-args">["<pause mode and
parameters>"]</kbd>
+</div>
+
+<p>
+Pauses in slides are accomplished by entering the macro PAUSE at
+desired locations in your input file. Subsequent material will be
+revealed using the pause mode given to DOCTYPE SLIDES.
+</p>
+
+<p>
+If you would like a different mode, you may pass PAUSE a
+new mode and associated parameters, following the same rules as the
+PAUSE argument to DOCTYPE.
+</p>
+
+<div id="transition" class="box-macro-args">
+Macro: <b>TRANSITION</b> <kbd class="macro-args">["<transition mode and
parameters>"]</kbd>
+</div>
+
+<p>
+If for some reason you have material that flows from one slide to
+the next <i>and</i> you want the next slide to have a transition
+different from the current one, you can tell mom about the new
+transition with the macro TRANSITION anywhere prior to the break to
+the next slide.
+</p>
+
+<h4 id="slide-printing" class="docs" style="font-size: 100%; text-transform:
uppercase">Printing slides</h4>
+
+<p>
+If you want to print slides as handouts, you have to tell
+<kbd>pdfmom</kbd> or <kbd>gropdf</kbd>, otherwise printing will
+stop at the first pause. Simply precede <kbd>pdfmom</kbd> or
+<kbd>gropdf</kbd> with GROPDF_NOSLIDE=1, like this:
+<br/>
+<span class="pre-in-pp">
+ GROPDF_NOSLIDE=1 pdfmom <options> slidefile.mom > slidefile.pdf
+</span>
+
+</p>
+
<!-- -PRINTSTYLE- -->
<div class="macro-id-overline">
@@ -1820,7 +2089,8 @@ Macro: <b>PRINTSTYLE</b> <kbd class="macro-args">TYPESET
| TYPEWRITE [ SINGLESPA
</div>
<p class="requires">
-• Required for document processing
+• Required for document processing, except in the case of
+slides
<br/>
Must come before any changes to default document style
</p>
@@ -2473,7 +2743,7 @@ The macro
<a href="color.html#color">COLOR</a>
and the
<a href="definitions.html#inlines">inline escape</a>,
-<a href="color.html#color-inline"><kbd>\[<colorname>]</kbd></a>
+<a href="color.html#color-inline"><kbd>\*[<colorname>]</kbd></a>
can be used at any time during document processing for occasional
colour effects. However, consistent and reliable colourizing of
various document elements (the docheader, heads, linebreaks,
@@ -2489,7 +2759,7 @@ If you plan to have mom generate a
<a href="docelement.html#toc">table of contents</a>,
do not embed colour
<a href="definitions.html#inlines">inline escapes</a>
-(<a href="color.html#color-inline"><kbd>\[<colorname>]</kbd></a>)
+(<a href="color.html#color-inline"><kbd>\*[<colorname>]</kbd></a>)
in the
<a href="definitions.html#stringargument">string arguments</a>
given to any of the
@@ -2819,9 +3089,9 @@ to place them where you want.
<h5 id="docheader-quad" class="docs">Change the quad direction of the
docheader</h5>
<p>
-By default, mom centers the docheader. If you’d prefer to
+By default, mom centres the docheader. If you’d prefer to
have your docheaders set flush left or right, or need to restore
-the default centering, invoke <kbd>.DOCHEADER_QUAD</kbd> with the
+the default centreing, invoke <kbd>.DOCHEADER_QUAD</kbd> with the
quad direction you want, either <kbd>LEFT</kbd> (or <kbd>L</kbd>),
<kbd>RIGHT</kbd> (or <kbd>R</kbd>) or <kbd>CENTER</kbd> (or
<kbd>C</kbd>).
@@ -3222,7 +3492,7 @@ disabled with
<a href="#no-shim">NO_SHIM</a>.
If your document is being flex-spaced, do not use
<a href="docprocessing.html#flex">FLEX</a>.
-Rather, disable flex-spacing with temporarily with
+Rather, disable flex-spacing temporarily with
<br/>
<span class="pre-in-pp">
.NO_FLEX
@@ -3558,10 +3828,12 @@ Macro: <b>RESTORE_SPACE</b>
</p>
<p>
-ADD_SPACE takes as its single argument the distance
-you want mom to advance from the normal
-baseline position at the top of any page after the first
-(ie the one on which the docheader is normally printed). A
+If your
+<a href="#doctype">DOCTYPE</a>
+is DEFAULT, CHAPTER, NAMED, or LETTER, ADD_SPACE takes as its
+single argument the distance you want mom to advance from the normal
+baseline position at the top of any page <i>after the first</i> (ie
+the one on which the docheader is normally printed). A
<a href="definitions.html#unitofmeasure">unit of measure</a> is
required.
</p>
@@ -3594,6 +3866,13 @@ whatever correction is required by the
strategy in effect.
</p>
+<p>
+If your
+<a href="#doctype">DOCTYPE</a>
+is SLIDES, ADD_SPACE may be used on any slide <i>including the
+first</i> to introduce additional white space at the top.
+</p>
+
<h4 class="docs doc-param-macros" style="margin-top: .5em">RESTORE_SPACE</h4>
<p style="margin-top: .5em">
diff --git a/contrib/mom/momdoc/goodies.html b/contrib/mom/momdoc/goodies.html
index b3d90f2..5322226 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-2017 Free Software Foundation, Inc.
+Copyright (C) 2004-2018 Free Software Foundation, Inc.
Written by Peter Schaffter (address@hidden).
Permission is granted to copy, distribute and/or modify this document
@@ -50,7 +50,10 @@ nearly indispensable) routines to simplify typesetting.
<ul class="no-enumerator">
<li class="list-head-goodies"><a href="#alias">ALIAS</a> <span
class="normal-smaller">– rename macros</span></li>
<li class="list-head-goodies"><a href="#caps">CAPS</a> <span
class="normal-smaller">– convert to upper case</span></li>
+<li class="list-head-goodies"><a href="#center-block">CENTER_BLOCK</a> <span
class="normal-smaller">– centre blocks of type with quad
intact</span></li>
<li class="list-head-goodies"><a href="#esc-char">ESC_CHAR</a> <span
class="normal-smaller">– change the escape character to something other
than a backslash</span></li>
+<li class="list-head-goodies"><a href="#hang">HANG</a> <span
class="normal-smaller">– hang character(s) outside right margin (inline
escape)</span></li>
+<li class="list-head-goodies"><a href="#left-hang">LEFT_HANG</a> <span
class="normal-smaller">– hang character(s) outside left margin</span></li>
<li class="list-head-goodies"><a href="#silent">SILENT</a> <span
class="normal-smaller">– hide input lines from output</span></li>
<li class="list-head-goodies"><a href="#sizespecs">SIZESPECS</a> <span
class="normal-smaller">– get cap-height, x-height and descender depth of
a font</span></li>
<li class="list-head-goodies"><a href="#smartquotes">SMARTQUOTES</a> <span
class="normal-smaller">– convert typewriter doublequotes to proper
doublequotes</span></li>
@@ -125,8 +128,7 @@ Macro: <b>ALIAS</b> <kbd class="macro-args"><new
name> <old name></k
<p>
The ALIAS macro may well be your best friend. With it, you can
change the name of a macro to anything you like (provided the new
-name is not already being used by mom; see the
-<a href="reserved.html#reserved">list of reserved words</a>).
+name is not already being used by mom).
</p>
<p>
@@ -1460,7 +1462,9 @@ If your running type is
or
<a href="typesetting.html#ext-inline">pseudo-extended</a>
and you want your superscripts to be equivalently pseudo-condensed
-or -extended, use <kbd>\*[CONDSUP]...\*[CONDSUPX]</kbd> or
+or -extended, use
+<br/>
+<kbd>\*[CONDSUP]...\*[CONDSUPX]</kbd> or
<kbd>\*[EXTSUP]...\*[EXTSUPX]</kbd>.
</p>
@@ -1500,6 +1504,100 @@ instead of 1/3 em, you’d do
and all subsequent superscripts would be raised by 3 points.
</p>
+<!-- -CENTER BLOCK- -->
+
+<div class="macro-id-overline">
+<h3 id="center-block" class="macro-id">Centre blocks of type</h3>
+</div>
+
+<div class="box-macro-args">
+Macro: <b>CENTER_BLOCK</b> <kbd class="macro-args"><toggle></kbd>
+</div>
+
+<p>
+Blocks of type sometimes need to be centred on the page with their quad
+direction (left, centre, right) left intact. The
+document processing macros
+<a href="docelement.html#quote">QUOTE</a>
+and
+<a href="docelement.html#blockquote">BLOCKQUOTE</a>
+take care of this automatically, but there are other situations
+where you may want to centre blocks of type. An example might be
+left-quadded
+<a href="docelement.html#list-intro">nested lists</a>.
+</p>
+
+<p>
+Whenever you want to centre a block of type on the page, surround it with
+<kbd>.CENTER_BLOCK/.CENTER_BLOCK OFF</kbd> (or QUIT, X, etc.).
+</p>
+
+<div class="macro-id-overline">
+<h3 id="left-hang" class="macro-id">Hanging characters</h3>
+</div>
+<br/>
+<div class="box-macro-args">
+Macro: <b>LEFT_HANG</b> <kbd class="macro-args"><character></kbd>
+</div>
+
+<div class="box-macro-args" style="margin-top: 1em">
+Inline: <b>\*[HANG <kbd class="macro-args"><character></kbd>]</b>
+</div>
+
+
+<p>
+LEFT_HANG hangs its argument to the left of the left margin.
+If enclosed in double-quotes, the argument may contain local
+horizontal motions.
+</p>
+
+<p>
+Input text after LEFT_HANG must begin by repeating the text of the
+argument, including horizontal motions. If the hung character is
+a left double-quote, <kbd>\[lq]</kbd> must be used in the argument
+and the usual keyboard double-quote (<kbd>"</kbd>) used for the
+input text so as not to confuse SMARTQUOTES.
+</p>
+
+<p>
+The following example demonstrates:
+<br>
+<span class="pre-in-pp">
+ .LEFT_HANG "\[lq]\*[FU3]"
+ "\*[FU3]This line will have its opening double-quote
+ plus three kern units of space hung outside the
+ left margin."
+</span>
+</p>
+
+<p style="margin-top: -1em">
+The <kbd>\*[HANG]</kbd> inline escape hangs its single-character
+argument, typically a punctuation mark, outside the right margin of
+justified copy, like this:
+<br>
+<span class="pre-in-pp">
+ This line will have its closing period hung outside
+ the right margin\*[HANG .]
+</span>
+For the exceptionally fussy, <kbd>\*[HANG]</kbd> may also be used
+with centred text to centre the text visually without taking the
+hung punctuation into account.
+</p>
+
+<p>
+If the hung character is a right double-quote, <kbd>"\[rq]"</kbd>
+must be used as the argument (that is, the <kbd>\[rq]</kbd> character
surrounded
+by double-quotes). The double-quotes are required for all special
+characters of the form <kbd>\[xx]</kbd>.
+</p>
+
+<p>
+If the hung character is a hyphen, <kbd>\*[HANG -]</kbd> must
+come at the end of an
+<a href="definitions.html#inputline">input line</a>.
+All other characters may be used mid-line if groff breaks the line
+naturally at the point the hung character is introduced.
+</p>
<div class="rule-long"><hr/></div>
<!-- Navigation links -->
diff --git a/contrib/mom/momdoc/graphical.html
b/contrib/mom/momdoc/graphical.html
index 15eac68..7fa1fbf 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-2017 Free Software Foundation, Inc.
+Copyright (C) 2004-2018 Free Software Foundation, Inc.
Written by Peter Schaffter (address@hidden).
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 fc6e7cf..607e255 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-2017 Free Software Foundation, Inc.
+Copyright (C) 2004-2018 Free Software Foundation, Inc.
Written by Peter Schaffter (address@hidden).
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 affa76d..6df877e 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-2017 Free Software Foundation, Inc.
+Copyright (C) 2004-2018 Free Software Foundation, Inc.
Written by Peter Schaffter (address@hidden).
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 2711f8f..807c412 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-2017 Free Software Foundation, Inc.
+Copyright (C) 2004-2018 Free Software Foundation, Inc.
Written by Peter Schaffter (address@hidden).
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 03e1f0f..d005a3f 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-2017 Free Software Foundation, Inc.
+Copyright (C) 2004-2018 Free Software Foundation, Inc.
Written by Peter Schaffter (address@hidden).
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 b5a112e..be405a5 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-2017 Free Software Foundation, Inc.
+Copyright (C) 2004-2018 Free Software Foundation, Inc.
Written by Peter Schaffter (address@hidden).
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 130ffc3..5823d69 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-2017 Free Software Foundation, Inc.
+Copyright (C) 2004-2018 Free Software Foundation, Inc.
Written by Peter Schaffter (address@hidden).
Permission is granted to copy, distribute and/or modify this document
@@ -28,7 +28,7 @@ FDL in the main directory of the groff source package.
<!-- ==================================================================== -->
-<div id="top" class="page">
+<div id="top" class="page" style="width: 800px">
<!-- Navigation links -->
<table style="width: 100%;">
@@ -560,6 +560,15 @@ elsewhere in the documentation.
<td><a href="typesetting.html#newpage">NEWPAGE</a></td><td>-- break to a new
page</td>
</tr>
<tr>
+<td><a href="docprocessing.html#newslide">NEWSLIDE</a></td><td>-- break to a
new slide</td>
+</tr>
+<tr>
+<td><a href="docprocessing.html#pause">PAUSE</a></td><td>-- pause slide
presentation</td>
+</tr>
+<tr>
+<td><a href="docprocessing.html#transition">TRANSITION</a></td><td>--
transition effect for slides</td>
+</tr>
+<tr>
<td><a href="goodies.html#pad">PAD</a></td><td>-- insert equalized whitespace
into a line</td>
</tr>
<tr>
@@ -1130,7 +1139,7 @@ elsewhere in the documentation.
<td><a href="refer.html#bracket-refs">REF[ / REF]</a></td><td>-- put square
brackets around embedded references</td>
</tr>
<tr>
-<td><a href="refer.html#bracket-refs">REF{ / REF}</a></td><td>-- put curly
braces around mbedded references</td>
+<td><a href="refer.html#bracket-refs">REF{ / REF}</a></td><td>-- put curly
braces around embedded references</td>
</tr>
<tr>
<td><a href="refer.html#bibliography">BIBLIOGRAPHY</a></td><td>-- output a
bibliography</td>
@@ -1425,6 +1434,12 @@ elsewhere in the documentation.
<tr>
<td><a href="rectoverso.html#collate">COLLATE</a></td><td>-- join documents
(chapters/sections)</td>
</tr>
+<tr>
+<td><a href="goodies.html#center-block">CENTER_BLOCK</a></td><td>-- centre
blocks of type</td>
+</tr>
+<tr>
+<td><a href="goodies.html#left-hang">LEFT_HANG / \*[HANG c]</a></td><td>--
hanging punctuation</td>
+</tr>
</table>
<div class="rule-long"><hr/></div>
diff --git a/contrib/mom/momdoc/rectoverso.html
b/contrib/mom/momdoc/rectoverso.html
index a2e3180..c081728 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-2017 Free Software Foundation, Inc.
+Copyright (C) 2004-2018 Free Software Foundation, Inc.
Written by Peter Schaffter (address@hidden).
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 962e1b4..1d5f8e1 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-2017 Free Software Foundation, Inc.
+Copyright (C) 2004-2018 Free Software Foundation, Inc.
Written by Peter Schaffter (address@hidden).
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 97f30a8..9f9259f 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-2017 Free Software Foundation, Inc.
+Copyright (C) 2004-2018 Free Software Foundation, Inc.
Written by Peter Schaffter (address@hidden).
Permission is granted to copy, distribute and/or modify this document
diff --git a/contrib/mom/momdoc/stylesheet.css
b/contrib/mom/momdoc/stylesheet.css
index 7791bf0..7eced06 100644
--- a/contrib/mom/momdoc/stylesheet.css
+++ b/contrib/mom/momdoc/stylesheet.css
@@ -1,4 +1,4 @@
-/* Copyright (C) 2004-2017 Free Software Foundation, Inc. */
+/* Copyright (C) 2004-2018 Free Software Foundation, Inc. */
/* This file is part of mom, which is part of groff, a free software */
/* project. */
@@ -361,13 +361,13 @@ ul.mini-toc-centered
.mini-toc-col-1
{
float: left ;
- width: 50% ;
- margin-left: -6px ;
+ width: 49% ;
+ margin-left: -10px ;
}
.mini-toc-col-2
{
float: left ;
- width: 50% ;
+ width: 51% ;
clear: right ;
}
diff --git a/contrib/mom/momdoc/tables-of-contents.html
b/contrib/mom/momdoc/tables-of-contents.html
index efa9aee..6486a10 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-2017 Free Software Foundation, Inc.
+Copyright (C) 2004-2018 Free Software Foundation, Inc.
Written by Peter Schaffter (address@hidden).
Permission is granted to copy, distribute and/or modify this document
diff --git a/contrib/mom/momdoc/toc.html b/contrib/mom/momdoc/toc.html
index 5d4c0d4..cea7756 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-2017 Free Software Foundation, Inc.
+Copyright (C) 2004-2018 Free Software Foundation, Inc.
Written by Peter Schaffter (address@hidden).
Permission is granted to copy, distribute and/or modify this document
@@ -20,7 +20,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 2.2-a -- Table of Contents</title>
+ <title>Mom, version 2.3 -- Table of Contents</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" />
</head>
@@ -31,7 +31,7 @@ FDL in the main directory of the groff source package.
<div class="page">
<div class="version">
- mom, version 2.2-a
+ mom, version 2.3
</div>
<h1 class="toc" style="margin-top: 9px;">Table of Contents</h1>
@@ -291,7 +291,10 @@ FDL in the main directory of the groff source package.
</ul></li>
<li><a href="docprocessing.html#docstyle-macros">5.3.3 The docstyle
macros</a> – base templates; what kind of document you're creating, how
you want it to look overall
<ul>
- <li><a href="docprocessing.html#doctype">5.3.3.1 DOCTYPE</a>
– the kind of document</li>
+ <li><a href="docprocessing.html#doctype">5.3.3.1 DOCTYPE</a>
– the kind of document (default, chapter, named, letter)
+ <ul style="list-style-type: circle">
+ <li><a href="docprocessing.html#slides">DOCTYPE SLIDES</a></li>
+ </ul></li>
<li><a href="docprocessing.html#printstyle">5.3.3.2 PRINTSTYLE</a>
– typeset or “typewritten, double-spaced”</li>
<li><a href="docprocessing.html#copystyle">5.3.3.3 COPYSTYLE</a>
– draft or final</li>
</ul></li>
diff --git a/contrib/mom/momdoc/typesetting.html
b/contrib/mom/momdoc/typesetting.html
index 329d1c5..2f9ed7b 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-2017 Free Software Foundation, Inc.
+Copyright (C) 2004-2018 Free Software Foundation, Inc.
Written by Peter Schaffter (address@hidden).
Permission is granted to copy, distribute and/or modify this document
@@ -4182,6 +4182,20 @@ macro in the
</p>
</div>
+<div class="box-tip">
+<p class="tip">
+<span class="note">Additional Note:</span>
+Do not use multi-columns with
+<a href="docprocessing.html#slide">DOCTYPE SLIDES</a>
+because MCX uses the lowest line on the page to determine column
+depth. Owing to the fact that both headers and footers are printed
+prior to slides receiving text, MCX will always go to the
+footer position. If you need functionality similar to MCO/MCX, use
+the groff requests <kbd>.mk</kbd> and <kbd>.rt</kbd>. See
+<kbd>info groff --index-search=mk</kbd>.
+</p>
+</div>
+
<div id="index-multicolumns" class="macro-list-container">
<h3 class="macro-list">Multi-columns macros</h3>
diff --git a/contrib/mom/momdoc/using.html b/contrib/mom/momdoc/using.html
index 8277a56..057e95a 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-2017 Free Software Foundation, Inc.
+Copyright (C) 2004-2018 Free Software Foundation, Inc.
Written by Peter Schaffter (address@hidden).
Permission is granted to copy, distribute and/or modify this document
diff --git a/contrib/mom/momdoc/version-2.html
b/contrib/mom/momdoc/version-2.html
index df83c11..68891f7 100644
--- a/contrib/mom/momdoc/version-2.html
+++ b/contrib/mom/momdoc/version-2.html
@@ -2,7 +2,7 @@
<!--
This file is part of groff, the GNU roff type-setting system.
-Copyright (C) 2004-2017 Free Software Foundation, Inc.
+Copyright (C) 2004-2018 Free Software Foundation, Inc.
Written by Peter Schaffter (address@hidden).
Permission is granted to copy, distribute and/or modify this document
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 03/03: Version 2.3 documentation.,
Peter Schaffter <=