[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Groff-commit] groff/contrib/mom ChangeLog NEWS om.tmac momdoc...
|
From: |
Werner LEMBERG |
|
Subject: |
[Groff-commit] groff/contrib/mom ChangeLog NEWS om.tmac momdoc... |
|
Date: |
Mon, 13 Sep 2004 12:02:50 -0400 |
CVSROOT: /cvsroot/groff
Module name: groff
Branch:
Changes by: Werner LEMBERG <address@hidden> 04/09/13 15:57:40
Modified files:
contrib/mom : ChangeLog NEWS om.tmac
contrib/mom/momdoc: definitions.html docprocessing.html
inlines.html intro.html typesetting.html
Log message:
o Small fixes to the documentation.
CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/groff/groff/contrib/mom/ChangeLog.diff?tr1=1.25&tr2=1.26&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/groff/groff/contrib/mom/NEWS.diff?tr1=1.15&tr2=1.16&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/groff/groff/contrib/mom/om.tmac.diff?tr1=1.20&tr2=1.21&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/groff/groff/contrib/mom/momdoc/definitions.html.diff?tr1=1.7&tr2=1.8&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/groff/groff/contrib/mom/momdoc/docprocessing.html.diff?tr1=1.17&tr2=1.18&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/groff/groff/contrib/mom/momdoc/inlines.html.diff?tr1=1.11&tr2=1.12&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/groff/groff/contrib/mom/momdoc/intro.html.diff?tr1=1.8&tr2=1.9&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/groff/groff/contrib/mom/momdoc/typesetting.html.diff?tr1=1.11&tr2=1.12&r1=text&r2=text
Patches:
Index: groff/contrib/mom/ChangeLog
diff -u groff/contrib/mom/ChangeLog:1.25 groff/contrib/mom/ChangeLog:1.26
--- groff/contrib/mom/ChangeLog:1.25 Sat Aug 28 15:41:30 2004
+++ groff/contrib/mom/ChangeLog Mon Sep 13 15:57:39 2004
@@ -1,3 +1,7 @@
+*Sep 12 2004
+
+o Small fixes to the documentation.
+
*Aug 21 2004
o Removed superfluous second arguments from strings UP, DOWN, FWD
Index: groff/contrib/mom/NEWS
diff -u groff/contrib/mom/NEWS:1.15 groff/contrib/mom/NEWS:1.16
--- groff/contrib/mom/NEWS:1.15 Mon Aug 9 09:07:47 2004
+++ groff/contrib/mom/NEWS Mon Sep 13 15:57:39 2004
@@ -1,3 +1,10 @@
+Releases 1.2-a and 1.2-b
+------------------------
+
+My personal email address has changed. 1.2-a and -b have been
+updated to reflect that. Additionally, I made some small changes
+to the documentation.
+
Release 1.2
-----------
Index: groff/contrib/mom/momdoc/definitions.html
diff -u groff/contrib/mom/momdoc/definitions.html:1.7
groff/contrib/mom/momdoc/definitions.html:1.8
--- groff/contrib/mom/momdoc/definitions.html:1.7 Mon Aug 9 09:07:48 2004
+++ groff/contrib/mom/momdoc/definitions.html Mon Sep 13 15:57:39 2004
@@ -236,8 +236,8 @@
<a href="#TERMS_PICASPOINTS">points</a>.
<p>
<em>In case you're interested...</em> In previous centuries,
-lines of type were separated by thin strips of -- you guessed it
--- lead. Lines of type that had no lead between them were said to
+lines of type were separated by thin strips of--you guessed
+it--lead. Lines of type that had no lead between them were said to
be "set solid." Once you began separating them with strips
of lead, they were said to be "leaded", and the spacing was
expressed in terms of the number of
@@ -437,8 +437,8 @@
\#
</pre>
-When processing output, groff silently ignores everything on the
-line after the comment character.
+When processing output, groff silently ignores everything on a
+line that begins with the comment character.
<dt><a name="TERMS_CONTROLLINES"><em>Control Lines</em></a>
<dd>Instructions to groff that appear on a line by themselves,
@@ -515,15 +515,15 @@
<dd>Instructions embedded in a document that determine how groff processes
the text for output. <strong>mom</strong>'s macros always begin with a
period, on a line by themselves, and must be typed in capital letters.
-Typically, macros contain complex commands issued to groff -- behind
-the scenes -- via groff
+Typically, macros contain complex commands issued to groff--behind
+the scenes--via groff
<a href="#TERMS_PRIMITIVES">primitives</a>.
<dt><a name="TERMS_UNITS"><em>Machine units</em></a>
<dd>A machine unit is 1/1000 of a
<a href="#TERMS_PICASPOINTS">point</a>
when the groff device is ps. ("ps" means
-"PostScript" -- the default device for which groff
+"PostScript"--the default device for which groff
prepares output, and the device for which <strong>mom</strong> was
specifically designed.)
@@ -609,7 +609,7 @@
measure. <strong>mom</strong>'s macros do not have default units
of measure. There are a couple of exceptions, the most notable of
which are <strong>PT_SIZE</strong> and <strong>LS</strong>. Both use
-<a href="#TERMS_PICASPOINTS">*points</a>
+<a href="#TERMS_PICASPOINTS">points</a>
as the default unit of measure, which means
you don't have to append "p" to their argument.
<p>
Index: groff/contrib/mom/momdoc/docprocessing.html
diff -u groff/contrib/mom/momdoc/docprocessing.html:1.17
groff/contrib/mom/momdoc/docprocessing.html:1.18
--- groff/contrib/mom/momdoc/docprocessing.html:1.17 Mon Aug 9 09:07:48 2004
+++ groff/contrib/mom/momdoc/docprocessing.html Mon Sep 13 15:57:39 2004
@@ -1081,7 +1081,7 @@
<p>
The argument passed to <strong>COVERTITLE</strong> or
-<strong>DOC_COVERTITLE</strong>is only used on cover or doc cover
+<strong>DOC_COVERTITLE</strong> is only used on cover or doc cover
pages, and then only if the argument COVERTITLE is passed to
<a href="cover.html#COVER">COVER</a>
or
@@ -2029,7 +2029,7 @@
<a href="definitions.html#TERMS_FOOTER">footers</a>.
An embedded colour will cause the string to be colourized any time
it appears in headers or footers. (If you want headers or footers
-colourized, or parts thereof, use the header/footer control macros
+colourized, or parts thereof, use the header/footer control macros.)
<p>
<a name="DOCHEADER_COLOR"></a>
If you want to colourize the entire docheader, use the macro
Index: groff/contrib/mom/momdoc/inlines.html
diff -u groff/contrib/mom/momdoc/inlines.html:1.11
groff/contrib/mom/momdoc/inlines.html:1.12
--- groff/contrib/mom/momdoc/inlines.html:1.11 Sat Aug 28 15:41:31 2004
+++ groff/contrib/mom/momdoc/inlines.html Mon Sep 13 15:57:39 2004
@@ -111,21 +111,21 @@
<a name="INLINE_FONTS_MOM"><h3><u>Changing fonts</u></h3></a>
<p>
-<strong>Mom</strong> provides five inlines to change fonts
-inline.
+<strong>Mom</strong> provides five escapes for changing fonts
+inline:
<p>
<table valign="baseline" cellpadding="10" summary="inlinefonts">
<tr>
<td><strong>\*[ROM]</strong></td>
- <td>Change font to roman</td>
+ <td>Change font to medium roman</td>
</tr>
<tr>
<td><strong>\*[IT]</strong></td>
- <td>Change font to italic</td>
+ <td>Change font to medium italic</td>
</tr>
<tr>
<td><strong>\*[BD]</strong></td>
- <td>Change font to bold </td>
+ <td>Change font to bold roman</td>
</tr>
<tr>
<td><strong>\*[BDI]</strong></td>
@@ -137,15 +137,16 @@
</tr>
</table>
<p>
-See also
-<a href="#INLINE_FONTS_GROFF">font control with \f</a>
-for other ways to change fonts inline.
+These escapes are provided for merely for convenience, legibility,
+and consistency when typesetting with <strong>mom</strong>. For
+more complete and flexible inline font control, please see
+<a href="#INLINE_FONTS_GROFF">font control with \f</a>.
<p>
<strong>NOTE:</strong> If you're using the
<a href="docprocessing.html#DOCPROCESSING">document processing macros</a>,
inline font changes remain in effect only for the duration of the
-current macro.
+current document element tag.
<p>
<!---INLINE_SIZE_MOM--->
@@ -477,43 +478,47 @@
<p>
Groff's basic mechanism for inline font control is the escape
-<strong>\f</strong>.
+<strong>\f[<</strong>font><strong>]</strong>.
<p>
<table valign="baseline" cellpadding="10" summary="inlinefontsgroff">
<tr>
- <td><strong>\fR</strong></td>
- <td>Change font to roman</td>
+ <td><strong>\f[R]</strong></td>
+ <td>Change font to medium roman (equivalent to mom's
<strong>\*[ROM]</strong>)</td>
</tr>
<tr>
- <td><strong>\fI</strong></td>
- <td>Change font to italic</td>
+ <td><strong>\f[I]</strong></td>
+ <td>Change font to medium italic (equivalent to mom's
<strong>\*[IT]</strong>)</td>
</tr>
<tr>
- <td><strong>\fB</strong></td>
- <td>Change font to bold</td>
+ <td><strong>\f[B]</strong></td>
+ <td>Change font to bold roman (equivalent to mom's
<strong>\*[BD]</strong>)</td>
</tr>
<tr>
- <td><strong>\f(BI</strong></td>
- <td>Change font to bold italic</td>
+ <td><strong>\f[BI]</strong></td>
+ <td>Change font to bold italic (equivalent to mom's
<strong>\*[BDI]</strong>)</td>
</tr>
<tr>
- <td><strong>\fP</strong></td>
- <td>Revert to previous font</td>
+ <td><strong>\f[P]</strong></td>
+ <td>Revert to previous font (equivalent to mom's
<strong>\*[PREV]</strong>)</td>
</tr>
</table>
<p>
-A special instance of <strong>\f</strong> is
-<strong>\f[font]</strong>, where "font" can be a
-complete legal family/font name combo. This is especially
-useful should you need to change both family and font inline.
-For example, if your prevailing family and font are Times Roman
-and you want a few words in Courier Bold Italic, you could do
-this:
+<strong>\f[<</strong>font><strong>]</strong> can be used with
+any legal font style registered with groff. (See
+<a href="appendices.html#STYLE_EXTENSIONS">here</a>
+for a list of pre-registered font styles provided by
+<strong>mom</strong>).
+<p>
+<strong>\f[<</strong>font><strong>]</strong> can also take a
+complete legal family+font name combo. This is especially useful
+should you need to change both family and font inline. For example,
+if your prevailing family and font are Times Roman and you want a
+few words in Courier Bold Italic, you could do this:
<p>
<pre>
.FAM T
.FT R
- The command \f[CBI]ls -l\fP gives a "long" directory listing.
+ The command \f[CBI]ls -l\f[P] gives a "long" directory
listing.
</pre>
The Unix command "ls -l" will appear in Courier Bold Italic
Index: groff/contrib/mom/momdoc/intro.html
diff -u groff/contrib/mom/momdoc/intro.html:1.8
groff/contrib/mom/momdoc/intro.html:1.9
--- groff/contrib/mom/momdoc/intro.html:1.8 Mon Aug 9 09:07:48 2004
+++ groff/contrib/mom/momdoc/intro.html Mon Sep 13 15:57:39 2004
@@ -64,7 +64,7 @@
Because <strong>mom</strong> provides both typesetting and document
processing macros, it's safe to say she blurs the distinction between
document processing and document design. While her basic document style
-comes with pretty spiffy defaults (okay -- change "spiffy"
+comes with pretty spiffy defaults (okay--change "spiffy"
to "typographically professional"), you can easily control
how all the various document elements look: titles, page headers and
footers, page numbering, heads, subheads, footnotes and so on can be
@@ -105,10 +105,9 @@
<a href="docprocessing.html#START">START</a>
macro; see below), every macro is a literal command that remains in
effect until you modify it or turn it off. This means that if you
-want to create flyers, document covers, surveys, tabulated forms,
-curricula vitae and so on, you may do so in the good old-fashioned
-way: one step at a time with complete control over every element on
-the page.
+want to create flyers, surveys, tabulated forms, curricula vitae and
+so on, you may do so in the good old-fashioned way: one step at a
+time with complete control over every element on the page.
<p>
Years of reading various mailing lists dealing with computer
typesetting (groff, TeX, and friends) have convinced me that no program
@@ -121,13 +120,12 @@
whatever it's worth, a similar problem exists with engraving musical
scores by computer.)
<p>
-<strong>Mom</strong> does not try to solve the problems posed by
-things like hanging punctuation, left-margin adjustments for those
-annoying "space-y" upper case letters like T and W, and
-so on. She merely tries to provide tools that allow knowledgeable
-typesetters to come up with solutions to these problems
-in ways that are somewhat easier and more intuitive than manipulating
-groff at the
+<strong>Mom</strong> does not try to solve the problems posed
+by things like hanging punctuation, left-margin adjustments for
+upper case letters like T and W, and so on. She merely tries to
+provide tools that allow knowledgeable typesetters to come up with
+solutions to these problems in ways that are easier and more
+intuitive than manipulating groff at the
<a href="definitions.html#TERMS_PRIMITIVES">primitive</a>
level. As a professional typesetter of more than two decades, and a
writer, I have encountered few situations that cannot be handled by
@@ -135,7 +133,7 @@
<p>
<strong>Author's note:</strong> One area where groff itself needs
serious rethinking is in the matter of an algorithm that takes into
-account both word AND letter spacing when
+account both word and letter spacing when
<a href="definitions.html#TERMS_JUST">justifying</a>
lines. At present, only word spacing is adjusted, requiring what I
consider an unnecessary amount of user intervention whenever
Index: groff/contrib/mom/momdoc/typesetting.html
diff -u groff/contrib/mom/momdoc/typesetting.html:1.11
groff/contrib/mom/momdoc/typesetting.html:1.12
--- groff/contrib/mom/momdoc/typesetting.html:1.11 Sat Aug 28 15:41:31 2004
+++ groff/contrib/mom/momdoc/typesetting.html Mon Sep 13 15:57:39 2004
@@ -30,7 +30,7 @@
<li><a href="#INTRO_BASIC_PARAMS">Introduction to Basic
Parameters</a>
<li><a href="#INDEX_BASIC">List of macros</a>
</ul>
- <li><strong>JUSTIFYING, QUADDING, FILLING, BREAKING LINES</strong>
+ <li><strong>JUSTIFYING, QUADDING, FILLING, BREAKING and JOINING
LINES</strong>
<ul>
<li><a href="#INTRO_JUST_QUAD_FILL">Introduction to justify,
quad, fill, break</a>
<li><a href="#INDEX_JUST">List of macros</a>
@@ -111,7 +111,7 @@
package, independent of the
<a href="docprocessing.html#DOCPROCESSING">document processing macros</a>.
With them, you can typeset on-the-fly. Book covers, your best
-friend's résumé, a poster for a lost dog --none of these requires
+friend's résumé, a poster for a lost dog--none of these requires
structured document processing (page headers, paragraphs, heads,
footnotes, etc). What they do demand is precise control over every
element on the page. The typesetting macros give you that control.
@@ -768,15 +768,15 @@
<a href="inlines.html#INLINE_FONTS_MOM">Inline Escapes, font control</a>.
<p>
<a name="FONT_NOTE"></a>
-<strong>NOTE: Mom, versions 1.1.9-a</strong> and higher,
+<strong>NOTE: mom, versions 1.1.9-a</strong> and higher,
considerably extends the range of arguments you can pass to
<strong>FT</strong>, making it more convenient to add and access
fonts of differing
<a href="definitions.html#TERMS_WEIGHT">weights</a>
and
<a href="definitions.html#TERMS_SHAPE">shapes</a>
-within the same family. Have a look at the Appendices,
-<a href="appendices.html#STYLE_EXTENSIONS">Adding PostScript fonts to
groff</a>,
+within the same family. Have a look
+<a href="appendices.html#STYLE_EXTENSIONS">here</a>
for a list of the weight/style arguments <strong>mom</strong>
allows.
<p>
@@ -1102,7 +1102,8 @@
<li><a href="#SPACE">SPACE</a> (break a line and add space
before the next output line)
<li><a href="#SPREAD">SPREAD</a> (break and force-justify an
output line)
</ul>
- <li><strong>Joining lines</strong>
+ <li><strong>Joining input lines in
+ <a href="definitions.html#TERMS_NOFILL">nofill mode</a></strong>
<ul>
<li><a href="#JOIN">\c</a> inline escape
</ul>
@@ -1272,11 +1273,15 @@
Macro: <strong>EL</strong>
<br>
<em>*In nofill modes (LEFT, RIGHT, CENTER), you must terminate the
-line preceding EL with the \c inline escape. Furthermore, in
-nofill modes, EL does not work after the PAD macro. See the
+line input preceding EL with the </em><kbd>\c</kbd><em> inline
+escape. See
<a href="#EL_NOTES">NOTES</a>,
-below.</em>
-
+below.
+<br>
+Furthermore, in nofill modes, EL does not work after the PAD macro.
+See
+<a href="#EL_EXCEPTION">Exception</a>
+for a workaround</em>.
<p>
The mnemonic "EL" is borrowed from old Compugraphic typesetting
systems, where it stood for "End Line." Conceptually,
@@ -1302,8 +1307,9 @@
get 24. To demonstrate:
<p>
<pre>
+ .LEFT
.LS 12.5
- A line of text.
+ A line of text.\c
.EL
.ALD 24p
The next line of text.
@@ -1312,6 +1318,7 @@
may be more intuitive than
<p>
<pre>
+ .LEFT
.LS 12.5
A line of text.
.ALD 11.5p
@@ -1371,6 +1378,7 @@
(see the exception, below), you don't have to worry about this,
regardless of the fill mode. Just type <kbd>.EL</kbd>
<p>
+<a name="EL_EXCEPTION"></a>
<strong>Exception: EL</strong> does not work after the
<a href="goodies.html#PAD">PAD</a>
macro when you're in a nofill mode. If you require
@@ -1379,11 +1387,13 @@
"manually", e.g.
<p>
<pre>
- .CENTER \" CENTER is a nofill mode
+ .CENTER \" CENTER is a nofill mode
.PAD "#\*[ST1]A line of text\*[ST1X]#"
- .TRAP OFF -+
- .SP -1v | - a "manual" EL
- .TRAP -+
+ \#
+ .TRAP OFF \" -+
+ .SP -1v \" |--> this is a "manual" EL
+ .TRAP \" -+
+ \#
.ST 1 L
.TAB 1
.ALD 2p
@@ -1405,8 +1415,10 @@
<p>
<strong>SPACE</strong> breaks a line, just like
<strong>BR</strong>, then adds space after the line. With no
-argument, it adds an extra line space. If you pass it a numeric
-argument without supplying a
+argument, it adds an extra line space of a value equal to the
+current
+<a href="definitions.html#TERMS_LEADING">leading</a>.
+If you pass it a numeric argument without supplying a
<a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>,
it advances that number of extra line spaces. For example:
<p>
@@ -1424,15 +1436,18 @@
<p>
If you supply a unit of measure, <strong>SPACE</strong> breaks the
-line then adds the specified amount of extra space to the current
-linespace, as in
+line then advances one linespace (at the current
+<a href="definitions.html#TERMS_LEADING">leading</a>)
+PLUS the specified amount of extra space given to
+<strong>SPACE</strong>,
+as in
<p>
<pre>
.SPACE 6p
</pre>
-which breaks the line then adds six points of space to the current
-linespace.
+which breaks the line and advances one full linespace plus six
+points.
<p>
<strong>SUGGESTION: SPACE</strong> and
@@ -1525,6 +1540,17 @@
<a href="definitions.html#TERMS_FILLED">fill modes</a>,
there'd have been no need for the <strong>\c</strong>.
<p>
+<strong>Addendum:</strong> The example, above, is designed to
+demonstrate the use of <strong>\c</strong>. However, an easier and
+more intuitive way to accomplish the family/font change in the
+example would be with the groff
+<a href="definitions.html#TERMS_INLINES">inline escape</a>,
+<a href="inlines.html#INLINE_FONTS_GROFF">\f</a>.
+<p>
+<pre>
+ Some lines of text to be \f[HB]joined\*[PREV] together.
+</pre>
+<p>
<hr>
<!====================================================================>
@@ -1755,7 +1781,7 @@
<strong>HY</strong> observes the following default hyphenation rules:
<br>
<ol>
- <li>Last lines (i.e. ones that will spring a trap -- typically
+ <li>Last lines (i.e. ones that will spring a trap--typically
the last line on a page) will not be hyphenated.
<li>The first and last two characters of a word are never
split off.
@@ -2113,7 +2139,7 @@
to get your hands on a condensed family. That's where these macros
and inline escapes come in. With them, you can fake the fonts
you're missing. A word of caution, though: "faked"
-fonts are just that -- faked. You should only use them as a
+fonts are just that--faked. You should only use them as a
last resort, and then only sparingly. A word or two or a line
or two in a faked font will pass unnoticed; large patches of
type in a faked font look typographically cheap.
@@ -3518,7 +3544,7 @@
is the macro you use to begin multi-column setting. It marks
the current
<a href="definitions.html#TERMS_BASELINE">baseline</a>
-as the top of your columns, for use late with
+as the top of your columns, for use later with
<a href="#MCR">MCR</a>. See the
<a href="#MULTI_COLUMNS">introduction to columns</a>
for an explanation of multi-columns and some sample
Index: groff/contrib/mom/om.tmac
diff -u groff/contrib/mom/om.tmac:1.20 groff/contrib/mom/om.tmac:1.21
--- groff/contrib/mom/om.tmac:1.20 Tue Aug 31 20:17:20 2004
+++ groff/contrib/mom/om.tmac Mon Sep 13 15:57:39 2004
@@ -23,7 +23,7 @@
.\"
.\"
.\"
-\# Version 1.2-a
+\# Version 1.2-b
\# -------------
\#
\# Antoine de St-Exupéry asserted that elegance in engineering is
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Groff-commit] groff/contrib/mom ChangeLog NEWS om.tmac momdoc...,
Werner LEMBERG <=