Csound Csound-dev Csound-tekno Search About

[Csnd-dev] should there be a NEW introduction to CS7 manual?

Date2024-10-23 19:46
Fromjoachim heintz
Subject[Csnd-dev] should there be a NEW introduction to CS7 manual?
i feel that it would be good to have a more clear structure in the first 
section of the csound manual.  this is my suggestion:

Introduction
     What's New in Csound 7
     Historical Preface
     History of the Manual
     Copyright Notice

Invoking Csound
     How Csound Works
     The `.csd` File Format
     The `csound` Command
     Csound Options (flags) Alphabetically
     Csound Options (flags) by Category
     Environment Variables
     Order of Precedence

Syntax of the Orchestra
     Header Statements
     Global Space
     Instruments
     Data Types
     Variables
     Macros
     User Defined Opcodes (UDO)
     Traditional and Functional Code

Syntax of the Score
     Parameter Fields
     Preprocessing
     Statements
     Macros
     Included Files

a first draft (not at all complete) can be seen at 
https://joachimheintz.github.io/CS7_Manual/

is it worth to continue?
	joachim

Date2024-10-23 20:01
Fromtjingboem
SubjectRe: [Csnd-dev] should there be a NEW introduction to CS7 manual?
i definitely agree and it is a good idea to build this from the ground up. 
Your approach looks clean.
I made some comments in https://github.com/csound/manual/wiki/Manual-Changes-for-Csound-7 but i can not keep up with the speed you are working in :-)






On Wed, Oct 23, 2024 at 8:46 PM joachim heintz <jh@joachimheintz.de> wrote:
i feel that it would be good to have a more clear structure in the first
section of the csound manual.  this is my suggestion:

Introduction
     What's New in Csound 7
     Historical Preface
     History of the Manual
     Copyright Notice

Invoking Csound
     How Csound Works
     The `.csd` File Format
     The `csound` Command
     Csound Options (flags) Alphabetically
     Csound Options (flags) by Category
     Environment Variables
     Order of Precedence

Syntax of the Orchestra
     Header Statements
     Global Space
     Instruments
     Data Types
     Variables
     Macros
     User Defined Opcodes (UDO)
     Traditional and Functional Code

Syntax of the Score
     Parameter Fields
     Preprocessing
     Statements
     Macros
     Included Files

a first draft (not at all complete) can be seen at
https://joachimheintz.github.io/CS7_Manual/

is it worth to continue?
        joachim

Date2024-10-23 20:05
Fromtjingboem
SubjectRe: [Csnd-dev] should there be a NEW introduction to CS7 manual?
Is there a way to run examples from this new manual?

On Wed, Oct 23, 2024 at 9:01 PM tjingboem <magknevel@gmail.com> wrote:
i definitely agree and it is a good idea to build this from the ground up. 
Your approach looks clean.
I made some comments in https://github.com/csound/manual/wiki/Manual-Changes-for-Csound-7 but i can not keep up with the speed you are working in :-)






On Wed, Oct 23, 2024 at 8:46 PM joachim heintz <jh@joachimheintz.de> wrote:
i feel that it would be good to have a more clear structure in the first
section of the csound manual.  this is my suggestion:

Introduction
     What's New in Csound 7
     Historical Preface
     History of the Manual
     Copyright Notice

Invoking Csound
     How Csound Works
     The `.csd` File Format
     The `csound` Command
     Csound Options (flags) Alphabetically
     Csound Options (flags) by Category
     Environment Variables
     Order of Precedence

Syntax of the Orchestra
     Header Statements
     Global Space
     Instruments
     Data Types
     Variables
     Macros
     User Defined Opcodes (UDO)
     Traditional and Functional Code

Syntax of the Score
     Parameter Fields
     Preprocessing
     Statements
     Macros
     Included Files

a first draft (not at all complete) can be seen at
https://joachimheintz.github.io/CS7_Manual/

is it worth to continue?
        joachim

Date2024-10-23 20:13
Fromjoachim heintz
SubjectRe: [Csnd-dev] should there be a NEW introduction to CS7 manual?
in general yes, i think.
but changing from docbook to markdown would be a big step and a lot of work.
i just wanted to work on this introduction with a tool which i know and 
which is straightforward.


On 23/10/2024 21:05, tjingboem wrote:
> Is there a way to run examples from this new manual?
> 
> On Wed, Oct 23, 2024 at 9:01 PM tjingboem  > wrote:
> 
>     i definitely agree and it is a good idea to build this from the
>     ground up.
>     Your approach looks clean.
>     I made some comments in
>     https://github.com/csound/manual/wiki/Manual-Changes-for-Csound-7
>     
>     but i can not keep up with the speed you are working in :-)
> 
> 
> 
> 
> 
> 
>     On Wed, Oct 23, 2024 at 8:46 PM joachim heintz      > wrote:
> 
>         i feel that it would be good to have a more clear structure in
>         the first
>         section of the csound manual.  this is my suggestion:
> 
>         Introduction
>               What's New in Csound 7
>               Historical Preface
>               History of the Manual
>               Copyright Notice
> 
>         Invoking Csound
>               How Csound Works
>               The `.csd` File Format
>               The `csound` Command
>               Csound Options (flags) Alphabetically
>               Csound Options (flags) by Category
>               Environment Variables
>               Order of Precedence
> 
>         Syntax of the Orchestra
>               Header Statements
>               Global Space
>               Instruments
>               Data Types
>               Variables
>               Macros
>               User Defined Opcodes (UDO)
>               Traditional and Functional Code
> 
>         Syntax of the Score
>               Parameter Fields
>               Preprocessing
>               Statements
>               Macros
>               Included Files
> 
>         a first draft (not at all complete) can be seen at
>         https://joachimheintz.github.io/CS7_Manual/
>         
> 
>         is it worth to continue?
>                  joachim
> 

Date2024-10-24 11:12
Fromtjingboem
SubjectRe: [Csnd-dev] should there be a NEW introduction to CS7 manual?


On Wed, Oct 23, 2024 at 9:13 PM joachim heintz <jh@joachimheintz.de> wrote:
>
> in general yes, i think.
> but changing from docbook to markdown would be a big step and a lot of work.
> i just wanted to work on this introduction with a tool which i know and
> which is straightforward.


I agree this is the way to go forward.
I also am looking ahead for what other options this new manual can have.

Found on the internet: Markdown's Code Execution: Based on the provided search results, Markdown itself does not have the capability to execute code. Markdown is a lightweight markup language used for formatting text, not for executing code.
However, some Markdown processors and editors, such as GitLab, R Markdown, and Visual Studio Code, can integrate code execution features through extensions or plugins. These features allow you to write code blocks in Markdown files and execute them, often with syntax highlighting and support for specific programming languages.


Re the new manual, for me it would make sense to, at one point, take out all the plugin manual pages of the main manual.  They can have their own manual and should find a place in https://github.com/csound/plugins.
Plugin opcodes like FLTK, the image opcodes etc.

For running the examples from the manual, another route could be an integration of these examples in CsoundQt?


>
>
> On 23/10/2024 21:05, tjingboem wrote:
> > Is there a way to run examples from this new manual?
> >
> > On Wed, Oct 23, 2024 at 9:01 PM tjingboem <magknevel@gmail.com
> > <mailto:magknevel@gmail.com>> wrote:
> >
> >     i definitely agree and it is a good idea to build this from the
> >     ground up.
> >     Your approach looks clean.
> >     I made some comments in
> >     https://github.com/csound/manual/wiki/Manual-Changes-for-Csound-7
> >     <https://github.com/csound/manual/wiki/Manual-Changes-for-Csound-7>
> >     but i can not keep up with the speed you are working in :-)
> >
> >
> >
> >
> >
> >
> >     On Wed, Oct 23, 2024 at 8:46 PM joachim heintz <jh@joachimheintz.de
> >     <mailto:jh@joachimheintz.de>> wrote:
> >
> >         i feel that it would be good to have a more clear structure in
> >         the first
> >         section of the csound manual.  this is my suggestion:
> >
> >         Introduction
> >               What's New in Csound 7
> >               Historical Preface
> >               History of the Manual
> >               Copyright Notice
> >
> >         Invoking Csound
> >               How Csound Works
> >               The `.csd` File Format
> >               The `csound` Command
> >               Csound Options (flags) Alphabetically
> >               Csound Options (flags) by Category
> >               Environment Variables
> >               Order of Precedence
> >
> >         Syntax of the Orchestra
> >               Header Statements
> >               Global Space
> >               Instruments
> >               Data Types
> >               Variables
> >               Macros
> >               User Defined Opcodes (UDO)
> >               Traditional and Functional Code
> >
> >         Syntax of the Score
> >               Parameter Fields
> >               Preprocessing
> >               Statements
> >               Macros
> >               Included Files
> >
> >         a first draft (not at all complete) can be seen at
> >         https://joachimheintz.github.io/CS7_Manual/
> >         <https://joachimheintz.github.io/CS7_Manual/>
> >
> >         is it worth to continue?
> >                  joachim
> >