[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 24/33: doc/meref.me.in: Clarify behavior of `$c` macro.
From: |
G. Branden Robinson |
Subject: |
[groff] 24/33: doc/meref.me.in: Clarify behavior of `$c` macro. |
Date: |
Thu, 30 Dec 2021 00:46:49 -0500 (EST) |
gbranden pushed a commit to branch temp-mail-fail
in repository groff.
commit 6e6282e0f163e79dbbb42782311aefce1223ac92
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Mon Dec 27 15:09:59 2021 +1100
doc/meref.me.in: Clarify behavior of `$c` macro.
...and interface to `$C` hook macro.
---
doc/meref.me.in | 52 +++++++++++++++++++++++++++++++++++++---------------
1 file changed, 37 insertions(+), 15 deletions(-)
diff --git a/doc/meref.me.in b/doc/meref.me.in
index c4e4d1a5..0e81c14c 100644
--- a/doc/meref.me.in
+++ b/doc/meref.me.in
@@ -1760,32 +1760,54 @@ call
.b .$c
.i T
.DE
+Format a chapter heading
+centered in boldface.
+Output
+.q \fBCHAPTER\fP
+if the segment type is
+.b C
+or
+.b RC,
+or
+.q \fBAPPENDIX\fP
+if the segment type is
+.b A
+or
+.b RA.
Increment \" ...except for abstract and bibliography segments
and output the chapter number
(in
-.NR (ch )
-and any title
-.i T,
-then call
-.b $C .
+.NR (ch ).
+If a chapter title
+.i T
+is present,
+format it,
+preceded by vertical space.
+If the segment type is any of
+.b C ,
+.b RC ,
+.b A ,
+or
+.b RA ,
+call
+.b $C
+(with the word
+.q Chapter
+or
+.q Appendix
+in mixed case).
.TL
.b .$C
.i K
.i N
.i T
.DE
-This hook macro is called by
-.b .$c .
-It can be used to insert chapter titles
+This hook macro
+can be used to insert chapter titles
into a table of contents.
.i K
-is a keyword,
-either
-.q Chapter
-or
-.q Appendix
-(depending on the section type set by
-.b .++ );
+is the chapter or appendix term supplied by
+.b $c ,
.i N
is the chapter or appendix number,
and
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 24/33: doc/meref.me.in: Clarify behavior of `$c` macro.,
G. Branden Robinson <=