Re: [Firebird-docs] A how-to on writing Firebird docs?

[Tilo M. <tm...@al...>]

Hi Paul,

"Paul Vinkenoog" <pa...@vi...> schrieb im Newsbeitrag
news:Pin...@so......
> 1. A how-to on getting the manual module to work, with:
>    - getting and installing Java 2

Here I suggest a simple link to the SUN download page. Additionally we can
add the stuff which is really needed to get our manual module compiled
(CLASSPATH,...).

>    - getting and installing CVS

Why not use this description?
http://sourceforge.net/docman/display_doc.php?docid=766&group_id=1

>    - checking out the Firebird manual module
>    - building the docs that are already there
>    - what to do if things don't work

Agreed.

>    This would be for people who are at least considering to write
>    docs. If we make such a how-to and we think it's good, we should
>    have it placed in the Files section at SourceFource, and ask
>    IBPhoenix to place a link (or even place the entire how-to as a
>    webpage). Otherwise, you would first have to install Java 2 and
>    CVS, check out the manual module and build the docs in order to
>    read how to accomplish the things you have just done :-)

I think our goal should be a nightly build of the html docs which then can
be made available online.

> 2. A how-to for those who really _are_ going to write docs, with:
>    - how to pick a subject and where to discuss/announce it
>    - why we really want you to write DocBook XML
>    - general as well as fbdocs-specific DocBook instructions + tips
>    - how to structure your document
>    - style guidelines/tips
>    - how and where to ask for commit rights
>    - dos and don'ts if you have received commit rights

Sounds good. We can use preface.xml where most of the required topics is
already available.

> Looking forward to your comments,
> Paul Vinkenoog

--
Regards,
Tilo Muetze
--
Marathon - The SQL Tool for Firebird & InterBase
http://gmarathon.sourceforge.net