Documentation project

2 views
Skip to first unread message

Luca Bruno

unread,
May 1, 2008, 9:04:23 PM5/1/08
to syx-d...@googlegroups.com
Hello,
with the next release 0.1.7, once I get a working interpreter and updated all the parts of Syx,
I will move output of doxygen to doc/reference and start a texinfo manual in doc/manual.

My idea is to have this kind of manual:
1) What is Smalltalk
2) Why Smalltalk YX
3) Introduction to the language
4) Introduction the Syx environment
5) COMPLETE Class and methods documentation, EACH non private method will be documented with examples
and EACH class will have usage examples
6) Embedding
7) Advanced topics, internal documentation

I know it's not the time yet for Smalltalk YX to get such documentation but I think it will be
a nice boost for the project and also for the entire Smalltalk community.
Since I don't have such fantasy now I will start directly with the 5th topic.

Any hint will be appreciated.
Bye.

--
http://syx.googlecode.com - Smalltalk YX
http://lethalman.blogspot.com - Thoughts about computer technologies
http://www.ammazzatecitutti.org - Ammazzateci tutti

Michael Heinrich

unread,
May 1, 2008, 4:10:04 PM5/1/08
to syx-d...@googlegroups.com
Hello Luca!

Nice to see and hear that you (we?) are still working on Syx!

I think that it is always the right time to get some documentation going to be available to those that would like to know more about Smalltalk and Syx in particular. I know that I would!

I would definitely like to be involved here and do anything I can to help spread the word about Syx!

Warm regards,

Michael

Luca Bruno

unread,
May 1, 2008, 11:34:10 PM5/1/08
to syx-d...@googlegroups.com
On Thu, 1 May 2008 13:10:04 -0700
"Michael Heinrich" <mjhei...@gmail.com> wrote:

> Hello Luca!
>
> Nice to see and hear that you (we?) are still working on Syx!
>
> I think that it is always the right time to get some documentation going to
> be available to those that would like to know more about Smalltalk and Syx
> in particular. I know that I would!
>
> I would definitely like to be involved here and do anything I can to help
> spread the word about Syx!
>
> Warm regards,
>
> Michael
>

Hello,
I'm very glad I can read you again and to have you precious help always.
You all know I'm not good with English ;)
If you want to help with documentation, feel free to get the trunk of the code using svn and work on the *.texinfo files.
The main file is syx.texinfo.
You can search for any editor on internet having the Tex support (like Emacs with AucTex I'm currently using).
When do changes, just post here the changes. Better if you use svn diff, but it's not so important don't worry.
Also, if you like you can create an issue for all the problem you find in the documentation.

Thanks very much in advice.

I think I will create a Smalltalk2Texinfo wrapper for all the comments in the head of all methods to create an automatic reference, and in at the same time it can be accesible from within the environment itself.

Reply all
Reply to author
Forward
0 new messages