<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( https://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 2008 - INRIA
 *
 * 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:ns3="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="help_skeleton" xml:lang="pt">
    <refnamediv>
        <refname>help_skeleton</refname>
        <refpurpose>constrói o esqueleto do arquivo de ajuda xml associado à
            função Scilab
        </refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Seqüência de Chamamento</title>
        <synopsis>txt = help_skeleton(funname [,path [,language]])</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Parâmetros</title>
        <variablelist>
            <varlistentry>
                <term>funname</term>
                <listitem>
                    <para>string : o nome da função</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>path</term>
                <listitem>
                    <para>string : o endereço onde se criará o arquivo, se for
                        requerido. Se este argumento não for fornecido, o esqueleto é
                        retornado como um string.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>language</term>
                <listitem>
                    <para>string :com valor possível "fr_FR" ou "en_US" o padrão é
                        "en_US"
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>txt</term>
                <listitem>
                    <para>o código xml ou o endereço do arquivo xml completo</para>
                    <para/>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Descrição</title>
        <para>
            <literal>txt = help_skeleton(funname)</literal> gera um vetor de
            strings contendo o esqueleto do código XML descrevendo a ajuda da função
            <literal>funname</literal>.
        </para>
        <para>
            <literal>fullpath = help_skeleton(funname,dirpath)</literal> gera o
            código XML descrevendo a ajuda da função <literal>funname</literal> em um
            arquivo nomeado <literal>funname.xml</literal> no diretório especificado
            pelo endereço <literal>dirpath</literal>. Neste caso, a função retorna o
            endereço do arquivo.
        </para>
    </refsection>
    <refsection>
        <title>Exemplos</title>
        <programlisting role="example"><![CDATA[
function [y,z]=foo(a,b),y=a+b,z=1,endfunction
p=help_skeleton('foo',TMPDIR)
if (isdef('editor') | (funptr('editor')<>0)) then
  editor(p);
end
 ]]></programlisting>
    </refsection>
    <refsection>
        <title>Ver Também</title>
        <simplelist type="inline">
            <member>
                <link linkend="help">help</link>
            </member>
        </simplelist>
    </refsection>
</refentry>
