groff-commit
[Top][All Lists]
Advanced

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

[groff] 05/36: groff_mm(7): Fix error in `Aph` reg description.


From: G. Branden Robinson
Subject: [groff] 05/36: groff_mm(7): Fix error in `Aph` reg description.
Date: Tue, 17 Jan 2023 20:45:10 -0500 (EST)

gbranden pushed a commit to branch master
in repository groff.

commit ff58c65ba4b0432fffc54ead28e6a7bab23e45a5
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Tue Jan 17 16:12:06 2023 -0600

    groff_mm(7): Fix error in `Aph` reg description.
    
    * The function of `Aph` was correctly described under the `APP` macro,
      but not under its own tag in the "Registers" section.  Fix this.
      Problem appears to date back to commit a48ab7b6db, groff 1.05
      (1992-03-18).
    * Update descriptions of `APP` macro, `App` and `Apptxt` strings, and
      `Aph` register to reduce redundancy and to cross reference each other.
    * Replace bogus reference to "List of contents" (it's "CONTENTS") with
      cross reference to TC macro instead, which is what produces the
      appendix entries under discussion.
---
 contrib/mm/groff_mm.7.man | 49 ++++++++++++++++++++++++++++-------------------
 1 file changed, 29 insertions(+), 20 deletions(-)

diff --git a/contrib/mm/groff_mm.7.man b/contrib/mm/groff_mm.7.man
index 359789c7f..6e6902639 100644
--- a/contrib/mm/groff_mm.7.man
+++ b/contrib/mm/groff_mm.7.man
@@ -566,26 +566,31 @@ it is incremented
 (or initialized,
 if necessary).
 .
-The default register format is \[lq]A\[rq].
+The register format used for
+.I id
+is \[lq]A\[rq].
 .
-The page is broken,
-and a header produced if register
-.B Aph
-is true;
-this is the default.
+The page is broken.
 .
-Appendices appear in the \[lq]List of contents\[rq] with page numbers.
+The register
+.B Aph
+determines whether an appendix heading is then formatted.
 .
-The name \[lq]APPENDIX\[rq] can be changed by setting the string
+This heading uses the string
 .B App
-to the desired text.
+followed by
+.IR id .
+.
+Appendices appear in any table of contents
+(see
+.BR TC ).
 .
 The string
 .B Apptxt
-is assigned
+is set to
 .I title
-if the argument is present,
-otherwise it is cleared.
+if the latter is present,
+and made empty otherwise.
 .
 .
 .TP
@@ -3642,7 +3647,11 @@ These are presented in quotation marks.
 .
 .TP
 .B Apptxt
-The current appendix text.
+stores the
+.I title
+argument to the last
+.B APP
+call.
 .
 .
 .TP
@@ -4002,13 +4011,13 @@ see macro
 .
 .TP
 .B Aph
-Print an appendix page for every new appendix if this register
-is non-zero.
-.
-No output occurs if
-.B Aph
-is zero,
-but there is always an appendix entry in the \[lq]List of contents\[rq].
+formats an appendix heading
+(and title,
+if supplied);
+see
+.B APP
+(Boolean-valued;
+.BR 1 ).
 .
 .
 .TP



reply via email to

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