groff-commit
[Top][All Lists]
Advanced

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

[groff] 01/07: groff_www(7): Stop using the "www" macro package.


From: G. Branden Robinson
Subject: [groff] 01/07: groff_www(7): Stop using the "www" macro package.
Date: Sat, 22 May 2021 09:14:44 -0400 (EDT)

gbranden pushed a commit to branch master
in repository groff.

commit 4ab064b69782f5e5b473e42b52f1635e06671cc6
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Sat May 22 16:55:24 2021 +1000

    groff_www(7): Stop using the "www" macro package.
    
    * tmac/groff_www.7.man: Stop using the "www" macro package.  The macros
      it exposes are not part of the quasi-standardized man(7) language, and
      thus should not be used in man(7) documents.  See groff_man_style(7)
      for portability advice.  Besides, the extension macros in the
      permissively-licensed an-ext.tmac are sufficient to support URL and
      email hyperlinks, and our SH and SS macro implementations already
      support anchor placement without requiring explicit effort from page
      authors.
    
      (initialization): Stop sourcing www.tmac.  Stop calling .LK and .HR;
      the page-internal navigation links were being placed after the apropos
      line instead of at the beginning of the page, contradicting the
      comment that was there (possibly a bug).
    
      (Requests) <URL, LK>: Stop calling .TAG.
    
      <LK>: Drop paragraph advising reader to format page for groff's HTML
      output device to observe the naviagtion links at that point in the
      test.
    
    Also:
    * Break input lines at commas.
    * Use Oxford comma.
---
 ChangeLog            | 19 +++++++++++++++++++
 tmac/groff_www.7.man | 23 +++--------------------
 2 files changed, 22 insertions(+), 20 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 268972b..95e72bf 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,24 @@
 2021-05-22  G. Branden Robinson <g.branden.robinson@gmail.com>
 
+       * tmac/groff_www.7.man: Stop using the "www" macro package.  The
+       macros it exposes are not part of the quasi-standardized man(7)
+       language, and thus should not be used in man(7) documents.  See
+       groff_man_style(7) for portability advice.  Besides, the
+       extension macros in the permissively-licensed an-ext.tmac are
+       sufficient to support URL and email hyperlinks, and our SH and
+       SS macro implementations already support anchor placement
+       without requiring explicit effort from page authors.
+       (initialization): Stop sourcing www.tmac.  Stop calling .LK and
+       .HR; the page-internal navigation links were being placed after
+       the apropos line instead of at the beginning of the page,
+       contradicting the comment that was there (possibly a bug).
+       (Requests) <URL, LK>: Stop calling .TAG.
+       <LK>: Drop paragraph advising reader to format page for groff's
+       HTML output device to observe the naviagtion links at that point
+       in the test.
+
+2021-05-22  G. Branden Robinson <g.branden.robinson@gmail.com>
+
        * doc/groff.texi (Comments): Fix error in description of parser
        operation; '.\"' is an effective whole-line comment not because
        it is a call of an undefined macro named '\"' (no 'mac' warning
diff --git a/tmac/groff_www.7.man b/tmac/groff_www.7.man
index 29b7e4e..ac6af70 100644
--- a/tmac/groff_www.7.man
+++ b/tmac/groff_www.7.man
@@ -29,15 +29,6 @@ groff_www \- GNU roff macros for authoring web pages
 .\" Save and disable compatibility mode (for, e.g., Solaris 10/11).
 .do nr *groff_groff_www_7_man_C \n[.cp]
 .cp 0
-.do mso www.tmac
-.
-.
-.\" we need the .LK here as we use it in the middle as an example --
-.\" once the user requests .LK then the automatic generation of links
-.\" at the top of the document is suppressed.
-.LK
-.
-.HR
 .
 .
 .\" ====================================================================
@@ -202,9 +193,9 @@ the only parameter to this macro is the background image 
file.
 .
 .TP
 .B .URL url [description] [after]
-generates
-.TAG URL
-a URL using either one, two or three arguments.
+generates a URL using either one,
+two,
+or three arguments.
 .
 The first parameter is the actual URL, the second is the name of the
 link, and the third is optional stuff to be printed immediately
@@ -510,18 +501,10 @@ End heading.
 .
 .TP
 .B .LK
-.TAG LK
 Force
 .I \%grohtml
 to place the automatically generated links at this position.
 .
-If this manual page has been processed with
-.B \-Thtml
-or
-.B \-Txhtml
-those links can be seen right here.
-.
-.LK
 .
 .TP
 .B .HR



reply via email to

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