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

The Reference Section has been added. As Menno said, adding the functional
syntax should be done but it's a lot of work!
So I propose to postpone this feature for future enhancements...

For now, I have to write the guidelines for writing an opcodes notice so
that people can add new opcodes info. These opcodes are not yet documented:

arg, chnclear_array, cingoto, cnkgoto, complex, conj, create, createinstr,
ctlchn, declare, delete, earlysmps, floatsize, ftresize, ftresizei,
getinstance, getp, imag, instrnum, instrstr, loscil3phs, loscilphs, lpform,
midipgm, mp3bitrate, mp3nchnls, mp3sr, nlalp, nxtpow2, offsetsmps,
opcoderef,
otafilter, pause, perf, pgmchn, pitchac, play, polar, pows, print_type,
ptablew, pvsenvftw, pvsgendy, pvslock, readks, real, run, sc_lag, sc_lagud,
sc_phasor, sc_trig, sequstate, setp, slicearray_i, splice, str, strecv,
string2array, stsend, systime, table3kt, vdel_k.

One question: should we protect the develop branch of the manual like the
develop branch of the code, so that people can not directly commit but
instead send a PR which should be validated by a member of the
Documentation team?

Regards

François

Le lun. 21 avr. 2025 à 16:46, tjingboem <[email protected]> a écrit :

> yes we probably should add the functional syntax per opcode- ouch quite
> some work
>
> i guess we should show both syntaxes?
> Traditional: blah
> Functional: blah
>
> On Mon, Apr 21, 2025 at 4:09 PM Victor Lazzarini <
> [email protected]> wrote:
>
>> Should we convert all opcode syntax description lines to the Csound 7
>> syntax?
>>
>> e.g
>>
>> sig:a = oscili(amp:x, freq:x[, phase:i])
>> sig:k = oscili(amp:k, freq:k[, phase:i])
>>
>> and have somewhere saying that x is a,k, or i
>> and k is k or i.
>>
>> Prof. Victor Lazzarini
>> Maynooth University
>> Ireland
>>
>> On 21 Apr 2025, at 14:09, tjingboem <[email protected]> wrote:
>>
>> 
>> 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
>>>
>>