<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( https://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) ENPC - Jean-Philippe Chancelier
 *
 * Copyright (C) 2012 - 2016 - Scilab Enterprises
 *
 * This file is hereby licensed under the terms of the GNU GPL v2.0,
 * pursuant to article 5.3.4 of the CeCILL v.2.1.
 * This file was originally licensed under the terms of the CeCILL v2.1,
 * and continues to be available under such terms.
 * For more information, see the COPYING file which you should have received
 * along with this program.
 *
 -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="xtitle" xml:lang="pt">
    <refnamediv>
        <refname>xtitle</refname>
        <refpurpose>adidciona títulos a janelas de gráficos</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Seqüência de Chamamento</title>
        <synopsis>xtitle(title,[x_label,[y_label,[z_label]]],&lt;opts_args&gt;)</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Parâmetros</title>
        <variablelist>
            <varlistentry>
                <term>title,x_label,y_label, z_label</term>
                <listitem>
                    <para>matrizes de strings </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>&lt;opt_args&gt;</term>
                <listitem>
                    <para>
                        uma seqüência de declarações <literal>key1=value1,
                            key2=value2
                        </literal>
                        ,... onde keys podem ser
                        <literal>boxed</literal> (ver abaixo). Nesse caso, a ordem não tem
                        valor especial
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>boxed</term>
                <listitem>
                    <para>um valor inteiro. Se for 1, um retângulo é desenhado ao redor
                        de cada título.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Descrição</title>
        <para>
            <literal>xtitle</literal> adiciona títulos a um esboço 2d ou 3d.
            <literal>title</literal> é o título geral e <emphasis role="bold">x_label</emphasis>, <emphasis role="bold">y_label</emphasis> e
            <emphasis role="bold">z_label</emphasis> são os títulos dos três eixos. Se
            os argumentos são matrizes, cada linha das matrizes é exibida em uma linha
            diferente.
        </para>
        <para>
            Entre com o comando <literal>xtitle()</literal> para visualizar uma
            demonstração.
        </para>
    </refsection>
    <refsection>
        <title>Exemplos</title>
        <programlisting role="example"><![CDATA[
// desenhando uma superfície
plot3d() ;
// pondo os títulos
xtitle( 'Minha superfície é azul', 'eixo X', 'eixo Y', 'eixo Z' ) ;
// desenhando uma caixa ao redor dos títulos
xtitle( 'Minha superfície é azul', 'eixo X', 'eixo Y', 'eixo Z' , boxed = %t ) ;
 ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>Ver Também</title>
        <simplelist type="inline">
            <member>
                <link linkend="titlepage">titlepage</link>
                <link linkend="label_properties">label_properties</link>
            </member>
        </simplelist>
    </refsection>
</refentry>
