I think this is a good idea. I would urge you to google around a bit and see 
how others might have handled this problem. My initial idea would be to 
embed the help in the opcode shared library file as a static string as 
either plain text, or in some minimal XML or HTML format.

Regards,
Mike

----- Original Message ----- 
From: "Andres Cabrera" 
To: "Csound-dev" 
Sent: Thursday, September 22, 2005 11:31 PM
Subject: [Cs-dev] Re: [Csnd] Csound 5 status


> Hi,
> About this message I remembered today something that was discussed that
> may be worth looking at, which is the addition of opcode meta-data.
> It might be useful (especially for front-ends and programs that use the
> api) to be able to know some more information about the opcodes. It
> would be good if apart from having access to the input and output number
> and types, having some other information like:
> -descriptive names for input and output variables (eg. aout, kfreq,
> etc.)
> -Brief (one line) description of the opcodes's function
> -Category and sub-category, for front-ends to be able to generate help
> and context menus (among other things). I'm thinking specifically of
> blue's menu to choose opcodes.
>
> This way, programs like blue or cecilia could generate part of their
> documentation dynamically, directly from the opcodes themselves.
>
> Does this proposal make sense?
> I would dig in if I knew where to start, but I can offer help in adding
> the information to the opcode sources.
>
> Cheers,
> Andres
>
> On Thu, 2005-08-25 at 07:36, Istvan Varga wrote:
>> One month after the previous review of what is left to do before
>> releasing Csound 5, it is time to update the information on
>> development status. Does anyone have suggestions on major issues
>> to be solved, or any (even if small) incompatible changes to the
>> API that should be done ? What is required to have a "release
>> candidate" version ?
>
>
>
> -------------------------------------------------------
> SF.Net email is sponsored by:
> Tame your development challenges with Apache's Geronimo App Server. 
> Download
> it for free - -and be entered to win a 42" plasma tv or your very own
> Sony(tm)PSP.  Click here to play: http://sourceforge.net/geronimo.php
> _______________________________________________
> Csound-devel mailing list
> Csound-devel@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/csound-devel
> 




-------------------------------------------------------
SF.Net email is sponsored by:
Tame your development challenges with Apache's Geronimo App Server. Download
it for free - -and be entered to win a 42" plasma tv or your very own
Sony(tm)PSP.  Click here to play: http://sourceforge.net/geronimo.php
_______________________________________________
Csound-devel mailing list
Csound-devel@lists.sourceforge.net