Menu
▾
▴
firebird-docs — chat stuff about documentation
You can subscribe to this list here.
| 2001 |
Jan
|
Feb
(1) |
Mar
|
Apr
(36) |
May
(56) |
Jun
(1) |
Jul
(5) |
Aug
(3) |
Sep
(1) |
Oct
|
Nov
|
Dec
(1) |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2002 |
Jan
|
Feb
|
Mar
(15) |
Apr
(5) |
May
(7) |
Jun
(5) |
Jul
(3) |
Aug
(6) |
Sep
(3) |
Oct
(8) |
Nov
(23) |
Dec
(21) |
| 2003 |
Jan
(25) |
Feb
(37) |
Mar
(59) |
Apr
(11) |
May
(8) |
Jun
(24) |
Jul
(18) |
Aug
(29) |
Sep
(30) |
Oct
(11) |
Nov
(20) |
Dec
(5) |
| 2004 |
Jan
(43) |
Feb
(24) |
Mar
(61) |
Apr
(14) |
May
(23) |
Jun
(50) |
Jul
(13) |
Aug
(56) |
Sep
(55) |
Oct
(64) |
Nov
(94) |
Dec
(27) |
| 2005 |
Jan
(40) |
Feb
(10) |
Mar
(55) |
Apr
(20) |
May
(16) |
Jun
(6) |
Jul
(58) |
Aug
(38) |
Sep
(5) |
Oct
(6) |
Nov
(71) |
Dec
(99) |
| 2006 |
Jan
(6) |
Feb
(15) |
Mar
(22) |
Apr
(9) |
May
(31) |
Jun
(35) |
Jul
(47) |
Aug
(18) |
Sep
(21) |
Oct
(24) |
Nov
(63) |
Dec
(79) |
| 2007 |
Jan
(22) |
Feb
(40) |
Mar
(47) |
Apr
(69) |
May
(22) |
Jun
(20) |
Jul
(25) |
Aug
(13) |
Sep
(7) |
Oct
(44) |
Nov
(76) |
Dec
(1) |
| 2008 |
Jan
(26) |
Feb
(30) |
Mar
(120) |
Apr
(14) |
May
(22) |
Jun
(40) |
Jul
(48) |
Aug
(7) |
Sep
(34) |
Oct
(31) |
Nov
|
Dec
(30) |
| 2009 |
Jan
(9) |
Feb
(6) |
Mar
(9) |
Apr
(2) |
May
(9) |
Jun
|
Jul
(31) |
Aug
(32) |
Sep
(15) |
Oct
(23) |
Nov
|
Dec
(9) |
| 2010 |
Jan
(19) |
Feb
(9) |
Mar
|
Apr
|
May
(9) |
Jun
(6) |
Jul
(8) |
Aug
(21) |
Sep
(10) |
Oct
(1) |
Nov
(3) |
Dec
(33) |
| 2011 |
Jan
|
Feb
(1) |
Mar
(4) |
Apr
(10) |
May
|
Jun
(9) |
Jul
(23) |
Aug
(2) |
Sep
(35) |
Oct
(36) |
Nov
|
Dec
(4) |
| 2012 |
Jan
(3) |
Feb
(8) |
Mar
(3) |
Apr
|
May
|
Jun
(5) |
Jul
|
Aug
|
Sep
|
Oct
(12) |
Nov
(12) |
Dec
|
| 2013 |
Jan
(18) |
Feb
(5) |
Mar
(1) |
Apr
|
May
|
Jun
(5) |
Jul
|
Aug
(21) |
Sep
|
Oct
(5) |
Nov
(1) |
Dec
(11) |
| 2014 |
Jan
|
Feb
|
Mar
(4) |
Apr
(2) |
May
|
Jun
|
Jul
(2) |
Aug
(5) |
Sep
(6) |
Oct
|
Nov
(29) |
Dec
|
| 2015 |
Jan
|
Feb
|
Mar
(14) |
Apr
|
May
|
Jun
|
Jul
(7) |
Aug
(7) |
Sep
(5) |
Oct
|
Nov
(6) |
Dec
(3) |
| 2016 |
Jan
(14) |
Feb
(9) |
Mar
(33) |
Apr
(12) |
May
(18) |
Jun
(3) |
Jul
|
Aug
(15) |
Sep
|
Oct
|
Nov
|
Dec
(22) |
| 2017 |
Jan
|
Feb
|
Mar
|
Apr
|
May
(10) |
Jun
|
Jul
|
Aug
|
Sep
|
Oct
(44) |
Nov
(32) |
Dec
(8) |
| 2018 |
Jan
(2) |
Feb
(25) |
Mar
(16) |
Apr
(11) |
May
(1) |
Jun
(19) |
Jul
(3) |
Aug
|
Sep
|
Oct
(25) |
Nov
|
Dec
|
| 2019 |
Jan
|
Feb
(2) |
Mar
|
Apr
(1) |
May
|
Jun
|
Jul
|
Aug
|
Sep
|
Oct
|
Nov
(2) |
Dec
(3) |
| 2020 |
Jan
(29) |
Feb
(28) |
Mar
(13) |
Apr
(13) |
May
(107) |
Jun
(75) |
Jul
(57) |
Aug
(36) |
Sep
(3) |
Oct
(4) |
Nov
(4) |
Dec
(1) |
| 2021 |
Jan
(2) |
Feb
(13) |
Mar
(5) |
Apr
(6) |
May
(44) |
Jun
(9) |
Jul
(9) |
Aug
(3) |
Sep
(11) |
Oct
(5) |
Nov
(14) |
Dec
(19) |
| 2022 |
Jan
(1) |
Feb
|
Mar
|
Apr
(4) |
May
(1) |
Jun
(1) |
Jul
(13) |
Aug
(6) |
Sep
(2) |
Oct
(7) |
Nov
(2) |
Dec
|
| 2023 |
Jan
(2) |
Feb
|
Mar
(13) |
Apr
(2) |
May
(31) |
Jun
(12) |
Jul
(5) |
Aug
(5) |
Sep
(27) |
Oct
(7) |
Nov
(25) |
Dec
(7) |
| 2024 |
Jan
(11) |
Feb
(27) |
Mar
(3) |
Apr
|
May
|
Jun
|
Jul
|
Aug
|
Sep
|
Oct
|
Nov
|
Dec
|
|
From: reed m. <rf...@cr...> - 2001-05-03 18:54:08
|
Marcelo, for some reason, you post shows up in the netscape newsreader with no visible content (I'm subscribed to the sourceforge.firebird-docs newsgroup at news.atkin.com) Using "View page source" shows a multi-part mime like this: > ------=_NextPart_000_007A_01C0D3C5.82B8EFB0 > Content-Type: text/plain; > charset="iso-8859-1" > Content-Transfer-Encoding: quoted-printable > > I have some experience with MS SQL Server, so maybe I could write the = [...and this...] > ------=_NextPart_000_007A_01C0D3C5.82B8EFB0 > Content-Type: text/html; > charset="iso-8859-1" > Content-Transfer-Encoding: quoted-printable > > <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> [...] I don't know if this is a problem on your end or mine, but I thought I'd let you know. [...] > Are there any writing guidelines, for example, on: > - writing style (first/third person? formal/informal? conversational?) I agree with jeff, what you are comfortable with. I would think it should be semi formal. A little conversational if it makes it easier to read. > - structure Hmmm... I think you'll have to play with this after you have much of the content written. > - acronyms (do we spell them out the first time in each section? never?) First time in a section would be ok. It might be better to use a glossary (which could be shared between all the docs, if the tools permit). > - how experienced we assume the reader is > I would say, assume that they have basic knowledge of SQL server, SQL databases in general and OS administration. Assume minimal knowledge of firebird/interbase, but rather than describing each interbase operation in detail, refer the reader to where they can get more information on that topic. (e.g., if you talk about creating a database and some domains, say that "data definition is described in such and such document...") If the document you need to refer to doesn't exist, I'd say just make a note of it for now. > I realize enforcing a consistent writing style when many different = > authors are involved is next to impossible, but I think it's a good = > thing to consider. > [...] -- Reed Mideke email: rfm(at)cruzers.com -If that fails: rfm(at)portalofevil.com |
|
From: Jeff D. <je...@el...> - 2001-05-03 15:07:18
|
I say write whatever you can in any style you can. It can all be editted and corrected and tweeked for style later. Your idea for a topic is excellent. I've started to work on Migration a little, but not specific to MSSQL. I think we should have a migration section for every major database eventually. Right now I'm working on an explanation of Firebird datatypes and explaining what they will take in the way of data, for example. Firebird has no Boolean datatype so someone porting to it needs to know how to make one as a domain etc. After basic issues I'm going to move on to conversion from older Interbase versions. IMHO migration from MSSQL documention would be very important, as it is a widely used database. If Firebird can grab some marketshare from Microsoft maybe we can get some corporate sponsoring for the Code Developers. If we are to get people to switch from MSSQL to Firebird they need the docs on how to do it and what issues they will encounter. Roles could be a hotpoint here. As I said before any work you can do on any subject, in any format, would be greatly appreciated by everyone. Jeff Dodds ""Marcelo Lopez Ruiz"" <mar...@xl...> wrote in message news:007d01c0d3de$a83267d0$80f900c8@marcelont... > This is a multi-part message in MIME format. > > ------=_NextPart_000_007A_01C0D3C5.82B8EFB0 > Content-Type: text/plain; > charset="iso-8859-1" > Content-Transfer-Encoding: quoted-printable > > I have some experience with MS SQL Server, so maybe I could write the = > "Converting Microsoft SQL Server databases to InterBase" topic. It = > should probably be Firebird rather than InterBase, by the way, but = > that's the way it's listed on the IDBH outline. > > Are there any writing guidelines, for example, on: > - writing style (first/third person? formal/informal? conversational?) > - structure > - acronyms (do we spell them out the first time in each section? never?) > - how experienced we assume the reader is > > I realize enforcing a consistent writing style when many different = > authors are involved is next to impossible, but I think it's a good = > thing to consider. > > Then again, I've never written anything that got published in my life, = > so what do I know? > > Is the MSSQL migration topic taken, or are there any suggestions for = > something more important to work with first? > > Marcelo Lopez Ruiz > |
|
From: Marcelo L. R. <mar...@xl...> - 2001-05-03 14:48:54
|
I have some experience with MS SQL Server, so maybe I could write the = "Converting Microsoft SQL Server databases to InterBase" topic. It = should probably be Firebird rather than InterBase, by the way, but = that's the way it's listed on the IDBH outline. Are there any writing guidelines, for example, on: - writing style (first/third person? formal/informal? conversational?) - structure - acronyms (do we spell them out the first time in each section? never?) - how experienced we assume the reader is I realize enforcing a consistent writing style when many different = authors are involved is next to impossible, but I think it's a good = thing to consider. Then again, I've never written anything that got published in my life, = so what do I know? Is the MSSQL migration topic taken, or are there any suggestions for = something more important to work with first? Marcelo Lopez Ruiz |
|
From: Andy C. <an...@ad...> - 2001-05-03 09:42:10
|
> I think Andy Canfield is working on a document which describes the > possibilities to connect from a client to Firebird. So installation = and > migration seems to be free. Unfortunately some work came up and people are yelling for it so I don't = have decent time to work on it now. I have some decent stuff on = "Connections" and the early versions of the SQL statements CONNECT and = SET DATABASE and DISCONNECT. I presume Joseph will post whatever he's = got from me as soon as there's something organized. In this area we need = tested examples of connecting in various packages; e.g. IBObjects, = Delphi, etc. I can't row the boat very fast right now; I'm using the = paddle to bang the alligators on their heads. By the way, I'm still missing: [1] A ZIP version of DocBook (I can't tar). [2] The corrected undistributable documentation set. |
|
From: Tilo M. <tm...@iq...> - 2001-05-01 14:08:46
|
""Jeff Dodds"" <je...@el...> schrieb im Newsbeitrag news:9cjg5l$jou$1...@ne...... > I had been working on building PHP document manager, but if we are going > to use docbook for certain then I'll quit my PHP project and setup for > docbook. Docbook seems the way to go at the moment. Have you experience with Docbook? In any case you can download a good working example from David Jencks http://home.earthlink.net/~davidjencks. Before you can build the docs remember to install the newest jdk. I'm in the moment reading the Docbook book from Norman Walsh to get used to the whole thing. I hope to start actively at the end of this week. > I'd like to start with the install (begin at the beginning) but I think > Firebird needs an Install Anywhere type of install and the docs to match it, > which I can't work on because it doesn't exist. > > How about Migration? I have done some migration, so I don't feel totally > out of the water here. I think Andy Canfield is working on a document which describes the possibilities to connect from a client to Firebird. So installation and migration seems to be free. -- Regards, Tilo Muetze IQ Compusulting www.iq-c.de |
|
From: Jeff D. <je...@el...> - 2001-04-30 15:49:57
|
Can someone recommend to me a documentation area to work on? I had been working on building PHP document manager, but if we are going to use docbook for certain then I'll quit my PHP project and setup for docbook. I'd like to start with the install (begin at the beginning) but I think Firebird needs an Install Anywhere type of install and the docs to match it, which I can't work on because it doesn't exist. How about Migration? I have done some migration, so I don't feel totally out of the water here. Jeff Dodds |
|
From: Tilo M. <tm...@iq...> - 2001-04-30 10:29:22
|
"David Jencks" <dav...@ea...> schrieb im Newsbeitrag news:20010428030753.L1315@HP.home.home... > Let me know if there are problems using this. If everyone likes it I'll > remove the stupid example content and commit it. Thanks a lot David! I like it very much. It's easy to use. The only things a writer needs is the JDK and a xml editor(emacs). At the moment I'm reading the Docbook book from Norman Walsh to get used to the whole thing. After that(end this week), I will start to actively contribute! Where do you commit the files? Regards, Tilo Muetze |
|
From: Ann W. H. <aha...@ib...> - 2001-04-29 15:35:11
|
At 01:55 PM 4/29/2001 +0700, Andy Canfield wrote: >As far as I know, there are only three ways to feed any sort of SQL >statement into Firebird. You missed one - probably not important, but QLI also has an SQL parser. And the server-side sql includes constraints & triggers. Regards, Ann www.ibphoenix.com We have answers. |
|
From: Andy C. <an...@ad...> - 2001-04-29 07:51:55
|
Please somebody answer this question.
As far as I know, there are only three ways to feed any sort of SQL =
statement into Firebird.
[1] Put the statements into your program as if they were source code, =
then feed the file through gpre. gpre generates a program that can then =
be compiled in the normal way and executed. This is called Embedded SQL, =
or ESQL for short.
[2] Feed the statements into some other program which is executing. =
These statements are handed to the API as-is; the API handles the =
parsing and decoding of the statements as well as executing them when =
appropriate. This is called Dynamic SQL, or DSQL.=20
[3] Put the SQL statements into a procedure and store the procedure on =
the server and call the procedure. There doesn't seem to be a special =
name for this; I'd call it "SSQL" for "Server-side SQL".
AFAIK, except for ESQL and server-side procedures, everything is DSQL. =
The stuff you type into isql is DSQL plus a few extra commands like =
"SHOW TABLES" (but never any extra syntax on existing DSQL statements). =
The stuff you type into IBConsole is fed to isql so it's essentially the =
same language. Where the API takes SQL statements they are DSQL =
statements.
I ask because the documentation refers to "SQL", as in "This is the =
syntax for SQL, and this other thing is the syntax for DSQL", and I'm =
not sure what "SQL" means when used that way.
I propose that we limit the use of the word "SQL" to that which is =
applicable to all input channels; e.g. "The SQL CONNECT statment". When =
we give syntax, if we say "SQL" it should apply to all contexts. If the =
contexts require different syntax, we should list the contexts and not =
refer to some of them as SQL and the others as DSQL. For example
SQL CONNECT statement:
syntax for DSQL ...
syntax for ESQL and SSQL ...
Can anyone please help me to identify all of the separate contexts that =
we need to track separately in the SQL syntax chapter? Thank you.
|
|
From: Andy C. <an...@ad...> - 2001-04-29 07:51:53
|
I apologize; the message from me with the above subject should have been = sent to Firebird-Devel. |
|
From: Ann W. H. <aha...@ib...> - 2001-04-28 17:39:00
|
Andy,
May I suggest putting this on the architecture
list or the firebird development list? Or maybe
not after you've read my comments?
>What's wrong with isc_expand_dpb() -
>
>[1] There is a difference between the size of a buffer and the size of the
>data in the buffer....
That's an error in the example - the caller should supply the length of the
buffer, not the length of the data.
>[2] The API says that isc_expand_dpb() allocates a new buffer if it needs
>it. However, there is nothing said about what happens to the old buffer.
>There is no deallocation of the old buffer.
The comments in the code say that the original intended user
for this (gpre) generates code to release the allocated buffer.
Gpre also generates exactly one call to isc_expand_dpb, so there
are no intermediate allocations to get lost.
FYI, dpb stands for database parameter block.
>... isc_fill_dpb( & dpb, & dpb_length, isc_dpb_user_name, username );
>... isc_free_dpb( dbp );
without adding two more calls to the (bloated) interface, you
could just allocated and stuff the block yourself. It's simple.
one byte of dpb version, the identifier, a byte of length, then
the value, and continue with identifier, length, value triplets
until done. Keep track of the length and if your next value
will overflow, allocate a bigger block, copy the data, & release
the old block.
>* When we wish to, we can cause isc_attach_database to store the
>dpb_length in an unsigned long integer, and recognize the isc_dpb_length
>code, updating the (small) number it received from the caller with the
>(large) number it finds in the dbp itself. When we do this we will no
>longer be limited to 32767 bytes in the dbp.
That limit has not yet been a problem.
>I am a little concerned that the length of a string in the dbp buffer is
>limited to 255 characters by the use of one byte as a length byte; file
>names under Windows 98 are limited to 32,767 bytes.
Again, that limit hasn't been a problem up to now - very few people actually
use names longer than 200 characters because of the improbability of typing
them right.
>If the user calls isc_fill_dpb() to put the strings into the dbp, we can
>set the format code to "2" and make the upgrade invisible to the caller.
I don't see this as worth the overall cost.
>Of course we need to keep isc_expand_dpb() in the API to support old code;
>however we should discourage it's use.
I'd just stop there.
>I welcome any comments. According to the API, isc_expand_dpb() and
>isc_attach_database() are the only two functions that use the dbp at all.
>But there is a TPB - maybe we should make the code handle both? How does
>this fix fit in with plans that others have?
The tpb (transaction parameter block) works like the dpb, and like
creating the dbp, creating a tpb is within the skill set of any
dull-normal programmer.
Regards,
Ann
www.ibphoenix.com
We have answers.
|
|
From: Andy C. <an...@ad...> - 2001-04-28 13:23:29
|
> I will try to get some framework set up for us. This all requires = more > experimentation, but it will probably be easier to convert plain text = to > xml than rtf to xml. On the other hand, if we do get the framework on > sourceforge, you could just write the stuff in xml and not worry about = the > conversion ( if you got emacs+psgml set up). Is it easy to go rtf to = plain > text? Are there linux rtf editors? As far as I know, rtf is a non-proprietary format. On the other hand, = the detailed description I have is labelled "Microsoft Technical = Support"; I hadn't noticed that. If you open the RTF document under Windows (It can be read by Word or by = WordPad which is bundled with Windows or with Word Viewer which is = downloadable for free from Microsoft), then you can cut and paste into = any editor that runs on Windows. But this would only preserve the = attributes, and not provide structure ( section, subsection, heading, = etc. ). RTF is ASCII text with a bunch of formatting codes. Much like HTML, = except that the codes look like "\par" instead of "<BR>". AFAIK, there = is no equivalent to the HTML link capability. If you have an RTF file, = read it with any ASCII text editor and you'll see the codes; you can = then replace the RTF codes with HTML codes or, better yet, wait until = we've got something like DocBook working and standardized and replace = the RTF codes with the DocBook XML codes. I'm just cranking out = (formatted) text right now. Assuming we go ahead with DocBook, we need somebody to tell us what = codes to put in at what spots. The XML has many different ways to do = things. Presumably DocBook is one set of codes. But what do we have that = is called <SECTION> ... </SECTION> and what do we have that is called = <DIVISION> ... <DIVISION>, etc.? Someone should decide and tell the rest = of us. Of course, at that point, we will be two sets of writers; those who have = DocBook up and running and those who do not. Any person can check out = the source and edit the source file (which contains the DocBook codes), = but only the first group will be able to see the results formatted = before checking it back in. Once we've got the layout instructions, I = will try to get DocBook working on my machine and personally convert = Connections.rtf to the proper DocBook codes as a learning test case. |
|
From: Andy C. <an...@ad...> - 2001-04-28 12:36:37
|
Last year I had trouble getting isc_expand_dpb() to work. It turns out =
that it CAN'T work as described in the manual. The problems are in the =
interface, not in the code.
What's wrong with isc_expand_dpb() -=20
[1] There is a difference between the size of a buffer and the size of =
the data in the buffer. The API says that isc_expand_dpb() allocates a =
new buffer if the new material will not fit into the old buffer. =
However, the length parameter is the size of the data in the buffer; =
isc_expand_dbp() has no way of knowing how big the old buffer is.=20
[2] The API says that isc_expand_dpb() allocates a new buffer if it =
needs it. However, there is nothing said about what happens to the old =
buffer. There is no deallocation of the old buffer.
Because these flaws are in the functional specs of isc_expand_dpb(), and =
not in the code itself, I propose to repair them by providing two new =
functions:
isc_fill_dpb() takes exactly four parameters:
A pointer to a DBP. Before the first call to isc_fill_dbp(), the =
caller should set this pointer to NULL. isc_fill_dbp() will do all =
allocating of the dbp buffer.
A pointer to a short int giving the length of the data in the =
dbp_buffer. This is purely an output of isc_fill_dpb(), and is provided =
solely for compatablity with isc_attach_database(), which needs this =
number as a parameter.
A parameter code for the string that is to be inserted into the dbp.
A pointer to the string that is to be inserted into the dbp.
Note that isc_fill_dbp() does not take variable arguments, like =
isc_expand_dpb(). Variable arguments must bypass compile-time type =
checking, and thus are error-prone.
isc_free_dpb() takes exactly one parameter, the pointer to the DPB as =
created and filled by isc_fill_dbp(). This must be called AFTER the call =
to isc_attach_database, to release the memory in the buffer.
Code calling these function would look like this:
char * username =3D ...;
char * password =3D ...;
char * dpb =3D NULL;
short dbp_length;
isc_fill_dpb( & dpb, & dpb_length, isc_dpb_user_name, username );
isc_fill_dpb( & dpb, & dpb_length, isc_dpb_password, password );
isc_attach_database( & status_vector, strlen( dbname ), dbname,=20
& dbhandle, dpb_length, dbp );
isc_free_dpb( dbp );
To implement this we would need a new dpb code which the caller never =
sees and which marks the allocated length of the dpb and the actual data =
length of the dbp (two numbers). Because shorts look a lot smaller now =
than they did a few years ago, I'd like to make these four byte numbers. =
Therefore the length information block would be ten bytes:
one byte for isc_dpb_length
one byte with the value 9
a four byte unsigned integer, the allocated length, standard (VAX?) =
format
a four byte unsigned integer, the data length, in standard (VAX?) =
format
I believe that this implementation meets the following criteria:
* It constructs a dbp which, with the exception of the new =
isc_dpb_length field, is completely compatable with the existing dpb =
format. I am led to understand that isc_attach_database() ignores any =
dpb code that it doesn't understand; therefore it will ignore the =
isc_dpb_length code and work as before.
* It can be fully thread-friendly. The application can construct two =
dbp's at the same time, interleaving the calls to isc_fill_dbp() at =
will, with no clash of buffer.
* There is no memory leak (unless the caller forgets the call to =
isc_free_dpb()). No matter how many times the caller calls =
isc_free_dbp(), no matter how many times isc_free_dbp() must re-allocate =
the dbp buffer; because isc_free_dpb() knows how the buffer was =
allocated, it will free it whenever it must replace it.
* with fixed parameters to isc_free_dpb(), not variable parameters, we =
have type checking on the code.
* When we wish to, we can cause isc_attach_database to store the =
dpb_length in an unsigned long integer, and recognize the isc_dpb_length =
code, updating the (small) number it received from the caller with the =
(large) number it finds in the dbp itself. When we do this we will no =
longer be limited to 32767 bytes in the dbp.=20
I am a little concerned that the length of a string in the dbp buffer is =
limited to 255 characters by the use of one byte as a length byte; file =
names under Windows 98 are limited to 32,767 bytes. If the user calls =
isc_fill_dpb() to put the strings into the dbp, we can set the format =
code to "2" and make the upgrade invisible to the caller.
Of course we need to keep isc_expand_dpb() in the API to support old =
code; however we should discourage it's use for new code and shift over =
to the new functions. Users would be warned that they can use =
isc_fill_dbp() and isc_free_dpb(), or they can do it themselves, but =
they should not mix methods as isc_fill_dpb() is not guaranteed to =
follow the format given in the API.
I welcome any comments. According to the API, isc_expand_dpb() and =
isc_attach_database() are the only two functions that use the dbp at =
all. But there is a TPB - maybe we should make the code handle both? How =
does this fix fit in with plans that others have?
|
|
From: Tilo M. <tm...@iq...> - 2001-04-28 08:05:41
|
"David Jencks" <dav...@ea...> schrieb im Newsbeitrag news:20010428030753.L1315@HP.home.home... > I have put together a framework for firebird to generate documentation from > DocBook xml documents. It is available as tar.bz2 format on David, this was fast! > Let me know if there are problems using this. If everyone likes it I'll > remove the stupid example content and commit it. OK, I will try it today. -- Regards, Tilo Muetze IQ Compusulting www.iq-c.de |
|
From: Tilo M. <tm...@iq...> - 2001-04-28 08:03:12
|
""Andy Canfield"" <an...@ad...> schrieb im Newsbeitrag news:001101c0cf0c$fcb8caa0$3f1bfea9@think6... > At the moment it's seems like a bit of work. If I can just email my = > stuff to Joseph Alba, and let him worry about pasting it into some HTML = > generator system, I'll skip it. I can tell you exactly what DocBook DTD = > I use; none yet. The one chunk I submitted so far was RTF (Rich Text = > Format), which is like a DOC file only not binary and not propriatary. = > When my FoxPro or C++ code wants to crank out a report, it generates an = > RTF file which I distribute by diskette or email. I know exactly where you talking about. The whole Docbook setup is not the simplest task. But if David will setup an framework for us, I will put it on a website with exact information how to get started. -- Regards, Tilo Muetze IQ Compusulting www.iq-c.de |
|
From: David J. <dav...@ea...> - 2001-04-28 07:03:24
|
Hi, I have put together a framework for firebird to generate documentation from DocBook xml documents. It is available as tar.bz2 format on http://home.earthlink.net/~davidjencks/ I have a zip but it didn't fit. What you get on unpacking is a "manual" directory containing all the directories, files, libraries, etc needed for a documentation project. All you have to do is supply the xml content. The source is in manual/src/docs. To compile to html, go to manual/src/build and run build.sh defaulthtml. You need java jdk probably 1.3. The ant script will tell you what it is doing - takes about 20 sec., and the results will be in dist/docs/defaulthtml. I've set up some simple graphics using Markus's logos, maybe I went overboard. See what you think. Let me know if there are problems using this. If everyone likes it I'll remove the stupid example content and commit it. The download is about 3.5 meg due to all the libraries. I can't keep this up on my site indefinitely, these two files use up almost all my space. Thanks David Jencks |
|
From: Ann W. H. <aha...@ib...> - 2001-04-27 22:28:28
|
Random and off the wall thought. Suppose you don't explain SQL at all. There are tons of books about SQL - some quite good. If we explain how we differ from the descriptions in one of those books, you'll have somewhat less of the boring part to write and can spend time worrying about important stuff like connection strings. Cheers, Ann |
|
From: David J. <dav...@ea...> - 2001-04-27 17:35:18
|
Hi, I will try to get some framework set up for us. This all requires more experimentation, but it will probably be easier to convert plain text to xml than rtf to xml. On the other hand, if we do get the framework on sourceforge, you could just write the stuff in xml and not worry about the conversion ( if you got emacs+psgml set up). Is it easy to go rtf to plain text? Are there linux rtf editors? thanks david jencks On 2001.04.27 07:26:03 -0400 Andy Canfield wrote: > I downloaded 'ant', which requires a java package. I've downloaded the > java package but haven't installed it yet. If and when I get them working > I can run the script to download jboss which is supposed to be a sample > set of manuals in DocBook format. > > At the moment it's seems like a bit of work. If I can just email my stuff > to Joseph Alba, and let him worry about pasting it into some HTML > generator system, I'll skip it. I can tell you exactly what DocBook DTD I > use; none yet. The one chunk I submitted so far was RTF (Rich Text > Format), which is like a DOC file only not binary and not propriatary. > When my FoxPro or C++ code wants to crank out a report, it generates an > RTF file which I distribute by diskette or email. > > ----------- Previous Message -------------- > From: "Tilo Muetze" <tm...@iq...> > To: <fir...@li...> > Date: Thu, 26 Apr 2001 16:25:24 +0200 > Organization: IQ Compusulting > Subject: [Firebird-docs] Re: Firebird-docs digest, Vol 1 #6 - 4 msgs > > Andy, Joseph and other who wan't to contribute to the documentation, > I've downloaded, installed and tried to use Docbook but it is really > complicated to start. If anyone out there has already put together the > frame > for the documentation using Docbook please tell me. > I've seen a message from Andy containing a first draft of the Firebird > docu, > but as I only have digest mode I can not download the attachment, so > please > tell me which format you have used! > > > > > _______________________________________________ > Firebird-docs mailing list > Fir...@li... > http://lists.sourceforge.net/lists/listinfo/firebird-docs > |
|
From: Andy C. <an...@ad...> - 2001-04-27 11:27:18
|
I downloaded 'ant', which requires a java package. I've downloaded the = java package but haven't installed it yet. If and when I get them = working I can run the script to download jboss which is supposed to be a = sample set of manuals in DocBook format. At the moment it's seems like a bit of work. If I can just email my = stuff to Joseph Alba, and let him worry about pasting it into some HTML = generator system, I'll skip it. I can tell you exactly what DocBook DTD = I use; none yet. The one chunk I submitted so far was RTF (Rich Text = Format), which is like a DOC file only not binary and not propriatary. = When my FoxPro or C++ code wants to crank out a report, it generates an = RTF file which I distribute by diskette or email. ----------- Previous Message -------------- From: "Tilo Muetze" <tm...@iq...> To: <fir...@li...> Date: Thu, 26 Apr 2001 16:25:24 +0200 Organization: IQ Compusulting Subject: [Firebird-docs] Re: Firebird-docs digest, Vol 1 #6 - 4 msgs Andy, Joseph and other who wan't to contribute to the documentation, I've downloaded, installed and tried to use Docbook but it is really complicated to start. If anyone out there has already put together the = frame for the documentation using Docbook please tell me. I've seen a message from Andy containing a first draft of the Firebird = docu, but as I only have digest mode I can not download the attachment, so = please tell me which format you have used! |
|
From: Andy C. <an...@ad...> - 2001-04-27 06:16:30
|
----- Original Message -----=20 From: "Joseph Alba" <ja...@il...> To: "Andy Canfield" <an...@ad...> Sent: Thursday, April 26, 2001 22:09 Subject: Re: Connections > Got your first copy. >=20 > I like your common sense approach. There are a few technical things = that > need to be corrected and enumerated (like specify precisely what = protocols > are available.) "All I know is what I read in the papers." (Beta docs) > I would like to see a lot of examples: Step by step How to's >=20 > Like: >=20 > How to connect to an Interbase server using ISQL. Can do. > How to connect to an Interbase server using IBConsole. Can do. With something like IBConsole, we need screen shots. Can do, but = RTF format won't support them, so I'll have to send them in separately. > How to test connections using IBConsole. I don't quite follow you. As in test to see whether it's possible to = connect to a database? > (Mention also that IBConsole cannot connect to a Classic Linux server = only > SuperServer) Will say. > How to connect using Delphi BDE I have no idea how; someone else will have to talk about this level. > How to connect using Delphi Interbase Express (?) I have no idea how; someone else will have to talk about this level. > How to connect using Jason's IBObjects I have no idea how; someone else will have to talk about this level. > How to connect using API Can do. I don't want to get into too much detail. A firm example of each is OK, = but... If the guy is using the API, I want to make sure that he reads = the isc_attach_database() documentation which is elsewhere. I must, of = course, include a link to it. Indeed, if we do the links right, we don't = need to duplicate information because the user will wander wherever he = needs to. What I want to do is give him ideas and map the ideas into = the specific commands without duplicating the effort of spelling out the = specific commands. For example, isc_attach_database() offers a whole raft of parameters = besides user, role, etc. I don't want to cover any unless those are also = permitted in other contexts. Apparently I need to add "cache", whatever = that is, because it's in the SQL CONNECT statement. > One thing I'd like the documentation to have is a lot of practical = things. I > believe in learning by example and doing. A person needs to do but a person also needs to have the conceptual = structure into which to map what he's doing. Here in Thailand people = tend to memorize keystrokes; we don't want that. Also, the "Connections" = section should be as complete as possible, even including things that = are obscure, because if he's got a concern about a connection where else = would he look? Examples are great, but, this is not a tutorial. If we = write it write, many users won't need a tutorial. A tutorial walks you = through the minimum; this tells you the maximum. Good point, though. Ann mentioned "Now I've got it installed, what do I = do?" This should include a link to a good tutorial that the person can = read and walk through from his keyboard live. > If a newbie were to read our docs, he should come out knowing HOW to = do > things, rather than lots of gobbledygooks without knowing HOW to do = it. It > would be a tragedy if the newbie knew about the Y-Valve or the = difference > between Classic and Superserver, but not knowing HOW to connect. Yeah. But in many cases, like running isql, much of the HOW is in a = separate section, and should be linked here. This section is for the = mind, not the fingers. I will extend the examples, etc. but I don't want to get too far down = the chain and duplicate stuff that ought to be in the other sections of = the manual. Except for IBConsole, I would not want him to get the = feeling that, having read this section, he doesn't need to read anything = else. User expectation of a program like IBConsole is that he can play = with it and learn by doing, not reading anything first. That's what I = did; haven't read any IBConsole documentation yet. But for something = like isql, he needs to read the documentation first, and that's the isql = section, not just the Connection section. > Would you like to give these how-to's a try? As for isql, I hope to write it myself and therefore can experiment with = the balance between the two. When we work out the guidelines for what = goes in A and what goes in B, we can apply that division to A versus C = and even X versus W. ONE FIRM RULE (which I violated) - NO CODE OR COMMANDS SHOULD BE = INCLUDED IN THE MANUAL UNLESS THEY HAVE BEEN TESTED, EXACTLY, VIA COPY = AND PASTE. I have seen example C code in manuals where, if you feed it = into a compiler as-is, it won't even compile. As you develop guidelines = for documentation writers regarding style or subjects or whatever, = please include this. Thanks. |
|
From: Jeff D. <je...@el...> - 2001-04-26 15:25:47
|
Works great, Thanks Mark. "Mark O'Donohue" <mar...@lu...> wrote in message news:3AE...@lu...... > > > Hi Jeff > > Jeff Dodds wrote: > > > Does anyone have any idea why I can't view this newsgroup? I can view and > > post to all the other newsgroups at news.atkin.com, but not firebird-docs. > > Please help. I am receiving all messages via email at the moment, but the > > threads are destroyed. > > Your right, I hadn't set it up quite right, it was low volume at the > time and I didn't spend too much time on it, I think I've fixed it, if > so you should see this message in the newsgroup. Otherwise in a little > while there will be another message like this one. (note the subtle > difference of fir...@li... and > sourceforge.firebird-doc names :-). > > Cheers & Sorry for the delay. > > Mark > > > -- > Your database needs YOU! > http://firebird.sourceforge.net > > > _______________________________________________ > Firebird-docs mailing list > Fir...@li... > http://lists.sourceforge.net/lists/listinfo/firebird-docs > |
|
From: Mark O'D. <mar...@lu...> - 2001-04-26 15:09:05
|
Hi Jeff Jeff Dodds wrote: > Does anyone have any idea why I can't view this newsgroup? I can view and > post to all the other newsgroups at news.atkin.com, but not firebird-docs. > Please help. I am receiving all messages via email at the moment, but the > threads are destroyed. Your right, I hadn't set it up quite right, it was low volume at the time and I didn't spend too much time on it, I think I've fixed it, if so you should see this message in the newsgroup. Otherwise in a little while there will be another message like this one. (note the subtle difference of fir...@li... and sourceforge.firebird-doc names :-). Cheers & Sorry for the delay. Mark -- Your database needs YOU! http://firebird.sourceforge.net |
|
From: Tilo M. <tm...@iq...> - 2001-04-26 14:27:36
|
Andy, Joseph and other who wan't to contribute to the documentation, I've downloaded, installed and tried to use Docbook but it is really complicated to start. If anyone out there has already put together the frame for the documentation using Docbook please tell me. I've seen a message from Andy containing a first draft of the Firebird docu, but as I only have digest mode I can not download the attachment, so please tell me which format you have used! Tilo |
|
From: Jeff D. <je...@el...> - 2001-04-26 13:51:42
|
Does anyone have any idea why I can't view this newsgroup? I can view and post to all the other newsgroups at news.atkin.com, but not firebird-docs. Please help. I am receiving all messages via email at the moment, but the threads are destroyed. Jeff Dodds |
|
From: <pc...@at...> - 2001-04-26 13:37:47
|
Andy, On 26 Apr 2001, at 19:56, Andy Canfield wrote: > Copyright status: Because I am an anarchist, I do not (declare / > file / claim) copyright. Since there is no Firebird > "organization", I hereby give permission to copyright it to > ibphoenix under the same terms as new code contributed to the > Firebird executable. As far as I know, no one has a copyright on > any of the material presented here (because I wrote it) except > that the last section was lifted from an email from Jim Starkey > and he may have copyright on that material. You can use FDL (Free Documentation Licence) from FSF, kinda GPL for documents. Look at http://www.gnu.org/copyleft/fdl.html or one written by Helen Borrie for IBDH (somewhere at www.interbase2000.org) You should protect yourself and other contributor against "commercial free riders" Best regards -- Pavel Cisar Firebird - The most addictive database http://firebird.sourceforge.net |
58 messages has been excluded from this view by a project administrator.
