firebird-docs

[Firebird-docs] Checking format for gbak doc

[FGM <fg...@os...>]

Hello,

I've made a first attempt at the docbook format with XXE. Can someone check
the first page to tell me if the use I make of the various elements is in
line with typical FB custom for docs ?

It is available at:
    http://radbase.riff.org/pub/gbakFormat.xml

Of course, it is just a first page: don't expect it to document the format
already !

Frederic

Re: [Firebird-docs] Checking format for gbak doc

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

Hello Fr=E9d=E9ric,

> I've made a first attempt at the docbook format with XXE. Can
> someone check the first page to tell me if the use I make of the
> various elements is in line with typical FB custom for docs ?
>
> It is available at:
>     http://radbase.riff.org/pub/gbakFormat.xml

Looks very good! One thing though: you have chosen for a <book>
containing <chapter>s. But unless it's going to be very big indeed,
it's better to make an <article> containing <sect1> etc.

Greetings,
Paul Vinkenoog

Re: [Firebird-docs] Checking format for gbak doc

[Frederic G. M. <fg...@os...>]

OK. XXE made me think every document had a "book" root. I'll change this.

"Paul Vinkenoog" <pa...@vi...> a écrit dans le message de
news:Pin...@s4......
> Hello Fr=E9d=E9ric,
>
> > I've made a first attempt at the docbook format with XXE. Can
> > someone check the first page to tell me if the use I make of the
> > various elements is in line with typical FB custom for docs ?
> >
> > It is available at:
> >     http://radbase.riff.org/pub/gbakFormat.xml
>
> Looks very good! One thing though: you have chosen for a <book>
> containing <chapter>s. But unless it's going to be very big indeed,
> it's better to make an <article> containing <sect1> etc.
>
> Greetings,
> Paul Vinkenoog
>
>
>
> -------------------------------------------------------
> This SF.Net email is sponsored by the new InstallShield X.
> From Windows to Linux, servers to mobile, InstallShield X is the one
> installation-authoring solution that does it all. Learn more and
> evaluate today! http://www.installshield.com/Dev2Dev/0504
> _______________________________________________
> Firebird-docs mailing list
> Fir...@li...
> https://lists.sourceforge.net/lists/listinfo/firebird-docs
>