On Sun, 8 Feb 2004, Cristian Rigamonti wrote:
Hi Allin and friends, having completed the Italian translation of
gretl, I've started thinking about translating some of its
documentation, and I have a couple of questions...
- I'd start from the web page: can I just download the HTML file
translate it, or is there another source document (SGML/XML...) for
it? Is it stored somewhere in the CVS (I've checked, but it doesn't
No, at present the web pages are not in CVS, but it might be a good
idea to add them. Since the information that appears on the web pages
is not required in any other format than HTML, I have not stored them
in XML. But I do have one "convenience" feature: they are stored in
"template" form so that when I make a new release I can run run a
simple shell script to update the date and version information. I
will plan to add these "template" HTML files to CVS.
- I'd then go on with the online help files; I've noticed
content from the /share/*.hlp files overlaps with the content of the
/doc/chapters/cmdref.xml file (the Manual's "Command Reference"
chapter). I had a look at their CVS logs and noticed that the update
timestamps are quite regular, so I was wondering if the help files
were somehow generated automatically from the xml file (in that case
it would be more efficient to translate the latter).
Good thinking, but unfortunately this is not automated! The XML files
are used to generate the PDF manual, the HTML help files for gnome,
and the compiled HTML help files for Windows. But the online help
files are not (yet) linked into that system; I edit them in parallel.
Does anyone have suggestions for where to look for good plain text
formatting of XML source?
More generally, I'd like to know something about the future of
documentation, e.g. are there any parts of the documentation that
will be heavily modified, so that it's not worth to start
translating them now? Are there any plans to switch to other
formats, or something? I would be glad to help, for what I can do.
I'd say that the "command reference" part may change slightly from
release to release (usually in the form of adding something, since I
try to be careful to preserve backward compatibility). Other sections
may have bits added from time to time.
The only "change in format" that I'm contemplating would be setting up
a system to generate the online help files from the XML sources. But
this is still just notional; I think it would be quite complicated.