csound / manual

Csound Reference Manual (English)
Other
45 stars 28 forks source link

change See Also section #625

Closed tjingboem closed 2 months ago

tjingboem commented 2 years ago

Regarding the See Also section: a lot of times related opcodes are not present, and often because a related opcode was created after an opcode and this list was not updated.

A better solution would be to change the See Also section to have a link to that group of opcodes as mentioned in the Opcodes Overview section. This list is kept up to date. From there, the user can hop to a few opcodes of which he/she thinks is the most appropriate for the case he/she is working on. And hop back if this turns out not to be the correct one after all.

Adding all related opcodes to a manual page clutters the screen IMO

For table this See Also section would get a link to: Screenshot from 2022-07-29 11-48-08

joachimheintz commented 2 years ago

thanks for mentioning this issue! i was thinking from time to time (= when i was on a reference page and looked for alternative opcodes) how we can update it. but it is such a lot of work ...

it sounds reasonable for me what you suggest. main point in my opinion is that it is one place where these important cross references are collected, and that we point to this place.

On 29/07/2022 13:54, Menno Knevel wrote:

Regarding the See Also section: a lot of times related opcodes are not present, and often because a related opcode was created after an opcode and this list was not updated.

A better solution would be to change the See Also section creating a link to that group of opcodes as mentioned in the Opcodes Overview section. This list is kept up to date.

Adding all related opcodes to a manual page clutters the screen IMO

For /table/ this See Also section would get a link to: Screenshot from 2022-07-29 11-48-08 https://user-images.githubusercontent.com/6670911/181752851-9839bf20-a298-4b3b-a11f-2defa8bc4c54.png

— Reply to this email directly, view it on GitHub https://github.com/csound/manual/issues/625, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAQYHKRJPBDXAZIO6O4JLTTVWPA5TANCNFSM55AQIMFA. You are receiving this because you are subscribed to this thread.Message ID: @.***>

tjingboem commented 1 year ago

Right. And another nice side effect is that the opcodes Overview gets really tight in with the opcode manual pages- giving it even more meaning.

If this Part II. Opcodes Overview is kept up to date, the user that is looking on a manual page for a certain opcode, will likely find the relevant opcode faster.

csounder commented 1 year ago

This would be wonderful. I am always looking for, and checking out, the related opcodes at the bottom of each manpage - this might be an even more effective and helpful solution.

tjingboem commented 1 year ago
csounder commented 1 year ago

Wow! So great in time for 6.18 !

Dr. Richard Boulanger Professor Electronic Production and Design Berklee College of Music

On Aug 30, 2022, at 2:48 PM, Menno Knevel @.***> wrote:

 Signal Generators Additive Synthesis/Resynthesis Basic Oscillators Dynamic Spectrum Oscillators FM Synthesis Granular Synthesis Hyper Vectorial Synthesis Linear and Exponential Generators Envelope Generators Models and Emulations Phasors Random (Noise) Generators Sample Playback Soundfonts Scanned Synthesis Table Access Wave Terrain Synthesis Waveguide Physical Modeling Signal Input and Output File Input and Output Signal Input Signal Output Software Bus Printing and Display Sound File Queries Signal Modifiers Amplitude Modifiers and Dynamic processing Convolution and Morphing Delay Panning and Spatialization Reverberation Sample Level Operators Signal Limiters Special Effects Standard Filters Specialized Filters Waveguides Waveshaping and Phase Distortion Instrument Control Clock Control Conditional Values Duration Control Statements FLTK Widgets and GUI controllers FLTK Containers FLTK Valuators Other FLTK Widgets Modifying FLTK Widget Appearance General FLTK Widget-related Opcodes Instrument Invocation Program Flow Control Real-time Performance Control Initialization and Reinitialization Sensing and Control Stacks Sub-instrument Control Time Reading Function Table Control Table Queries Read/Write Operations Table Reading with Dynamic Selection Mathematical Operations Amplitude Converters Arithmetic and Logic Operations Comparators and Accumulators Mathematical Functions Opcode Equivalents of Functions Random Functions Trigonometric Functions Linear Algebra Opcodes — Scalar, vector, and matrix arithmetic on real and complex values. Array Opcodes Pitch Converters Functions Tuning Opcodes Real-time MIDI Support Virtual MIDI Keyboard MIDI input MIDI Message Output Generic Input and Output Converters Event Extenders Note-on/Note-off Output MIDI/Score Interoperability opcodes System Realtime Messages Slider Banks Spectral Processing Short-time Fourier Transform (STFT) Resynthesis Linear Predictive Coding (LPC) Resynthesis Non-standard Spectral Processing Tools for Real-time Spectral Processing (pvs opcodes) ATS Spectral Processing Array-based spectral opcodes Strings String Manipulation Opcodes String Conversion Opcodes Vectorial Opcodes Tables of vectors operators Operations Between a Vectorial and a Scalar Signal Operations Between two Vectorial Signals Vectorial Envelope Generators Limiting and wrapping of vectorial control signals Vectorial Control-rate Delay Paths Vectorial Random Signal Generators Zak Patch System Plugin Hosting DSSI and LADSPA for Csound OSC and Network Ableton Link Opcodes OSC Network Remote Opcodes Mixer Opcodes Signal Flow Graph Opcodes Jacko Opcodes Python Opcodes Introduction Orchestra Syntax Image processing opcodes STK Opcodes Miscellaneous opcodes — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you commented.

tjingboem commented 3 months ago

i think it will be ready for 7.0.