~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/helptools/help/pt_BR/percenthelps.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

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