[GRASS-dev] Manpage HTML markup consistency

Patton, Eric epatton at nrcan.gc.ca
Sun Feb 24 17:22:08 EST 2008


E:
>> Is there any preferred way for using html markup for tagging module names, parameter names, and flags in the document html pages?

M:
>AFAIK not really. It would be reasonable to define these rules and
>update SUBMITTING_DOCS document accordingly.

>>  >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.

>+1 for <b>flag</b> and <b>name</b>

By name, you meant any module parameter?

>
>* <em>module</em> or <em><a href="module.html">module</em> for
>external references
>
>* <h2>See also</h2>
><em>
><a href="module1.html">module1</a>,
><a href="module2.html">module2</a>
><em>
>
>instead of
>
><em>
><a href="module1.html">module1</a>,<br>
><a href="module2.html">module2</a>
><em>
>
>Martin

Thanks for feedback,

~ Eric.


More information about the grass-dev mailing list