Csound Csound-dev Csound-tekno Search About

[Csnd] new manual

Date2025-05-17 20:21
FromVictor Lazzarini <000010b17ddd988e-dmarc-request@LISTSERV.HEANET.IE>
Subject[Csnd] new manual
Just a shout out to the manual team and François in special. 

I've written my first set of pages for new opcodes and the process is so easy! 

So much better than the clunky docbook, md files are easily written and, more 
importantly, readable!

The resulting pages look something else, much more stylish and modern. The docbook styling was dire. This is fantastic.

The syntax tabs are the icing on the cake! Great stuff.

Well done and many thanks for this. Documentation writing is not something to dread anymore.

Prof. Victor Lazzarini
Maynooth University
Ireland

Csound mailing list
Csound@listserv.heanet.ie
https://listserv.heanet.ie/cgi-bin/wa?A0=CSOUND
Send bugs reports to
        https://github.com/csound/csound/issues
Discussions of bugs and features can be posted here

Date2025-05-18 13:29
FromFrancois PINOT
SubjectRe: [Csnd] new manual
Thanks Victor.

I wouldn't be so harsh about xml and docbook. They were great technology 20 years ago and they still are for algorithmic data computing  and NoSQL databases for example...
Of course md files are more friendly for humans to edit and mkdocs-material offers very nice styling features created by smart and experienced people.

The use of mkdocs was Joachim's idea. The syntax tabs were Menno's idea.

François

Le sam. 17 mai 2025 à 21:21, Victor Lazzarini <000010b17ddd988e-dmarc-request@listserv.heanet.ie> a écrit :

Just a shout out to the manual team and François in special.

I've written my first set of pages for new opcodes and the process is so easy!

So much better than the clunky docbook, md files are easily written and, more
importantly, readable!

The resulting pages look something else, much more stylish and modern. The docbook styling was dire. This is fantastic.

The syntax tabs are the icing on the cake! Great stuff.

Well done and many thanks for this. Documentation writing is not something to dread anymore.

Prof. Victor Lazzarini
Maynooth University
Ireland

Csound mailing list
Csound@listserv.heanet.ie
https://listserv.heanet.ie/cgi-bin/wa?A0=CSOUND
Send bugs reports to
        https://github.com/csound/csound/issues
Discussions of bugs and features can be posted here
Csound mailing list Csound@listserv.heanet.ie https://listserv.heanet.ie/cgi-bin/wa?A0=CSOUND Send bugs reports to https://github.com/csound/csound/issues Discussions of bugs and features can be posted here

Date2025-05-18 15:16
Fromjoachim heintz
SubjectRe: [Csnd] new manual
... but you did it, and i do not want to know how much time you spent 
with it ... =)

i second your words about docbook.  in particular we should not forget 
that steven at that time did a similar work as françois has done now.

	joachim

On 18/05/2025 14:29, Francois PINOT wrote:
> Thanks Victor.
> 
> I wouldn't be so harsh about xml and docbook. They were great technology 
> 20 years ago and they still are for algorithmic data computing  and 
> NoSQL databases for example...
> Of course md files are more friendly for humans to edit and mkdocs- 
> material offers very nice styling features created by smart and 
> experienced people.
> 
> The use of mkdocs was Joachim's idea. The syntax tabs were Menno's idea.
> 
> François
> 
> Le sam. 17 mai 2025 à 21:21, Victor Lazzarini <000010b17ddd988e-dmarc- 
> request@listserv.heanet.ie  request@listserv.heanet.ie>> a écrit :
> 
> 
>     Just a shout out to the manual team and François in special.
> 
>     I've written my first set of pages for new opcodes and the process
>     is so easy!
> 
>     So much better than the clunky docbook, md files are easily written
>     and, more
>     importantly, readable!
> 
>     The resulting pages look something else, much more stylish and
>     modern. The docbook styling was dire. This is fantastic.
> 
>     The syntax tabs are the icing on the cake! Great stuff.
> 
>     Well done and many thanks for this. Documentation writing is not
>     something to dread anymore.
> 
>     Prof. Victor Lazzarini
>     Maynooth University
>     Ireland
> 
>     Csound mailing list
>     Csound@listserv.heanet.ie 
>     https://listserv.heanet.ie/cgi-bin/wa?A0=CSOUND      listserv.heanet.ie/cgi-bin/wa?A0=CSOUND>
>     Send bugs reports to
>     https://github.com/csound/csound/issues      csound/issues>
>     Discussions of bugs and features can be posted here
> 
> Csound mailing list Csound@listserv.heanet.ie 
>  https://listserv.heanet.ie/cgi-bin/ 
> wa?A0=CSOUND  Send bugs 
> reports to https://github.com/csound/csound/issues  csound/csound/issues> Discussions of bugs and features can be posted here

Csound mailing list
Csound@listserv.heanet.ie
https://listserv.heanet.ie/cgi-bin/wa?A0=CSOUND
Send bugs reports to
        https://github.com/csound/csound/issues
Discussions of bugs and features can be posted here