template.xml

<!--Change refentry id and indexterm id-->
<refentry id="newopcodename">
<indexterm id="IndexNewopcode"><primary>newopcodename</primary></indexterm>
<!--Make sure the category below is a valid one! See categories.py-->
  <refentryinfo><title>Signal Modifiers:Delay</title></refentryinfo>
  <refmeta>
    <refentrytitle>newopcodename</refentrytitle>
  </refmeta>

  <refnamediv>
    <refname>newopcodename</refname>
    <refpurpose>
      Short description. Single line for opcode listing.
    </refpurpose>
  </refnamediv>
 
  <refsect1>
    <title>Description</title>
    <para>Plugin opcode in mycode. (if not in base system)</para>
     <para>
      Less concise description, but still short.
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
<!--    Please keep this below ~70 characters by using backslashes to avoid overflow in the pdf version-->
    <synopsis>outarg1, outarg2 <command>newopcodename</command> inarg1, inarg2</synopsis>
  </refsect1>

  <refsect1>
<!--  If applicable list i-time arguments-->
    <title>Initialization</title>
    <para>
      <emphasis>ivar</emphasis> -- i-time variable
    </para>
    <para>
      <emphasis>ivar2</emphasis> -- i-time variable 2
    </para>
  </refsect1>
 
  <refsect1>
    <title>Performance</title>
<!--    First list all input and output performance parameters-->
    <para>
      <emphasis>asig</emphasis> -- audio signal
    </para>
    <para>
      <emphasis>ksig</emphasis> -- control signal
    </para>

    <para>
      Then describe performace in detail.
    </para>

    <para>Use for internal manual links: <link linkend="delayr"><citetitle>delayr</citetitle></link> and this for external hyperlinks: <ulink url="examples/newopcodename.csd"><citetitle>newopcodename.csd</citetitle></ulink> or for the internet: <ulink url="http://www.csounds.com"><citetitle>Csounds.com page</citetitle></ulink>.
    </para>

    <para>
      You can also emphasize <emphasis>words</emphasis>.
    </para>

    <note>
      <title>Title of the note (optional)</title>
      <para>
        An important note. You can also use "tip" or "warning" instead of note.
      </para>
    </note>

    <para>
      You can also do lists.
      <itemizedlist>
        <listitem><para>First item</para></listitem>
        <listitem><para>Second item</para></listitem>
      </itemizedlist>
    </para>

    <para>
      You can also do numbered lists.
      <orderedlist>
        <listitem><para>First item</para></listitem>
        <listitem><para>Second item</para></listitem>
      </orderedlist>
    </para>

    <para>
      Put inline program lines like this:
      <programlisting>aout oscil 10000, 440, 1</programlisting>
      And Csound output like this:
      <literallayout>Output text</literallayout>
    </para>

    <para>
      You can put images like this:
      <mediaobject>
        <imageobject>
          <imagedata fileref="images/grain3_2.png" format="PNG"/>
        </imageobject>

        <textobject>
          <phrase>[A diagram showing grains with a start time less than zero in red.]</phrase>
        </textobject>

        <caption>
          <para>A diagram showing grains with a start time less than zero in red.</para>
        </caption>
      </mediaobject>
    </para>
    
  </refsect1>

 
  <refsect1>
<!--To add examples, create the csd file in the examples directory, then run:-->
<!--python csd2docbook.py -f newopcodename.csd-->
<!--to generate the xml highlighted version used below-->
    <title>Examples</title>
    <para>
      Here is an example of the delay opcode. It uses the file <ulink url="examples/newopcodename.csd"><citetitle>newopcodename.csd</citetitle></ulink>.
      <example>
        <title>Example of the newopcodename opcode.</title>
        <para>See the sections <link linkend="UsingRealTime"><citetitle>Real-time Audio</citetitle></link> and <link linkend="CommandFlags"><citetitle>Command Line Flags</citetitle></link> for more information on using command line flags.</para>
          <xi:include href="examples-xml/newopcodename.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>
    </para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
<!--    it is always good to include a good See Also list  -->
    <para>
      <link linkend="deltap"><citetitle>deltap</citetitle></link>
    </para>
  </refsect1>

  <refsect1>
<!--  And put your name and other relevant information here-->
    <title>Credits</title>
    <para>By: &namejohn; 2010</para>
    <para>Additional information</para>
    <para>New in version 6.??</para>
  </refsect1>

<!--Now remember to add a link from the appropriate category in the Opcode Overview.-->
<!--Add the entity to manual.xml-->
<!--Add the entity reference in the appropriate place in opcodes/top.xml-->
<!--And you are set! Maybe delete the comments as well...-->

</refentry>