Re: GDP Stylee

[Karl Eichwalder <keichwa gmx net>]

Aaron Weber <aaron@helixcode.com> writes:

> I've got a rev of the GDP handbook w/style section in it on my web page:
> http://primates.helixcode.com/~aaron/gdp.html

Nice overview and a good reading!  Random notes:

 I vote to avoid the <prompt> tag in running text.  It should be enough
to say:

    Call <command>db2html</command> to produce HTML.

Writing "<prompt>$</prompt> <command>db2html</command>" will confuse the
reader.  Maybe, it's okay to write long commands like this:

    <literallayout format="linespecific" class="input">
    <prompt> $ </prompt><command>db2html --nochunks mydoc.sgml</command>
    </literallayout>


. <variable> is the wrong tag talking about environment variables;
instead use <envar>.  Example: <envar>EDITOR</envar>.

-- 
work : ke@suse.de                          |          ------    ,__o
     : http://www.suse.de/~ke/             |         ------   _-\_<,
home : keichwa@gmx.net                     |        ------   (*)/'(*)