f5361f7fb7c2214be0dff0034d27eaecb9f5eb34
[scilab.git] / scilab / modules / helptools / help / pt_BR / percenthelps.xml
1 <?xml version="1.0" encoding="ISO-8859-1"?>
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" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="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="percenthelps" xml:lang="pt">
17     <refnamediv>
18         <refname>%helps</refname>
19         <refpurpose>variável definindo o endereço dos diretórios de
20             ajuda
21         </refpurpose>
22     </refnamediv>
23     <refsection>
24         <title>Descrição</title>
25         <para>
26             A variável global <literal>%helps</literal> é uma matriz N x 2 de
27             strings. A k-ésima linha de <literal>%helps</literal>,
28             <literal>%helps(k,:)</literal> representa o k-ésimo capítulo do manual e é
29             feita de dois strings:
30         </para>
31         <para>
32             <literal>%helps(k,1)</literal> é o nome de endereço absoluto de um
33             diretório.
34         </para>
35         <para>
36             <literal>%helps(k,2)</literal> é um título para este diretório. Por
37             exemplo, para k=2, nós temos o capítulo de gráficos
38             <literal>%helps(2,:)</literal>.
39         </para>
40         <para>
41             A variável <literal>%helps</literal> é definida no arquivo de
42             inicialização do Scilab <literal>SCI+"/scilab.start"</literal>.
43         </para>
44         <para>Para adicionar um novo diretório de ajuda, o usuário deve adicionar
45             uma linha a <literal>%helps</literal>. (Uma linha para cada
46             diretório).
47         </para>
48         <para>
49             Por exemplo, <literal>%helps=[%helps;
50                 "Path-Of-My-Help-Dir","My-Title"];
51             </literal>
52             habilita o navegador de ajuda
53             do Scilab a procurar por itens do manual de ajuda no diretório com
54             endereço "Path-Of-My-Help-Dir".
55         </para>
56         <para>"My-Title" é, então, o título do novo capítulo de ajuda.</para>
57         <para>Um diretório válido deve conter:</para>
58         <para>
59             1- Um conjunto de arquivos<literal>.html</literal> (ex.:
60             <literal>item1.html, item2.html</literal> etc). Os arquivos
61             <literal>.html</literal> são geralmente construídos de arquivos
62             XML.
63         </para>
64         <para>
65             2- Um arquivo <literal>whatis.html</literal>, que deve conter um
66             formato especial. Cada linha de <literal>whatis</literal> deve ser como
67             segue:
68         </para>
69         <programlisting role="xml"><![CDATA[
70 <BR><A HREF="item.html">item</A> - rápida descrição
71  ]]></programlisting>
72         <para>
73             <literal>item</literal> é o item da ajuda, i.e. o comando
74             <literal>help item</literal> exibe o conteúdo do arquivo
75             <literal>item.html</literal>.
76         </para>
77         <para>
78             O comando <literal>apropos keyword</literal> retorna as linhas de
79             todos os arquivos <literal>whatis.html</literal> nos quais a palavra-chave
80             keyword aparece.
81         </para>
82         <para>Em plataformas Linux, o Scilab provê um Makefile para transformar
83             páginas <literal>.xml</literal> pages em páginas <literal>.html</literal>
84             (ver SCIDIR/examples/man-examples).
85         </para>
86     </refsection>
87     <refsection role="see also">
88         <title>Ver Também</title>
89         <simplelist type="inline">
90             <member>
91                 <link linkend="apropos">apropos</link>
92             </member>
93             <member>
94                 <link linkend="help">help</link>
95             </member>
96             <member>
97                 <link linkend="man">man</link>
98             </member>
99         </simplelist>
100     </refsection>
101 </refentry>