[GRASS-dev] Manpage HTML markup consistency

[Dylan Beaudette]

On Sunday 24 February 2008, Patton, Eric 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.
>
> Feedback welcome,
>
> ~ Eric.
>

Eric,

I wonder if now would be a good time to investgate the use of CSS in the man 
pages. If we define a couple types of "container" objects (<div>, <span>, 
etc) we can use a single style file to later manipulate the look and feel of 
the manual pages. Something like this:


<div class="module_description">
...
</div>

<div class="module_inputs">
...
</div>

I am not CSS expert, but it would seem that we could easily create a set of 
classes - or class hierarchy to allow global changes to the style of the 
manual. The self-documenting 'class' operator might be helpful as well.


Dylan


-- 
Dylan Beaudette
Soil Resource Laboratory
http://casoilresource.lawr.ucdavis.edu/
University of California at Davis
530.754.7341