groff-commit
[Top][All Lists]
Advanced

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

[groff] 15/18: doc/meref.me.in (Sectioning): Clarify.


From: G. Branden Robinson
Subject: [groff] 15/18: doc/meref.me.in (Sectioning): Clarify.
Date: Sun, 2 Jan 2022 10:33:59 -0500 (EST)

gbranden pushed a commit to branch master
in repository groff.

commit 8d9884f8e6f27aa86beacb881a6ab26e092d2dfa
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Sat Jan 1 14:44:42 2022 +1100

    doc/meref.me.in (Sectioning): Clarify.
    
    * Move material about setting of section indentation from `sh` to `$p`,
      since the latter is the macro that actually does this.
    * <sh>: A missing section depth is effectively the previous depth used,
      which might be zero.
    * <sh>: Explicitly state that automatically numbered section components
      start at 1.
    * <sh>: Move clarification of what happens if all section components are
      zero to the end of the description.
---
 doc/meref.me.in | 33 +++++++++++----------------------
 1 file changed, 11 insertions(+), 22 deletions(-)

diff --git a/doc/meref.me.in b/doc/meref.me.in
index 2c2ecc5e..6b0043d3 100644
--- a/doc/meref.me.in
+++ b/doc/meref.me.in
@@ -364,7 +364,7 @@ to the section title.
 Begin section with numbered heading
 of depth
 .i \(+-N
-[empty]
+[+0]
 and optional title
 .i T
 [empty].
@@ -372,15 +372,6 @@ Vertical space of
 .NR (ss
 [1v]
 precedes the heading.
-If
-.i \(+-N
-is empty,
-the current depth,
-stored in
-the register
-.NR ($0
-[0],
-is used.
 The components
 of the section number
 are maintained in
@@ -390,25 +381,14 @@ through
 combined,
 they are available in
 .ST ($n .
+Automatic section numbering at all depths begins at 1.
 The section number is followed by a period.
-If all components are zero,
-no number is output.
 The heading is set in font
 .NR (sf
 [8]
 at size
 .NR (sp
 [10p].
-If
-.NR (si
-[0] is not zero,
-.b .sh
-calls
-.b .ba
-to set the section indentation to
-.NR (si \c
-.b * \c
-.NR ($0 .
 The section heading
 is set at the indentation of the parent depth;
 a further indentation of
@@ -455,6 +435,8 @@ and nothing is output\(em\c
 this is useful to automatically
 coordinate section numbers with
 chapter numbers.
+If all components are zero,
+no number is output.
 .TL
 .b .sx
 .i \(+-N
@@ -502,6 +484,13 @@ and
 all three,
 but the first two
 are empty strings.
+If
+.i N
+is present,
+the section indentation is set to
+.NR (si \c
+.b * \c
+.i n .
 .TL
 .b .$0
 .i T



reply via email to

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