[GRASS-dev] Re: GRASS documentation

Mon Nov 5 02:09:05 EST 2007

Michael Barton wrote:

> 4. The doc page is just plain ASCII text with html tags. You can look at 
> it in any text editor or an html editor. BUT CAUTION. Many slick html 
> editors will try to add in extra tags (CSS or other). MS Word is 
> especially notorioius for this. If you want to use an html editor, I can 
> recommend KompoZer. It is an open source WYSIWYG html editor (successor 
> to NVU) and located at <http://kompozer.sourceforge.net/>. Make sure you 
> turn OFF cascading style sheets in the preferences.

Have you actually tried using an HTML editor on those files? They
aren't valid HTML, and aren't supposed to be. In particular, they lack
the DOCTYPE declaration, the <head>...</head> section, and the opening
<html> and <body> tags (but include the closing tags).

Anything which tries to save anything resembling valid HTML will have
to have its output edited manually. Those files *must not* contain any
of the parts which are output by the --html-description option.

Also:

1. They must not contain tags or entities which are not understood by
the g.html2man script (tools/g.html2man/g.html2man).

2. Any portions which are not modified must not be re-formatted during
the editing process, as this will make the output from "cvs diff"
useless.

IOW: do not use a "WYSYWIG" HTML editor on those files, but either a
normal text editor or something which is designed for editing HTML
*source* (e.g. [X]Emacs' html-mode or psgml-mode).

-- 
Glynn Clements <glynn at gclements.plus.com>