[fluxus] function list?

[Dave Griffiths]

>> This may be a dumb-ish question, but is there some sort of master
>> function list for Fluxus? Or is there an easy way to find out what all
>> the possible functions are (some source code file, perhaps)?
>
> this was one of the aims of transfering the docs to texi format, but i
> didnt
> get around to to making the definitions appear in a way that was visually
> compatible with the examples.
>
> see any of the chapters after 'state machine' for all the docuemtned
> definitions. http://www.pawfal.org/Software/fluxus/docs/index.html
>
>> If I could find such a list, I would gladly contribute some help
>> documenting those functions.
>
> i think dave has some newfangled automated documentation extraction from
> the source, and im not really sure how this would affect the texi version.

The plan is to put all the function documentation in the source files -
for the plt branch this includes scheme files, which define some of the
functions. It's good to have the documentation in the source as it's more
likely to be kept up to date (because it's there when you're changing
things).

I have a script which recursively processes all source files in the
distribution, looking for documentation, pulling it out and converting it
into a file which can be read by an online help system. This file can also
be converted into texi markup and my plan is to append this to the current
documentation.

So to get round to your question, it would be great to have some help
getting this documentation done - all is needed is a description of the
function and a small example. The format is currently along the lines of:

// StartFunctionDoc
// functionname argument1 argument2...
// Description:
// Describe the function here
// Example:
// (some)
// (scheme)
// (code) ; with comments
// EndFunctionDoc

The other thing that needs doing is reading through the existing
documentation (as a new user preferably) and posting feedback on what
needs further elaboration (or what's plain wrong or misleading). Also
finding typos or bad english etc... I can give you cvs access if you need
it.

I plan to write up some notes from the fluxus workshops on learning scheme
+ fluxus for beginners to the language (the current docs assume knowledge
of scheme), and add this to the existing manual.

cheers,

dave