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

I vote for the wiki, too. This will make it easier for non-devs to
contribute to the knowledge base.

Jake
--
The Csound Blog - http://csoundblog.com/
Slipmat - http://slipmat.noisepages.com/

On Thu, Jun 9, 2011 at 8:13 AM, Steven Yi  wrote:
>
> 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
https://lists.sourceforge.net/lists/listinfo/csound-

> Does this sound alright?

yes

Stef

------------------------------------------------------------------------------
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

Hi All,

I was going to modify the wiki but looks like I don't have permission.  I get:

You do not have permission to edit this page, for the following reason:
The action you have requested is limited to users in one of the
groups: editor, admin.
You can view and copy the source of this page:

Could someone grant me access?

Thanks,
steven

On Thu, Jun 9, 2011 at 11:13 AM, Steven Yi  wrote:
> 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

The sourceforge wiki is a bit odd as you have to first visit it and
then ask John for persmission... The ultimate spam deterrent! =)

Cheers,
Andres

On Sat, Jun 11, 2011 at 3:06 AM, Steven Yi  wrote:
> Hi All,
>
> I was going to modify the wiki but looks like I don't have permission.  I get:
>
> You do not have permission to edit this page, for the following reason:
> The action you have requested is limited to users in one of the
> groups: editor, admin.
> You can view and copy the source of this page:
>
> Could someone grant me access?
>
> Thanks,
> steven
>
> On Thu, Jun 9, 2011 at 11:13 AM, Steven Yi  wrote:
>> 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
https:

John has worked it out for me.  Thanks John! (and thanks Andres for
adding that note to the Wiki!)

On Sat, Jun 11, 2011 at 11:51 AM, Andres Cabrera  wrote:
> The sourceforge wiki is a bit odd as you have to first visit it and
> then ask John for persmission... The ultimate spam deterrent! =)
>
> Cheers,
> Andres
>
> On Sat, Jun 11, 2011 at 3:06 AM, Steven Yi  wrote:
>> Hi All,
>>
>> I was going to modify the wiki but looks like I don't have permission.  I get:
>>
>> You do not have permission to edit this page, for the following reason:
>> The action you have requested is limited to users in one of the
>> groups: editor, admin.
>> You can view and copy the source of this page:
>>
>> Could someone grant me access?
>>
>> Thanks,
>> steven
>>
>> On Thu, Jun 9, 2011 at 11:13 AM, Steven Yi  wrote:
>>> 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
> 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

Hi All,

I've created the initial template for the API User Guide.  It's on the Wiki at:

https://sourceforge.net/apps/mediawiki/csound/index.php?title=Main_Page

I've created just a template for the C language section as to
breakdown.  My thought is, once agreed, we can copy the contents of
that section to the other sections and replace the "(C") with
"(Python)" or whatever other language.  I think we should make the
guide be divided the same as much as we can for each section.

Now, I'm not Wiki editing guru so would appreciate someone with more
Wik markup experience to take a look and let me know if the formatting
looks alright.

Thanks!
steven

On Sat, Jun 11, 2011 at 12:15 PM, Steven Yi  wrote:
> John has worked it out for me.  Thanks John! (and thanks Andres for
> adding that note to the Wiki!)
>
> On Sat, Jun 11, 2011 at 11:51 AM, Andres Cabrera  wrote:
>> The sourceforge wiki is a bit odd as you have to first visit it and
>> then ask John for persmission... The ultimate spam deterrent! =)
>>
>> Cheers,
>> Andres
>>
>> On Sat, Jun 11, 2011 at 3:06 AM, Steven Yi  wrote:
>>> Hi All,
>>>
>>> I was going to modify the wiki but looks like I don't have permission.  I get:
>>>
>>> You do not have permission to edit this page, for the following reason:
>>> The action you have requested is limited to users in one of the
>>> groups: editor, admin.
>>> You can view and copy the source of this page:
>>>
>>> Could someone grant me access?
>>>
>>> Thanks,
>>> steven
>>>
>>> On Thu, Jun 9, 2011 at 11:13 AM, Steven Yi  wrote:
>>>> 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
>> 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

Looks great Steven. If you like you can grab some text from the floss
manuals. There are some examples that fall nicely under your headings
and I hope to add more in the next few days.

On Saturday, 11 June 2011, Steven Yi  wrote:
> Hi All,
>
> I've created the initial template for the API User Guide.  It's on the Wiki at:
>
> https://sourceforge.net/apps/mediawiki/csound/index.php?title=Main_Page
>
> I've created just a template for the C language section as to
> breakdown.  My thought is, once agreed, we can copy the contents of
> that section to the other sections and replace the "(C") with
> "(Python)" or whatever other language.  I think we should make the
> guide be divided the same as much as we can for each section.
>
> Now, I'm not Wiki editing guru so would appreciate someone with more
> Wik markup experience to take a look and let me know if the formatting
> looks alright.
>
> Thanks!
> steven
>
> On Sat, Jun 11, 2011 at 12:15 PM, Steven Yi  wrote:
>> John has worked it out for me.  Thanks John! (and thanks Andres for
>> adding that note to the Wiki!)
>>
>> On Sat, Jun 11, 2011 at 11:51 AM, Andres Cabrera  wrote:
>>> The sourceforge wiki is a bit odd as you have to first visit it and
>>> then ask John for persmission... The ultimate spam deterrent! =)
>>>
>>> Cheers,
>>> Andres
>>>
>>> On Sat, Jun 11, 2011 at 3:06 AM, Steven Yi  wrote:
>>>> Hi All,
>>>>
>>>> I was going to modify the wiki but looks like I don't have permission.  I get:
>>>>
>>>> You do not have permission to edit this page, for the following reason:
>>>> The action you have requested is limited to users in one of the
>>>> groups: editor, admin.
>>>> You can view and copy the source of this page:
>>>>
>>>> Could someone grant me access?
>>>>
>>>> Thanks,
>>>> steven
>>>>
>>>> On Thu, Jun 9, 2011 at 11:13 AM, Steven Yi  wrote:
>>>>> 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@li

------------------------------------------------------------------------------
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

You know Rory, you can take that step and contribute as the Wiki is
open to all to edit! :P

But more seriously, I guess first thing to figure out: what
information do we have already we can use to start? As I understand
it, there is:

* FLOSS manual
* Michael's Guide
* Some articles online (Csound Journal, others that I've seen before
but can't remember where they are)

My take is to start with the FLOSS manual and Michael's guide first.
After that, scour through the Csound Journal to see what's available,
then start filling in information that's missing.

Also, I figure we should start with the C API guide, flesh it out,
then work on the others and use the C guide as a model.

If you're interested to spend some time with documenting the API,
could you please reply here?  Whether it is in writing or
reviewing/editing, all is welcome.  We can figure out a plan of attack
in dividing up work after this.

Thanks!
steven


On Sat, Jun 11, 2011 at 2:52 PM, Rory Walsh  wrote:
> Looks great Steven. If you like you can grab some text from the floss
> manuals. There are some examples that fall nicely under your headings
> and I hope to add more in the next few days.
>
> On Saturday, 11 June 2011, Steven Yi  wrote:
>> Hi All,
>>
>> I've created the initial template for the API User Guide.  It's on the Wiki at:
>>
>> https://sourceforge.net/apps/mediawiki/csound/index.php?title=Main_Page
>>
>> I've created just a template for the C language section as to
>> breakdown.  My thought is, once agreed, we can copy the contents of
>> that section to the other sections and replace the "(C") with
>> "(Python)" or whatever other language.  I think we should make the
>> guide be divided the same as much as we can for each section.
>>
>> Now, I'm not Wiki editing guru so would appreciate someone with more
>> Wik markup experience to take a look and let me know if the formatting
>> looks alright.
>>
>> Thanks!
>> steven
>>
>> On Sat, Jun 11, 2011 at 12:15 PM, Steven Yi  wrote:
>>> John has worked it out for me.  Thanks John! (and thanks Andres for
>>> adding that note to the Wiki!)
>>>
>>> On Sat, Jun 11, 2011 at 11:51 AM, Andres Cabrera  wrote:
>>>> The sourceforge wiki is a bit odd as you have to first visit it and
>>>> then ask John for persmission... The ultimate spam deterrent! =)
>>>>
>>>> Cheers,
>>>> Andres
>>>>
>>>> On Sat, Jun 11, 2011 at 3:06 AM, Steven Yi  wrote:
>>>>> Hi All,
>>>>>
>>>>> I was going to modify the wiki but looks like I don't have permission.  I get:
>>>>>
>>>>> You do not have permission to edit this page, for the following reason:
>>>>> The action you have requested is limited to users in one of the
>>>>> groups: editor, admin.
>>>>> You can view and copy the source of this page:
>>>>>
>>>>> Could someone grant me access?
>>>>>
>>>>> Thanks,
>>>>> steven
>>>>>
>>>>> On Thu, Jun 9, 2011 at 11:13 AM, Steven Yi  wrote:
>>>>>> 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@li
>
> ------------------------------------------------------------------------------
> 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

> If you're interested to spend some time with documenting the API,
> could you please reply here?  Whether it is in writing or
> reviewing/editing, all is welcome.  We can figure out a plan of attack
> in dividing up work after this.

Once the JAVA API is covered, I can if you want add a section about 
accessing it dynamically via Emacs+Clojure, which is what I'm doing in 
Surmulot.

Stef


------------------------------------------------------------------------------
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

I wrote an article on using the API for the Csound journal some years
ago. I'm using that as a basis for my contribution to the floss
manual. I can contribute c/c++ code but I don't do python or Java.

Rory.


2011/6/11 Stéphane Rollandin :
>> If you're interested to spend some time with documenting the API,
>> could you please reply here?  Whether it is in writing or
>> reviewing/editing, all is welcome.  We can figure out a plan of attack
>> in dividing up work after this.
>
> Once the JAVA API is covered, I can if you want add a section about
> accessing it dynamically via Emacs+Clojure, which is what I'm doing in
> Surmulot.
>
> Stef
>
>
> ------------------------------------------------------------------------------
> 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

Thanks Stephane and Rory for replying.  I'm going to be out of town
next week and this week is pretty full up, so am scheduling myself to
start looking at this when I get back.  In the meanwhile, if anyone
wants to make modifications you're welcome to modify the wiki.

Thanks!
steven

On Sun, Jun 12, 2011 at 11:59 AM, Rory Walsh  wrote:
> I wrote an article on using the API for the Csound journal some years
> ago. I'm using that as a basis for my contribution to the floss
> manual. I can contribute c/c++ code but I don't do python or Java.
>
> Rory.
>
>
> 2011/6/11 Stéphane Rollandin :
>>> If you're interested to spend some time with documenting the API,
>>> could you please reply here?  Whether it is in writing or
>>> reviewing/editing, all is welcome.  We can figure out a plan of attack
>>> in dividing up work after this.
>>
>> Once the JAVA API is covered, I can if you want add a section about
>> accessing it dynamically via Emacs+Clojure, which is what I'm doing in
>> Surmulot.
>>
>> Stef
>>
>>
>> ------------------------------------------------------------------------------
>> 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
> 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