groff-commit
[Top][All Lists]
Advanced

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

[groff] 01/01: [mom]: Update and emend docs


From: Peter Schaffter
Subject: [groff] 01/01: [mom]: Update and emend docs
Date: Sun, 13 Oct 2024 14:02:47 -0400 (EDT)

PTPi pushed a commit to branch master
in repository groff.

commit 8740fa141ef597530e51e6057af5392b48537dcb
Author: Peter Schaffter <peter@schaffter.ca>
AuthorDate: Sun Oct 13 14:02:02 2024 -0400

    [mom]: Update and emend docs
---
 contrib/mom/momdoc/docelement.html    | 42 ++++++++++++++++++++++++++---------
 contrib/mom/momdoc/docprocessing.html | 16 ++++++++-----
 contrib/mom/momdoc/stylesheet.css     |  2 +-
 3 files changed, 43 insertions(+), 17 deletions(-)

diff --git a/contrib/mom/momdoc/docelement.html 
b/contrib/mom/momdoc/docelement.html
index 18639bbd3..52a8629bd 100644
--- a/contrib/mom/momdoc/docelement.html
+++ b/contrib/mom/momdoc/docelement.html
@@ -3411,10 +3411,10 @@ When you turn line-numbering on, mom, by default
 </p>
 <ul style="margin-top: -.5em;">
   <li>numbers every line of paragraph text; line-numbering is
-      suspended for all other document processing tags (like
-      docheaders, epigraphs, headings, quotes, etc.) and special
-      pages (covers, endotes, bibliographies, etc.); be aware,
-      though, that if you turn
+      suspended for all other document elements (docheaders,
+      epigraphs, headings, quotes, etc.) and special pages (covers,
+      endotes, bibliographies, etc.); be aware, though, that if you
+      turn
       <a href="definitions.html#docheader">docheaders</a>
       off (with
       <a href="docprocessing.html#docheader">DOCHEADER</a> OFF)
@@ -3474,20 +3474,40 @@ for instructions on line-numbered endnotes.)
 
 <div class="box-tip">
 <p class="tip">
-<span class="note">Note:</span>
+<span class="note">Note: QUOTE / BLOCKQUOTE</span>
+<br/>
+By default, mom does not include quotes and blockquotes in the line
+numbering scheme.  If you wish to enable line numbering for them,
+use the macros
+<a href="#number-quote-lines">NUMBER_QUOTE_LINES</a>
+or
+<a href="#number-quote-lines">NUMBER_BLOCKQUOTE_LINES</a>.
 Do not use NUMBER_LINES inside 
 <a href="#quote">QUOTE</a>
 or
 <a href="#blockquote">BLOCKQUOTE</a>.
-By default, mom expects that quotes and blockquotes will not be
-line numbered.  If you wish to enable line numbering for them, you
-must invoke
-<a href="#number-quote-lines">NUMBER_QUOTE_LINES</a>
-or
-<a href="#number-quote-lines">NUMBER_BLOCKQUOTE_LINES</a>.
 </p>
 </div>
 
+<div class="box-tip">
+<p class="tip">
+<span class="note">Note: LIST</span>
+<br/>
+By default,
+<a href="#item">ITEM</a>s
+in a
+<a href="#list">LIST</a>
+are included in the line numbering scheme.  If
+<a href="typesetting.html#quad">QUAD C</a>
+or
+<a href="typesetting.html#quad">QUAD R</a>
+are in effect prior to the start of the list, line numbers are set
+to the left of longest item, not the document&#8217;s left margin.
+If you wish to disable line numbering for a such (or any) lists,
+put <kbd>.NUMBER_LINES OFF</kbd> before the first ITEM and insert
+<kbd>NUMBER_LINES&nbsp;RESUME</kbd> after the last.
+</div>
+
 
 <p>
 The first time you invoke
diff --git a/contrib/mom/momdoc/docprocessing.html 
b/contrib/mom/momdoc/docprocessing.html
index 007ca41c0..813955224 100644
--- a/contrib/mom/momdoc/docprocessing.html
+++ b/contrib/mom/momdoc/docprocessing.html
@@ -309,10 +309,12 @@ appropriate macro.
 </p>
 
 <p>
-<b>Flex-spacing</b> kicks in automatically whenever you turn shimming
-off.  In other words, if you want a document flex-spaced,
-<kbd>.NO_SHIM</kbd> is how you achieve it.  If, in addition to not
-shimming, you don&#8217;t want mom flex-spacing either,
+<b>Flex-spacing</b> kicks in automatically whenever you
+turn shimming off, provided your document is processed with
+<b>pdfmom(1)</b>.  In other words, if you want a document
+flex-spaced, <kbd>.NO_SHIM</kbd> is how you achieve it.  If, in
+addition to not shimming, you don&#8217;t want mom flex-spacing
+either,
 <a href="#no-flex">NO_FLEX</a>
 lets you disable it, too.
 </p>
@@ -410,7 +412,8 @@ Macro: <b>NO_SHIM</b> <kbd class="macro-args">&lt;none&gt; 
| &lt;anything&gt;</k
 
 <p>
 NO_SHIM, without an argument, disables automatic shimming,
-suppresses the SHIM macro, and enables flex-spacing.
+suppresses the SHIM macro, and, provided your document is processed
+with <b>pdfmom(1)</b>, enables flex-spacing.
 </p>
 
 <p>
@@ -428,6 +431,9 @@ been disabled and disables flex-spacing.
 <div class="box-macro-args">
 Macro: <b>FLEX</b> <kbd class="macro-args">[ FORCE ]</kbd>
 </div>
+<p class="requires">
+&bull;&nbsp;Requires that documents be processed with <b>pdfmom(1)</b>
+</p>
 
 <p>
 When flex-spacing is enabled, the FLEX macro inserts flexible
diff --git a/contrib/mom/momdoc/stylesheet.css 
b/contrib/mom/momdoc/stylesheet.css
index 9d9efa329..fae92b46a 100644
--- a/contrib/mom/momdoc/stylesheet.css
+++ b/contrib/mom/momdoc/stylesheet.css
@@ -240,7 +240,7 @@ div.rule-long /* precedes nav bar at bottom of page */
   outline: solid 1px #ceac8d ;
   padding-left: 15px ; 
   padding-right: 15px ; 
-  text-align: justify ;
+  text-align: left ;
   background-color: #f9f9d9 ;
   margin-bottom: 1.5em ;
   }



reply via email to

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