Re: [Firebird-docs] New potential doc writer

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

Hi Norman,

> I'm now hopefully ready to devote some spare time (of which I have
> very little) to writing docs for Firebird, and giving a little back
> to the project.
>
> My initial thoughts are to do a book on the various commandline
> utilities supplied with Firebird (1.5) - you know, GBAK, GFIX etc

Good idea!

And it might even be less work than you think. Now that the Firebord
Book is out, IBPhoenix are going to transfer the chapters of their
Using Firebird guide to the project, just like they have done with the
Quick Start Guide. We receive these docs in a format that's "almost
DocBook". In "Using Firebird" there are already chapters on isql, gbak
and gfix, and sections on the other tools. You could use those as a
basis for your book - or use them for reference only, whatever.

> Quick question, and possibly a request for a new 'howto', how do I
> adapt the build.xml script to allow me to build my own standalone
> book before adding it into the Firebird set ?

Better leave build.xml alone and edit /src/docs/firebirddocs.xml:
define an entity for your book (or one entity for each chapter) and
include it (or them) further down. If you open the file you'll see how
it works; just look at how it's done for the other books. You can
comment out the others in your local copy to speed up the build
process.


Greetings,
Paul Vinkenoog