Re: [Csnd-dev] Manual for Csound 7

I second Tarmo's gratitude to the entire manual team.
WOW.
It is looking so beautiful, modern, and clean.

*- Dr.B*


*Dr. Richard Boulanger*

Professor

Electronic Production and Design

*Berklee College of Music*

Professional Writing & Technology Division


On Sat, Mar 1, 2025 at 5:22 AM Tarmo Johannes <[email protected]> wrote:

> Thank you, Francois!
>
> This is helpful and also to know about https://csound.com/manual/opcodes/
> <opcodename>
>
> Great work, all the manual team, thanks!
>
> Tarmo
>
>
> L, 1. märts 2025 12:18 Francois PINOT <[email protected]> kirjutas:
>
>> I've added an Opcodes Index page: https://csound.com/manual/opcodesIndex/
>>
>> François
>>
>> Le ven. 28 févr. 2025 à 14:03, Francois PINOT <[email protected]> a
>> écrit :
>>
>>> The correct URL is  https://csound.com/manual/opcodes/adsr/
>>>
>>> Note that this is the develop branch of the manual and that about 20% of
>>> the manual is not yet ported to mkdocs. A few days more...
>>>
>>> François
>>>
>>> Le ven. 28 févr. 2025, 12:45, Tarmo Johannes <[email protected]> a
>>> écrit :
>>>
>>>> Hi!
>>>>
>>>> Yes, the new manual looks great and is well organized. It is so
>>>> important to have Csound 7 documentation available, thank you som much!
>>>> A small drawback at the moment I noticed in a lesson that the short
>>>> access to opcodes like https://csound.com/manual/adsr looks weird as
>>>> all icons magnified and gives 404 error result for the content.
>>>>
>>>> Also I could not find "Table of contents" entry with list of all
>>>> opcodes where a quick search would give the entry of specific opcode.
>>>>
>>>> Or what is the new logic about this?
>>>>
>>>> Thanks!
>>>> tarmo
>>>>
>>>> Kontakt Francois PINOT (<[email protected]>) kirjutas kuupäeval K,
>>>> 26. veebruar 2025 kell 00:41:
>>>>
>>>>> Metadata like the ones in the comments at the top of this file:
>>>>> https://github.com/joachimheintz/CS7_Manual/blob/main/docs/opcodes/adsyn.md?plain=1#adsyn
>>>>> ?
>>>>>
>>>>> Le mar. 25 févr. 2025, 20:51, Hlöðver Sigurðsson <[email protected]> a
>>>>> écrit :
>>>>>
>>>>>> look good. The only downside off the bat for me, is I use the data
>>>>>> programmability of xml to create emacs and web-ide editor support. But it
>>>>>> could be supported separately, in fact perhaps even as opcode metadata
>>>>>> built in down the road.
>>>>>>
>>>>>> On Tue, 25 Feb 2025 at 20:52, Rory Walsh <[email protected]> wrote:
>>>>>>
>>>>>>> Great work guys. It looks and functions great. :)
>>>>>>>
>>>>>>> On Tue, 25 Feb 2025 at 18:33, Dr. Richard Boulanger <
>>>>>>> [email protected]> wrote:
>>>>>>>
>>>>>>>> Looking great!  But... the historical preface mentions Berry
>>>>>>>> Vercoe.  ;-).   It is Barry Vercoe
>>>>>>>> Dr. Richard Boulanger
>>>>>>>> Professor
>>>>>>>> Electronic Production and Design
>>>>>>>> Berklee College of Music
>>>>>>>>
>>>>>>>> On Feb 25, 2025, at 1:27 PM, vlz <[email protected]> wrote:
>>>>>>>>
>>>>>>>> Yes, absolutely. Thanks a lot for this work. It will simplify
>>>>>>>> maintenance significantly.
>>>>>>>> Prof. Victor Lazzarini
>>>>>>>> Maynooth University
>>>>>>>> Ireland
>>>>>>>>
>>>>>>>> On 25 Feb 2025, at 17:08, Francois PINOT <[email protected]>
>>>>>>>> wrote:
>>>>>>>>
>>>>>>>> 
>>>>>>>> Dear devs,
>>>>>>>>
>>>>>>>> Joachim, Menno and I are working on a new platform for the manual
>>>>>>>> for Csound 7. We're using mkdocs-material which is based on markdown, a
>>>>>>>> technology simpler and more recent than docbook. It produces
>>>>>>>> beautiful pages.
>>>>>>>>
>>>>>>>> The transformation from xml to markdown is a bit tedious. I tried
>>>>>>>> different tools available on the web, but the results were not convincing.
>>>>>>>> I finally wrote a program to transform one notice from xml to markdown: it
>>>>>>>> works fine on nearly all files: for each file it takes me about 2mn to
>>>>>>>> transform it, verify the result and eventually do some hand adjustment. I
>>>>>>>> wrote another program to cleanly replace the tabulations by spaces in the
>>>>>>>> csd files.
>>>>>>>>
>>>>>>>> After three weeks, I've transformed about 65% of the manual. You
>>>>>>>> can see the result here:
>>>>>>>> https://joachimheintz.github.io/CS7_Manual/
>>>>>>>>
>>>>>>>> If everyone agrees, we'd like to move this repository from
>>>>>>>> Joachim's github to the csound github even if it's not complete so that
>>>>>>>> people can begin to add notices for Csound 7. We can add it as a new branch
>>>>>>>> to the actual manual repo, protecting the other branches against writing,
>>>>>>>> so that this new branch becomes the official develop branch of the manual
>>>>>>>> with its own CI action. Of course, we'll provide guidelines to help people
>>>>>>>> writing new notices.
>>>>>>>>
>>>>>>>> Comments and advice are welcome.
>>>>>>>>
>>>>>>>> Regards
>>>>>>>>
>>>>>>>> François
>>>>>>>>
>>>>>>>>