add CDATA + role in the helptools module
Yann Collette [Fri, 4 Sep 2009 06:45:08 +0000 (08:45 +0200)]
24 files changed:
scilab/modules/helptools/help/en_US/apropos.xml
scilab/modules/helptools/help/en_US/help_from_sci.xml
scilab/modules/helptools/help/en_US/help_skeleton.xml
scilab/modules/helptools/help/en_US/man.xml
scilab/modules/helptools/help/en_US/manedit.xml
scilab/modules/helptools/help/en_US/percenthelps.xml
scilab/modules/helptools/help/en_US/xmltochm.xml
scilab/modules/helptools/help/en_US/xmltohtml.xml
scilab/modules/helptools/help/en_US/xmltojar.xml
scilab/modules/helptools/help/en_US/xmltopdf.xml
scilab/modules/helptools/help/en_US/xmltops.xml
scilab/modules/helptools/help/fr_FR/apropos.xml
scilab/modules/helptools/help/fr_FR/percenthelps.xml
scilab/modules/helptools/help/pt_BR/apropos.xml
scilab/modules/helptools/help/pt_BR/foo.xml
scilab/modules/helptools/help/pt_BR/help_from_sci.xml
scilab/modules/helptools/help/pt_BR/help_skeleton.xml
scilab/modules/helptools/help/pt_BR/man.xml
scilab/modules/helptools/help/pt_BR/manedit.xml
scilab/modules/helptools/help/pt_BR/percenthelps.xml
scilab/modules/helptools/help/pt_BR/xmltohtml.xml
scilab/modules/helptools/help/pt_BR/xmltojar.xml
scilab/modules/helptools/help/pt_BR/xmltopdf.xml
scilab/modules/helptools/help/pt_BR/xmltops.xml

index 5df5428..6172d19 100644 (file)
@@ -51,14 +51,14 @@ apropos(regexp)</synopsis>
   </refsection>
   <refsection>
     <title>Examples</title>
-    <programlisting role="example"><![CDATA[
+    <programlisting role="example"><![CDATA[ 
 apropos('ode')
 apropos ode 
 apropos "list of"
 apropos "sin.*hyperbolic"
 apropos "^ab"  //search help beginning the two characters "ab"
 apropos "quadratic.*solver"
-  ]]></programlisting>
+ ]]></programlisting>
   </refsection>
   <refsection>
     <title>See Also</title>
index 2102d11..49677cd 100644 (file)
@@ -96,7 +96,7 @@ following the References headline.</para></listitem>
 
 <refsection>
    <title>Examples</title>
-   <programlisting role="example">
+   <programlisting role="example"><![CDATA[ 
 help_from_sci()   // Open an empty source code template in the Scipad editor.
 // Save this template as test_fun.sci in the current directory before running
 // the next example commands.
@@ -113,8 +113,7 @@ help_from_sci('test_fun','.','.')
 // This command would process all .sci files in the macros directory
 // and use the head comments section to update all .xml help files in the
 // help\en_US directory an rebuild the .dem.sce files in the demos\ directory.
-
-   </programlisting>
+ ]]></programlisting>
 </refsection>
 
 <refsection>
index 86fb37c..8e598b1 100644 (file)
   <refsection>
     <title>Examples</title>
 
-    <programlisting role="example">
-
-   function [y,z]=foo(a,b),y=a+b,z=1,endfunction
-    p=help_skeleton('foo',TMPDIR)
-    scipad(p)
-  
-  </programlisting>
+    <programlisting role="example"><![CDATA[ 
+function [y,z]=foo(a,b),y=a+b,z=1,endfunction
+p=help_skeleton('foo',TMPDIR)
+scipad(p)
+ ]]></programlisting>
   </refsection>
 
   <refsection>
 
     <para>Serge Steer, INRIA</para>
   </refsection>
-</refentry>
\ No newline at end of file
+</refentry>
index f7d3219..b56866c 100644 (file)
       (most of the cases) but may be simply  'Scilab keyword' or 'Scilab data type', ..., 
       depending of what explains the help page. 
    </para>
-    <programlisting><![CDATA[
-
-       <!DOCTYPE MAN SYSTEM "<SCIDIR>/man/manrev.dtd">
-       <MAN>
-          <LANGUAGE>eng</LANGUAGE>
-          <TITLE>foo</TITLE>
-          <TYPE>Scilab function</TYPE>
-          <DATE>$LastChangedDate$</DATE>
-   
-        ]]></programlisting>
+    <programlisting><![CDATA[ 
+<!DOCTYPE MAN SYSTEM "<SCIDIR>/man/manrev.dtd">
+<MAN>
+   <LANGUAGE>eng</LANGUAGE>
+   <TITLE>foo</TITLE>
+   <TYPE>Scilab function</TYPE>
+   <DATE>$LastChangedDate$</DATE>
+ ]]></programlisting>
     <para>
    The first of these 2 following entries (<literal>SHORT_DESCRIPTION</literal>)
    is mandatory and important since the words of the short description text, are used by the
index 2a6b50f..e8d8627 100644 (file)
   </refsection>
   <refsection>
     <title>Examples</title>
-    <programlisting role="example"><![CDATA[
-
+    <programlisting role="example"><![CDATA[ 
 manedit('manedit')
 
 function [x,y,z]=foo123(a,b),
 x=a+b,y=a-b,z=a==b
 endfunction
 manedit foo123
-  ]]></programlisting>
+ ]]></programlisting>
   </refsection>
   <refsection>
     <title>See Also</title>
index ef85329..b0b0978 100644 (file)
     <para>
     2- A <literal>whatis.html</literal> file, which must have a special format. Each row
     of the <literal>whatis</literal> must be as follows:</para>
-    <programlisting><![CDATA[
-
+    <programlisting role = ""><![CDATA[ 
 <BR><A HREF="item.html">item</A> - quick description
-   
-    ]]></programlisting>
+ ]]></programlisting>
     <para><literal>item</literal> is the item of the help, i.e. the command <literal>help item</literal>
     displays the contents of the file <literal>item.html</literal>.</para>
     <para>
index b3730d9..801e8a6 100644 (file)
@@ -68,9 +68,7 @@
   </refsection>
   <refsection>
     <title>Examples</title>
-    <programlisting role="example">
-
-
+    <programlisting role="example"><![CDATA[ 
 // example_1/
 // `-- help
 //     |-- en_US
@@ -114,8 +112,7 @@ res = xmltochm(my_chinese_help_dir,my_chinese_help_title,'zh_TW');
 if MSDOS then
  dos('start ' + res);
 end
-
-    </programlisting>
+ ]]></programlisting>
   </refsection>
   <refsection>
     <title>See Also</title>
index ea9782b..aee3eed 100644 (file)
@@ -64,9 +64,7 @@
   </refsection>
   <refsection>
     <title>Examples</title>
-    <programlisting role="example">
-
-
+    <programlisting role="example"><![CDATA[ 
 // example_1/
 // `-- help
 //     |-- en_US
@@ -90,21 +88,18 @@ my_french_help_dir    = my_module_path+'/help/fr_FR';
 my_french_help_title  = 'Example 1 [fr_FR]';
 my_french_html_dir    = xmltohtml(my_french_help_dir,my_french_help_title,'fr_FR')
 
-
 // Build the english help
 // =============================================================================
 my_english_help_dir   = my_module_path+'/help/en_US';
 my_english_help_title = 'Example 1 [en_US]';
 my_english_html_dir   = xmltohtml(my_english_help_dir,my_english_help_title,'en_US')
 
-
 // Build the chinese help
 // =============================================================================
 my_chinese_help_dir   = my_module_path+'/help/zh_TW';
 my_chinese_help_title = 'Example 1 [zh_TW]';
 my_chinese_html_dir   = xmltohtml(my_chinese_help_dir,my_chinese_help_title,'zh_TW')
-
-    </programlisting>
+ ]]></programlisting>
   </refsection>
   <refsection>
     <title>See Also</title>
index 254f7ca..fabda8a 100644 (file)
@@ -64,9 +64,7 @@
   </refsection>
   <refsection>
     <title>Examples</title>
-    <programlisting role="example">
-
-
+    <programlisting role="example"><![CDATA[ 
 // example_1/
 // `-- help
 //     |-- en_US
@@ -90,21 +88,18 @@ my_french_help_dir    =  my_module_path+'/help/fr_FR';
 my_french_help_title  =  'Example 1 [fr_FR]';
 xmltojar(my_french_help_dir,my_french_help_title,'fr_FR');
 
-
 // Build the english help
 // =============================================================================
 my_english_help_dir   =  my_module_path+'/help/en_US';
 my_english_help_title =  'Example 1 [en_US]';
 xmltojar(my_english_help_dir,my_english_help_title,'en_US');
 
-
 // Build the chinese help
 // =============================================================================
 my_chinese_help_dir   =  my_module_path+'/help/zh_TW';
 my_chinese_help_title =  'Example 1 [zh_TW]';
 xmltojar(my_chinese_help_dir,my_chinese_help_title,'zh_TW');
 
-
 // Add french, english or chinese help chapters
 // =============================================================================
 
@@ -129,9 +124,7 @@ if getlanguage() == 'fr_FR' then
 else
   del_help_chapter(my_english_help_title);
 end
-
-
-    </programlisting>
+ ]]></programlisting>
   </refsection>
   <refsection>
     <title>See Also</title>
index 55c68d4..1ccfe6b 100644 (file)
@@ -64,9 +64,7 @@
   </refsection>
   <refsection>
     <title>Examples</title>
-    <programlisting role="example">
-
-
+    <programlisting role="example"><![CDATA[ 
 // example_1/
 // `-- help
 //     |-- en_US
@@ -90,7 +88,6 @@ my_french_help_dir    = my_module_path+'/help/fr_FR';
 my_french_help_title  = 'Example 1 [fr_FR]';
 my_french_pdf         = xmltopdf(my_french_help_dir,my_french_help_title,'fr_FR')
 
-
 // Build the english help
 // =============================================================================
 my_english_help_dir   = my_module_path+'/help/en_US';
@@ -102,8 +99,7 @@ my_english_pdf        = xmltopdf(my_english_help_dir,my_english_help_title,'en_U
 my_chinese_help_dir   = my_module_path+'/help/zh_TW';
 my_chinese_help_title = 'Example 1 [zh_TW]';
 my_chinese_pdf        = xmltopdf(my_chinese_help_dir,my_chinese_help_title,'zh_TW')
-
-    </programlisting>
+ ]]></programlisting>
   </refsection>
   <refsection>
     <title>See Also</title>
index 72bf91d..a126f31 100644 (file)
@@ -64,9 +64,7 @@
   </refsection>
   <refsection>
     <title>Examples</title>
-    <programlisting role="example">
-
-
+    <programlisting role="example"><![CDATA[ 
 // example_1/
 // `-- help
 //     |-- en_US
@@ -82,8 +80,6 @@
 //         |-- example_1_function_2.xml
 //         `-- example_1_function_3.xml
 
-
-
 my_module_path = pathconvert(SCI+'/modules/helptools/examples/example_1',%f,%f)
 
 // Build the french help
@@ -92,21 +88,18 @@ my_french_help_dir    = my_module_path+'/help/fr_FR';
 my_french_help_title  = 'Example 1 [fr_FR]';
 my_french_ps          = xmltops(my_french_help_dir,my_french_help_title,'fr_FR')
 
-
 // Build the english help
 // =============================================================================
 my_english_help_dir   = my_module_path+'/help/en_US';
 my_english_help_title = 'Example 1 [EN_US]';
 my_english_ps         = xmltops(my_english_help_dir,my_english_help_title,'en_US')
 
-
 // Build the chinese help
 // =============================================================================
 my_chinese_help_dir   = my_module_path+'/help/zh_TW';
 my_chinese_help_title = 'Example 1 [zh_TW]';
 my_chinese_ps         = xmltops(my_chinese_help_dir,my_chinese_help_title,'zh_TW');
-
-    </programlisting>
+ ]]></programlisting>
   </refsection>
   <refsection>
     <title>See Also</title>
index 0492826..9a11242 100644 (file)
@@ -51,7 +51,7 @@ apropos(regexp)</synopsis>
   </refsection>
   <refsection>
     <title>Exemples</title>
-    <programlisting role="example"><![CDATA[
+    <programlisting role="example"><![CDATA[ 
 apropos('ode')
 apropos ode 
 apropos "list of"
index 6d6d753..d3d63b3 100644 (file)
@@ -22,9 +22,9 @@
     <title>Description</title>
     <para><literal>%helps</literal> est une matrice de chaînes de caractères à deux colonnes. Chaque ligne est formée comme ceci
   </para>
-    <programlisting><![CDATA[
+    <programlisting><![CDATA[ 
 répertoire_du_chapitre    titre_du_chapitre
-   ]]></programlisting>
+ ]]></programlisting>
     <para>
     Par exemple, nous avons le chapitre "graphics". 
     <literal>%helps(2,:)</literal>.
@@ -50,9 +50,9 @@ répertoire_du_chapitre    titre_du_chapitre
   </para>
     <para>
   </para>
-    <programlisting><![CDATA[
+    <programlisting><![CDATA[ 
 <BR><A HREF="item.html">item</A> - description rapide
-   ]]></programlisting>
+ ]]></programlisting>
     <para><literal>item</literal> est l'article de la liste d'aide, c'est-à-dire que la commande <literal>help item</literal> affiche le contenu du fichier <literal>item.html</literal>.
   </para>
     <para>
index 3cf8220..dde8a9a 100644 (file)
@@ -73,14 +73,14 @@ apropos(regexp)</synopsis>
   <refsection>
     <title>Exemplos</title>
 
-    <programlisting role="example">
+    <programlisting role="example"><![CDATA[ 
 apropos('ode')
 apropos ode 
 apropos "list of"
 apropos "sin.*hyperbolic"
 apropos "^ab"  //procura por ajuda começando com os dois caracteres "ab"
 apropos "quadratic.*solver"
-  </programlisting>
+ ]]></programlisting>
   </refsection>
 
   <refsection>
index d84f426..d5db066 100644 (file)
   <refsection>
     <title>Exemplos</title>
 
-    <programlisting role="example">
-
+    <programlisting role="example"><![CDATA[ 
 deff("y=foo(x)","y=x"); // define a função foo como a função identidade.
 foo("toto")
-  </programlisting>
+ ]]></programlisting>
   </refsection>
 
   <refsection>
index 8672bce..c0ee579 100644 (file)
   <refsynopsisdiv>
     <title>Seqüência de Chamamento</title>
 
-    <synopsis>help_from_sci() // gera um modelo de função vazio</synopsis>
-
-    <synopsis>help_from_sci(funname,helpdir) // gera helpdir/funname.xml a partir de funname.sci</synopsis>
-
-    <synopsis>help_from_sci(dirname,helpdir) // processa dirname/*.sci e cria helpdir/*.xml.</synopsis>
-
-    <synopsis>help_from_sci(dirname,helpdir,helpdir) // como acima, mas também cria o arquivo de demonstração helpdir/*.dem.sce.</synopsis>
-
-    <synopsis>[helptxt,demotxt]=help_from_sci(funname) // retorna funname.xml e funname.dem.sce como duas matrizes de texto.</synopsis>
+    <synopsis>
+      help_from_sci() // gera um modelo de função vazio
+      help_from_sci(funname,helpdir) // gera helpdir/funname.xml a partir de funname.sci
+      help_from_sci(dirname,helpdir) // processa dirname/*.sci e cria helpdir/*.xml.
+      help_from_sci(dirname,helpdir,helpdir) // como acima, mas também cria o arquivo de demonstração helpdir/*.dem.sce.
+      [helptxt,demotxt]=help_from_sci(funname) // retorna funname.xml e funname.dem.sce como duas matrizes de texto.
+    </synopsis>
   </refsynopsisdiv>
 
   <refsection>
     "Bibliography".</para>
 
     <para>As seguintes diretrizes devem ser seguidas ao se escrever os
-    comentários de código fonte: <itemizedlist>
-        <listitem>
-           
-
+    comentários de código fonte:</para>
+      <itemizedlist>
+        <listitem><para>       
           <literal>Calling Sequence</literal>
-
            - um exemplo por linha. 
-        </listitem>
-
-        <listitem>
-           
-
+        </para></listitem>
+        <listitem><para>
           <literal>Parameters</literal>
-
            - separe o nome do parâmetro e a descrição por um ":". Mantenha a descrição de cada parâmetro na mesma linha. 
-        </listitem>
-
-        <listitem>
-           
-
+        </para></listitem>
+        <listitem><para>
           <literal>Description</literal>
-
            - a formatação do texto pode ser feita utilizando comandos XML. Adicionar uma linha de comentário vazia na seção Description é interpretado como começo de um novo parágrafo. 
-        </listitem>
-
-        <listitem>
-           
-
+          </para></listitem>
+        <listitem><para>
           <literal>See also</literal>
-
            - liste um nome de função por linha.
-        </listitem>
-
-        <listitem>
-           
-
+          </para></listitem>
+        <listitem><para>
           <literal>Authors</literal>
-
            - escreva um autor em cada linha após o cabeçalho Authors. Use ";" para separar os autores de qualquer informação adicional. 
-        </listitem>
-
-        <listitem>
-           
-
+          </para></listitem>
+        <listitem><para>
           <literal>Bibliography</literal>
-
            - escreva uma referência por linha seguindo o cabeçalho References. 
-        </listitem>
-      </itemizedlist></para>
+          </para></listitem>
+      </itemizedlist>
 
     <para></para>
   </refsection>
   <refsection>
     <title>Exemplos</title>
 
-    <programlisting role="example">
+    <programlisting role="example"><![CDATA[ 
 help_from_sci()   // abrindo um modelo de código-fonte vazio no editor Scipad.
 // salve este modelo como test_fun.sci no diretório corrente antes de executar
 // os próximos comandos do exemplo
@@ -191,8 +167,7 @@ help_from_sci('test_fun','.','.')
 // este comando processaria todos os arquivos .sci no diretório de macros
 // e utilizaria a seção de comentários de cabeçalho para atualizar as ajudas .xml no
 // diretório help\en_US e reconstruiria os arquivos .dem.sce no diretório demos\.
-
-   </programlisting>
+ ]]></programlisting>
   </refsection>
 
   <refsection>
index 02f1832..542da83 100644 (file)
   <refsection>
     <title>Exemplos</title>
 
-    <programlisting role="example">
-
-   function [y,z]=foo(a,b),y=a+b,z=1,endfunction
-    p=help_skeleton('foo',TMPDIR)
-    scipad(p)
-  
-  </programlisting>
+    <programlisting role="example"><![CDATA[ 
+function [y,z]=foo(a,b),y=a+b,z=1,endfunction
+p=help_skeleton('foo',TMPDIR)
+scipad(p)
+ ]]></programlisting>
   </refsection>
 
   <refsection>
index dd4f06d..a89bf57 100644 (file)
     'palavra-chave do Scilab' ou 'tipo de dados do Scilab', ..., dependendo do
     que explica a página de ajuda.</para>
 
-    <programlisting>
-
-       &lt;!DOCTYPE MAN SYSTEM "&lt;SCIDIR&gt;/man/manrev.dtd"&gt;
-       &lt;MAN&gt;
-          &lt;LANGUAGE&gt;eng&lt;/LANGUAGE&gt;
-          &lt;TITLE&gt;foo&lt;/TITLE&gt;
-          &lt;TYPE&gt;função do Scilab&lt;/TYPE&gt;
-          &lt;DATE&gt;$LastChangedDate$&lt;/DATE&gt;
-   
-        </programlisting>
+    <programlisting role = ""><![CDATA[ 
+<!DOCTYPE MAN SYSTEM "<SCIDIR>/man/manrev.dtd">
+<MAN>
+   <LANGUAGE>eng</LANGUAGE>
+   <TITLE>foo</TITLE>
+   <TYPE>função do Scilab</TYPE>
+   <DATE>$LastChangedDate$</DATE>
+ ]]></programlisting>
 
     <para>A primeira destas duas entradas seguintes
     (<literal>SHORT_DESCRIPTION</literal>) é mandatória e importante desde que
     várias seqüências de chamamento, utilize várias entradas
     <literal>CALLING_SEQUENCE_ITEM</literal>.</para>
 
-    <programlisting>
-
-          &lt;ASHORT_DESCRIPTION name="foo"&gt;descrição curta de foo&lt;/ASHORT_DESCRIPTION&gt;
-          &lt;CALLING_SEQUENCE&gt;
-              &lt;CALLING_SEQUENCE_ITEM&gt;[y] = foo(x)&lt;/CALLING_SEQUENCE_ITEM&gt;
-          &lt;/CALLING_SEQUENCE&gt;
-   
-        </programlisting>
+    <programlisting role = ""><![CDATA[ 
+<ASHORT_DESCRIPTION name="foo">descrição curta de foo</ASHORT_DESCRIPTION>
+<CALLING_SEQUENCE>
+    <CALLING_SEQUENCE_ITEM>[y] = foo(x)</CALLING_SEQUENCE_ITEM>
+    </CALLING_SEQUENCE>
+ ]]></programlisting>
 
     <para>A entrada seguinte (<literal>PARAM</literal>) não é estritamente
     mandatória, mas é a boa para descrever cada parâmetro (de entrada e saída)
     no caso de uma função.</para>
 
-    <programlisting>
-
-          &lt;PARAM&gt;
-             &lt;PARAM_INDENT&gt;
-                &lt;PARAM_ITEM&gt;
-                   &lt;PARAM_NAME&gt;x&lt;/PARAM_NAME&gt;
-                   &lt;PARAM_DESCRIPTION&gt;
-                      &lt;SP&gt;: o que pode ser x&lt;/SP&gt;
-                   &lt;/PARAM_DESCRIPTION&gt; 
-                &lt;/PARAM_ITEM&gt;
-                &lt;PARAM_ITEM&gt;
-                   &lt;PARAM_NAME&gt;y&lt;/PARAM_NAME&gt;
-                   &lt;PARAM_DESCRIPTION&gt;
-                      &lt;SP&gt;: o que pode ser y&lt;/SP&gt;
-                   &lt;/PARAM_DESCRIPTION&gt; 
-                &lt;/PARAM_ITEM&gt;
-             &lt;/PARAM_INDENT&gt;
-          &lt;/PARAM&gt;
-   
-        </programlisting>
+    <programlisting role = ""><![CDATA[ 
+<PARAM>
+   <PARAM_INDENT>
+      <PARAM_ITEM>
+         <PARAM_NAME>x</PARAM_NAME>
+         <PARAM_DESCRIPTION>
+            <SP>: o que pode ser x</SP>
+         </PARAM_DESCRIPTION> 
+      </PARAM_ITEM>
+      <PARAM_ITEM>
+         <PARAM_NAME>y</PARAM_NAME>
+         <PARAM_DESCRIPTION>
+            <SP>: o que pode ser y</SP>
+         </PARAM_DESCRIPTION> 
+      </PARAM_ITEM>
+   </PARAM_INDENT>
+</PARAM>
+ ]]></programlisting>
 
     <para>A entrada <literal>DESCRIPTION</literal> é talvez a mais
     significativa (mas não é estritamente mandatória) e pode ser mais
     <literal>&lt;/LINK&gt;</literal> e não <literal>&lt;ALINK&gt;</literal> e
     <literal>&lt;/ALINK&gt;</literal>).</para>
 
-    <programlisting>
-
-         &lt;DESCRIPTION&gt;
-             &lt;P&gt;
-                Um primeiro parágrafo explica o que a função foo computa.
-                Se você deseja enfatizar um nome de parâmetro, você pode utilizar o segunte
-                tag &lt;VERB&gt;x&lt;/VERB&gt;, se você desejar enfatizar parte do texto
-                &lt;EM&gt;encerre-a nestes tags&lt;/EM&gt; e use estes
-                &lt;BD&gt;para uma fonte em negrito&lt;/BD&gt; e finalmente &lt;TT&gt;para um estilo em máquina de escrever&lt;/TT&gt;.
-             &lt;/P&gt;
-             &lt;P&gt;
-                Um segundo parágrafo... Aqui vai um exemplo de um link para outra página :
-                &lt;ALINK&gt;man&lt;/ALINK&gt;.
-             &lt;/P&gt;
-         &lt;/DESCRIPTION&gt;
-   
-        </programlisting>
+    <programlisting role = ""><![CDATA[ 
+<DESCRIPTION>
+    <P>
+       Um primeiro parágrafo explica o que a função foo computa.
+       Se você deseja enfatizar um nome de parâmetro, você pode utilizar o segunte
+       tag <VERB>x</VERB>, se você desejar enfatizar parte do texto
+       <EM>encerre-a nestes tags</EM> e use estes
+       <BD>para uma fonte em negrito</BD> e finalmente <TT>para um estilo em máquina de escrever</TT>.
+    </P>
+    <P>
+       Um segundo parágrafo... Aqui vai um exemplo de um link para outra página :
+       <ALINK>man</ALINK>.
+    </P>
+</DESCRIPTION>
+ ]]></programlisting>
 
     <para>Aqui está como escrever a sua própria entrada, por exemplo, para
     escrever observações e/ou notas sobre a sua maravilhosa função.</para>
 
-    <programlisting>
-
-         &lt;SECTION label='Notes'&gt;
-             &lt;P&gt;
-                Aqui está uma lista de notas :
-             &lt;/P&gt;
-             &lt;ITEM label='first'&gt;&lt;SP&gt;blablabla...&lt;/SP&gt;&lt;/ITEM&gt;
-             &lt;ITEM label='second'&gt;&lt;SP&gt;toto é o francês de foo...&lt;/SP&gt;&lt;/ITEM&gt;
-         &lt;/SECTION&gt;
-   
-        </programlisting>
+    <programlisting role = ""><![CDATA[ 
+<SECTION label='Notes'>
+    <P>
+       Aqui está uma lista de notas :
+    </P>
+    <ITEM label='first'><SP>blablabla...</SP></ITEM>
+    <ITEM label='second'><SP>toto é o francês de foo...</SP></ITEM>
+</SECTION>
+ ]]></programlisting>
 
     <para>Uma entrada importante é <literal>EXAMPLE</literal> que é reservada
     para mostrar usos no Scilab da sua função (comece com exemplos simples!).
     <literal>}}&gt;&lt;/EXAMPLE&gt;</literal> (mais uma vez, este é um truque
     ruim para evitar problemas de interpretação).</para>
 
-    <programlisting>
-
-         &lt;EXAMPLE&gt;&lt;![CDATA[
-             deff("y=foo(x)","y=x"); // definindo a função foo como a função identidade
-             foo("toto")
-      }}&gt;&lt;/EXAMPLE&gt;
-   
-        </programlisting>
+    <programlisting role = ""><![CDATA[ 
+<EXAMPLE><![CDATA[
+    deff("y=foo(x)","y=x"); // definindo a função foo como a função identidade
+    foo("toto")
+}}></EXAMPLE>
+ ]]></programlisting>
 
     <para>Esta última parte explica como colocar links para outras páginas de
     ajuda relacionadas (como já foi dito antes, os bons tags são
     <literal>AUTHOR_ITEM</literal> por autor). Talvez seja uma boa idéia
     colocar um endereço de email, se você procura por relatos de bugs !</para>
 
-    <programlisting>
-
-         &lt;SEE_ALSO&gt;
-           &lt;SEE_ALSO_ITEM&gt; &lt;ALINK&gt;man&lt;/ALINK&gt; &lt;/SEE_ALSO_ITEM&gt;
-           &lt;SEE_ALSO_ITEM&gt; &lt;ALINK&gt;apropos&lt;/ALINK&gt; &lt;/SEE_ALSO_ITEM&gt;
-         &lt;/SEE_ALSO&gt;
-
-         &lt;AUTHOR&gt;
-           &lt;AUTHOR_ITEM&gt;B. P.&lt;/AUTHOR_ITEM&gt;
-         &lt;/AUTHOR&gt;
-       &lt;/MAN&gt;
-   
-        </programlisting>
+    <programlisting role = ""><![CDATA[ 
+<SEE_ALSO>
+  <SEE_ALSO_ITEM> <ALINK>man</ALINK> </SEE_ALSO_ITEM>
+  <SEE_ALSO_ITEM> <ALINK>apropos</ALINK> </SEE_ALSO_ITEM>
+</SEE_ALSO>
+ <AUTHOR>
+  <AUTHOR_ITEM>B. P.</AUTHOR_ITEM>
+</AUTHOR>
+</MAN>
+ ]]></programlisting>
   </refsection>
 
   <refsection>
index a6c1ba3..387d93d 100644 (file)
   <refsection>
     <title>Exemplos</title>
 
-    <programlisting role="example">
-
+    <programlisting role="example"><![CDATA[ 
 manedit('manedit')
 
 function [x,y,z]=foo123(a,b),
 x=a+b,y=a-b,z=a==b
 endfunction
 manedit foo123
-  </programlisting>
+ ]]></programlisting>
   </refsection>
 
   <refsection>
index e158470..e3c9329 100644 (file)
     formato especial. Cada linha de <literal>whatis</literal> deve ser como
     segue:</para>
 
-    <programlisting>
-
-&lt;BR&gt;&lt;A HREF="item.html"&gt;item&lt;/A&gt; - rápida descrição
-   
-    </programlisting>
+    <programlisting role = ""><![CDATA[ 
+<BR><A HREF="item.html">item</A> - rápida descrição
+ ]]></programlisting>
 
     <para><literal>item</literal> é o item da ajuda, i.e. o comando
     <literal>help item</literal> exibe o conteúdo do arquivo
index 314721e..f6d3eb3 100644 (file)
@@ -89,9 +89,7 @@
   <refsection>
     <title>Exemplos</title>
 
-    <programlisting role="example">
-
-
+    <programlisting role="example"><![CDATA[ 
 // example_1/
 // `-- help
 //     |-- en_US
@@ -115,21 +113,18 @@ my_french_help_dir    = my_module_path+'/help/fr_FR';
 my_french_help_title  = 'Example 1 [fr_FR]';
 my_french_html_dir    = xmltohtml(my_french_help_dir,my_french_help_title,'fr_FR')
 
-
 // Construindo a ajuda em inglês
 // =============================================================================
 my_english_help_dir   = my_module_path+'/help/en_US';
 my_english_help_title = 'Example 1 [en_US]';
 my_english_html_dir   = xmltohtml(my_english_help_dir,my_english_help_title,'en_US')
 
-
 // Construindo a ajuda em chinês
 // =============================================================================
 my_chinese_help_dir   = my_module_path+'/help/zh_TW';
 my_chinese_help_title = 'Example 1 [zh_TW]';
 my_chinese_html_dir   = xmltohtml(my_chinese_help_dir,my_chinese_help_title,'zh_TW')
-
-    </programlisting>
+ ]]></programlisting>
   </refsection>
 
   <refsection>
index 441e432..cd544da 100644 (file)
@@ -89,9 +89,7 @@
   <refsection>
     <title>Exemplos</title>
 
-    <programlisting role="example">
-
-
+    <programlisting role="example"><![CDATA[ 
 // example_1/
 // `-- help
 //     |-- en_US
@@ -115,21 +113,18 @@ my_french_help_dir    =  my_module_path+'/help/fr_FR';
 my_french_help_title  =  'Example 1 [fr_FR]';
 xmltojar(my_french_help_dir,my_french_help_title,'fr_FR');
 
-
 // Construindo a ajuda em inglês
 // =============================================================================
 my_english_help_dir   =  my_module_path+'/help/en_US';
 my_english_help_title =  'Example 1 [en_US]';
 xmltojar(my_english_help_dir,my_english_help_title,'en_US');
 
-
 // Construindo a ajuda em chinês
 // =============================================================================
 my_chinese_help_dir   =  my_module_path+'/help/zh_TW';
 my_chinese_help_title =  'Example 1 [zh_TW]';
 xmltojar(my_chinese_help_dir,my_chinese_help_title,'zh_TW');
 
-
 // Adicionando capítulos de ajuda em francês, inglês e chinês
 // =============================================================================
 
@@ -154,9 +149,7 @@ if getlanguage() == 'fr_FR' then
 else
   del_help_chapter(my_english_help_title);
 end
-
-
-    </programlisting>
+ ]]></programlisting>
   </refsection>
 
   <refsection>
index 2e77bd1..38c565c 100644 (file)
@@ -89,9 +89,7 @@
   <refsection>
     <title>Exemplos</title>
 
-    <programlisting role="example">
-
-
+    <programlisting role="example"><![CDATA[ 
 // example_1/
 // `-- help
 //     |-- en_US
@@ -115,7 +113,6 @@ my_french_help_dir    = my_module_path+'/help/fr_FR';
 my_french_help_title  = 'Example 1 [fr_FR]';
 my_french_pdf         = xmltopdf(my_french_help_dir,my_french_help_title,'fr_FR')
 
-
 // Construindo a ajuda em inglês
 // =============================================================================
 my_english_help_dir   = my_module_path+'/help/en_US';
@@ -127,8 +124,7 @@ my_english_pdf        = xmltopdf(my_english_help_dir,my_english_help_title,'en_U
 my_chinese_help_dir   = my_module_path+'/help/zh_TW';
 my_chinese_help_title = 'Example 1 [zh_TW]';
 my_chinese_pdf        = xmltopdf(my_chinese_help_dir,my_chinese_help_title,'zh_TW')
-
-    </programlisting>
+ ]]></programlisting>
   </refsection>
 
   <refsection>
index c9aa677..fb602ef 100644 (file)
@@ -89,9 +89,7 @@
   <refsection>
     <title>Exemplos</title>
 
-    <programlisting role="example">
-
-
+    <programlisting role="example"><![CDATA[ 
 // example_1/
 // `-- help
 //     |-- en_US
 //         |-- example_1_function_2.xml
 //         `-- example_1_function_3.xml
 
-
-
 my_module_path = pathconvert(SCI+'/modules/helptools/examples/example_1',%f,%f)
 
 // Construindo a ajuda em francês
@@ -117,21 +113,18 @@ my_french_help_dir    = my_module_path+'/help/fr_FR';
 my_french_help_title  = 'Example 1 [fr_FR]';
 my_french_ps          = xmltops(my_french_help_dir,my_french_help_title,'fr_FR')
 
-
 // Construindo a ajuda em inglês
 // =============================================================================
 my_english_help_dir   = my_module_path+'/help/en_US';
 my_english_help_title = 'Example 1 [EN_US]';
 my_english_ps         = xmltops(my_english_help_dir,my_english_help_title,'en_US')
 
-
 // Construindo a ajuda em chinês
 // =============================================================================
 my_chinese_help_dir   = my_module_path+'/help/zh_TW';
 my_chinese_help_title = 'Example 1 [zh_TW]';
 my_chinese_ps         = xmltops(my_chinese_help_dir,my_chinese_help_title,'zh_TW');
-
-    </programlisting>
+ ]]></programlisting>
   </refsection>
 
   <refsection>