Blaine is responsible for setting up the DocBook framework, so he should be
involved in any major changes.

-Re the web site files, they are not under version control (apart from the
files generated with DocBook). There is a complicated procedure for
uploading using open-source tools and I only started updating them more
regularly when I used wsftp (commercial). Someone might know an easy
open-source way. For now, please send me any modified html files and will
upload them.

- There is no new commit to readmedocbook.txt. You can use the CVS command
"log" as follows in the directory to see the revision history:

log readmedocbooks.txt

-The http docs have a style sheet. I will send you the whole site.

-I haven't found an XML editor. So I've been using normal text editors.

The general thinking about documentation was that we put all the user texts
in the guide and produce the pdf and html directly. The work was done
earlier this year and there are still some pdf formatting issues to be
resolved. I personally don't think we should change this aspect now.

Something we haven't done yet is to check other open-source projects that
use DocBooks and get some ideas on how to improve the system.

The organisation of the rest (web site, etc.) has not been decided,
especially due to lack of time. A wiki system would certainly be very
useful.

Regarding your last suggestion, sure. If the text files involved belong to
the guide, then you can add chapters or appendixes. Otherwise html can be
used if you wish.

Fred

----- Original Message ----- 
From: "Thomas Mueller" <[EMAIL PROTECTED]>
To: <[EMAIL PROTECTED]>
Sent: 22 October 2004 22:40
Subject: [Hsqldb-developers] Documentation


Hi,

I would like to contribute to the documentation of HSQLDB and have some
questions:

- I didn't find the files on web site in the CVS. Is is under version
control? If I want to contribute to that part, what should I do?

- I had some problems when 'compiling' the docs (docbooks). I commited this
to the file readmedocbook.txt (Sun JDK 1.4 Xerces / Xalan problem). Was that
the correct way doing it? Did it actually work? I better as because I so far
never commited anything to the HSQLDB project...

- When reading the existing documentation, I think the html docs should all
use the same style (font and such). Do you agree when I create a stylesheet
and try to link all html files to that one?

- I'm new to 'docbooks'. It sounds quite interesting to be able to create
html and pdf files! So far, I did find it hard to get the build working
(downloading 5 different libraries), but I can now create the pdf / hmtl
files... But how should I edit the documentation? I use Windows XP. I don't
have a problem using a text editor for xml files, but how do you edit the
files? Is there a good editor (open source / free of course :-).

- (Maybe because I'm new to docbooks, and because I had trouble installing
it) I find it is simpler to just write html docs (using some html editor
like NVU or OpenOffice). I mean, at some point we should probably have some
Wiki system for the docs, and I guess html would be just the 'simpler'
format from a practical view... The pdf file can still be created using
OpenOffice, or a html to pdf converter like HTMLDOC. What is your experience
with docbooks? What is your position? I don't want to alienate anybody, but
I'm just writing directly what I think...

- Is it ok if I reorganize / link the docs a little? For me, all the html
files should be linked in some consistent way. Should we not convert all the
.txt files to proper html files and link them in some consistent way?

Thanks for your input,
Thomas

-- 
Geschenkt: 3 Monate GMX ProMail + 3 Ausgaben der TV Movie mit DVD
++++ Jetzt anmelden und testen http://www.gmx.net/de/go/mail ++++



-------------------------------------------------------
This SF.net email is sponsored by: IT Product Guide on ITManagersJournal
Use IT products in your business? Tell us what you think of them. Give us
Your Opinions, Get Free ThinkGeek Gift Certificates! Click to find out more
http://productguide.itmanagersjournal.com/guidepromo.tmpl
_______________________________________________
hsqldb-developers mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/hsqldb-developers 



-------------------------------------------------------
This SF.net email is sponsored by: IT Product Guide on ITManagersJournal
Use IT products in your business? Tell us what you think of them. Give us
Your Opinions, Get Free ThinkGeek Gift Certificates! Click to find out more
http://productguide.itmanagersjournal.com/guidepromo.tmpl
_______________________________________________
hsqldb-developers mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/hsqldb-developers

Reply via email to