<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( https://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) INRIA - Serge Steer
 *
 * 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: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="titlepage">
    <refnamediv>
        <refname>titlepage</refname>
        <refpurpose>add a title in the middle of a graphics window</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Syntax</title>
        <synopsis>titlepage(str)</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>str</term>
                <listitem>
                    <para>matrix of strings</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            <function>titlepage</function> displays the matrix of strings <varname>str</varname> in the middle of
            the current graphics window
            with a font as big as possible, depending on the current axes and its geometry.
        </para>
    </refsection>

    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[
titlepage("This is the title of the page");
 ]]></programlisting>
        <scilab:image>
            titlepage("This is the title of the page");
        </scilab:image>

        <programlisting role="example"><![CDATA[
f=scf();
a1=f.children;
a1.margins(3)=0.61;
a2=newaxes();
a2.margins(4)=0.39;
sca(a1);
titlepage("Bottom title");
sca(a2);
titlepage("Top title");
 ]]></programlisting>
        <scilab:image localized="true">
            f=scf();
            a1=f.children;
            a1.margins(3)=0.61;
            a2=newaxes();
            a2.margins(4)=0.39;
            sca(a1);
            titlepage("Bottom title");
            sca(a2);
            titlepage("Top title");
        </scilab:image>
    </refsection>
    <refsection role="see also">
        <title>See also</title>
        <simplelist type="inline">
            <member>
                <link linkend="xtitle">xtitle</link>
            </member>
        </simplelist>
    </refsection>
</refentry>
