Revision of help page for fchamp function (en_US). 82/10382/2
Stanislav KROTER [Wed, 30 Jan 2013 09:17:42 +0000 (15:17 +0600)]
Change-Id: Ic629c491589cb1395e30602f5a9a2a1ceda4c060

scilab/modules/graphics/help/en_US/2d_plot/fchamp.xml

index bc77e36..8084b3a 100644 (file)
 <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" xmlns:scilab="http://www.scilab.org"  xml:lang="en" xml:id="fchamp">
     <refnamediv>
         <refname>fchamp</refname>
-        <refpurpose>direction field of a 2D first order
-            ODE
+        <refpurpose>
+            direction field of a 2D first order ODE
         </refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>fchamp(f,t,xr,yr,[arfact,rect,strf])
-            fchamp(f,t,xr,yr,&lt;opt_args&gt;)
+        <synopsis>
+            fchamp(f, t, xr, yr, [arfact, rect, strf])
+            fchamp(f, t, xr, yr, &lt;opt_args&gt;)
         </synopsis>
     </refsynopsisdiv>
     <refsection>
             <varlistentry>
                 <term>f</term>
                 <listitem>
-                    <para>An external (function or character string) or a list which
-                        describes the ODE.
+                    <para>
+                        an external (function or character string) or a list
+                        which describes the ODE.
                     </para>
                     <variablelist>
                         <varlistentry>
                             <term>-</term>
                             <listitem>
                                 <para>
-                                    It can be a function name <literal>f</literal>, where
-                                    <literal>f</literal> is supposed to be a function of type
-                                    <literal>y=f(t,xy [p1,..pn])</literal>. <literal>f</literal> returns a
-                                    column vector of size 2, <literal>y</literal>, which gives the value
-                                    of the direction field <literal>f</literal> at point
-                                    <literal>xy=[x,y]</literal> and at time <literal>t</literal>.
+                                    It can be a function name <varname>f</varname>,
+                                    where <varname>f</varname> is supposed to be
+                                    a function of type <literal>y=f(t, xy, [p1, ..., pn])</literal>.
+                                    <varname>f</varname> returns a column vector
+                                    of size 2, <varname>y</varname>, which gives
+                                    the value of the direction field <varname>f</varname>
+                                    at point <literal>xy=[x,y]</literal> and at
+                                    time <varname>t</varname>.
                                 </para>
                             </listitem>
                         </varlistentry>
                         <varlistentry>
                             <term>-</term>
                             <listitem>
-                                <para>It can also be an object of type list,
-                                    <literal>list(f,P1,..Pn)</literal> where <literal>f</literal> is a
-                                    function of type <literal>y=f(t,xy,p1,..pn)</literal> and
-                                    <literal>Pi</literal> gives the value of the parameter
-                                    <literal>pi</literal>.
+                                <para>
+                                    It can also be an object of type list,
+                                    <literal>list(f,P1, ..., Pn)</literal> where
+                                    <literal>f</literal> is a function of type
+                                    <literal>y=f(t, xy, p1, ..., pn)</literal>
+                                    and <literal>Pi</literal> gives the value of
+                                    the parameter <literal>pi</literal>.
                                 </para>
                             </listitem>
                         </varlistentry>
             <varlistentry>
                 <term>t</term>
                 <listitem>
-                    <para>The selected time.</para>
+                    <para>the selected time.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>xr,yr</term>
+                <term>xr, yr</term>
                 <listitem>
-                    <para>Two row vectors of size n1 and n2 which define the grid on
+                    <para>
+                        two row vectors of size <literal>n1</literal> and
+                        <literal>n2</literal> which define the grid on
                         which the direction field is computed.
                     </para>
                 </listitem>
                 <term>&lt;opt_args&gt;</term>
                 <listitem>
                     <para>
-                        This represents a sequence of statements <literal>key1=value1,key2=value2</literal>,
-                        ... where <literal>key1</literal>,
-                        <literal>key2,...</literal> can be one of the following: arfact, rect,
-                        strf (see below).
+                        This represents a sequence of statements
+                        <literal>key1=value1, key2=value2</literal>,...
+                        where <literal>key1</literal>, <literal>key2</literal>,...
+                        can be one of the following: <literal>arfact</literal>,
+                        <literal>rect</literal>, <literal>strf</literal> (see
+                        below).
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>arfact,rect,strf</term>
+                <term>arfact, rect, strf</term>
                 <listitem>
                     <para>
-                        Optional arguments, see <literal>champ</literal>.
+                        Optional arguments, see <function>champ</function>.
                     </para>
                 </listitem>
             </varlistentry>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>fchamp</literal> is used to draw the direction field of a 2D first
-            order ODE defined by the external function <literal>f</literal>. Note that if
-            the ODE is autonomous, argument <literal>t</literal> is useless, but it must be
-            given.
+            <function>fchamp</function> is used to draw the direction field of a
+            2D first order ODE defined by the external function
+            <varname>f</varname>.
+            <note>
+                Note that if the ODE is autonomous, argument
+                <varname>t</varname> is useless, but it must be given.
+            </note>
         </para>
         <para>
-            Enter the command <literal>fchamp()</literal> to see a demo.
+            Enter the command <code>fchamp()</code> to see a demo.
         </para>
     </refsection>
     <refsection>