groff-commit
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[groff] 01/01: Doc fixes.


From: Peter Schaffter
Subject: [groff] 01/01: Doc fixes.
Date: Thu, 21 Jan 2021 13:20:21 -0500 (EST)

PTPi pushed a commit to branch master
in repository groff.

commit 7bb53f135a4ad69956be1c45689d0eb05cc18de1
Author: Peter Schaffter <peter@schaffter.ca>
AuthorDate: Thu Jan 21 13:17:29 2021 -0500

    Doc fixes.
    
    Correct miscellaneous typos and style nits.
    
    Add strikethrough tip to UNDERSCORE.
    
    Remove mention of comments being stripped from om.tmac during build.
    
    Add para concerning use of Zapf Dingbats font and accessing
    undefined characters in it.
---
 contrib/mom/momdoc/docelement.html  |  2 +-
 contrib/mom/momdoc/goodies.html     | 14 +++++++++++---
 contrib/mom/momdoc/inlines.html     |  6 +++---
 contrib/mom/momdoc/intro.html       |  9 ---------
 contrib/mom/momdoc/toc.html         |  4 ++--
 contrib/mom/momdoc/typesetting.html | 13 +++++++++++++
 gnulib                              |  2 +-
 7 files changed, 31 insertions(+), 19 deletions(-)

diff --git a/contrib/mom/momdoc/docelement.html 
b/contrib/mom/momdoc/docelement.html
index 4f14784..7db22d9 100644
--- a/contrib/mom/momdoc/docelement.html
+++ b/contrib/mom/momdoc/docelement.html
@@ -1906,7 +1906,7 @@ and a vertical adjustment factor.
 
 <p>
 The first argument is any valid groff character (e.g., <kbd>*</kbd>
-[an asterisk], <kbd>\[dg]</kbd> [a dagger], <kbd>\f[ZD]\N'141\fP</kbd>
+[an asterisk], <kbd>\[dg]</kbd> [a dagger], <kbd>\f[ZD]\N'141'\fP</kbd>
 [an arbitrary character from Zapf Dingbats], <kbd>\l'4P'</kbd> [a
 4-pica long rule]). Mom sets the character centred on the current
 line length.  (See <kbd>man groff_char</kbd> for a list of all
diff --git a/contrib/mom/momdoc/goodies.html b/contrib/mom/momdoc/goodies.html
index ddff28e..6bf3a5d 100644
--- a/contrib/mom/momdoc/goodies.html
+++ b/contrib/mom/momdoc/goodies.html
@@ -714,7 +714,7 @@ required
 The string must be enclosed in double-quotes, like this:
 <br/>
 <span class="pre-in-pp">
-  .UNDERSCORE "Unmonitored monopolies breed high prices and poor 
products."&nbsp;
+  .UNDERSCORE "Unmonitored monopolies breed high prices and poor products."
 </span>
 If you wish to change the distance of the rule from the baseline,
 use the optional argument
@@ -722,14 +722,22 @@ use the optional argument
 (with a unit of measure).
 <br/>
 <span class="pre-in-pp">
-  .UNDERSCORE 3p "Unmonitored monopolies breed high prices and poor 
products."&nbsp;
+  .UNDERSCORE 3p "Unmonitored monopolies breed high prices and poor products."
 </span>
-The above places upper edge of the underscore 3 points below the
+The above places the upper edge of the underscore 3 points below the
 <a href="definitions.html#baseline">baseline</a>.
 </p>
 
 <div class="box-tip">
 <p class="tip">
+<span class="note">Tip:</span>
+UNDERSCORE can also be used for strikethrough effects by supplying a
+negative value to the distance argument.
+</p>
+</div>
+
+<div class="box-tip">
+<p class="tip">
 <span class="note">Note:</span>
 UNDERSCORE does not work across line breaks in output copy, which is
 to say that you can&#8217;t underscore a multi-line passage simply
diff --git a/contrib/mom/momdoc/inlines.html b/contrib/mom/momdoc/inlines.html
index be3e06d..39efd3a 100644
--- a/contrib/mom/momdoc/inlines.html
+++ b/contrib/mom/momdoc/inlines.html
@@ -623,10 +623,10 @@ the input line in previous tab, like this:
 <h3 id="inline-rule-mom" class="docs">Full measure rules</h3>
 <p>
 I find I often need rules drawn to the full measure of the current line
-or tab length.  The official way to do this is <kbd>\l'\n[.lu]'</kbd>,
+or tab length.  The official way to do this is <kbd>\l'\n[.l]u'</kbd>,
 which is annoying to type, and doesn&#8217;t mean a whole heck of a lot if
 you&#8217;re new to groff.  The inline, <kbd>\*[RULE]</kbd>, is a simple
-replacement for <kbd>\l'\n[.lu]'</kbd>.  Use it whenever you need
+replacement for <kbd>\l'\n[.l]u'</kbd>.  Use it whenever you need
 a rule drawn to the full measure of the current line or tab length, for
 example:
 <br/>
@@ -1027,7 +1027,7 @@ For a complete list of special characters and glyphs (ie 
just
 about anything you&#8217;d ever want to appear on the printed
 page, including mathematical symbols, accented characters, unusual
 ligatures and letters unique to various European languages), consult
-<kbd>man groff-char</kbd>.
+<kbd>man groff_char</kbd>.
 </p>
 
 <span class="pre">
diff --git a/contrib/mom/momdoc/intro.html b/contrib/mom/momdoc/intro.html
index 014a265..b8feca2 100644
--- a/contrib/mom/momdoc/intro.html
+++ b/contrib/mom/momdoc/intro.html
@@ -336,15 +336,6 @@ addition to what&#8217;s contained in this documentation.
 </p>
 </div>
 
-<div class="box-tip">
-<p class="tip-top" style="padding-bottom: 9px; text-indent: 0px;">
-<strong>Addendum:</strong> The main macro file, om.tmac, is stripped
-of comments when groff is built from sources. om.tmac in the sources
-themselves still contains the comments, as do the tarballs posted on
-mom&#8217;s homepage.
-</p>
-</div>
-
 <div class="rule-short" style="padding-top: 6px; padding-bottom: 
3px;"><hr/></div>
 
 <h2 id="macro-args" class="docs">How to read macro arguments</h2>
diff --git a/contrib/mom/momdoc/toc.html b/contrib/mom/momdoc/toc.html
index b136ff9..5632b4c 100644
--- a/contrib/mom/momdoc/toc.html
+++ b/contrib/mom/momdoc/toc.html
@@ -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.4-4_c -- Table of Contents</title>
+  <title>Mom, version 2.4-4_d -- 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.4-4_c
+    mom, version 2.4-4_d
   </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 c2dad84..1960efa 100644
--- a/contrib/mom/momdoc/typesetting.html
+++ b/contrib/mom/momdoc/typesetting.html
@@ -839,6 +839,19 @@ only exists in one style: Italic (<kbd>I</kbd>).  
Therefore,
 <kbd>ZCM</kbd>, then setting the font to <kbd>I</kbd>.
 </p>
 
+<p>
+Furthermore, if you need to access a character from groff's Zapf
+Dingbats font directly, use <kbd>.FT&nbsp;ZD</kbd> or the
+<a href="definitions.html#inlines">inline escape</a>
+<kbd>\f[ZD]</kbd>.  Commonly-used dingbats are
+available without changing to the ZD font by using groff's
+pre-defined character escapes, e.g. <kbd>\[rh]</kbd> for a pointing
+right hand; see <kbd>man groff_char</kbd> for a complete list.
+Dingbats that have not been pre-defined must be accessed with the
+<kbd>\N</kbd> escape.  For example, <kbd>\f[ZD]\N'37'</kbd> prints
+the (undefined) telephone dingbat.  
+</p>
+
 <p id="fam-add-note" class="tip-bottom">
 <span class="additional-note">Additional note:</span> 
 If you are running a version of groff lower than 1.19.2, you must
diff --git a/gnulib b/gnulib
index d60a35e..dce8759 160000
--- a/gnulib
+++ b/gnulib
@@ -1 +1 @@
-Subproject commit d60a35e94c4f5b8f09f15828242418f5073d46e7
+Subproject commit dce8759f0f0236a860a3e68b63c5e99cc6f168f9



reply via email to

[Prev in Thread] Current Thread [Next in Thread]