add CDATA + role in the helptools module
[scilab.git] / scilab / modules / helptools / help / pt_BR / help_skeleton.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) 2008 - INRIA
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 version="5.0-subset Scilab" xml:id="help_skeleton" xml:lang="en"
14           xmlns="http://docbook.org/ns/docbook"
15           xmlns:xlink="http://www.w3.org/1999/xlink"
16           xmlns:svg="http://www.w3.org/2000/svg"
17           xmlns:ns3="http://www.w3.org/1999/xhtml"
18           xmlns:mml="http://www.w3.org/1998/Math/MathML"
19           xmlns:db="http://docbook.org/ns/docbook">
20   <info>
21     <pubdate>$LastChangedDate: 2008-03-26 08:50:39 +0000 (mer, 26 mar 2008)
22     $</pubdate>
23   </info>
24
25   <refnamediv>
26     <refname>help_skeleton</refname>
27
28     <refpurpose>constrói o esqueleto do arquivo de ajuda xml associado à
29     função Scilab</refpurpose>
30   </refnamediv>
31
32   <refsynopsisdiv>
33     <title>Seqüência de Chamamento</title>
34
35     <synopsis>txt = help_skeleton(funname [,path [,language]])</synopsis>
36   </refsynopsisdiv>
37
38   <refsection>
39     <title>Parâmetros</title>
40
41     <variablelist>
42       <varlistentry>
43         <term>funname</term>
44
45         <listitem>
46           <para>string : o nome da função</para>
47         </listitem>
48       </varlistentry>
49
50       <varlistentry>
51         <term>path</term>
52
53         <listitem>
54           <para>string : o endereço onde se criará o arquivo, se for
55           requerido. Se este argumento não for fornecido, o esqueleto é
56           retornado como um string.</para>
57         </listitem>
58       </varlistentry>
59
60       <varlistentry>
61         <term>language</term>
62
63         <listitem>
64           <para>string :com valor possível "fr_FR" ou "en_US" o padrão é
65           "en_US"</para>
66         </listitem>
67       </varlistentry>
68
69       <varlistentry>
70         <term>txt</term>
71
72         <listitem>
73           <para>o código xml ou o endereço do arquivo xml completo</para>
74
75           <para></para>
76         </listitem>
77       </varlistentry>
78     </variablelist>
79   </refsection>
80
81   <refsection>
82     <title>Descrição</title>
83
84     <para><literal>txt = help_skeleton(funname)</literal> gera um vetor de
85     strings contendo o esqueleto do código XML descrevendo a ajuda da função
86     <literal>funname</literal>.</para>
87
88     <para><literal>fullpath = help_skeleton(funname,dirpath)</literal> gera o
89     código XML descrevendo a ajuda da função <literal>funname</literal> em um
90     arquivo nomeado <literal>funname.xml</literal> no diretório especificado
91     pelo endereço <literal>dirpath</literal>. Neste caso, a função retorna o
92     endereço do arquivo.</para>
93   </refsection>
94
95   <refsection>
96     <title>Exemplos</title>
97
98     <programlisting role="example"><![CDATA[ 
99 function [y,z]=foo(a,b),y=a+b,z=1,endfunction
100 p=help_skeleton('foo',TMPDIR)
101 scipad(p)
102  ]]></programlisting>
103   </refsection>
104
105   <refsection>
106     <title>Ver Também</title>
107
108     <simplelist type="inline">
109       <member><link linkend="help">help</link></member>
110     </simplelist>
111   </refsection>
112
113   <refsection>
114     <title>Autor</title>
115
116     <para>Serge Steer, INRIA</para>
117   </refsection>
118 </refentry>