Re: [Csnd-dev] [EXTERNAL] Re: [Csnd-dev] Manual for Csound 7

my thoughts are: yes, i miss the list of opcode xxx - short description as
well.

And i think your proposal is the best i have seen so far.

Also nice to see the Deprecated Opcodes & GEN Routines find their way back
again in a non-intrusive manner :-P


Perhaps we could change
Overview
- Opcodes
to
Overview
- Opcodes Categories

to make a bigger difference with
Reference
- Opcodes


i still think the A, B C etc in Appendices before every chapter should go.
Reason is that this makes sense in an analog book, but not in the digital
world.





On Sun, Apr 20, 2025 at 7:42 PM joachim heintz <[email protected]> wrote:

> hi menno, and all -
>
> i am back to this suggestion, and there is one point i am missing.
>
> we had in the csound6 manual a prominent section "Reference" (it was the
> third section after "Overview" and "Opcodes Overview").
>
> actually, for daily usage i mostly looked at this Reference.  it was
> good that it was not only the alphabetic opcode index, but showed the
> short description, too.  for instance:
>
> "sandpaper — Semi-physical model of a sandpaper sound."
>
> @françois: is it possible to have this kind of overview?  so
> - alphabetically as in https://csound.com/manual/opcodesIndex/
> - but one line per opcode and
> - with the short description
>
> and i think this Reference section needs a prominent place in the
> manual, so i would suggest this outline:
>
> Introduction (detailed as in menno's list)
> Csound System (as in menno's list)
> Overview
> - Opcodes (detailed as in menno's list)
> - GEN Routines
> - Utilities
> Reference
> - Opcodes
> - Score Statements
> - GEN Routines
> - Utilities
> - Deprecated Opcodes
> - Deprecated GEN Routines
> Appendices
> - Opcodes Quick Reference
> - and then as in menno's list
>
> thoughts?
>         joachim
>
>
> On 16/04/2025 11:01, Menno Knevel wrote:
> > Hi all,
> > i sat down and took a moment to reflect on how to get a more transparent
> manual index; what is shown to the user when looking at the Csound Manual.
> > So, continuing the path of the present beta Csound7 manual
> https://csound.com/manual/, i came up with re-distributing of some
> chapters and simplifying the start screen . The tree of the manual has a
> max depth of 3.
> >
> > I can not attach anything in this list, so i hope the copy-paste of my
> .odt is without error.
> >
> > Feedback appreciated.
> >
> > ==============================
> >
> >
> > Introduction
> >               What’s new
> >               Historical
> >                               Preface
> >                               Manual
> >                                               Nomenclature
> >               Copyright/ Links
> > Csound System
> >               How Csound Works
> >               Configuring
> >               Real-Time Audio
> >               The ‘csound’ Command
> >               The ‘csd’ File Format
> >               Csound Options (flags)
> >                               Alphabetically
> >                               By Category
> >               Guard Point in Tables
> >               Environment Variables
> >               Order of Precedence
> >               UDP Server
> >               Syntax of the Orchestra
> >                               Header Statements and Global Space
> >                               Instruments
> >                               Data Types and Variables
> >                               Macros
> >                               User Defined Opcodes (UDO)
> >                               Traditional and Functional Code
> >               Syntax of the Score
> >                               Parameter Fileds
> >                               Durations in Instrument Events
> >                               Amplitude Values
> >                               Preprocessing
> >                               List of Statements
> >                               Macros
> >                               Included Files
> >                               Expressions
> >                               Scripts
> >                               Csbeats
> > Opcodes Overview
> >               Signal Generators
> >               Signal Input/Output
> >               Signal Modifiers
> >               Instrument Control
> >               Functional Table Control
> >               Mathematical Operations
> >               Pitch Converters
> >               Real-Time MIDI
> >               Spectral Processing
> >               Strings
> >               Vectorial Opcodes
> >               Zak Patch System
> >               OSC, Network and non-MIDI deveices
> >               Signal Flow Graph Opcodes
> >               Mixer Opcodes
> >               Miscellaneous Opcodes
> > GEN Routine Overview
> > Utility Programs
> >               About
> >               Analysis File Generation
> >               File Queries
> >               File Conversion
> >               Other Csound Utilities
> > Opcodes Index
> > Opcodes Quick Reference
> > GEN Routine Index
> > Appendices
> >               List of Examples
> >               Pitch Conversion
> >               Sound Intensity Values
> >               Formant Values
> >               Modal Frequency Ratios
> >               Window Functions
>