commit d09a172d03856747353889dca911573843808388
parent 2e39edcbc6f336bda52d14b3e4a48fc74d5008ba
Author: fundamental <[email protected]>
Date: Sun, 25 Sep 2011 09:42:37 -0400
Doc: getting documentation to compile again
Diffstat:
16 files changed, 76 insertions(+), 72 deletions(-)
diff --git a/doc/Makefile b/doc/Makefile
@@ -1,19 +1,23 @@
.PHONY: subdirs gen
-all: xhtml
+all: gen-files xhtml chunked pdf
+
+gen-files:
+ cd gen; make
+
xhtml: zynaddsubfx.txt envelope.txt intro.txt lfo.txt
asciidoc -a numbered -a toc -b xhtml11 \
- --conf-file=myconf.conf zynaddsubfx.txt
+ zynaddsubfx.txt
chunked:
asciidoc --doctype=article -b docbook \
--conf-file=myconf.conf zynaddsubfx.txt
+ rm -rf ./zynaddsubfx.chunked
mkdir ./zynaddsubfx.chunked
rm -f "./zynaddsubfx.chunked/*.html"
ln -s ../images/ zynaddsubfx.chunked/images
- cd "."
xsltproc --stringparam html.stylesheet "./docbook-xsl.css" \
--stringparam callout.graphics 0 \
--stringparam navig.graphics 0 \
@@ -30,7 +34,8 @@ pdf:
sed -e 's~^\\includegraphics~\\par\\noindent\{\} \\includegraphics~' | \
sed -e 's~includegraphics\[\]~includegraphics[scale=0.5]~' > tmp.tex
mv tmp.tex zynaddsubfx.tex
- latex zynaddsubfx.tex
+ pdflatex zynaddsubfx.tex
+ pdflatex zynaddsubfx.tex
clean:
rm -f *~ *html *pdf *xml *tex *log zynaddsubfx.chunked/images
diff --git a/doc/adsynth.txt b/doc/adsynth.txt
@@ -1,5 +1,5 @@
Add Synth
-=========
+---------
Additive Synthesis is one of the three major synthesis engines available in
ZynAddSubFX.
@@ -7,7 +7,7 @@ Overall it adds together several voices with an oscillator as their sound
source.
High Level (Global)
--------------------
+~~~~~~~~~~~~~~~~~~~
From a high level perspective, Add synth can be understood with this block
diagram:
@@ -24,7 +24,7 @@ This could lead one to think that ad-note is just a bunch of minor
postprocessing and at this level much of the sound generation is hidden.
Voices
-------
+~~~~~~
The voice gives access to a similar setup to the global parameters and then some
more, such as the modulator, oscillator, and unison features.
@@ -32,7 +32,7 @@ more, such as the modulator, oscillator, and unison features.
image:images/ad-voice.png[]
Modulation
-~~~~~~~~~~
+^^^^^^^^^^
Within the options for modulation, one can select:
* Morph
@@ -42,5 +42,8 @@ Within the options for modulation, one can select:
* Disabled
Unison
-~~~~~~
+^^^^^^
+
+Unison is useful in creating the chorus like sound of many simultaneous
+oscillators
diff --git a/doc/build.txt b/doc/build.txt
@@ -1,8 +1,8 @@
Appendix B: Building ZynAddSubFX
-================================
+--------------------------------
Introduction to CMake
----------------------
+~~~~~~~~~~~~~~~~~~~~~
********************************************************************
Note: This section is mostly copied from the OpenSceneGraph wiki, at:
@@ -15,7 +15,7 @@ from this a platform-specific build system. This build system can be in
the form of VisualStudio project files, Unix Makefiles or XCode project
files. CMake is able to automatically locate external dependencies, and
allows you to toggle on/off module compilation and configure various
-build options.
+build options.
The use of a unified build system has allowed to avoid build breakages
that were common in the previous build method of maintaining three
@@ -29,7 +29,7 @@ to use the development version of ZynAddSubFX and help contribute
to its testing and refinement, leading to a high-quality code base.
Quick start guide
------------------
+~~~~~~~~~~~~~~~~~
For the impatient ones, here is a quick guide on how to immediately
build ZynAddSubFX from source.
diff --git a/doc/controller.txt b/doc/controller.txt
@@ -1,11 +1,10 @@
Controller
-=========
-:Author: Paul Nasca
+---------
image::./images/uicontroller.png[]
General
--------
+~~~~~~~
* *ModWh*: Modullation Wheel depth
* *Exp MWh*: Exponental Modulation Wheel (changes modulation scale to
@@ -22,7 +21,7 @@ General
* *PWheelB.Rng (cents)*: Pitch Wheel Bend Range (cents; 100 cents = 1 halftone)
Portamento
-----------
+~~~~~~~~~~
* *Rcv.*: If the part receives portamento On/Off (65) controller
* *time*: The duration of the portamento
@@ -39,7 +38,7 @@ NOTE: The threshold refers to the frequencies and not to MIDI notes
Proportinal Portamento
-~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^
////
TODO: add graphs to explain prp.rate and prp. depth
////
@@ -49,7 +48,7 @@ TODO: add graphs to explain prp.rate and prp. depth
* *Prp. Dpth*: The divergence from
Resonance
----------
+~~~~~~~~~
* *CFdpth*: resonance center controller depth
* *BWdpth*: resonance bandwidth controller depth
diff --git a/doc/envelope.txt b/doc/envelope.txt
@@ -1,14 +1,13 @@
Envelopes
-=========
-:Author: Paul Nasca
+---------
Introduction
-------------
+~~~~~~~~~~~~
Envelopes control how the amplitude, the frequency, or the
filter changes over time.
Amplitude Envelopes
--------------------
+~~~~~~~~~~~~~~~~~~~
These envelopes controls the amplitude of the sound.
In ZynAddSubFX, amplitude envelopes can be linear or logarithmic.
@@ -27,7 +26,7 @@ After this, the last stage take place.
Frequency Envelopes
--------------------
+~~~~~~~~~~~~~~~~~~~
These envelopes controls the frequency (more exactly, the pitch) of
the oscillators.
@@ -48,7 +47,7 @@ to a certain
value
Filter Envelopes
-----------------
+~~~~~~~~~~~~~~~~
These envelopes controls the cutoff frequency of the filters and are divided
into
@@ -60,7 +59,7 @@ image:images/envelope3.png[Alt Text]
* *Release*: this stage begins on Note Off and glides the filter cutoff frequency of the note to a certain value
Freemode Envelopes
-------------------
+~~~~~~~~~~~~~~~~~~
For all envelope there is a mode that allows the user to set an arbitrary number of stages and control points. This mode is called Freemode.
@@ -69,7 +68,7 @@ image:images/envelope4.png[Alt Text]
Only stage that always remains defined is the Sustain, where the envelopes freezes until a Note Off event.
User Interface
---------------
+~~~~~~~~~~~~~~
All the envelope types has some common controls:
* *E*: Shows a window that you can view the real envelope shape or convert to free mode to edit it
diff --git a/doc/filter.txt b/doc/filter.txt
@@ -1,5 +1,5 @@
Filters
-=======
+-------
:Author: Mark McCurry
:Date: July 5, 2009
@@ -7,14 +7,14 @@ In ZynAddSubFX filters can be used at several different stages to
increase or decrease a defined set of frequencys.
Types
------
+~~~~~
ZynAddSubFX currently supports a wide set of filters that it can provide
image:images/filter0.png[]
Values
-------
+~~~~~~
Each of these filters will be affected by their Q values, number of poles, and
cutoff values.
@@ -29,6 +29,6 @@ poles:
image:images/filter2.png[]
User Interface
---------------
+~~~~~~~~~~~~~~
A picture of the UI will go here
diff --git a/doc/gen/Makefile b/doc/gen/Makefile
@@ -8,7 +8,7 @@ all:$(OBJECTS)
convert $(<:.tex=.dvi) -resize 200% -trim $@
rm $(<:.tex=.dvi) $(<:.tex=.log) $(<:.tex=.aux)
-.PHONY
+.PHONY: clean
clean:
rm -f *.png *~
diff --git a/doc/gen/ad-note.tex b/doc/gen/ad-note.tex
@@ -4,9 +4,9 @@
\begin{document}
\begin{pspicture}[showgrid=false](-5,-3)(12,3)
\psset{framesize=2 .65}
-\psfblock[fillstyle=solid,fillcolor=green](-4,1){inFq}{Note Fq.}
-\psfblock[fillstyle=solid,fillcolor=yellow](-4,0){lfoFq}{Fq. LFO}
-\psfblock[fillstyle=solid,fillcolor=red](-4,-1){envFq}{Fq. Env.}
+\psfblock(-4,1){inFq}{Note Fq.}
+\psfblock(-4,0){lfoFq}{Fq. LFO}
+\psfblock(-4,-1){envFq}{Fq. Env.}
\dotnode(-2.5,1){dot1}
\dotnode(-2.5,0){dot2}
@@ -17,14 +17,14 @@
\psfblock(2,0){flt}{Filter}
-\psfblock[fillstyle=solid,fillcolor=red](1,-2){envFl}{Filter Env.}
-\psfblock[fillstyle=solid,fillcolor=yellow](3,-2){lfoFl}{Filter LFO}
+\psfblock(1,-2){envFl}{Filter Env.}
+\psfblock(3,-2){lfoFl}{Filter LFO}
\pspolygon(4,1)(6,0)(4,-1)
\psfblock[linecolor=white](5,0){amp}{Amp}
-\psfblock[fillstyle=solid,fillcolor=red](4,2){envAmp}{Amp. Env.}
-\psfblock[fillstyle=solid,fillcolor=yellow](6,2){lfoAmp}{Amp. LFO}
+\psfblock(4,2){envAmp}{Amp. Env.}
+\psfblock(6,2){lfoAmp}{Amp. LFO}
\psfblock(7.5,0){pnch}{Punch}
diff --git a/doc/getting.txt b/doc/getting.txt
@@ -1,5 +1,5 @@
Appendix C: Getting ZynAddSubFX
-===============================
+-------------------------------
Usually there are several methods to obtain a copy of ZynAddSubFX.
@@ -11,7 +11,7 @@ Git::
git://zynaddsubfx.git.sourceforge.net/gitroot/zynaddsubfx/zynaddsubfx
Introduction to Git
--------------------
+~~~~~~~~~~~~~~~~~~~
For those who want to live on the bleeding edge or who want to assist with
making sure that the next release has fewer bugs, you will want to get aquanted
@@ -20,7 +20,7 @@ Git is used to manage the source code for this project and can be used to
quickly and easily get an up-to-date copy of the source code.
Getting the Source Code
-~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^
In order to get a copy of the ZynAddSubFX source code, all that needs to be done is:
@@ -35,7 +35,7 @@ You should now be in the directory of the source code.
For simple steps on building, please see Appendix B of the manual.
Checking out a branch
-~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^
Lets say that development has extended into the creation of a new feature that
you want to preview.
diff --git a/doc/intro.txt b/doc/intro.txt
@@ -1,11 +1,10 @@
Getting Started
-===============
-
+---------------
In most cases ZynAddSubFX is used it will not alone, and it will be linked
with other programs.
MIDI
-----
+~~~~
MIDI can be used to connect other applications to ZynAddSubFX.
Under ALSA on Linux the standard tool to connect ZynAddSubFX's MIDI is
@@ -18,6 +17,6 @@ ZynAddSubFX.
For more specific information see INSERT CHAPTER NAME HERE.
JACK
-----
+~~~~
JACK can be used to connect the output of ZynAddSubFX to other
applications.
diff --git a/doc/lfo.txt b/doc/lfo.txt
@@ -1,9 +1,9 @@
LFO
-===
+---
:author: Paul Nasca
Introduction
-------------
+~~~~~~~~~~~~
"LFO" means Low Frequency Oscillator.
These oscillators are not used to make sounds by themselves, but they changes
@@ -46,7 +46,7 @@ notes) to zero (the LFO frequency will be the same on all notes) to positive
stretch (the LFO frequency will be increased on higher notes).
User Interface
---------------
+~~~~~~~~~~~~~~
In ZynAddSubFX, LFO parameters are shown as:
diff --git a/doc/mididefaults.txt b/doc/mididefaults.txt
@@ -1,5 +1,5 @@
Appendex A: MIDI Defaults
-=========================
+-------------------------
.Default MIDI Connections
[literal]
@@ -7,7 +7,7 @@ Appendex A: MIDI Defaults
007 - Volume
010 - Pan
011 - Expression
-064 - Sustain
+064 - Sustain
065 - Portamento Enable
071 - Filter Q
074 - Filter Cutoff
diff --git a/doc/myconf.conf b/doc/myconf.conf
@@ -1,3 +1,2 @@
[titles]
-
underlines="__","==","--","~~","^^"
diff --git a/doc/nrpn.txt b/doc/nrpn.txt
@@ -1,6 +1,5 @@
NRPN (Non Registered Parameters Number)
-=======================================
-:Author: Paul Nasca
+---------------------------------------
NRPNs can control all system and insertion effect parameters.
For example, you may change the reverb time when playing to keyboard or
@@ -42,7 +41,7 @@ Most parameters has the range from 0 to 127.
When parameters have another range, it is written as [low...high] .
Reverb
-------
+~~~~~~
[verse]
+[orange]#00 - Volume or Dry/Wet (FC)#
@@ -59,7 +58,7 @@ Reverb
[red]#11 - Room Size (AC)#+
Echo
-----
+~~~~
[verse]
+[orange]#00 - Volume or Dry/Wet (FC)#
@@ -72,7 +71,7 @@ Echo
Chorus
-------
+~~~~~~
[verse]
+[orange]#00 - Volume or Dry/Wet (FC)#
@@ -89,7 +88,7 @@ Chorus
[red]#11 - Mode [0..1] (0=add, 1=subtract) (AC)#+
Phaser
-------
+~~~~~~
[verse]
+[orange]#00 - Volume or Dry/Wet (FC)#
@@ -106,7 +105,7 @@ Phaser
11 - Phase+
AlienWah
---------
+~~~~~~~~
[verse]
+[orange]#00 - Volume or Dry/Wet (FC)#
@@ -122,7 +121,7 @@ AlienWah
10 - Phase+
Distorsion
-----------
+~~~~~~~~~~
[verse]
+[orange]#00 - Volume or Dry/Wet (FC)#
@@ -137,7 +136,7 @@ Distorsion
09 - Mode [0.1] (0=mono,1=stereo)+
EQ
---
+~~
[verse]
+[orange]#00 - Gain (FC)#+
diff --git a/doc/saving.txt b/doc/saving.txt
@@ -1,11 +1,11 @@
Persistence
-===========
+-----------
As with most applications ZynAddSubFX allows for one to ave your work and reload
it.
Saving it all
--------------
+~~~~~~~~~~~~~
One of the simplest ways to save your work is to save the entire session.
This can be done through the File menu and will result in the creation of an
@@ -15,13 +15,13 @@ session, such as microtonal tunings, all patches, system effects, insertion
effects, etc...
Saving Parts
-------------
+~~~~~~~~~~~~
In many cases saving everything is not what is desired.
Saving a patch later on is one such example.
Patches
-~~~~~~~
+^^^^^^^
In order to save a patch, one can either save it from the instruments menu or
through the bank window.
@@ -36,7 +36,7 @@ File->Settings->Bank_Root_Dirs window to see the paths for banks.
NOTE: You need to have write permissions to add instruments to the bank.
Presets
-~~~~~~~
+^^^^^^^
Have a favorite setting for an envelope, a difficult to reproduce oscillator?
Then presets are for you.
Presets allow for one to save the settings for any of the components which
@@ -45,7 +45,7 @@ This is done with preset files (.xpz), which get stored in the folders indicated
by File->Settings->Preset_Root_Dirs.
Summary
--------
+~~~~~~~
.Extension Summary
[literal]
diff --git a/doc/zynaddsubfx.txt b/doc/zynaddsubfx.txt
@@ -1,9 +1,8 @@
Zynaddsubfx
-___________
-:Author: Paul Nasca
+===========
+:Author: Paul Nasca and Mark McCurry
-
-:titles.underlines: "__","==","--","~~","^^"
+This documentation is a work in progress
include::./intro.txt[]
@@ -17,7 +16,9 @@ include::./adsynth.txt[]
include::./controller.txt[]
+/////////////////////////////
include::./nrpn.txt[]
+/////////////////////////////
include::./saving.txt[]
