[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 13/31: refer(1): Fix content, style, markup nits.
From: |
G. Branden Robinson |
Subject: |
[groff] 13/31: refer(1): Fix content, style, markup nits. |
Date: |
Mon, 31 Jan 2022 11:28:09 -0500 (EST) |
gbranden pushed a commit to branch master
in repository groff.
commit 64e529c9d7444b6d87e678ace2825025beec3021
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Sun Jan 30 05:38:57 2022 +1100
refer(1): Fix content, style, markup nits.
Content:
* Warn people off of screwing with "accent strings", and explain why.
Add contextual information so the reader has some idea what we're
talking about. Add cross reference to groff_char(7).
Style:
* Migrate terminology: "#" is a number sign (Unicode), not a hash sign.
* Add commas after conditional dependent clauses.
Markup:
* Migrate to 'P' paragraphing macro.
---
src/preproc/refer/refer.1.man | 39 +++++++++++++++++++++++++++------------
1 file changed, 27 insertions(+), 12 deletions(-)
diff --git a/src/preproc/refer/refer.1.man b/src/preproc/refer/refer.1.man
index 43303fbd..66428f8c 100644
--- a/src/preproc/refer/refer.1.man
+++ b/src/preproc/refer/refer.1.man
@@ -583,20 +583,32 @@ if there is more than one occurrence of a particular
field in a record,
only the last such field will be used.
.
.
-.LP
+.P
If accent strings are used,
they should follow the character to be accented.
-This means that the
-.B .AM
-macro must be used with the
+.
+This means that an
.I ms
-macros.
+document must call the
+.B .AM
+macro when it initializes.
.
Accent strings should not be quoted:
use one
.B \e
rather than two.
.
+Accent strings are an obsolescent feature of the
+.I me
+and
+.I ms
+macro packages;
+modern documents should use
+.I groff
+special character escape sequences instead;
+see
+.MR groff_char @MAN7EXT@ .
+.
.
.\" ====================================================================
.SS Citations
@@ -836,10 +848,10 @@ nor anything between them,
is output.
.
.
-.LP
+.P
Commands are separated by newlines or semicolons.
.
-A hash sign
+A number sign
.RB ( # )
introduces a comment that extends to the end of the line,
but does not conceal the newline.
@@ -857,13 +869,14 @@ If there is no such double quote,
the word extends to the end of the line.
.
Pairs of double quotes in a word beginning with a double quote collapse
-to a single double quote.
+to one double quote.
.
-Neither a hash sign nor a semicolon is recognized inside double quotes.
+Neither a number sign nor a semicolon is recognized inside double
+quotes.
.
A line can be continued by ending it with a backslash
.RB \[lq] \[rs] \[rq];
-this works everywhere except after a hash sign.
+this works everywhere except after a number sign.
.
.
.LP
@@ -940,7 +953,8 @@ This is mainly useful with numeric labels.
.
If
.I string
-is omitted it defaults to
+is omitted,
+it defaults to
.RB \[lq] \- \[rq].
.
.
@@ -983,7 +997,8 @@ print it at the end of the reference as a paragraph
preceded by the line
.LP
If
.I string
-is omitted it will default to
+is omitted,
+it will default to
.BR AP ;
if
.I field
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 13/31: refer(1): Fix content, style, markup nits.,
G. Branden Robinson <=