Csound Csound-dev Csound-tekno Search About

[Csnd-dev] new manual Csound Plugins

Date2024-06-17 10:35
FromMenno Knevel
Subject[Csnd-dev] new manual Csound Plugins
Hello,
i am in the process of copying 3rd party opcode manual pages to a new manual. 
This manual will be part of https://github.com/csound/plugins

Once the new 3rd party manual is ready, i will take these 3rd plugin opcode manual pages out of the Canonical Manual. 
There is an issue tracker entry https://github.com/csound/manual/issues/748
with a list of the manual pages concerning. Ableton, Bela, FLTK etc.

My aim is to synchronize this work with the release of Csound7.

It might be that this is not a good idea and there are better ideas out there. Please share them.

Date2024-06-17 11:10
FromRory Walsh
SubjectRe: [Csnd-dev] new manual Csound Plugins
Sounds like a good idea to me.

On Mon 17 Jun 2024, 10:35 Menno Knevel, <magknevel@gmail.com> wrote:
Hello,
i am in the process of copying 3rd party opcode manual pages to a new manual.
This manual will be part of https://github.com/csound/plugins

Once the new 3rd party manual is ready, i will take these 3rd plugin opcode manual pages out of the Canonical Manual.
There is an issue tracker entry https://github.com/csound/manual/issues/748
with a list of the manual pages concerning. Ableton, Bela, FLTK etc.

My aim is to synchronize this work with the release of Csound7.

It might be that this is not a good idea and there are better ideas out there. Please share them.

Date2024-06-17 11:31
FromEduardo Moguillansky
SubjectRe: [Csnd-dev] new manual Csound Plugins
I would personally advocate for steering away from docbook for a new manual. Even if you can withstand the pain of xml, the fact that it takes more than 20 times longer to compile the manual than to compile csound itself should be a sign that it might be a good idea to try something else. 

Plugins adapted to risset use a markdown file as a manual page. risset can aggregate all these pages to generate the docs using mkdocs.
See for example the docs for the hdf5 opcodes:


Here the generated result:





On Mon, Jun 17, 2024 at 12:10 PM Rory Walsh <rorywalsh@ear.ie> wrote:
Sounds like a good idea to me.

On Mon 17 Jun 2024, 10:35 Menno Knevel, <magknevel@gmail.com> wrote:
Hello,
i am in the process of copying 3rd party opcode manual pages to a new manual.
This manual will be part of https://github.com/csound/plugins

Once the new 3rd party manual is ready, i will take these 3rd plugin opcode manual pages out of the Canonical Manual.
There is an issue tracker entry https://github.com/csound/manual/issues/748
with a list of the manual pages concerning. Ableton, Bela, FLTK etc.

My aim is to synchronize this work with the release of Csound7.

It might be that this is not a good idea and there are better ideas out there. Please share them.