New serie of images in the graphic help.
[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" version="5.0-subset Scilab" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="xtitle">
14   <info>
15     <pubdate>$LastChangedDate$</pubdate>
16   </info>
17   <refnamediv>
18     <refname>xtitle</refname>
19     <refpurpose>add titles on a graphics
20       window
21     </refpurpose>
22   </refnamediv>
23   <refsynopsisdiv>
24     <title>Calling Sequence</title>
25     <synopsis>xtitle(title,[x_label,[y_label,[z_label]]],&lt;opts_args&gt;)</synopsis>
26   </refsynopsisdiv>
27   <refsection>
28     <title>Arguments</title>
29     <variablelist>
30       <varlistentry>
31         <term>title,x_label,y_label, z_label</term>
32         <listitem>
33           <para>matrices of strings.</para>
34           <para>
35             Starting from Scilab 5.2, it is possible to write <link linkend="math_rendering_features_in_graphic">LaTeX or MathML expression</link>.
36           </para>
37         </listitem>
38       </varlistentry>
39       <varlistentry>
40         <term>&lt;opt_args&gt;</term>
41         <listitem>
42           <para>
43             a sequence of statements <literal>key1=value1,
44               key2=value2
45             </literal>
46             ,... where keys may be <literal>boxed</literal> (see
47             below). In this case, the order has no special meaning.
48           </para>
49         </listitem>
50       </varlistentry>
51       <varlistentry>
52         <term>boxed</term>
53         <listitem>
54           <para>an integer value. If it is 1, a box is drawn around each
55             title.
56           </para>
57         </listitem>
58       </varlistentry>
59     </variablelist>
60   </refsection>
61   <refsection>
62     <title>Description</title>
63     <para>
64       <literal>xtitle</literal> add titles on a 2D or 3D plot. <literal>title</literal>
65       is the general title and <emphasis role="bold">x_label</emphasis>, <emphasis role="bold">y_label</emphasis> and
66       <emphasis role="bold">z_label</emphasis> are the titles on the three axis. If the arguments are
67       matrices, each line of the matrices is displayed on a different line.
68     </para>
69     <para>
70       Enter the command <literal>xtitle()</literal> to see a demo.
71     </para>
72   </refsection>
73   <refsection>
74     <title>Sample</title>
75     <scilab:image>
76       plot3d() ;
77       xtitle( 'My surface is blue', 'X axis', 'Y axis', 'Z axis' ) ;
78     </scilab:image>
79   </refsection>
80   <refsection>
81     
82     <title>Examples</title>
83     <programlisting role="example"><![CDATA[ 
84 plot3d() ;
85 // puts the titles
86 xtitle( 'My surface is blue', 'X axis', 'Y axis', 'Z axis' ) ;
87 // draw a box around the titles
88 xtitle( 'My surface is blue', 'X axis', 'Y axis', 'Z axis', boxed = 1 );
89
90
91 // With LaTeX & MathML:
92 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>";
93
94 xtitle( 'My surface is blue', 'X axis', '$Y axis$', mathml );
95  ]]></programlisting>
96   </refsection>
97   <refsection role="see also">
98     <title>See Also</title>
99     <simplelist type="inline">
100       <member>
101         <link linkend="titlepage">titlepage</link>
102       </member>
103       <member>
104         <link linkend="label_properties">label_properties</link>
105       </member>
106     </simplelist>
107   </refsection>
108 </refentry>