[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 04/04: Version 2.1 updates
|
From: |
Peter Schaffter |
|
Subject: |
[groff] 04/04: Version 2.1 updates |
|
Date: |
Thu, 05 Feb 2015 20:21:10 +0000 |
PTPi pushed a commit to branch master
in repository groff.
commit 191cf2c02f66e415a290ecad61ea606fbe86b37e
Author: Peter Schaffter <address@hidden>
Date: Thu Feb 5 15:20:44 2015 -0500
Version 2.1 updates
---
contrib/mom/momdoc/appendices.html | 2 +-
contrib/mom/momdoc/color.html | 2 +-
contrib/mom/momdoc/cover.html | 714 ++++++++++++++++++----------
contrib/mom/momdoc/definitions.html | 2 +-
contrib/mom/momdoc/docelement.html | 289 +++++++-----
contrib/mom/momdoc/docprocessing.html | 610 ++++++++++--------------
contrib/mom/momdoc/goodies.html | 19 +-
contrib/mom/momdoc/graphical.html | 2 +-
contrib/mom/momdoc/headfootpage.html | 2 +-
contrib/mom/momdoc/images.html | 4 +-
contrib/mom/momdoc/inlines.html | 2 +-
contrib/mom/momdoc/intro.html | 2 +-
contrib/mom/momdoc/letters.html | 2 +-
contrib/mom/momdoc/macrolist.html | 35 ++-
contrib/mom/momdoc/rectoverso.html | 7 +-
contrib/mom/momdoc/refer.html | 5 +-
contrib/mom/momdoc/reserved.html | 2 +-
contrib/mom/momdoc/stylesheet.css | 13 +-
contrib/mom/momdoc/tables-of-contents.html | 109 +----
contrib/mom/momdoc/toc.html | 6 +-
contrib/mom/momdoc/typesetting.html | 114 +++++-
contrib/mom/momdoc/using.html | 2 +-
contrib/mom/momdoc/version-2.html | 56 ++-
23 files changed, 1159 insertions(+), 842 deletions(-)
diff --git a/contrib/mom/momdoc/appendices.html
b/contrib/mom/momdoc/appendices.html
index 32a9ce4..d8b5b9c 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-2014 Free Software Foundation, Inc.
+Copyright (C) 2004-2015 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 e447110..8bd8eb4 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-2014 Free Software Foundation, Inc.
+Copyright (C) 2004-2015 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 3b49df8..ec62913 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-2014 Free Software Foundation, Inc.
+Copyright (C) 2004-2015 Free Software Foundation, Inc.
Written by Peter Schaffter (address@hidden).
Permission is granted to copy, distribute and/or modify this document
@@ -40,28 +40,42 @@ FDL in the main directory of the groff source package.
<h1 class="docs">Creating cover pages</h1>
-<div style="width: 63%; margin: auto;">
+<div style="width: 66%; margin: auto;">
<ul class="no-enumerator">
<li><a href="#cover-intro">Introduction to cover pages</a>
<ul style="margin-left: -.5em; list-style-type: disc;">
<li><a href="#important-note">Important note</a></li>
<li><a href="#desc">Description of cover pages</a></li>
- <li><a href="#pagination">Headers/footers/pagination and cover
pages</a></li>
+ <li><a href="#pagination">Headers/footers/pagination</a>
+ <ul style="margin-left: -1.25em; list-style-type: circle;">
+ <li><a href="#pagination">DOC_COVERS_COUNT_PAGES</a></li>
+ <li><a href="#pagination">COVERS_COUNT_PAGES</a></li>
+ </ul>
+ </li>
<li><a href="#design">Designing your own cover pages</a></li>
+ <li><a href="#persistence">Persistence of data and formatting</a></li>
</ul></li>
- <li><a href="#index-covers">Cover and document cover macros</a>
+ <li><a href="#index-covers">Doc-cover and cover macros</a>
<ul style="margin-left: -.5em; list-style-type: disc;">
- <li><a href="#cover">COVER / DOC_COVER</a>
- <ul style="margin-left: -.5em; list-style-type: circle;">
- <li><a href="#required-arg">The required argument</a></li>
+ <li><a href="#cover">DOC_COVER / COVER</a>
+ <ul style="margin-left: -1.25em; list-style-type: circle;">
+ <li><a href="#cover-args">The argument list: saying what goes on
doc-cover and cover pages</a></li>
+ <li><a href="#meanings">What the arguments mean</a></li>
<li><a href="#chapter">How the CHAPTER argument and friends work</a></li>
- <li><a href="#optional-args">The optional arguments</a></li>
- <li><a href="#doctype">What the DOCTYPE argument means</a></li>
- <li><a href="#blankpage">What the BLANKPAGE argument means</a></li>
</ul></li>
+ <li><a href="#covertext">DOC_COVERTEXT / COVERTEXT</a>
+ <ul style="margin-left: -1.25em; list-style-type: circle;">
+ <li><a href="#placement">Placement</a></li>
+ </ul>
+ </li>
+ <li><a href="#coverimage">DOC_COVER_IMAGE / COVER_IMAGE</a>
+ <ul style="margin-left: -1.25em; list-style-type: circle;">
+ <li><a href="#positioning">Positioning of doc-cover and cover
images</a></li>
+ </ul>
+ </li>
</ul></li>
<li><a href="#on-off">Enabling/disabling automatic generation of cover
pages</a></li>
- <li><a href="#cover-control">Control macros for covers and doc
covers</a></li>
+ <li><a href="#cover-control">Control macros for covers and
doc-covers</a></li>
</ul>
</div>
@@ -71,15 +85,15 @@ FDL in the main directory of the groff source package.
<p>
Though identical in treatment, mom provides two kinds of cover
-pages: document cover pages (”doc covers”), and section
+pages: document cover pages (”doc-covers”), and section
cover pages (which I shall refer to simply as cover pages).
</p>
<p>
-A doc cover is what you’d most likely use at the start of a
+A doc-cover is what you’d most likely use at the start of a
collated document, where you might want the name of the complete
document, the author(s) and the copyright line to appear. Another
-place you might use a doc cover is for a novel, where you want the
+place you might use a doc-cover is for a novel, where you want the
title of the novel, not the chapter title or chapter number, as the
first cover page.
</p>
@@ -87,26 +101,26 @@ first cover page.
<p>
A cover is what you’d use for pages that separate sections
of a collated document, ie title pages. A cover page (but not a
-doc cover) in a collated document could, for example, simply read:
+doc-cover) in a collated document could, for example, simply read:
”PART 1”.
</p>
<p>
In non-collated documents (say, an essay) you can use either a cover
-or doc cover to generate the cover sheet.
+or doc-cover to generate the cover sheet.
</p>
<p>
-In addition, nothing prevents you from generating both a doc cover
+In addition, nothing prevents you from generating both a doc-cover
and a cover for every document in a collated document. Or you can
-selectively disable the automatic generation of either doc covers or
+selectively disable the automatic generation of either doc-covers or
covers in a collated document on-the-fly.
</p>
<div id="important-note" class="box-important">
<p class="tip">
<span class="important">Important note:</span>
-Automatic generation of covers or doc covers after the first one(s)
+Automatic generation of covers or doc-covers after the first one(s)
only takes place if you are working with collated documents. Mom
provides no mechanism for saying ”print a section cover
here even though I'm still working on the same (non-collated)
@@ -117,7 +131,7 @@ document.”
<h3 id="desc" class="docs">Description of cover pages</h3>
<p>
-By default, mom typesets covers and doc covers identically to
+By default, mom typesets covers and doc-covers identically to
<a href="definitions.html#docheader">docheaders</a>
(see
<a href="docprocessing.html#docheader-control">How to change the look of
docheaders</a>
@@ -127,28 +141,32 @@ differences are
<ul style="margin-top: -.5em; margin-bottom: -.5em;">
<li>the position on the page where the information is output</li>
<li>the (optional) addition of copyright and miscellaneous information</li>
- <li>there’s no running text underneath</li>
+ <li>there’s no running text underneath, although you can add text
+ to a cover or doc-cover (for example, an Abstract) with
+ <a href="#covertext">COVERTEXT</a>
+ </li>
</ul>
<p>
You tell mom what you want to appear on cover pages through the
arguments you pass to
-<a href="#cover">COVER</a>
+<a href="#cover">DOC_COVER</a>
and/or
-<a href="#cover">DOC_COVER</a>.
+<a href="#cover">COVER</a>.
Provided you have already given mom the appropriate reference macros
(eg
<a href="docprocessing.html#title">TITLE</a>
or
<a href="docprocessing.html#author">AUTHOR</a>),
-she will output covers and doc covers identically to how she
+she will output covers and doc-covers identically to how she
would output docheaders containing the same information.
</p>
<p>
-By default, mom starts covers and doc covers one-third of the way
+By default, mom starts covers and doc-covers one-third of the way
down the page. This can be changed through the use of the control
-macros COVER_ADVANCE / DOC_COVER_ADVANCE.
+macros DOC_COVER_START_POS / COVER_START_POS (or DOC_COVER_ADVANCE /
+COVER_ADVANCE).
</p>
<p>
@@ -157,7 +175,7 @@ reference macro,
<a href="docprocessing.html#copyright">COPYRIGHT</a>),
she sets it, by default, in a smaller
<a href="definitions.html#ps">point size</a>
-in the bottom right hand corner of the cover or doc cover. The
+in the bottom right hand corner of the cover or doc-cover. The
position, as well as all of the standard typesetting parameters, can be
altered via control macros.
</p>
@@ -167,11 +185,11 @@ Similarly, if you request miscellaneous information (and
have
already given mom the reference macro,
<a href="docprocessing.html#misc">MISC</a>),
she sets it, by default, in a smaller point size in the bottom left
-hand corner of the cover or doc cover. As with the copyright, the
+hand corner of the cover or doc-cover. As with the copyright, the
position and type specs can be altered via control macros.
</p>
-<h3 id="pagination" class="docs">Headers/footers/pagination and cover
pages</h3>
+<h3 id="pagination" class="docs">Headers/footers/pagination</h3>
<p>
Mom does not set any
@@ -179,81 +197,75 @@ Mom does not set any
or
<a href="definitions.html#footer">footers</a>
on cover pages. Neither does she set any page numbers. From
-the point of view of pagination, covers and doc covers are by
+the point of view of pagination, covers and doc-covers are by
default considered ”null” pages. If you wish them to
be included in the pagination scheme (even though no page numbers
-appear), you must tell mom that’s what you want with the
-macros DOC_COVERS_COUNT_PAGES and/or COVERS_COUNT_PAGES.
+appear), you must tell mom that’s what you want by invoking
+<br/>
+<span class="pre-in-pp">
+ .DOC_COVERS_COUNT_PAGES
+</span>
+or
+<br/>
+<span class="pre-in-pp">
+ .COVERS_COUNT_PAGES
+</span>
</p>
<h3 id="design" class="docs">Designing your own cover pages</h3>
<p>
Finally, if you want to design your own cover page(s), you can
-always typeset them (using the
-<a href="typesetting.html#macros-typesetting">typesetting macros</a>),
-invoke
-<a href="typesetting.html#newpage"><kbd>.NEWPAGE</kbd></a>,
-set up your document (see
-<a href="docprocessing.html#docprocessing-tut">Tutorial – Setting up a
mom document</a>),
-and lastly invoke
-<a href="docprocessing.html#start"><kbd>.START</kbd></a>.
-The cover page, and any typesetting commands on it, will have no
-effect on mom’s processing of the document after you invoke
-<kbd><a href="docprocessing.html#START">.START</a></kbd>.
+typeset them by hand inside a
+<a href="#covertext">COVERTEXT</a>
+block using mom’s typesetting macros to format the text.
+</p>
+
+<h3 id="persistence" class="docs">Persistence of data and formatting</h3>
+
+<p>
+Doc-cover and cover data—that is to say, the strings passed to
+reference macros that appear on doc-cover and cover
+pages—does not persist after
+<a href="docprocessing.html#start">START</a>,
+however the formatting of the various parts (TITLE, AUTHOR,
+COPYRIGHT, etc.) does.
</p>
<div class="macro-list-container">
<h3 id="index-covers" class="macro-list">Cover and document cover macros</h3>
<ul class="macro-list">
- <li><a href="#cover">COVER and DOC_COVER</a>
+ <li><a href="#cover">DOC_COVER and COVER</a>
<ul style="margin-left: -.5em; list-style-type: disc;">
- <li><a href="#required-and-optional-args">Required and optional
arguments</a></li>
+ <li><a href="#cover-args">The arguments: saying what goes on doc-cover and
cover pages</a></li>
</ul></li>
+ <li><a href="#covertext">DOC_COVERTEXT / COVERTEXT</a></li>
+ <li><a href="#coverimage">DOC_COVER_IMAGE / COVER_IMAGE</a></li>
<li><a href="#on-off">Enabling/disabling automatic generation of cover
pages</a>
<ul style="margin-left: -.5em; list-style-type: disc;">
- <li><a href="#covers">COVERS</a></li>
<li><a href="#doc-covers">DOC_COVERS</a></li>
+ <li><a href="#covers">COVERS</a></li>
</ul></li>
- <li><a href="#cover-control">Control macros for covers and doc
covers</a></li>
+ <li><a href="#cover-control">Control macros for doc-covers and
covers</a></li>
</ul>
</div>
<!-- -COVER- -->
<div class="macro-id-overline">
-<h3 id="cover" class="macro-id">COVER and DOC_COVER</h3>
+<h3 id="cover" class="macro-id">DOC_COVER and COVER</h3>
</div>
-<div class="box-macro-args">
-Macro: <b>COVER</b> <kbd class="macro-args">(see required and optional
arguments, below)</kbd>
-</div>
-
-<div id="doc-cover" class="box-macro-args" style="margin-top: 1em;">
-Macro: <b>DOC_COVER</b> <kbd class="macro-args">(see required and optional
arguments, below)</kbd>
-</div>
-
-<div id="required-and-optional-args" style="margin-top: 1em; padding-bottom:
3px; white-space: nowrap; overflow: auto;">
-<b><a href="#required-arg">Required argument:</a></b> <kbd
class="macro-args">TITLE | DOCTITLE | COVERTITLE | CHAPTER | CHAPTER_TITLE |
CHAPTER+TITLE</kbd>
-</div>
-
-<div style="margin-top: .5em; padding-bottom: 3px; white-space: nowrap;
overflow: auto;">
-<b><a href="#optional-args">Optional arguments:</a></b> <kbd
class="macro-args">[ SUBTITLE AUTHOR DOCTYPE COPYRIGHT MISC BLANKPAGE
PDF_OUTLINE_LABEL <label> ]</kbd>
+<div id="doc-cover" class="box-macro-args">
+Macro: <b>DOC_COVER</b> <kbd class="macro-args">(see argument list,
below)</kbd>
</div>
-<div class="box-tip">
-<p class="tip">
-<span class="note">Note:</span>
-These macros should be placed in the style sheet section of your
-document setup (see
-<a href="docprocessing.html#docprocessing-tut">Tutorial – Setting up a
mom document</a>),
-ie after PRINTSTYLE (and/or DOCTYPE and/or COPYSTYLE), but before
-START.
-</p>
+<div class="box-macro-args" style="margin-top: 1em;">
+Macro: <b>COVER</b> <kbd class="macro-args">(see argument list, below)</kbd>
</div>
-<p style="margin-top: -.25em;">
-COVER and DOC_COVER behave identically. The reason mom provides
+<p>
+DOC_COVER and COVER behave identically. The reason mom provides
two macros for cover page generation is so that you can have two
different kinds of covers with different information on each.
</p>
@@ -267,50 +279,166 @@ page that contained the name of the entire document,
your (the
author’s) name, and perhaps the copyright date. Subsequently,
you could use COVER, after each <kbd>.COLLATE</kbd> but before each
<kbd><a href="docprocessing.html#start">.START</a></kbd>,
-to generate a cover page (or cover ”sheet”, if you
-prefer) containing just the name of the section.
+to generate a cover page (title page, cover sheet) containing
+just the name of the section, for example, “Part 1”.
</p>
-<h4 id="required-arg" class="docs" style="margin-top: -.5em;">The required
argument</h4>
-
<p>
-Both COVER and DOC_COVER, whenever invoked, require a first
-argument, as listed above. This first argument will become the
-first bit of information mom prints on the cover or doc cover (ie
-the title).
+The arguments to <kbd>DOC_COVER</kbd> and <kbd>COVER</kbd> tell mom
+what you’d like on cover pages. You may give as many or as
+few arguments as you need, in any order. A very common setup would
+be:
+<br/>
+<span class="pre-in-pp">
+ .COVER TITLE AUTHOR COPYRIGHT
+</span>
</p>
-<p>
-In order for the information to appear, you must, of course, have
-given mom the appropriate
-<a href="docprocessing.html#reference-macros">reference macro</a>.
-A list of first arguments with their equivalent reference macros follows.
+<h4 id="cover-args" class="docs" style="margin-top: -1em;">The argument
list</h4>
+
+<p style="margin-top: 1em">
+The arguments to <kbd>COVER</kbd> and <kbd>DOC_COVER</kbd> tell mom
+what you want on the cover page:
+<br/>
+<span class="pre-in-pp">
+ TITLE | DOCTITLE | DOC_COVERTITLE | COVERTITLE
+ CHAPTER | CHAPTER_TITLE | CHAPTER+TITLE
+ SUBTITLE
+ AUTHOR
+ DOCTYPE
+ DOC_COVERTEXT | COVERTEXT
+ DOC_COVER_IMAGE | COVER_IMAGE
+ COPYRIGHT
+ MISC
+ PDF_OUTLINE_LABEL "<label>"
+ BLANKPAGE
+</span>
</p>
-<dl style="margin-top: -.5em;">
- <dt class="no-italic"><kbd>TITLE</kbd></dt>
- <dd>
- – means the argument you gave to <a
href="docprocessing.html#title">TITLE</a>
- </dd>
- <dt class="no-italic"><kbd>DOCTITLE</kbd></dt>
- <dd>
- – means the argument you gave to <a
href="docprocessing.html#doc-title">DOCTITLE</a>
- </dd>
- <dt class="no-italic"><kbd>COVERTITLE</kbd></dt>
- <dd>
- – means the argument you gave to <a
href="docprocessing.html#covertitle">COVERTITLE</a>
- or
- <a href="docprocessing.html#doc-covertitle">DOC_COVERTITLE</a>
- </dd>
- <dt class="no-italic"><kbd>CHAPTER, CHAPTER_TITLE, CHAPTER+TITLE</kbd></dt>
- <dd>
- – see below, <i>How the CHAPTER argument and friends work</i>
- </dd>
-</dl>
+<h4 id="meanings" class="docs" style="margin-top: -1em;">What the arguments
mean</h4>
+
+<dl>
+ <dt class="params">TITLE</dt>
+ <dd class="cover-args">– the string(s) you gave to
+ <a href="docprocessing.html#title">TITLE</a>
+ </dd>
+ <dt class="params">DOCTITLE</dt>
+ <dd class="cover-args">– the string(s) you gave to
+ <a href="docprocessing.html#doc-title">DOCTITLE</a>
+ </dd>
+ <dt class="params">DOC_COVERTITLE / COVERTITLE</dt>
+ <dd class="cover-args">– the string(s) you gave to
+ <a href="docprocessing.html#doc-covertitle">DOC_COVERTITLE</a>
+ or
+ <a href="docprocessing.html#covertitle">COVERTITLE</a>
+ </dd>
+ <dt class="params">CHAPTER, CHAPTER_TITLE, CHAPTER+TITLE</dt>
+ <dd class="cover-args">– see below,
+ <a href="#chapter">How the CHAPTER argument and friends work</a>
+ </dd>
+ <dt class="params">SUBTITLE</dt>
+ <dd class="cover-args">– the string(s) you gave to
+ <a href="docprocessing.html#subtitle">SUBTITLE</a>
+ </dd>
+ <dt class="params">AUTHOR</dt>
+ <dd class="cover-args">– the string(s) you gave to
+ <a href="docprocessing.html#author">AUTHOR</a>
+ </dd>
+ <dt class="params">DOCTYPE</dt>
+ <dd class="cover-args">– the string you gave to
+ <a href="docprocessing.html#doctype">DOCTYPE NAMED</a>
+ </dd>
+ <dt class="params">DOC_COVERTEXT / COVERTEXT</dt>
+ <dd class="cover-args">– the block of type you entered for
+ <a href="#covertext">DOC_COVERTEXT</a>
+ or
+ <a href="#covertext">COVERTEXT</a>
+ </dd>
+ <dt class="params">DOC_COVER_IMAGE / COVER_IMAGE</dt>
+ <dd class="cover-args">– the image file you gave to
+ <a href="#covertext">DOC_COVER_IMAGE</a>
+ or
+ <a href="#covertext">COVER_IMAGE</a>
+ </dd>
+ <dt class="params">COPYRIGHT</dt>
+ <dd class="cover-args">– the string you gave to
+ <a href="docprocessing.html#copyright">COPYRIGHT</a>
+ </dd>
+ <dt class="params">MISC</dt>
+ <dd class="cover-args">– the string(s) you gave to
+ <a href="docprocessing.html#misc">MISC</a>
+ </dd>
+ <dt class="params">PDF_OUTLINE_LABEL <label></dt>
+ <dd class="cover-args">
+ <span style="display:block; margin-left: 1em">
+ By default, mom identifies doc-covers in the outline panel of PDF
+ viewers with the prepended label, “Cover:”, and covers
+ with the label “Title Page:”. If you would like
+ to change the label, give the <kbd>PDF_OUTLINE_LABEL</kbd>
+ argument to DOC_COVER or COVER along with the new label, in
+ quotation marks, as in this example:
+ <br/>
+ <kbd> .COVER TITLE AUTHOR COPYRIGHT PDF_LABEL "Cover Sheet:
"</kbd>
+ </span>
+ </dd>
+ <dt class="params">BLANKPAGE</dt>
+ <dd class="cover-args">
+ <span style="display:block; margin-left: 1em">
+ If the final argument to DOC_COVER or COVER is <kbd>BLANKPAGE</kbd>,
+ mom will insert a blank page after the doc-cover or cover. This is
+ particularly useful if you intend to print your document two-sided,
+ since, in two-sided printing, there may be instances where you do
+ not want text on the reverse side of cover or title pages
+ </span>
+ <span style="display:block; margin-left: 1em; margin-top: .5em">
+ If you enable
+ <a href="#pagination">DOC_COVERS_COUNT_PAGES</a>
+ and/or
+ <a href="#pagination">COVERS_COUNT_PAGES</a>,
+ the blank page will be taken into account in the pagination
+ scheme, though no page number appears on it. Otherwise, blank
+ pages are invisible to mom's pagination.
+ </span>
+ </dd>
+<dl/>
-<h5 id="chapter" class="docs" style="margin-top: -.5em; text-transform:
none;">How the CHAPTER argument and friends work</h5>
+<p>
+Please note that in all cases, if you have passed
+a reference macro one of the optional arguments,
+<kbd>DOC_COVER</kbd> or <kbd>COVER</kbd> (e.g.
+<kbd>.TITLE DOC_COVER "Title"</kbd>), mom will print the
+appropriate string on the appropriate cover page. Thus,
+<br/>
+<span class="pre-in-pp">
+ .TITLE DOC_COVER "Collected Essays"
+ .TITLE COVER "1985-2015"
+ .TITLE "Neo-liberalism: Who Did They Think They Were Fooling?"
+ .DOC_COVER TITLE
+ .COVER TITLE
+</span>
+will print “Collected Essays” on the doc-cover page,
+“1985-2015” on the cover page, and, assuming the
+docheader hasn’t been disabled, “Neo-liberalism: Who
+Did They Think They Were Fooling?” as the title in the
+docheader.
+</p>
<p>
+Note that
+<br/>
+<span class="pre-in-pp">
+ .DOC_COVERTITLE "Collected Essays"
+ .COVERTITLE "1985-2015"
+ .TITLE "Neo-liberalism: Who Did They Think They Were Fooling?"
+ .DOC_COVER DOC_COVERTITLE
+ .COVER COVERTITLE
+</span>
+could be used to accomplish the same thing.
+</p>
+
+<h5 id="chapter" class="docs" style="margin-top: 0; text-transform: none;">How
the CHAPTER argument and friends work</h5>
+
+<p style="margin-top: .75em">
<span style="display: block; margin-bottom: -1.25em; font-weight:
bold;">• CHAPTER</span>
<br/>
The <kbd>CHAPTER</kbd> argument will print the
@@ -322,7 +450,7 @@ For example, assuming a vanilla setup for your chapter:
<span class="pre-in-pp" style="color: #64614a;">
.CHAPTER 1
.CHAPTER_TITLE "The Bonny Blue Yonder"
- <span style="color: #941614;">.COVER CHAPTER</span> \"(or <span
style="color: #941614;">.DOC_COVER CHAPTER</span>)
+ <span style="color: #941614;">.COVER CHAPTER</span> \" (or <span
style="color: #941614;">.DOC_COVER CHAPTER</span>)
</span>
will print (and only print)
<br/>
@@ -371,72 +499,196 @@ will print
</span>
</p>
-<h4 id="optional-args" class="docs" style="margin-top: -1em;">The optional
arguments</h4>
+<div class="macro-id-overline">
+<h3 id="covertext" class="macro-id">DOC_COVERTEXT and COVERTEXT</h3>
+</div>
+
+<div class="box-macro-args">
+Macro: <b>DOC_COVERTEXT</b> <kbd class="macro-args"><toggle></kbd>
+</div>
+<div class="box-macro-args" style="margin-top: 1em;">
+Macro: <b>COVERTEXT</b> <kbd class="macro-args"><toggle></kbd>
+</div>
+
+<p class="requires">
+• Must come after
+<a href="#printstyle"><span class="normal">PRINTSTYLE</span></a>
+</p>
+
+<p>
+<kbd>DOC_COVERTEXT</kbd> and <kbd>COVERTEXT</kbd> allow you to add
+text to doc-covers and covers in addition to, or instead of, what is
+generated by mom from the arguments you give to
+<a href="#doccover">DOC_COVER</a>
+and
+<a href="#doccover">COVER</a>.
+</p>
+
+<p>
+Invoke <kbd>.DOC_COVERTEXT</kbd> or <kbd>.COVERTEXT</kbd> on a line
+by itself, follow it with the text and formatting you desire, and
+terminate the text block with <kbd>.DOC_COVERTEXT OFF</kbd> or
+<kbd>COVERTEXT OFF</kbd> (or <kbd>QUIT, END, DONE</kbd>, etc.).
+</p>
+
+<p>
+By default, cover text is set over the full line length of the
+document, using the style parameters of
+<a href="definitions.html#running">running text</a>.
+Therefore, as noted, these macros must come after PRINTSTYLE
+and any global style changes (margins, family, size, leading,
+etc.). Formatting within a cover text block must be done
+“manually” with mom’s typesetting macros;
+<a href="docelement.html#pp">PP</a>
+is the only allowed document element tag.
+</p>
+
+<h4 id="placement" class="docs">Placement</h4>
<p>
-The remainder of the arguments to COVER and
-DOC_COVER are optional. They refer specifically to
-the information you gave the
-<a href="docprocessing.html#reference-macros">reference macros</a>
-bearing the same name as the arguments. You may enter as many or as
-few as you like, in any order.
+If you do not instruct mom to put anything on doc-cover or cover
+pages except <kbd>DOC_COVERTEXT</kbd> or <kbd>COVERTEXT</kbd>, the
+cover text will begin at the document’s top margin. You must
+use
+<a href="typesetting.html#space">SP</a>
+or
+<a href="typesetting.html#ald">ALD</a>
+to move it further down the page. Equally, if only
+<kbd>COPYRIGHT</kbd> and/or <kbd>MISC</kbd> are to go on the pages,
+cover text begins at the top margin. In all other cases, cover text
+begins below the last element on the page, separated by a blank
+line.
</p>
-<h5 id="doctype" class="docs" style="text-transform: none; margin-top:
-.5em;">What the DOCTYPE argument means</h5>
+<p>
+<kbd>DOC_COVERTEXT</kbd> and <kbd>COVERTEXT</kbd> are particularly
+useful for putting abstracts on cover pages, as technical reports
+often require.
+</p>
<p>
-When you pass COVER or DOC_COVER
-the argument, <kbd>DOCTYPE</kbd>, it refers to the argument you gave
-to
-<a href="docprocessing.html#doctype">DOCTYPE</a> <kbd>NAMED</kbd>.
-For example, if, in your
-<a href="docprocessing.html#docstyle-macros">docstyle macros</a>
-you gave a
+Here's a simple recipe for setting an abstract:
<br/>
<span class="pre-in-pp">
- .DOCTYPE NAMED "Abstract"
+ .COVERTEXT
+ .FT BI
+ .PT_SIZE 14
+ .LS 14
+ .CENTER
+ Abstract
+ .SP .5v
+ .FT R
+ .PT_SIZE 12
+ .IB 6P
+ .JUSTIFY
+ Text of Abstract...
+ .COVERTEXT OFF
</span>
-the argument, <kbd>DOCTYPE</kbd>, given to the COVER or DOC_COVER
-macros, would mean that you wanted the word, Abstract, to appear on
-the cover or doc cover underneath the title and/or author(s), just
-as it would in the
-<a href="docprocessing.html#docheader">docheader</a>.
+Assuming you have told mom to put the title and author on the
+cover page, the abstract will appear beneath the author with a
+14-point bold-italic title, centered, with the text of the abstract
+medium-roman and justified, indented 6 picas from both margins.
</p>
-<h5 id="blankpage" class="docs" style="text-transform: none; margin-top:
-.5em;">What the BLANKPAGE argument means</h5>
+<div class="macro-id-overline">
+<h3 id="coverimage" class="macro-id">DOC_COVER_IMAGE and COVER_IMAGE</h3>
+</div>
+
+<div id="coverimage" class="box-macro-args">
+Macro: <b>DOC_COVER_IMAGE</b> <kbd class="macro-args"><image>
<width> <height> [ -L | -C | -R | -I <indent> <Y-pos> [
<X-pos> ] ]</kbd>
+</div>
+
+<div id="coverimage" class="box-macro-args" style="margin-top: 1em;">
+Macro: <b>COVER_IMAGE</b> <kbd class="macro-args"><image> <width>
<height> [ -L | -C | -R | -I <indent> <Y-pos> [ <X-pos>
] ]</kbd>
+</div>
<p>
-If the final argument to DOC_COVER or COVER is <kbd>BLANKPAGE</kbd>,
-mom will insert a blank page after the doc cover or cover. This is
-particularly useful if you intend to print your document two-sided,
-since, in two-sided printing, there may be instances where you do
-not want text on the reverse side of cover or title pages.
+There are times you need a full page image on a cover, for example
+the jacket of a book. Equally, there are times when you need a small
+image on the cover, perhaps a company logo.
</p>
<p>
-If you enable DOC_COVERS_COUNT_PAGES and/or COVERS_COUNT_PAGES, the
-blank page will be taken into account in the pagination scheme,
-though no page number appears on it. Otherwise, blank pages are
-invisible to mom's pagination.
+DOC_COVER_IMAGE and COVER_IMAGE take the same arguments
+as PDF_IMAGE, and in the same order. Consult
+<a href="images.html#pdf-image">PDF_IMAGE</a>
+for a desciption.
</p>
-<h5 id="pdf-label" class="docs" style="text-transform: none; margin-top:
-.5em;">What the PDF_OUTLINE_LABEL argument means</h5>
+<p>
+Two additional arguments allow you to place images using x-y
+coordinates. Please note that if you use x-y coordinates for
+positioning, <b>Y-pos</b> comes before <b>X-pos</b> in the order of
+arguments.
+</p>
<p>
-By default, mom identifies doccovers in the outline panel of PDF
-viewers with the prepended string, “Cover:”, and covers
-with the string “Title Page:”. If you would like
-to change the strings, pass the <kbd>PDF_OUTLINE_LABEL</kbd>
-argument to COVER or DOCCOVER, along with the new string.
+Like PDF_IMAGE, the image file must be in PDF format. Mom
+apologizes, but PostScript images are not supported for inclusion on
+covers. See
+<a href="images.html#pdf">Image conversion and file processing</a>
+for instructions on converting various image types to PDF, and
+<a href="images.html#bounding-box">here</a>
+for instructions on obtaining image dimensions.
</p>
-<!-- -ENABLING/DISABLING- -->
+<h4 id="positioning" class="docs">Positioning of doc-cover and cover
images</h4>
-<div class="macro-id-overline">
+<p>
+With no arguments other than <kbd><file name></kbd>,
+<kbd><width></kbd>, and <kbd><height></kbd>,
+DOC_COVER_IMAGE and COVER_IMAGE place images flush with the top
+left corner of the printer sheet. This allows placing full-page
+background images on covers. For example, assuming a US-letter page
+size,
+<br/>
+<span class="pre-in-pp">
+ .DOC_COVER_IMAGE image.pdf 612p 792p
+ .DOC_COVER TITLE AUTHOR DOC_COVER_IMAGE
+</span>
+will fill the doc-cover page with “image.pdf” and set
+the title and author in their usual locations.
+</p>
+
+<p>
+For smaller images, the horizontal position is established
+with one of the <kbd>-L</kbd>, <kbd>-C</kbd>, <kbd>-R</kbd>, or
+<kbd>-I <indent></kbd> arguments, just like
+<a href="images.html#pdf-image">PDF_IMAGE</a>.
+You may instead use the <kbd>X-pos</kbd> argument, provided that it
+is preceded by a <kbd>Y-pos</kbd> argument. The values given to
+<kbd>-I</kbd>, <kbd>Y-pos</kbd> and <kbd>X-pos</kbd> must have a
+<a href="definitions.html#unitofmeasure">unit of measure</a>
+appended to them.
+</p>
+
+<p>
+Vertical positioning of smaller images requires the <kbd>Y-pos</kbd>
+argument (which is why it precedes <kbd>X-pos</kbd> in the order of
+arguments) otherwise the image will be flush with the top edge of
+the printer sheet
+</p>
+
+<p>
+The positioning of images does not effect the placement of type on
+doc-cover and cover pages.
+</p>
+
+<div class="box-tip">
+<p class="tip">
+<span class="note">Tip:</span>
+The combination of
+<a href="#covertext">COVERTEXT</a>
+and COVER_IMAGE make it possible to design covers entirely to your
+own specifications.
+</p>
+</div>
+
+<div class="macro-id-overline" style="margin-top: .5em">
<h3 id="on-off" class="macro-id">Enabling/disabling automatic generation of
cover pages</h3>
</div>
-<div id="covers" class="box-macro-args">
+<div id="covers" class="box-macro-args" style="margin-top: .5em">
Macro: <b>COVERS</b> <kbd class="macro-args"><toggle></kbd>
</div>
@@ -449,7 +701,7 @@ By default, if you give mom a
<a href="#cover">COVER</a>
or
<a href="#doc-cover">DOC_COVER</a>
-directive, she will print the cover or doc cover. In a document
+directive, she will print the cover or doc-cover. In a document
that contains sections, articles or chapters formerly treated as
”one-off’s” but now being
<a href="rectoverso.html#collate-intro">collated</a>,
@@ -458,12 +710,11 @@ such behaviour may not be desirable.
<p>
Mom lets you selectively enable or disable the generation of covers
-and/or doc covers with the toggle macros, COVERS and DOC_COVERS.
+and/or doc-covers with the toggle macros, COVERS and DOC_COVERS.
Because they’re toggle macros, simply invoking them by
-themselves enables automatic cover or doc cover generation, while
+themselves enables automatic cover or doc-cover generation, while
invoking them with any argument at all (<kbd>OFF, QUIT, X</kbd>,
-etc) disables cover or doc cover generation.
-</p>
+etc) disables cover or doc-cover generation. </p>
<div class="box-tip">
<p class="tip">
@@ -482,10 +733,10 @@ instances of START.
<div class="rule-short"><hr/></div>
-<h2 id="cover-control" class="macro-group">Control macros for covers and doc
covers</h2>
+<h2 id="cover-control" class="macro-group">Control macros for doc-covers and
covers</h2>
<p>
-The default typographic appearance of the items on a cover or doc
+The default typographic appearance of the items on a doc-cover or
cover is identical to that of the items in a
<a href="definitions.html#docheader">docheader</a>.
(See
@@ -501,111 +752,80 @@ which do not appear in docheaders, have the following
default
characteristics:
</p>
<ul style="margin-top: -.5em; margin-bottom: -.5em;">
- <li>the COPYRIGHT line is set in the bottom right hand corner
- of the page, 2
+ <li>the COPYRIGHT line is set flush with the document’s right
+ and bottom margins, 2
<a href="definitions.html#ps">point sizes</a>
smaller than the size of
<a href="definitions.html#running">running text</a>
</li>
- <li>MISC lines are set in the bottom left hand
- corner of the page, in the same family, font and point size
- as the copyright line.
+ <li>MISC lines are set flush with the document’s left and bottom
+ margins, in the same family, font and point size as the
+ copyright line.
</li>
</ul>
<p>
-The defaults for the entirety of covers and doc covers, and all the
+The defaults for the entirety of doc-covers and covers, and all the
elements thereon, can be changed with control macros whose defaults
-and arguments are identical to the corresponding control macros
-governing docheaders. The only difference is the name by which you
-invoke them.
-</p>
-
-<p>
-A complete list of cover and doc cover control macros follows.
-Please refer to
-<a href="docprocessing.html#index-docheader-control">docheader control</a>
-in order to get the defaults and any special instructions for usage.
-</p>
-
-<h3 id="index-cover-control" class="docs" style="margin-bottom: .25em;">Cover
/ doc cover control macros and defaults</h3>
-
-<div class="defaults-container" style="padding-bottom: 8px;">
-
-<span class="pre defaults">
-COVER_ADVANCE DOC_COVER_ADVANCE -+
-COVER_FAMILY DOC_COVER_FAMILY | like
-COVER_LEAD DOC_COVER_LEAD | DOCHEADER_<spec>
-COVER_QUAD DOC_COVER_QUAD -+
-
-COVER_TITLE_FAMILY DOC_COVER_TITLE_FAMILY -+
-COVER_TITLE_FONT DOC_COVER_TITLE_FONT | like
-COVER_TITLE_COLOR DOC_COVER_TITLE_COLOR | TITLE_<spec>
-COVER_TITLE_SIZE DOC_COVER_TITLE_SIZE -+
-
-COVER_CHAPTER_TITLE_FAMILY DOC_COVER_CHAPTER_TITLE_FAMILY -+
-COVER_CHAPTER_TITLE_FONT DOC_COVER_CHAPTER_TITLE_FONT | like
-COVER_CHAPTER_TITLE_COLOR DOC_COVER_CHAPTER_TITLE_COLOR |
CHAPTER_TITLE_<spec>
-COVER_CHAPTER_TITLE_SIZE DOC_COVER_CHAPTER_TITLE_SIZE -+
-
-COVER_SUBTITLE_FAMILY DOC_COVER_SUBTITLE_FAMILY -+
-COVER_SUBTITLE_FONT DOC_COVER_SUBTITLE_FONT | like
-COVER_SUBTITLE_COLOR DOC_COVER_SUBTITLE_COLOR | SUBTITLE_<spec>
-COVER_SUBTITLE_SIZE DOC_COVER_AUTHOR_SIZE -+
-
-COVER_ATTRIBUTE_COLOR DOC_COVER_ATTRIBUTE_COLOR - like ATTRIBUTE_COLOR
- - the macro, ATTRIBUTE_STRING, controls the attribution string
- for both docheaders and cover pages; cover pages have no
- separate ATTRIBUTE_STRING macro
-
-COVER_AUTHOR_FAMILY DOC_COVER_AUTHOR_FAMILY -+
-COVER_AUTHOR_FONT DOC_COVER_AUTHOR_FONT | like
-COVER_AUTHOR_COLOR DOC_COVER_AUTHOR_COLOR | AUTHOR_<spec>
-COVER_AUTHOR_SIZE DOC_COVER_AUTHOR_SIZE -+
-
-COVER_DOCTYPE_FAMILY DOC_COVER_DOCTYPE_FAMILY -+
-COVER_DOCTYPE_FONT DOC_COVER_DOCTYPE_FONT | like
-COVER_DOCTYPE_COLOR DOC_COVER_DOCTYPE_COLOR | DOCTYPE_<spec>
-COVER_DOCTYPE_SIZE DOC_COVER_DOCTYPE_SIZE -+
-
-COVER_COPYRIGHT_FAMILY DOC_COVER_COPYRIGHT_FAMILY -+
-COVER_COPYRIGHT_FONT DOC_COVER_COPYRIGHT_FONT |
-COVER_COPYRIGHT_COLOR DOC_COVER_COPYRIGHT_COLOR | like any of the above
-COVER_COPYRIGHT_SIZE DOC_COVER_COPYRIGHT_SIZE |
-COVER_COPYRIGHT_QUAD DOC_COVER_COPYRIGHT_QUAD -+
- - copyright quad sets both the position on the page and the quad
- direction and can be either L (left) or R (right); default is right
-
-COVER_MISC_FAMILY DOC_COVER_MISC_FAMILY -+
-COVER_MISC_FONT DOC_COVER_MISC_FONT |
-COVER_MISC_COLOR DOC_COVER_MISC_COLOR | like any of the above
-COVER_MISC_SIZE DOC_COVER_MISC_SIZE |
-COVER_MISC_QUAD DOC_COVER_MISC_QUAD -+
- - misc quad sets both the position on the page and the quad
- direction and can be either L (left) or R (right); default is left
-
-COVER_UNDERLINE DOC_COVER_UNDERLINE - like DOCTYPE_UNDERLINE
- - cover underline controls underlining of the argument given to
- DOCTYPE NAMED "<name>" only
-
-COVER_COUNTS_PAGES DOC_COVER_COUNTS_PAGES
- - whether to consider cover pages in the pagination scheme; the
- default is to ignore them
- - see Note
-</span>
-</div>
+and arguments are identical to the corresponding
+<a href="docprocessing.html#index-docheader-control">Control macros for
docheaders</a>
+(q.v.) The only difference is the name by which you invoke them. Wherever
+<kbd>DOCHEADER</kbd> is used for overall changes, replace it
+with <kbd>DOC_COVER</kbd> or <kbd>COVER</kbd>. For part-by-part
+changes, prepend <kbd>DOC_COVER_</kbd> or <kbd>COVER_</kbd> to the
+part/parameter.
+</p>
-<p style="margin-top: -2em;">
-<b>Note:</b>
+<p>
+Thus, to change the overall family, color, leading, quad and
+starting position of a doc-cover, you’d do
+<br/>
+<span class="pre-in-pp">
+ .DOC_COVER_FAMILY H
+ .DOC_COVER_COLOR blue
+ .DOC_COVER_LEADING +2
+ .DOC_COVER_QUAD L
+ .DOC_COVER_ADVANCE 3i \" or .DOC_COVER_START_POS 3i
+</span>
+To change the style parameters for selected parts of a cover, you
+might do something like this:
<br/>
-COVER_COUNTS_PAGES and DOC_COVER_COUNTS_PAGES are toggle macros,
-hence invoking them by themselves means that mom will consider
-covers and doc covers in the pagination scheme; invoking them with
-any argument (<kbd>OFF, NO, X</kbd>, etc.) means they are ignored.
-The default is to ignore them.
+<span class="pre-in-pp">
+ .COVER_TITLE_FONT B
+ .COVER_TITLE_SIZE +4
+ .COVER_SUBTITLE_FONT I
+ .COVER_AUTHOR_FONT R
+ .COVER_AUTHOR_SPACE_BEFORE 6p
+ .COVER_DOCTYPE_COLOR red
+ .COVER_MISC_SIZE -1
+ .COVER_MISC_LEAD 12
+ .COVER_COPYRIGHT_SIZE -2
+ .COVER_COPYRIGHT_QUAD L
+ .COVER_MISC_QUAD R
+</span>
+Note in the above example that _COPYRIGHT_QUAD and _MISC_QUAD set
+both the horizontal position on the page and the quad direction,
+either L (or LEFT) or R (or RIGHT), and have no corresponding
+docheader control macro.
</p>
-<div class="rule-long"><hr/></div>
+<div class="box-tip">
+<p class="tip-top">
+<span class="note">Tip:</span>
+As with the docheader control macros, <kbd>DOC_COVER_</kbd> and
+<kbd>COVER_</kbd> part/parameter style changes may be
+<a href="docprocessing.html#grouping">grouped</a>,
+for example
+</br>
+<span class="pre-in-pp">
+ .DOC_COVER_TITLE_STYLE \
+ FAMILY A \
+ FONT B \
+ SIZE +4 \
+ CAPS
+</span>
+</p>
+</div>
<!-- Navigation links -->
<table style="width: 100%; margin-top: 12px;">
diff --git a/contrib/mom/momdoc/definitions.html
b/contrib/mom/momdoc/definitions.html
index edc9a76..091ac7a 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-2014 Free Software Foundation, Inc.
+Copyright (C) 2004-2015 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 6203964..3f20962 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-2014 Free Software Foundation, Inc.
+Copyright (C) 2004-2015 Free Software Foundation, Inc.
Written by Peter Schaffter (address@hidden).
Permission is granted to copy, distribute and/or modify this document
@@ -53,6 +53,7 @@ FDL in the main directory of the groff source package.
<li><a href="#quad">quad/justification</a></li>
<li><a href="#underline">underline style, rule weight</a></li>
</ul></li>
+ <li><a href="#grouping">Grouping control macros</a></li>
</ul></li>
</ul>
</div>
@@ -369,7 +370,20 @@ Control macros that end in _QUAD take the same arguments as
If mom gives the option to underline a document element, the weight
of the underline and its distance from the
<a href="definitions.html#baseline">baseline</a>
-are controlled by macros that end in _UNDERLINE.
+are controlled by macros that end in _UNDERSCORE or _UNDERLINE.
+These macros take the following arguments:
+<br/>
+<span class="pre-in-pp">
+ DOUBLE - double underscore
+ <weight> - the underscore weight (in points, no unit of measure
required
+ <distance> - distance from baseline (unit of measure required)
+ <rule gap> - distance between double underscore rules (unit of measure
required_
+</span>
+<kbd>DOUBLE</kbd> by itself will double-underscore the element. The
+remaining arguments must be entered in the order given. You may not
+skip over any of them, which means that if you only wish to change
+<kbd><rule gap></kbd>, you must still enter a
+<kbd><weight></kbd> and <kbd><distance></kbd> argument.
</p>
<p>
@@ -386,6 +400,49 @@ to
as is the argument to _RULE_WEIGHT macros.
</p>
+<h3 id="grouping" class="docs">Grouping control macros</h3>
+
+<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
+<a href="#blockquote-intro">BLOCKQUOTES</a>
+with
+<br/>
+<span class="pre-in-pp">
+ .BLOCKQUOTE_FAMILY H
+ .BLOCKQUOTE_SIZE -2
+ .BLOCKQUOTE_INDENT 4P
+</span>
+you can enter the same style parameter changes with
+<br/>
+<span class="pre-in-pp">
+ .BLOCKQUOTE_STYLE \
+ FAMILY H \
+ 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.
+</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
+<br/>
+<span class="pre-in-pp">
+ FAMILY FONT SIZE LEAD AUTOLEAD
+ QUAD INDENT
+ COLOR CAPS SMALLCAPS UNDERLINE/UNDERSCORE
+</span>
+those parameters may be used within a <kbd>_STYLE</kbd> macro.
+</p>
+
<div class="rule-short"><hr/></div>
<!-- ==================================================================== -->
@@ -506,6 +563,10 @@ resulting in unbalanced columns.
<p class="defaults">
See
<a href="#control-macro-args">Arguments to the control macros</a>.
+<br/>
+The following EPIGRAPH control macros may also be
+<a href="#grouping">grouped</a>
+using EPIGRAPH_STYLE.
</p>
<span class="pre defaults">
@@ -514,10 +575,7 @@ See
.EPIGRAPH_SIZE default = -1.5 (points)
.EPIGRAPH_COLOR default = black
.EPIGRAPH_AUTOLEAD default = 2 points
-
(The next two apply to “block” style epigraphs only)
-
-.EPIGRAPH_QUAD default = same as paragraphs
.EPIGRAPH_INDENT* (see Note on EPIGRAPH_INDENT, below)
*Indent here refers to the indent from both the left and right margins
@@ -679,8 +737,11 @@ and
The PP macro being so important, and representing, as it were, the
basis of everything that goes on in a document, its control is
managed in a manner somewhat different from other document element
-tags.
+tags. As a result, the control macros for PP may not be
+<a href="#grouping">grouped</a>
+within a <kbd>_STYLE</kbd> macro.
</p>
+
<ol style="margin-top: .5em; padding-bottom: .5em;">
<li><a href="#pp-family">Family control</a></li>
<li><a href="#pp-font">Font control</a></li>
@@ -1283,6 +1344,7 @@ which may be given in any order:
UNDERSCORE <weight> <gap> | NO_UNDERSCORE \
UNDERSCORE2 <weight> <gap1> <gap2> | NO_UNDERSCORE2 \
CAPS | NO_CAPS \
+ SMALLCAPS | NO_SMALLCAPS \
BASELINE_ADJUST <amount to raise heading from the baseline> \
SPACE_AFTER | NO_SPACE_AFTER \
NUMBER | NO_NUMBER
@@ -1961,9 +2023,6 @@ like this:
</p>
</div>
-
-
-
<div class="box-tip">
<h2 id="quote-spacing-notes" class="docs" style="padding-top: 9px; font-size:
100%;">Further notes on quote spacing</h2>
@@ -2068,10 +2127,10 @@ Macro: <b>QUOTE</b> <kbd class="macro-args">toggle</kbd>
</div>
<p>
-QUOTE is a toggle macro. To begin a section
-of quoted text, invoke it with no argument, then type in your
-quote. When you’re finished, invoke <kbd>.QUOTE</kbd> with any
-argument (eg <kbd>OFF, END, X, Q</kbd>...) to turn it off. Example:
+QUOTE is a toggle macro. To begin a section of quoted text, invoke
+it with no argument, then type in your quote. When you’re
+finished, invoke <kbd>.QUOTE</kbd> with any argument (eg <kbd>OFF,
+END, X, Q</kbd>...) to turn it off. Example:
<br/>
<span class="pre-in-pp">
.QUOTE
@@ -2085,6 +2144,7 @@ argument (eg <kbd>OFF, END, X, Q</kbd>...) to turn it
off. Example:
</p>
<div class="defaults-container" style="background-color: #ded4bd; border:
none;">
+
<h3 id="quote-control" class="docs defaults">QUOTE control macros and
defaults</h3>
<ol style="margin-top: .5em; padding-bottom: .5em;">
@@ -2100,7 +2160,17 @@ argument (eg <kbd>OFF, END, X, Q</kbd>...) to turn it
off. Example:
<p class="defaults" style="padding-top: 6px;">
See
<a href="#control-macro-args">Arguments to the control macros</a>.
+<br/>
+The following QUOTE control macros may also be
+<a href="#grouping">grouped</a>
+using QUOTE_STYLE. If you do so, <kbd>QUOTE_LEFT</kbd>,
<kbd>QUOTE_CENTER</kbd>,
+and <kbd>QUOTE_RIGHT</kbd> must be entered as:
+<br/>
+<kbd> QUAD LEFT</kbd><br/>
+<kbd> QUAD CENTER</kbd><br/>
+<kbd> QUAD RIGHT</kbd>
</p>
+
<span class="pre defaults">
.QUOTE_FAMILY default = prevailing document family; default is Times Roman
.QUOTE_FONT default = italic; underlined in TYPEWRITE
@@ -2108,6 +2178,9 @@ See
<a id="quote-autolead">.QUOTE_AUTOLEAD default = none; leading of quotes is
the same as paragraphs </a>
.QUOTE_COLOR default = black
.QUOTE_INDENT (see below, "Quote indent")
+.QUOTE_LEFT -+ Quad direction of quote.
+.QUOTE_CENTER | LEFT observes QUOTE_INDENT;
+.QUOTE_RIGHT -+ CENTER and RIGHT do not
</span>
</div>
@@ -2135,19 +2208,13 @@ and 1 (for
</p>
<div class="box-tip">
-<p class="tip-top">
+<p class="tip">
<span class="note">Note:</span>
If your PARA_INDENT is 0 (ie no indenting of the first line of
paragraphs), you <i>must</i> set a QUOTE_INDENT yourself, with a
unit of measure appended to the argument. Mom has no default for
QUOTE_INDENT if paragraph first lines are not being indented.
</p>
-
-<p class="tip-bottom">
-<span class="note">Additional note:</span>
-QUOTE_INDENT also sets the indent for
-<a href="#blockquote">blockquotes</a>.
-</p>
</div>
<h4 id="always-fullspace-quotes" class="docs" style="margin-top: -.25em;">2.
Spacing above and below quotes (typeset only)</h4>
@@ -2240,7 +2307,7 @@ to control it.)
</div>
<div class="box-macro-args">
-Macro: <b>BLOCKQUOTE</b> <kbd class="macro-args">toggle</kbd>
+Macro: <b>BLOCKQUOTE</b> <kbd class="macro-args"><toggle></kbd>
</div>
<p class="alias" style="margin-bottom: 0;">
@@ -2292,6 +2359,10 @@ tag, as well as in any of the control macros that begin
or end with
<p class="defaults" style="padding-top: 6px;">
See
<a href="#control-macro-args">Arguments to the control macros</a>.
+<br/>
+The following BLOCKQUOTE control macros may also be
+<a href="#grouping">grouped</a>
+using BLOCKQUOTE_STYLE.
</p>
<span class="pre defaults">
.BLOCKQUOTE_FAMILY default = prevailing document family; default is Times
Roman
@@ -2329,19 +2400,13 @@ and 1 (for
</p>
<div class="box-tip">
-<p class="tip-top">
+<p class="tip">
<span class="note">Note:</span>
If your PARA_INDENT is 0 (ie no indenting of the first line of
paragraphs), you <i>must</i> set a BLOCKQUOTE_INDENT yourself, with
a unit of measure appended to the argument. Mom has no default for
BLOCKQUOTE_INDENT if paragraph first lines are not being indented.
</p>
-
-<p class="tip-bottom">
-<span class="note">Additional note:</span>
-BLOCKQUOTE_INDENT also sets the indent for
-<a href="#quote">quotes</a>.
-</p>
</div>
@@ -2555,6 +2620,10 @@ still need to be introduced with <kbd>\&</kbd>, as in
this example:
<p class="defaults" style="padding-top: 6px;">
See
<a href="#control-macro-args">Arguments to the control macros</a>.
+<br/>
+The following CODE control macros may also be
+<a href="#grouping">grouped</a>
+using CODE_STYLE.
</p>
<span class="pre defaults">
.CODE_FAMILY default = Courier
@@ -2984,7 +3053,12 @@ but rather
<div class="defaults-container" style="background-color: #ded4bd; border:
none;">
<h3 id="list-control" class="docs defaults">LIST control macros and
defaults</h3>
-<ol style="margin-top: .5em; padding-bottom: .5em;">
+<p style="margin-top: 0; margin-left: .5em">
+LIST control macros may not be
+<a href="#grouping">grouped</a>.
+</p>
+
+<ol style="margin-top: -.5em; padding-left: 1.5em; padding-bottom: .5em;">
<li><a href="#shift-list">Indenting lists (SHIFT_LIST)</a></li>
<li><a href="#reset-list">Resetting an initialized list’s enumerator
(RESET_LIST)</a></li>
<li><a href="#pad-list-digits">Padding digit enumerators
(PAD_LIST_DIGITS)</a></li>
@@ -3426,8 +3500,9 @@ desired result.
<ol style="margin-top: .5em; padding-bottom: .5em;">
<li><a href="#number-lines-general">Family/font/size/colour</a></li>
+ <li><a href="#number-lines-per-section">Reset line numbering after
COLLATE</a></li>
<li><a href="#number-quote-lines">Line numbering control for quotes and
blockquotes</a>
- <ul>
+ <ul style="padding-left: 1em">
<li><a href="#number-quote-lines-global">Including QUOTEs and BLOCKQUOTEs
in the line numbering scheme</a></li>
<li><a href="#number-quote-lines-selective">Selectively enabling line
numbering for QUOTEs and BLOCKQUOTEs</a></li>
<li><a href="#number-quote-lines-gutter">Changing the line number gutter
for QUOTEs and BLOCKQUOTEs</a></li>
@@ -3442,6 +3517,10 @@ desired result.
<p class="defaults" style="padding-top: 6px;">
See
<a href="#control-macro-args">Arguments to the control macros</a>.
+<br/>
+The following NUMBER_LINES control macros may also be
+<a href="#grouping">grouped</a>
+using LINENUMBER_STYLE.
</p>
<span class="pre defaults">
.LINENUMBER_FAMILY default = prevailing family or document family; default is
Times Roman
@@ -3451,7 +3530,22 @@ See
</span>
</div>
-<h4 id="number-quote-lines" class="docs" style="margin-top: -1.75em;">2. Line
numbering control macros for QUOTE and BLOCKQUOTE</h4>
+<h4 id="number-lines-per-section" class="docs" style="margin-top: -1.75em;">2.
Reset line numbering after COLLATE</h4>
+
+<p>
+After
+<a href="rectoverso.html#collate">COLLATE</a>,
+line numbering continues from where it left off. If you would like
+each chapter or major document section to begin its line numbering
+at “1”, invoke
+<span class="pre-in-pp">
+ .NUMBER_LINES_PER_SECTION
+</span>
+after
+<a href="#number-lines"><kbd>.NUMBER_LINES</kbd></a>.
+</p>
+
+<h4 id="number-quote-lines" class="docs" style="margin-top: 0em;">3. Line
numbering control macros for QUOTE and BLOCKQUOTE</h4>
<h5 id="number-quote-lines-global" class="docs" style="font-size:
87%">• Including QUOTEs and BLOCKQUOTEs in the line numbering
scheme</h5>
@@ -4042,6 +4136,10 @@ should be entered normally.
<p class="defaults" style="padding-top: 6px;">
See
<a href="#control-macro-args">Arguments to the control macros</a>.
+<br/>
+The following FOOTNOTE control macros may also be
+<a href="#grouping">grouped</a>
+using FOOTNOTE_STYLE.
</p>
<span class="pre defaults">
.FOOTNOTE_FAMILY default = prevailing document family; default is Times
Roman
@@ -4772,7 +4870,6 @@ appearance of endnotes pages, set them up prior to
<ul style="margin-left: -.5em;">
<li><a href="#endnote-title">Document-identification string(s)</a></li>
<li><a href="#endnote-title-control">Document-identification string
control macros and defaults</a></li>
- <li><a href="#endnote-title-underscore">Document-identification string
underscoring</a></li>
</ul></li>
<li><a href="#endnotes-numbering"><b>Endnotes referencing style</b></a>
<ul style="margin-left: -.5em;">
@@ -4796,6 +4893,10 @@ appearance of endnotes pages, set them up prior to
<p class="defaults" style="padding-top: 6px;">
See
<a href="#control-macro-args">Arguments to the control macros</a>.
+<br/>
+The following ENDNOTE control macros may also be
+<a href="#grouping">grouped</a>
+using ENDNOTE_STYLE.
</p>
<span class="pre defaults">
.ENDNOTE_FAMILY default = prevailing document family; default is Times Roman
@@ -5282,7 +5383,16 @@ side—<kbd>""</kbd>—or no argument
at all).
<p class="defaults" style="padding-top: 6px;">
See
<a href="#control-macro-args">Arguments to the control macros</a>.
+<br/>
+The following ENDNOTES_HEADER control macros may also be
+<a href="#grouping">grouped</a>
+using ENDNOTES_HEADER_STYLE.
</p>
+
+<p style="margin-top: .5em; margin-bottom: 0; margin-left: .5em">
+Please note that “_HEADER_”, here, refers to the title
+that appears at the top of the first endnotes page, not to the page
+headers of subsequent endnotes pages.
<span class="pre defaults">
.ENDNOTES_HEADER_FAMILY default = prevailing document family
.ENDNOTES_HEADER_FONT default = bold
@@ -5292,6 +5402,7 @@ See
*Relative to the size of the endnotes text (set with ENDNOTE_PT_SIZE)
</span>
+</p>
</div>
<p style="margin-top: -2em">
@@ -5393,7 +5504,7 @@ Some examples:
- turn double-underscoring on; set the rule weight to 3/4 of
a point; set the gap between the title and the upper
underscore to 3 points; leave the gap between the upper
- and the lower underunderscore at the default
+ and the lower underscore at the default
.ENDNOTES_HEADER_UNDERSCORE DOUBLE 1.5 1.5p 1.5p
- turn double-underscoring on; set the rule weight to 1-1/2
@@ -5481,87 +5592,25 @@ included in the endnotes redundant.
<p class="defaults" style="padding-top: 6px;">
See
<a href="#control-macro-args">Arguments to the control macros</a>.
+<br/>
+The following ENDNOTE_TITLE_STYLE control macros may also be
+<a href="#grouping">grouped</a>
+using ENDNOTE_TITLE_STYLE_STYLE.
</p>
<span class="pre defaults">
-.ENDNOTE_TITLE_FAMILY default = prevailing document family; default is Times
Roman
-.ENDNOTE_TITLE_FONT default = bold
-.ENDNOTE_TITLE_SIZE* default = 0
-.ENDNOTE_TITLE_QUAD default = left
+.ENDNOTE_TITLE_FAMILY default = prevailing document family; default is Times
Roman
+.ENDNOTE_TITLE_FONT default = bold
+.ENDNOTE_TITLE_SIZE* default = 0
+.ENDNOTE_TITLE_COLOR default = black
+.ENDNOTE_TITLE_QUAD default = left
+.ENDNOTE_TITLE_CAPS
+.ENDNOTE_TITLE_SMALLCAPS
+.ENDNOTE_TITLE_UNDERSCORE default = single underscore
*Relative to the size of the endnotes text (set with ENDNOTE_PT_SIZE)
</span>
</div>
-<!-- -ENDNOTE_TITLE_UNDERLINE- -->
-
-<h5 id="endnote-title-underscore" class="docs" style="margin-top: -1.25em;
margin-bottom: .5em; margin-left: .5em;">• Endnotes
document-identification underscoring</h5>
-
-<div class="box-macro-args">
-Macro: <b>ENDNOTE_TITLE_UNDERSCORE</b> <kbd class="macro-args">[DOUBLE]
[<underline weight> [<underline gap> [<distance between double
rules]]] | <none> | <anything></kbd>
-</div>
-
-<p class="alias" style="margin-bottom: 0;">
-<i>Alias:</i> <b>ENDNOTE_TITLE_UNDERLINE</b>
-</p>
-
-<p class="requires">
-• The argument
-<span style="font-style: normal"><kbd><underscore weight></kbd></span>
-must not have the
-<a href="definitions.html#unitofmeasure">unit of measure</a>,
-<span style="font-style: normal;"><kbd>p</kbd></span>,
-appended to it; all other arguments require a unit of measure
-</p>
-
-<p>
-Invoked without an argument, <kbd>.ENDNOTE_TITLE_UNDERSCORE</kbd>
-will place a single rule underneath the document identification
-string. Invoked with the argument <kbd>DOUBLE</kbd>,
-ENDNOTE_TITLE_UNDERSCORE will double-underscore the string. Invoked
-with any other non-numeric argument, (eg <kbd>OFF, NO, X</kbd>,
-etc.) the macro disables underscoring of the string.
-</p>
-
-<p>
-In addition, you can use ENDNOTE_TITLE_UNDERSCORE to control the
-weight of the underscore rule(s), the gap between the title and the
-underscore, and, in the case of double-underscores, the distance
-between the two rules.
-</p>
-
-<p>
-Some examples:
-<br/>
-<span class="pre-in-pp">
- .ENDNOTE_TITLE_UNDERSCORE 1
- - turn underscoring on; set the rule weight to 1 point
-
- .ENDNOTE_TITLE_UNDERSCORE 1 3p
- - turn underscoring on; set the rule weight to 1 point; set
- the gap between the string and the underscore to 3 points
-
- .ENDNOTE_TITLE_UNDERSCORE DOUBLE .75 3p
- - turn double-underscoring on; set the rule weight to 3 points
-
- .ENDNOTE_TITLE_UNDERSCORE DOUBLE 1.5 1.5p 1.5p
- - turn double-underscoring on; set the rule weight to 1-1/2
- points; set the gap between the string and the upper
- underscore to 1-1/2 points; set the gap between the upper
- and the lower underscore to 1-1/2 points
-</span>
-</p>
-
-<p>
-Note, from the above, that in all instances, underscoring (single or
-double) is enabled whenever ENDNOTE_TITLE_UNDERSCORE is used in this
-way.
-</p>
-
-<p>
-Mom’s default is to single-underscore the string with a
-1/2-point rule placed 2 points below its baseline.
-</p>
-
<!-- -ENDNOTE_NUMBERING- -->
<h4 id="endnotes-numbering" class="docs" style="margin-top: -.25em;">6.
Endnotes referencing style</h4>
@@ -6236,11 +6285,12 @@ etc) exits the current margin note.
<ul style="margin-left: -.5em;">
<li><a href="#finis">Tag: FINIS</a></li>
- <li>FINIS control macros
+ <li><a href="#finis-control">FINIS control macros</a>
<ul style="margin-left: -1.25em;">
<li><a href="#finis-string">Changing the FINIS string</a></li>
<li><a href="#finis-string-caps">Automatic capitalization of the FINIS
string</a></li>
<li><a href="#finis-color">Changing the FINIS colour</a></li>
+ <li><a href="#finis-no-dashes">Removing the dashes around FINIS</a></li>
</ul></li>
</ul>
@@ -6312,7 +6362,15 @@ two lines of your document file, like this:
<h3 id="finis-control" class="docs" style="margin-bottom: -1em">Finis contol
macros</h3>
-<h4 id="finis-string" class="docs">Changing the FINIS string</h4>
+<p>
+Since FINIS is only used once in a document, it has few control
+macros. It is expected that you will make changes to style
+parameters such as family, font, and size with
+<a href="definitions.html#inlines">inline escapes</a>
+in the FINIS string itself (see below).
+</p>
+
+<h4 id="finis-string" class="docs" style="margin-top: -.5em">Changing the
FINIS string</h4>
<p>
By default, FINIS prints the word, END, between
@@ -6381,6 +6439,19 @@ new colour; the em-dashes will be in the default
document colour
(usually black).
</p>
+<!-- -FINIS DASHES- -->
+
+<h4 id="finis-no-dashes" class="docs">Removing the dashes around FINIS</h4>
+
+<p>
+If you don’t want the dashes around the FINIS string, you can
+remove them with
+<br/>
+<span class="pre-in-pp">
+ .FINIS_NO_DASHES
+</span>
+</p>
+
<div class="rule-long"><hr/></div>
<!-- Navigation links -->
diff --git a/contrib/mom/momdoc/docprocessing.html
b/contrib/mom/momdoc/docprocessing.html
index 7873885..60fe073 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-2014 Free Software Foundation, Inc.
+Copyright (C) 2004-2015 Free Software Foundation, Inc.
Written by Peter Schaffter (address@hidden).
Permission is granted to copy, distribute and/or modify this document
@@ -81,11 +81,24 @@ class="header-link" href="#setup">Preliminary document
setup</a></h3>
<li><a href="#printstyle">PRINTSTYLE</a></li>
<li><a href="#copystyle">COPYSTYLE</a></li>
</ul></li>
+ <li><a href="cover.html"><b>Cover pages</b></a>
+ <li><a href="#docheader"><b>Managing the document header</b></a>
+ <ul class="toc-docproc">
+ <li><a href="#docheader">DOCHEADER</a></li>
+ <li><a href="#docheader-control">Docheader control</a>
+ <ul class="toc-docproc">
+ <li><a href="#docheader-desc">Docheader description</a></li>
+ <li><a href="#index-docheader-control">Macro list</a></li>
+ </ul></li>
+ </ul></li>
</ul>
<h3 class="toc toc-docproc-header"><a class="header-link"
href="#start-macro">Initiate document processing</a></h3>
<ul class="toc-docproc" style="margin-top: .5em;">
<li><a href="#start"><b>The START macro</b></a></li>
</ul>
+</div>
+<div class="mini-toc-col-2">
+<br/>
<h3 class="toc toc-docproc-header"><a class="header-link"
href="#style-before-start">Establishing type and formatting<br/><span
style="display: block; margin-top: -.3em;">parameters before
START</span></a></h3>
<ul class="toc-docproc" style="margin-top: .5em;">
<li><a href="#type-before-start"><b>Behaviour of the typesetting macros
before START</b></a>
@@ -94,10 +107,7 @@ class="header-link" href="#setup">Preliminary document
setup</a></h3>
<li><a href="#color">Initializing colours</a></li>
</ul></li>
</ul>
-</div>
-<div class="mini-toc-col-2" style="margin-top: -1em;">
-<br/>
-<ul class="toc-docproc" style="margin-top: .5em;">
+<ul class="toc-docproc" style="margin-top: -1em">
<li><a href="#doc-lead-adjust"><b>Adjust linespacing to fill pages</b></a>
<ul class="toc-docproc">
<li><a href="#doc-lead-adjust">DOC_LEAD_ADJUST</a></li>
@@ -106,15 +116,6 @@ class="header-link" href="#setup">Preliminary document
setup</a></h3>
<li><a href="#automatic-shimming">Automatic shimming (headings,
etc)</a></li>
</ul></li>
</ul></li>
- <li><a href="#docheader"><b>Managing the document header</b></a>
- <ul class="toc-docproc">
- <li><a href="#docheader">DOCHEADER</a></li>
- <li><a href="#docheader-control">Docheader control</a>
- <ul class="toc-docproc">
- <li><a href="#docheader-desc">Docheader description</a></li>
- <li><a href="#index-docheader-control">Macro list</a></li>
- </ul></li>
- </ul></li>
<li><a href="#columns-intro"><b>Setting documents in columns</b></a>
<ul class="toc-docproc">
<li><a href="#columns">COLUMNS</a></li>
@@ -146,11 +147,11 @@ class="header-link" href="#setup">Preliminary document
setup</a></h3>
</ul></li>
</ul></li>
</ul>
-<h3 class="toc toc-docproc-header"><a class="header-link"
href="#terminating">Terminating a document</a></h3>
</div>
+<h3 style="margin-top: -.5em; text-align: center; text-transform: uppercase;
font-size: 95%;"><a class="header-link" href="#terminating">Terminating a
document</a></h3>
</div>
-<div class="rule-short"><br/><hr/></div>
+<div class="rule-short" style="margin-top: -1.75em"><br/><hr/></div>
<!-- ==================================================================== -->
@@ -832,7 +833,7 @@ the title of each article or entitled section), and appears
<p>
Moreover, DOCTITLE does not appear in the
-<a href="definitions.html#pdfoutline">PDF outline </a>,
+<a href="definitions.html#pdfoutline">PDF outline</a>,
as its presence in window title would make it redundant.
</p>
@@ -1255,7 +1256,7 @@ you must enclose the argument in double-quotes.
<p>
You may, if you wish, invoke <kbd>.REVISION</kbd> without an
argument, in which case, no revision number will be printed beside
-"Rev." in headers or footers.
+“Rev.” in headers or footers.
</p>
<!-- -REVISION_STRING- -->
@@ -1487,7 +1488,7 @@ Macro: <b>PDF_TITLE</b> <kbd
class="macro-args">"<pdf viewer window titl
<p>
Except for
-<a href="#doctitle">DOCTITLE</a>,
+<a href="#doc-title">DOCTITLE</a>,
mom does not, by default, provide PDF viewers with a document title.
You may set one, if you like, with PDF_TITLE.
</p>
@@ -1509,9 +1510,6 @@ and revision information in the headers) or a final copy.
<h3 id="index-docstyle" class="macro-list">Docstyle macros</h3>
<ul class="macro-list">
<li><a href="#doctype">DOCTYPE</a>
- <ul style="margin-left: -.5em; list-style-type: disc;">
- <li><a href="#doctype-underline">DOCTYPE_UNDERLINE</a> – how to
control DOCTYPE <kbd>NAMED</kbd> underlining</li>
- </ul></li>
<li><a href="#printstyle">PRINTSTYLE</a> – non-optional macro required
for document processing
<ul style="margin-left: -.5em; list-style-type: disc;">
<li><a href="#typeset-defaults">Defaults for PRINTSTYLE TYPESET</a></li>
@@ -1603,100 +1601,21 @@ as well as in page headers.
for how mom outputs each part of the page header.)
</p>
-<p>
-Additionally, if you wish the name of this particular kind of
-document to be coloured, you can pass DOCTYPE <kbd>NAMED</kbd> a
-third (optional) argument: the name of a colour pre-defined (or
-“initialized”) with
-<a href="color.html#newcolor">NEWCOLOR</a>
-or
-<a href="color.html#xcolor">XCOLOR</a>.
-For example, if you have a doctype named “Warning”,
-and you’d like “Warning” to be in red, assuming you’ve
-pre-defined (or “initialized”) the color, red, this is
-what the DOCTYPE entry would look like:
-<br/>
-<span class="pre">
- .DOCTYPE NAMED "Warning" red
-</span>
-</p>
-
-<div class="box-tip" style="margin-top: 1.5em;">
-<h3 id="doctype-underline" class="docs control">How to control DOCTYPE NAMED
underlining</h3>
-
-<p style="tip">
-By default, the string passed to DOCTYPE <kbd>NAMED</kbd> is
-underlined in the docheader, and on document-cover pages and cover
-(“title”) pages. (See the
-<a href="cover.html#intro">Introduction to covers</a>
-for the difference between “doc cover” and
-“cover” pages.)
-</p>
-
-<p>
-You can use the macro DOCTYPE_UNDERLINE to set the weight of
-the underline and its distance from where the doctype-name appears
-in the docheader (doc covers and covers handle underlining of the
-doctype-name differently; see
-<a href="cover.html#cover-underline">COVER_UNDERLINE</a>),
-or simply toggle doctype underlining on or off. Mom’s default
-is to underline the doctype-name.
-</p>
-
-<p>
-The order of arguments is <kbd>weight</kbd>, optionally followed by
-<kbd>gap</kbd>, where “gap” is the distance from the
-<a href="definitions.html#baseline">baseline</a>
-of the doctype-name to the underline.
-</p>
-
-<p>
-The <kbd>weight</kbd> argument is given in points, or fractions
-thereof, and must not have the
-<a href="definitions.html#unitofmeasure">unit of measure</a>,
-<kbd>p</kbd>, appended. Like
-<a href="inlines.html#rule-weight">RULE_WEIGHT</a>,
-weights must be greater than 0 and less than 100. Mom’s
-default for DOCTYPE <kbd>NAMED</kbd> underlining is 1/2 point.
-</p>
-
-<p>
-The <kbd>gap</kbd> argument can be given using any unit of measure,
-and must have the unit of measure appended to the argument.
-The distance of the gap is measured from the baseline of the
-DOCTYPE <kbd>NAMED</kbd> name to the upper edge of the underline.
-Mom’s default gap for named-doctype underlining is 2 points.
-</p>
-
-<p>
-As an example, suppose you want the doctype-name underlined in the
-docheader with a 2-point rule separated from the doctype-name by 3
-points. The way to accomplish it is:
-<br/>
-<span class="pre-in-pp">
- .DOCTYPE_UNDERLINE 2 3p
-</span>
-If you wanted the same thing, but were content with mom’s
-default gap of 2 points,
+<div class="box-tip">
+<p id="copystyle-note" class="tip">
+<span class="note">Note: version 2.1 change</span>
<br/>
-<span class="pre-in-pp">
- .DOCTYPE_UNDERLINE 2
-</span>
-would do the trick.
-</p>
-
-<p>
-If you merely want to toggle the underlining of
-the doctype-name in docheaders on or off, invoke
-<kbd>.DOCTYPE_UNDERLINE</kbd> by itself to turn the underlining on,
-or <kbd>.DOCTYPE_UNDERLINE OFF</kbd> (or NO, X, etc.)
-</p>
-
-<p class="tip-bottom">
-Please note that if you supply a weight to DOCTYPE_UNDERLINE, and
-optionally a gap, you also turn the underlining of the doctype-name
-in docheaders on; if this is not what you want, you must turn the
-underlining off manually afterwards.
+<kbd>DOCTYPE NAMED "string"</kbd> no longer accepts a color argument
+after <kbd>"string"</kbd>. Setting the color of the string is now
+done with <kbd>DOCTYPE_COLOR <color></kbd>. Default
+underscoring of <kbd>"string"</kbd> in the docheader and on covers
+has been removed. Use <kbd>DOCTYPE_UNDERLINE</kbd>,
+<kbd>DOC_COVER_DOCTYPE_UNDERLINE</kbd> and/or
+<kbd>COVER_DOCTYPE_UNDERLINE</kbd> to re-enable it. All three
+take the same arguments listed in the
+<a href="docelement.html#underline">Underline style, rule weight</a>
+section of
+<a href="docelement.html#control-macro-args">Arguments to the control
macros</a>.
</p>
</div>
@@ -2556,22 +2475,16 @@ edge of the paper to the
of the first line of type.
</p>
-<div class="box-tip">
-<p class="tip">
-<span class="tip">Tip:</span>
-Since no document processing happens until you invoke
-<a href="#start"><kbd>.START</kbd></a>—including
-anything to do with docheaders—you can
-typeset your own docheader prior to START (if
-you don’t like the way mom does things) and use
-<kbd>.DOCHEADER OFF</kbd> with its optional distance
-argument to ensure that the body of your document starts where
-you want. You can even insert a PDF or PostScript image file (see
-<a href="images.html#pspic">PSPIC</a>).
-and
-<a href="images.html#pdf-image">PDF_IMAGE</a>).
+<p>
+With <kbd>DOCHEADER OFF</kbd>, it is possible to create your own
+custom docheaders (after
+<a href="#start">START</a>)
+using mom’s typesetting macros. It is recommended that if you
+do create a custom docheader, you make
+<a href="docprocessing.html#shim"><kbd>.SHIM</kbd></a>
+the last macro before the first item of your document (for
+example, <kbd>.PP</kbd> or <kbd>.HEADING 1</kbd>. PP...)
</p>
-</div>
<!-- DOCHEADER CONTROL -->
@@ -2599,8 +2512,7 @@ A typeset docheader has the following characteristics:
by medium italic, same size as running text
Author(s) medium italic, same size as running text
-(Document type) bold italic, underscored, 3 points larger than running text
-
+(Document type) bold italic, 3 points larger than running text
</span>
</div>
@@ -2613,7 +2525,6 @@ is <kbd>CHAPTER</kbd>,
<span class="pre" style="color: #302419;">
Chapter <n> bold, 4 points larger than running text
Chapter Title bold italic, 4 points larger than running text
-
</span>
</div>
@@ -2624,7 +2535,6 @@ is the prevailing family of the whole document. Title,
subtitle,
author and document type are what you supply with the
<a href="#reference-macros">reference macros</a>.
Any you leave out will not appear; mom will compensate:
-
</p>
<div class="box-tip">
@@ -2633,44 +2543,48 @@ Any you leave out will not appear; mom will compensate:
If your DOCTYPE is <kbd>CHAPTER</kbd> and you have both “Chapter
<n>” and a “Chapter Title” (as above), mom
inserts a small amount of whitespace between them, equal to
-one-quarter of the <a href="definitions.html#leading">leading</a> in
-effect. If this doesn’t suit you, you can alter the space by
-including the
-<a href="definitions.html#inlines">inline escapes</a>,
-<a href="inlines.html#up"><kbd>\*[UP]</kbd></a>
-or
-<a href="inlines.html#down"><kbd>\*[DOWN]</kbd></a>,
-in the argument you pass to
-<a href="#chapter-title">CHAPTER_TITLE</a>,
-like this:
-<br/>
-<span class="pre-in-pp" style="margin-bottom: -1em;">
- .CHAPTER_TITLE "\*[DOWN 2p]Why Not Patent Calculus?"
-</span>
-or
-<span class="pre-in-pp" style="margin-top: -.5em;">
- .CHAPTER_TITLE "\*[UP 2p]Why Not Patent Calculus?"
-</span>
+one-quarter of the
+<a href="definitions.html#leading">leading</a>
+in effect. If this doesn’t suit you, you can remove or alter
+the space with
+<a href="#space-before">CHAPTER_TITLE_SPACE_BEFORE</a>.
</p>
</div>
<div class="macro-list-container">
<h3 id="index-docheader-control" class="macro-list">Docheader control</h3>
-<ol class="macro-list">
- <li><a href="#change-start">Change the starting position of the
docheader</a></li>
- <li><a href="#docheader-quad">Change quad direction the entire
docheader</a></li>
- <li><a href="#docheader-family">Change the family of the entire
docheader</a></li>
- <li><a href="#change-family">Change the family of individual docheader
elements</a></li>
- <li><a href="#change-font">Change the font of individual docheader
elements</a></li>
- <li><a href="#change-size">Adjust the size of docheader elements</a></li>
- <li><a href="#adjust-leading">Adjust the docheader leading</a></li>
- <li><a href="#docheader-color">Change the colour of the entire
docheader</a></li>
- <li><a href="#change-color">Change the colour of the individual docheader
elements</a></li>
- <li><a href="#change-attribute">Change the attribution string
(“by”)</a></li>
-</ol>
+
+<p style="margin-top: -1.5em; margin-left: .5em; margin-right: .5em">
+With the docheader control macros, you can change the family,
+colour, leading and quad direction of the entire docheader. You can
+also set the style parameters for each part individually. Style
+parameters include family, font, size, colour, lead, space before,
+caps, smallcaps and underscoring.
+</p>
+
+<ul class="macro-list" style="margin-top: -.5em">
+ <li><a href="#change-whole-docheader">1. Changes to the whole docheader</a>
+ <ul style="list-style-type: disc">
+ <li><a href="#change-start">Change the starting position of the
docheader</a></li>
+ <li><a href="#docheader-family">Change the family of the whole
docheader</a></li>
+ <li><a href="#docheader-color">Change the colour of the whole
docheader</a></li>
+ <li><a href="#docheader-lead">Change the leading of the whole
docheader</a></li>
+ <li><a href="#docheader-quad">Change the quad direction whole the
docheader</a></li>
+ </ul>
+ </li>
+ <li><a href="#part-by-part">2. Part by part changes</a>
+ <ul style="list-style-type: disc">
+ <li><a href="#list-of-params">List of parameters and arguments</a></li>
+ <li><a href="#grouping">Grouping part/parameter changes</a> – very
handy</li>
+ </ul>
+ </li>
+ <li><a href="#change-attribute">3. Changing or removing the attribution
string (“by”)</a></li>
+</ul>
</div>
-<h4 id="change-start" class="docs">1. Change the starting position of the
docheader</h4>
+<h4 id="change-whole-docheader" class="docs" style="font-size: 100%">1.
Changes to the whole docheader</h4>
+
+<h5 id="change-start" class="docs">Change the starting position of the
docheader</h5>
<p>
By default, a docheader starts on the same
@@ -2707,7 +2621,7 @@ to place them where you want.
</p>
</div>
-<h4 id="docheader-quad" class="docs">2. Change the quad direction of the
docheader</h4>
+<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
@@ -2718,7 +2632,7 @@ quad direction you want, either <kbd>LEFT</kbd> (or
<kbd>L</kbd>),
<kbd>C</kbd>).
</p>
-<h4 id="docheader-family" class="docs">3. Change the family of the entire
docheader</h4>
+<h5 id="docheader-family" class="docs">Change the family of the entire
docheader</h5>
<p>
By default, mom sets the docheader in the same
@@ -2743,186 +2657,199 @@ is how you’d do it.
<p>
Please note that if you use DOCHEADER_FAMILY, you can still alter
-the family of individual parts of the docheader with the macros
-listed
-<a href="#change-family">here</a>.
+the family of individual parts of the docheader.
</p>
-<h4 id="change-family" class="docs">4. Change the family of individual
docheader elements</h4>
-
-<p>
-The following macros let you change the
-<a href="definitions.html#family">family</a>
-of each docheader element separately:
-</p>
-<ul style="list-style-type: none; margin: -.5em;">
- <li>Macro: <b>TITLE_FAMILY</b> <kbd
class="macro-args"><family></kbd></li>
- <li>Macro: <b>CHAPTER_TITLE_FAMILY</b> <kbd
class="macro-args"><family></kbd></li>
- <li>Macro: <b>SUBTITLE_FAMILY</b> <kbd
class="macro-args"><family></kbd></li>
- <li>Macro: <b>AUTHOR_FAMILY</b> <kbd
class="macro-args"><family></kbd></li>
- <li>Macro: <b>DOCTYPE_FAMILY</b> <kbd class="macro-args"><family></kbd>
- (if <a href="#doctype">DOCTYPE</a> is <kbd>NAMED</kbd>)
- </li>
-</ul>
-
-<p>
-Simply pass the appropriate macro the family you want, just as you
-would with
-<a href="typesetting.html#family">FAMILY</a>.
-</p>
-
-<h4 id="change-font" class="docs">5. Change the font of individual docheader
elements</h4>
-
-<p>
-The following macros let you change the
-<a href="definitions.html#font">font</a>
-of each docheader element separately:
-</p>
-<ul style="list-style-type: none; margin: -.5em;">
- <li>Macro: <b>TITLE_FONT</b> <kbd class="macro-args">R | B | I |
BI</kbd></li>
- <li>Macro: <b>CHAPTER_TITLE_FONT</b> <kbd class="macro-args">R | B | I |
BI</kbd></li>
- <li>Macro: <b>SUBTITLE_FONT</b> <kbd class="macro-args">R | B | I |
BI</kbd></li>
- <li>Macro: <b>AUTHOR_FONT</b> <kbd class="macro-args">R | B | I |
BI</kbd></li>
- <li>Macro: <b>DOCTYPE_FONT</b> <kbd class="macro-args">R | B | I | BI</kbd>
- (if <a href="#doctype">DOCTYPE</a> is <kbd>NAMED</kbd>)
- </li>
-</ul>
+<h5 id="docheader-color" class="docs">Change the color of the entire
docheader</h5>
<p>
-Simply pass the appropriate macro the font you want. <kbd>R, B,
-I</kbd> and <kbd>BI</kbd> have the same meaning as they do for
-<a href="typesetting.html#font">FT</a>. You may also use any of the
-<a href="appendices.html#style-extensions">style extensions</a>
-provided by mom.
-</p>
-
-<h4 id="change-size" class="docs">6. Adjust the size of individual docheader
elements</h4>
-
-<p>
-The following macros let you adjust the point size of each docheader
-element separately.
-</p>
-
-<p>
-Mom calculates the point size of docheader elements from the point
-size of paragraphs in running text, so you must prepend a + or -
-sign to the argument. Points is assumed as the
-<a href="definitions.html#unitofmeasure">unit of measure</a>,
-so there’s no need to append a unit to the argument.
-Fractional point sizes are allowed.
+The default color for docheaders is black, as you’d expect.
+If you wish to change it, use
+<kbd>.DOCHEADER_COLOR <color></kbd>, where
+<kbd> <color></kbd> is a color pre-initialized with
+<a href="color.html#xcolor">XCOLOR</a>
+or
+<a href="color.html#newcolor">NEWCOLOR</a>.
</p>
-<ul style="list-style-type: none; margin: -.5em;">
- <li>Macro: <b>TITLE_SIZE</b> <kbd class="macro-args"><+/-points></kbd>
- <br/>
- default = +3.5 (+4 if docheader title is "Chapter
<n>")
- </li>
- <li>Macro: <b>CHAPTER_TITLE_SIZE</b> <kbd
class="macro-args"><+/-points></kbd>
- <br/>
- default = +4
- </li>
- <li>Macro: <b>SUBTITLE_SIZE</b> <kbd
class="macro-args"><+/-points></kbd>
- <br/>
- default = +0
- </li>
- <li>Macro: <b>AUTHOR_SIZE</b> <kbd class="macro-args"><+/-points></kbd>
- <br/>
- default = +0
- </li>
- <li>Macro: <b>DOCTYPE_SIZE</b> <kbd
class="macro-args"><+/-points></kbd>
- (if <a href="#doctype">DOCTYPE</a> is <kbd>NAMED</kbd>)
- <br/>
- default = +3
- </li>
-</ul>
+<h5 id="docheader-lead" class="docs">Change the leading of the entire
docheader</h5>
<p>
-Simply pass the appropriate macro the size adjustment you want.
+By default, mom uses the leading in effect for
+<a href="definitions.html#running">running text</a>
+for docheaders. If you want to increase or
+decrease the overall docheader leading, use
+<kbd>.DOCHEADER_LEAD +|-<amount></kbd>, where
+<kbd><amount></kbd> is the number of
+<a href="definitions.html#picaspoints">points</a>
+by which to make the adjustment.
</p>
-<h4 id="adjust-leading" class="docs">7. Adjust the docheader leading</h4>
+<h4 id="part-by-part" class="docs" style="font-size: 100%">2. Part by part
changes</h4>
<p>
-The
-<a href="definitions.html#leading">leading</a>
-of docheaders is the same as running text. If you’d like your
-docheaders to have a different leading, say, 2 points more than the
-lead of running text, use:
+Whenever you want to change the style parameters for any part of
+the docheader, simply join the name of the part to the parameter
+you wish to change using an underscore, then supply any necessary
+arguments. The subitle double-underlined? No problem.
<br/>
<span class="pre-in-pp">
- .DOCHEADER_LEAD +2
+ .SUBTITLE_UNDERLINE DOUBLE
</span>
-Since the leading of docheaders is calculated from the lead of running
-text, a + or - sign is required before the argument (how much to add
-or subtract from the lead of running text). No
-<a href="definitions.html#unitofmeasure">unit of measure</a>
-is required; points is assumed.
-</p>
-
-<h4 id="docheader-color" class="docs">8. Change the colour of the entire
docheader</h4>
-
-<p>
-If you want to colourize the entire docheader:
+Author in red?
<br/>
<span class="pre-in-pp">
- .DOCHEADER_COLOR <kbd class="macro-args"><color name></kbd>
+ .AUTHOR_COLOR red
+</span>
+Title in smallcaps?
+<span class="pre-in-pp">
+ .TITLE_SMALLCAPS
</span>
-You must pre-define (or “initialize”) the colour with
-<a href="color.html#newcolor">NEWCOLOR</a>
-or
-<a href="color.html#xcolor">XCOLOR</a>.
</p>
-
-<h4 id="change-color" class="docs">9. Change the colour of the docheader
elements individually</h4>
-
-<p>
-The following macros let you change the colour of each
-docheader element separately. You must pre-define (or
-“initialize”) the colour with
-<a href="color.html#newcolor">NEWCOLOR</a>
-or
-<a href="color.html#xcolor">XCOLOR</a>.
-</p>
-<ul style="list-style-type: none; margin: -.5em;">
- <li>Macro: <b>TITLE_COLOR</b> <kbd
class="macro-args"><colorname></kbd></li>
- <li>Macro: <b>CHAPTER_TITLE_COLOR</b> <kbd
class="macro-args"><colorname></kbd>
- <ul style="list-style-type: disc; margin-left: -.5em;">
- <li>Note: <b>CHAPTER_TITLE_COLOR</b> is needed only if you supply both a
- <a href="#chapter">CHAPTER</a>
- reference macro and a
- <a href="#chapter-title">CHAPTER_TITLE</a>
- macro. Otherwise, TITLE_COLOR takes care of colorizing the
- chapter header.
- </li>
- </ul></li>
- <li>Macro: <b>SUBTITLE_COLOR</b> <kbd
class="macro-args"><colorname></kbd></li>
- <li>Macro: <b>ATTRIBUTE_COLOR</b> <kbd
class="macro-args"><colorname></kbd>
- (the “by” string preceding author[s] name[s])
- </li>
- <li>Macro: <b>AUTHOR_COLOR</b> <kbd
class="macro-args"><colorname></kbd></li>
- <li>Macro: <b>DOCTYPE_COLOR</b> <kbd class="macro-args">
<colorname></kbd>
- (if <a href="#doctype">DOCTYPE</a> is <kbd>NAMED</kbd>)
- </li>
-</ul>
-
-<p>
-It is not recommended that you embed colour (with the
-<a href="definitions.html#inlines">inline escape</a>,
-<a href="color.html#color-inline"><kbd>\*[<colorname>]</kbd></a>)
-in the strings passed to TITLE, CHAPTER_TITLE, SUBTITLE, AUTHOR or
-the name you give DOCTYPE <kbd>NAMED</kbd>. The strings passed to
-these macros are used to generate page
-<a href="definitions.html#header">headers</a>
-and
-<a href="definitions.html#footer">footers</a>,
-with the result that an embedded colour will cause the string to be
-colourized in headers and/or footers as well. (If you want headers
-or footers colourized, or parts thereof, use the header/footer
-control macros.)
+<div class="box-tip" style="margin-top: -1em;">
+<p class="tip">
+<span class="note">Note:</span>
+Use <kbd>ATTRIBUTE</kbd> as the part name for the attribution string
+(“by”) that precedes the author, and <kbd>DOCTYPE</kbd>
+as the name for the string passed to <kbd>DOCTYPE NAMED "string"</kbd>.
+</p>
+</div>
+
+<h5 id="list-of-params" class="docs">List of parameters with arguments</h5>
+
+<dl>
+ <dt class="params">_FAMILY</dt>
+ <dd>
+ Takes the same argument as <a href="typesetting.html#family">FAMILY</a>.
+ </dd>
+ <dt class="params">_FONT</dt>
+ <dd>
+ Takes the same argument as <a href="typesetting.html#font">FT</a>.
+ </dd>
+ <dt class="params">_SIZE</dt>
+ <dd>
+ Takes a <kbd>+</kbd> or <kbd>-</kbd> value relative to the size of
+ <a href="definitions.html#running">running text</a>.
+ </dd>
+ <dt class="params">_COLOR</dt>
+ <dd>
+ Takes the same argument as <a href="color.html#color">COLOR</a>.
+ Colors should be pre-initialized with
+ <a href="color.html#xcolor">XCOLOR</a>
+ or
+ <a href="color.html#newcolor">NEWCOLOR</a>.
+ </dd>
+ <dt class="params">_LEAD</dt>
+ <dd>
+ Takes an absolute leading value, i.e. not relative to the
+ overall leading of the docheader. The leading applies to
+ multiple lines of type within the same docheader part, e.g.
+ several authors or a long title that must be split over two
+ lines. No
+ <a href="definitions.html#unitofmeasure">unit of measure</a>
+ is required;
+ <a href="definitions.html#picaspoints">points</a>
+ is assumed.
+ </dd>
+ <dt id="space-before" class="params">_SPACE_BEFORE</dt>
+ <dd>
+ Takes a numeric value with a
+ <a href="definitions.html#unitofmeasure">unit of measure</a>
+ appended to it. The value may be negative. This allows you
+ to adjust the whitespace before a docheader part, for example
+ if you want more whitespace between the title and the author.
+ <span style="display: block; margin-top: .5em">
+ Note that <kbd>TITLE</kbd> does not have a <kbd>_SPACE_BEFORE</kbd>
+ parameter; use
+ <a href="#change-start">DOCHEADER_ADVANCE</a>
+ to move the title further down on the page.
+ </span>
+ </dd>
+ <dt class="params">_CAPS</dt>
+ <dd>
+ Capitalizes the entire docheader part. No argument is
+ required.
+ </dd>
+ <dt class="params">_NO_CAPS</dt>
+ <dd>
+ Only used if you need to reverse the sense of <kbd>_CAPS</kbd>, as
+ can sometimes happen when
+ <a href="rectoverso.html#collate">collating</a>
+ documents that have differing docheader style requirements.
+ </dd>
+ <dt class="params">_SMALLCAPS</dt>
+ <dd>
+ Set the entire docheader part in smallcaps. No argument is
+ required.
+ </dd>
+ <dt class="params">_NO_SMALLCAPS</dt>
+ <dd>
+ Only used if you need to reverse the sense of
+ <kbd>_SMALLCAPS</kbd>, as can sometimes happen when
+ <a href="rectoverso.html#collate">collating</a>
+ documents that have differing docheader style requirements.
+ </dd>
+ <dt class="params">_UNDERSCORE</dt>
+ <dd>
+ With no argument, underscores the docheader part. With a
+ single, possibly decimal numeric argument, sets the weight of
+ the underscore. A second numeric argument to which a
+ <a href="definitions.html#unitofmeasure">unit of measure</a>
+ is appended (most likely <kbd>p</kbd>) sets the distance
+ between the baseline and the underscore.
+ <span style="display: block; margin-top: .5em">
+ If the argument <kbd>DOUBLE</kbd> is given, double underscores
+ the docheader part. With a single, possibly decimal numeric
+ argument afterwards, sets the weight of the underscore rules.
+ A third numeric argument to which a
+ <a href="definitions.html#unitofmeasure">unit of measure</a>
+ is appended (most likely <kbd>p</kbd>) sets the distance
+ between the baseline and the first underscore rule. A fourth
+ numeric argument to which a unit of measure is appended sets
+ the distance between the two underscore rules.
+ </span>
+ <span style="display: block; margin-top: .5em">
+ You may give <kbd>_UNDERLINE</kbd> as the parameter instead of
+ <kbd>_UNDERSCORE</kbd> if you prefer.
+ </span>
+ </dd>
+ <dt class="params">NO_UNDERSCORE</dt>
+ <dd>
+ Only used if you need to reverse the sense of
+ <kbd>_UNDERSCORE</kbd>, as can sometimes happen when
+ <a href="rectoverso.html#collate">collating</a>
+ documents that have differing docheader style requirements.
+ </dd>
+</dl>
+
+<h5 id="grouping" class="docs">Grouping part/parameter changes</h5>
+
+<p>
+If you want to change several parameters for a particular docheader
+part, you may group the changes together in a single macro by
+joining the name of the part to <kbd>STYLE</kbd> with an underscore,
+for example <kbd>TITLE_STYLE</kbd> or <kbd>AUTHOR_STYLE</kbd>.
+The following demonstrates:
+<span class="pre-in-pp">
+ .CHAPTER_TITLE_STYLE \
+ FAMILY T \
+ SIZE +4 \
+ UNDERSCORE 2 \
+ SMALLCAPS
+</span>
+Notice the use of the backslash character, which is required after
+the macro name and all parameters except the last. Grouping reduces
+clutter and the finger fatigue caused by entering
+<span class="pre-in-pp">
+ .CHAPTER_TITLE_FAMILY T
+ .CHAPTER_TITLE_SIZE +4
+ .CHAPTER_TITLE_UNDERSCORE 2
+ .CHAPTER_TITLE_SMALLCAPS
+</span>
</p>
-<h4 id="change-attribute" class="docs">10. Change the attribution string
(“by”)</h4>
+<h4 id="change-attribute" class="docs" style="font-size: 100%">3. Changing or
removing the attribution string (“by”)</h4>
<p>
If you’re not writing in English, you can change what mom
@@ -2933,7 +2860,7 @@ prints where “by” appears in docheaders. For
example,
</span>
changes “by” to “par”. ATTRIBUTE_STRING
can also be used, for example, to make the attribution read
-"Edited by".
+“Edited by”.
</p>
<p>
@@ -2978,24 +2905,6 @@ doc cover pages, cover pages, or the first-page
docheader,
arguments, is sufficient.
</p>
-<div class="box-tip">
-<p class="tip">
-<span class="note">Note:</span>
-The type specs for the attribution line in docheaders are the
-same as for the author line. Although it’s highly unlikely
-you’ll want the attribution line in a different family, font,
-or point size, you can make such changes using
-<a href="definitions.html#inlines">inline escapes</a>
-in the argument to ATTRIBUTE_STRING. For example,
-<br/>
-<span class="pre-in-pp">
- .ATTRIBUTE_STRING "\f[HBI]\*[SIZE -2p] by \*[SIZE +2p]\*[PREV]"
-</span>
-would set “by” in Helvetica bold italic, 2 points
-smaller than normal.
-</p>
-</div>
-
<div class="rule-short"><hr/></div>
<!-- -COLUMNS- -->
@@ -3151,7 +3060,7 @@ Macro: <b>COL_NEXT</b>
it left (assuming the type is justified or quad left), and moves over
to the top of the next column. If the column happens to be the last
(rightmost) one on the page, mom starts a new page
-at the "column 1" position. This is the macro to use when
+at the “column 1” position. This is the macro to use when
you want to start a new column after the end of a paragraph.
</p>
@@ -3313,12 +3222,12 @@ the tops of pages after the first.)
element tag is entered, the font reverts
to the current default for the new tag.
- N.B. — \•[SLANT] and \•[BOLDER] affect
+ N.B. — \*[SLANT] and \*[BOLDER] affect
paragraph text, and remain in effect for all
paragraphs until turned off. If you want to
use them in a macro that takes a string
argument, include the escape in the string.
- \•[COND] and \•[EXT] behave similarly.
+ \*[COND] and \*[EXT] behave similarly.
PT_SIZE •Changes point size for the duration of the
current tag only. As soon as another document
@@ -3340,9 +3249,7 @@ the tops of pages after the first.)
track when you’re ready to return to the
document’s default leading.
-
-<a id="autolead"></a>
- AUTOLEAD •Invoked before START, sets the overall document
+ <a id="autolead" style="margin-top: -1em">AUTOLEAD</a> •Invoked
before START, sets the overall document
leading as a function of the overall document
point size (ie the point size used in paragraphs);
subsequently disabled after START, except for calls
@@ -3822,9 +3729,6 @@ a document.
</p>
</div>
-
-<div class="rule-long"><hr/></div>
-
<!-- Navigation links -->
<table style="width: 100%; margin-top: 12px;">
<tr>
diff --git a/contrib/mom/momdoc/goodies.html b/contrib/mom/momdoc/goodies.html
index 4ac405a..13c9c77 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-2014 Free Software Foundation, Inc.
+Copyright (C) 2004-2015 Free Software Foundation, Inc.
Written by Peter Schaffter (address@hidden).
Permission is granted to copy, distribute and/or modify this document
@@ -510,6 +510,21 @@ The above produces, on output
</span>
</p>
+<div class="box-tip">
+<p class="tip">
+<span class="note">Note:</span>
+<kbd>\*[LC]</kbd> must come after a terminating period.
+<br/>
+<span class="pre-in-pp">
+ \*[UC]All work and no play makes Jack a dull boy.\*[LC]
+</span>
+not
+<span class="pre-in-pp">
+ \*[UC]All work and no play makes Jack a dull boy\*[LC].
+</span>
+</p>
+</div>
+
<!-- -STRING- -->
<div class="macro-id-overline">
@@ -1433,7 +1448,7 @@ above the baseline. If you’re not happy with this
default,
you can change it by invoking SUPERSCRIPT_RAISE_AMOUNT with the
amount you want them raised. A
<a href="definitions.html#unitofmeasure">unit of measure</a>
-must be appended directly to the amount. Thus, you want
+must be appended directly to the amount. Thus, if you want
superscripts raised by 3
<a href="definitions.html#picaspoints">points</a>
instead of 1/3 em, you’d do
diff --git a/contrib/mom/momdoc/graphical.html
b/contrib/mom/momdoc/graphical.html
index 61b7fcb..6d7bdb1 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-2014 Free Software Foundation, Inc.
+Copyright (C) 2004-2015 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 3ed822e..c310e29 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-2014 Free Software Foundation, Inc.
+Copyright (C) 2004-2015 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 fdff0c0..39cd23a 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-2014 Free Software Foundation, Inc.
+Copyright (C) 2004-2015 Free Software Foundation, Inc.
Written by Peter Schaffter (address@hidden).
Permission is granted to copy, distribute and/or modify this document
@@ -789,7 +789,7 @@ If you use <kbd>.TS</kbd> without the <kbd>H</kbd> argument
(and
therefore no <kbd>.TH</kbd>), tables that fit on the page are output
in position. If there is not enough room to output the table,
<kbd>tbl</kbd> will abort with message instructing you to use
-<kbd>.TS H/.TH</kbd>. Given that <kbd>.TS</kbd> without <kbd>TH</kbd>
+<kbd>.TS H/.TH</kbd>. Given that <kbd>.TS</kbd> without <kbd>H</kbd>
may sometimes fail, it is advisable to begin all <b>tbl</b> blocks
with <kbd>.TS H</kbd>.
</p>
diff --git a/contrib/mom/momdoc/inlines.html b/contrib/mom/momdoc/inlines.html
index c93c54d..a377069 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-2014 Free Software Foundation, Inc.
+Copyright (C) 2004-2015 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 bab0be5..ee17d88 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-2014 Free Software Foundation, Inc.
+Copyright (C) 2004-2015 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 c33c58d..885c74d 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-2014 Free Software Foundation, Inc.
+Copyright (C) 2004-2015 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 eea7438..c9648a9 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-2014 Free Software Foundation, Inc.
+Copyright (C) 2004-2015 Free Software Foundation, Inc.
Written by Peter Schaffter (address@hidden).
Permission is granted to copy, distribute and/or modify this document
@@ -68,6 +68,7 @@ elsewhere in the documentation.
<li><a href="#qr-14">Nested lists</a></li>
<li><a href="#qr-15">Colour</a></li>
<li><a href="#qr-16">Dropcaps</a></li>
+ <li><a href="#qr-56">Smallcaps</a></li>
<li><a href="#qr-17">Utilities</a></li>
<li><a href="#qr-18">Graphical objects and images</a></li>
</ul>
@@ -512,6 +513,19 @@ elsewhere in the documentation.
<table class="quick-ref">
<tr>
+<th id="qr-56" class="quick-ref" colspan="2" >+++ Smallcaps</th>
+</tr>
+<tr>
+<td><a href="typesetting.html#smallcaps">SMALLCAPS</a></td>
+</tr>
+<tr>
+<td><a href="typesetting.html#smallcaps-style">SMALLCAPS_STYLE</a></td>
+</tr>
+</table>
+
+
+<table class="quick-ref">
+<tr>
<th id="qr-17" class="quick-ref" colspan="2" >+++ Utilities</th>
</tr>
<tr>
@@ -666,6 +680,9 @@ elsewhere in the documentation.
<tr>
<td><a
href="docelement.html#number-blockquote-lines">NUMBER_BLOCKQUOTE_LINES</a></td><td>--
numbering of BLOCKQUOTE lines on/off</td>
</tr>
+<tr>
+<td><a href="docelement.html#number-lines-control">Control
macros</a></td><td>-- numbering of BLOCKQUOTE lines on/off</td>
+</tr>
</table>
<table class="quick-ref">
@@ -1271,10 +1288,10 @@ elsewhere in the documentation.
<th id="qr-46" class="quick-ref" colspan="2" >+++ Pagination</th>
</tr>
<tr>
-<td><a href="headfootpage.html#index-pagination">PAGINATE</a></td><td>--
pagination on/off</td>
+<td><a href="headfootpage.html#paginate">PAGINATE</a></td><td>-- pagination
on/off</td>
</tr>
<tr>
-<td><a href="headfootpage.html#index-pagination-control">Control
macros</a></td><td>-- change default style for pagination</td>
+<td><a href="headfootpage.html#index-paginate-control">Control
macros</a></td><td>-- change default style for pagination</td>
</tr>
<tr>
<td><a href="headfootpage.html#pagenumber"> PAGENUMBER</a></td><td>--
user-defined (starting) page number</td>
@@ -1307,6 +1324,18 @@ elsewhere in the documentation.
<td><a href="cover.html#on-off">DOC_COVERS</a></td><td>-- printing of document
covers on/off</td>
</tr>
<tr>
+<td><a href="cover.html#covertext">DOC_COVERTEXT</a></td><td>-- printing of
document covers on/off</td>
+</tr>
+<tr>
+<td><a href="cover.html#covertext">COVERTEXT</a></td><td>-- printing of
document covers on/off</td>
+</tr>
+<tr>
+<td><a href="cover.html#coverimage">DOC_COVER_IMAGE</a></td><td>-- printing of
document covers on/off</td>
+</tr>
+<tr>
+<td><a href="cover.html#coverimage">COVER_IMAGE</a></td><td>-- printing of
document covers on/off</td>
+</tr>
+<tr>
<td><a href="cover.html#cover-control">Control macros</a></td><td>-- change
style defaults for covers</td>
</tr>
</table>
diff --git a/contrib/mom/momdoc/rectoverso.html
b/contrib/mom/momdoc/rectoverso.html
index 4a884bb..4e83a6f 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-2014 Free Software Foundation, Inc.
+Copyright (C) 2004-2015 Free Software Foundation, Inc.
Written by Peter Schaffter (address@hidden).
Permission is granted to copy, distribute and/or modify this document
@@ -264,9 +264,6 @@ this:
.CHAPTER 17
.START
</span>
-</p>
-
-<p>
A slightly more complex version of the same thing, for chapters
that require their own titles, looks like this:
<br/>
@@ -277,7 +274,7 @@ that require their own titles, looks like this:
</span>
</p>
-<div class="box-tip">
+<div class="box-tip" style="margin-top: -1em">
<p class="tip">
<span class="tip">Tip:</span>
If the last line of text before <kbd>.COLLATE</kbd>
diff --git a/contrib/mom/momdoc/refer.html b/contrib/mom/momdoc/refer.html
index e18681e..9f43db5 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-2014 Free Software Foundation, Inc.
+Copyright (C) 2004-2015 Free Software Foundation, Inc.
Written by Peter Schaffter (address@hidden).
Permission is granted to copy, distribute and/or modify this document
@@ -1929,6 +1929,9 @@ BIBLIOGRAPHY_ALLOWS_FOOTERS OFF.
<div class="box-macro-args">
Macro: <b>BIBLIOGRAPHY_STRING</b> <kbd class="macro-args">"<title to
print at the top of bibliography pages>"</kbd>
</div>
+<p class="alias" style="margin-bottom: 0;">
+<i>Alias:</i> <b>BIBLIOGRAPHY_HEADER</b>
+</p>
<p>
By default, mom prints the word “BIBLIOGRAPHY” as a title
diff --git a/contrib/mom/momdoc/reserved.html b/contrib/mom/momdoc/reserved.html
index 7740f77..1260ce4 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-2014 Free Software Foundation, Inc.
+Copyright (C) 2004-2015 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 9ff4050..d3df7b6 100644
--- a/contrib/mom/momdoc/stylesheet.css
+++ b/contrib/mom/momdoc/stylesheet.css
@@ -1,4 +1,4 @@
-/* Copyright (C) 2004-2014 Free Software Foundation, Inc. */
+/* Copyright (C) 2004-2015 Free Software Foundation, Inc. */
/* This file is part of mom, which is part of groff, a free software */
/* project. */
@@ -673,3 +673,14 @@ span.book-title
font-style: italic ;
}
+dt.params
+{
+ font-style: normal ;
+ font-weight: bold ;
+}
+
+dd.cover-args
+{
+ margin-bottom: .25em;
+ margin-left: 1.25em ;
+}
diff --git a/contrib/mom/momdoc/tables-of-contents.html
b/contrib/mom/momdoc/tables-of-contents.html
index 8683e81..de98f67 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-2014 Free Software Foundation, Inc.
+Copyright (C) 2004-2015 Free Software Foundation, Inc.
Written by Peter Schaffter (address@hidden).
Permission is granted to copy, distribute and/or modify this document
@@ -344,10 +344,10 @@ themselves (overall family, headers/footers, pagination,
etc).
</ul></li>
<li><a href="#toc-header">Header string (eg “Contents”) and
style</a>
<ul style="margin-left: -.5em;">
- <li><a href="#toc-header-string">Changing the header string</a>
- <ul style="margin-left: -.5em;">
- <li><a href="#toc-header-style">Header string control macros and
defaults</a></li>
- </ul></li>
+ <li><a href="#toc-header-string">Changing the header string</a></li>
+ <li><a href="#toc-header-v-pos">Header string vertical placement</a></li>
+ <li><a href="#toc-header-style">Header string control macros and
defaults</a></li>
+ </li>
</ul></li>
<li><a href="#toc-style">Entries and reference page number style</a>
<ul style="margin-left: -.5em;">
@@ -580,7 +580,7 @@ example
</span>
</p>
-<h5 id="toc-header-style" class="docs" style="margin-top: 1em; text-transform:
none;">Header string vertical placement</h5>
+<h5 id="toc-header-v-pos" class="docs" style="margin-top: 1em; text-transform:
none;">Header string vertical placement</h5>
<div id="toc-header-v-pos" class="box-macro-args" style="margin-top: 1em">
Macro: <b>TOC_HEADER_V_POS</b> <kbd class="macro-args"><distance from top
of page></kbd>
@@ -606,6 +606,10 @@ If you’d like it to fall at a different position,
say 2 inches, use
<p class="defaults" style="padding-top: 6px;">
See
<a href="docelement.html#control-macro-args">Arguments to the control
macros</a>.
+<br/>
+The following TOC_HEADER control macros may also be
+<a href="#grouping">grouped</a>
+using TOC_HEADER_STYLE.
</p>
<span class="pre defaults">
.TOC_HEADER_FAMILY default = prevailing doc family
@@ -613,99 +617,12 @@ See
.TOC_HEADER_SIZE default = +4
.TOC_HEADER_QUAD default = left
.TOC_HEADER_COLOR default = black
+.TOC_HEADER_CAPS default = no
+.TOC_HEADER_SMALLCAPS default = no
+.TOC_HEADER_UNDERSCORE default = none
</span>
</div>
-<!-- -TOC_HEADER_CAPS- -->
-
-<h5 id="toc-header-caps" class="docs" style="margin-top: -1.5em;
margin-bottom: .5em; margin-left: .5em;">• Header (first-page title)
capitalization</h5>
-
-<div class="box-macro-args">
-Macro: <b>TOC_HEADER_CAPS</b> <kbd class="macro-args">toggle</kbd>
-</div>
-
-<p>
-Invoked by itself, <kbd>.TOC_HEADER_CAPS</kbd> will automatically
-capitalize the the table of contents first-page title. Invoked with
-any other argument, the macro disables automatic capitalization of
-the title.
-</p>
-
-<p>
-You may want the table of contents first-page title to be in caps,
-but the title in subsequent page headers to be in caps/lower case.
-If the argument to
-<kbd><a href="#endnotes-header-string">TOC_HEADER_STRING</a></kbd>
-is in caps/lower case and TOC_HEADER_CAPS is on, this is exactly
-what will happen.
-</p>
-
-<p>
-Mom’s default is not to capitalize the table of contents
-first-page title string.
-</p>
-
-<!--- TOC_HEADER_UNDERSCORE- -->
-
-<h5 id="toc-header-underscore" class="docs" style="margin-top: -.25em;
margin-bottom: .5em; margin-left: .5em;">• Header (first-page title)
underscoring</h5>
-
-<div class="box-macro-args">
-Macro: <b>TOC_HEADER_UNDERSCORE</b> <kbd class="macro-args">[DOUBLE]
[<underscore weight> [<underscore gap> [<distance between double
rules]]] | <none> | <anything></kbd>
-</div>
-
-<p class="requires">
-• The argument
-<span style="font-style: normal"><kbd><underscore weight></kbd></span>
-must not have the
-<a href="definitions.html#unitofmeasure">unit of measure</a>,
-<span style="font-style: normal;"><kbd>p</kbd></span>,
-appended to it; all other arguments require a unit of measure
-</p>
-
-<p>
-Invoked without an argument, <kbd>.TOC_HEADER_UNDERSCORE</kbd>
-will place a single rule underneath the table of contents
-first-page title. Invoked with the argument, <kbd>DOUBLE</kbd>,
-TOC_HEADER_UNDERSCORE will double-underscore the title. Invoked
-with any other non-numeric argument, (eg <kbd>OFF, NO, X</kbd>,
-etc.) the macro disables underscoring of the title.
-</p>
-
-<p>
-In addition, you can use TOC_HEADER_UNDERSCORE to control the
-weight of the underscore rule(s), the gap between the title and the
-underscore, and, in the case of double-underscores, the distance
-between the two rules.
-</p>
-
-<p>
-Some examples:
-<br/>
-<span class="pre-in-pp">
- .TOC_HEADER_UNDERSCORE 1
- - turn underscoring on; set the rule weight to 1 point
-
- .TOC_HEADER_UNDERSCORE 1 3p
- - turn underscoring on; set the rule weight to 1 point; set
- the gap between the title and the underscore to 3 points
-
- .TOC_HEADER_UNDERSCORE DOUBLE .75 3p
- - turn double-underscoring on; set the rule weight to 3/4 of
- a point; set the gap between the title and the upper
- underscore to 3 points; leave the gap between the upper
- and the lower underunderscore at the default
-
- .TOC_HEADER_UNDERSCORE DOUBLE 1.5 1.5p 1.5p
- - turn double-underscoring on; set the rule weight to 1-1/2
- points; set the gap between the title and the upper
- underscore to 1-1/2 points; set the gap between the upper
- and the lower underscore to 1-1/2 points
-</span>
-Note, from the above, that in all instances, underscoring (single
-or double) is enabled whenever TOC_HEADER_UNDERSCORE is used in
-this way.
-</p>
-
<h4 id="toc-style" class="docs" style="margin-top: -.5em;">4. Entries and
reference page numbers style</h4>
<p>
diff --git a/contrib/mom/momdoc/toc.html b/contrib/mom/momdoc/toc.html
index b01b891..077e12c 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-2014 Free Software Foundation, Inc.
+Copyright (C) 2004-2015 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.1-c_2 -- Table of Contents</title>
+ <title>Mom, version 2.1 -- 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.1-c_2
+ mom, version 2.1
</div>
<h1 class="toc" style="margin-top: 9px;">Table of Contents</h1>
diff --git a/contrib/mom/momdoc/typesetting.html
b/contrib/mom/momdoc/typesetting.html
index 3a8722a..4b3f3d3 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-2014 Free Software Foundation, Inc.
+Copyright (C) 2004-2015 Free Software Foundation, Inc.
Written by Peter Schaffter (address@hidden).
Permission is granted to copy, distribute and/or modify this document
@@ -2590,6 +2590,11 @@ large patches of type in a faked font look
typographically cheap.
<li><a href="#extend">EXTEND</a> – percentage for pseudo-extended
type</li>
<li><a href="#ext-inline">\*[EXT]</a> – inline escape for
pseudo-extending</li>
</ul></li>
+ <li>Smallcaps
+ <ul style="list-style: none; margin-left: -1em;">
+ <li><a href="#smallcaps">SMALLCAPS</a> – enable smallcaps</li>
+ <li><a href="#smallcaps-style">SMALLCAPS_STYLE</a> – size, weight,
and width of smallcaps</li>
+ </ul></li>
</ul>
</div>
@@ -2933,10 +2938,7 @@ embedded in text lines, like this:
</span>
<kbd>\*[EXT]</kbd> remains in effect until you turn it off with
<kbd>\*[EXTX]</kbd>.
-</p>
-
-<div class="box-important">
-<p class="tip">
+</p> <div class="box-important"> <p class="tip">
<span class="important">IMPORTANT:</span> You must turn
<kbd>\*[EXT]</kbd> off before making any changes to the point size
of your type, either via the
@@ -2958,6 +2960,108 @@ mom ignores <kbd>\*[EXT]</kbd> requests.
</p>
</div>
+<!-- SMALLCAPS -->
+
+<div class="macro-id-overline">
+<h3 id="smallcaps" class="macro-id">Smallcaps</h3>
+</div>
+
+<div class="box-macro-args">
+Macro: <b>SMALLCAPS</b> <kbd class="macro-args"><toggle></kbd>
+</div>
+
+<p>
+To begin setting type in pseudo-smallcaps, simply invoke
+<kbd>.SMALLCAPS</kbd>. When you no longer want them, invoke
+<kbd>SMALLCAPS OFF</kbd> (or <kbd>END</kbd>, <kbd>STOP</kbd>,
+<kbd>DONE</kbd>, etc). If you are currently in a
+<a href="definitions.html#filled">no-fill mode</a>,
+(i.e. <kbd>.LEFT</kbd>, <kbd>.CENTER</kbd>, or <kbd>.RIGHT</kbd>)
+and you want the smallcaps to continue on the same line,
+append a <kbd>\c</kbd> to the line, like this
+<br/>
+<span class="pre-in-pp">
+ A line of type\c
+ .SMALLCAPS
+ with a few words in smallcaps.
+ .SMALLCAPS OFF
+</span>
+The line preceding <kbd>.SMALLCAPS OFF</kbd> should also have a
+<kbd>\c</kbd> appended to it if you wish it to continue unbroken.
+</p>
+
+<div class="box-tip">
+<p class="tip-top">
+<span class="note">Note:</span>
+SMALLCAPS does not have an inline equivalent to
+<a href="inlines.html#uc-lc"><kbd>\*[UC]</kbd> / <kbd>\*[LC]</kbd></a>.
+Furthermore, if you’re using the
+<a href="docprocessing.html#docprocessing">document processing macros</a>
+with
+<a href="docprocessing.html#printstyle">PRINTSTYLE TYPEWRITE</a>,
+mom ignores SMALLCAPS.
+</p>
+
+<p class="tip-bottom">
+Additionally, be aware that no automatic
+<a href="definitions.html#kern">kerning</a>
+takes place while pseudo-smallcaps are in effect.
+</p>
+</div>
+
+<div class="macro-id-overline">
+<h3 id="smallcaps-style" class="macro-id">Set size, weight, and width of
smallcaps</h3>
+</div>
+
+<div class="box-macro-args">
+Macro: <b>SMALLCAPS_STYLE</b> <kbd class="macro-args">SIZE <percentage>
WEIGHT_ADJ <percentage> EXTEND <percentage></kbd>
+</div>
+
+<p>
+True smallcaps are not a font effect, but, like designer cuts of
+bold, condensed, and extended, actual fonts provided with some
+families. It is highly recommended that you acquire real smallcaps
+fonts rather than relying on mom's pseudo version.
+</p>
+
+<p>
+To achieve a reasonable facsimile of designer-cut small fonts, mom
+needs to know the percentage of regular caps at a given point size
+by which to reduce the small caps. To make adjustments for the
+difference in weight and width of the smaller caps, she also needs
+to know by how much to embolden (“fatten”) the
+smallcaps, and by how much to increase their width.
+</p>
+
+<p>
+All three arguments to SMALLCAPS_STYLE reflect a
+percentage of the point size in effect when
+<a href="#smallcaps">SMALLCAPS</a>
+is invoked. Mom’s defaults for pseudo-smallcaps are:
+<br/>
+<span class="pre-in-pp">
+ SIZE = 74%
+ WEIGHT_ADJ = .3%
+ EXTEND = 5%
+</span>
+To change any or all of the defaults, you might enter
+<br/>
+<span class="pre-in-pp">
+ .SMALLCAPS_STYLE SIZE 80 WEIGHT_ADJ .25 EXTEND 3
+</span>
+or, more readably,
+<br/>
+<span class="pre-in-pp">
+ .SMALLCAPS_STYLE
+ SIZE 80 \
+ WEIGHT_ADJ .25 \
+ EXTEND 3
+</span>
+Note that you do not have to give SMALLCAPS_STYLE all three
+arguments, and that the arguments may be entered in any order. Any
+arguments you omit will remain at their former value.
+</p>
+
<div class="rule-short" style="margin-bottom: 24px;"><hr/></div>
<!-- ==================================================================== -->
diff --git a/contrib/mom/momdoc/using.html b/contrib/mom/momdoc/using.html
index 341efcd..167410a 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-2014 Free Software Foundation, Inc.
+Copyright (C) 2004-2015 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 ce50adc..e1f52c7 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-2014 Free Software Foundation, Inc.
+Copyright (C) 2004-2015 Free Software Foundation, Inc.
Written by Peter Schaffter (address@hidden).
Permission is granted to copy, distribute and/or modify this document
@@ -54,8 +54,9 @@ FDL in the main directory of the groff source package.
<li><a href="#headings">2.3 Headings</a></li>
<li><a href="#margin-notes">2.4 Margin notes</a></li>
<li><a href="#floats">2.5 Floats</a></li>
- <li><a href="#table-of-contents">2.5 Table of contents</a></li>
+ <li><a href="#table-of-contents">2.5 Tables of contents</a></li>
</ul></li>
+ <li><a href="#v2.1-changes">Version 2.1 changes</a></li>
<li><a href="#pdfmom">The <strong>pdfmom</strong> wrapper around
groff</a></li>
<li><a href="#install-font">The <strong>install-font.sh</strong>
script</a></li>
</ol>
@@ -276,7 +277,7 @@ top of the next page. An <kbd>ADJUST</kbd> argument to
FLOAT allows
for optical centering.
</p>
-<h3 id="table-of-contents" class="docs">2.6. Table of contents</h3>
+<h3 id="table-of-contents" class="docs">2.6. Tables of contents</h3>
<p>
The default look of the Table of Contents has been overhauled to
@@ -321,7 +322,52 @@ the mom source file is processed with
<a href="pdfmom"><strong>pdfmom</strong></a>.
</p>
-<h2 id="pdfmom" class="docs">3. pdfmom</h2>
+<h2 id="v2.1-changes" class="docs">3. Version 2.1 changes</h2>
+
+<p>
+Version 2.1 adds these features:
+</p>
+<ul style="margin-top: -.5em; width: 90%">
+ <li>expansion of cover, docheader, page header, and heading
+ control macros to permit caps, smallcaps, color, and
+ underscoring</li>
+ <li>the ability to style every element appearing in docheaders and
+ automatically-generated cover/title pages separately</li>
+ <li>macros to place images on cover/title pages</li>
+ <li>a new macro, COVERTEXT, that allows adding text (e.g. an
+ Abstract) to automatically-generated cover/title pages or to
+ create cover/title pages entirely by hand</li>
+ <li>separate indent control macros for QUOTES and BLOCKQUOTES</li>
+ <li>pseudo-smallcaps, including a control macro to choose the
+ size, weight, and width of the small caps</li>
+ <li>new <element>_STYLE macros that allow setting
+ parameters for <element> with a single macro using
+ keyword/value pairs</li>
+</ul>
+
+<p>
+The following changes have been made:
+</p>
+
+<ul style="margin-top: -.5em; width: 90%">
+ <li>MISC_AUTOLEAD (including COVER_MISC_AUTOLEAD and
+ DOC_COVER_MISC_AUTOLEAD) has been replaced in favour of MISC_LEAD,
+ which takes an absolute leading value, rather than one derived
+ from the point size</li>
+ <li>COVER_UNDERLINE and DOC_COVER_UNDERLINE have been
+ removed in favour of COVER_DOCTYPE_UNDERLINE and
+ DOC_COVER_DOCTYPE_UNDERLINE</li>
+ <li>DOCTYPE NAMED <string> no longer accepts a color
+ argument; setting the color for <string> is accomplished with
+ DOCTYPE_COLOR <color>; in addition, the string now has a
+ complete set of control macros</li>
+ <li>default underscoring of the DOCTYPE NAMED string has been
+ removed, both in the docheader and on cover/title pages</li>
+ <li>no cover/title page data persists, however formatting for the
+ elements on them does</li>
+</ul>
+
+<h2 id="pdfmom" class="docs">4. pdfmom</h2>
<p>
Deri James has provided <strong>pdfmom</strong>, a wrapper around
@@ -339,7 +385,7 @@ recognizes PDF images that have been embedded with
<a href="images.html#pdf-image"><kbd>PDF_IMAGE</kbd></a>.
</p>
-<h2 id="install-font" class="docs">4. install-font.sh</h2>
+<h2 id="install-font" class="docs">5. install-font.sh</h2>
<p>
A bash script, <strong>install-font.sh</strong>, has been posted at the
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 04/04: Version 2.1 updates,
Peter Schaffter <=