[groff] 04/14: groff_mm(7): Clarify AE, AS, TL macro behavior.

[G. Branden Robinson]

gbranden pushed a commit to branch master
in repository groff.

commit 9c76ace4210306466629cb10c3222a61db4ced91
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Tue Jan 3 14:55:16 2023 -0600

    groff_mm(7): Clarify AE, AS, TL macro behavior.
    
    Some mm macros maintained the ms legacy of collecting cover sheet text
    into diversions, and some did not.  Clarify the varied practices.
    
    * AE: State that this macro ends collection of abstract text.
    * AS: State that this macro begins collection of abstract text.
      Document that abstract type 2 is not supported (mainly because DWB
      mm's `CS` macro is not).
    * TL: State that this macro begins collection of document title.  Be
      specific about when the arguments are used (just memo types 0 and 5).
      Cross-reference `MT` macro accordingly.
    
    Also use two empty requests where vertical space is expected.
---
 contrib/mm/groff_mm.7.man | 38 +++++++++++++++++++++++++++++++-------
 1 file changed, 31 insertions(+), 7 deletions(-)

diff --git a/contrib/mm/groff_mm.7.man b/contrib/mm/groff_mm.7.man
index faef84001..6fbfe07c3 100644
--- a/contrib/mm/groff_mm.7.man
+++ b/contrib/mm/groff_mm.7.man
@@ -499,11 +499,16 @@ It is a special case of
 See also
 .BR 1C .
 .
+.
 .TP
 .B AE
-Abstract end, see
+Abstract end;
+stop collecting abstract text.
+.
+See
 .BR AS .
 .
+.
 .TP
 .BI AF\ \fR[\fP name-of-firm \fR]\fP
 Author's firm, should be called before
@@ -600,7 +605,12 @@ are included in appendices.
 .TP
 .BR AS\~ [\c
 .IR arg \~[ indent ]]
-Abstract start.
+Abstract start;
+begin collecting abstract.
+.
+Text up to the next
+.B AE
+call is included in the abstract.
 .
 Depending on the cover sheet macros used,
 .I arg
@@ -656,6 +666,13 @@ T}
 An abstract is not printed at all in external letters
 .RB ( "MT 5" ).
 .
+Abstract type
+.B 2
+was supported by DWB
+.I mm
+but is not by
+.IR "groff mm" .
+.
 .
 .IP
 The
@@ -3321,18 +3338,25 @@ This header is printed again if a page break occurs.
 .
 Argument \[lq]N\[rq] isn't implemented yet.
 .
+.
 .TP
-.BI TL\  "\fR[\fPcharging-case-number \fR[\fPfiling-case-number\fR]]\fP"
-Begin title of memorandum.
+.BR TL \~[\c
+.IR charging-case-number \~[\c
+.IR filing-case-number ]]
+Begin collecting document title.
 .
-All text up to the next
+Text up to the next
 .B AU
-is included in the title.
+call is included in the title.
 .
 .I charging-case-number
 and
 .I filing-case-number
-are saved for use in the front page processing.
+are saved for use in memorandum types 0 and 5.
+.
+See
+.BR MT .
+.
 .
 .TP
 .BI TM\  "\fR[\fPnum1 \fR[\fPnum2 \fR[.\|.\|.]]]\fP"