Merge pull request #729 from tjingboem/7.0

21st / EXTRA bunch of SeeAlso
csound · May 21, 2024 · f93b0ea · f93b0ea
2 parents d612d30 + 4a2a991
commit f93b0ea
Show file tree

Hide file tree

Showing 18 changed files with 74 additions and 44 deletions.
diff --git a/STKopcodes/top.xml b/STKopcodes/top.xml
@@ -51,7 +51,10 @@
     C++ (STK) web site at <ulink
     url="https://ccrma.stanford.edu/software/stk">https://ccrma.stanford.edu/software/stk</ulink>.
   </para>
-
+    <para>
+Also, see the <link linkend="SiggenModels"><citetitle>Models and Emulations</citetitle> section </link>.  
+    </para>
+
   <bridgehead>Credits</bridgehead>
   <para>
     This implementation of the STK unit generators was written by Perry R. Cook

diff --git a/control/invocat.xml b/control/invocat.xml
@@ -7,7 +7,8 @@
     <itemizedlist>
       <listitem><para><link linkend="event"><citetitle>event</citetitle></link></para></listitem>
       <listitem><para><link linkend="event_i"><citetitle>event_i</citetitle></link></para></listitem>
-	  <listitem><para><link linkend="scoreline_i"><citetitle>scoreline_i</citetitle></link></para></listitem>
+      <listitem><para><link linkend="nstance"><citetitle>nstance</citetitle></link></para></listitem>
+      <listitem><para><link linkend="scoreline_i"><citetitle>scoreline_i</citetitle></link></para></listitem>
       <listitem><para><link linkend="scoreline"><citetitle>scoreline</citetitle></link></para></listitem>
       <listitem><para><link linkend="schedule"><citetitle>schedule</citetitle></link></para></listitem>
       <listitem><para><link linkend="schedulek"><citetitle>schedulek</citetitle></link></para></listitem>

diff --git a/control/sensing.xml b/control/sensing.xml
@@ -29,6 +29,7 @@
       <itemizedlist>
         <listitem><para><link linkend="follow"><citetitle>follow</citetitle></link></para></listitem>
         <listitem><para><link linkend="follow2"><citetitle>follow2</citetitle></link></para></listitem>
+	<listitem><para><link linkend="lufs"><citetitle>lufs</citetitle></link></para></listitem>
         <listitem><para><link linkend="peak"><citetitle>peak</citetitle></link></para></listitem>
         <listitem><para><link linkend="rms"><citetitle>rms</citetitle></link></para></listitem>
 	<listitem><para><link linkend="vactrol"><citetitle>vactrol</citetitle></link></para></listitem>
@@ -56,6 +57,7 @@
 	<listitem><para><link linkend="tempo"><citetitle>tempo</citetitle></link></para></listitem>
 	<listitem><para><link linkend="tempoval"><citetitle>tempoval</citetitle></link></para></listitem>
         <listitem><para><link linkend="trigger"><citetitle>trigger</citetitle></link></para></listitem>
+	<listitem><para><link linkend="trighold"><citetitle>trighold</citetitle></link></para></listitem>
         <listitem><para><link linkend="trigseq"><citetitle>trigseq</citetitle></link></para></listitem>
         <listitem><para><link linkend="timedseq"><citetitle>timedseq</citetitle></link></para></listitem>
       </itemizedlist></para>

diff --git a/math/array.xml b/math/array.xml
@@ -72,14 +72,6 @@
       </para></listitem>
       <listitem><para><link linkend="printarray"><citetitle>printarray</citetitle></link> print an array
       </para></listitem>
-      <listitem><para><link linkend="cbrt"><citetitle>cbrt</citetitle></link> return the value of the cubic root of an argument
-      </para></listitem>
-      <listitem><para><link linkend="fmax"><citetitle>fmax</citetitle></link> return the maximum of two arguments
-      </para></listitem>
-      <listitem><para><link linkend="fmin"><citetitle>fmin</citetitle></link> return the minimum of two arguments
-      </para></listitem>
-      <listitem><para><link linkend="fmod"><citetitle>fmod</citetitle></link> computes the remainder of the division of its first argument by the second
-      </para></listitem>
       <listitem><para>the unary functions
 	 <link linkend="ceil"><citetitle>ceil</citetitle></link> 
 	 <link linkend="floor"><citetitle>floor</citetitle></link> 

diff --git a/math/trig.xml b/math/trig.xml
@@ -9,7 +9,9 @@
       </listitem>
       <listitem><para><link linkend="sin"><citetitle>sin</citetitle></link>, <link linkend="sinh"><citetitle>sinh</citetitle></link> and <link linkend="sininv"><citetitle>sininv</citetitle></link></para>
       </listitem>
-      <listitem><para><link linkend="tan"><citetitle>tan</citetitle></link>, <link linkend="tanh"><citetitle>tanh</citetitle></link>, <link linkend="taninv"><citetitle>taninv</citetitle></link>, and <link linkend="taninv2"><citetitle>taninv2</citetitle></link>.</para>
+      <listitem><para><link linkend="tan"><citetitle>tan</citetitle></link>, <link linkend="tanh"><citetitle>tanh</citetitle></link>, <link linkend="taninv"><citetitle>taninv</citetitle></link>, and <link linkend="taninv2"><citetitle>taninv2</citetitle></link></para>
+      </listitem>
+      <listitem><para><link linkend="signum"><citetitle>signum</citetitle></link></para>
       </listitem>
     </itemizedlist>
   </para>

diff --git a/miscopcodes/top.xml b/miscopcodes/top.xml
@@ -3,6 +3,9 @@
   <title>Miscellaneous opcodes</title>
   <para>Here is a list of opcodes that don't fall in any category:
     <itemizedlist>
+      <listitem><link linkend="directory"><citetitle>directory</citetitle></link> - Reads a directory and outputs to a string array a list of file names.</listitem>
+      <listitem><link linkend="nchnls_hw"><citetitle>nchnls_hw</citetitle></link> - Returns the number of audio channels in the underlying hardware.</listitem>
+      <listitem><link linkend="pwd"><citetitle>pwd</citetitle></link> - Asks the underlying operating system for the current directory name as a string.</listitem>
       <listitem><link linkend="system"><citetitle>system</citetitle></link> - Call an external program via the system call.</listitem>
       <listitem><link linkend="modmatrix"><citetitle>modmatrix</citetitle></link>
       - modulation matrix opcode with optimizations for sparse matrices.</listitem>

diff --git a/opcodes/directory.xml b/opcodes/directory.xml
@@ -58,7 +58,12 @@
       </example>
     </para>
   </refsect1>
-
+
+     <refsect1>
+        <title>See also</title>
+        <para><link linkend="MiscopcodesTop"><citetitle>Miscellaneous opcodes</citetitle></link></para>
+  </refsect1>
+
   <refsect1>
     <title>Credits</title>
     <para>

diff --git a/opcodes/getseed.xml b/opcodes/getseed.xml
@@ -47,6 +47,11 @@
     </para>
   </refsect1>
 
+      <refsect1>
+        <title>See also</title>
+        <para><link linkend="SiggenNoise"><citetitle>Random (Noise) Generators</citetitle></link></para>
+    </refsect1>
+
   <refsect1>
     <title>Credits</title>
     <para>

diff --git a/opcodes/hypot.xml b/opcodes/hypot.xml
@@ -51,7 +51,14 @@
       </example>
     </para>
   </refsect1>
-
+
+  <refsect1>
+    <title>See Also</title>
+    <para>
+      <link linkend="arrayOpcodes"><citetitle></citetitle>array opcodes</link>
+    </para>
+  </refsect1>
+
   <refsect1>
     <title>Credits</title>
     <para>

diff --git a/opcodes/lufs.xml b/opcodes/lufs.xml
@@ -81,14 +81,11 @@
       </example>
     </para>
   </refsect1>
-
-  <refsect1>
-    <title>See Also</title>
-<!--    it's always good to include a good See Also list  -->
-    <para>
-      <link linkend="rms"><citetitle>rms</citetitle></link>
-    </para>
-  </refsect1>
+
+      <refsect1>
+        <title>See also</title>
+        <para><link linkend="ControlSensing"><citetitle>Sensing and Control: Envelope followers</citetitle></link></para>
+    </refsect1>
 
   <refsect1>
 <!--  And put your name and other relevant information here-->

diff --git a/opcodes/nchnls_hw.xml b/opcodes/nchnls_hw.xml
@@ -35,6 +35,11 @@
     correspond to the currently selected/in-use hardware devices.
     </para>
   </refsect1>
+
+     <refsect1>
+        <title>See also</title>
+        <para><link linkend="MiscopcodesTop"><citetitle>Miscellaneous opcodes</citetitle></link></para>
+  </refsect1>
 
   <refsect1>
     <title>Credits</title>

diff --git a/opcodes/nstance.xml b/opcodes/nstance.xml
@@ -87,15 +87,9 @@ stop the given instrument instance via the turnoff opcode. Note that the instanc
     </para>
   </refsect1>
 
-  <refsect1>
-    <title>See also</title>
-    <para><link linkend="event"><citetitle>event</citetitle></link>,
-    <link linkend="event_i"><citetitle>event_i</citetitle></link>,
-    <link linkend="schedwhen"><citetitle>schedwhen</citetitle></link>,
-    <link linkend="schedkwhen"><citetitle>schedkwhen</citetitle></link>,
-    <link linkend="schedkwhennamed"><citetitle>schedkwhennamed</citetitle></link>,
-    <link linkend="scoreline"><citetitle>scoreline</citetitle></link>,
-    <link linkend="scoreline_i"><citetitle>scoreline_i</citetitle></link></para>
+      <refsect1>
+        <title>See also</title>
+        <para><link linkend="ControlInvocat"><citetitle>Instrument Invocation</citetitle></link></para>
     <para> More information on this opcode: <ulink url="http://www.csoundjournal.com/issue15/phrase_loops.html"><citetitle>http://www.csoundjournal.com/issue15/phrase_loops.html</citetitle></ulink>  , written by Jim Aikin </para>
   </refsect1>
 

diff --git a/opcodes/p.xml b/opcodes/p.xml
@@ -68,4 +68,9 @@ random number is now 139.496898
     </para>
   </refsect1>
 
+      <refsect1>
+        <title>See also</title>
+        <para><link linkend="ControlReinitn"><citetitle>Initialization and Reinitialization</citetitle></link></para>
+  </refsect1>
+
 </refentry>
diff --git a/opcodes/pwd.xml b/opcodes/pwd.xml
@@ -52,7 +52,12 @@
       </example>
     </para>
   </refsect1>
-
+
+     <refsect1>
+        <title>See also</title>
+        <para><link linkend="MiscopcodesTop"><citetitle>Miscellaneous opcodes</citetitle></link></para>
+  </refsect1>
+
   <refsect1>
     <title>Credits</title>
     <para>

diff --git a/opcodes/remove.xml b/opcodes/remove.xml
@@ -44,6 +44,11 @@
     </para>
   </refsect1>
 
+      <refsect1>
+        <title>See also</title>
+        <para><link linkend="ControlInvocat"><citetitle>Instrument Invocation</citetitle></link></para>
+    </refsect1>
+
   <refsect1>
     <title>Credits</title>
     <para>

diff --git a/opcodes/signum.xml b/opcodes/signum.xml
@@ -40,6 +40,11 @@
     </para>
   </refsect1>
 
+      <refsect1>
+        <title>See also</title>
+        <para><link linkend="MathTrig"><citetitle>Trigonometric Functions</citetitle></link></para>
+    </refsect1>
+
   <refsect1>
     <title>Credits</title>
     <para>

diff --git a/opcodes/trighold.xml b/opcodes/trighold.xml
@@ -75,18 +75,11 @@
       </example>
     </para>
   </refsect1>
-
-  <refsect1>
-    <title>See Also</title>
-    <!--    it's always good to include a good See Also list  -->
-    <para>
-      <link linkend="lag"><citetitle>lag</citetitle></link>, 
-      <link linkend="metro"><citetitle>metro</citetitle></link>, 
-      <link linkend="mpulse"><citetitle>mpulse</citetitle></link>
-      <link linkend="trigger"><citetitle>trigger</citetitle></link>
-
-    </para>
-  </refsect1>
+
+      <refsect1>
+        <title>See also</title>
+        <para><link linkend="ControlSensing"><citetitle>Sensing and Control: Tempo and Sequencing</citetitle></link></para>
+    </refsect1>
 
   <refsect1>
     <!--  And put your name and other relevant information here-->

diff --git a/siggen/random.xml b/siggen/random.xml
@@ -78,7 +78,8 @@
     </itemizedlist>
   </para>
   <para>
-	  See <link linkend="seed"><citetitle>seed</citetitle></link> which sets the global seed value for all x-class noise generators, as well as other opcodes that use a random call, such as <link linkend="grain"><citetitle>grain</citetitle></link>. 
+	  See <link linkend="seed"><citetitle>seed</citetitle></link> which sets the global seed value for all x-class noise generators, as well as other opcodes that use a random call, such as <link linkend="grain"><citetitle>grain</citetitle></link>.  
+	  And <link linkend="getseed"><citetitle>getseed</citetitle></link> returns the global seed value used for all x-class noise generators.
 	    </para>
   <para><link linkend="rand"><citetitle>rand</citetitle></link>, <link linkend="randh"><citetitle>randh</citetitle></link>, <link linkend="randi"><citetitle>randi</citetitle></link>, <link linkend="rnd"><citetitle>rnd(x)</citetitle></link> and <link linkend="birnd"><citetitle>birnd(x)</citetitle></link> are not affected by seed.
 Use <link linkend="rndseed"><citetitle>rndseed</citetitle></link> for that.