Csound Csound-dev Csound-tekno Search About

Re: [Cs-dev] Manual/docs for extending Csound

Date2005-07-15 21:21
FromMichael Gogins
SubjectRe: [Cs-dev] Manual/docs for extending Csound
I think it would be better to update the manual rather than the wiki. You could circulate a draft, or request feedback, if you are not sure about the content.

Regards,
Mike

-----Original Message-----
From: Iain Duncan 
Sent: Jul 15, 2005 3:22 PM
To: csound-devel@lists.sourceforge.net
Subject: Re: [Cs-dev] Manual/docs for extending Csound

> I've been wanting to work on the manual for a while, but haven't had any
> time. I have a lot of emails flagged that contain useful information
> that should be in the manual or a wiki. If you have time, I can send you
> this information.

I have no time really for about another week, but after that I plan on 
working on some opcodes. In the process I would be happy to help make a 
wiki page on that process, and/or attempt a rewrite of the manual page.
Do you have stuff saved on that topic specifically?

Dr B & David, what do you think about a wiki page on csounds.com on 
topics like that?

Iain


> Cheers,
> Andrés
> 
> On Thu, 2005-07-14 at 13:51, Iain Duncan wrote:
> 
>>>Hi Iain,
>>>
>>>I believe Dr. Victor Lazzarini has authored a number of papers on the 
>>>subject. You will find these on cSounds.com or at his site:
>>>
>>>http://www.nuim.ie/academic/music/vlazzarini/
>>>
>>>http://www.csounds.com/articles/Extensions_to_Csound.pdf
>>>
>>>http://www.csounds.com/articles/DevelopingOpcodes.zip
>>>(contains sndloop.c source suitable for both Csound4 and Csound5. You 
>>>can A/B the API discrepancies.)
>>
>>Thanks for the links David, and Victor, thanks for the wonderful paper, 
>>it was incredible readable for a technical how to! =) I am keeping all 
>>of the comments I can find on this topic, perhaps this would be the kind 
>>of thing that would be useful as a wiki page? Perhaps in conjuction with 
>>the UDO database and eventual dynamic Opcode database? ( It's bound to 
>>happen now that recoding UDOs to regular opcodes is much easier! )
>>
>>Iain
>>
>>
>>-------------------------------------------------------
>>SF.Net email is sponsored by: Discover Easy Linux Migration Strategies
>>from IBM. Find simple to follow Roadmaps, straightforward articles,
>>informative Webcasts and more! Get everything you need to get up to
>>speed, fast. http://ads.osdn.com/?ad_id=7477&alloc_id=16492&op=click
>>_______________________________________________
>>Csound-devel mailing list
>>Csound-devel@lists.sourceforge.net
>>https://lists.sourceforge.net/lists/listinfo/csound-devel
>>
>>
> 
> 
> 
> 
> -------------------------------------------------------
> SF.Net email is sponsored by: Discover Easy Linux Migration Strategies
> from IBM. Find simple to follow Roadmaps, straightforward articles,
> informative Webcasts and more! Get everything you need to get up to
> speed, fast. http://ads.osdn.com/?ad_idt77&alloc_id492&op=click
> _______________________________________________
> Csound-devel mailing list
> Csound-devel@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/csound-devel
> 


-------------------------------------------------------
SF.Net email is sponsored by: Discover Easy Linux Migration Strategies
from IBM. Find simple to follow Roadmaps, straightforward articles,
informative Webcasts and more! Get everything you need to get up to
speed, fast. http://ads.osdn.com/?ad_id=7477&alloc_id=16492&op=click
_______________________________________________
Csound-devel mailing list
Csound-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/csound-devel





-------------------------------------------------------
SF.Net email is sponsored by: Discover Easy Linux Migration Strategies
from IBM. Find simple to follow Roadmaps, straightforward articles,
informative Webcasts and more! Get everything you need to get up to
speed, fast. http://ads.osdn.com/?ad_idt77&alloc_id492&op=click
_______________________________________________
Csound-devel mailing list
Csound-devel@lists.sourceforge.net

Date2005-07-16 06:22
FromDavid Akbari
SubjectRe: [Cs-dev] Manual/docs for extending Csound
I agree with Mike. The Canonical Reference Manual should be an absolute 
resource for users to refer to that is free from errors or misnomers.

I believe it would make more sense to host a Wiki as an off-site 
resource; if a group of users decided to add a Csound entry to 
wikipedia.com for example, I would of course add multiple references to 
this on cSounds.com.

This entry could be treated as a combination of the Canonical Manual as 
well as user addendum to the language (non-canonical). The purpose of 
this could be similar to a "manual scratchpad". I don't think we would 
want users to access the Canonical manual and make potentially 
erroneous additions too hastily.

On a side note, if there are some responsibilities that I could help 
with in adding information / maintaining the Canonical Reference 
Manual, I would be obliged to do so.

Also, how can a user go about compiling a Windows .chm or .hlp from CVS 
source of the manual? What documents exist to help explain this 
process?

I am officially running Ubuntu Linux / Win 98 SE / and OSX on the same 
machine. I am certainly down to try and enforce cross-platform 
compatibility to the extent I can possibly offer.


-David


On Jul 15, 2005, at 4:21 PM, Michael Gogins wrote:

> I think it would be better to update the manual rather than the wiki. 
> You could circulate a draft, or request feedback, if you are not sure 
> about the content.
>
> Regards,
> Mike
>
> -----Original Message-----
> From: Iain Duncan 
> Sent: Jul 15, 2005 3:22 PM
> To: csound-devel@lists.sourceforge.net
> Subject: Re: [Cs-dev] Manual/docs for extending Csound
>
>> I've been wanting to work on the manual for a while, but haven't had 
>> any
>> time. I have a lot of emails flagged that contain useful information
>> that should be in the manual or a wiki. If you have time, I can send 
>> you
>> this information.
>
> I have no time really for about another week, but after that I plan on
> working on some opcodes. In the process I would be happy to help make a
> wiki page on that process, and/or attempt a rewrite of the manual page.
> Do you have stuff saved on that topic specifically?
>
> Dr B & David, what do you think about a wiki page on csounds.com on
> topics like that?
>
> Iain
>
>
>> Cheers,
>> Andrés
>>
>> On Thu, 2005-07-14 at 13:51, Iain Duncan wrote:
>>
>>>> Hi Iain,
>>>>
>>>> I believe Dr. Victor Lazzarini has authored a number of papers on 
>>>> the
>>>> subject. You will find these on cSounds.com or at his site:
>>>>
>>>> http://www.nuim.ie/academic/music/vlazzarini/
>>>>
>>>> http://www.csounds.com/articles/Extensions_to_Csound.pdf
>>>>
>>>> http://www.csounds.com/articles/DevelopingOpcodes.zip
>>>> (contains sndloop.c source suitable for both Csound4 and Csound5. 
>>>> You
>>>> can A/B the API discrepancies.)
>>>
>>> Thanks for the links David, and Victor, thanks for the wonderful 
>>> paper,
>>> it was incredible readable for a technical how to! =) I am keeping 
>>> all
>>> of the comments I can find on this topic, perhaps this would be the 
>>> kind
>>> of thing that would be useful as a wiki page? Perhaps in conjuction 
>>> with
>>> the UDO database and eventual dynamic Opcode database? ( It's bound 
>>> to
>>> happen now that recoding UDOs to regular opcodes is much easier! )
>>>
>>> Iain
>>>
>>>
>>> -------------------------------------------------------
>>> SF.Net email is sponsored by: Discover Easy Linux Migration 
>>> Strategies
>>> from IBM. Find simple to follow Roadmaps, straightforward articles,
>>> informative Webcasts and more! Get everything you need to get up to
>>> speed, fast. http://ads.osdn.com/?ad_id=7477&alloc_id=16492&op=click
>>> _______________________________________________
>>> Csound-devel mailing list
>>> Csound-devel@lists.sourceforge.net
>>> https://lists.sourceforge.net/lists/listinfo/csound-devel
>>>
>>>
>>
>>
>>
>>
>> -------------------------------------------------------
>> SF.Net email is sponsored by: Discover Easy Linux Migration Strategies
>> from IBM. Find simple to follow Roadmaps, straightforward articles,
>> informative Webcasts and more! Get everything you need to get up to
>> speed, fast. http://ads.osdn.com/?ad_idt77&alloc_id492&op=click
>> _______________________________________________
>> Csound-devel mailing list
>> Csound-devel@lists.sourceforge.net
>> https://lists.sourceforge.net/lists/listinfo/csound-devel
>>
>
>
> -------------------------------------------------------
> SF.Net email is sponsored by: Discover Easy Linux Migration Strategies
> from IBM. Find simple to follow Roadmaps, straightforward articles,
> informative Webcasts and more! Get everything you need to get up to
> speed, fast. http://ads.osdn.com/?ad_id=7477&alloc_id=16492&op=click
> _______________________________________________
> Csound-devel mailing list
> Csound-devel@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/csound-devel
>
>
>
>
>
> -------------------------------------------------------
> SF.Net email is sponsored by: Discover Easy Linux Migration Strategies
> from IBM. Find simple to follow Roadmaps, straightforward articles,
> informative Webcasts and more! Get everything you need to get up to
> speed, fast. http://ads.osdn.com/?ad_idt77&alloc_id492&op=click
> _______________________________________________
> Csound-devel mailing list
> Csound-devel@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/csound-devel
>



-------------------------------------------------------
SF.Net email is sponsored by: Discover Easy Linux Migration Strategies
from IBM. Find simple to follow Roadmaps, straightforward articles,
informative Webcasts and more! Get everything you need to get up to
speed, fast. http://ads.osdn.com/?ad_idt77&alloc_id492&op=click
_______________________________________________
Csound-devel mailing list
Csound-devel@lists.sourceforge.net

Date2005-07-16 06:42
FromIain Duncan
SubjectRe: [Cs-dev] Manual/docs for extending Csound
The reason I liked the wiki idea ( or page with comments ) is just that 
I often find on resource pages where users are allowed to add comments, 
there are tips and little gotchas that might be quite platform specific. 
( Ie I did this like so on Debian ). I do think the main entry should be 
in the manual and the manual should be as up to date and complete as 
possible.

Iain

David Akbari wrote:
> I agree with Mike. The Canonical Reference Manual should be an absolute 
> resource for users to refer to that is free from errors or misnomers.
> 
> I believe it would make more sense to host a Wiki as an off-site 
> resource; if a group of users decided to add a Csound entry to 
> wikipedia.com for example, I would of course add multiple references to 
> this on cSounds.com.
> 
> This entry could be treated as a combination of the Canonical Manual as 
> well as user addendum to the language (non-canonical). The purpose of 
> this could be similar to a "manual scratchpad". I don't think we would 
> want users to access the Canonical manual and make potentially erroneous 
> additions too hastily.
> 
> On a side note, if there are some responsibilities that I could help 
> with in adding information / maintaining the Canonical Reference Manual, 
> I would be obliged to do so.
> 
> Also, how can a user go about compiling a Windows .chm or .hlp from CVS 
> source of the manual? What documents exist to help explain this process?
> 
> I am officially running Ubuntu Linux / Win 98 SE / and OSX on the same 
> machine. I am certainly down to try and enforce cross-platform 
> compatibility to the extent I can possibly offer.
> 
> 
> -David
> 
> 
> On Jul 15, 2005, at 4:21 PM, Michael Gogins wrote:
> 
>> I think it would be better to update the manual rather than the wiki. 
>> You could circulate a draft, or request feedback, if you are not sure 
>> about the content.
>>
>> Regards,
>> Mike
>>
>> -----Original Message-----
>> From: Iain Duncan 
>> Sent: Jul 15, 2005 3:22 PM
>> To: csound-devel@lists.sourceforge.net
>> Subject: Re: [Cs-dev] Manual/docs for extending Csound
>>
>>> I've been wanting to work on the manual for a while, but haven't had any
>>> time. I have a lot of emails flagged that contain useful information
>>> that should be in the manual or a wiki. If you have time, I can send you
>>> this information.
>>
>>
>> I have no time really for about another week, but after that I plan on
>> working on some opcodes. In the process I would be happy to help make a
>> wiki page on that process, and/or attempt a rewrite of the manual page.
>> Do you have stuff saved on that topic specifically?
>>
>> Dr B & David, what do you think about a wiki page on csounds.com on
>> topics like that?
>>
>> Iain
>>
>>
>>> Cheers,
>>> Andrés
>>>
>>> On Thu, 2005-07-14 at 13:51, Iain Duncan wrote:
>>>
>>>>> Hi Iain,
>>>>>
>>>>> I believe Dr. Victor Lazzarini has authored a number of papers on the
>>>>> subject. You will find these on cSounds.com or at his site:
>>>>>
>>>>> http://www.nuim.ie/academic/music/vlazzarini/
>>>>>
>>>>> http://www.csounds.com/articles/Extensions_to_Csound.pdf
>>>>>
>>>>> http://www.csounds.com/articles/DevelopingOpcodes.zip
>>>>> (contains sndloop.c source suitable for both Csound4 and Csound5. You
>>>>> can A/B the API discrepancies.)
>>>>
>>>>
>>>> Thanks for the links David, and Victor, thanks for the wonderful paper,
>>>> it was incredible readable for a technical how to! =) I am keeping all
>>>> of the comments I can find on this topic, perhaps this would be the 
>>>> kind
>>>> of thing that would be useful as a wiki page? Perhaps in conjuction 
>>>> with
>>>> the UDO database and eventual dynamic Opcode database? ( It's bound to
>>>> happen now that recoding UDOs to regular opcodes is much easier! )
>>>>
>>>> Iain
>>>>
>>>>
>>>> -------------------------------------------------------
>>>> SF.Net email is sponsored by: Discover Easy Linux Migration Strategies
>>>> from IBM. Find simple to follow Roadmaps, straightforward articles,
>>>> informative Webcasts and more! Get everything you need to get up to
>>>> speed, fast. http://ads.osdn.com/?ad_id=7477&alloc_id=16492&op=click
>>>> _______________________________________________
>>>> Csound-devel mailing list
>>>> Csound-devel@lists.sourceforge.net
>>>> https://lists.sourceforge.net/lists/listinfo/csound-devel
>>>>
>>>>
>>>
>>>
>>>
>>>
>>> -------------------------------------------------------
>>> SF.Net email is sponsored by: Discover Easy Linux Migration Strategies
>>> from IBM. Find simple to follow Roadmaps, straightforward articles,
>>> informative Webcasts and more! Get everything you need to get up to
>>> speed, fast. http://ads.osdn.com/?ad_idt77&alloc_id492&op=click
>>> _______________________________________________
>>> Csound-devel mailing list
>>> Csound-devel@lists.sourceforge.net
>>> https://lists.sourceforge.net/lists/listinfo/csound-devel
>>>
>>
>>
>> -------------------------------------------------------
>> SF.Net email is sponsored by: Discover Easy Linux Migration Strategies
>> from IBM. Find simple to follow Roadmaps, straightforward articles,
>> informative Webcasts and more! Get everything you need to get up to
>> speed, fast. http://ads.osdn.com/?ad_id=7477&alloc_id=16492&op=click
>> _______________________________________________
>> Csound-devel mailing list
>> Csound-devel@lists.sourceforge.net
>> https://lists.sourceforge.net/lists/listinfo/csound-devel
>>
>>
>>
>>
>>
>> -------------------------------------------------------
>> SF.Net email is sponsored by: Discover Easy Linux Migration Strategies
>> from IBM. Find simple to follow Roadmaps, straightforward articles,
>> informative Webcasts and more! Get everything you need to get up to
>> speed, fast. http://ads.osdn.com/?ad_idt77&alloc_id492&op=click
>> _______________________________________________
>> Csound-devel mailing list
>> Csound-devel@lists.sourceforge.net
>> https://lists.sourceforge.net/lists/listinfo/csound-devel
>>
> 
> 
> 
> -------------------------------------------------------
> SF.Net email is sponsored by: Discover Easy Linux Migration Strategies
> from IBM. Find simple to follow Roadmaps, straightforward articles,
> informative Webcasts and more! Get everything you need to get up to
> speed, fast. http://ads.osdn.com/?ad_idt77&alloc_id492&op=click
> _______________________________________________
> Csound-devel mailing list
> Csound-devel@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/csound-devel
> 
> 


-------------------------------------------------------
SF.Net email is sponsored by: Discover Easy Linux Migration Strategies
from IBM. Find simple to follow Roadmaps, straightforward articles,
informative Webcasts and more! Get everything you need to get up to
speed, fast. http://ads.osdn.com/?ad_id=7477&alloc_id=16492&op=click
_______________________________________________
Csound-devel mailing list
Csound-devel@lists.sourceforge.net