Re: [Firebird-docs] Reference Documentation

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

Hi Louis,

> I'm sharing the same opinion. It is a MUST to have a Reference Doc
> similiar to that of MySQL, where you can get everything out without
> struggling with other and partly old documentations in the net.

We all agree on that. Our problem has always been finding enough
people to do the actual work.

> I'm very into Firebird and other open source databases and would
> like to offer my help for the documentation sub-project.

That's great, thanks. If you want to help specifically with the
Reference Doc sub-subproject, here's some information:

A database has been set up containing one entry per SQL statement.
Some are empty, some already contain text that has to be checked
and/or updated and/or rewritten. This is not how the doc subproject
usually works; it's done this way so that even small contributions
can be processed efficiently, keeping the threshold low for
potential contributors. [In fact, the initiative came from a group
of Firebirders who were not involved in the doc subproject.]

The database is located at ibexpert.org/3021:fbdoc. Anybody can get
read-only access as user fbdocwriter with password tmp123. Once you
start contributing, contact Holger Klemt (hklemt at ibexpert biz)
for a personal login.

The idea is that every entry is updated to Firebird 2.1; for this
you need to consult the Release Notes from Firebird 1.0 through 2.1

There's a Howto at http://www.destructor.de/firebird/refdoc/1345.htm

One complication is that we can't use all the available material
because of copyright issues (spelled B.O.R.L.A.N.D.)
Some entries must be totally rewritten; they are listed in my
posting "RefGuide entries that should be rewritten completely"
of 19 Nov 2007.
Some must be partly rewritten. See "Entries that should be partly
rewritten" of 29 Nov 2007.
Some are "almost clean". These are DROP GENERATOR, TRIM, BIT_LENGTH
& friends, and ASCII_VAL. See list posting of 28 Nov 2007.
Finally (and fortunately) many entries are free from copyright
issues. See "Clean RefGuide entries - complete list" of 28 Nov 2007.

The best way to get old list postings is via the NNTP server at
news.atkin.com, group sourceforge.firebird-doc (without the final s).


If you want some more information on the Firebird Doc Subproject
in general, you might visit the doc subproject homepage at
http://www.firebirdsql.org/index.php?op=devel&sub=doc


Well, I hope I didn't scare you off with this posting and you're
still willing to help us ;-)


Kind regards,
Paul Vinkenoog