Indent all the XML files to the same way
[scilab.git] / scilab / modules / graphics / help / en_US / annotation / xtitle.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) ENPC - Jean-Philippe Chancelier
5  * 
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at    
10  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11  *
12  -->
13 <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" version="5.0-subset Scilab" xml:lang="en" xml:id="xtitle">
14     <refnamediv>
15         <refname>xtitle</refname>
16         <refpurpose>add titles on a graphics
17             window
18         </refpurpose>
19     </refnamediv>
20     <refsynopsisdiv>
21         <title>Calling Sequence</title>
22         <synopsis>xtitle(title,[x_label,[y_label,[z_label]]],&lt;opts_args&gt;)</synopsis>
23     </refsynopsisdiv>
24     <refsection>
25         <title>Arguments</title>
26         <variablelist>
27             <varlistentry>
28                 <term>title,x_label,y_label, z_label</term>
29                 <listitem>
30                     <para>matrices of strings.</para>
31                     <para>
32                         Starting from Scilab 5.2, it is possible to write <link linkend="math_rendering_features_in_graphic">LaTeX or MathML expression</link>.
33                     </para>
34                 </listitem>
35             </varlistentry>
36             <varlistentry>
37                 <term>&lt;opt_args&gt;</term>
38                 <listitem>
39                     <para>
40                         a sequence of statements <literal>key1=value1,
41                             key2=value2
42                         </literal>
43                         ,... where keys may be <literal>boxed</literal> (see
44                         below). In this case, the order has no special meaning.
45                     </para>
46                 </listitem>
47             </varlistentry>
48             <varlistentry>
49                 <term>boxed</term>
50                 <listitem>
51                     <para>an integer value. If it is 1, a box is drawn around each
52                         title.
53                     </para>
54                 </listitem>
55             </varlistentry>
56         </variablelist>
57     </refsection>
58     <refsection>
59         <title>Description</title>
60         <para>
61             <literal>xtitle</literal> add titles on a 2D or 3D plot. <literal>title</literal>
62             is the general title and <emphasis role="bold">x_label</emphasis>, <emphasis role="bold">y_label</emphasis> and
63             <emphasis role="bold">z_label</emphasis> are the titles on the three axis. If the arguments are
64             matrices, each line of the matrices is displayed on a different line.
65         </para>
66         <para>
67             Enter the command <literal>xtitle()</literal> to see a demo.
68         </para>
69     </refsection>
70     <refsection>
71         <title>Sample</title>
72         <scilab:image>
73             plot3d() ;
74             xtitle( 'My surface is blue', 'X axis', 'Y axis', 'Z axis' ) ;
75         </scilab:image>
76     </refsection>
77     <refsection>
78         <title>Examples</title>
79         <programlisting role="example"><![CDATA[ 
80 plot3d() ;
81 // puts the titles
82 xtitle( 'My surface is blue', 'X axis', 'Y axis', 'Z axis' ) ;
83 // draw a box around the titles
84 xtitle( 'My surface is blue', 'X axis', 'Y axis', 'Z axis', boxed = 1 );
85
86
87 // With LaTeX & MathML:
88 mathml="<mrow>      <mfrac>        <mrow>          <mi>d</mi>          <mi>y</mi>        </mrow>        <mrow>          <mi>d</mi>          <mi>x</mi>        </mrow>      </mfrac>      <mo>=</mo>      <mfrac>        <mn>1</mn>        <msup>          <mi>y</mi>          <mn>2</mn>        </msup>      </mfrac>    </mrow>";
89
90 xtitle( 'My surface is blue', 'X axis', '$Y axis$', mathml );
91  ]]></programlisting>
92     </refsection>
93     <refsection role="see also">
94         <title>See Also</title>
95         <simplelist type="inline">
96             <member>
97                 <link linkend="titlepage">titlepage</link>
98             </member>
99             <member>
100                 <link linkend="label_properties">label_properties</link>
101             </member>
102         </simplelist>
103     </refsection>
104 </refentry>