First wave of changes #22
Conversation
…g formats for the glossary
… keyboard mode, solved some TODOs and comments
|
|
||
| [glossary] | ||
| Key:: A possible input to Zyn-Fusion, with a specific notation (eg. A4, G#2, etc). Practically, it's the same thing as a note. |
There was a problem hiding this comment.
I'm not proposing a change, but for elsewhere in the docs be aware that this is an overloaded term and may be used to talk about a whole scale in the microtonal sections of the app.
| Timbre:: The percieved quality of a sound. Different oscillators produce different timbres. | ||
| VU meter:: A meter that displays the average level of an audio signal. | ||
| Voice:: A single instance of sound a synth can produce. If you are limited to three voices, you can only play three notes at one time and expect to hear them in the final sound. |
There was a problem hiding this comment.
That's the primary usage, but same as the last comment be aware that this gets overloaded to include a smaller contributing element within the add synth engine.
There was a problem hiding this comment.
Could you elaborate on this? What changes would you propose?
There was a problem hiding this comment.
For definitions that have multiple usages I'd mention the options in the definition. e.g. voice in most synths is typically an instance of something producing a sound, but in zyn it also refers to a piece of add synth where each voice in an add synth instance features one oscillator and one modulating oscillator.
Manual.adoc
Outdated
| === Synthesizer Modules | ||
| include::SynthesizerModules.adoc[] | ||
| // === Synthesizer Modules | ||
| // include::SynthesizerModules.adoc[] |
There was a problem hiding this comment.
I'm guessing that commenting these out is part of the WIP nature of this PR?
There was a problem hiding this comment.
Yes, as I finish each part up, I uncomment the next one. Makes the PDF and TOC more managable, since the WIP content is always at the bottom and not somewhere in the middle of the doc.
UserInterface.adoc
Outdated
| When you run Zyn-Fusion you'll be presented with this window: | ||
|
|
||
| // TODO: Color the elements here and use the colors as help. |
There was a problem hiding this comment.
I think one of the plans with the automated screen capture wasn't recoloring, but making it semi-easy to draw bounding boxes around areas you wanted to highlight to users. I do not recall the status of that functionality however.
There was a problem hiding this comment.
Understandable, thank you for letting me know! I won't force such a functionality, then.
| Master VU meter:: | ||
| This meter will display the current audio output levels. It can be useful for a few things: | ||
| * It'll let you decide on choosing an optimal sound level for your patch. | ||
| * It might be helpful to find out which instance of Zyn-Fusion is currently making sounds, if you're working with a few of them at once. | ||
| * It'll help you make sure your MIDI keyboard is connected properly. | ||
|
|
||
| VOLUME slider:: |
There was a problem hiding this comment.
although the UI does use shoutcase (mostly for typographic reasons), I'm not 100% sure if it's the best for the manual.
There was a problem hiding this comment.
Alright, I'll switch it back!
UserInterface.adoc
Outdated
| Learn indicator:: | ||
| This indicator shows when automation learning is in progress. | ||
|
|
||
| // TODO: More info about this in the manual? |
There was a problem hiding this comment.
I'd say this is something that should be discussed in another tutorial
| This indicator shows when MIDI contoller learning is in progress. | ||
|
|
||
| // TODO: More info here | ||
| Learn indicator:: |
There was a problem hiding this comment.
I actually am a bit worried about this documentation style. It's something that I've done in the past and sort of burnt out of documentation work. Enumerating everything in front of the user tends to make hard to read documentation and with something at the scale of zynaddsubfx it makes it an impossible task for you as the documentor. I'd drop some of these elements if you don't have something to tell the user about in a narrative sense.
|
Thank you, I'll wait for your response on the question I've left, and then I'll correct everything! |
|
There is a commented-out segment in the effects relating to the effect routing dropdown menu, this should be checked at some point. |
|
Major changes to the file and TOC structure OTW. |
|
Slowly starting work on this again, it's gonna move at a snail's pace until my Linux machine is up and running, but I'll try to lay the foundation for speedy work in the future! |
|
Merged 👍 |
|
TY! Please also merge mruby-zest/mruby-zest-build#119 when possible! |
This first set of changes aims to finish all the "TODO" statements made in the manual, as well as make minor adjustments along the way. Once all the changes have been made, this PR is to be squashed and merged accordingly.
I ask the maintainers to not merge this until ready.