Csound Csound-dev Csound-tekno Search About

[Csnd-dev] Manual for Csound 7

Date2025-02-25 17:07
FromFrancois PINOT
Subject[Csnd-dev] Manual for Csound 7
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


Date2025-02-25 17:11
FromDave Seidel
SubjectRe: [Csnd-dev] Manual for Csound 7
This looks great!

On Tue, Feb 25, 2025 at 12:08 PM Francois PINOT <fggpinot@gmail.com> 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


Date2025-02-25 18:27
Fromvlz
SubjectRe: [Csnd-dev] Manual for Csound 7
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 <fggpinot@gmail.com> 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


Date2025-02-25 18:33
From"Dr. Richard Boulanger"
SubjectRe: [Csnd-dev] Manual for Csound 7
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 <viclazzarini@gmail.com> 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 <fggpinot@gmail.com> 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


Date2025-02-25 18:52
FromRory Walsh
SubjectRe: [Csnd-dev] Manual for Csound 7
Great work guys. It looks and functions great. :) 

On Tue, 25 Feb 2025 at 18:33, Dr. Richard Boulanger <rboulanger@berklee.edu> 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 <viclazzarini@gmail.com> 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 <fggpinot@gmail.com> 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


Date2025-02-25 19:50
FromHlöðver Sigurðsson
SubjectRe: [Csnd-dev] Manual for Csound 7
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 <rorywalsh@ear.ie> wrote:
Great work guys. It looks and functions great. :) 

On Tue, 25 Feb 2025 at 18:33, Dr. Richard Boulanger <rboulanger@berklee.edu> 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 <viclazzarini@gmail.com> 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 <fggpinot@gmail.com> 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


Date2025-02-25 22:41
FromFrancois PINOT
SubjectRe: [Csnd-dev] Manual for Csound 7
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 <hlolli@gmail.com> 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 <rorywalsh@ear.ie> wrote:
Great work guys. It looks and functions great. :) 

On Tue, 25 Feb 2025 at 18:33, Dr. Richard Boulanger <rboulanger@berklee.edu> 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 <viclazzarini@gmail.com> 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 <fggpinot@gmail.com> 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


Date2025-02-28 11:45
FromTarmo Johannes
SubjectRe: [Csnd-dev] Manual for Csound 7
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 (<fggpinot@gmail.com>) 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 <hlolli@gmail.com> 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 <rorywalsh@ear.ie> wrote:
Great work guys. It looks and functions great. :) 

On Tue, 25 Feb 2025 at 18:33, Dr. Richard Boulanger <rboulanger@berklee.edu> 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 <viclazzarini@gmail.com> 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 <fggpinot@gmail.com> 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


Date2025-02-28 13:03
FromFrancois PINOT
SubjectRe: [Csnd-dev] Manual for Csound 7
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 <trmjhnns@gmail.com> 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 (<fggpinot@gmail.com>) 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 <hlolli@gmail.com> 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 <rorywalsh@ear.ie> wrote:
Great work guys. It looks and functions great. :) 

On Tue, 25 Feb 2025 at 18:33, Dr. Richard Boulanger <rboulanger@berklee.edu> 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 <viclazzarini@gmail.com> 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 <fggpinot@gmail.com> 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


Date2025-03-01 10:18
FromFrancois PINOT
SubjectRe: [Csnd-dev] Manual for Csound 7
I've added an Opcodes Index page: https://csound.com/manual/opcodesIndex/

François

Le ven. 28 févr. 2025 à 14:03, Francois PINOT <fggpinot@gmail.com> 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 <trmjhnns@gmail.com> 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 (<fggpinot@gmail.com>) 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 <hlolli@gmail.com> 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 <rorywalsh@ear.ie> wrote:
Great work guys. It looks and functions great. :) 

On Tue, 25 Feb 2025 at 18:33, Dr. Richard Boulanger <rboulanger@berklee.edu> 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 <viclazzarini@gmail.com> 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 <fggpinot@gmail.com> 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


Date2025-03-01 10:21
FromTarmo Johannes
SubjectRe: [Csnd-dev] Manual for Csound 7
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 <fggpinot@gmail.com> 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 <fggpinot@gmail.com> 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 <trmjhnns@gmail.com> 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 (<fggpinot@gmail.com>) 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 <hlolli@gmail.com> 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 <rorywalsh@ear.ie> wrote:
Great work guys. It looks and functions great. :) 

On Tue, 25 Feb 2025 at 18:33, Dr. Richard Boulanger <rboulanger@berklee.edu> 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 <viclazzarini@gmail.com> 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 <fggpinot@gmail.com> 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


Date2025-03-02 16:43
From"Dr. Richard Boulanger"
SubjectRe: [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 <trmjhnns@gmail.com> 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 <fggpinot@gmail.com> 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 <fggpinot@gmail.com> 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 <trmjhnns@gmail.com> 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 (<fggpinot@gmail.com>) 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 <hlolli@gmail.com> 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 <rorywalsh@ear.ie> wrote:
Great work guys. It looks and functions great. :) 

On Tue, 25 Feb 2025 at 18:33, Dr. Richard Boulanger <rboulanger@berklee.edu> 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 <viclazzarini@gmail.com> 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 <fggpinot@gmail.com> 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


Date2025-03-03 09:54
Fromjoachim heintz
SubjectRe: [Csnd-dev] Manual for Csound 7
yes and in particular it is much easier to write and to change.
kudos to françois for this tedious and accurate work which has got us to 
this new platform!


On 02/03/2025 17:43, Dr. Richard Boulanger wrote:
> 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  > wrote:
> 
>     Thank you, Francois!
> 
>     This is helpful and also to know about https://csound.com/manual/
>     opcodes/ 
> 
>     Great work, all the manual team, thanks!
> 
>     Tarmo
> 
> 
>     L, 1. märts 2025 12:18 Francois PINOT      > 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
>         > 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
>             > 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 (                 >) 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                      CS7_Manual/blob/main/docs/opcodes/adsyn.md?
>                     plain=1#adsyn> ?
> 
>                     Le mar. 25 févr. 2025, 20:51, Hlöðver Sigurðsson
>                     > 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
>                         > wrote:
> 
>                             Great work guys. It looks and functions
>                             great. :)
> 
>                             On Tue, 25 Feb 2025 at 18:33, Dr. Richard
>                             Boulanger                              > 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
>>                                 >                                 > 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 >>                                 > 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/
>>>                                 >>                                 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
>>>

Date2025-03-03 10:00
FromVictor Lazzarini <000010b17ddd988e-dmarc-request@LISTSERV.HEANET.IE>
SubjectRe: [Csnd-dev] [EXTERNAL] Re: [Csnd-dev] Manual for Csound 7
yes, thank you so much, François, for freeing us from docbook. It's going to be much simpler to write documentation now.

Prof. Victor Lazzarini
Maynooth University
Ireland

> On 3 Mar 2025, at 09:54, joachim heintz  wrote:
>
> *Warning*
>
> This email originated from outside of Maynooth University's Mail System. Do not reply, click links or open attachments unless you recognise the sender and know the content is safe.
>
> yes and in particular it is much easier to write and to change.
> kudos to françois for this tedious and accurate work which has got us to
> this new platform!
>
>
>> On 02/03/2025 17:43, Dr. Richard Boulanger wrote:
>> 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 > > wrote:
>>
>>    Thank you, Francois!
>>
>>    This is helpful and also to know about https://csound.com/manual/
>>    opcodes/ 
>>
>>    Great work, all the manual team, thanks!
>>
>>    Tarmo
>>
>>
>>    L, 1. märts 2025 12:18 Francois PINOT >    > 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
>>        > 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
>>            > 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 (>                >) 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 >                    CS7_Manual/blob/main/docs/opcodes/adsyn.md?
>>                    plain=1#adsyn> ?
>>
>>                    Le mar. 25 févr. 2025, 20:51, Hlöðver Sigurðsson
>>                    > 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
>>                        > wrote:
>>
>>                            Great work guys. It looks and functions
>>                            great. :)
>>
>>                            On Tue, 25 Feb 2025 at 18:33, Dr. Richard
>>                            Boulanger >                            > 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
>>>                                >>                                > 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 >>>                                > 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/
>>>>                                >>>                                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
>>>>

Date2025-03-17 12:01
FromTarmo Johannes
SubjectRe: [Csnd-dev] [EXTERNAL] Re: [Csnd-dev] Manual for Csound 7
Hi!

One more though on manual:

the Gen routines are hard to find. They are under 'Syntax of the score' but this is not inititive since score is just one way to use them. Why not an separate category in the main menu? Or it could be also under 'Miscellanea' if it seems better.

My humble opinion.

Thanks!
tarmo

Kontakt Victor Lazzarini (<000010b17ddd988e-dmarc-request@listserv.heanet.ie>) kirjutas kuupäeval E, 3. märts 2025 kell 12:00:
yes, thank you so much, François, for freeing us from docbook. It's going to be much simpler to write documentation now.

Prof. Victor Lazzarini
Maynooth University
Ireland

> On 3 Mar 2025, at 09:54, joachim heintz <jh@joachimheintz.de> wrote:
>
> *Warning*
>
> This email originated from outside of Maynooth University's Mail System. Do not reply, click links or open attachments unless you recognise the sender and know the content is safe.
>
> yes and in particular it is much easier to write and to change.
> kudos to françois for this tedious and accurate work which has got us to
> this new platform!
>
>
>> On 02/03/2025 17:43, Dr. Richard Boulanger wrote:
>> 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 <trmjhnns@gmail.com
>> <mailto:trmjhnns@gmail.com>> wrote:
>>
>>    Thank you, Francois!
>>
>>    This is helpful and also to know about https://csound.com/manual/
>>    opcodes/ <https://csound.com/manual/opcodes/><opcodename>
>>
>>    Great work, all the manual team, thanks!
>>
>>    Tarmo
>>
>>
>>    L, 1. märts 2025 12:18 Francois PINOT <fggpinot@gmail.com
>>    <mailto:fggpinot@gmail.com>> kirjutas:
>>
>>        I've added an Opcodes Index page: https://csound.com/manual/
>>        opcodesIndex/ <https://csound.com/manual/opcodesIndex/>
>>
>>        François
>>
>>        Le ven. 28 févr. 2025 à 14:03, Francois PINOT
>>        <fggpinot@gmail.com <mailto:fggpinot@gmail.com>> a écrit :
>>
>>            The correct URL is https://csound.com/manual/opcodes/adsr/
>>            <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
>>            <trmjhnns@gmail.com <mailto:trmjhnns@gmail.com>> 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 <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 (<fggpinot@gmail.com
>>                <mailto:fggpinot@gmail.com>>) 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 <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
>>                    <hlolli@gmail.com <mailto:hlolli@gmail.com>> 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
>>                        <rorywalsh@ear.ie <mailto:rorywalsh@ear.ie>> wrote:
>>
>>                            Great work guys. It looks and functions
>>                            great. :)
>>
>>                            On Tue, 25 Feb 2025 at 18:33, Dr. Richard
>>                            Boulanger <rboulanger@berklee.edu
>>                            <mailto:rboulanger@berklee.edu>> 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
>>>                                <viclazzarini@gmail.com
>>>                                <mailto:viclazzarini@gmail.com>> 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 <fggpinot@gmail.com
>>>>                                <mailto:fggpinot@gmail.com>> 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/
>>>>                                <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
>>>>

Date2025-03-17 14:34
Fromtjingboem
SubjectRe: [Csnd-dev] [EXTERNAL] Re: [Csnd-dev] Manual for Csound 7
yes, good point.

We could have:
Opcodes Overview
GEN overview
and
Opcodes Index
GEN index

and a few words on the ftgen page about the GEN form, and visa versa

On Mon, Mar 17, 2025 at 1:01 PM Tarmo Johannes <trmjhnns@gmail.com> wrote:
Hi!

One more though on manual:

the Gen routines are hard to find. They are under 'Syntax of the score' but this is not inititive since score is just one way to use them. Why not an separate category in the main menu? Or it could be also under 'Miscellanea' if it seems better.

My humble opinion.

Thanks!
tarmo

Kontakt Victor Lazzarini (<000010b17ddd988e-dmarc-request@listserv.heanet.ie>) kirjutas kuupäeval E, 3. märts 2025 kell 12:00:
yes, thank you so much, François, for freeing us from docbook. It's going to be much simpler to write documentation now.

Prof. Victor Lazzarini
Maynooth University
Ireland

> On 3 Mar 2025, at 09:54, joachim heintz <jh@joachimheintz.de> wrote:
>
> *Warning*
>
> This email originated from outside of Maynooth University's Mail System. Do not reply, click links or open attachments unless you recognise the sender and know the content is safe.
>
> yes and in particular it is much easier to write and to change.
> kudos to françois for this tedious and accurate work which has got us to
> this new platform!
>
>
>> On 02/03/2025 17:43, Dr. Richard Boulanger wrote:
>> 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 <trmjhnns@gmail.com
>> <mailto:trmjhnns@gmail.com>> wrote:
>>
>>    Thank you, Francois!
>>
>>    This is helpful and also to know about https://csound.com/manual/
>>    opcodes/ <https://csound.com/manual/opcodes/><opcodename>
>>
>>    Great work, all the manual team, thanks!
>>
>>    Tarmo
>>
>>
>>    L, 1. märts 2025 12:18 Francois PINOT <fggpinot@gmail.com
>>    <mailto:fggpinot@gmail.com>> kirjutas:
>>
>>        I've added an Opcodes Index page: https://csound.com/manual/
>>        opcodesIndex/ <https://csound.com/manual/opcodesIndex/>
>>
>>        François
>>
>>        Le ven. 28 févr. 2025 à 14:03, Francois PINOT
>>        <fggpinot@gmail.com <mailto:fggpinot@gmail.com>> a écrit :
>>
>>            The correct URL is https://csound.com/manual/opcodes/adsr/
>>            <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
>>            <trmjhnns@gmail.com <mailto:trmjhnns@gmail.com>> 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 <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 (<fggpinot@gmail.com
>>                <mailto:fggpinot@gmail.com>>) 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 <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
>>                    <hlolli@gmail.com <mailto:hlolli@gmail.com>> 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
>>                        <rorywalsh@ear.ie <mailto:rorywalsh@ear.ie>> wrote:
>>
>>                            Great work guys. It looks and functions
>>                            great. :)
>>
>>                            On Tue, 25 Feb 2025 at 18:33, Dr. Richard
>>                            Boulanger <rboulanger@berklee.edu
>>                            <mailto:rboulanger@berklee.edu>> 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
>>>                                <viclazzarini@gmail.com
>>>                                <mailto:viclazzarini@gmail.com>> 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 <fggpinot@gmail.com
>>>>                                <mailto:fggpinot@gmail.com>> 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/
>>>>                                <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
>>>>

Date2025-03-17 14:44
From"Dr. Richard Boulanger"
SubjectRe: [Csnd-dev] [EXTERNAL] Re: [Csnd-dev] Manual for Csound 7
Yes!

Dr. Richard Boulanger
Professor
Electronic Production and Design
Berklee College of Music

On Mar 17, 2025, at 10:34 AM, tjingboem <magknevel@gmail.com> wrote:


yes, good point.

We could have:
Opcodes Overview
GEN overview
and
Opcodes Index
GEN index

and a few words on the ftgen page about the GEN form, and visa versa

On Mon, Mar 17, 2025 at 1:01 PM Tarmo Johannes <trmjhnns@gmail.com> wrote:
Hi!

One more though on manual:

the Gen routines are hard to find. They are under 'Syntax of the score' but this is not inititive since score is just one way to use them. Why not an separate category in the main menu? Or it could be also under 'Miscellanea' if it seems better.

My humble opinion.

Thanks!
tarmo

Kontakt Victor Lazzarini (<000010b17ddd988e-dmarc-request@listserv.heanet.ie>) kirjutas kuupäeval E, 3. märts 2025 kell 12:00:
yes, thank you so much, François, for freeing us from docbook. It's going to be much simpler to write documentation now.

Prof. Victor Lazzarini
Maynooth University
Ireland

> On 3 Mar 2025, at 09:54, joachim heintz <jh@joachimheintz.de> wrote:
>
> *Warning*
>
> This email originated from outside of Maynooth University's Mail System. Do not reply, click links or open attachments unless you recognise the sender and know the content is safe.
>
> yes and in particular it is much easier to write and to change.
> kudos to françois for this tedious and accurate work which has got us to
> this new platform!
>
>
>> On 02/03/2025 17:43, Dr. Richard Boulanger wrote:
>> 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 <trmjhnns@gmail.com
>> <mailto:trmjhnns@gmail.com>> wrote:
>>
>>    Thank you, Francois!
>>
>>    This is helpful and also to know about https://csound.com/manual/
>>    opcodes/ <https://csound.com/manual/opcodes/><opcodename>
>>
>>    Great work, all the manual team, thanks!
>>
>>    Tarmo
>>
>>
>>    L, 1. märts 2025 12:18 Francois PINOT <fggpinot@gmail.com
>>    <mailto:fggpinot@gmail.com>> kirjutas:
>>
>>        I've added an Opcodes Index page: https://csound.com/manual/
>>        opcodesIndex/ <https://csound.com/manual/opcodesIndex/>
>>
>>        François
>>
>>        Le ven. 28 févr. 2025 à 14:03, Francois PINOT
>>        <fggpinot@gmail.com <mailto:fggpinot@gmail.com>> a écrit :
>>
>>            The correct URL is https://csound.com/manual/opcodes/adsr/
>>            <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
>>            <trmjhnns@gmail.com <mailto:trmjhnns@gmail.com>> 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 <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 (<fggpinot@gmail.com
>>                <mailto:fggpinot@gmail.com>>) 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 <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
>>                    <hlolli@gmail.com <mailto:hlolli@gmail.com>> 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
>>                        <rorywalsh@ear.ie <mailto:rorywalsh@ear.ie>> wrote:
>>
>>                            Great work guys. It looks and functions
>>                            great. :)
>>
>>                            On Tue, 25 Feb 2025 at 18:33, Dr. Richard
>>                            Boulanger <rboulanger@berklee.edu
>>                            <mailto:rboulanger@berklee.edu>> 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
>>>                                <viclazzarini@gmail.com
>>>                                <mailto:viclazzarini@gmail.com>> 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 <fggpinot@gmail.com
>>>>                                <mailto:fggpinot@gmail.com>> 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/
>>>>                                <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
>>>>