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