[GRASS-translations] modules translation and description.html

6 messages Options
Embed this post
Permalink
Maxim Dubinin

[GRASS-translations] modules translation and description.html

Reply Threaded More More options
Print post
Permalink
Hi all,

we've started looking into translating individual docs for modules,
but found some inconsistency between html version from the website and
description.html from some of the modules.

Take d.colorlist for example as html:
http://grass.osgeo.org/grass64/manuals/html64_user/d.colorlist.html
and compare with description.html for this command from either 6.3 or
6.4. For some reason description.html from neither 6.3 or 6.4 contains
some parts such as NAME, SYNOPSIS etc. I assume these parts are added
automatically, is it so?

Take d.color as another example
http://grass.osgeo.org/grass64/manuals/html64_user/d.colors.html
the description.html for this one from 6.3 contains NAME,SYNOPSIS etc,
but in 6.4 it does not.

Can someone explain what is going on with them and how
description.html should really look like? Based on what is in /doc for
sample module page, the description.html should start from
DESCRIPTION, is it so?

--
Best regards,
 Maxim                          mailto:[hidden email]

_______________________________________________
grass-translations mailing list
[hidden email]
http://lists.osgeo.org/mailman/listinfo/grass-translations
Markus Neteler

Re: [GRASS-translations] modules translation and description.html

Reply Threaded More More options
Print post
Permalink
Hi Maxim,

On Tue, Dec 16, 2008 at 10:51 PM, Maxim Dubinin <[hidden email]> wrote:
> Hi all,
>
> we've started looking into translating individual docs for modules,
> but found some inconsistency between html version from the website and
> description.html from some of the modules.

Note that description.html in the source code is used to *construct*
the final HTML version (this happens when the source code is
compiled).

> Take d.colorlist for example as html:
> http://grass.osgeo.org/grass64/manuals/html64_user/d.colorlist.html
> and compare with description.html for this command from either 6.3 or
> 6.4. For some reason description.html from neither 6.3 or 6.4 contains
> some parts such as NAME, SYNOPSIS etc. I assume these parts are added
> automatically, is it so?

Exactly.
Each module, using --html-description flag, generates the HTML template
which is then combined with the content of description.html.

...
> Can someone explain what is going on with them and how
> description.html should really look like? Based on what is in /doc for
> sample module page, the description.html should start from
> DESCRIPTION, is it so?

description.html contains the real descriptive content without parameters,
flags etc.

For translations, description.html is relevant. Not the web page.

Hope it is clear now.

Markus
_______________________________________________
grass-translations mailing list
[hidden email]
http://lists.osgeo.org/mailman/listinfo/grass-translations
Markus Neteler

Re: Re[2]: [GRASS-translations] modules translation and description.html

Reply Threaded More More options
Print post
Permalink
(cc to list)

On Thu, Dec 18, 2008 at 6:09 PM, Maxim Dubinin <[hidden email]> wrote:
> Thanks for explanations, this was more or less how I understand it
> too.
>
> Now for the second part of my question, do I understand right then,
> that this was simply incorrectly formed module doc?
> http://trac.osgeo.org/grass/browser/grass/branches/releasebranch_6_3/display/d.colors/description.html

ah, now I get it!
Yes, that was AFAIK wrong, I have it removed (please check again above link).

> thus fixed for 6.4
> http://trac.osgeo.org/grass/browser/grass/branches/develbranch_6/display/d.colors/description.html

Right.
Note that a *few* modules really need the header part included in
description.html since the modules cannot generate the template.

Best regards,
Markus
_______________________________________________
grass-translations mailing list
[hidden email]
http://lists.osgeo.org/mailman/listinfo/grass-translations
Maxim Dubinin

Re[4]: [GRASS-translations] modules translation and description.html

Reply Threaded More More options
Print post
Permalink
Will it help if I provide list of modules, for which docs are
not fixed in develbranch_6? Some of them are among those *few* that
actually need header, I assume.

Also I've notice that for some modules description.html is substituted
by module-name.html (see for example r.mapcalc.html, lrs.html), is it
normal? Just wondering.

Anyway, here is the list:

http://trac.osgeo.org/grass/browser/grass/branches/develbranch_6/display/drivers/cairo/description.html
http://trac.osgeo.org/grass/browser/grass/branches/develbranch_6/general/g.parser/description.html
http://trac.osgeo.org/grass/browser/grass/branches/develbranch_6/general/g.setproj/description.html
http://trac.osgeo.org/grass/browser/grass/branches/develbranch_6/display/drivers/PNG/description.html
http://trac.osgeo.org/grass/browser/grass/branches/develbranch_6/display/drivers/PS/description.html
http://trac.osgeo.org/grass/browser/grass/branches/develbranch_6/raster/r.li/description.html
http://trac.osgeo.org/grass/browser/grass/branches/develbranch_6/raster/r.li/r.li.daemon/description.html
http://trac.osgeo.org/grass/browser/grass/branches/develbranch_6/lib/db/sqlp/description.html
http://trac.osgeo.org/grass/browser/grass/branches/develbranch_6/display/drivers/XDRIVER/description.html
http://trac.osgeo.org/grass/browser/grass/branches/develbranch_6/vector/v.lrs/lrs.html
http://trac.osgeo.org/grass/browser/grass/branches/develbranch_6/raster/r.mapcalc/r.mapcalc.html
http://trac.osgeo.org/grass/browser/grass/branches/develbranch_6/raster/r.mapcalc/r3.mapcalc.html

--
Best regards,
 Maxim

Вы писали 18 декабря 2008 г., 11:36:09:

MN> (cc to list)

MN> On Thu, Dec 18, 2008 at 6:09 PM, Maxim Dubinin <[hidden email]> wrote:
>> Thanks for explanations, this was more or less how I understand it
>> too.
>>
>> Now for the second part of my question, do I understand right then,
>> that this was simply incorrectly formed module doc?
>> http://trac.osgeo.org/grass/browser/grass/branches/releasebranch_6_3/display/d.colors/description.html

MN> ah, now I get it!
MN> Yes, that was AFAIK wrong, I have it removed (please check again above link).

>> thus fixed for 6.4
>> http://trac.osgeo.org/grass/browser/grass/branches/develbranch_6/display/d.colors/description.html

MN> Right.
MN> Note that a *few* modules really need the header part included in
MN> description.html since the modules cannot generate the template.

MN> Best regards,
MN> Markus

_______________________________________________
grass-translations mailing list
[hidden email]
http://lists.osgeo.org/mailman/listinfo/grass-translations
Markus Neteler

Re: Re[4]: [GRASS-translations] modules translation and description.html

Reply Threaded More More options
Print post
Permalink
On Thu, Dec 18, 2008 at 7:14 PM, Maxim Dubinin <[hidden email]> wrote:
> Will it help if I provide list of modules, for which docs are
> not fixed in develbranch_6? Some of them are among those *few* that
> actually need header, I assume.

See comments below.

> Also I've notice that for some modules description.html is substituted
> by module-name.html (see for example r.mapcalc.html, lrs.html), is it
> normal? Just wondering.

Yes, normal. eg in raster/r.mapcalc/ are both r.mapcalc.html and
r3.mapcalc.html, so  description.html won't work here.

lrs.html and the *intro.html pages are "metapages" without module
but introductive stuff.


> Anyway, here is the list:

[reordered]

These are drivers and no modules/commands, so ok:
> http://trac.osgeo.org/grass/browser/grass/branches/develbranch_6/display/drivers/cairo/description.html
> http://trac.osgeo.org/grass/browser/grass/branches/develbranch_6/display/drivers/PNG/description.html
> http://trac.osgeo.org/grass/browser/grass/branches/develbranch_6/display/drivers/PS/description.html
> http://trac.osgeo.org/grass/browser/grass/branches/develbranch_6/display/drivers/XDRIVER/description.html
> http://trac.osgeo.org/grass/browser/grass/branches/develbranch_6/lib/db/sqlp/description.html


"metapages" without module but introductive stuff:
> http://trac.osgeo.org/grass/browser/grass/branches/develbranch_6/raster/r.li/description.html
> http://trac.osgeo.org/grass/browser/grass/branches/develbranch_6/vector/v.lrs/lrs.html


These modules cannot generate the HTML template for technical
reasons:
> http://trac.osgeo.org/grass/browser/grass/branches/develbranch_6/general/g.parser/description.html
> http://trac.osgeo.org/grass/browser/grass/branches/develbranch_6/general/g.setproj/description.html
> http://trac.osgeo.org/grass/browser/grass/branches/develbranch_6/raster/r.li/r.li.daemon/description.html

More than one module in the directory:
> http://trac.osgeo.org/grass/browser/grass/branches/develbranch_6/raster/r.mapcalc/r.mapcalc.html
> http://trac.osgeo.org/grass/browser/grass/branches/develbranch_6/raster/r.mapcalc/r3.mapcalc.html

Everything looks ok!

Markus
_______________________________________________
grass-translations mailing list
[hidden email]
http://lists.osgeo.org/mailman/listinfo/grass-translations
Glynn Clements

Re: Re[4]: [GRASS-translations] modules translation and description.html

Reply Threaded More More options
Print post
Permalink
In reply to this post by Maxim Dubinin

Maxim Dubinin wrote:

> Will it help if I provide list of modules, for which docs are
> not fixed in develbranch_6? Some of them are among those *few* that
> actually need header, I assume.

In general, most user-visible modules generate the header dynamically,
while libraries, drivers, support programs and a few (mostly
interactive) modules don't.

> Also I've notice that for some modules description.html is substituted
> by module-name.html (see for example r.mapcalc.html, lrs.html), is it
> normal? Just wondering.

If more than one module is built from a directory, the HTML files are
named after the module. Directories which just install static HTML
files typically name them (or at least one of them, if there are
several) as they see fit (description.html and <module>.html are built
into the make logic which generates HTML files).

FWIW, the situation has changed quite a bit in 7.0:

1. HTML files are always named after the module, never
description.html.

2. There are fewer modules which don't generate the header.

3. The resulting HTML files must be valid according to the HTML4
(transitional) DTD or you get an error (the script which converts the
HTML files to nroff manual pages changed from a Perl mess which uses
ad-hoc search/replace to one which uses a real HTML parser).

--
Glynn Clements <[hidden email]>
_______________________________________________
grass-translations mailing list
[hidden email]
http://lists.osgeo.org/mailman/listinfo/grass-translations