groff-commit
[Top][All Lists]
Advanced

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

[groff] 02/02: Doc updates.


From: Peter Schaffter
Subject: [groff] 02/02: Doc updates.
Date: Mon, 10 Sep 2018 13:58:03 -0400 (EDT)

PTPi pushed a commit to branch master
in repository groff.

commit 36cdd2dad8fea91aaceb32341b807cc9a5a0f61a
Author: Peter Schaffter <address@hidden>
Date:   Mon Sep 10 13:57:32 2018 -0400

    Doc updates.
---
 contrib/mom/momdoc/headfootpage.html | 30 +++++++++++++++++++++++++++++-
 contrib/mom/momdoc/macrolist.html    |  3 +++
 contrib/mom/momdoc/stylesheet.css    |  1 +
 3 files changed, 33 insertions(+), 1 deletion(-)

diff --git a/contrib/mom/momdoc/headfootpage.html 
b/contrib/mom/momdoc/headfootpage.html
index 8fb27c8..5caa1bd 100644
--- a/contrib/mom/momdoc/headfootpage.html
+++ b/contrib/mom/momdoc/headfootpage.html
@@ -1998,8 +1998,9 @@ with control macros.
   <li><a href="#paginate">PAGINATE</a> &ndash; pagination on or off</li>
   <li><a href="#pagenumber">PAGENUMBER</a> &ndash; user-defined (starting) 
page number</li>
   <li><a href="#pagenum-style">PAGENUM_STYLE</a> &ndash; digits, roman 
numerals, etc</li>
-  <li><a href="#pagenum-on-first-page">PAGENUM_ON_FIRST_PAGE</a> &ndash; 
applies only when footers are enabled</li>
+  <li><a href="#pagenum-on-first-page">PAGENUM_ON_FIRST_PAGE</a> &ndash; put 
page number on first page when numbering is at the top of the page</li>
   <li><a href="#draft-with-pagenumber">DRAFT_WITH_PAGENUMBER</a> &ndash; 
attach draft/revision information to page numbers</li>
+  <li><a href="#pagenumber-string">PAGENUMBER_STRING</a> &ndash; user-defined 
page number string</li>
   <li><a href="#index-paginate-control">Pagination control macros and 
defaults</a></li>
 </ul>
 </div>
@@ -2138,6 +2139,33 @@ for other ways of dealing with crowded page headers when 
formatting
 draft-style copy.
 </p>
 
+<!-- -PAGENUMBER_STRING- -->
+
+<div id="pagenumber-string" class="box-macro-args">
+Macro: <b>PAGENUMBER_STRING</b> "&lt;text of page number string&gt;"
+</div>
+
+<p>
+If you want page numbering to contain text in addition to the page
+number itself, use PAGENUMBER_STRING.
+</p>
+
+<p>
+The most common use for PAGENUMBER_STRING is to include the total
+number of pages along with the page number, for example
+&#8220;Page 1 of 10, Page 2 of 10...&#8221;  To accomplish this,
+you&#8217;d enter
+<br/>
+<span class="pre-in-pp">
+  .PAGENUMBER_STRING "Page \*[PAGE#] of 10"
+</span>
+Notice that the page number is entered symbolically with the
+<a href="definitions.html#inlines">inline escape</a>
+<span style="white-space:nowrap"><kbd>\*[PAGE#]</kbd>,</span>
+while the total number of pages must be entered explicitly after the
+document is complete and the total number of pages known.
+</p>
+
 <!-- -PAGINATE_CONTROL- -->
 
 <div class="macro-list-container">
diff --git a/contrib/mom/momdoc/macrolist.html 
b/contrib/mom/momdoc/macrolist.html
index 3ba8484..3ea7198 100644
--- a/contrib/mom/momdoc/macrolist.html
+++ b/contrib/mom/momdoc/macrolist.html
@@ -1374,6 +1374,9 @@ elsewhere in the documentation.
 <td><a 
href="headfootpage.html#pagenum-style">&nbsp;PAGENUM_STYLE</a></td><td>-- 
digits, roman numerals, etc</td>
 </tr>
 <tr>
+<td><a 
href="headfootpage.html#pagenumber-string">&nbsp;PAGENUMBER_STRING</a></td><td>--
 user-defined page numbering string</td>
+</tr>
+<tr>
 <td><a 
href="headfootpage.html#pagenum-on-first-page">&nbsp;PAGENUM_ON_FIRST_PAGE</a></td><td>--
 when footers are enabled</td>
 </tr>
 <tr>
diff --git a/contrib/mom/momdoc/stylesheet.css 
b/contrib/mom/momdoc/stylesheet.css
index 7eced06..1574f27 100644
--- a/contrib/mom/momdoc/stylesheet.css
+++ b/contrib/mom/momdoc/stylesheet.css
@@ -492,6 +492,7 @@ h3.macro-list
 ul.macro-list
 {
   margin-left: -21px ;
+  padding-right: 12px ;
   list-style-type: none ;
   font-family: arial,sans-serif ;
   margin-top: -1.25em ;



reply via email to

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