← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/helptools/examples/example_1/help/en_US/example_1_function_1.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/helptools/examples/example_1/help/en_US/example_1_function_1.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="example_1_function_1">
3
 
  <refnamediv>
4
 
    <refname>example_1_function_1</refname>
5
 
    <refpurpose>"example_1_function_1" description</refpurpose>
6
 
  </refnamediv>
7
 
  <refsynopsisdiv>
8
 
    <title>Calling Sequence</title>
9
 
    <synopsis>a = example_1_function_1(b,c)</synopsis>
10
 
  </refsynopsisdiv>
11
 
  <refsection>
12
 
    <title>Parameters</title>
13
 
    <variablelist>
14
 
      <varlistentry>
15
 
        <term>b</term>
16
 
        <listitem>
17
 
          <para>
18
 
            "b" parameter description
19
 
          </para>
20
 
        </listitem>
21
 
      </varlistentry>
22
 
      <varlistentry>
23
 
        <term>c</term>
24
 
        <listitem>
25
 
          <para>
26
 
            "c" parameter description
27
 
          </para>
28
 
        </listitem>
29
 
      </varlistentry>
30
 
      <varlistentry>
31
 
        <term>a</term>
32
 
        <listitem>
33
 
          <para>
34
 
            "a" parameter description
35
 
          </para>
36
 
        </listitem>
37
 
      </varlistentry>
38
 
    </variablelist>
39
 
  </refsection>
40
 
  <refsection>
41
 
    <title>Description</title>
42
 
    <itemizedlist>
43
 
      <listitem>
44
 
        <para>
45
 
          example_1_function_1 full description
46
 
        </para>
47
 
      </listitem>
48
 
    </itemizedlist>
49
 
  </refsection>
50
 
  <refsection>
51
 
    <title>Example of image inclusion (PNG format)</title>
52
 
    <para>
53
 
      <inlinemediaobject>
54
 
        <imageobject>
55
 
          <imagedata fileref="../images/plot3d.png" align="center" valign="middle"/>
56
 
        </imageobject>
57
 
      </inlinemediaobject>
58
 
    </para>
59
 
  </refsection>
60
 
  <refsection>
61
 
    <title>Example of image inclusion (SVG format)</title>
62
 
    <para>
63
 
      <inlinemediaobject>
64
 
        <imageobject>
65
 
          <imagedata fileref="../images/fac3d.svg" align="center" valign="middle"/>
66
 
        </imageobject>
67
 
      </inlinemediaobject>
68
 
    </para>
69
 
  </refsection>
70
 
  <refsection>
71
 
    <title>Example of MathML inclusion: separate file</title>
72
 
    <para>
73
 
      <informalequation>
74
 
        <mediaobject>
75
 
          <imageobject>
76
 
            <imagedata align="center" fileref="../mml/quadratic.mml"/>
77
 
          </imageobject>
78
 
        </mediaobject>
79
 
      </informalequation>
80
 
    </para>
81
 
  </refsection>
82
 
  <refsection>
83
 
    <title>
84
 
      Example of T<subscript>E</subscript>X inclusion: separate file
85
 
    </title>
86
 
    <para>
87
 
      <informalequation>
88
 
        <mediaobject>
89
 
          <imageobject>
90
 
            <imagedata align="center" fileref="../tex/math.tex"/>
91
 
          </imageobject>
92
 
        </mediaobject>
93
 
      </informalequation>
94
 
    </para>
95
 
  </refsection>
96
 
  <refsection>
97
 
    <title>Example of MathML inclusion: Inline</title>
98
 
    <para>
99
 
      <informalequation>
100
 
        <mediaobject>
101
 
          <imageobject>
102
 
            <imagedata>
103
 
              <mml:math>
104
 
                <mml:semantics>
105
 
                  <mml:mrow>
106
 
                    <mml:mrow>
107
 
                      <mml:mfenced mml:close="∣" mml:open="∣">
108
 
                        <mml:msub>
109
 
                          <mml:mrow>
110
 
                            <mml:mo mml:stretchy="false">(</mml:mo>
111
 
                            <mml:mrow>
112
 
                              <mml:mi>z</mml:mi>
113
 
                              <mml:mrow>
114
 
                                <mml:mrow>
115
 
                                  <mml:mo mml:stretchy="false">(</mml:mo>
116
 
                                  <mml:mi>v</mml:mi>
117
 
                                  <mml:mo mml:stretchy="false">)</mml:mo>
118
 
                                </mml:mrow>
119
 
                                <mml:mo mml:stretchy="false">−</mml:mo>
120
 
                                <mml:mi>z</mml:mi>
121
 
                              </mml:mrow>
122
 
                              <mml:mrow>
123
 
                                <mml:mo mml:stretchy="false">(</mml:mo>
124
 
                                <mml:mi>u</mml:mi>
125
 
                                <mml:mo mml:stretchy="false">)</mml:mo>
126
 
                              </mml:mrow>
127
 
                            </mml:mrow>
128
 
                            <mml:mo mml:stretchy="false">)</mml:mo>
129
 
                          </mml:mrow>
130
 
                          <mml:mrow>
131
 
                            <mml:mi mml:fontstyle="italic">ltol</mml:mi>
132
 
                            <mml:mrow>
133
 
                              <mml:mo mml:stretchy="false">(</mml:mo>
134
 
                              <mml:mi>j</mml:mi>
135
 
                              <mml:mo mml:stretchy="false">)</mml:mo>
136
 
                            </mml:mrow>
137
 
                          </mml:mrow>
138
 
                        </mml:msub>
139
 
                      </mml:mfenced>
140
 
                      <mml:mo mml:stretchy="false">≤</mml:mo>
141
 
                      <mml:mi mml:fontstyle="italic">tol</mml:mi>
142
 
                    </mml:mrow>
143
 
                    <mml:mrow>
144
 
                      <mml:mrow>
145
 
                        <mml:mrow>
146
 
                          <mml:mo mml:stretchy="false">(</mml:mo>
147
 
                          <mml:mi>j</mml:mi>
148
 
                          <mml:mo mml:stretchy="false">)</mml:mo>
149
 
                        </mml:mrow>
150
 
                        <mml:mo mml:stretchy="false">⋅</mml:mo>
151
 
                        <mml:mfenced mml:close="∣" mml:open="∣">
152
 
                          <mml:msub>
153
 
                            <mml:mrow>
154
 
                              <mml:mo mml:stretchy="false">(</mml:mo>
155
 
                              <mml:mrow>
156
 
                                <mml:mi>z</mml:mi>
157
 
                                <mml:mrow>
158
 
                                  <mml:mo mml:stretchy="false">(</mml:mo>
159
 
                                  <mml:mi>u</mml:mi>
160
 
                                  <mml:mo mml:stretchy="false">)</mml:mo>
161
 
                                </mml:mrow>
162
 
                              </mml:mrow>
163
 
                              <mml:mo mml:stretchy="false">)</mml:mo>
164
 
                            </mml:mrow>
165
 
                            <mml:mrow>
166
 
                              <mml:mi mml:fontstyle="italic">ltol</mml:mi>
167
 
                              <mml:mrow>
168
 
                                <mml:mo mml:stretchy="false">(</mml:mo>
169
 
                                <mml:mi>j</mml:mi>
170
 
                                <mml:mo mml:stretchy="false">)</mml:mo>
171
 
                              </mml:mrow>
172
 
                            </mml:mrow>
173
 
                          </mml:msub>
174
 
                        </mml:mfenced>
175
 
                      </mml:mrow>
176
 
                      <mml:mo mml:stretchy="false">+</mml:mo>
177
 
                      <mml:mi mml:fontstyle="italic">tol</mml:mi>
178
 
                    </mml:mrow>
179
 
                    <mml:mrow>
180
 
                      <mml:mo mml:stretchy="false">(</mml:mo>
181
 
                      <mml:mi>j</mml:mi>
182
 
                      <mml:mo mml:stretchy="false">)</mml:mo>
183
 
                    </mml:mrow>
184
 
                    <mml:mi>,</mml:mi>
185
 
                    <mml:mi mml:fontstyle="normal">for</mml:mi>
186
 
                    <mml:mrow>
187
 
                      <mml:mi>j</mml:mi>
188
 
                      <mml:mo mml:stretchy="false">=</mml:mo>
189
 
                      <mml:mn>1</mml:mn>
190
 
                    </mml:mrow>
191
 
                    <mml:mi mml:fontstyle="normal">:</mml:mi>
192
 
                    <mml:mi mml:fontstyle="normal">ntol</mml:mi>
193
 
                  </mml:mrow>
194
 
                  <mml:annotation mml:encoding="StarMath 5.0">abs(z(v)-z(u))_{ltol(j)}
195
 
                    &lt;= tol(j) cdot abs(z(u))_{ltol(j)} + tol(j), for
196
 
                    j=1:ntol
197
 
                  </mml:annotation>
198
 
                </mml:semantics>
199
 
              </mml:math>
200
 
            </imagedata>
201
 
          </imageobject>
202
 
        </mediaobject>
203
 
      </informalequation>
204
 
    </para>
205
 
  </refsection>
206
 
  <refsection>
207
 
    <title>Example of LaTeX inclusion: Inline</title>
208
 
    <para>
209
 
      <latex><![CDATA[
 
3
    <refnamediv>
 
4
        <refname>example_1_function_1</refname>
 
5
        <refpurpose>"example_1_function_1" description</refpurpose>
 
6
    </refnamediv>
 
7
    <refsynopsisdiv>
 
8
        <title>Calling Sequence</title>
 
9
        <synopsis>a = example_1_function_1(b,c)</synopsis>
 
10
    </refsynopsisdiv>
 
11
    <refsection>
 
12
        <title>Parameters</title>
 
13
        <variablelist>
 
14
            <varlistentry>
 
15
                <term>b</term>
 
16
                <listitem>
 
17
                    <para>
 
18
                        "b" parameter description
 
19
                    </para>
 
20
                </listitem>
 
21
            </varlistentry>
 
22
            <varlistentry>
 
23
                <term>c</term>
 
24
                <listitem>
 
25
                    <para>
 
26
                        "c" parameter description
 
27
                    </para>
 
28
                </listitem>
 
29
            </varlistentry>
 
30
            <varlistentry>
 
31
                <term>a</term>
 
32
                <listitem>
 
33
                    <para>
 
34
                        "a" parameter description
 
35
                    </para>
 
36
                </listitem>
 
37
            </varlistentry>
 
38
        </variablelist>
 
39
    </refsection>
 
40
    <refsection>
 
41
        <title>Description</title>
 
42
        <itemizedlist>
 
43
            <listitem>
 
44
                <para>
 
45
                    example_1_function_1 full description
 
46
                </para>
 
47
            </listitem>
 
48
        </itemizedlist>
 
49
    </refsection>
 
50
    <refsection>
 
51
        <title>Example of image inclusion (PNG format)</title>
 
52
        <para>
 
53
            <inlinemediaobject>
 
54
                <imageobject>
 
55
                    <imagedata fileref="../images/plot3d.png" align="center" valign="middle"/>
 
56
                </imageobject>
 
57
            </inlinemediaobject>
 
58
        </para>
 
59
    </refsection>
 
60
    <refsection>
 
61
        <title>Example of image inclusion (SVG format)</title>
 
62
        <para>
 
63
            <inlinemediaobject>
 
64
                <imageobject>
 
65
                    <imagedata fileref="../images/fac3d.svg" align="center" valign="middle"/>
 
66
                </imageobject>
 
67
            </inlinemediaobject>
 
68
        </para>
 
69
    </refsection>
 
70
    <refsection>
 
71
        <title>Example of MathML inclusion: separate file</title>
 
72
        <para>
 
73
            <informalequation>
 
74
                <mediaobject>
 
75
                    <imageobject>
 
76
                        <imagedata align="center" fileref="../mml/quadratic.mml"/>
 
77
                    </imageobject>
 
78
                </mediaobject>
 
79
            </informalequation>
 
80
        </para>
 
81
    </refsection>
 
82
    <refsection>
 
83
        <title>
 
84
            Example of T<subscript>E</subscript>X inclusion: separate file
 
85
        </title>
 
86
        <para>
 
87
            <informalequation>
 
88
                <mediaobject>
 
89
                    <imageobject>
 
90
                        <imagedata align="center" fileref="../tex/math.tex"/>
 
91
                    </imageobject>
 
92
                </mediaobject>
 
93
            </informalequation>
 
94
        </para>
 
95
    </refsection>
 
96
    <refsection>
 
97
        <title>Example of MathML inclusion: Inline</title>
 
98
        <para>
 
99
            <informalequation>
 
100
                <mediaobject>
 
101
                    <imageobject>
 
102
                        <imagedata>
 
103
                            <mml:math>
 
104
                                <mml:semantics>
 
105
                                    <mml:mrow>
 
106
                                        <mml:mrow>
 
107
                                            <mml:mfenced mml:close="∣" mml:open="∣">
 
108
                                                <mml:msub>
 
109
                                                    <mml:mrow>
 
110
                                                        <mml:mo mml:stretchy="false">(</mml:mo>
 
111
                                                        <mml:mrow>
 
112
                                                            <mml:mi>z</mml:mi>
 
113
                                                            <mml:mrow>
 
114
                                                                <mml:mrow>
 
115
                                                                    <mml:mo mml:stretchy="false">(</mml:mo>
 
116
                                                                    <mml:mi>v</mml:mi>
 
117
                                                                    <mml:mo mml:stretchy="false">)</mml:mo>
 
118
                                                                </mml:mrow>
 
119
                                                                <mml:mo mml:stretchy="false">−</mml:mo>
 
120
                                                                <mml:mi>z</mml:mi>
 
121
                                                            </mml:mrow>
 
122
                                                            <mml:mrow>
 
123
                                                                <mml:mo mml:stretchy="false">(</mml:mo>
 
124
                                                                <mml:mi>u</mml:mi>
 
125
                                                                <mml:mo mml:stretchy="false">)</mml:mo>
 
126
                                                            </mml:mrow>
 
127
                                                        </mml:mrow>
 
128
                                                        <mml:mo mml:stretchy="false">)</mml:mo>
 
129
                                                    </mml:mrow>
 
130
                                                    <mml:mrow>
 
131
                                                        <mml:mi mml:fontstyle="italic">ltol</mml:mi>
 
132
                                                        <mml:mrow>
 
133
                                                            <mml:mo mml:stretchy="false">(</mml:mo>
 
134
                                                            <mml:mi>j</mml:mi>
 
135
                                                            <mml:mo mml:stretchy="false">)</mml:mo>
 
136
                                                        </mml:mrow>
 
137
                                                    </mml:mrow>
 
138
                                                </mml:msub>
 
139
                                            </mml:mfenced>
 
140
                                            <mml:mo mml:stretchy="false">≤</mml:mo>
 
141
                                            <mml:mi mml:fontstyle="italic">tol</mml:mi>
 
142
                                        </mml:mrow>
 
143
                                        <mml:mrow>
 
144
                                            <mml:mrow>
 
145
                                                <mml:mrow>
 
146
                                                    <mml:mo mml:stretchy="false">(</mml:mo>
 
147
                                                    <mml:mi>j</mml:mi>
 
148
                                                    <mml:mo mml:stretchy="false">)</mml:mo>
 
149
                                                </mml:mrow>
 
150
                                                <mml:mo mml:stretchy="false">⋅</mml:mo>
 
151
                                                <mml:mfenced mml:close="∣" mml:open="∣">
 
152
                                                    <mml:msub>
 
153
                                                        <mml:mrow>
 
154
                                                            <mml:mo mml:stretchy="false">(</mml:mo>
 
155
                                                            <mml:mrow>
 
156
                                                                <mml:mi>z</mml:mi>
 
157
                                                                <mml:mrow>
 
158
                                                                    <mml:mo mml:stretchy="false">(</mml:mo>
 
159
                                                                    <mml:mi>u</mml:mi>
 
160
                                                                    <mml:mo mml:stretchy="false">)</mml:mo>
 
161
                                                                </mml:mrow>
 
162
                                                            </mml:mrow>
 
163
                                                            <mml:mo mml:stretchy="false">)</mml:mo>
 
164
                                                        </mml:mrow>
 
165
                                                        <mml:mrow>
 
166
                                                            <mml:mi mml:fontstyle="italic">ltol</mml:mi>
 
167
                                                            <mml:mrow>
 
168
                                                                <mml:mo mml:stretchy="false">(</mml:mo>
 
169
                                                                <mml:mi>j</mml:mi>
 
170
                                                                <mml:mo mml:stretchy="false">)</mml:mo>
 
171
                                                            </mml:mrow>
 
172
                                                        </mml:mrow>
 
173
                                                    </mml:msub>
 
174
                                                </mml:mfenced>
 
175
                                            </mml:mrow>
 
176
                                            <mml:mo mml:stretchy="false">+</mml:mo>
 
177
                                            <mml:mi mml:fontstyle="italic">tol</mml:mi>
 
178
                                        </mml:mrow>
 
179
                                        <mml:mrow>
 
180
                                            <mml:mo mml:stretchy="false">(</mml:mo>
 
181
                                            <mml:mi>j</mml:mi>
 
182
                                            <mml:mo mml:stretchy="false">)</mml:mo>
 
183
                                        </mml:mrow>
 
184
                                        <mml:mi>,</mml:mi>
 
185
                                        <mml:mi mml:fontstyle="normal">for</mml:mi>
 
186
                                        <mml:mrow>
 
187
                                            <mml:mi>j</mml:mi>
 
188
                                            <mml:mo mml:stretchy="false">=</mml:mo>
 
189
                                            <mml:mn>1</mml:mn>
 
190
                                        </mml:mrow>
 
191
                                        <mml:mi mml:fontstyle="normal">:</mml:mi>
 
192
                                        <mml:mi mml:fontstyle="normal">ntol</mml:mi>
 
193
                                    </mml:mrow>
 
194
                                    <mml:annotation mml:encoding="StarMath 5.0">abs(z(v)-z(u))_{ltol(j)}
 
195
                                        &lt;= tol(j) cdot abs(z(u))_{ltol(j)} + tol(j), for
 
196
                                        j=1:ntol
 
197
                                    </mml:annotation>
 
198
                                </mml:semantics>
 
199
                            </mml:math>
 
200
                        </imagedata>
 
201
                    </imageobject>
 
202
                </mediaobject>
 
203
            </informalequation>
 
204
        </para>
 
205
    </refsection>
 
206
    <refsection>
 
207
        <title>Example of LaTeX inclusion: Inline</title>
 
208
        <para>
 
209
            <latex><![CDATA[
210
210
\phi_n(\kappa) = \frac{1}{4\pi^2\kappa^2} \int_0^\infty \frac{\sin(\kappa R)}{\kappa R}  \frac{\partial}{\partial R}\left[ R^2\frac{\partial D_n(R)}{\partial R}\right]\,dR
211
211
 ]]></latex>
212
 
    </para>
213
 
  </refsection>
214
 
  <refsection>
215
 
    <title>Examples</title>
216
 
    <programlisting role="example"><![CDATA[
 
212
        </para>
 
213
    </refsection>
 
214
    <refsection>
 
215
        <title>Examples</title>
 
216
        <programlisting role="example"><![CDATA[
217
217
// Comments
218
218
b = 2;
219
219
c = 3;
220
220
a = example_1_function_1(b,c);
221
221
  ]]></programlisting>
222
 
  </refsection>
223
 
  <refsection role="see also">
224
 
    <title>See Also</title>
225
 
    <simplelist type="inline">
226
 
      <member>
227
 
        <link linkend="example_1_function_2">example_1_function_2</link>
228
 
      </member>
229
 
      <member>
230
 
        <link linkend="example_1_function_3">example_1_function_3</link>
231
 
      </member>
232
 
      <member>
233
 
        <link linkend="example_1_function_4">example_1_function_4</link>
234
 
      </member>
235
 
      <member>
236
 
        <link linkend="example_1_function_5">example_1_function_5</link>
237
 
      </member>
238
 
      <member>
239
 
        <link linkend="example_1_function_6">example_1_function_6</link>
240
 
      </member>
241
 
      <member>
242
 
        <link linkend="example_1_function_7">example_1_function_7</link>
243
 
      </member>
244
 
    </simplelist>
245
 
  </refsection>
 
222
    </refsection>
 
223
    <refsection role="see also">
 
224
        <title>See Also</title>
 
225
        <simplelist type="inline">
 
226
            <member>
 
227
                <link linkend="example_1_function_2">example_1_function_2</link>
 
228
            </member>
 
229
            <member>
 
230
                <link linkend="example_1_function_3">example_1_function_3</link>
 
231
            </member>
 
232
            <member>
 
233
                <link linkend="example_1_function_4">example_1_function_4</link>
 
234
            </member>
 
235
            <member>
 
236
                <link linkend="example_1_function_5">example_1_function_5</link>
 
237
            </member>
 
238
            <member>
 
239
                <link linkend="example_1_function_6">example_1_function_6</link>
 
240
            </member>
 
241
            <member>
 
242
                <link linkend="example_1_function_7">example_1_function_7</link>
 
243
            </member>
 
244
        </simplelist>
 
245
    </refsection>
246
246
</refentry>