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