Re: [Csnd-dev] Manual for Csound 7
Dave Seidel <[email protected]>
| Newsgroups | gmane.comp.audio.csound.devel |
|---|---|
| Message-ID | <CAMnrweAeeo1z3KqRz+848Pa=NVtVW4tYb+z3mfOm8frNmL-55w@mail.gmail.com> |
This looks great! On Tue, Feb 25, 2025 at 12:08 PM 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 > >