Use Scripts to generate all screenshots

zynaddsubfx · Nov 18, 2018 · 1cbb359 · 1cbb359
1 parent 57d02d9
commit 1cbb359
Show file tree

Hide file tree

Showing 75 changed files with 89 additions and 74 deletions.
diff --git a/ADDsynth.adoc b/ADDsynth.adoc
@@ -1,4 +1,4 @@
-image::imgs/20180413-144959.png[]
+image::imgs/add-synth.png[]
 * what is ADDsynth and why is it called this way?
 * signal routing diagram
 * global settings
@@ -7,4 +7,4 @@ image::imgs/20180413-144959.png[]
 * mod-osc
 * modulation
 * voice list
-* resonance
+* resonance
diff --git a/FilterModule.adoc b/FilterModule.adoc
@@ -1,36 +1,46 @@
 image::imgs/20180413-143939.png[]
 
 ==== Filter Classes
-.Filter Classes
-image::imgs/20180413-143956.png[]
 
 Zyn-Fusion features three classes of filters.
 
+State variable filters:: Limited filter types, but good under heavy modulation
+Analog filters:: Standard Biquad formulations for a variety of shapes
+Formant filters:: Good for modeling speech spectral shapes. Composed by many
+sub-filters.
+
 ===== Analog Filters
 
 // fundamental, could you fill this in? - unfa
+image::imgs/filter-analog.png[]
+
+LP1:: One pole low pass
+HP1:: One pole high pass
+LP2:: Two pole low pass
+HP2:: Two pole high pass
+BP::  Bandpass
+Notch:: Notch
+Peak:: Peak
+L.Shelf:: low shelf
+H.Shelf:: high shelf
 
 ===== State Variable Filters
 
 // fundamental, could you fill this in? - unfa
+image::imgs/filter-svf.png[]
 
-===== Formant Filter
-
-The formant filter is a separate class on it's own. It's a complex filter that will let you define presets of peak filters, arrange them in a sequence and then smoothly interpolate between them. This way you can apply very complex and animated filtering to shape the harmonic profile of your sounds and make it evolve over time. More on that later in this chapter.
-
-
+Low::  Two pole low pass
+High:: Two pole high pass
+Band:: Bandpass
+Notch:: Notch
 
-==== Analog Filter Types
-
-
-.Analog Filter Types
-image::imgs/20180413-144027.png[]
-==== State Variable filter types
-
-.State Variable Filter Types
-image::imgs/20180413-144058.png[]
-==== Formant filter
+===== Formant Filter
 
-The formant filter is a separate class on it's own. It's a complex filter that will let you define presets of peak filters, arrange them in a sequence and then smoothly interpolate between them. This way you can apply very complex and animated filtering to shape the harmonic profile of your sounds and make it evolve over time.
+The formant filter is a separate class on it's own.
+It's a complex filter that will let you define presets of peak filters,
+arrange them in a sequence and then smoothly interpolate between them.
+This way you can apply very complex and animated filtering to shape the
+harmonic profile of your sounds and make it evolve over time.
+More on that later in this chapter.
 
-image::imgs/20180413-144131.png[]
+image::imgs/20180413-144131.png[]
diff --git a/Kits.adoc b/Kits.adoc
@@ -1,5 +1,5 @@
-image::imgs/Selection_428b.png[]
+image::imgs/kit.png[]
 
 - [ ] What are kits?
 - [ ] No kits, Multi kit and Single Kit
-- [ ] What is Drum Mode?
+- [ ] What is Drum Mode?
diff --git a/Manual.adoc b/Manual.adoc
@@ -4,40 +4,40 @@
 == Introduction
 include::Introduction.adoc[]
 
-= Basic Topics
+== Basic Topics
 
-== User Interface
+=== User Interface
 include::UserInterface.adoc[]
 
-== Synthesizer Modules
+=== Synthesizer Modules
 include::SynthesizerModules.adoc[]
 
-== Synthesis Engines
+=== Synthesis Engines
 
-=== ADDsynth
+==== ADDsynth
 include::ADDsynth.adoc[]
 
-=== SUBsynth
+==== SUBsynth
 include::SUBsynth.adoc[]
 
-=== PADsynth
+==== PADsynth
 include::PADsynth.adoc[]
 
-== Part Settings
+=== Part Settings
 include::PartSettings.adoc[]
 
-== Kits
+=== Kits
 include::Kits.adoc[]
 
-== Presets and Banks
+=== Presets and Banks
 include::PresetsAndBanks.adoc[]
 
-== Settings
+=== Settings
 include::Settings.adoc[]
 
-= Glossary
+== Glossary
 include::Glossary.adoc[]
 
-= Advanced Topics
+== Advanced Topics
 
-// Once we have eveything written, we'll put here stuff that's unnecessarily detailed and would trip up new users
+// Once we have eveything written, we'll put here stuff that's unnecessarily detailed and would trip up new users
diff --git a/OscillatorModule.adoc b/OscillatorModule.adoc
@@ -1,4 +1,4 @@
-image::imgs/20180328-183503.png[]
+image::imgs/osc-overall.png[]
 
 This module creates cyclic waveforms. You might feel intimidated by how complex this thing looks. But don't worry - we're gonna break it down and you'll realize it's not very complicated.
 
@@ -24,4 +24,4 @@ As opposed to the Base Waveform, this displays your final waveform that will be
 
 Now let's dismantle this mysterious section in the middle:
 
-image::imgs/20180328-192654.png[]
+image::imgs/osc-tight.png[]
diff --git a/PADsynth.adoc b/PADsynth.adoc
@@ -1,3 +1,3 @@
-image::imgs/20180413-145036.png[]
+image::imgs/pad-synth.png[]
 * what is padsynth and why it's named this way?
-* signal routing diagram
+* signal routing diagram
diff --git a/PartSettings.adoc b/PartSettings.adoc
@@ -10,7 +10,7 @@ Part settings - among other things - let you determine how the part will respond
 
 To access the part settings, click on the "Part Settings" button in the sidebar
 
-image::imgs/Selection_440.png[]
+image::imgs/part-settings-button.png[]
 
 === What are parts?
 
@@ -22,17 +22,18 @@ ZynFusion is a multitimbre synthesizer - that means it can perform with multiple
 
 You can select and enable/disable parts using the grid dial below the "Part Settings" button:
 
-image::imgs/Selection_440a.png[]
+image::imgs/part-settings-selection.png[]
 
 Left-click will select the chosen part and let you interact with it. Middle-click will enable/disable the chosen part.
 
 ==== Part List
 
 When you open up the Part Settings panel, you'll see a list of all parts on the left side:
 
-image::imgs/Selection_440b.png[]
+image::imgs/part-settings-labelenable.png[]
 
-Clicking on a button with a Part's number will enable/disable that part. Clicking in the empty name fileds will select a part and bring up it's parameters in the rest of the panel.
+Clicking on a button with a Part's number will enable/disable that part.
+Clicking in the empty name fields will select a part and bring up it's parameters in the rest of the panel.
 
 You can also type in a name for your part here.
 
@@ -44,32 +45,28 @@ Parts can be viewed, enabled and renamed also in the Mixer view. More in the <<M
 
 === Naming parts
 
-Each part has a unique number, which cannot be changed, but can also be assigned a name. It's useful to name your parts when using more than one to keep thinkgs organized.
+Each part has a unique number, which cannot be changed, but can also be assigned a name. It's useful to name your parts when using more than one to keep things organized.
 
 To name a part, just click in the Part List and type in a name:
 
-image::imgs/Selection_440c.png[]
+image::imgs/part-settings-labelenable-close.png[]
 
-The name will be displayed in the Par List, and in the Mixer.
+The name will be displayed in the part list, and in the Mixer.
 
 
 === Instrument settings
 
 
-image::imgs/Selection_424a.png[]
+image::imgs/part-settings-instrument.png[]
 
 === Controllers
 
-image::imgs/Selection_425.png[]
+image::imgs/part-settings-controllers.png[]
 
 === Portamento
 
-image::imgs/Selection_426.png[]
+image::imgs/part-settings-portamento.png[]
 
 === Scale Settings
 
-image::imgs/Selection_427.png[]
-
-=== Tunings and Key mapping
-
-image::imgs/Selection_428.png[]
+image::imgs/part-settings-scale.png[]
diff --git a/SUBsynth.adoc b/SUBsynth.adoc
@@ -1,3 +1,3 @@
-image::imgs/20180413-145013.png[]
+image::imgs/sub-synth.png[]
 * what is subsynth and why it's named this way?
-* signal routing diagram
+* signal routing diagram
diff --git a/Settings.adoc b/Settings.adoc
@@ -2,10 +2,10 @@
 
 To access the settings view, click twice on the Zyn logo in the top left corner.
 
-image::imgs/Selection_435.png[]
+image::imgs/logo.png[]
 
 === Global Settings
-image::imgs/Selection_422.png[]
+image::imgs/settings-global.png[]
 
 These settings affect the whole ZynAddSubFX instance.
 
@@ -15,29 +15,36 @@ WARNING: Currently some of these parameters are read-only
 
 .Sample Rate
 The sample rate used by ZynAddSubFX engine. +
-The begger - the higher frequencies will be processed, introducing more DSP load in the system
+The bigger - the higher frequencies will be processed, introducing more DSP load in the system
 It's best to keep this the same as your soundcard is currently using to avoid needless resampling.
 
 .Swap stereo
 If you find your L and R channels to be the wrong way around, this option will fix it.
 
 .Oscil Size
-The size of the SUBsynth oscillator wavetable in samples. The bigger this is, the more high frequencies will be included in the SUBsynth osciallators. The bigger the wavetable, the more CPU-intensive SUBsynth becomes, but also playing very low notes will remain more high harmonics.
+The size of the SUBsynth oscillator wavetable in samples.
+The bigger this is, the more high frequencies will be included in the Add synth oscillators.
+The bigger the wavetable, the more CPU-intensive Add synth becomes, though
+harmonics will be represented more accurately.
 
 .Buffer Size
-Size of the internal DSP buffer of ZynAddSubFX in samples. Since the LFOs and Envelopes are updated only once every bufer this has impact on the sound. The smaller the buffer is, the better the time resolution of LFOs and ENVs. It also makes the latency lower. Making the buffer size bigger lowers the CPU usage in exchange for increating latency and making the LFOs and ENVs update less frequently.
+Size of the internal DSP buffer of ZynAddSubFX in samples.
+Since the LFOs and Envelopes are updated only once every buffer this has impact on the sound.
+The smaller the buffer is, the better the time resolution of LFOs and ENVs.
+It also makes the latency lower.
+Making the buffer size bigger lowers the CPU usage in exchange for increasing latency and making the LFOs and ENVs update less frequently.
 
 .XML compression
 ZynAddSubFX uses XML format to store the presets. This determines the level of Gzip (?) compression applied to it before saving to disk, to save storage space. Higher values create smaller files in exchange for more CPU time needed to save and open them. Lower values speed up save/load times but create bigger files.
 
 .Virtual Keyboard Layout
-This setting afects how Zyn-Fusion interprets input from your computer keyboard to emulate a musical keyboard.
+This setting affect how Zyn-Fusion interprets input from your computer keyboard to emulate a musical keyboard.
 
 .Ignore MIDI Program Change
-ZynAddSubFX would noramlly respond to MIDI Program Change messages and load a patch from a bank. This feature will enable you to prevent that.
+ZynAddSubFX would normally respond to MIDI Program Change messages and load a patch from a bank. This feature will enable you to prevent that.
 
 === Bank Settings
-image::imgs/Selection_423.png[]
+image::imgs/settings-bank-roots.png[]
 
 === Preset Settings
-image::imgs/Selection_424.png[]
+image::imgs/settings-preset-roots.png[]
diff --git a/SynthesizerModules.adoc b/SynthesizerModules.adoc
@@ -16,16 +16,17 @@ include::FilterModule.adoc[]
 
 === Envelope Module
 
-image::imgs/20180413-144343.png[]
+image::imgs/env.png[]
 * ADSR
 * Free mode
 
 === LFO Module
 
-image::imgs/20180413-144358.png[]
+image::imgs/lfo.png[]
+
 === amplifier (?)
 
-image::imgs/20180413-144157.png[]
+image::imgs/amp-control.png[]
 * vol
 * scale
 * pan

diff --git a/UserInterface.adoc b/UserInterface.adoc
@@ -2,7 +2,7 @@
 === Panels
 When you run Zyn-Fusion you'll be presented with this window:
 
-image::imgs/20180328-183524.png[]
+image::imgs/bank-read.png[]
 
 As you can see it is divided into multiple panels, each with their own use.
 When navigating between different _views_, you'll consistently see the status
@@ -16,7 +16,7 @@ The status panel is where you'll find a few global parameters, the file menu,
 automation-learn/fine-tuning mode selectors, the panic button, master VU meter,
 and the information tray.
 
-Panic button:: 
+Panic button::
     When getting started you'll want to be familiar with the panic button as
     it will instantly silence the audio produced by Zyn, no matter what state
     the synth is in. It's a safety device in case the sounds go out of control.
@@ -33,7 +33,7 @@ Learn indicator::
     This indicator shows when automation learning is in progress.
 Information Tray::
     The information tray will show tooltips about Zyn's parameters, current
-    parameter values, as well as other status information. image:imgs/Selection_437.png[]
+    parameter values, as well as other status information. image:imgs/info-tray.png[]
 
 ////
 .Screenshot todo
@@ -155,4 +155,4 @@ like view for the keybindings like discussed in
 https://tex.stackexchange.com/questions/44581/creating-keyboard-layout-diagrams
 
 ISSUE:: https://github.com/zynaddsubfx/user-manual/issues/7
-////
+////
diff --git a/imgs/20180328-183503.png b/imgs/20180328-183503.png
diff --git a/imgs/20180328-183524.png b/imgs/20180328-183524.png
diff --git a/imgs/20180328-192654.png b/imgs/20180328-192654.png
diff --git a/imgs/20180413-143645.png b/imgs/20180413-143645.png
diff --git a/imgs/20180413-143718.png b/imgs/20180413-143718.png
diff --git a/imgs/20180413-143738.png b/imgs/20180413-143738.png
diff --git a/imgs/20180413-143808.png b/imgs/20180413-143808.png
diff --git a/imgs/20180413-143824.png b/imgs/20180413-143824.png
diff --git a/imgs/20180413-143845.png b/imgs/20180413-143845.png
diff --git a/imgs/20180413-143905.png b/imgs/20180413-143905.png
diff --git a/imgs/20180413-143923.png b/imgs/20180413-143923.png
diff --git a/imgs/20180413-143956.png b/imgs/20180413-143956.png
diff --git a/imgs/20180413-144027.png b/imgs/20180413-144027.png
diff --git a/imgs/20180413-144058.png b/imgs/20180413-144058.png
diff --git a/imgs/20180413-144157.png b/imgs/20180413-144157.png
diff --git a/imgs/20180413-144343.png b/imgs/20180413-144343.png
diff --git a/imgs/20180413-144358.png b/imgs/20180413-144358.png
diff --git a/imgs/20180413-144421.png b/imgs/20180413-144421.png
diff --git a/imgs/20180413-144751.png b/imgs/20180413-144751.png
diff --git a/imgs/20180413-144959.png b/imgs/20180413-144959.png
diff --git a/imgs/20180413-145013.png b/imgs/20180413-145013.png
diff --git a/imgs/20180413-145036.png b/imgs/20180413-145036.png
diff --git a/imgs/Selection_422.png b/imgs/Selection_422.png
diff --git a/imgs/Selection_423.png b/imgs/Selection_423.png
diff --git a/imgs/Selection_423a.png b/imgs/Selection_423a.png
diff --git a/imgs/Selection_424.png b/imgs/Selection_424.png
diff --git a/imgs/Selection_424a.png b/imgs/Selection_424a.png
diff --git a/imgs/Selection_425.png b/imgs/Selection_425.png
diff --git a/imgs/Selection_426.png b/imgs/Selection_426.png
diff --git a/imgs/Selection_427.png b/imgs/Selection_427.png
diff --git a/imgs/Selection_428.png b/imgs/Selection_428.png
diff --git a/imgs/Selection_428b.png b/imgs/Selection_428b.png
diff --git a/imgs/Selection_435.png b/imgs/Selection_435.png
diff --git a/imgs/Selection_437.png b/imgs/Selection_437.png
diff --git a/imgs/Selection_440.png b/imgs/Selection_440.png
diff --git a/imgs/Selection_440a.png b/imgs/Selection_440a.png
diff --git a/imgs/Selection_440b.png b/imgs/Selection_440b.png
diff --git a/imgs/Selection_440c.png b/imgs/Selection_440c.png
diff --git a/imgs/add-synth.png b/imgs/add-synth.png
diff --git a/imgs/amp-control.png b/imgs/amp-control.png
diff --git a/imgs/bank-read.png b/imgs/bank-read.png
diff --git a/imgs/env.png b/imgs/env.png
diff --git a/imgs/filter-analog.png b/imgs/filter-analog.png
diff --git a/imgs/filter-formant.png b/imgs/filter-formant.png
diff --git a/imgs/filter-svf.png b/imgs/filter-svf.png
diff --git a/imgs/info-tray.png b/imgs/info-tray.png
diff --git a/imgs/kit.png b/imgs/kit.png
diff --git a/imgs/lfo.png b/imgs/lfo.png
diff --git a/imgs/logo.png b/imgs/logo.png
diff --git a/imgs/osc-overall.png b/imgs/osc-overall.png
diff --git a/imgs/osc-tight.png b/imgs/osc-tight.png
diff --git a/imgs/pad-synth.png b/imgs/pad-synth.png
diff --git a/imgs/part-settings-button.png b/imgs/part-settings-button.png
diff --git a/imgs/part-settings-controllers.png b/imgs/part-settings-controllers.png
diff --git a/imgs/part-settings-instrument.png b/imgs/part-settings-instrument.png
diff --git a/imgs/part-settings-labelenable-close.png b/imgs/part-settings-labelenable-close.png
diff --git a/imgs/part-settings-labelenable.png b/imgs/part-settings-labelenable.png
diff --git a/imgs/part-settings-portamento.png b/imgs/part-settings-portamento.png
diff --git a/imgs/part-settings-scale.png b/imgs/part-settings-scale.png
diff --git a/imgs/part-settings-selection.png b/imgs/part-settings-selection.png
diff --git a/imgs/settings-bank-roots.png b/imgs/settings-bank-roots.png
diff --git a/imgs/settings-global.png b/imgs/settings-global.png
diff --git a/imgs/settings-preset-roots.png b/imgs/settings-preset-roots.png
diff --git a/imgs/sub-synth.png b/imgs/sub-synth.png