groff-commit
[Top][All Lists]
Advanced

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

[groff] 03/28: [ms]: Fix doc omission; .ID can take an argument.


From: G. Branden Robinson
Subject: [groff] 03/28: [ms]: Fix doc omission; .ID can take an argument.
Date: Sat, 19 Jun 2021 17:24:07 -0400 (EDT)

gbranden pushed a commit to branch master
in repository groff.

commit a7d76e2474faf8934c1f2b8dd181aeb8e46fed31
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Fri Jun 18 08:07:30 2021 +1000

    [ms]: Fix doc omission; .ID can take an argument.
    
    * doc/groff.texi (ms Document Control Settings) <DI>: Characterize
      register setting as a _default_.
    
      (ms Displays and Keeps): Add optional variable "indent" argument to
      syntax summary of ".DS I" and ".ID".  Note that the given indentation
      is used if present, and \n[DI] otherwise.
    
    * doc/ms.ms (Displays and keeps): Add optional variable "indent"
      argument to syntax summary of ".ID".  Switch fonts more carefully and
      apply italic corrections.
    
    * tmac/groff_ms.7.man (Displays and keeps): Sync with doc/ms.ms.
---
 ChangeLog           | 14 ++++++++++++++
 doc/groff.texi      | 17 +++++++++--------
 doc/ms.ms           |  3 ++-
 tmac/groff_ms.7.man | 10 ++++++++--
 4 files changed, 33 insertions(+), 11 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 734e7a3..aa9f175 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,17 @@
+2021-06-18  G. Branden Robinson <g.branden.robinson@gmail.com>
+
+       [ms]: Fix doc omission; .ID can take an argument.
+
+       * doc/groff.texi (ms Document Control Settings) <DI>:
+       Characterize register setting as a _default_.
+       (ms Displays and Keeps): Add optional variable "indent" argument
+       to syntax summary of ".DS I" and ".ID".  Note that the given
+       indentation is used if present, and \n[DI] otherwise.
+       * doc/ms.ms (Displays and keeps): Add optional variable "indent"
+       argument to syntax summary of ".ID".  Switch fonts more
+       carefully and apply italic corrections.
+       * tmac/groff_ms.7.man (Displays and keeps): Sync with doc/ms.ms.
+
 2021-06-17  G. Branden Robinson <g.branden.robinson@gmail.com>
 
        * tmac/s.tmac: Properly situate devtag flag-related register
diff --git a/doc/groff.texi b/doc/groff.texi
index 4766514..82eb572 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -2871,8 +2871,8 @@ Default: 0.5@dmn{v}.
 @endDefmpreg
 
 @Defmpreg {DI, ms}
-Sets the amount by which to indent a display started with @samp{.DS I}
-or @code{ID}.  This is a GNU extension.
+Sets the default amount by which to indent a display started with
+@samp{.DS I} or @code{ID}.  This is a GNU extension.
 
 Effective: next indented display.
 
@@ -3595,13 +3595,14 @@ macro allows the display to break across pages.  The 
@code{DE} macro
 ends the display.
 @endDefmac
 
-@DefmacList {DS, @t{I}, ms}
-@DefmacItemx {ID, , ms}
+@DefmacList {DS, @t{I} [@Var{indent}], ms}
+@DefmacItemx {ID, [@Var{indent}], ms}
 @DefmacListEndx {DE, , ms}
-Indents the display as defined by the @code{DI} register.  The @samp{.DS
-I} call generates a page break, if necessary, to keep the entire display
-on one page.  The @code{ID} macro allows the display to break across
-pages.  The @code{DE} macro ends the display.
+Indents the display by @var{indent} if specified (and by the amount of
+the @code{DI} register otherwise).  The @samp{.DS I} call generates a
+page break, if necessary, to keep the entire display on one page.  The
+@code{ID} macro allows the display to break across pages.  The @code{DE}
+macro ends the display.
 @endDefmac
 
 @DefmacList {DS, @t{B}, ms}
diff --git a/doc/ms.ms b/doc/ms.ms
index b5113cb..b8f98b7 100644
--- a/doc/ms.ms
+++ b/doc/ms.ms
@@ -1665,7 +1665,8 @@ Display macro     Description
 With keep      No keep
 _
 \&.DS L        \&.LD   Left-aligns display.
-\&.DS I [\fIindent\fP] \&.ID   T{
+\&.DS I \f[R][\,\f[I]indent\/\f[]]     \
+\&.ID \f[R][\,\f[I]indent\/\f[]]       T{
 Indents display
 (by
 .I indent
diff --git a/tmac/groff_ms.7.man b/tmac/groff_ms.7.man
index 471292f..9a32448 100644
--- a/tmac/groff_ms.7.man
+++ b/tmac/groff_ms.7.man
@@ -1047,8 +1047,14 @@ Display macro    Type of display
 With keep      No keep
 _
 \&.DS L        \&.LD   Left-justified.
-\&.DS I [\,\fIindent\/\fP]     \&.ID   T{
-Indented (default indent in the \fBDI\fP register).
+\&.DS I \f[R][\,\f[I]indent\/\f[]]     \
+\&.ID \f[R][\,\f[I]indent\/\f[]]       T{
+Indented
+(by
+.I indent
+if given,
+otherwise the value of
+.BR \[rs]n[DI] ).
 T}
 \&.DS B        \&.BD   T{
 Block-centered (left-justified, longest line centered).



reply via email to

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