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

[Paul V. <pa...@vi...>]

Hi Fr=E9d=E9ric,

> As I've been working on the Gbak format and Helen and Ann suggested
> so, I'll probably put up a small document on this subject.
>
> How should I do it ? I normally work in OO or Word with custom
> stylesheets for my usual artifacts, which seem similar to what you
> describe for Docbook.  Can I use these and just paste the elements
> in a docbook skeleton somewhere ? (where ?).

Will you write one small doc and nothing more? Then you shouldn't
probably bother with DocBook at all. Just write it in plain OO or Word
without any fancy formatting stuff, and I'll convert it to DocBook.

You can generate DocBook with OO 1.1.1 but I personally find it rather
awkward. Carlos seems to be doing OK with it though :-)

If you want to take the DocBook-with-OO route, read

  http://xml.openoffice.org/xmerge/docbook/UserGuide.html

=2E..and also get that template they link to.

If you think you're going to write more technical docs in the future
(not necessarily for Firebird), learning DocBook may be very
benificial for you. You can find all you need in the Firebird
Docwriting Howto (but this will cost you at least an hour to read
and understand):

  http://www.firebirdsql.org/devel/doc/manual/defaulthtml/docwritehowto.htm=
l


Greetings,
Paul Vinkenoog