[groff] 31/53: doc/meref.me: Correctly explain chapter titles.

[G. Branden Robinson]

gbranden pushed a commit to branch master
in repository groff.

commit 8cb1a927922188f24554b5bcb4df0783262a33bb
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Sun Dec 12 19:05:47 2021 +1100

    doc/meref.me: Correctly explain chapter titles.
    
    * The argument to `+c` must be delimited as a three-part title.
    * Use pipe | instead of a (neutral) apostrophe as the delimiter in the
      example, since two adjacent ones can be confused with \(dq in Times.
    * The argument must furthermore be quoted if it contains spaces, because
      it is a macro argument.
    * Advise reader to use `\E` to avoid escape character quoting hell.
    * If the reader wants to walk with Virgil anyway, advise them of the
      correct number of backslashes required.
    
    Problem dates back 30+ years.  Part of it may be older still; Heirloom
    Doctools troff requires eight backslashes, too (but supports \E).
---
 doc/meref.me | 36 ++++++++++++++++++++++++------------
 1 file changed, 24 insertions(+), 12 deletions(-)

diff --git a/doc/meref.me b/doc/meref.me
index 59b4fc2..26a79d7 100644
--- a/doc/meref.me
+++ b/doc/meref.me
@@ -1706,18 +1706,30 @@ chapter or appendix,
 respectively.
 The
 .i H
-parameter defines the new header.
-If there are any spaces in it,
-the entire header must be quoted.
-If you want the header to have the chapter number
-in it,
-use the string
-.b "\e\e\e\en(ch" .
-For example, to number appendixes
-.b A.1
-etc.,
-type
-.b ".++ RA \(aq\(aq\(aq\e\e\e\en(ch.%\(aq" .
+parameter defines the new header,
+which must be delimited as a three-part title\(em\c
+if it contains spaces,
+it must furthermore be quoted.
+To include the chapter number,
+use the input sequence
+.b "\eEn(ch" .\**
+.(f
+\**
+If you wish to avoid use of the \*G
+.b \eE
+extension,
+fully
+.i eight
+backslashes must precede
+.q n(ch .
+.)f
+For example,
+\[lq]\c
+.b ".++ RA |||\eEn(ch.%|" \[rq]
+numbers appendices as
+.b A. \c
+.bi n
+in the right-hand header.
 Each section
 (chapter, appendix, etc.)
 should be preceded by the