[GRASS-dev] Manpage HTML markup consistency
hamish_b at yahoo.com
Sun Feb 24 17:50:54 EST 2008
Eric Patton wrote:
> Is there any preferred way for using html markup for tagging module
> names, parameter names, and flags in the document html pages?
> From what I have seen, <b>, <em>, and <i> (or some combination
> thereof) have been variously used to highlight module names, flags
> and parameters. Although flags seem to be more consistently
> <b>oldfaced than anything else.
> For the sake of consistency between pages, and for a common look, I
> would like to adhere to a common rationale for using html markup on
> these descriptors.
> My own preference is to just boldface flags and parameter names; that
> seems to make them stand out better when scanning quickly through the
> page, more so than <em>phasis.
The common usage has been:
module names <em>
flags and option names <b> (inline text; not within <pre> code)
shell commands, names, etc <tt> (inline text; don't overuse)
emphasized phrase <i> (inline text; use instead of bolding the
code: <div class="code"><pre> ... </pre></div>
once formalized... -> SUBMITTING_DOCS
Be a better friend, newshound, and
know-it-all with Yahoo! Mobile. Try it now. http://mobile.yahoo.com/;_ylt=Ahu06i62sR8HDtDypao8Wcj9tAcJ
More information about the grass-dev