add CDATA + role in the helptools module
[scilab.git] / scilab / modules / helptools / help / pt_BR / xmltopdf.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="xmltopdf" 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:ns4="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-14 11:58:09 +0100 (ven, 14 mar 2008)
22     $</pubdate>
23   </info>
24
25   <refnamediv>
26     <refname>xmltopdf</refname>
27
28     <refpurpose>converte arquivos de ajuda xml do Scilab para formato
29     PDF</refpurpose>
30   </refnamediv>
31
32   <refsynopsisdiv>
33     <title>Seqüência de Chamamento</title>
34
35     <synopsis>xmltopdf(dirs [,titles [,dir_language [default_language]]]]])</synopsis>
36   </refsynopsisdiv>
37
38   <refsection>
39     <title>Parâmetros</title>
40
41     <variablelist>
42       <varlistentry>
43         <term>dirs</term>
44
45         <listitem>
46           <para>vetor de strings: um conjunto de endereços de diretórios para
47           os quais os manuais pdf devem ser gerados ou <literal>[]
48           </literal></para>
49         </listitem>
50       </varlistentry>
51
52       <varlistentry>
53         <term>titles</term>
54
55         <listitem>
56           <para>vetor de strings: títulos associados a endereços de diretórios
57           ou []</para>
58         </listitem>
59       </varlistentry>
60
61       <varlistentry>
62         <term>dir_language</term>
63
64         <listitem>
65           <para>vetor de strings: idiomas associados a endereços de diretórios
66           ou []</para>
67         </listitem>
68       </varlistentry>
69
70       <varlistentry>
71         <term>default_language</term>
72
73         <listitem>
74           <para>vetor de strings: idiomas padrões associados aos endereços de
75           diretórios ou []. Se um arquivo XML estiver faltando em
76           dir_language, ele é copiado de default_language.</para>
77         </listitem>
78       </varlistentry>
79     </variablelist>
80   </refsection>
81
82   <refsection>
83     <title>Descrição</title>
84
85     <para>Converte arquivos de ajuda Scilab contidos em um conjunto de
86     diretórios para formato PDF</para>
87   </refsection>
88
89   <refsection>
90     <title>Exemplos</title>
91
92     <programlisting role="example"><![CDATA[ 
93 // example_1/
94 // `-- help
95 //     |-- en_US
96 //     |   |-- example_1_function_1.xml
97 //     |   |-- example_1_function_2.xml
98 //     |   `-- example_1_function_3.xml
99 //     `-- fr_FR
100 //         |-- example_1_function_1.xml
101 //         |-- example_1_function_2.xml
102 //         `-- example_1_function_3.xml
103 //     `-- zh_TW
104 //         |-- example_1_function_1.xml
105 //         |-- example_1_function_2.xml
106 //         `-- example_1_function_3.xml
107
108 my_module_path = pathconvert(SCI+'/modules/helptools/examples/example_1',%f,%f)
109
110 // Construindo a ajuda em francês
111 // =============================================================================
112 my_french_help_dir    = my_module_path+'/help/fr_FR';
113 my_french_help_title  = 'Example 1 [fr_FR]';
114 my_french_pdf         = xmltopdf(my_french_help_dir,my_french_help_title,'fr_FR')
115
116 // Construindo a ajuda em inglês
117 // =============================================================================
118 my_english_help_dir   = my_module_path+'/help/en_US';
119 my_english_help_title = 'Example 1 [en_US]';
120 my_english_pdf        = xmltopdf(my_english_help_dir,my_english_help_title,'en_US')
121
122 // Construindo a ajuda em chinês
123 // =============================================================================
124 my_chinese_help_dir   = my_module_path+'/help/zh_TW';
125 my_chinese_help_title = 'Example 1 [zh_TW]';
126 my_chinese_pdf        = xmltopdf(my_chinese_help_dir,my_chinese_help_title,'zh_TW')
127  ]]></programlisting>
128   </refsection>
129
130   <refsection>
131     <title>Ver Também</title>
132
133     <simplelist type="inline">
134       <member><link linkend="help">help</link></member>
135
136       <member><link
137       linkend="add_help_chapter">add_help_chapter</link></member>
138     </simplelist>
139   </refsection>
140 </refentry>