Hi all,
- documentation cosmetics -
I have extended:
lib/gis/parser.c
include/Make/Html.make (separated from Rules.html)
tools/build_html_index.sh
to generate an additional HTML header line to include a simple
CSS style file. Basically the examples can be coded now
like this in the 'description.html' files:
<div class="code"><pre>
v.to.db -p roads option=length type=line units=k
</pre></div>
Such an example appears indented with type write font in a grey box
which makes it easier to distinguish in the text flow.
And: Section titles are green colored now (such as the GRASS Web site).
Example:
vector/v.to.db/description.html
TODO 1:
Now all the tons of examples should be homogenized and changed to
above style.
TODO 2: Fix tools/g.html2man/g.html2man to accept multiple lines
in above environment (two or more lines of example in a single
<div class="code"><pre>
...
...
</pre></div>
At time the line break is eaten and not preserved (hi Daniel, maybe
you could help?). Maybe these examples could be indented a bit in the
MAN pages?
By tomorrow morning Italian time the updated man pages will be online.
Markus
That's a great move. Do you think it makes sense to use another <div> for output?
Someting else: since this needs to be done for every description.html, it
might be good to revise the examples and make them all work with spearfish.
What do we gain? It's a very good starting point for building a (minimal) set
of regression tests. I'm positive that is something to do for 7.0.
I'm revising g.html2man to take care of line breaks within PRE. Should land on
CVS today.
Daniel.
-- Daniel Calvelo Aros
---------- Original Message -----------
From: Markus Neteler <neteler@itc.it>
To: grass developers list <grass5@grass.itc.it>
Sent: Fri, 4 Nov 2005 17:21:41 +0100
Subject: [GRASS5] New CSS based doc style for GRASS usage examples
Hi all,
- documentation cosmetics -
I have extended:
lib/gis/parser.c
include/Make/Html.make (separated from Rules.html)
tools/build_html_index.sh
to generate an additional HTML header line to include a simple
CSS style file. Basically the examples can be coded now
like this in the 'description.html' files:
<div class="code"><pre>
v.to.db -p roads option=length type=line units=k
</pre></div>
Such an example appears indented with type write font in a grey box
which makes it easier to distinguish in the text flow.
And: Section titles are green colored now (such as the GRASS Web
site).
Example:
vector/v.to.db/description.html
TODO 1:
Now all the tons of examples should be homogenized and changed to
above style.
TODO 2: Fix tools/g.html2man/g.html2man to accept multiple lines
in above environment (two or more lines of example in a single
<div class="code"><pre>
...
...
</pre></div>
At time the line break is eaten and not preserved (hi Daniel, maybe
you could help?). Maybe these examples could be indented a bit in the
MAN pages?
By tomorrow morning Italian time the updated man pages will be online.
Markus
_______________________________________________
grass5 mailing list
grass5@grass.itc.it
http://grass.itc.it/mailman/listinfo/grass5
------- End of Original Message -------
On Fri, Nov 04, 2005 at 12:14:22PM -0500, Daniel Calvelo Aros wrote:
That's a great move. Do you think it makes sense to use another <div> for output?
Well, maybe (no idea).
Someting else: since this needs to be done for every description.html, it
might be good to revise the examples and make them all work with spearfish.
Yes, fully agreed (and I tried as much is possible for examples written
by me).
What do we gain? It's a very good starting point for building a (minimal) set
of regression tests. I'm positive that is something to do for 7.0.
I'm revising g.html2man to take care of line breaks within PRE. Should land on
CVS today.
Nice, thanks!
Markus