add CDATA + role in the helptools module
[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  * 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="helps" 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$</pubdate>
22   </info>
23
24   <refnamediv>
25     <refname>%helps</refname>
26
27     <refpurpose>variável definindo o endereço dos diretórios de
28     ajuda</refpurpose>
29   </refnamediv>
30
31   <refsection>
32     <title>Descrição</title>
33
34     <para>A variável global <literal>%helps</literal> é uma matriz N x 2 de
35     strings. A k-ésima linha de <literal>%helps</literal>,
36     <literal>%helps(k,:)</literal> representa o k-ésimo capítulo do manual e é
37     feita de dois strings:</para>
38
39     <para><literal>%helps(k,1)</literal> é o nome de endereço absoluto de um
40     diretório.</para>
41
42     <para><literal>%helps(k,2)</literal> é um título para este diretório. Por
43     exemplo, para k=2, nós temos o capítulo de gráficos
44     <literal>%helps(2,:)</literal>.</para>
45
46     <para>A variável <literal>%helps</literal> é definida no arquivo de
47     inicialização do Scilab <literal>SCI+"/scilab.start"</literal>.</para>
48
49     <para>Para adicionar um novo diretório de ajuda, o usuário deve adicionar
50     uma linha a <literal>%helps</literal>. (Uma linha para cada
51     diretório).</para>
52
53     <para>Por exemplo, <literal>%helps=[%helps;
54     "Path-Of-My-Help-Dir","My-Title"];</literal> 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".</para>
57
58     <para>"My-Title" é, então, o título do novo capítulo de ajuda.</para>
59
60     <para>Um diretório válido deve conter:</para>
61
62     <para>1- Um conjunto de arquivos<literal>.html</literal> (ex.:
63     <literal>item1.html, item2.html</literal> etc). Os arquivos
64     <literal>.html</literal> são geralmente construídos de arquivos
65     XML.</para>
66
67     <para>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:</para>
70
71     <programlisting role = ""><![CDATA[ 
72 <BR><A HREF="item.html">item</A> - rápida descrição
73  ]]></programlisting>
74
75     <para><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>.</para>
78
79     <para>O comando <literal>apropos keyword</literal> retorna as linhas de
80     todos os arquivos <literal>whatis.html</literal> nos quais a palavra-chave
81     keyword aparece.</para>
82
83     <para>Em plataformas Linux, o Scilab provê um Makefile para transformar
84     páginas <literal>.xml</literal> pages em páginas <literal>.html</literal>
85     (ver SCIDIR/examples/man-examples).</para>
86   </refsection>
87
88   <refsection>
89     <title>Ver Também</title>
90
91     <simplelist type="inline">
92       <member><link linkend="apropos">apropos</link></member>
93
94       <member><link linkend="help">help</link></member>
95
96       <member><link linkend="man">man</link></member>
97     </simplelist>
98   </refsection>
99 </refentry>