There is also the floss manual. I'm updating the section on the API as
we speak..

On 9 June 2011 16:22, Francois PINOT  wrote:
> I vote for wiki
>
> Francois
>
>
> Message: 3
>>
>> Date: Thu, 9 Jun 2011 11:13:31 -0400
>> From: Steven Yi 
>> Subject: [Cs-dev] Where to have API User's Guide
>> To: Developer discussions 
>> Message-ID: 
>> Content-Type: text/plain; charset=ISO-8859-1
>>
>> Hi All,
>>
>> I wanted to start a separate thread regarding where should we put the
>> API user's guide, and how should we divide things up.  My thought is
>> we should either choose docbook (to match the user manual's output) or
>> we use the project wiki on sourceforge. The former gives us all of the
>> things we are used to with editing the user manual, the latter allows
>> a little more realtime modification and update and may be easier to
>> maintain (plus it keeps it together with the RFC's and API
>> modification pages).
>>
>> I think for myself, I'm leaning towards the Wiki.  I think too we
>> should have the following sections:
>>
>> * Introduction - (General information about the API)
>> * C
>> * C++
>> * Java
>> * Python
>> * Lua
>> * Lisp
>>
>> Under each language section would have the same subsections:
>>
>> * Introduction (i.e. describe how to get the API installed, intro to
>> packages, etc.)
>> * Simple Example
>> * Handling Threads (using csound threads, or threading yourself,
>> discussion about things to be careful about with threads)
>> * Setting Csound Callbacks (Message, MIDI, graph, etc.)
>> * Interacting at runtime (host to csound, csound to host, care about
>> not blocking too long by using intermediary data cache, etc.)
>> * etc.
>>
>> I think it'd be appropriate to divide by language then sections rather
>> than sections with each language within it, as I imagine if I want to
>> use python for example, I don't really care to see how it's done in
>> Java or Lisp.
>>
>> Does this sound alright?  If so, I can add the breakdown to the Wiki
>> and we can start filling things in to start.  If we want to move to
>> docbook or something else later, we can always do that too.
>>
>> Thanks!
>> steven
>>
>
> ------------------------------------------------------------------------------
> EditLive Enterprise is the world's most technically advanced content
> authoring tool. Experience the power of Track Changes, Inline Image
> Editing and ensure content is compliant with Accessibility Checking.
> http://p.sf.net/sfu/ephox-dev2dev
> _______________________________________________
> Csound-devel mailing list
> Csound-devel@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/csound-devel
>
>

------------------------------------------------------------------------------
EditLive Enterprise is the world's most technically advanced content
authoring tool. Experience the power of Track Changes, Inline Image
Editing and ensure content is compliant with Accessibility Checking.
http://p.sf.net/sfu/ephox-dev2dev
_______________________________________________
Csound-devel mailing list
Csound-devel@lists.sourceforge.net