groff-commit
[Top][All Lists]
Advanced

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

[groff] 03/35: [mm]: Update documentation of ISO date feature.


From: G. Branden Robinson
Subject: [groff] 03/35: [mm]: Update documentation of ISO date feature.
Date: Fri, 16 Jul 2021 20:39:37 -0400 (EDT)

gbranden pushed a commit to branch master
in repository groff.

commit 4f3b1e335abbcf16f7490fefb5abb17dd8a8a562
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Tue Jul 13 22:19:53 2021 +1000

    [mm]: Update documentation of ISO date feature.
    
    * contrib/mm/NOTES: Tighten wording and fix grammar.
    
    * contrib/mm/groff_mm.7.man (Description/Macros) <ISODATE>: Clarify.
      Note that the string thus set is used only by some cover sheet and
      memorandum types.  Indicate when the macro must be called to be
      effective.  Better describe "old" (U.S. traditional) date format.
    
      (Description/Registers used in mm) <Iso>: Clarify operation.  Defining
      the register with _any_ value (before mm is loaded) makes it
      effective.  Add cross reference to `ISODATE` macro.
---
 contrib/mm/NOTES          |  2 +-
 contrib/mm/groff_mm.7.man | 36 ++++++++++++++++++++++++------------
 2 files changed, 25 insertions(+), 13 deletions(-)

diff --git a/contrib/mm/NOTES b/contrib/mm/NOTES
index 1696529..d3c8fe7 100644
--- a/contrib/mm/NOTES
+++ b/contrib/mm/NOTES
@@ -76,7 +76,7 @@ cov*abs-name          S       The string 'ABSTRACT', changed 
with .AST
 
 cov*abstract           M       The abstract.
 
-cov*new-date           S       The date (todays date if ND is not used)
+cov*new-date           S       date (today if .ND not used)
 
 cov*mt-type            S       MT type
 cov*mt-addresse        S       MT addressee
diff --git a/contrib/mm/groff_mm.7.man b/contrib/mm/groff_mm.7.man
index 266517f..7ae4c1a 100644
--- a/contrib/mm/groff_mm.7.man
+++ b/contrib/mm/groff_mm.7.man
@@ -1806,18 +1806,23 @@ is called instead of printing \[oq]INDEX\[cq], and
 is called after the printing and should take care of restoring to
 normal operation again.
 .
+.
 .TP
-.B ISODATE \fR[\fP0\fR]\fP
-Change the predefined date string in
-.B DT
-to ISO-format, this is, \[oq]YYYY-MM-DD\[cq].
+.BR ISODATE\~ [ 0 ]
+Change the date used by some cover sheet and memorandum types to
+ISO\~8601 format;
+that is,
+.IR YYYY - MM - DD .
+.
+Must be called before
+.B ND
+to be effective.
 .
-This can also be done by adding
-.B \-rIso=1
-on the command line.
+If given an argument
+.RB of\~ 0,
+U.S.\& traditional date format is used
+(this is the default).
 .
-Reverts to old date format if argument is\~\c
-.BR 0 .
 .
 .TP
 .BI IR\  "\fR[\fPitalic-text \fR[\fProman-text \fR[\fPitalic-text 
\fR[.\|.\|.]]]]\fP"
@@ -3654,12 +3659,19 @@ l l.
 .IP
 Default is\~0.
 .
+.
 .TP
 .B Iso
-Set this variable to\~1 on the command line to get an ISO-formatted
-date string (\fB\-rIso=1\fP).
+Define this register
+(to any value)
+on the command line to use ISO\~8601 date format
+(e.g.,
+.RB \[lq] \-rIso=1 \[rq]).
+.
+See macro
+.B ISODATE
+above.
 .
-Useless inside of a document.
 .
 .TP
 .B L



reply via email to

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