helpdocs: remove use of old formula:: tag

Most of them expressed the formula as code, so I replaced them with code:: for now. Someone who speaks TeX math will need to convert them to math:: instead. (cherry picked from commit 5c84bd1)
supercollider · Feb 8, 2012 · da17ded · da17ded
1 parent 2004e21
commit da17ded
Show file tree

Hide file tree

Showing 30 changed files with 33 additions and 45 deletions.
diff --git a/HelpSource/Classes/AmpComp.schelp b/HelpSource/Classes/AmpComp.schelp
@@ -8,7 +8,7 @@ Description::
 
 Implements the (optimized) formula:
 
-formula::
+code::
 compensationFactor = (root / freq) ** exp
 ::
 

diff --git a/HelpSource/Classes/BPZ2.schelp b/HelpSource/Classes/BPZ2.schelp
@@ -8,7 +8,7 @@ Description::
 
 A special case fixed filter. Implements the formula:
 
-formula::
+code::
 out(i) = 0.5 * (in(i) - in(i - 2)).
 ::
 

diff --git a/HelpSource/Classes/BRZ2.schelp b/HelpSource/Classes/BRZ2.schelp
@@ -8,7 +8,7 @@ Description::
 
 A special case fixed filter. Implements the formula:
 
-formula::
+code::
 out(i) = 0.5 * (in(i) + in(i - 2)).
 ::
 

diff --git a/HelpSource/Classes/BufSamples.schelp b/HelpSource/Classes/BufSamples.schelp
@@ -6,7 +6,7 @@ categories::  UGens>Buffer>Info
 Description::
 
 Returns the current number of allocated samples. A sample is not the same as a frame (compare with link::Classes/BufFrames:: ); a frame includes the samples in each channel of the buffer. Only for a mono buffer are samples the same as frames.
-formula::
+code::
 samples = frames * numChannels
 ::
 

diff --git a/HelpSource/Classes/Bus.schelp b/HelpSource/Classes/Bus.schelp
@@ -14,7 +14,7 @@ Bus objects should not be created or modified within a link::Classes/SynthDef::.
 
 Note::
 The lowest code::n:: bus indices are reserved for hardware output and input, where
-formula::
+code::
 n = server.options.numOutputBusChannels + server.options.numInputBusChannels
 ::
 definitionlist::

diff --git a/HelpSource/Classes/COsc.schelp b/HelpSource/Classes/COsc.schelp
@@ -8,7 +8,7 @@ Description::
 
 Chorusing wavetable lookup oscillator. Produces sum of two signals at
 
-formula::
+code::
 (freq ± (beats / 2)).
 ::
 

diff --git a/HelpSource/Classes/Changed.schelp b/HelpSource/Classes/Changed.schelp
@@ -16,7 +16,7 @@ threshold
 
 discussion::
 Implements the formula:
-formula::
+code::
 out(i) = abs(in(i) - in(i-1)) > thresh
 ::
 

diff --git a/HelpSource/Classes/FOS.schelp b/HelpSource/Classes/FOS.schelp
@@ -9,7 +9,7 @@ Description::
 A standard first order filter section. Filter coefficients are given
 directly rather than calculated for you. Formula is equivalent to:
 
-formula::
+code::
 out(i) = (a0 * in(i)) + (a1 * in(i-1)) + (b1 * out(i-1))
 ::
 

diff --git a/HelpSource/Classes/Gendy2.schelp b/HelpSource/Classes/Gendy2.schelp
@@ -107,7 +107,7 @@ argument::a
 Parameter for Lehmer random number generator perturbed by
 Xenakis as in
 
-formula::
+code::
 ((old*a)+c)%1.0
 ::
 

diff --git a/HelpSource/Classes/HPZ1.schelp b/HelpSource/Classes/HPZ1.schelp
@@ -8,7 +8,7 @@ Description::
 
 A special case fixed filter. Implements the formula:
 
-formula::
+code::
 out(i) = 0.5 * (in(i) - in(i-1))
 ::
 

diff --git a/HelpSource/Classes/HPZ2.schelp b/HelpSource/Classes/HPZ2.schelp
@@ -8,7 +8,7 @@ Description::
 
 A special case fixed filter. Implements the formula:
 
-formula::
+code::
 out(i) = 0.25 * (in(i) - (2 * in(i - 1)) + in(i - 2)).
 ::
 

diff --git a/HelpSource/Classes/Integrator.schelp b/HelpSource/Classes/Integrator.schelp
@@ -7,7 +7,7 @@ Description::
 
 Integrates an input signal with a leak. The formula implemented is:
 
-formula::
+code::
 out(0) = in(0) + (coef * out(-1))
 ::
 

diff --git a/HelpSource/Classes/LFGauss.schelp b/HelpSource/Classes/LFGauss.schelp
@@ -6,7 +6,7 @@ description::
 A non-band-limited gaussian function oscillator. Output ranges from strong::minval:: to 1.
 
 LFGauss implements the formula:
-formula::
+code::
 f(x) = exp(squared(x - iphase) / (-2.0 * squared(width)))
 ::
 where x is to vary in the range -1 to 1 over the period dur. strong::minval:: is the initial value at -1.

diff --git a/HelpSource/Classes/LPZ1.schelp b/HelpSource/Classes/LPZ1.schelp
@@ -7,7 +7,7 @@ categories::  UGens>Filters>Linear
 Description::
 
 A special case fixed filter. Implements the formula:
-formula::
+code::
 out(i) = 0.5 * (in(i) + in(i-1))
 ::
 which is a two point averager.

diff --git a/HelpSource/Classes/LPZ2.schelp b/HelpSource/Classes/LPZ2.schelp
@@ -7,7 +7,7 @@ categories::  UGens>Filters>Linear
 Description::
 
 A special case fixed filter. Implements the formula:
-formula::
+code::
 out(i) = 0.25 * (in(i) + (2 * in(i - 1)) + in(i - 2)).
 ::
 

diff --git a/HelpSource/Classes/Logistic.schelp b/HelpSource/Classes/Logistic.schelp
@@ -7,7 +7,7 @@ categories::  UGens>Generators>Chaotic
 Description::
 
 A noise generator based on the logistic map:
-formula::
+code::
 y = chaosParam * y * (1.0 - y)
 ::
 

diff --git a/HelpSource/Classes/OnePole.schelp b/HelpSource/Classes/OnePole.schelp
@@ -8,7 +8,7 @@ Description::
 
 A one pole filter. Implements the formula:
 
-formula::
+code::
 
 out(i) = ((1 - abs(coef)) * in(i)) + (coef * out(i-1)).
 

diff --git a/HelpSource/Classes/OneZero.schelp b/HelpSource/Classes/OneZero.schelp
@@ -8,7 +8,7 @@ Description::
 
 A one zero filter. Implements the formula:
 
-formula::
+code::
 
 out(i) = ((1 - abs(coef)) * in(i)) + (coef * in(i-1)).
 

diff --git a/HelpSource/Classes/PV_Add.schelp b/HelpSource/Classes/PV_Add.schelp
@@ -7,7 +7,7 @@ Description::
 
 Complex addition:
 
-formula::
+code::
 
 RealA + RealB, ImagA + ImagB
 

diff --git a/HelpSource/Classes/PV_ConformalMap.schelp b/HelpSource/Classes/PV_ConformalMap.schelp
@@ -7,7 +7,7 @@ Description::
 
 Applies the conformal mapping
 
-formula::
+code::
 
 z → (z - a) / (1 - za*)
 
@@ -20,13 +20,13 @@ the UGen.
 Makes a transformation of the complex plane so the output is full of
 phase vocoder artifacts but may be musically fun. Usually keep
 
-formula::
+code::
 |a| < 1
 ::
 but
 you can of course try bigger values to make it really noisy.
 
-formula::
+code::
 a = 0
 ::
 should

diff --git a/HelpSource/Classes/PV_Mul.schelp b/HelpSource/Classes/PV_Mul.schelp
@@ -7,7 +7,7 @@ Description::
 
 Complex Multiplication:
 
-formula::
+code::
 
 (RealA * RealB) - (ImagA * ImagB),
 (ImagA * RealB) + (RealA * ImagB)

diff --git a/HelpSource/Classes/Resonz.schelp b/HelpSource/Classes/Resonz.schelp
@@ -8,7 +8,7 @@ Description::
 
 A two pole resonant filter with zeroes at
 
-formula::
+code::
 z = ±1
 ::
 

diff --git a/HelpSource/Classes/Rotate2.schelp b/HelpSource/Classes/Rotate2.schelp
@@ -11,11 +11,11 @@ an axis. Rotate2 does an equal power rotation so it also works well on
 stereo sounds. It takes two audio inputs (x, y) and an angle control
 (pos). It outputs two channels (x, y). It computes this:
 
-formula::
+code::
 xout = cos(angle) * xin + sin(angle) * yin;
 ::
 
-formula::
+code::
 yout = cos(angle) * yin - sin(angle) * xin;
 ::
 

diff --git a/HelpSource/Classes/SOS.schelp b/HelpSource/Classes/SOS.schelp
@@ -9,7 +9,7 @@ Description::
 A standard second order filter section. Filter coefficients are given
 directly rather than calculated for you. Formula is equivalent to:
 
-formula::
+code::
 
 out(i) = (a0 * in(i)) + (a1 * in(i-1)) + (a2 * in(i-2)) + (b1 * out(i-1)) + (b2 * out(i-2))
 

diff --git a/HelpSource/Classes/Schmidt.schelp b/HelpSource/Classes/Schmidt.schelp
@@ -10,7 +10,7 @@ When  code::in::  crosses to greater than
 code::hi:: , output 1, then when signal crosses lower
 than  code::lo::  output 0. Uses the formula:
 
-formula::
+code::
 
 if (out == 1, { if (in < lo, { out = 0.0 }) }, { if (in > hi, { out = 1.0 }) }).
 

diff --git a/HelpSource/Classes/TGrains.schelp b/HelpSource/Classes/TGrains.schelp
@@ -4,7 +4,7 @@ categories::  UGens>Buffer, UGens>Generators>Granular
 
 Description::
 Triggers generate grains from a buffer. Each grain has a Hanning envelope
-formula::
+code::
 (sin2(x) for x from 0 to π)
 ::
 and is panned between two channels of multiple outputs.

diff --git a/HelpSource/Classes/XOut.schelp b/HelpSource/Classes/XOut.schelp
@@ -10,7 +10,7 @@ Send signal to a bus, crossfading with previous contents.
 code::xfade::  is a level for the crossfade between what
 is on the bus and what you are sending. The algorithm is equivalent to this:
 
-formula::
+code::
 bus_signal = (input_signal * xfade) + (bus_signal * (1 - xfade));
 ::
 

diff --git a/HelpSource/Overviews/Operators.schelp b/HelpSource/Overviews/Operators.schelp
@@ -361,7 +361,7 @@ method:: hypotApx
 Hypotenuse approximation. Returns an approximation of the square root of the sum of the squares of x and y.
 discussion::
 The formula used is :
-formula::
+code::
 abs(x) + abs(y) - ((sqrt(2) - 1) * min(abs(x), abs(y)))
 ::
 hypotApx is used to implement Complex method magnitudeApx.

diff --git a/HelpSource/Reference/Server-Command-Reference.schelp b/HelpSource/Reference/Server-Command-Reference.schelp
@@ -898,8 +898,8 @@ table::
     ::
 ::
 Fills a buffer with a series of chebyshev polynomials, which can be defined as:
-formula::
-cheby(n) = amplitude  * cos(n * acos(x))
+code::
+cheby(n) = amplitude * cos(n * acos(x))
 ::
 The first float value specifies the amplitude for n = 1, the second float value specifies the amplitude for n = 2, and so on. To eliminate a DC offset when used as a waveshaper, the wavetable is offset so that the center value is zero.
 ::

diff --git a/HelpSource/scdoc.css b/HelpSource/scdoc.css
@@ -297,18 +297,6 @@ pre.code {
 
 }
 
-code.formula, pre.formula {
-    font-family: monospace;
-    font-size: 10pt;
-    font-weight: normal;
-    color: #333;
-}
-
-pre.formula {
-    padding: 0.5em;
-    text-align: center;
-}
-
 .image {
     text-align: center;
     margin: 2em;