diff options
author | gaius <gaius> | 2005-11-28 08:40:21 +0000 |
---|---|---|
committer | gaius <gaius> | 2005-11-28 08:40:21 +0000 |
commit | 67ffbefb3ac0fe267e48086b0cb3eaf600e69e62 (patch) | |
tree | c73cd888fc782683d3cd7b7c452aae12cfc624f2 | |
parent | 39a88aed140da462b23fe81a52f0175a8767b4c5 (diff) | |
download | groff-67ffbefb3ac0fe267e48086b0cb3eaf600e69e62.tar.gz |
* doc/Makefile.in: separate rule for webpage.html so that extra
command line options can be passed to grohtml.
* doc/groff.css: changed all margins to 0%.
* doc/webpage.ms: now uses new macros ALN, LNS and LNE
so that left navigation is exploited. Also updated webpage to
contain new sections on licences, mailing lists, cvs/ftp
access, groff dependencies and bug reports.
* tmac/groff_www.man: documented the new macros ALN, LNS and LNE.
* tmac/www.tmac: implemented the new macros ALN, LNS and LNE.
-rw-r--r-- | ChangeLog | 12 | ||||
-rw-r--r-- | doc/Makefile.in | 4 | ||||
-rw-r--r-- | doc/groff.css | 8 | ||||
-rw-r--r-- | doc/webpage.ms | 100 | ||||
-rw-r--r-- | tmac/groff_www.man | 32 | ||||
-rw-r--r-- | tmac/www.tmac | 71 |
6 files changed, 175 insertions, 52 deletions
@@ -1,3 +1,15 @@ +2005-11-28 Gaius Mulley <gaius@glam.ac.uk> + + * doc/Makefile.in: separate rule for webpage.html so that extra + command line options can be passed to grohtml. + * doc/groff.css: changed all margins to 0%. + * doc/webpage.ms: now uses new macros ALN, LNS and LNE + so that left navigation is exploited. Also updated webpage to + contain new sections on licences, mailing lists, cvs/ftp + access, groff dependencies and bug reports. + * tmac/groff_www.man: documented the new macros ALN, LNS and LNE. + * tmac/www.tmac: implemented the new macros ALN, LNS and LNE. + 2005-11-25 Gaius Mulley <gaius@glam.ac.uk> * src/devices/grohtml/post-html.cpp diff --git a/doc/Makefile.in b/doc/Makefile.in index 96f307e0..4de9e5df 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -127,6 +127,10 @@ pic.html: pic.ms -Thtml -ms >$@ webpage.html: webpage.ms gnu.png gnu.eps groff.css + $(GROFF) -P-j`basename $< | sed -e 's|.ms$$||'` \ + -P-n -P-r -P-p -P-b -P-I`basename $< | sed -e 's|.ms$$||'` \ + -P-D$(imagedir) -Thtml -ms >$@ + webpage.ps: gnu.eps grnexmpl.ps: grnexmpl.me grnexmpl.g diff --git a/doc/groff.css b/doc/groff.css index ba36f6ed..5432bcdc 100644 --- a/doc/groff.css +++ b/doc/groff.css @@ -1,9 +1,9 @@ body { - margin-top: 5%; - margin-left: 5%; - margin-right: 5%; - margin-bottom: 5%; + margin-top: 0%; + margin-left: 0%; + margin-right: 0%; + margin-bottom: 0%; background-color: white; color: black; } diff --git a/doc/webpage.ms b/doc/webpage.ms index 3d1bf954..4a9a827b 100644 --- a/doc/webpage.ms +++ b/doc/webpage.ms @@ -14,6 +14,7 @@ .\" .HEAD "<link rel=""icon"" type=""image/png"" href=""http://www.gnu.org/graphics/gnu-mini.png"" >" . .mso www.tmac +.ALN "#eeeeee" 30 . .de blm-macro . nr tmp \\n[.i] @@ -22,7 +23,7 @@ .. .blm blm-macro . -.HX 0 +.HX 1 . .defcolor mydarkred rgb 0.65f 0.1f 0.2f .defcolor mydarkgreen rgb 0.1f 0.5f 0.2f @@ -35,37 +36,24 @@ . Home of Groff (GNU Troff). . -. .HTML-IMAGE-LEFT .PSPIC -L gnu.eps 2i 2i .ie r ps4html \ -. nop \v'-0.66i'\h'2.0i'\s[100]\*[GNU] Troff\s0 +. nop \v'-0.66i'\h'2.0i'\s[80]\*[GNU] Troff\s0 .el \ . nop \v'-0.66i'\h'2.0i'\s[60]\*[GNU] Troff\s0 .HTML-IMAGE-END . .HR -.HnS 1 -GNU Troff (\c -.URL http://\:groff.ffii.org/ Groff ) -\[em] a -.URL http://\:www.gnu.org/ GNU -project. -.HnE -.HR -.LK . -.LP -.DC T HE mydarkred -groff (GNU Troff) software -is a typesetting package which reads plain text mixed with -formatting commands and produces formatted output. -Groff now supports HTML. +.LNS . +.DC T HIS mydarkred +is the home page for groff (\c +.URL http://\:www.gnu.org/ GNU +Troff). Groff is a software typesetting package which reads plain +text mixed with formatting commands and produces formatted output. . -.SH -Download - The source code of the currently released versions of groff is available at the .URL "http://\:groff.ffii.org/\:groff/" "FFII host (Germany)" , @@ -74,8 +62,7 @@ and its mirrors. . The USA site also contains older, obsolete versions. -The most actual pre-release, development version is available from a -CVS repository, see below. +The development version is available from a CVS repository, see below. . Development snapshots (produced twice a day from the CVS repository) can be downloaded from @@ -84,8 +71,11 @@ can be downloaded from For a special version of groff on the Microsoft operating systems, see .URL "http://\:gnuwin32.sf.net/\:packages/\:groffl.htm" "Groff for Windows" . -GNU troff is released under the -.URL http://\:www.gnu.org/\:copyleft/\:gpl.html "GNU Copyright License" . +Groff was originally written and maintained by James Clark, however it +is now maintained by +.MTO Ted.Harding@\:nessie.mcc.ac.uk "Ted Harding" +and +.MTO wl@\:gnu.org "Werner Lemberg" . User issues lead: .MTO Ted.Harding@\:nessie.mcc.ac.uk "Ted Harding" . @@ -93,10 +83,28 @@ User issues lead: Technical issues lead: .MTO wl@\:gnu.org "Werner Lemberg" . . +.LNE +. +\s[-4]\f[I]This document was produced using +.URL http://groff.ffii.org/ groff-\n[.x].\n[.y].\n[.Y] . +.br +The image at the top has been contributed by Imogen Mulley (born 1991), +based on a similar picture found on the +.URL http://www.gnu.org "GNU server" . +.HR +.SH +Licence +.LP +GNU troff is released under the +.URL http://\:www.gnu.org/\:copyleft/\:gpl.html "GNU Copyright License" . +The documentation is released under the +.URL http://\:www.gnu.org/\:copyleft/\:fdl.html "Free Documentation License" . +Groff is an official GNU project as defined on +.URL http://\:savannah.gnu.org savannah . . .SH README - +.LP This is the GNU groff document formatting system. The version number is given in the file VERSION. @@ -120,6 +128,9 @@ See the file COPYING for copying permission. The file PROBLEMS describes various problems that have been encountered in compiling, installing, and running groff. +.SH +CVS and FTP access +.LP The most recent released version of groff is always available by .URL "ftp://\:ftp.gnu.org/\:gnu/\:groff" "anonymous ftp" . @@ -186,7 +197,9 @@ gunzip -c ../groff-\[la]version\[ra]-current.diff.gz | patch -p1 .ft P .fi .in - +.SH +Groff dependancies +.LP Depending on your requirements, you may need at least some of the following tools to build groff directly from its source: @@ -215,6 +228,9 @@ output. If you don't intend to produce output in either of these formats, then these packages are unnecessary. +.SH +Bug reports +.LP Please report bugs using the form in the file BUG-REPORT; the idea of this is to make sure that FSF has all the information it needs to fix the bug. At the very least, read the BUG-REPORT form and make sure that you supply @@ -223,6 +239,9 @@ Even if you are not sure that something is a bug, report it using BUG-REPORT: this will enable us to determine whether it really is a bug or not. +.SH +Mailing lists +.LP Three mailing lists are available: .ULS @@ -260,17 +279,9 @@ Alternatively, you may subscribe by visiting the web pages at Each of these web pages also provides a link to a browseable archive of postings to the corresponding mailing list. -GNU groff was written by -.MTO jjc@\:jclark.com "James Clark" . -It is now maintained by -.MTO Ted.Harding@\:nessie.mcc.ac.uk "Ted Harding" -and -.MTO wl@\:gnu.org "Werner Lemberg" . -. -. .SH NEWS VERSION 1.19.2 -. +.LP .SH 2 troff .ULS @@ -530,7 +541,7 @@ and the latter makes troff always use unscaled character widths. . .SH NEWS VERSION 1.19.1 -. +.LP .SH 2 groff @@ -732,7 +743,7 @@ section. . .SH NEWS VERSION 1.19 -. +.LP .SH 2 troff @@ -1061,7 +1072,7 @@ groff -Tps -dpaper=a4l -P-pa4 -P-l -ms foo.ms > foo.ps . .SH NEWS VERSION 1.18.1 -. +.LP .SH 2 troff @@ -1173,7 +1184,7 @@ for a PostScript font definition file FOO. . .SH NEWS VERSION 1.18 - +.LP This section describes recent user-visible changes in groff. Bug fixes are not described. There are more details in the man pages. @@ -1821,13 +1832,6 @@ grops, grolj4, and grolbp use it currently. troff completely ignores it. .ULE . -.HR +.LNE . -\s[-2]\f[I]This document was produced using -.URL http://groff.ffii.org/ groff-\n[.x].\n[.y].\n[.Y] . -.br -The image at the top has been contributed by Imogen Mulley (born 1991), -based on a similar picture found on the -.URL http://www.gnu.org "GNU server" . -.HR .\" EOF diff --git a/tmac/groff_www.man b/tmac/groff_www.man index e4b3f524..efc07e3e 100644 --- a/tmac/groff_www.man +++ b/tmac/groff_www.man @@ -97,6 +97,11 @@ Here is a summary of the functions found in this macro set. device driver \&.CDS code example begin \&.CDE code example end +\&.ALN place links on left of + main text. +\&.LNS start a new two column + table with links in the left. +\&.LNE end the two column table. .fi .PP Output of the @@ -480,6 +485,33 @@ Start displaying a code section in constant width font. .B ".CDE" End code display . +.TP +.B ".ALN [color] [percentage]" +Place section heading links automatically to the left of the main +text. The color argument is optional and if present indicates which +HTML background color is to be used under the links. +The optional percentage indicates the amount of width to devote to +displaying the links. The default values are #eeeeee and 30 +for color and percentage width respectively. +This macro should only be called once at the beginning of the document. +Once this macro has been called each section heading will emit an +HTML table consisting of the links in the left and the section text +on the right. +. +.TP +.B ".LNS" +Start a new two column table with links in the left column. +This can be called if the document has text before the first .SH +and if .ALN is used. Typically this is called just before the +first paragraph and after the main title as it indicates that +text after this point should be positioned to the right of +the left hand navigational links. +. +.TP +.B ".LNE" +End a two column table. This should be called at the end of the +document if .ALN was used. +. .SH SECTION HEADING LINKS By default .B \%grohtml diff --git a/tmac/www.tmac b/tmac/www.tmac index 5dcbd1ee..0e3c76fe 100644 --- a/tmac/www.tmac +++ b/tmac/www.tmac @@ -1215,6 +1215,77 @@ www functionality. It should work with any macro set. .ft P .. . +.ds www-nav-colour "#eeeeee +.nr www-nav-width-left 30 +.nr www-nav-width-right 70 +. +. +.\" LNS - left navigation start +. +.de LNS +. HTML</p> "<table><tr><td valign=top width=\\n[www-nav-width-left]% bgcolor=""\\*[www-nav-colour]"">" +. LK +. HTML</p> "</td><td valign=top width=\\n[www-nav-width-right]%>" +. nr SH-open 1 +.. +. +.\" LNE - left navigation end +. +.de LNE +. HTML</p> </td></tr></table> +. HR +.. +.nr SH-open 0 +.nr needs-begin 0 +. +. +.de www-SH +. if (0\\$1 == 0) \{\ +. if (\\n[SH-open] == 1) .LNE +. nr needs-begin 1 +. @SH-old +. \} +.. +. +.de www-NH +. if (0\\$1 <= 1) \{\ +. if (\\n[SH-open] == 1) .LNE +. nr needs-begin 1 +. @NH-old +. \} +.. +. +.de www-LP +. @LP-old +. if (\\n[needs-begin] == 1) \{\ +. HR +. LNS +. \} +. nr needs-begin 0 +.. +. +.\" ALN [colour] [left width percentage] +.\" turns on automatic left navigation, this macro should only be +.\" called once (normally at the start of the document) as it +.\" indicates the all top level section headings will form a +.\" navigation list on the left of the main text. +. +.de ALN +. if '\*(.T'html' \{\ +. if !'\\$1'' .ds www-nav-colour \\$1 +. if (0\\$2 > 0) \{\ +. nr www-nav-width-left \\$2 +. nr www-nav-width-right (100-\\$2) +. \} +. rn @SH @SH-old +. rn www-SH @SH +. rn @NH @NH-old +. rn www-NH @NH +. rn @LP @LP-old +. rn www-LP @LP +. \} +.. +. .if r ps4html .nop \O[0] .cp \n(_C . |