Hi All,

Something sounds not right about embedding documentation as well. 
Would it not be possible for csound to have a manual lookup system and
a separate directory full of manual entries?  It would make easier
updating of manual entries to have them separate, so if an manual is
updated, the opcode doesn't have to be recompiled and redistributed. 
The precedent I am thinking about is the unix man pages, where the
utility and man page are separate.

What features would be interesting I think:

-If csound experiences an error in orchestra code, to check the manual
directory for an entry for the failed opcode, and if it finds it,
parse out the command line text from it, thus able to give a more
descriptive explanation, but if it doesn't find the error, report as
it does now

-for csound -z and -z1, also do a lookup of the manual entry and do
the same, show if available and use old method if not (maybe make this
-z2)

I can try to mock up something in python to do the lookup.  What this
doesn't do is allow for grouping of entries.  It might be nice to have
a string category in the OENTRY to facilitate that, but it could also
simply be done in the manual entry too.

steven


On 9/23/05, Anthony Kozar <anthonykozar@sbcglobal.net> wrote:
> Istvan Varga wrote on 9/23/05 5:07 AM:
>
> > Most of the other ideas are not fully clear, and I do not like the idea
> > of integrating parts of the manual into the engine or plugins; is there
> > any reason why the frontends cannot to display pages from the actual
> > manual ?
>
> Yes.  When lots of people start distributing many Csound plugins for a
> multitude of sites, there will be no combined manual for all of them.  This
> is why the plugins need to embed some metadata about themselves -- so that
> hosts can provide users with a decent interface to all of this information.
>
> We cannot assume one central repository for all Csound plugins.  If someone
> does not believe me on this, just search the web for PD internals.
>
> Anthony
>
>
>
> -------------------------------------------------------
> 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