groff-commit
[Top][All Lists]
Advanced

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

[groff] 11/16: doc/groff.texi: Fix style nits in ms docs.


From: G. Branden Robinson
Subject: [groff] 11/16: doc/groff.texi: Fix style nits in ms docs.
Date: Sun, 10 Sep 2023 15:09:34 -0400 (EDT)

gbranden pushed a commit to branch master
in repository groff.

commit 928930affeaffed535165393754c20b9dfcc3ed4
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Wed Sep 6 12:17:31 2023 -0500

    doc/groff.texi: Fix style nits in ms docs.
    
    * Use `CartoucheExample` for input examples, consistently with the rest
      of (this part of) the manual.  (This convention strikes me as a little
      odd, if the use of the cartouche is to suggest a sheet of paper.)
    * Update poor man's keeps.
    * Put citation of CSTR paper in quotation marks since it's an article,
      not a book.
    * Complain about Texinfo.
---
 doc/groff.texi | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)

diff --git a/doc/groff.texi b/doc/groff.texi
index 6f5afe232..c715a0c9e 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -4235,9 +4235,9 @@ footnote line length is required, recall that arithmetic 
expressions in
 @code{roff} input are evaluated strictly from left to right, with no
 operator precedence (parentheses are honored).
 
-@Example
+@CartoucheExample
 .ds FR 0+3i \" Set footnote line length to 3 inches.
-@endExample
+@endCartoucheExample
 
 @c ---------------------------------------------------------------------
 
@@ -4260,6 +4260,7 @@ desired localization macro package after @file{ms}; see
 $ groff -ms -mfr bienvenue.ms
 @endCartoucheExample
 
+@need 250
 The following strings are available.
 
 @Defmpstr {REFERENCES, ms}
@@ -4464,6 +4465,7 @@ document, call @code{TC} or @code{PX} to emit the table 
of contents;
 @code{TC} resets the page number to @samp{i} (Roman numeral one), and
 then calls @code{PX}.  All of these macros are Berkeley extensions.
 
+@need 250
 @DefmacList {XS, [@Var{page-number}], ms}
 @DefmacItemx {XA, [@Var{page-number} [@Var{indentation}]], ms}
 @DefmacListEndx {XE, , ms}
@@ -4603,13 +4605,16 @@ of its own.
 
 @itemize @bullet
 @item
+@c Texinfo's @cite command conceives only of citations of long-form
+@c works, like books, and forces italics.  Article citations are
+@c typically placed in quotation marks instead.
 The internals of @code{groff} @file{ms} differ from the internals of
 @acronym{AT&T} @file{ms}.  Documents that depend upon implementation
 details of @acronym{AT&T} @file{ms} may not format properly with
 @code{groff} @file{ms}.  Such details include macros whose function was
 not documented in the @acronym{AT&T} @file{ms}
-manual.@footnote{@cite{Typing Documents on the UNIX System: Using the
--ms Macros with Troff and Nroff}, M.@tie{}E.@: Lesk, Bell Laboratories,
+manual.@footnote{``Typing Documents on the UNIX System: Using the
+-ms Macros with Troff and Nroff'', M.@tie{}E.@: Lesk, Bell Laboratories,
 1978}
 @c XXX: We support RT anyway; maybe we should stop?
 



reply via email to

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