Page 1 of 1

DSA documentation

Posted: Sat Mar 28, 2009 4:15 pm
by Paul Stevens
Look at:

http://dianneandpaul.net/CSBwin/DSA.pdf

We have to decide where to put this and how
best to make it easily found by anyone looking
for DSA help.

The author's name should be on the title
page, don't you agree?

Re: DSA documentation

Posted: Sat Mar 28, 2009 10:38 pm
by TyGuy6
Wow. This is great. *speechless*

Re: DSA documentation

Posted: Sun Mar 29, 2009 10:55 am
by Jan
:shock:

Wow! That's fantastic! I would need centuries to make something like this! Actually, I will need several weeks only to read it through!

I love the sentences like "Two types of sounds are supported....blah, blah" - reminds me my dissertation thesis. :P
Paul Stevens wrote: The author's name should be on the title
page, don't you agree?
Definitely!

Re: DSA documentation

Posted: Sun Mar 29, 2009 11:45 am
by zoom
This is definitely a good thing. The author should be mentioned somewhere(I could not find a name)

Re: DSA documentation

Posted: Sun Mar 29, 2009 6:34 pm
by ChristopheF
Surely a lot of work must have been done to create this document.
My web site has been open to a limited number of contributors for some time now. Paul, as you have your own account, you should be able to connect and upload this document on my web site if you want to store it there. The most appropriate would be to create a "wiki" page for this purpose.
By the way, I would be happy to see all the CSBwin documentation you have on your site being included in the Encyclopaedia, but I don't have time to this myself and maybe you would prefer to keep it separate.
Other people may help, in fact anyone interested in adding content to my site is welcome! (if you don't have an account yet, just ask me one).

Re: DSA documentation

Posted: Sun Mar 29, 2009 11:00 pm
by zoom
I will print this pdf. Probably a good idea to have a documentation in real on paper.
Reminds me a bit of the programming books out there... now DSA is a language with
it´s own booklet!! :P

Re: DSA documentation

Posted: Mon Mar 30, 2009 4:53 am
by Paul Stevens
I don't feel competent to update the Encyclopaedia.
I have no objection whatsoever to having any of
my documentation moved to the Encyclopaedia.
But the stuff on my site is such a ragged heap of
miscellaneous. I think it would not do the
Encyclopaedia justice in its present form and
I have no desire to tidy it up. The DSA PDF
file is quite beautiful and would look nice there.

The wiki is also a natural spot for the DSA docs.
It seems to me it would be nicer if it were in
only one place, however. And perhaps referenced
in other places. Perhaps the author has
something to say. Anyone else?

Re: DSA documentation

Posted: Mon Mar 30, 2009 8:40 am
by ian_scho
Great thanks and hugs to the author for this!
Bounce this thread to let us know if there are any updates in the future to the document, plz.

Re: DSA documentation

Posted: Mon Mar 30, 2009 1:33 pm
by Roquen
I'm responsible for creating the PDF, but I wouldn't call myself the author. I basically cut-and-paste together Paul's docs, did a little overtyping, formatting and added a little verbage.

The doc is currently is a pre-pre-alpha version. There are tons of errors and ommisions, was well as being down-right incomplete.

My main question about the PDF is: "Does its existence really make sense?" Mainly I'm wondering if moving all of the content to the WIKI might be a better overall solution. Esp. since I'd like to move this from being a solo project to a community one (in other words, I'm running out of motivation)

FYI:
Typesetting is in LaTeX using the application Lyx.

Re: DSA documentation

Posted: Mon Mar 30, 2009 2:20 pm
by ian_scho
FYI:
1. The wiki is my number one place to go for DSB functions and queries
2. I then search for it's usage in the source code using bareGrep
3. Then it's a search in the forum as a last resort

Never had the luxury of having a one-stop document. It would be where to point those who wish to start a CSBwin dungeon.