diff options
author | G. Branden Robinson <g.branden.robinson@gmail.com> | 2021-05-22 16:55:24 +1000 |
---|---|---|
committer | G. Branden Robinson <g.branden.robinson@gmail.com> | 2021-05-22 16:55:24 +1000 |
commit | 4ab064b69782f5e5b473e42b52f1635e06671cc6 (patch) | |
tree | 93905e3968ecab97d2e4a6f67894d836dc80e123 | |
parent | 3533498a1effa5346630438d947182d754fb4e04 (diff) | |
download | groff-git-4ab064b69782f5e5b473e42b52f1635e06671cc6.tar.gz |
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.
-rw-r--r-- | ChangeLog | 19 | ||||
-rw-r--r-- | tmac/groff_www.7.man | 23 |
2 files changed, 22 insertions, 20 deletions
@@ -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 29b7e4ef4..ac6af707b 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 |