Csound Csound-dev Csound-tekno Search About

[Csnd] ICSC2019 Dev Table resolution

Date2019-09-29 20:54
FromGleb
Subject[Csnd] ICSC2019 Dev Table resolution
Hi everyone!

This is the draft of ICSC2019 Developer Round Table resolution. Feel free to
discuss it further and propose additions...

- We need someone to maintain the csound dot com
- It would be great to have an official Csound logo design
- We may try to organize 'Csound connection' or 'Csound weekends' in short
periods, i.e. one per month
- We can increase our social activity, incl. adding official Youtube channel
- The manual needs revision, as well as its build
- We should provide better instruction for the new developers
- Our website should have 'How can I help to develop' or 'What can you do to
Csound' page 
- Senior Csounders are very welcome to make a video (or two) for Youtube  
- We need more translations for manual, especially for the non-European
languages
- We need Csound 7 style vs Csound 6 style examples
- Would be nice to have Csound 7 early beta available   
- We need to try more community calls / small local meetings / remote group
coding sessions
- Could we organize Csound Summer School every even year (starting from
ICSchool Twenty-Twenty?)
- We need more nice examples for manual. 




-----
Gleb Rogozinsky, PhD
Associated Professor
Interactive Arts Department
Saint-Petersburg University of Film and Television

Deputy Director of Medialab
Saint-Petersburg University of Telecommunications
--
Sent from: http://csound.1045644.n5.nabble.com/Csound-General-f1093014.html

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

Date2019-09-30 10:28
FromVictor Lazzarini
SubjectRe: [Csnd] ICSC2019 Dev Table resolution
Good resolutions. A few comments from me.

1. We need a manual editor/maintainer. François has been kindly building the
releases, but I think we do not have anyone leading editorial decisions and 
organising the manual. All the things listed there need quite a bit of work and
the reason they have not been done is because no one is taking the editor’s
job. That should be a recognised position, and named at the top of the manual,
e.g.

Csound Reference Manual
Jane Doe, Editor

and a recognised publication, possibly with DOI etc. that we can cite.

Volunteers?

2. Likewise, the maintainer of the website should be a recognised position,
such as above (Csound Community Page, Joe Bloggs, Editor).

3. Summer Schools are great. Let’s talk about that. Small local meetings are 
even better.

 4. Demonstrating Csound 7 vs Csound 6 syntax is fine, but we need to first
finish defining what that new syntax is. And we need to move to work on Csound 7.

5. Following from 4. we have to make a decision on a Csound 6 feature freeze,
and put it on maintenance mode as we did with 5.x at the end. That decision
needs be taken soon.

========================
Prof. Victor Lazzarini
Maynooth University
Ireland

> On 29 Sep 2019, at 20:54, Gleb  wrote:
> 
> Hi everyone!
> 
> This is the draft of ICSC2019 Developer Round Table resolution. Feel free to
> discuss it further and propose additions...
> 
> - We need someone to maintain the csound dot com
> - It would be great to have an official Csound logo design
> - We may try to organize 'Csound connection' or 'Csound weekends' in short
> periods, i.e. one per month
> - We can increase our social activity, incl. adding official Youtube channel
> - The manual needs revision, as well as its build
> - We should provide better instruction for the new developers
> - Our website should have 'How can I help to develop' or 'What can you do to
> Csound' page 
> - Senior Csounders are very welcome to make a video (or two) for Youtube  
> - We need more translations for manual, especially for the non-European
> languages
> - We need Csound 7 style vs Csound 6 style examples
> - Would be nice to have Csound 7 early beta available   
> - We need to try more community calls / small local meetings / remote group
> coding sessions
> - Could we organize Csound Summer School every even year (starting from
> ICSchool Twenty-Twenty?)
> - We need more nice examples for manual. 
> 
> 
> 
> 
> -----
> Gleb Rogozinsky, PhD
> Associated Professor
> Interactive Arts Department
> Saint-Petersburg University of Film and Television
> 
> Deputy Director of Medialab
> Saint-Petersburg University of Telecommunications
> --
> Sent from: http://csound.1045644.n5.nabble.com/Csound-General-f1093014.html
> 
> 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

Date2019-09-30 11:17
FromEduardo Moguillansky
SubjectRe: [Csnd] ICSC2019 Dev Table resolution
On 30.09.19 11:28, Victor Lazzarini wrote:
> Good resolutions. A few comments from me.
>
> 1. We need a manual editor/maintainer. François has been kindly building the
> releases, but I think we do not have anyone leading editorial decisions and
> organising the manual. All the things listed there need quite a bit of work and
> the reason they have not been done is because no one is taking the editor’s
> job. That should be a recognised position, and named at the top of the manual,
> e.g.
>
> Csound Reference Manual
> Jane Doe, Editor
>
> and a recognised publication, possibly with DOI etc. that we can cite.

Would it be thinkable to convert the manual to a different format? 
docbook takes really too long to build and there does not seem to be any 
way to parallelize it. There is also a lot of manual indexing involved 
that could be automated (adding an opcode to a specific category, adding 
it to the global list of opcodes, etc)

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

Date2019-09-30 13:54
FromHlöðver Sigurðsson
SubjectRe: [Csnd] ICSC2019 Dev Table resolution
I discussed it with some people, that it makes sense to go for another format than docbook. Could be json, yaml or even python dictionary. From a more programmating format its easy to render various formats. As well, for front ends to generate syntax highlighting and minidocs. XML is becoming too arcane imo.

On Mon, 30 Sep 2019 at 12:17, Eduardo Moguillansky <eduardo.moguillansky@gmail.com> wrote:
On 30.09.19 11:28, Victor Lazzarini wrote:
> Good resolutions. A few comments from me.
>
> 1. We need a manual editor/maintainer. François has been kindly building the
> releases, but I think we do not have anyone leading editorial decisions and
> organising the manual. All the things listed there need quite a bit of work and
> the reason they have not been done is because no one is taking the editor’s
> job. That should be a recognised position, and named at the top of the manual,
> e.g.
>
> Csound Reference Manual
> Jane Doe, Editor
>
> and a recognised publication, possibly with DOI etc. that we can cite.

Would it be thinkable to convert the manual to a different format?
docbook takes really too long to build and there does not seem to be any
way to parallelize it. There is also a lot of manual indexing involved
that could be automated (adding an opcode to a specific category, adding
it to the global list of opcodes, etc)

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

Date2019-09-30 14:31
FromVictor Lazzarini
SubjectRe: [Csnd] ICSC2019 Dev Table resolution
I think it could be time to move on, but it looks like a big job to move to a different format. I think two
things are essential:

1. easy to edit and to add reference pages
2. easy to render to all formats we need (plus others as a bonus)

I think leading this change is probably a job for whoever takes on as editor.
========================
Prof. Victor Lazzarini
Maynooth University
Ireland

> On 30 Sep 2019, at 13:54, Hlöðver Sigurðsson  wrote:
> 
> I discussed it with some people, that it makes sense to go for another format than docbook. Could be json, yaml or even python dictionary. From a more programmating format its easy to render various formats. As well, for front ends to generate syntax highlighting and minidocs. XML is becoming too arcane imo.
> 
> On Mon, 30 Sep 2019 at 12:17, Eduardo Moguillansky  wrote:
> On 30.09.19 11:28, Victor Lazzarini wrote:
> > Good resolutions. A few comments from me.
> >
> > 1. We need a manual editor/maintainer. François has been kindly building the
> > releases, but I think we do not have anyone leading editorial decisions and
> > organising the manual. All the things listed there need quite a bit of work and
> > the reason they have not been done is because no one is taking the editor’s
> > job. That should be a recognised position, and named at the top of the manual,
> > e.g.
> >
> > Csound Reference Manual
> > Jane Doe, Editor
> >
> > and a recognised publication, possibly with DOI etc. that we can cite.
> 
> Would it be thinkable to convert the manual to a different format? 
> docbook takes really too long to build and there does not seem to be any 
> way to parallelize it. There is also a lot of manual indexing involved 
> that could be automated (adding an opcode to a specific category, adding 
> it to the global list of opcodes, etc)
> 
> 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


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

Date2019-09-30 14:57
FromHlöðver Sigurðsson
SubjectRe: [Csnd] ICSC2019 Dev Table resolution
I already wrote a hacky xquery parser for the manual. I recently exported the manual into react components for the web-ide, I should be able to spit out any format with this xquery. I'll research what format could suite best.

On Mon, 30 Sep 2019 at 15:31, Victor Lazzarini <Victor.Lazzarini@mu.ie> wrote:
I think it could be time to move on, but it looks like a big job to move to a different format. I think two
things are essential:

1. easy to edit and to add reference pages
2. easy to render to all formats we need (plus others as a bonus)

I think leading this change is probably a job for whoever takes on as editor.
========================
Prof. Victor Lazzarini
Maynooth University
Ireland

> On 30 Sep 2019, at 13:54, Hlöðver Sigurðsson <hlolli@gmail.com> wrote:
>
> I discussed it with some people, that it makes sense to go for another format than docbook. Could be json, yaml or even python dictionary. From a more programmating format its easy to render various formats. As well, for front ends to generate syntax highlighting and minidocs. XML is becoming too arcane imo.
>
> On Mon, 30 Sep 2019 at 12:17, Eduardo Moguillansky <eduardo.moguillansky@gmail.com> wrote:
> On 30.09.19 11:28, Victor Lazzarini wrote:
> > Good resolutions. A few comments from me.
> >
> > 1. We need a manual editor/maintainer. François has been kindly building the
> > releases, but I think we do not have anyone leading editorial decisions and
> > organising the manual. All the things listed there need quite a bit of work and
> > the reason they have not been done is because no one is taking the editor’s
> > job. That should be a recognised position, and named at the top of the manual,
> > e.g.
> >
> > Csound Reference Manual
> > Jane Doe, Editor
> >
> > and a recognised publication, possibly with DOI etc. that we can cite.
>
> Would it be thinkable to convert the manual to a different format?
> docbook takes really too long to build and there does not seem to be any
> way to parallelize it. There is also a lot of manual indexing involved
> that could be automated (adding an opcode to a specific category, adding
> it to the global list of opcodes, etc)
>
> 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


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

Date2019-09-30 15:13
FromVictor Lazzarini
SubjectRe: [Csnd] ICSC2019 Dev Table resolution
That’s a great solution, thanks for that.
========================
Prof. Victor Lazzarini
Maynooth University
Ireland

> On 30 Sep 2019, at 14:57, Hlöðver Sigurðsson  wrote:
> 
> I already wrote a hacky xquery parser for the manual. I recently exported the manual into react components for the web-ide, I should be able to spit out any format with this xquery. I'll research what format could suite best.
> 
> On Mon, 30 Sep 2019 at 15:31, Victor Lazzarini  wrote:
> I think it could be time to move on, but it looks like a big job to move to a different format. I think two
> things are essential:
> 
> 1. easy to edit and to add reference pages
> 2. easy to render to all formats we need (plus others as a bonus)
> 
> I think leading this change is probably a job for whoever takes on as editor.
> ========================
> Prof. Victor Lazzarini
> Maynooth University
> Ireland
> 
> > On 30 Sep 2019, at 13:54, Hlöðver Sigurðsson  wrote:
> > 
> > I discussed it with some people, that it makes sense to go for another format than docbook. Could be json, yaml or even python dictionary. From a more programmating format its easy to render various formats. As well, for front ends to generate syntax highlighting and minidocs. XML is becoming too arcane imo.
> > 
> > On Mon, 30 Sep 2019 at 12:17, Eduardo Moguillansky  wrote:
> > On 30.09.19 11:28, Victor Lazzarini wrote:
> > > Good resolutions. A few comments from me.
> > >
> > > 1. We need a manual editor/maintainer. François has been kindly building the
> > > releases, but I think we do not have anyone leading editorial decisions and
> > > organising the manual. All the things listed there need quite a bit of work and
> > > the reason they have not been done is because no one is taking the editor’s
> > > job. That should be a recognised position, and named at the top of the manual,
> > > e.g.
> > >
> > > Csound Reference Manual
> > > Jane Doe, Editor
> > >
> > > and a recognised publication, possibly with DOI etc. that we can cite.
> > 
> > Would it be thinkable to convert the manual to a different format? 
> > docbook takes really too long to build and there does not seem to be any 
> > way to parallelize it. There is also a lot of manual indexing involved 
> > that could be automated (adding an opcode to a specific category, adding 
> > it to the global list of opcodes, etc)
> > 
> > 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
> 
> 
> 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


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

Date2019-09-30 15:37
FromSteven Yi
SubjectRe: [Csnd] ICSC2019 Dev Table resolution
Also an important issue is that a number of tools are built around the
documentation. I know Blue uses a python script to read the
documentation as XML and generate information it uses for syntax
highlighting and presenting of opcode information to the user.  Also,
I depend upon the HTML output organization with opcode entries going
to files with [opcodename].html.  I think CsoundQt and Cabbage may be
in the same boat, perhaps others.

This is to say that the documentation is not just a format for output
to the print/screen manual, but also a data source too.  I'm all for
transitioning the documentation to a new format as long as we also
keep the data aspect in mind.

On Mon, Sep 30, 2019 at 9:31 AM Victor Lazzarini  wrote:
>
> I think it could be time to move on, but it looks like a big job to move to a different format. I think two
> things are essential:
>
> 1. easy to edit and to add reference pages
> 2. easy to render to all formats we need (plus others as a bonus)
>
> I think leading this change is probably a job for whoever takes on as editor.
> ========================
> Prof. Victor Lazzarini
> Maynooth University
> Ireland
>
> > On 30 Sep 2019, at 13:54, Hlöðver Sigurðsson  wrote:
> >
> > I discussed it with some people, that it makes sense to go for another format than docbook. Could be json, yaml or even python dictionary. From a more programmating format its easy to render various formats. As well, for front ends to generate syntax highlighting and minidocs. XML is becoming too arcane imo.
> >
> > On Mon, 30 Sep 2019 at 12:17, Eduardo Moguillansky  wrote:
> > On 30.09.19 11:28, Victor Lazzarini wrote:
> > > Good resolutions. A few comments from me.
> > >
> > > 1. We need a manual editor/maintainer. François has been kindly building the
> > > releases, but I think we do not have anyone leading editorial decisions and
> > > organising the manual. All the things listed there need quite a bit of work and
> > > the reason they have not been done is because no one is taking the editor’s
> > > job. That should be a recognised position, and named at the top of the manual,
> > > e.g.
> > >
> > > Csound Reference Manual
> > > Jane Doe, Editor
> > >
> > > and a recognised publication, possibly with DOI etc. that we can cite.
> >
> > Would it be thinkable to convert the manual to a different format?
> > docbook takes really too long to build and there does not seem to be any
> > way to parallelize it. There is also a lot of manual indexing involved
> > that could be automated (adding an opcode to a specific category, adding
> > it to the global list of opcodes, etc)
> >
> > 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
>
>
> 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

Date2019-09-30 16:13
FromHlöðver Sigurðsson
SubjectRe: [Csnd] ICSC2019 Dev Table resolution
that's true, I would not want to abandon static html output at all. I think all the frontends would benefit from a modern queryable programmatic format.

Thanks for pointing that out.

A source of inspiration is what the clojure community has been doing with their documentation, 2 frontends at least are using https://clojuredocs-edn.netlify.com/ endpoint for syntax highlighting. And as an alternative a new community driven documentation site https://cljdoc.org/ which is just amazing!

On Mon, 30 Sep 2019 at 16:37, Steven Yi <stevenyi@gmail.com> wrote:
Also an important issue is that a number of tools are built around the
documentation. I know Blue uses a python script to read the
documentation as XML and generate information it uses for syntax
highlighting and presenting of opcode information to the user.  Also,
I depend upon the HTML output organization with opcode entries going
to files with [opcodename].html.  I think CsoundQt and Cabbage may be
in the same boat, perhaps others.

This is to say that the documentation is not just a format for output
to the print/screen manual, but also a data source too.  I'm all for
transitioning the documentation to a new format as long as we also
keep the data aspect in mind.

On Mon, Sep 30, 2019 at 9:31 AM Victor Lazzarini <Victor.Lazzarini@mu.ie> wrote:
>
> I think it could be time to move on, but it looks like a big job to move to a different format. I think two
> things are essential:
>
> 1. easy to edit and to add reference pages
> 2. easy to render to all formats we need (plus others as a bonus)
>
> I think leading this change is probably a job for whoever takes on as editor.
> ========================
> Prof. Victor Lazzarini
> Maynooth University
> Ireland
>
> > On 30 Sep 2019, at 13:54, Hlöðver Sigurðsson <hlolli@gmail.com> wrote:
> >
> > I discussed it with some people, that it makes sense to go for another format than docbook. Could be json, yaml or even python dictionary. From a more programmating format its easy to render various formats. As well, for front ends to generate syntax highlighting and minidocs. XML is becoming too arcane imo.
> >
> > On Mon, 30 Sep 2019 at 12:17, Eduardo Moguillansky <eduardo.moguillansky@gmail.com> wrote:
> > On 30.09.19 11:28, Victor Lazzarini wrote:
> > > Good resolutions. A few comments from me.
> > >
> > > 1. We need a manual editor/maintainer. François has been kindly building the
> > > releases, but I think we do not have anyone leading editorial decisions and
> > > organising the manual. All the things listed there need quite a bit of work and
> > > the reason they have not been done is because no one is taking the editor’s
> > > job. That should be a recognised position, and named at the top of the manual,
> > > e.g.
> > >
> > > Csound Reference Manual
> > > Jane Doe, Editor
> > >
> > > and a recognised publication, possibly with DOI etc. that we can cite.
> >
> > Would it be thinkable to convert the manual to a different format?
> > docbook takes really too long to build and there does not seem to be any
> > way to parallelize it. There is also a lot of manual indexing involved
> > that could be automated (adding an opcode to a specific category, adding
> > it to the global list of opcodes, etc)
> >
> > 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
>
>
> 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
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

Date2019-09-30 16:43
FromVictor Lazzarini
SubjectRe: [Csnd] ICSC2019 Dev Table resolution
Another point is to look for formats/toolchains that are standard and widely used. 

The mistake would be to have a dependency that suddenly is not maintained anymore.

Prof. Victor Lazzarini
Maynooth University
Ireland

On 30 Sep 2019, at 16:13, Hlöðver Sigurðsson <hlolli@gmail.com> wrote:

that's true, I would not want to abandon static html output at all. I think all the frontends would benefit from a modern queryable programmatic format.

Thanks for pointing that out.

A source of inspiration is what the clojure community has been doing with their documentation, 2 frontends at least are using https://clojuredocs-edn.netlify.com/ endpoint for syntax highlighting. And as an alternative a new community driven documentation site https://cljdoc.org/ which is just amazing!

On Mon, 30 Sep 2019 at 16:37, Steven Yi <stevenyi@gmail.com> wrote:
Also an important issue is that a number of tools are built around the
documentation. I know Blue uses a python script to read the
documentation as XML and generate information it uses for syntax
highlighting and presenting of opcode information to the user.  Also,
I depend upon the HTML output organization with opcode entries going
to files with [opcodename].html.  I think CsoundQt and Cabbage may be
in the same boat, perhaps others.

This is to say that the documentation is not just a format for output
to the print/screen manual, but also a data source too.  I'm all for
transitioning the documentation to a new format as long as we also
keep the data aspect in mind.

On Mon, Sep 30, 2019 at 9:31 AM Victor Lazzarini <Victor.Lazzarini@mu.ie> wrote:
>
> I think it could be time to move on, but it looks like a big job to move to a different format. I think two
> things are essential:
>
> 1. easy to edit and to add reference pages
> 2. easy to render to all formats we need (plus others as a bonus)
>
> I think leading this change is probably a job for whoever takes on as editor.
> ========================
> Prof. Victor Lazzarini
> Maynooth University
> Ireland
>
> > On 30 Sep 2019, at 13:54, Hlöðver Sigurðsson <hlolli@gmail.com> wrote:
> >
> > I discussed it with some people, that it makes sense to go for another format than docbook. Could be json, yaml or even python dictionary. From a more programmating format its easy to render various formats. As well, for front ends to generate syntax highlighting and minidocs. XML is becoming too arcane imo.
> >
> > On Mon, 30 Sep 2019 at 12:17, Eduardo Moguillansky <eduardo.moguillansky@gmail.com> wrote:
> > On 30.09.19 11:28, Victor Lazzarini wrote:
> > > Good resolutions. A few comments from me.
> > >
> > > 1. We need a manual editor/maintainer. François has been kindly building the
> > > releases, but I think we do not have anyone leading editorial decisions and
> > > organising the manual. All the things listed there need quite a bit of work and
> > > the reason they have not been done is because no one is taking the editor’s
> > > job. That should be a recognised position, and named at the top of the manual,
> > > e.g.
> > >
> > > Csound Reference Manual
> > > Jane Doe, Editor
> > >
> > > and a recognised publication, possibly with DOI etc. that we can cite.
> >
> > Would it be thinkable to convert the manual to a different format?
> > docbook takes really too long to build and there does not seem to be any
> > way to parallelize it. There is also a lot of manual indexing involved
> > that could be automated (adding an opcode to a specific category, adding
> > it to the global list of opcodes, etc)
> >
> > 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
>
>
> 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
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

Date2019-10-01 09:39
FromVictor Lazzarini
Subject[Csnd] Manual reorganisation (was Re: [Csnd] ICSC2019 Dev Table resolution)
All those things are important to take in consideration.

From a manual page writing perspective, which is the most contact I had with the manual, the
most problematic thing is markup verbosity and the strict syntax of the tags. Otherwise, I’d
be happy to continue as it is, any other inconvenience is minor.

What would I like to see, from the perspective of a manual page writer:

1. Plain text format, editable anywhere
2. Low level of formatting annotation
3. Easy placement of examples (all in one, no need to produce separate CSDs)
4. Readability
5. No need to edit main manual to insert pages.

As an example, this is the type of workflow I see would be very handy

1. Open editor of choice.
2. Type the manual page using markdown-like annotations.
3. Add example directly to text.
4. Save it to relevant source folder.
5. Compile the manual.

========================
Prof. Victor Lazzarini
Maynooth University
Ireland

> On 30 Sep 2019, at 15:37, Steven Yi  wrote:
> 
> Also an important issue is that a number of tools are built around the
> documentation. I know Blue uses a python script to read the
> documentation as XML and generate information it uses for syntax
> highlighting and presenting of opcode information to the user.  Also,
> I depend upon the HTML output organization with opcode entries going
> to files with [opcodename].html.  I think CsoundQt and Cabbage may be
> in the same boat, perhaps others.
> 
> This is to say that the documentation is not just a format for output
> to the print/screen manual, but also a data source too.  I'm all for
> transitioning the documentation to a new format as long as we also
> keep the data aspect in mind.
> 
> On Mon, Sep 30, 2019 at 9:31 AM Victor Lazzarini  wrote:
>> 
>> I think it could be time to move on, but it looks like a big job to move to a different format. I think two
>> things are essential:
>> 
>> 1. easy to edit and to add reference pages
>> 2. easy to render to all formats we need (plus others as a bonus)
>> 
>> I think leading this change is probably a job for whoever takes on as editor.
>> ========================
>> Prof. Victor Lazzarini
>> Maynooth University
>> Ireland
>> 
>>> On 30 Sep 2019, at 13:54, Hlöðver Sigurðsson  wrote:
>>> 
>>> I discussed it with some people, that it makes sense to go for another format than docbook. Could be json, yaml or even python dictionary. From a more programmating format its easy to render various formats. As well, for front ends to generate syntax highlighting and minidocs. XML is becoming too arcane imo.
>>> 
>>> On Mon, 30 Sep 2019 at 12:17, Eduardo Moguillansky  wrote:
>>> On 30.09.19 11:28, Victor Lazzarini wrote:
>>>> Good resolutions. A few comments from me.
>>>> 
>>>> 1. We need a manual editor/maintainer. François has been kindly building the
>>>> releases, but I think we do not have anyone leading editorial decisions and
>>>> organising the manual. All the things listed there need quite a bit of work and
>>>> the reason they have not been done is because no one is taking the editor’s
>>>> job. That should be a recognised position, and named at the top of the manual,
>>>> e.g.
>>>> 
>>>> Csound Reference Manual
>>>> Jane Doe, Editor
>>>> 
>>>> and a recognised publication, possibly with DOI etc. that we can cite.
>>> 
>>> Would it be thinkable to convert the manual to a different format?
>>> docbook takes really too long to build and there does not seem to be any
>>> way to parallelize it. There is also a lot of manual indexing involved
>>> that could be automated (adding an opcode to a specific category, adding
>>> it to the global list of opcodes, etc)
>>> 
>>> 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
>> 
>> 
>> 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


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

Date2019-10-01 10:01
FromEduardo Moguillansky
SubjectRe: [Csnd] Manual reorganisation (was Re: [Csnd] ICSC2019 Dev Table resolution)
I have had a very nice experience with the csound plugins documentation, 
written in mkdocs:

* source: https://github.com/csound-plugins/csound-plugins/tree/master/docs
* online version: https://csound-plugins.github.io/csound-plugins/

Features:

* Each page is written in markdown
* it has csound syntax highlighting
* examples can be placed inline
* as it is markdown it can be read as is
* the manual compiles in seconds to html
* other formats for export are supported (pdf)
* the markdown itself can be easily parsed by thirdparty tools to 
extract information
* the generated html can be used offline (either just opening index.html 
or mkdocs can act as server which enables search within the whole pages, 
as in the online version)

On the negative side, I am not sure if mkdocs will be around in 10 
years, but I am also not so optimistic about many other things still 
being around in 10 years...



On 01.10.19 10:39, Victor Lazzarini wrote:
> All those things are important to take in consideration.
>
>  From a manual page writing perspective, which is the most contact I had with the manual, the
> most problematic thing is markup verbosity and the strict syntax of the tags. Otherwise, I’d
> be happy to continue as it is, any other inconvenience is minor.
>
> What would I like to see, from the perspective of a manual page writer:
>
> 1. Plain text format, editable anywhere
> 2. Low level of formatting annotation
> 3. Easy placement of examples (all in one, no need to produce separate CSDs)
> 4. Readability
> 5. No need to edit main manual to insert pages.
>
> As an example, this is the type of workflow I see would be very handy
>
> 1. Open editor of choice.
> 2. Type the manual page using markdown-like annotations.
> 3. Add example directly to text.
> 4. Save it to relevant source folder.
> 5. Compile the manual.
>
> ========================
> Prof. Victor Lazzarini
> Maynooth University
> Ireland
>
>> On 30 Sep 2019, at 15:37, Steven Yi  wrote:
>>
>> Also an important issue is that a number of tools are built around the
>> documentation. I know Blue uses a python script to read the
>> documentation as XML and generate information it uses for syntax
>> highlighting and presenting of opcode information to the user.  Also,
>> I depend upon the HTML output organization with opcode entries going
>> to files with [opcodename].html.  I think CsoundQt and Cabbage may be
>> in the same boat, perhaps others.
>>
>> This is to say that the documentation is not just a format for output
>> to the print/screen manual, but also a data source too.  I'm all for
>> transitioning the documentation to a new format as long as we also
>> keep the data aspect in mind.
>>
>> On Mon, Sep 30, 2019 at 9:31 AM Victor Lazzarini  wrote:
>>> I think it could be time to move on, but it looks like a big job to move to a different format. I think two
>>> things are essential:
>>>
>>> 1. easy to edit and to add reference pages
>>> 2. easy to render to all formats we need (plus others as a bonus)
>>>
>>> I think leading this change is probably a job for whoever takes on as editor.
>>> ========================
>>> Prof. Victor Lazzarini
>>> Maynooth University
>>> Ireland
>>>
>>>> On 30 Sep 2019, at 13:54, Hlöðver Sigurðsson  wrote:
>>>>
>>>> I discussed it with some people, that it makes sense to go for another format than docbook. Could be json, yaml or even python dictionary. From a more programmating format its easy to render various formats. As well, for front ends to generate syntax highlighting and minidocs. XML is becoming too arcane imo.
>>>>
>>>> On Mon, 30 Sep 2019 at 12:17, Eduardo Moguillansky  wrote:
>>>> On 30.09.19 11:28, Victor Lazzarini wrote:
>>>>> Good resolutions. A few comments from me.
>>>>>
>>>>> 1. We need a manual editor/maintainer. François has been kindly building the
>>>>> releases, but I think we do not have anyone leading editorial decisions and
>>>>> organising the manual. All the things listed there need quite a bit of work and
>>>>> the reason they have not been done is because no one is taking the editor’s
>>>>> job. That should be a recognised position, and named at the top of the manual,
>>>>> e.g.
>>>>>
>>>>> Csound Reference Manual
>>>>> Jane Doe, Editor
>>>>>
>>>>> and a recognised publication, possibly with DOI etc. that we can cite.
>>>> Would it be thinkable to convert the manual to a different format?
>>>> docbook takes really too long to build and there does not seem to be any
>>>> way to parallelize it. There is also a lot of manual indexing involved
>>>> that could be automated (adding an opcode to a specific category, adding
>>>> it to the global list of opcodes, etc)
>>>>
>>>> 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
>>>
>>> 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
>
> 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

Date2019-10-01 10:25
FromVictor Lazzarini
SubjectRe: [Csnd] Manual reorganisation (was Re: [Csnd] ICSC2019 Dev Table resolution)
Thanks, that’s another one to try. I have the impression we have the manual in docbook since early 2000s. Definitely
since Csound 5 (2003), so it has lasted for about 20 years.
========================
Prof. Victor Lazzarini
Maynooth University
Ireland

> On 1 Oct 2019, at 10:01, Eduardo Moguillansky  wrote:
> 
> I have had a very nice experience with the csound plugins documentation, written in mkdocs:
> 
> * source: https://github.com/csound-plugins/csound-plugins/tree/master/docs
> * online version: https://csound-plugins.github.io/csound-plugins/
> 
> Features:
> 
> * Each page is written in markdown
> * it has csound syntax highlighting
> * examples can be placed inline
> * as it is markdown it can be read as is
> * the manual compiles in seconds to html
> * other formats for export are supported (pdf)
> * the markdown itself can be easily parsed by thirdparty tools to extract information
> * the generated html can be used offline (either just opening index.html or mkdocs can act as server which enables search within the whole pages, as in the online version)
> 
> On the negative side, I am not sure if mkdocs will be around in 10 years, but I am also not so optimistic about many other things still being around in 10 years...
> 
> 
> 
> On 01.10.19 10:39, Victor Lazzarini wrote:
>> All those things are important to take in consideration.
>> 
>> From a manual page writing perspective, which is the most contact I had with the manual, the
>> most problematic thing is markup verbosity and the strict syntax of the tags. Otherwise, I’d
>> be happy to continue as it is, any other inconvenience is minor.
>> 
>> What would I like to see, from the perspective of a manual page writer:
>> 
>> 1. Plain text format, editable anywhere
>> 2. Low level of formatting annotation
>> 3. Easy placement of examples (all in one, no need to produce separate CSDs)
>> 4. Readability
>> 5. No need to edit main manual to insert pages.
>> 
>> As an example, this is the type of workflow I see would be very handy
>> 
>> 1. Open editor of choice.
>> 2. Type the manual page using markdown-like annotations.
>> 3. Add example directly to text.
>> 4. Save it to relevant source folder.
>> 5. Compile the manual.
>> 
>> ========================
>> Prof. Victor Lazzarini
>> Maynooth University
>> Ireland
>> 
>>> On 30 Sep 2019, at 15:37, Steven Yi  wrote:
>>> 
>>> Also an important issue is that a number of tools are built around the
>>> documentation. I know Blue uses a python script to read the
>>> documentation as XML and generate information it uses for syntax
>>> highlighting and presenting of opcode information to the user.  Also,
>>> I depend upon the HTML output organization with opcode entries going
>>> to files with [opcodename].html.  I think CsoundQt and Cabbage may be
>>> in the same boat, perhaps others.
>>> 
>>> This is to say that the documentation is not just a format for output
>>> to the print/screen manual, but also a data source too.  I'm all for
>>> transitioning the documentation to a new format as long as we also
>>> keep the data aspect in mind.
>>> 
>>> On Mon, Sep 30, 2019 at 9:31 AM Victor Lazzarini  wrote:
>>>> I think it could be time to move on, but it looks like a big job to move to a different format. I think two
>>>> things are essential:
>>>> 
>>>> 1. easy to edit and to add reference pages
>>>> 2. easy to render to all formats we need (plus others as a bonus)
>>>> 
>>>> I think leading this change is probably a job for whoever takes on as editor.
>>>> ========================
>>>> Prof. Victor Lazzarini
>>>> Maynooth University
>>>> Ireland
>>>> 
>>>>> On 30 Sep 2019, at 13:54, Hlöðver Sigurðsson  wrote:
>>>>> 
>>>>> I discussed it with some people, that it makes sense to go for another format than docbook. Could be json, yaml or even python dictionary. From a more programmating format its easy to render various formats. As well, for front ends to generate syntax highlighting and minidocs. XML is becoming too arcane imo.
>>>>> 
>>>>> On Mon, 30 Sep 2019 at 12:17, Eduardo Moguillansky  wrote:
>>>>> On 30.09.19 11:28, Victor Lazzarini wrote:
>>>>>> Good resolutions. A few comments from me.
>>>>>> 
>>>>>> 1. We need a manual editor/maintainer. François has been kindly building the
>>>>>> releases, but I think we do not have anyone leading editorial decisions and
>>>>>> organising the manual. All the things listed there need quite a bit of work and
>>>>>> the reason they have not been done is because no one is taking the editor’s
>>>>>> job. That should be a recognised position, and named at the top of the manual,
>>>>>> e.g.
>>>>>> 
>>>>>> Csound Reference Manual
>>>>>> Jane Doe, Editor
>>>>>> 
>>>>>> and a recognised publication, possibly with DOI etc. that we can cite.
>>>>> Would it be thinkable to convert the manual to a different format?
>>>>> docbook takes really too long to build and there does not seem to be any
>>>>> way to parallelize it. There is also a lot of manual indexing involved
>>>>> that could be automated (adding an opcode to a specific category, adding
>>>>> it to the global list of opcodes, etc)
>>>>> 
>>>>> 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
>>>> 
>>>> 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
>> 
>> 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


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

Date2019-10-01 14:15
FromForrest Curo
SubjectRe: [Csnd] Manual reorganisation (was Re: [Csnd] ICSC2019 Dev Table resolution)
For now, how does one submit proposed changes to the manual? [Docbook does not seem to be an editor-friendly format!]

On Tue, Oct 1, 2019 at 2:26 AM Victor Lazzarini <Victor.Lazzarini@mu.ie> wrote:
Thanks, that’s another one to try. I have the impression we have the manual in docbook since early 2000s. Definitely
since Csound 5 (2003), so it has lasted for about 20 years.
========================
Prof. Victor Lazzarini
Maynooth University
Ireland

> On 1 Oct 2019, at 10:01, Eduardo Moguillansky <eduardo.moguillansky@GMAIL.COM> wrote:
>
> I have had a very nice experience with the csound plugins documentation, written in mkdocs:
>
> * source: https://github.com/csound-plugins/csound-plugins/tree/master/docs
> * online version: https://csound-plugins.github.io/csound-plugins/
>
> Features:
>
> * Each page is written in markdown
> * it has csound syntax highlighting
> * examples can be placed inline
> * as it is markdown it can be read as is
> * the manual compiles in seconds to html
> * other formats for export are supported (pdf)
> * the markdown itself can be easily parsed by thirdparty tools to extract information
> * the generated html can be used offline (either just opening index.html or mkdocs can act as server which enables search within the whole pages, as in the online version)
>
> On the negative side, I am not sure if mkdocs will be around in 10 years, but I am also not so optimistic about many other things still being around in 10 years...
>
>
>
> On 01.10.19 10:39, Victor Lazzarini wrote:
>> All those things are important to take in consideration.
>>
>> From a manual page writing perspective, which is the most contact I had with the manual, the
>> most problematic thing is markup verbosity and the strict syntax of the tags. Otherwise, I’d
>> be happy to continue as it is, any other inconvenience is minor.
>>
>> What would I like to see, from the perspective of a manual page writer:
>>
>> 1. Plain text format, editable anywhere
>> 2. Low level of formatting annotation
>> 3. Easy placement of examples (all in one, no need to produce separate CSDs)
>> 4. Readability
>> 5. No need to edit main manual to insert pages.
>>
>> As an example, this is the type of workflow I see would be very handy
>>
>> 1. Open editor of choice.
>> 2. Type the manual page using markdown-like annotations.
>> 3. Add example directly to text.
>> 4. Save it to relevant source folder.
>> 5. Compile the manual.
>>
>> ========================
>> Prof. Victor Lazzarini
>> Maynooth University
>> Ireland
>>
>>> On 30 Sep 2019, at 15:37, Steven Yi <stevenyi@gmail.com> wrote:
>>>
>>> Also an important issue is that a number of tools are built around the
>>> documentation. I know Blue uses a python script to read the
>>> documentation as XML and generate information it uses for syntax
>>> highlighting and presenting of opcode information to the user.  Also,
>>> I depend upon the HTML output organization with opcode entries going
>>> to files with [opcodename].html.  I think CsoundQt and Cabbage may be
>>> in the same boat, perhaps others.
>>>
>>> This is to say that the documentation is not just a format for output
>>> to the print/screen manual, but also a data source too.  I'm all for
>>> transitioning the documentation to a new format as long as we also
>>> keep the data aspect in mind.
>>>
>>> On Mon, Sep 30, 2019 at 9:31 AM Victor Lazzarini <Victor.Lazzarini@mu.ie> wrote:
>>>> I think it could be time to move on, but it looks like a big job to move to a different format. I think two
>>>> things are essential:
>>>>
>>>> 1. easy to edit and to add reference pages
>>>> 2. easy to render to all formats we need (plus others as a bonus)
>>>>
>>>> I think leading this change is probably a job for whoever takes on as editor.
>>>> ========================
>>>> Prof. Victor Lazzarini
>>>> Maynooth University
>>>> Ireland
>>>>
>>>>> On 30 Sep 2019, at 13:54, Hlöðver Sigurðsson <hlolli@gmail.com> wrote:
>>>>>
>>>>> I discussed it with some people, that it makes sense to go for another format than docbook. Could be json, yaml or even python dictionary. From a more programmating format its easy to render various formats. As well, for front ends to generate syntax highlighting and minidocs. XML is becoming too arcane imo.
>>>>>
>>>>> On Mon, 30 Sep 2019 at 12:17, Eduardo Moguillansky <eduardo.moguillansky@gmail.com> wrote:
>>>>> On 30.09.19 11:28, Victor Lazzarini wrote:
>>>>>> Good resolutions. A few comments from me.
>>>>>>
>>>>>> 1. We need a manual editor/maintainer. François has been kindly building the
>>>>>> releases, but I think we do not have anyone leading editorial decisions and
>>>>>> organising the manual. All the things listed there need quite a bit of work and
>>>>>> the reason they have not been done is because no one is taking the editor’s
>>>>>> job. That should be a recognised position, and named at the top of the manual,
>>>>>> e.g.
>>>>>>
>>>>>> Csound Reference Manual
>>>>>> Jane Doe, Editor
>>>>>>
>>>>>> and a recognised publication, possibly with DOI etc. that we can cite.
>>>>> Would it be thinkable to convert the manual to a different format?
>>>>> docbook takes really too long to build and there does not seem to be any
>>>>> way to parallelize it. There is also a lot of manual indexing involved
>>>>> that could be automated (adding an opcode to a specific category, adding
>>>>> it to the global list of opcodes, etc)
>>>>>
>>>>> 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
>>>>
>>>> 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
>>
>> 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


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

Date2019-10-01 14:33
FromRory Walsh
SubjectRe: [Csnd] Manual reorganisation (was Re: [Csnd] ICSC2019 Dev Table resolution)
What I usually do is clone the manual repo, make some changes, or create a new xml file depending on what I'm doing, and finally, submit a PR. I rarely actually ever try to build locally as it is a pain. The PR will trigger a build, and if there are no problems it will be accepted and become part of the next release. 

On Tue, 1 Oct 2019 at 14:16, Forrest Curo <treegestalt@gmail.com> wrote:
For now, how does one submit proposed changes to the manual? [Docbook does not seem to be an editor-friendly format!]

On Tue, Oct 1, 2019 at 2:26 AM Victor Lazzarini <Victor.Lazzarini@mu.ie> wrote:
Thanks, that’s another one to try. I have the impression we have the manual in docbook since early 2000s. Definitely
since Csound 5 (2003), so it has lasted for about 20 years.
========================
Prof. Victor Lazzarini
Maynooth University
Ireland

> On 1 Oct 2019, at 10:01, Eduardo Moguillansky <eduardo.moguillansky@GMAIL.COM> wrote:
>
> I have had a very nice experience with the csound plugins documentation, written in mkdocs:
>
> * source: https://github.com/csound-plugins/csound-plugins/tree/master/docs
> * online version: https://csound-plugins.github.io/csound-plugins/
>
> Features:
>
> * Each page is written in markdown
> * it has csound syntax highlighting
> * examples can be placed inline
> * as it is markdown it can be read as is
> * the manual compiles in seconds to html
> * other formats for export are supported (pdf)
> * the markdown itself can be easily parsed by thirdparty tools to extract information
> * the generated html can be used offline (either just opening index.html or mkdocs can act as server which enables search within the whole pages, as in the online version)
>
> On the negative side, I am not sure if mkdocs will be around in 10 years, but I am also not so optimistic about many other things still being around in 10 years...
>
>
>
> On 01.10.19 10:39, Victor Lazzarini wrote:
>> All those things are important to take in consideration.
>>
>> From a manual page writing perspective, which is the most contact I had with the manual, the
>> most problematic thing is markup verbosity and the strict syntax of the tags. Otherwise, I’d
>> be happy to continue as it is, any other inconvenience is minor.
>>
>> What would I like to see, from the perspective of a manual page writer:
>>
>> 1. Plain text format, editable anywhere
>> 2. Low level of formatting annotation
>> 3. Easy placement of examples (all in one, no need to produce separate CSDs)
>> 4. Readability
>> 5. No need to edit main manual to insert pages.
>>
>> As an example, this is the type of workflow I see would be very handy
>>
>> 1. Open editor of choice.
>> 2. Type the manual page using markdown-like annotations.
>> 3. Add example directly to text.
>> 4. Save it to relevant source folder.
>> 5. Compile the manual.
>>
>> ========================
>> Prof. Victor Lazzarini
>> Maynooth University
>> Ireland
>>
>>> On 30 Sep 2019, at 15:37, Steven Yi <stevenyi@gmail.com> wrote:
>>>
>>> Also an important issue is that a number of tools are built around the
>>> documentation. I know Blue uses a python script to read the
>>> documentation as XML and generate information it uses for syntax
>>> highlighting and presenting of opcode information to the user.  Also,
>>> I depend upon the HTML output organization with opcode entries going
>>> to files with [opcodename].html.  I think CsoundQt and Cabbage may be
>>> in the same boat, perhaps others.
>>>
>>> This is to say that the documentation is not just a format for output
>>> to the print/screen manual, but also a data source too.  I'm all for
>>> transitioning the documentation to a new format as long as we also
>>> keep the data aspect in mind.
>>>
>>> On Mon, Sep 30, 2019 at 9:31 AM Victor Lazzarini <Victor.Lazzarini@mu.ie> wrote:
>>>> I think it could be time to move on, but it looks like a big job to move to a different format. I think two
>>>> things are essential:
>>>>
>>>> 1. easy to edit and to add reference pages
>>>> 2. easy to render to all formats we need (plus others as a bonus)
>>>>
>>>> I think leading this change is probably a job for whoever takes on as editor.
>>>> ========================
>>>> Prof. Victor Lazzarini
>>>> Maynooth University
>>>> Ireland
>>>>
>>>>> On 30 Sep 2019, at 13:54, Hlöðver Sigurðsson <hlolli@gmail.com> wrote:
>>>>>
>>>>> I discussed it with some people, that it makes sense to go for another format than docbook. Could be json, yaml or even python dictionary. From a more programmating format its easy to render various formats. As well, for front ends to generate syntax highlighting and minidocs. XML is becoming too arcane imo.
>>>>>
>>>>> On Mon, 30 Sep 2019 at 12:17, Eduardo Moguillansky <eduardo.moguillansky@gmail.com> wrote:
>>>>> On 30.09.19 11:28, Victor Lazzarini wrote:
>>>>>> Good resolutions. A few comments from me.
>>>>>>
>>>>>> 1. We need a manual editor/maintainer. François has been kindly building the
>>>>>> releases, but I think we do not have anyone leading editorial decisions and
>>>>>> organising the manual. All the things listed there need quite a bit of work and
>>>>>> the reason they have not been done is because no one is taking the editor’s
>>>>>> job. That should be a recognised position, and named at the top of the manual,
>>>>>> e.g.
>>>>>>
>>>>>> Csound Reference Manual
>>>>>> Jane Doe, Editor
>>>>>>
>>>>>> and a recognised publication, possibly with DOI etc. that we can cite.
>>>>> Would it be thinkable to convert the manual to a different format?
>>>>> docbook takes really too long to build and there does not seem to be any
>>>>> way to parallelize it. There is also a lot of manual indexing involved
>>>>> that could be automated (adding an opcode to a specific category, adding
>>>>> it to the global list of opcodes, etc)
>>>>>
>>>>> 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
>>>>
>>>> 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
>>
>> 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


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
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

Date2019-10-01 16:30
FromJohn ff
SubjectRe: [Csnd] Manual reorganisation (was Re: [Csnd] ICSC2019 Dev Table resolution)
Rory's way s the rest but if the change is smaller isolated sending me a repaeet for or stuff or patch would probably work.

==John

⁣Sent from TypeApp ​

On Oct 1, 2019, 14:34, at 14:34, Rory Walsh  wrote:
>What I usually do is clone the manual repo, make some changes, or
>create a
>new xml file depending on what I'm doing, and finally, submit a PR. I
>rarely actually ever try to build locally as it is a pain. The PR will
>trigger a build, and if there are no problems it will be accepted and
>become part of the next release.
>
>On Tue, 1 Oct 2019 at 14:16, Forrest Curo 
>wrote:
>
>> For now, how does one submit proposed changes to the manual? [Docbook
>does
>> not seem to be an editor-friendly format!]
>>
>> On Tue, Oct 1, 2019 at 2:26 AM Victor Lazzarini
>
>> wrote:
>>
>>> Thanks, that’s another one to try. I have the impression we have the
>>> manual in docbook since early 2000s. Definitely
>>> since Csound 5 (2003), so it has lasted for about 20 years.
>>> ========================
>>> Prof. Victor Lazzarini
>>> Maynooth University
>>> Ireland
>>>
>>> > On 1 Oct 2019, at 10:01, Eduardo Moguillansky <
>>> eduardo.moguillansky@GMAIL.COM> wrote:
>>> >
>>> > I have had a very nice experience with the csound plugins
>>> documentation, written in mkdocs:
>>> >
>>> > * source:
>>> https://github.com/csound-plugins/csound-plugins/tree/master/docs
>>> > * online version: https://csound-plugins.github.io/csound-plugins/
>>> >
>>> > Features:
>>> >
>>> > * Each page is written in markdown
>>> > * it has csound syntax highlighting
>>> > * examples can be placed inline
>>> > * as it is markdown it can be read as is
>>> > * the manual compiles in seconds to html
>>> > * other formats for export are supported (pdf)
>>> > * the markdown itself can be easily parsed by thirdparty tools to
>>> extract information
>>> > * the generated html can be used offline (either just opening
>>> index.html or mkdocs can act as server which enables search within
>the
>>> whole pages, as in the online version)
>>> >
>>> > On the negative side, I am not sure if mkdocs will be around in 10
>>> years, but I am also not so optimistic about many other things still
>being
>>> around in 10 years...
>>> >
>>> >
>>> >
>>> > On 01.10.19 10:39, Victor Lazzarini wrote:
>>> >> All those things are important to take in consideration.
>>> >>
>>> >> From a manual page writing perspective, which is the most contact
>I
>>> had with the manual, the
>>> >> most problematic thing is markup verbosity and the strict syntax
>of
>>> the tags. Otherwise, I’d
>>> >> be happy to continue as it is, any other inconvenience is minor.
>>> >>
>>> >> What would I like to see, from the perspective of a manual page
>writer:
>>> >>
>>> >> 1. Plain text format, editable anywhere
>>> >> 2. Low level of formatting annotation
>>> >> 3. Easy placement of examples (all in one, no need to produce
>separate
>>> CSDs)
>>> >> 4. Readability
>>> >> 5. No need to edit main manual to insert pages.
>>> >>
>>> >> As an example, this is the type of workflow I see would be very
>handy
>>> >>
>>> >> 1. Open editor of choice.
>>> >> 2. Type the manual page using markdown-like annotations.
>>> >> 3. Add example directly to text.
>>> >> 4. Save it to relevant source folder.
>>> >> 5. Compile the manual.
>>> >>
>>> >> ========================
>>> >> Prof. Victor Lazzarini
>>> >> Maynooth University
>>> >> Ireland
>>> >>
>>> >>> On 30 Sep 2019, at 15:37, Steven Yi  wrote:
>>> >>>
>>> >>> Also an important issue is that a number of tools are built
>around the
>>> >>> documentation. I know Blue uses a python script to read the
>>> >>> documentation as XML and generate information it uses for syntax
>>> >>> highlighting and presenting of opcode information to the user. 
>Also,
>>> >>> I depend upon the HTML output organization with opcode entries
>going
>>> >>> to files with [opcodename].html.  I think CsoundQt and Cabbage
>may be
>>> >>> in the same boat, perhaps others.
>>> >>>
>>> >>> This is to say that the documentation is not just a format for
>output
>>> >>> to the print/screen manual, but also a data source too.  I'm all
>for
>>> >>> transitioning the documentation to a new format as long as we
>also
>>> >>> keep the data aspect in mind.
>>> >>>
>>> >>> On Mon, Sep 30, 2019 at 9:31 AM Victor Lazzarini <
>>> Victor.Lazzarini@mu.ie> wrote:
>>> >>>> I think it could be time to move on, but it looks like a big
>job to
>>> move to a different format. I think two
>>> >>>> things are essential:
>>> >>>>
>>> >>>> 1. easy to edit and to add reference pages
>>> >>>> 2. easy to render to all formats we need (plus others as a
>bonus)
>>> >>>>
>>> >>>> I think leading this change is probably a job for whoever takes
>on
>>> as editor.
>>> >>>> ========================
>>> >>>> Prof. Victor Lazzarini
>>> >>>> Maynooth University
>>> >>>> Ireland
>>> >>>>
>>> >>>>> On 30 Sep 2019, at 13:54, Hlöðver Sigurðsson
>
>>> wrote:
>>> >>>>>
>>> >>>>> I discussed it with some people, that it makes sense to go for
>>> another format than docbook. Could be json, yaml or even python
>dictionary.
>>> From a more programmating format its easy to render various formats.
>As
>>> well, for front ends to generate syntax highlighting and minidocs.
>XML is
>>> becoming too arcane imo.
>>> >>>>>
>>> >>>>> On Mon, 30 Sep 2019 at 12:17, Eduardo Moguillansky <
>>> eduardo.moguillansky@gmail.com> wrote:
>>> >>>>> On 30.09.19 11:28, Victor Lazzarini wrote:
>>> >>>>>> Good resolutions. A few comments from me.
>>> >>>>>>
>>> >>>>>> 1. We need a manual editor/maintainer. François has been
>kindly
>>> building the
>>> >>>>>> releases, but I think we do not have anyone leading editorial
>>> decisions and
>>> >>>>>> organising the manual. All the things listed there need quite
>a
>>> bit of work and
>>> >>>>>> the reason they have not been done is because no one is
>taking the
>>> editor’s
>>> >>>>>> job. That should be a recognised position, and named at the
>top of
>>> the manual,
>>> >>>>>> e.g.
>>> >>>>>>
>>> >>>>>> Csound Reference Manual
>>> >>>>>> Jane Doe, Editor
>>> >>>>>>
>>> >>>>>> and a recognised publication, possibly with DOI etc. that we
>can
>>> cite.
>>> >>>>> Would it be thinkable to convert the manual to a different
>format?
>>> >>>>> docbook takes really too long to build and there does not seem
>to
>>> be any
>>> >>>>> way to parallelize it. There is also a lot of manual indexing
>>> involved
>>> >>>>> that could be automated (adding an opcode to a specific
>category,
>>> adding
>>> >>>>> it to the global list of opcodes, etc)
>>> >>>>>
>>> >>>>> 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
>>> >>>>
>>> >>>> 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
>>> >>
>>> >> 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
>>>
>>>
>>> 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
>
>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

Date2019-10-01 16:34
FromRory Walsh
SubjectRe: [Csnd] Manual reorganisation (was Re: [Csnd] ICSC2019 Dev Table resolution)
For what it's worth @Forrest Curo, I don't even clone the repo locally. I simply make a fork, edit the files online and then make the PR all through the github website. Once it's accepted I delete my fork. 

On Tue, 1 Oct 2019 at 16:31, John ff <jpff@codemist.co.uk> wrote:
Rory's way s the rest but if the change is smaller isolated sending me a repaeet for or stuff or patch would probably work.

==John

⁣Sent from TypeApp ​

On Oct 1, 2019, 14:34, at 14:34, Rory Walsh <rorywalsh@ear.ie> wrote:
>What I usually do is clone the manual repo, make some changes, or
>create a
>new xml file depending on what I'm doing, and finally, submit a PR. I
>rarely actually ever try to build locally as it is a pain. The PR will
>trigger a build, and if there are no problems it will be accepted and
>become part of the next release.
>
>On Tue, 1 Oct 2019 at 14:16, Forrest Curo <treegestalt@gmail.com>
>wrote:
>
>> For now, how does one submit proposed changes to the manual? [Docbook
>does
>> not seem to be an editor-friendly format!]
>>
>> On Tue, Oct 1, 2019 at 2:26 AM Victor Lazzarini
><Victor.Lazzarini@mu.ie>
>> wrote:
>>
>>> Thanks, that’s another one to try. I have the impression we have the
>>> manual in docbook since early 2000s. Definitely
>>> since Csound 5 (2003), so it has lasted for about 20 years.
>>> ========================
>>> Prof. Victor Lazzarini
>>> Maynooth University
>>> Ireland
>>>
>>> > On 1 Oct 2019, at 10:01, Eduardo Moguillansky <
>>> eduardo.moguillansky@GMAIL.COM> wrote:
>>> >
>>> > I have had a very nice experience with the csound plugins
>>> documentation, written in mkdocs:
>>> >
>>> > * source:
>>> https://github.com/csound-plugins/csound-plugins/tree/master/docs
>>> > * online version: https://csound-plugins.github.io/csound-plugins/
>>> >
>>> > Features:
>>> >
>>> > * Each page is written in markdown
>>> > * it has csound syntax highlighting
>>> > * examples can be placed inline
>>> > * as it is markdown it can be read as is
>>> > * the manual compiles in seconds to html
>>> > * other formats for export are supported (pdf)
>>> > * the markdown itself can be easily parsed by thirdparty tools to
>>> extract information
>>> > * the generated html can be used offline (either just opening
>>> index.html or mkdocs can act as server which enables search within
>the
>>> whole pages, as in the online version)
>>> >
>>> > On the negative side, I am not sure if mkdocs will be around in 10
>>> years, but I am also not so optimistic about many other things still
>being
>>> around in 10 years...
>>> >
>>> >
>>> >
>>> > On 01.10.19 10:39, Victor Lazzarini wrote:
>>> >> All those things are important to take in consideration.
>>> >>
>>> >> From a manual page writing perspective, which is the most contact
>I
>>> had with the manual, the
>>> >> most problematic thing is markup verbosity and the strict syntax
>of
>>> the tags. Otherwise, I’d
>>> >> be happy to continue as it is, any other inconvenience is minor.
>>> >>
>>> >> What would I like to see, from the perspective of a manual page
>writer:
>>> >>
>>> >> 1. Plain text format, editable anywhere
>>> >> 2. Low level of formatting annotation
>>> >> 3. Easy placement of examples (all in one, no need to produce
>separate
>>> CSDs)
>>> >> 4. Readability
>>> >> 5. No need to edit main manual to insert pages.
>>> >>
>>> >> As an example, this is the type of workflow I see would be very
>handy
>>> >>
>>> >> 1. Open editor of choice.
>>> >> 2. Type the manual page using markdown-like annotations.
>>> >> 3. Add example directly to text.
>>> >> 4. Save it to relevant source folder.
>>> >> 5. Compile the manual.
>>> >>
>>> >> ========================
>>> >> Prof. Victor Lazzarini
>>> >> Maynooth University
>>> >> Ireland
>>> >>
>>> >>> On 30 Sep 2019, at 15:37, Steven Yi <stevenyi@gmail.com> wrote:
>>> >>>
>>> >>> Also an important issue is that a number of tools are built
>around the
>>> >>> documentation. I know Blue uses a python script to read the
>>> >>> documentation as XML and generate information it uses for syntax
>>> >>> highlighting and presenting of opcode information to the user.
>Also,
>>> >>> I depend upon the HTML output organization with opcode entries
>going
>>> >>> to files with [opcodename].html.  I think CsoundQt and Cabbage
>may be
>>> >>> in the same boat, perhaps others.
>>> >>>
>>> >>> This is to say that the documentation is not just a format for
>output
>>> >>> to the print/screen manual, but also a data source too.  I'm all
>for
>>> >>> transitioning the documentation to a new format as long as we
>also
>>> >>> keep the data aspect in mind.
>>> >>>
>>> >>> On Mon, Sep 30, 2019 at 9:31 AM Victor Lazzarini <
>>> Victor.Lazzarini@mu.ie> wrote:
>>> >>>> I think it could be time to move on, but it looks like a big
>job to
>>> move to a different format. I think two
>>> >>>> things are essential:
>>> >>>>
>>> >>>> 1. easy to edit and to add reference pages
>>> >>>> 2. easy to render to all formats we need (plus others as a
>bonus)
>>> >>>>
>>> >>>> I think leading this change is probably a job for whoever takes
>on
>>> as editor.
>>> >>>> ========================
>>> >>>> Prof. Victor Lazzarini
>>> >>>> Maynooth University
>>> >>>> Ireland
>>> >>>>
>>> >>>>> On 30 Sep 2019, at 13:54, Hlöðver Sigurðsson
><hlolli@gmail.com>
>>> wrote:
>>> >>>>>
>>> >>>>> I discussed it with some people, that it makes sense to go for
>>> another format than docbook. Could be json, yaml or even python
>dictionary.
>>> From a more programmating format its easy to render various formats.
>As
>>> well, for front ends to generate syntax highlighting and minidocs.
>XML is
>>> becoming too arcane imo.
>>> >>>>>
>>> >>>>> On Mon, 30 Sep 2019 at 12:17, Eduardo Moguillansky <
>>> eduardo.moguillansky@gmail.com> wrote:
>>> >>>>> On 30.09.19 11:28, Victor Lazzarini wrote:
>>> >>>>>> Good resolutions. A few comments from me.
>>> >>>>>>
>>> >>>>>> 1. We need a manual editor/maintainer. François has been
>kindly
>>> building the
>>> >>>>>> releases, but I think we do not have anyone leading editorial
>>> decisions and
>>> >>>>>> organising the manual. All the things listed there need quite
>a
>>> bit of work and
>>> >>>>>> the reason they have not been done is because no one is
>taking the
>>> editor’s
>>> >>>>>> job. That should be a recognised position, and named at the
>top of
>>> the manual,
>>> >>>>>> e.g.
>>> >>>>>>
>>> >>>>>> Csound Reference Manual
>>> >>>>>> Jane Doe, Editor
>>> >>>>>>
>>> >>>>>> and a recognised publication, possibly with DOI etc. that we
>can
>>> cite.
>>> >>>>> Would it be thinkable to convert the manual to a different
>format?
>>> >>>>> docbook takes really too long to build and there does not seem
>to
>>> be any
>>> >>>>> way to parallelize it. There is also a lot of manual indexing
>>> involved
>>> >>>>> that could be automated (adding an opcode to a specific
>category,
>>> adding
>>> >>>>> it to the global list of opcodes, etc)
>>> >>>>>
>>> >>>>> 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
>>> >>>>
>>> >>>> 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
>>> >>
>>> >> 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
>>>
>>>
>>> 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
>
>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
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

Date2019-10-01 19:10
FromOeyvind Brandtsegg
SubjectRe: [Csnd] Manual reorganisation (was Re: [Csnd] ICSC2019 Dev Table resolution)
This option seems attractive to me. Easier editing, and thus less effort in making quick fixes once one notice something odd in the manual. 

tir. 1. okt. 2019 kl. 11:26 skrev Victor Lazzarini <Victor.Lazzarini@mu.ie>:
Thanks, that’s another one to try. I have the impression we have the manual in docbook since early 2000s. Definitely
since Csound 5 (2003), so it has lasted for about 20 years.
========================
Prof. Victor Lazzarini
Maynooth University
Ireland

> On 1 Oct 2019, at 10:01, Eduardo Moguillansky <eduardo.moguillansky@GMAIL.COM> wrote:
>
> I have had a very nice experience with the csound plugins documentation, written in mkdocs:
>
> * source: https://github.com/csound-plugins/csound-plugins/tree/master/docs
> * online version: https://csound-plugins.github.io/csound-plugins/
>
> Features:
>
> * Each page is written in markdown
> * it has csound syntax highlighting
> * examples can be placed inline
> * as it is markdown it can be read as is
> * the manual compiles in seconds to html
> * other formats for export are supported (pdf)
> * the markdown itself can be easily parsed by thirdparty tools to extract information
> * the generated html can be used offline (either just opening index.html or mkdocs can act as server which enables search within the whole pages, as in the online version)
>
> On the negative side, I am not sure if mkdocs will be around in 10 years, but I am also not so optimistic about many other things still being around in 10 years...
>
>
>
> On 01.10.19 10:39, Victor Lazzarini wrote:
>> All those things are important to take in consideration.
>>
>> From a manual page writing perspective, which is the most contact I had with the manual, the
>> most problematic thing is markup verbosity and the strict syntax of the tags. Otherwise, I’d
>> be happy to continue as it is, any other inconvenience is minor.
>>
>> What would I like to see, from the perspective of a manual page writer:
>>
>> 1. Plain text format, editable anywhere
>> 2. Low level of formatting annotation
>> 3. Easy placement of examples (all in one, no need to produce separate CSDs)
>> 4. Readability
>> 5. No need to edit main manual to insert pages.
>>
>> As an example, this is the type of workflow I see would be very handy
>>
>> 1. Open editor of choice.
>> 2. Type the manual page using markdown-like annotations.
>> 3. Add example directly to text.
>> 4. Save it to relevant source folder.
>> 5. Compile the manual.
>>
>> ========================
>> Prof. Victor Lazzarini
>> Maynooth University
>> Ireland
>>
>>> On 30 Sep 2019, at 15:37, Steven Yi <stevenyi@gmail.com> wrote:
>>>
>>> Also an important issue is that a number of tools are built around the
>>> documentation. I know Blue uses a python script to read the
>>> documentation as XML and generate information it uses for syntax
>>> highlighting and presenting of opcode information to the user.  Also,
>>> I depend upon the HTML output organization with opcode entries going
>>> to files with [opcodename].html.  I think CsoundQt and Cabbage may be
>>> in the same boat, perhaps others.
>>>
>>> This is to say that the documentation is not just a format for output
>>> to the print/screen manual, but also a data source too.  I'm all for
>>> transitioning the documentation to a new format as long as we also
>>> keep the data aspect in mind.
>>>
>>> On Mon, Sep 30, 2019 at 9:31 AM Victor Lazzarini <Victor.Lazzarini@mu.ie> wrote:
>>>> I think it could be time to move on, but it looks like a big job to move to a different format. I think two
>>>> things are essential:
>>>>
>>>> 1. easy to edit and to add reference pages
>>>> 2. easy to render to all formats we need (plus others as a bonus)
>>>>
>>>> I think leading this change is probably a job for whoever takes on as editor.
>>>> ========================
>>>> Prof. Victor Lazzarini
>>>> Maynooth University
>>>> Ireland
>>>>
>>>>> On 30 Sep 2019, at 13:54, Hlöðver Sigurðsson <hlolli@gmail.com> wrote:
>>>>>
>>>>> I discussed it with some people, that it makes sense to go for another format than docbook. Could be json, yaml or even python dictionary. From a more programmating format its easy to render various formats. As well, for front ends to generate syntax highlighting and minidocs. XML is becoming too arcane imo.
>>>>>
>>>>> On Mon, 30 Sep 2019 at 12:17, Eduardo Moguillansky <eduardo.moguillansky@gmail.com> wrote:
>>>>> On 30.09.19 11:28, Victor Lazzarini wrote:
>>>>>> Good resolutions. A few comments from me.
>>>>>>
>>>>>> 1. We need a manual editor/maintainer. François has been kindly building the
>>>>>> releases, but I think we do not have anyone leading editorial decisions and
>>>>>> organising the manual. All the things listed there need quite a bit of work and
>>>>>> the reason they have not been done is because no one is taking the editor’s
>>>>>> job. That should be a recognised position, and named at the top of the manual,
>>>>>> e.g.
>>>>>>
>>>>>> Csound Reference Manual
>>>>>> Jane Doe, Editor
>>>>>>
>>>>>> and a recognised publication, possibly with DOI etc. that we can cite.
>>>>> Would it be thinkable to convert the manual to a different format?
>>>>> docbook takes really too long to build and there does not seem to be any
>>>>> way to parallelize it. There is also a lot of manual indexing involved
>>>>> that could be automated (adding an opcode to a specific category, adding
>>>>> it to the global list of opcodes, etc)
>>>>>
>>>>> 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
>>>>
>>>> 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
>>
>> 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


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

Date2019-10-03 10:42
FromMarijana Janevska
SubjectRe: [Csnd] ICSC2019 Dev Table resolution

Dear Csounders,

 

I would like to help in the revision of the manual and write more nice examples for it. And I think some of the other students of Joachim are going to be interested in doing this, so we’ll discuss this in our class, see who is interested and divide the job…

Making videos and tutorials for the Youtube channel is very important for the new Csounders. And if there is an official Youtube channel, I think it is important that the videos that are being made are outlined in more or less the same form. For example, if it is a video for “How to do FM in Csound”, then there is a brief description of what FM is and how to do it in Csound using different opcodes and some examples for that… But it is important that this is taken in consideration before the videos are being made… I am highly supportive of this and can do some videos myself…

Csound Summer School is a great idea!

And another thing that I noticed is that there are very few female composers that are active in the community and I am willing to take the initiative to encourage female composers to be more included and active and maybe in some of the future Csound conferences (or in the Summer School) we organize a concert for female composers… just an idea…

And thank you everyone for the amazing energy on the conference! It was a pleasure to meet you all!

 

All the best,

Marijana Janevska


On Mon, Sep 30, 2019 at 5:43 PM Victor Lazzarini <Victor.Lazzarini@mu.ie> wrote:
Another point is to look for formats/toolchains that are standard and widely used. 

The mistake would be to have a dependency that suddenly is not maintained anymore.

Prof. Victor Lazzarini
Maynooth University
Ireland

On 30 Sep 2019, at 16:13, Hlöðver Sigurðsson <hlolli@gmail.com> wrote:

that's true, I would not want to abandon static html output at all. I think all the frontends would benefit from a modern queryable programmatic format.

Thanks for pointing that out.

A source of inspiration is what the clojure community has been doing with their documentation, 2 frontends at least are using https://clojuredocs-edn.netlify.com/ endpoint for syntax highlighting. And as an alternative a new community driven documentation site https://cljdoc.org/ which is just amazing!

On Mon, 30 Sep 2019 at 16:37, Steven Yi <stevenyi@gmail.com> wrote:
Also an important issue is that a number of tools are built around the
documentation. I know Blue uses a python script to read the
documentation as XML and generate information it uses for syntax
highlighting and presenting of opcode information to the user.  Also,
I depend upon the HTML output organization with opcode entries going
to files with [opcodename].html.  I think CsoundQt and Cabbage may be
in the same boat, perhaps others.

This is to say that the documentation is not just a format for output
to the print/screen manual, but also a data source too.  I'm all for
transitioning the documentation to a new format as long as we also
keep the data aspect in mind.

On Mon, Sep 30, 2019 at 9:31 AM Victor Lazzarini <Victor.Lazzarini@mu.ie> wrote:
>
> I think it could be time to move on, but it looks like a big job to move to a different format. I think two
> things are essential:
>
> 1. easy to edit and to add reference pages
> 2. easy to render to all formats we need (plus others as a bonus)
>
> I think leading this change is probably a job for whoever takes on as editor.
> ========================
> Prof. Victor Lazzarini
> Maynooth University
> Ireland
>
> > On 30 Sep 2019, at 13:54, Hlöðver Sigurðsson <hlolli@gmail.com> wrote:
> >
> > I discussed it with some people, that it makes sense to go for another format than docbook. Could be json, yaml or even python dictionary. From a more programmating format its easy to render various formats. As well, for front ends to generate syntax highlighting and minidocs. XML is becoming too arcane imo.
> >
> > On Mon, 30 Sep 2019 at 12:17, Eduardo Moguillansky <eduardo.moguillansky@gmail.com> wrote:
> > On 30.09.19 11:28, Victor Lazzarini wrote:
> > > Good resolutions. A few comments from me.
> > >
> > > 1. We need a manual editor/maintainer. François has been kindly building the
> > > releases, but I think we do not have anyone leading editorial decisions and
> > > organising the manual. All the things listed there need quite a bit of work and
> > > the reason they have not been done is because no one is taking the editor’s
> > > job. That should be a recognised position, and named at the top of the manual,
> > > e.g.
> > >
> > > Csound Reference Manual
> > > Jane Doe, Editor
> > >
> > > and a recognised publication, possibly with DOI etc. that we can cite.
> >
> > Would it be thinkable to convert the manual to a different format?
> > docbook takes really too long to build and there does not seem to be any
> > way to parallelize it. There is also a lot of manual indexing involved
> > that could be automated (adding an opcode to a specific category, adding
> > it to the global list of opcodes, etc)
> >
> > 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
>
>
> 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
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
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

Date2019-10-03 11:44
FromRory Walsh
SubjectRe: [Csnd] ICSC2019 Dev Table resolution
Thanks Marijana. Please let us know the outcome of your discussions in class. With regards to the few female composers in the community, I think this is a real issue that needs addressing. There were no female presenters giving any talks this year, or in any of the previous conferences from what I can recall. There have never been any keynotes by women, yet there have been female composers featured in many concerts. From the outside in this community looks extremely lobsided. Whatever the next event is, please let us reach out to some female composers and get them to share their experiences with us! 

On Thu, 3 Oct 2019 at 10:53, Marijana Janevska <marijana.janevska90@gmail.com> wrote:

Dear Csounders,

 

I would like to help in the revision of the manual and write more nice examples for it. And I think some of the other students of Joachim are going to be interested in doing this, so we’ll discuss this in our class, see who is interested and divide the job…

Making videos and tutorials for the Youtube channel is very important for the new Csounders. And if there is an official Youtube channel, I think it is important that the videos that are being made are outlined in more or less the same form. For example, if it is a video for “How to do FM in Csound”, then there is a brief description of what FM is and how to do it in Csound using different opcodes and some examples for that… But it is important that this is taken in consideration before the videos are being made… I am highly supportive of this and can do some videos myself…

Csound Summer School is a great idea!

And another thing that I noticed is that there are very few female composers that are active in the community and I am willing to take the initiative to encourage female composers to be more included and active and maybe in some of the future Csound conferences (or in the Summer School) we organize a concert for female composers… just an idea…

And thank you everyone for the amazing energy on the conference! It was a pleasure to meet you all!

 

All the best,

Marijana Janevska


On Mon, Sep 30, 2019 at 5:43 PM Victor Lazzarini <Victor.Lazzarini@mu.ie> wrote:
Another point is to look for formats/toolchains that are standard and widely used. 

The mistake would be to have a dependency that suddenly is not maintained anymore.

Prof. Victor Lazzarini
Maynooth University
Ireland

On 30 Sep 2019, at 16:13, Hlöðver Sigurðsson <hlolli@gmail.com> wrote:

that's true, I would not want to abandon static html output at all. I think all the frontends would benefit from a modern queryable programmatic format.

Thanks for pointing that out.

A source of inspiration is what the clojure community has been doing with their documentation, 2 frontends at least are using https://clojuredocs-edn.netlify.com/ endpoint for syntax highlighting. And as an alternative a new community driven documentation site https://cljdoc.org/ which is just amazing!

On Mon, 30 Sep 2019 at 16:37, Steven Yi <stevenyi@gmail.com> wrote:
Also an important issue is that a number of tools are built around the
documentation. I know Blue uses a python script to read the
documentation as XML and generate information it uses for syntax
highlighting and presenting of opcode information to the user.  Also,
I depend upon the HTML output organization with opcode entries going
to files with [opcodename].html.  I think CsoundQt and Cabbage may be
in the same boat, perhaps others.

This is to say that the documentation is not just a format for output
to the print/screen manual, but also a data source too.  I'm all for
transitioning the documentation to a new format as long as we also
keep the data aspect in mind.

On Mon, Sep 30, 2019 at 9:31 AM Victor Lazzarini <Victor.Lazzarini@mu.ie> wrote:
>
> I think it could be time to move on, but it looks like a big job to move to a different format. I think two
> things are essential:
>
> 1. easy to edit and to add reference pages
> 2. easy to render to all formats we need (plus others as a bonus)
>
> I think leading this change is probably a job for whoever takes on as editor.
> ========================
> Prof. Victor Lazzarini
> Maynooth University
> Ireland
>
> > On 30 Sep 2019, at 13:54, Hlöðver Sigurðsson <hlolli@gmail.com> wrote:
> >
> > I discussed it with some people, that it makes sense to go for another format than docbook. Could be json, yaml or even python dictionary. From a more programmating format its easy to render various formats. As well, for front ends to generate syntax highlighting and minidocs. XML is becoming too arcane imo.
> >
> > On Mon, 30 Sep 2019 at 12:17, Eduardo Moguillansky <eduardo.moguillansky@gmail.com> wrote:
> > On 30.09.19 11:28, Victor Lazzarini wrote:
> > > Good resolutions. A few comments from me.
> > >
> > > 1. We need a manual editor/maintainer. François has been kindly building the
> > > releases, but I think we do not have anyone leading editorial decisions and
> > > organising the manual. All the things listed there need quite a bit of work and
> > > the reason they have not been done is because no one is taking the editor’s
> > > job. That should be a recognised position, and named at the top of the manual,
> > > e.g.
> > >
> > > Csound Reference Manual
> > > Jane Doe, Editor
> > >
> > > and a recognised publication, possibly with DOI etc. that we can cite.
> >
> > Would it be thinkable to convert the manual to a different format?
> > docbook takes really too long to build and there does not seem to be any
> > way to parallelize it. There is also a lot of manual indexing involved
> > that could be automated (adding an opcode to a specific category, adding
> > it to the global list of opcodes, etc)
> >
> > 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
>
>
> 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
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
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

Date2019-10-03 14:32
FromHlöðver Sigurðsson
SubjectRe: [Csnd] ICSC2019 Dev Table resolution
Hi Marijana,
Yes please take initiative to make women feel more included. I know you will inspire more women composers if they hear your pieces and get to know you, I was very impressed. Making video tutorials is only a good thing, because there are so few videos out there and so much content to cover. If not from myself, then I hope the rest of the csound community can help whenever you reach out for help or propose ideas.

On Thu, 3 Oct 2019 at 12:44, Rory Walsh <rorywalsh@ear.ie> wrote:
Thanks Marijana. Please let us know the outcome of your discussions in class. With regards to the few female composers in the community, I think this is a real issue that needs addressing. There were no female presenters giving any talks this year, or in any of the previous conferences from what I can recall. There have never been any keynotes by women, yet there have been female composers featured in many concerts. From the outside in this community looks extremely lobsided. Whatever the next event is, please let us reach out to some female composers and get them to share their experiences with us! 

On Thu, 3 Oct 2019 at 10:53, Marijana Janevska <marijana.janevska90@gmail.com> wrote:

Dear Csounders,

 

I would like to help in the revision of the manual and write more nice examples for it. And I think some of the other students of Joachim are going to be interested in doing this, so we’ll discuss this in our class, see who is interested and divide the job…

Making videos and tutorials for the Youtube channel is very important for the new Csounders. And if there is an official Youtube channel, I think it is important that the videos that are being made are outlined in more or less the same form. For example, if it is a video for “How to do FM in Csound”, then there is a brief description of what FM is and how to do it in Csound using different opcodes and some examples for that… But it is important that this is taken in consideration before the videos are being made… I am highly supportive of this and can do some videos myself…

Csound Summer School is a great idea!

And another thing that I noticed is that there are very few female composers that are active in the community and I am willing to take the initiative to encourage female composers to be more included and active and maybe in some of the future Csound conferences (or in the Summer School) we organize a concert for female composers… just an idea…

And thank you everyone for the amazing energy on the conference! It was a pleasure to meet you all!

 

All the best,

Marijana Janevska


On Mon, Sep 30, 2019 at 5:43 PM Victor Lazzarini <Victor.Lazzarini@mu.ie> wrote:
Another point is to look for formats/toolchains that are standard and widely used. 

The mistake would be to have a dependency that suddenly is not maintained anymore.

Prof. Victor Lazzarini
Maynooth University
Ireland

On 30 Sep 2019, at 16:13, Hlöðver Sigurðsson <hlolli@gmail.com> wrote:

that's true, I would not want to abandon static html output at all. I think all the frontends would benefit from a modern queryable programmatic format.

Thanks for pointing that out.

A source of inspiration is what the clojure community has been doing with their documentation, 2 frontends at least are using https://clojuredocs-edn.netlify.com/ endpoint for syntax highlighting. And as an alternative a new community driven documentation site https://cljdoc.org/ which is just amazing!

On Mon, 30 Sep 2019 at 16:37, Steven Yi <stevenyi@gmail.com> wrote:
Also an important issue is that a number of tools are built around the
documentation. I know Blue uses a python script to read the
documentation as XML and generate information it uses for syntax
highlighting and presenting of opcode information to the user.  Also,
I depend upon the HTML output organization with opcode entries going
to files with [opcodename].html.  I think CsoundQt and Cabbage may be
in the same boat, perhaps others.

This is to say that the documentation is not just a format for output
to the print/screen manual, but also a data source too.  I'm all for
transitioning the documentation to a new format as long as we also
keep the data aspect in mind.

On Mon, Sep 30, 2019 at 9:31 AM Victor Lazzarini <Victor.Lazzarini@mu.ie> wrote:
>
> I think it could be time to move on, but it looks like a big job to move to a different format. I think two
> things are essential:
>
> 1. easy to edit and to add reference pages
> 2. easy to render to all formats we need (plus others as a bonus)
>
> I think leading this change is probably a job for whoever takes on as editor.
> ========================
> Prof. Victor Lazzarini
> Maynooth University
> Ireland
>
> > On 30 Sep 2019, at 13:54, Hlöðver Sigurðsson <hlolli@gmail.com> wrote:
> >
> > I discussed it with some people, that it makes sense to go for another format than docbook. Could be json, yaml or even python dictionary. From a more programmating format its easy to render various formats. As well, for front ends to generate syntax highlighting and minidocs. XML is becoming too arcane imo.
> >
> > On Mon, 30 Sep 2019 at 12:17, Eduardo Moguillansky <eduardo.moguillansky@gmail.com> wrote:
> > On 30.09.19 11:28, Victor Lazzarini wrote:
> > > Good resolutions. A few comments from me.
> > >
> > > 1. We need a manual editor/maintainer. François has been kindly building the
> > > releases, but I think we do not have anyone leading editorial decisions and
> > > organising the manual. All the things listed there need quite a bit of work and
> > > the reason they have not been done is because no one is taking the editor’s
> > > job. That should be a recognised position, and named at the top of the manual,
> > > e.g.
> > >
> > > Csound Reference Manual
> > > Jane Doe, Editor
> > >
> > > and a recognised publication, possibly with DOI etc. that we can cite.
> >
> > Would it be thinkable to convert the manual to a different format?
> > docbook takes really too long to build and there does not seem to be any
> > way to parallelize it. There is also a lot of manual indexing involved
> > that could be automated (adding an opcode to a specific category, adding
> > it to the global list of opcodes, etc)
> >
> > 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
>
>
> 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
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
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
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

Date2019-10-03 15:42
FromJason Hallen
SubjectRe: [Csnd] ICSC2019 Dev Table resolution
Hi everyone,

I've been learning Csound for about 6 months now, so I'm still a newcomer.  I was very excited to see this resolution from the Developer Round Table, and I especially appreciate Marijana's comments.  The timing was perfect for me because just this weekend I was writing a blog post on how mysterious and challenging Csound is for the newcomer.  Admittedly, there will always be a steep learning curve for Csound even if you have the best online documentation and user community.  It's just a conceptually challenging language, at least for me.  That being said, I've been struck by how difficult it has been to teach myself Csound.  I definitely noticed the lack of an organized presence on YouTube and the lack of a modern online forum when I began 6 months ago.  I've been very fortunate that as an academic librarian I've had free and easy access to textbooks like Csound: A Sound and Music Computing System, Computer Music Instruments, The Csound Book, and The Audio Programming Book.  Perhaps the most helpful book conceptually has been Dodge and Jerse's Computer Music.  The average person trying to learn Csound might not have access to these books, and even with all these resources plus the FLOSS Manual and the Csound reference manual Csound has still been an uphill battle to learn.

All this is to say that I support any efforts by the user community to make Csound more approachable for newcomers.  All the ideas mentioned in the resolution will help with that.  I think it's especially important that when newcomers curious about Csound search the internet for Csound resources they come away with the impression that Csound is modern and vibrant and that there is an active, supportive user community.  I've since come to find that both these things are true, but they were not obvious to me when I first started out 6 months ago.

My apologies if I'm misunderstanding the use of the term "developer" and my comments about newcomers are not directly relevant to this discussion.  My comments are geared toward anyone curious to adopt Csound in their musical projects.  Perhaps by "developer" you mean people with more advanced programming backgrounds who are looking to integrate Csound into more advanced frameworks.

Thanks to all of you who are working on this!  Kudos to the Developer Round Table for this resolution!  I'll be happy to help in any way I can.

Jason

On Thu, Oct 3, 2019 at 8:32 AM Hlöðver Sigurðsson <hlolli@gmail.com> wrote:
Hi Marijana,
Yes please take initiative to make women feel more included. I know you will inspire more women composers if they hear your pieces and get to know you, I was very impressed. Making video tutorials is only a good thing, because there are so few videos out there and so much content to cover. If not from myself, then I hope the rest of the csound community can help whenever you reach out for help or propose ideas.

On Thu, 3 Oct 2019 at 12:44, Rory Walsh <rorywalsh@ear.ie> wrote:
Thanks Marijana. Please let us know the outcome of your discussions in class. With regards to the few female composers in the community, I think this is a real issue that needs addressing. There were no female presenters giving any talks this year, or in any of the previous conferences from what I can recall. There have never been any keynotes by women, yet there have been female composers featured in many concerts. From the outside in this community looks extremely lobsided. Whatever the next event is, please let us reach out to some female composers and get them to share their experiences with us! 

On Thu, 3 Oct 2019 at 10:53, Marijana Janevska <marijana.janevska90@gmail.com> wrote:

Dear Csounders,

 

I would like to help in the revision of the manual and write more nice examples for it. And I think some of the other students of Joachim are going to be interested in doing this, so we’ll discuss this in our class, see who is interested and divide the job…

Making videos and tutorials for the Youtube channel is very important for the new Csounders. And if there is an official Youtube channel, I think it is important that the videos that are being made are outlined in more or less the same form. For example, if it is a video for “How to do FM in Csound”, then there is a brief description of what FM is and how to do it in Csound using different opcodes and some examples for that… But it is important that this is taken in consideration before the videos are being made… I am highly supportive of this and can do some videos myself…

Csound Summer School is a great idea!

And another thing that I noticed is that there are very few female composers that are active in the community and I am willing to take the initiative to encourage female composers to be more included and active and maybe in some of the future Csound conferences (or in the Summer School) we organize a concert for female composers… just an idea…

And thank you everyone for the amazing energy on the conference! It was a pleasure to meet you all!

 

All the best,

Marijana Janevska


On Mon, Sep 30, 2019 at 5:43 PM Victor Lazzarini <Victor.Lazzarini@mu.ie> wrote:
Another point is to look for formats/toolchains that are standard and widely used. 

The mistake would be to have a dependency that suddenly is not maintained anymore.

Prof. Victor Lazzarini
Maynooth University
Ireland

On 30 Sep 2019, at 16:13, Hlöðver Sigurðsson <hlolli@gmail.com> wrote:

that's true, I would not want to abandon static html output at all. I think all the frontends would benefit from a modern queryable programmatic format.

Thanks for pointing that out.

A source of inspiration is what the clojure community has been doing with their documentation, 2 frontends at least are using https://clojuredocs-edn.netlify.com/ endpoint for syntax highlighting. And as an alternative a new community driven documentation site https://cljdoc.org/ which is just amazing!

On Mon, 30 Sep 2019 at 16:37, Steven Yi <stevenyi@gmail.com> wrote:
Also an important issue is that a number of tools are built around the
documentation. I know Blue uses a python script to read the
documentation as XML and generate information it uses for syntax
highlighting and presenting of opcode information to the user.  Also,
I depend upon the HTML output organization with opcode entries going
to files with [opcodename].html.  I think CsoundQt and Cabbage may be
in the same boat, perhaps others.

This is to say that the documentation is not just a format for output
to the print/screen manual, but also a data source too.  I'm all for
transitioning the documentation to a new format as long as we also
keep the data aspect in mind.

On Mon, Sep 30, 2019 at 9:31 AM Victor Lazzarini <Victor.Lazzarini@mu.ie> wrote:
>
> I think it could be time to move on, but it looks like a big job to move to a different format. I think two
> things are essential:
>
> 1. easy to edit and to add reference pages
> 2. easy to render to all formats we need (plus others as a bonus)
>
> I think leading this change is probably a job for whoever takes on as editor.
> ========================
> Prof. Victor Lazzarini
> Maynooth University
> Ireland
>
> > On 30 Sep 2019, at 13:54, Hlöðver Sigurðsson <hlolli@gmail.com> wrote:
> >
> > I discussed it with some people, that it makes sense to go for another format than docbook. Could be json, yaml or even python dictionary. From a more programmating format its easy to render various formats. As well, for front ends to generate syntax highlighting and minidocs. XML is becoming too arcane imo.
> >
> > On Mon, 30 Sep 2019 at 12:17, Eduardo Moguillansky <eduardo.moguillansky@gmail.com> wrote:
> > On 30.09.19 11:28, Victor Lazzarini wrote:
> > > Good resolutions. A few comments from me.
> > >
> > > 1. We need a manual editor/maintainer. François has been kindly building the
> > > releases, but I think we do not have anyone leading editorial decisions and
> > > organising the manual. All the things listed there need quite a bit of work and
> > > the reason they have not been done is because no one is taking the editor’s
> > > job. That should be a recognised position, and named at the top of the manual,
> > > e.g.
> > >
> > > Csound Reference Manual
> > > Jane Doe, Editor
> > >
> > > and a recognised publication, possibly with DOI etc. that we can cite.
> >
> > Would it be thinkable to convert the manual to a different format?
> > docbook takes really too long to build and there does not seem to be any
> > way to parallelize it. There is also a lot of manual indexing involved
> > that could be automated (adding an opcode to a specific category, adding
> > it to the global list of opcodes, etc)
> >
> > 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
>
>
> 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
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
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
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

Date2019-10-03 19:00
FromLeonardo Foletto
SubjectRe: [Csnd] ICSC2019 Dev Table resolution
It would be great to have more diversity in our community and we could use this idea of creating something like an official YouTube channel as an occasion to also work on that issue if there are female/nonbinary Csounders interested in contributing with video lessons or performances. 
In general it would greatly benefit the community to have a more "official" online presence easy to find and access (YouTube / instagram) to showcase what our community is doing and have some beginners tutorial and intro lessons for people who are just discovering about the software and might not yet be familiar with how to navigate documentation /mailing lists. I feel like even something as simple as a YouTube video showing how to install csound /csoundqt and how to navigate examples and documentation would be a great starting point. I would be happy to help setup / moderate some of this social media channels on behalf of the community, but I feel like first we should have a minimal body of material ready to be uploaded and a logo that we can adopt everywhere to better brand and expose Csound. As for the first few videos to upload, we could also start by getting in touch with people who have already quality videos and tutorials about Csound on Youtube and maybe watermarking them with the Csound logo and reposting them on this new channel (with the appropriate attribution to the author of course). 
Just an idea, but might be worth exploring..
Also, does anyone have a graphic designer friend/ is a graphic designer who would be willing to help us out with a new logo?
Should we make an open call to the community to propose a logo and then make a poll and vote? That call could go together with the request of videos/educational material for the Youtube channel..

Let me know what you think. 

Best, 
Leo



On Thu, Oct 3, 2019, 10:43 AM Jason Hallen <hallenj@gmail.com> wrote:
Hi everyone,

I've been learning Csound for about 6 months now, so I'm still a newcomer.  I was very excited to see this resolution from the Developer Round Table, and I especially appreciate Marijana's comments.  The timing was perfect for me because just this weekend I was writing a blog post on how mysterious and challenging Csound is for the newcomer.  Admittedly, there will always be a steep learning curve for Csound even if you have the best online documentation and user community.  It's just a conceptually challenging language, at least for me.  That being said, I've been struck by how difficult it has been to teach myself Csound.  I definitely noticed the lack of an organized presence on YouTube and the lack of a modern online forum when I began 6 months ago.  I've been very fortunate that as an academic librarian I've had free and easy access to textbooks like Csound: A Sound and Music Computing System, Computer Music Instruments, The Csound Book, and The Audio Programming Book.  Perhaps the most helpful book conceptually has been Dodge and Jerse's Computer Music.  The average person trying to learn Csound might not have access to these books, and even with all these resources plus the FLOSS Manual and the Csound reference manual Csound has still been an uphill battle to learn.

All this is to say that I support any efforts by the user community to make Csound more approachable for newcomers.  All the ideas mentioned in the resolution will help with that.  I think it's especially important that when newcomers curious about Csound search the internet for Csound resources they come away with the impression that Csound is modern and vibrant and that there is an active, supportive user community.  I've since come to find that both these things are true, but they were not obvious to me when I first started out 6 months ago.

My apologies if I'm misunderstanding the use of the term "developer" and my comments about newcomers are not directly relevant to this discussion.  My comments are geared toward anyone curious to adopt Csound in their musical projects.  Perhaps by "developer" you mean people with more advanced programming backgrounds who are looking to integrate Csound into more advanced frameworks.

Thanks to all of you who are working on this!  Kudos to the Developer Round Table for this resolution!  I'll be happy to help in any way I can.

Jason

On Thu, Oct 3, 2019 at 8:32 AM Hlöðver Sigurðsson <hlolli@gmail.com> wrote:
Hi Marijana,
Yes please take initiative to make women feel more included. I know you will inspire more women composers if they hear your pieces and get to know you, I was very impressed. Making video tutorials is only a good thing, because there are so few videos out there and so much content to cover. If not from myself, then I hope the rest of the csound community can help whenever you reach out for help or propose ideas.

On Thu, 3 Oct 2019 at 12:44, Rory Walsh <rorywalsh@ear.ie> wrote:
Thanks Marijana. Please let us know the outcome of your discussions in class. With regards to the few female composers in the community, I think this is a real issue that needs addressing. There were no female presenters giving any talks this year, or in any of the previous conferences from what I can recall. There have never been any keynotes by women, yet there have been female composers featured in many concerts. From the outside in this community looks extremely lobsided. Whatever the next event is, please let us reach out to some female composers and get them to share their experiences with us! 

On Thu, 3 Oct 2019 at 10:53, Marijana Janevska <marijana.janevska90@gmail.com> wrote:

Dear Csounders,

 

I would like to help in the revision of the manual and write more nice examples for it. And I think some of the other students of Joachim are going to be interested in doing this, so we’ll discuss this in our class, see who is interested and divide the job…

Making videos and tutorials for the Youtube channel is very important for the new Csounders. And if there is an official Youtube channel, I think it is important that the videos that are being made are outlined in more or less the same form. For example, if it is a video for “How to do FM in Csound”, then there is a brief description of what FM is and how to do it in Csound using different opcodes and some examples for that… But it is important that this is taken in consideration before the videos are being made… I am highly supportive of this and can do some videos myself…

Csound Summer School is a great idea!

And another thing that I noticed is that there are very few female composers that are active in the community and I am willing to take the initiative to encourage female composers to be more included and active and maybe in some of the future Csound conferences (or in the Summer School) we organize a concert for female composers… just an idea…

And thank you everyone for the amazing energy on the conference! It was a pleasure to meet you all!

 

All the best,

Marijana Janevska


On Mon, Sep 30, 2019 at 5:43 PM Victor Lazzarini <Victor.Lazzarini@mu.ie> wrote:
Another point is to look for formats/toolchains that are standard and widely used. 

The mistake would be to have a dependency that suddenly is not maintained anymore.

Prof. Victor Lazzarini
Maynooth University
Ireland

On 30 Sep 2019, at 16:13, Hlöðver Sigurðsson <hlolli@gmail.com> wrote:

that's true, I would not want to abandon static html output at all. I think all the frontends would benefit from a modern queryable programmatic format.

Thanks for pointing that out.

A source of inspiration is what the clojure community has been doing with their documentation, 2 frontends at least are using https://clojuredocs-edn.netlify.com/ endpoint for syntax highlighting. And as an alternative a new community driven documentation site https://cljdoc.org/ which is just amazing!

On Mon, 30 Sep 2019 at 16:37, Steven Yi <stevenyi@gmail.com> wrote:
Also an important issue is that a number of tools are built around the
documentation. I know Blue uses a python script to read the
documentation as XML and generate information it uses for syntax
highlighting and presenting of opcode information to the user.  Also,
I depend upon the HTML output organization with opcode entries going
to files with [opcodename].html.  I think CsoundQt and Cabbage may be
in the same boat, perhaps others.

This is to say that the documentation is not just a format for output
to the print/screen manual, but also a data source too.  I'm all for
transitioning the documentation to a new format as long as we also
keep the data aspect in mind.

On Mon, Sep 30, 2019 at 9:31 AM Victor Lazzarini <Victor.Lazzarini@mu.ie> wrote:
>
> I think it could be time to move on, but it looks like a big job to move to a different format. I think two
> things are essential:
>
> 1. easy to edit and to add reference pages
> 2. easy to render to all formats we need (plus others as a bonus)
>
> I think leading this change is probably a job for whoever takes on as editor.
> ========================
> Prof. Victor Lazzarini
> Maynooth University
> Ireland
>
> > On 30 Sep 2019, at 13:54, Hlöðver Sigurðsson <hlolli@gmail.com> wrote:
> >
> > I discussed it with some people, that it makes sense to go for another format than docbook. Could be json, yaml or even python dictionary. From a more programmating format its easy to render various formats. As well, for front ends to generate syntax highlighting and minidocs. XML is becoming too arcane imo.
> >
> > On Mon, 30 Sep 2019 at 12:17, Eduardo Moguillansky <eduardo.moguillansky@gmail.com> wrote:
> > On 30.09.19 11:28, Victor Lazzarini wrote:
> > > Good resolutions. A few comments from me.
> > >
> > > 1. We need a manual editor/maintainer. François has been kindly building the
> > > releases, but I think we do not have anyone leading editorial decisions and
> > > organising the manual. All the things listed there need quite a bit of work and
> > > the reason they have not been done is because no one is taking the editor’s
> > > job. That should be a recognised position, and named at the top of the manual,
> > > e.g.
> > >
> > > Csound Reference Manual
> > > Jane Doe, Editor
> > >
> > > and a recognised publication, possibly with DOI etc. that we can cite.
> >
> > Would it be thinkable to convert the manual to a different format?
> > docbook takes really too long to build and there does not seem to be any
> > way to parallelize it. There is also a lot of manual indexing involved
> > that could be automated (adding an opcode to a specific category, adding
> > it to the global list of opcodes, etc)
> >
> > 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
>
>
> 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
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
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
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
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

Date2019-10-03 19:09
FromOeyvind Brandtsegg
SubjectRe: [Csnd] ICSC2019 Dev Table resolution
Hi Marijana,

Thanks for the initiative to encourage and support more female Csound users to be active and included in the community. I put Anna Xambó of WoNoMute on CC too and hope you two get in touch with each other. Maybe a German branch of WoNoMuTe (WoGeMuTe?) could be started, or other networking activity to connect these growing initiatives.

Thanks for your inspiring music too!

Oeyvind

tor. 3. okt. 2019 kl. 11:52 skrev Marijana Janevska <marijana.janevska90@gmail.com>:

Dear Csounders,

 

I would like to help in the revision of the manual and write more nice examples for it. And I think some of the other students of Joachim are going to be interested in doing this, so we’ll discuss this in our class, see who is interested and divide the job…

Making videos and tutorials for the Youtube channel is very important for the new Csounders. And if there is an official Youtube channel, I think it is important that the videos that are being made are outlined in more or less the same form. For example, if it is a video for “How to do FM in Csound”, then there is a brief description of what FM is and how to do it in Csound using different opcodes and some examples for that… But it is important that this is taken in consideration before the videos are being made… I am highly supportive of this and can do some videos myself…

Csound Summer School is a great idea!

And another thing that I noticed is that there are very few female composers that are active in the community and I am willing to take the initiative to encourage female composers to be more included and active and maybe in some of the future Csound conferences (or in the Summer School) we organize a concert for female composers… just an idea…

And thank you everyone for the amazing energy on the conference! It was a pleasure to meet you all!

 

All the best,

Marijana Janevska


On Mon, Sep 30, 2019 at 5:43 PM Victor Lazzarini <Victor.Lazzarini@mu.ie> wrote:
Another point is to look for formats/toolchains that are standard and widely used. 

The mistake would be to have a dependency that suddenly is not maintained anymore.

Prof. Victor Lazzarini
Maynooth University
Ireland

On 30 Sep 2019, at 16:13, Hlöðver Sigurðsson <hlolli@gmail.com> wrote:

that's true, I would not want to abandon static html output at all. I think all the frontends would benefit from a modern queryable programmatic format.

Thanks for pointing that out.

A source of inspiration is what the clojure community has been doing with their documentation, 2 frontends at least are using https://clojuredocs-edn.netlify.com/ endpoint for syntax highlighting. And as an alternative a new community driven documentation site https://cljdoc.org/ which is just amazing!

On Mon, 30 Sep 2019 at 16:37, Steven Yi <stevenyi@gmail.com> wrote:
Also an important issue is that a number of tools are built around the
documentation. I know Blue uses a python script to read the
documentation as XML and generate information it uses for syntax
highlighting and presenting of opcode information to the user.  Also,
I depend upon the HTML output organization with opcode entries going
to files with [opcodename].html.  I think CsoundQt and Cabbage may be
in the same boat, perhaps others.

This is to say that the documentation is not just a format for output
to the print/screen manual, but also a data source too.  I'm all for
transitioning the documentation to a new format as long as we also
keep the data aspect in mind.

On Mon, Sep 30, 2019 at 9:31 AM Victor Lazzarini <Victor.Lazzarini@mu.ie> wrote:
>
> I think it could be time to move on, but it looks like a big job to move to a different format. I think two
> things are essential:
>
> 1. easy to edit and to add reference pages
> 2. easy to render to all formats we need (plus others as a bonus)
>
> I think leading this change is probably a job for whoever takes on as editor.
> ========================
> Prof. Victor Lazzarini
> Maynooth University
> Ireland
>
> > On 30 Sep 2019, at 13:54, Hlöðver Sigurðsson <hlolli@gmail.com> wrote:
> >
> > I discussed it with some people, that it makes sense to go for another format than docbook. Could be json, yaml or even python dictionary. From a more programmating format its easy to render various formats. As well, for front ends to generate syntax highlighting and minidocs. XML is becoming too arcane imo.
> >
> > On Mon, 30 Sep 2019 at 12:17, Eduardo Moguillansky <eduardo.moguillansky@gmail.com> wrote:
> > On 30.09.19 11:28, Victor Lazzarini wrote:
> > > Good resolutions. A few comments from me.
> > >
> > > 1. We need a manual editor/maintainer. François has been kindly building the
> > > releases, but I think we do not have anyone leading editorial decisions and
> > > organising the manual. All the things listed there need quite a bit of work and
> > > the reason they have not been done is because no one is taking the editor’s
> > > job. That should be a recognised position, and named at the top of the manual,
> > > e.g.
> > >
> > > Csound Reference Manual
> > > Jane Doe, Editor
> > >
> > > and a recognised publication, possibly with DOI etc. that we can cite.
> >
> > Would it be thinkable to convert the manual to a different format?
> > docbook takes really too long to build and there does not seem to be any
> > way to parallelize it. There is also a lot of manual indexing involved
> > that could be automated (adding an opcode to a specific category, adding
> > it to the global list of opcodes, etc)
> >
> > 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
>
>
> 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
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
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

Date2019-10-03 22:19
FromHlöðver Sigurðsson
SubjectRe: [Csnd] ICSC2019 Dev Table resolution
Great idea, there should be a community driven youtube channel, if we opt for that idea, we can add the link to it to the website.

I just experimented in creating a new channel, despite there can be only 1 owner, many admins can be added, as far as I understand it. I created a #youtube channel on the csound slack channel. We could discuss tutorials/screencasts/hacks/tricks that would be cool to post and share.

Btw those unfamiliar with slack, there's a cross-platform slack client on https://slack.com/intl/en-de/downloads and a signup to csound-organization here https://csound-slack.herokuapp.com/


On Thu, 3 Oct 2019 at 20:09, Oeyvind Brandtsegg <obrandts@gmail.com> wrote:
Hi Marijana,

Thanks for the initiative to encourage and support more female Csound users to be active and included in the community. I put Anna Xambó of WoNoMute on CC too and hope you two get in touch with each other. Maybe a German branch of WoNoMuTe (WoGeMuTe?) could be started, or other networking activity to connect these growing initiatives.

Thanks for your inspiring music too!

Oeyvind

tor. 3. okt. 2019 kl. 11:52 skrev Marijana Janevska <marijana.janevska90@gmail.com>:

Dear Csounders,

 

I would like to help in the revision of the manual and write more nice examples for it. And I think some of the other students of Joachim are going to be interested in doing this, so we’ll discuss this in our class, see who is interested and divide the job…

Making videos and tutorials for the Youtube channel is very important for the new Csounders. And if there is an official Youtube channel, I think it is important that the videos that are being made are outlined in more or less the same form. For example, if it is a video for “How to do FM in Csound”, then there is a brief description of what FM is and how to do it in Csound using different opcodes and some examples for that… But it is important that this is taken in consideration before the videos are being made… I am highly supportive of this and can do some videos myself…

Csound Summer School is a great idea!

And another thing that I noticed is that there are very few female composers that are active in the community and I am willing to take the initiative to encourage female composers to be more included and active and maybe in some of the future Csound conferences (or in the Summer School) we organize a concert for female composers… just an idea…

And thank you everyone for the amazing energy on the conference! It was a pleasure to meet you all!

 

All the best,

Marijana Janevska


On Mon, Sep 30, 2019 at 5:43 PM Victor Lazzarini <Victor.Lazzarini@mu.ie> wrote:
Another point is to look for formats/toolchains that are standard and widely used. 

The mistake would be to have a dependency that suddenly is not maintained anymore.

Prof. Victor Lazzarini
Maynooth University
Ireland

On 30 Sep 2019, at 16:13, Hlöðver Sigurðsson <hlolli@gmail.com> wrote:

that's true, I would not want to abandon static html output at all. I think all the frontends would benefit from a modern queryable programmatic format.

Thanks for pointing that out.

A source of inspiration is what the clojure community has been doing with their documentation, 2 frontends at least are using https://clojuredocs-edn.netlify.com/ endpoint for syntax highlighting. And as an alternative a new community driven documentation site https://cljdoc.org/ which is just amazing!

On Mon, 30 Sep 2019 at 16:37, Steven Yi <stevenyi@gmail.com> wrote:
Also an important issue is that a number of tools are built around the
documentation. I know Blue uses a python script to read the
documentation as XML and generate information it uses for syntax
highlighting and presenting of opcode information to the user.  Also,
I depend upon the HTML output organization with opcode entries going
to files with [opcodename].html.  I think CsoundQt and Cabbage may be
in the same boat, perhaps others.

This is to say that the documentation is not just a format for output
to the print/screen manual, but also a data source too.  I'm all for
transitioning the documentation to a new format as long as we also
keep the data aspect in mind.

On Mon, Sep 30, 2019 at 9:31 AM Victor Lazzarini <Victor.Lazzarini@mu.ie> wrote:
>
> I think it could be time to move on, but it looks like a big job to move to a different format. I think two
> things are essential:
>
> 1. easy to edit and to add reference pages
> 2. easy to render to all formats we need (plus others as a bonus)
>
> I think leading this change is probably a job for whoever takes on as editor.
> ========================
> Prof. Victor Lazzarini
> Maynooth University
> Ireland
>
> > On 30 Sep 2019, at 13:54, Hlöðver Sigurðsson <hlolli@gmail.com> wrote:
> >
> > I discussed it with some people, that it makes sense to go for another format than docbook. Could be json, yaml or even python dictionary. From a more programmating format its easy to render various formats. As well, for front ends to generate syntax highlighting and minidocs. XML is becoming too arcane imo.
> >
> > On Mon, 30 Sep 2019 at 12:17, Eduardo Moguillansky <eduardo.moguillansky@gmail.com> wrote:
> > On 30.09.19 11:28, Victor Lazzarini wrote:
> > > Good resolutions. A few comments from me.
> > >
> > > 1. We need a manual editor/maintainer. François has been kindly building the
> > > releases, but I think we do not have anyone leading editorial decisions and
> > > organising the manual. All the things listed there need quite a bit of work and
> > > the reason they have not been done is because no one is taking the editor’s
> > > job. That should be a recognised position, and named at the top of the manual,
> > > e.g.
> > >
> > > Csound Reference Manual
> > > Jane Doe, Editor
> > >
> > > and a recognised publication, possibly with DOI etc. that we can cite.
> >
> > Would it be thinkable to convert the manual to a different format?
> > docbook takes really too long to build and there does not seem to be any
> > way to parallelize it. There is also a lot of manual indexing involved
> > that could be automated (adding an opcode to a specific category, adding
> > it to the global list of opcodes, etc)
> >
> > 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
>
>
> 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
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
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
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

Date2019-10-04 16:43
FromSteven Yi
SubjectRe: [Csnd] ICSC2019 Dev Table resolution
Dear Marijana,

This all sounds fantastic. I particularly like the initiative to help
the diversity of representation in this community. Hopefully everyone,
regardless of identity, will feel encouraged to participate and share
online and in person at future gatherings and conferences.

A video tutorials team collaboration would be great I think.  Any of
these tasks can be onerous for one person, but perhaps a few people
together can make this not too much.  I think a common production on
videos would be nice.  However, I think anyone should feel encouraged
to produce their own videos too, and we can give them visibility on
the csound.com site by having a list of video playlists. (Just
thinking out loud here.)

All best and thanks again for your initiative!

Steven



On Thu, Oct 3, 2019 at 5:52 AM Marijana Janevska
 wrote:
>
> Dear Csounders,
>
>
>
> I would like to help in the revision of the manual and write more nice examples for it. And I think some of the other students of Joachim are going to be interested in doing this, so we’ll discuss this in our class, see who is interested and divide the job…
>
> Making videos and tutorials for the Youtube channel is very important for the new Csounders. And if there is an official Youtube channel, I think it is important that the videos that are being made are outlined in more or less the same form. For example, if it is a video for “How to do FM in Csound”, then there is a brief description of what FM is and how to do it in Csound using different opcodes and some examples for that… But it is important that this is taken in consideration before the videos are being made… I am highly supportive of this and can do some videos myself…
>
> Csound Summer School is a great idea!
>
> And another thing that I noticed is that there are very few female composers that are active in the community and I am willing to take the initiative to encourage female composers to be more included and active and maybe in some of the future Csound conferences (or in the Summer School) we organize a concert for female composers… just an idea…
>
> And thank you everyone for the amazing energy on the conference! It was a pleasure to meet you all!
>
>
>
> All the best,
>
> Marijana Janevska
>
>
> On Mon, Sep 30, 2019 at 5:43 PM Victor Lazzarini  wrote:
>>
>> Another point is to look for formats/toolchains that are standard and widely used.
>>
>> The mistake would be to have a dependency that suddenly is not maintained anymore.
>>
>> Prof. Victor Lazzarini
>> Maynooth University
>> Ireland
>>
>> On 30 Sep 2019, at 16:13, Hlöðver Sigurðsson  wrote:
>>
>> that's true, I would not want to abandon static html output at all. I think all the frontends would benefit from a modern queryable programmatic format.
>>
>> Thanks for pointing that out.
>>
>> A source of inspiration is what the clojure community has been doing with their documentation, 2 frontends at least are using https://clojuredocs-edn.netlify.com/ endpoint for syntax highlighting. And as an alternative a new community driven documentation site https://cljdoc.org/ which is just amazing!
>>
>> On Mon, 30 Sep 2019 at 16:37, Steven Yi  wrote:
>>>
>>> Also an important issue is that a number of tools are built around the
>>> documentation. I know Blue uses a python script to read the
>>> documentation as XML and generate information it uses for syntax
>>> highlighting and presenting of opcode information to the user.  Also,
>>> I depend upon the HTML output organization with opcode entries going
>>> to files with [opcodename].html.  I think CsoundQt and Cabbage may be
>>> in the same boat, perhaps others.
>>>
>>> This is to say that the documentation is not just a format for output
>>> to the print/screen manual, but also a data source too.  I'm all for
>>> transitioning the documentation to a new format as long as we also
>>> keep the data aspect in mind.
>>>
>>> On Mon, Sep 30, 2019 at 9:31 AM Victor Lazzarini  wrote:
>>> >
>>> > I think it could be time to move on, but it looks like a big job to move to a different format. I think two
>>> > things are essential:
>>> >
>>> > 1. easy to edit and to add reference pages
>>> > 2. easy to render to all formats we need (plus others as a bonus)
>>> >
>>> > I think leading this change is probably a job for whoever takes on as editor.
>>> > ========================
>>> > Prof. Victor Lazzarini
>>> > Maynooth University
>>> > Ireland
>>> >
>>> > > On 30 Sep 2019, at 13:54, Hlöðver Sigurðsson  wrote:
>>> > >
>>> > > I discussed it with some people, that it makes sense to go for another format than docbook. Could be json, yaml or even python dictionary. From a more programmating format its easy to render various formats. As well, for front ends to generate syntax highlighting and minidocs. XML is becoming too arcane imo.
>>> > >
>>> > > On Mon, 30 Sep 2019 at 12:17, Eduardo Moguillansky  wrote:
>>> > > On 30.09.19 11:28, Victor Lazzarini wrote:
>>> > > > Good resolutions. A few comments from me.
>>> > > >
>>> > > > 1. We need a manual editor/maintainer. François has been kindly building the
>>> > > > releases, but I think we do not have anyone leading editorial decisions and
>>> > > > organising the manual. All the things listed there need quite a bit of work and
>>> > > > the reason they have not been done is because no one is taking the editor’s
>>> > > > job. That should be a recognised position, and named at the top of the manual,
>>> > > > e.g.
>>> > > >
>>> > > > Csound Reference Manual
>>> > > > Jane Doe, Editor
>>> > > >
>>> > > > and a recognised publication, possibly with DOI etc. that we can cite.
>>> > >
>>> > > Would it be thinkable to convert the manual to a different format?
>>> > > docbook takes really too long to build and there does not seem to be any
>>> > > way to parallelize it. There is also a lot of manual indexing involved
>>> > > that could be automated (adding an opcode to a specific category, adding
>>> > > it to the global list of opcodes, etc)
>>> > >
>>> > > 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
>>> >
>>> >
>>> > 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
>>
>> 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
>
> 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

Date2019-10-05 10:20
FromMarijana Janevska
SubjectRe: [Csnd] ICSC2019 Dev Table resolution

Dear all,

 

Thank you all for the strong support!!! We discussed on this subject yesterday at Joachim’s class and me and few other students will start with revising the Manual, reading through it, commenting, and writhing what could be improved, also writing interesting examples. I already started with collecting material for the videos and will make a few of them, that would be helpful for beginners… I will also try to contact the female composes working with Csound and maybe initiate a meeting, or something… (Oeyvind thank you for suggesting Anna Xambó, I will get in touch with her, and if anyone else thinks of another one please feel free to share…)

I will update you on all of these things soon…

Warm greetings,

Marijana


On Fri, Oct 4, 2019 at 5:44 PM Steven Yi <stevenyi@gmail.com> wrote:
Dear Marijana,

This all sounds fantastic. I particularly like the initiative to help
the diversity of representation in this community. Hopefully everyone,
regardless of identity, will feel encouraged to participate and share
online and in person at future gatherings and conferences.

A video tutorials team collaboration would be great I think.  Any of
these tasks can be onerous for one person, but perhaps a few people
together can make this not too much.  I think a common production on
videos would be nice.  However, I think anyone should feel encouraged
to produce their own videos too, and we can give them visibility on
the csound.com site by having a list of video playlists. (Just
thinking out loud here.)

All best and thanks again for your initiative!

Steven



On Thu, Oct 3, 2019 at 5:52 AM Marijana Janevska
<marijana.janevska90@gmail.com> wrote:
>
> Dear Csounders,
>
>
>
> I would like to help in the revision of the manual and write more nice examples for it. And I think some of the other students of Joachim are going to be interested in doing this, so we’ll discuss this in our class, see who is interested and divide the job…
>
> Making videos and tutorials for the Youtube channel is very important for the new Csounders. And if there is an official Youtube channel, I think it is important that the videos that are being made are outlined in more or less the same form. For example, if it is a video for “How to do FM in Csound”, then there is a brief description of what FM is and how to do it in Csound using different opcodes and some examples for that… But it is important that this is taken in consideration before the videos are being made… I am highly supportive of this and can do some videos myself…
>
> Csound Summer School is a great idea!
>
> And another thing that I noticed is that there are very few female composers that are active in the community and I am willing to take the initiative to encourage female composers to be more included and active and maybe in some of the future Csound conferences (or in the Summer School) we organize a concert for female composers… just an idea…
>
> And thank you everyone for the amazing energy on the conference! It was a pleasure to meet you all!
>
>
>
> All the best,
>
> Marijana Janevska
>
>
> On Mon, Sep 30, 2019 at 5:43 PM Victor Lazzarini <Victor.Lazzarini@mu.ie> wrote:
>>
>> Another point is to look for formats/toolchains that are standard and widely used.
>>
>> The mistake would be to have a dependency that suddenly is not maintained anymore.
>>
>> Prof. Victor Lazzarini
>> Maynooth University
>> Ireland
>>
>> On 30 Sep 2019, at 16:13, Hlöðver Sigurðsson <hlolli@gmail.com> wrote:
>>
>> that's true, I would not want to abandon static html output at all. I think all the frontends would benefit from a modern queryable programmatic format.
>>
>> Thanks for pointing that out.
>>
>> A source of inspiration is what the clojure community has been doing with their documentation, 2 frontends at least are using https://clojuredocs-edn.netlify.com/ endpoint for syntax highlighting. And as an alternative a new community driven documentation site https://cljdoc.org/ which is just amazing!
>>
>> On Mon, 30 Sep 2019 at 16:37, Steven Yi <stevenyi@gmail.com> wrote:
>>>
>>> Also an important issue is that a number of tools are built around the
>>> documentation. I know Blue uses a python script to read the
>>> documentation as XML and generate information it uses for syntax
>>> highlighting and presenting of opcode information to the user.  Also,
>>> I depend upon the HTML output organization with opcode entries going
>>> to files with [opcodename].html.  I think CsoundQt and Cabbage may be
>>> in the same boat, perhaps others.
>>>
>>> This is to say that the documentation is not just a format for output
>>> to the print/screen manual, but also a data source too.  I'm all for
>>> transitioning the documentation to a new format as long as we also
>>> keep the data aspect in mind.
>>>
>>> On Mon, Sep 30, 2019 at 9:31 AM Victor Lazzarini <Victor.Lazzarini@mu.ie> wrote:
>>> >
>>> > I think it could be time to move on, but it looks like a big job to move to a different format. I think two
>>> > things are essential:
>>> >
>>> > 1. easy to edit and to add reference pages
>>> > 2. easy to render to all formats we need (plus others as a bonus)
>>> >
>>> > I think leading this change is probably a job for whoever takes on as editor.
>>> > ========================
>>> > Prof. Victor Lazzarini
>>> > Maynooth University
>>> > Ireland
>>> >
>>> > > On 30 Sep 2019, at 13:54, Hlöðver Sigurðsson <hlolli@gmail.com> wrote:
>>> > >
>>> > > I discussed it with some people, that it makes sense to go for another format than docbook. Could be json, yaml or even python dictionary. From a more programmating format its easy to render various formats. As well, for front ends to generate syntax highlighting and minidocs. XML is becoming too arcane imo.
>>> > >
>>> > > On Mon, 30 Sep 2019 at 12:17, Eduardo Moguillansky <eduardo.moguillansky@gmail.com> wrote:
>>> > > On 30.09.19 11:28, Victor Lazzarini wrote:
>>> > > > Good resolutions. A few comments from me.
>>> > > >
>>> > > > 1. We need a manual editor/maintainer. François has been kindly building the
>>> > > > releases, but I think we do not have anyone leading editorial decisions and
>>> > > > organising the manual. All the things listed there need quite a bit of work and
>>> > > > the reason they have not been done is because no one is taking the editor’s
>>> > > > job. That should be a recognised position, and named at the top of the manual,
>>> > > > e.g.
>>> > > >
>>> > > > Csound Reference Manual
>>> > > > Jane Doe, Editor
>>> > > >
>>> > > > and a recognised publication, possibly with DOI etc. that we can cite.
>>> > >
>>> > > Would it be thinkable to convert the manual to a different format?
>>> > > docbook takes really too long to build and there does not seem to be any
>>> > > way to parallelize it. There is also a lot of manual indexing involved
>>> > > that could be automated (adding an opcode to a specific category, adding
>>> > > it to the global list of opcodes, etc)
>>> > >
>>> > > 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
>>> >
>>> >
>>> > 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
>>
>> 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
>
> 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
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

Date2019-10-05 10:39
FromVictor Lazzarini
SubjectRe: [Csnd] ICSC2019 Dev Table resolution
There's already a number of women composers active on
this list. We'd like to hear more from all of you.

Prof. Victor Lazzarini
Maynooth University
Ireland

On 5 Oct 2019, at 10:21, Marijana Janevska <marijana.janevska90@gmail.com> wrote:

Dear all,

 

Thank you all for the strong support!!! We discussed on this subject yesterday at Joachim’s class and me and few other students will start with revising the Manual, reading through it, commenting, and writhing what could be improved, also writing interesting examples. I already started with collecting material for the videos and will make a few of them, that would be helpful for beginners… I will also try to contact the female composes working with Csound and maybe initiate a meeting, or something… (Oeyvind thank you for suggesting Anna Xambó, I will get in touch with her, and if anyone else thinks of another one please feel free to share…)

I will update you on all of these things soon…

Warm greetings,

Marijana


On Fri, Oct 4, 2019 at 5:44 PM Steven Yi <stevenyi@gmail.com> wrote:
Dear Marijana,

This all sounds fantastic. I particularly like the initiative to help
the diversity of representation in this community. Hopefully everyone,
regardless of identity, will feel encouraged to participate and share
online and in person at future gatherings and conferences.

A video tutorials team collaboration would be great I think.  Any of
these tasks can be onerous for one person, but perhaps a few people
together can make this not too much.  I think a common production on
videos would be nice.  However, I think anyone should feel encouraged
to produce their own videos too, and we can give them visibility on
the csound.com site by having a list of video playlists. (Just
thinking out loud here.)

All best and thanks again for your initiative!

Steven



On Thu, Oct 3, 2019 at 5:52 AM Marijana Janevska
<marijana.janevska90@gmail.com> wrote:
>
> Dear Csounders,
>
>
>
> I would like to help in the revision of the manual and write more nice examples for it. And I think some of the other students of Joachim are going to be interested in doing this, so we’ll discuss this in our class, see who is interested and divide the job…
>
> Making videos and tutorials for the Youtube channel is very important for the new Csounders. And if there is an official Youtube channel, I think it is important that the videos that are being made are outlined in more or less the same form. For example, if it is a video for “How to do FM in Csound”, then there is a brief description of what FM is and how to do it in Csound using different opcodes and some examples for that… But it is important that this is taken in consideration before the videos are being made… I am highly supportive of this and can do some videos myself…
>
> Csound Summer School is a great idea!
>
> And another thing that I noticed is that there are very few female composers that are active in the community and I am willing to take the initiative to encourage female composers to be more included and active and maybe in some of the future Csound conferences (or in the Summer School) we organize a concert for female composers… just an idea…
>
> And thank you everyone for the amazing energy on the conference! It was a pleasure to meet you all!
>
>
>
> All the best,
>
> Marijana Janevska
>
>
> On Mon, Sep 30, 2019 at 5:43 PM Victor Lazzarini <Victor.Lazzarini@mu.ie> wrote:
>>
>> Another point is to look for formats/toolchains that are standard and widely used.
>>
>> The mistake would be to have a dependency that suddenly is not maintained anymore.
>>
>> Prof. Victor Lazzarini
>> Maynooth University
>> Ireland
>>
>> On 30 Sep 2019, at 16:13, Hlöðver Sigurðsson <hlolli@gmail.com> wrote:
>>
>> that's true, I would not want to abandon static html output at all. I think all the frontends would benefit from a modern queryable programmatic format.
>>
>> Thanks for pointing that out.
>>
>> A source of inspiration is what the clojure community has been doing with their documentation, 2 frontends at least are using https://clojuredocs-edn.netlify.com/ endpoint for syntax highlighting. And as an alternative a new community driven documentation site https://cljdoc.org/ which is just amazing!
>>
>> On Mon, 30 Sep 2019 at 16:37, Steven Yi <stevenyi@gmail.com> wrote:
>>>
>>> Also an important issue is that a number of tools are built around the
>>> documentation. I know Blue uses a python script to read the
>>> documentation as XML and generate information it uses for syntax
>>> highlighting and presenting of opcode information to the user.  Also,
>>> I depend upon the HTML output organization with opcode entries going
>>> to files with [opcodename].html.  I think CsoundQt and Cabbage may be
>>> in the same boat, perhaps others.
>>>
>>> This is to say that the documentation is not just a format for output
>>> to the print/screen manual, but also a data source too.  I'm all for
>>> transitioning the documentation to a new format as long as we also
>>> keep the data aspect in mind.
>>>
>>> On Mon, Sep 30, 2019 at 9:31 AM Victor Lazzarini <Victor.Lazzarini@mu.ie> wrote:
>>> >
>>> > I think it could be time to move on, but it looks like a big job to move to a different format. I think two
>>> > things are essential:
>>> >
>>> > 1. easy to edit and to add reference pages
>>> > 2. easy to render to all formats we need (plus others as a bonus)
>>> >
>>> > I think leading this change is probably a job for whoever takes on as editor.
>>> > ========================
>>> > Prof. Victor Lazzarini
>>> > Maynooth University
>>> > Ireland
>>> >
>>> > > On 30 Sep 2019, at 13:54, Hlöðver Sigurðsson <hlolli@gmail.com> wrote:
>>> > >
>>> > > I discussed it with some people, that it makes sense to go for another format than docbook. Could be json, yaml or even python dictionary. From a more programmating format its easy to render various formats. As well, for front ends to generate syntax highlighting and minidocs. XML is becoming too arcane imo.
>>> > >
>>> > > On Mon, 30 Sep 2019 at 12:17, Eduardo Moguillansky <eduardo.moguillansky@gmail.com> wrote:
>>> > > On 30.09.19 11:28, Victor Lazzarini wrote:
>>> > > > Good resolutions. A few comments from me.
>>> > > >
>>> > > > 1. We need a manual editor/maintainer. François has been kindly building the
>>> > > > releases, but I think we do not have anyone leading editorial decisions and
>>> > > > organising the manual. All the things listed there need quite a bit of work and
>>> > > > the reason they have not been done is because no one is taking the editor’s
>>> > > > job. That should be a recognised position, and named at the top of the manual,
>>> > > > e.g.
>>> > > >
>>> > > > Csound Reference Manual
>>> > > > Jane Doe, Editor
>>> > > >
>>> > > > and a recognised publication, possibly with DOI etc. that we can cite.
>>> > >
>>> > > Would it be thinkable to convert the manual to a different format?
>>> > > docbook takes really too long to build and there does not seem to be any
>>> > > way to parallelize it. There is also a lot of manual indexing involved
>>> > > that could be automated (adding an opcode to a specific category, adding
>>> > > it to the global list of opcodes, etc)
>>> > >
>>> > > 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
>>> >
>>> >
>>> > 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
>>
>> 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
>
> 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
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