Bug Fix #12431 - Updated %helps help page
[scilab.git] / scilab / modules / helptools / help / pt_BR / percenthelps.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  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  -->
16 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
17           xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml"
18           xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook"
19           xmlns:scilab="http://www.scilab.org" xml:id="percenthelps" xml:lang="pt">
20     <refnamediv>
21         <refname>%helps</refname>
22         <refpurpose>variável definindo o endereço dos diretórios de ajuda
23         </refpurpose>
24     </refnamediv>
25     <refsection role="description">
26         <title>Descrição</title>
27         <para>
28             A variável global <literal>%helps</literal> é uma matriz N x 2 de
29             strings. A k-ésima linha de <literal>%helps</literal>,
30             <literal>%helps(k,:)</literal> representa o k-ésimo capítulo do manual e é
31             feita de dois strings:
32         </para>
33         <para>
34             <literal>%helps(k,1)</literal> é o nome de endereço absoluto de um
35             diretório.
36         </para>
37         <para>
38             <literal>%helps(k,2)</literal> é um título para este diretório. Por
39             exemplo, para k=2, nós temos o capítulo de gráficos
40             <literal>%helps(2,:)</literal>.
41         </para>
42         <para>
43             A variável <literal>%helps</literal> é definida no arquivo de
44             inicialização do Scilab <literal>SCI+"/scilab.start"</literal>.
45         </para>
46         <para>Para adicionar um novo diretório de ajuda, o usuário deve adicionar
47             uma linha a <literal>%helps</literal>. (Uma linha para cada
48             diretório).
49         </para>
50         <para>
51             Por exemplo, <literal>%helps=[%helps;
52                 "Path-Of-My-Help-Dir","My-Title"];
53             </literal>
54             habilita o navegador de ajuda
55             do Scilab a procurar por itens do manual de ajuda no diretório com
56             endereço "Path-Of-My-Help-Dir".
57         </para>
58         <para>"My-Title" é, então, o título do novo capítulo de ajuda.</para>
59         <para>Um diretório válido deve conter:</para>
60         <para>
61             1- Um conjunto de arquivos<literal>.html</literal> (ex.:
62             <literal>item1.html, item2.html</literal> etc). Os arquivos
63             <literal>.html</literal> são geralmente construídos de arquivos
64             XML.
65         </para>
66         <para>
67             2- Um arquivo <literal>whatis.html</literal>, que deve conter um
68             formato especial. Cada linha de <literal>whatis</literal> deve ser como
69             segue:
70         </para>
71         <programlisting role="xml"><![CDATA[
72 <BR><A HREF="item.html">item</A> - rápida descrição
73  ]]></programlisting>
74         <para>
75             <literal>item</literal> é o item da ajuda, i.e. o comando
76             <literal>help item</literal> exibe o conteúdo do arquivo
77             <literal>item.html</literal>.
78         </para>
79         <para>
80             O comando <literal>apropos keyword</literal> retorna as linhas de
81             todos os arquivos <literal>whatis.html</literal> nos quais a palavra-chave
82             keyword aparece.
83         </para>
84         <para>Em plataformas Linux, o Scilab provê um Makefile para transformar
85             páginas <literal>.xml</literal> pages em páginas <literal>.html</literal>
86             (ver SCIDIR/examples/man-examples).
87         </para>
88     </refsection>
89     <refsection role="examples">
90        <title>Exemplos</title>
91         <programlisting role="example"><![CDATA[
92 global %helps  // This instruction creates a local %helps variable connected to the global one
93 %helps
94 if %helps==[]                    // No help chapter is registered for any external module
95     if atomsGetInstalled()==[]   // If no external module is installed
96         atomsInstall uman;       //  we install the "uman" one (available for all plateforms)
97     end
98     atomsLoad(atomsGetInstalled()(1));  // We load the first module, included its help pages
99     %helps                       // Now the external chapter should be registered
100 end
101       ]]></programlisting>
102     </refsection>
103     <refsection role="see also">
104         <title>Ver Também</title>
105         <simplelist type="inline">
106             <member>
107                 <link linkend="apropos">apropos</link>
108             </member>
109             <member>
110                 <link linkend="help">help</link>
111             </member>
112         </simplelist>
113     </refsection>
114 </refentry>