summaryrefslogtreecommitdiff
path: root/scoregens/r.xml
blob: ca3fc38180f058bd950ffed83999487a4da25842 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
<refentry id="r">
      <indexterm id="IndexRStatement"><primary>r statement</primary></indexterm>
      <indexterm id="IndexRepeatStatement"><primary>repeat statement</primary></indexterm>
  <refmeta>
    <refentrytitle>r Statement (Repeat Statement)</refentrytitle>
  </refmeta>
 
  <refnamediv>
    <refname>r</refname>
    <refpurpose>
      Starts a repeated section.
    </refpurpose>
  </refnamediv>
 
  <refsect1>
    <title>Description</title>
    <para>
      Starts a repeated section, which lasts until the next <emphasis>s</emphasis>, <emphasis>r</emphasis> or <emphasis>e statement</emphasis>.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Syntax</title>
    <synopsis><command>r</command> p1 p2</synopsis>
  </refsect1>
 
  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>p1</emphasis> -- Number of times to repeat the section.
    </para>

    <para>
      <emphasis>p2</emphasis> -- Macro(name) to advance with each repetition (optional).
    </para>
  </refsect1>
 
  <refsect1>
    <title>Performance</title>
    <para>
      In order that the sections may be more flexible than simple editing, the macro named p2 is given the value of 1 for the first time through the section, 2 for the second, and 3 for the third.  This can be used to change p-field parameters, or ignored.
    </para>

    <warning>
      <title>Warning</title>
      <para>
        Because of serious problems of interaction with macro expansion, sections must start and end in the same file, and not in a macro.
      </para>
    </warning>
  </refsect1>

  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the r statement. It uses the file <ulink url="examples/r.csd"><citetitle>r.csd</citetitle></ulink>.

      <example>
        <title>Example of the r statement.</title>

        <xi:include href="examples-xml/r.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>
    </para>
  </refsect1>
 
  <refsect1>
    <title>Credits</title>
    <para>
      <simplelist>
        <member>Author: &namejohn;</member>
        <member>University of Bath/Codemist Ltd.</member>
        <member>Bath, UK</member>
        <member>April, 1998</member>
      </simplelist>
    </para>

    <para>New in Csound version 3.48</para>
    <para>Example written by &namekevin;</para>
  </refsect1>
</refentry>