* Bug 6911 fixed: help_from_sci dit not support ω in heading comments
[scilab.git] / scilab / modules / helptools / help / en_US / help_from_sci.xml
index 1a0d64e..743a57c 100644 (file)
         <refpurpose>Generate help files and demo files from the head comments section of a .sci source file.</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
-        <title>Calling Sequence</title>
+        <title>Syntax</title>
         <synopsis>
             help_from_sci() // generate an empty function template
             helptxt = help_from_sci() // generate an empty function template
             help_from_sci(funname,helpdir) // generate helpdir/funname.xml from funname.sci.
             help_from_sci(dirname,helpdir) // process dirname/*.sci and create helpdir/*.xml help files.
             help_from_sci(dirname,helpdir,demodir) // as above but also creating demodir/*.dem.sce demo files.
-            [helptxt,demotxt]=help_from_sci(funname) // return funname.xml and funname.dem.sce code as two text matrixes.
+            [helptxt,demotxt]=help_from_sci(funname) // return funname.xml and funname.dem.sce code as two text matrices.
         </synopsis>
     </refsynopsisdiv>
     <refsection>
@@ -78,7 +78,7 @@
         </para>
         <para>
             The remaining comments are formatted according to the following (optional) headlines:
-            "Calling Sequence", "Parameters", "Description", "Examples", "See also", "Used functions",
+            "Syntax", "Parameters", "Description", "Examples", "See also", "Used functions",
             "Authors" and "Bibliography".
         </para>
         <para>
@@ -86,7 +86,7 @@
             <itemizedlist>
                 <listitem>
                     <para>
-                        <literal>Calling Sequence</literal> - one example pr. line.
+                        <literal>Syntax</literal> - one example pr. line.
                     </para>
                 </listitem>
                 <listitem>
                 </listitem>
             </itemizedlist>
         </para>
+        <note>
+          The "&amp;" character as well as numerical HTML entities like "&amp;#123;" are supported
+          in the contents. Literal HTML entities like "&amp;acute;" are not accepted. Please use
+          directly the UTF-8 character like "é" instead.
+        </note>
         <para>
         </para>
     </refsection>
     <refsection>
         <title>Examples</title>
         <programlisting role="example"><![CDATA[
-help_from_sci()   // Open an empty source code template in the scinotes editor.
-// Save this template as test_fun.sci in the current directory before running
-// the next example commands.
+// Open an source code template in the scinotes editor and return its help and demo texts
+[helptxt, demotxt] = help_from_sci()
 
-help_from_sci("test_fun")        // return the xml skeleton as a text string
-
-help_from_sci("test_fun",".")    // create the xml help file in the current directory.
-
-// create both a xml help file and a demo file in the current directory.
-help_from_sci("test_fun",".",".")
-
-// From a toolbox root directory a typical calling sequence would be:
+// From a toolbox root directory a typical syntax would be:
 // help_from_sci("macros","help\en_US","demos")
 // 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
@@ -163,4 +160,16 @@ help_from_sci("test_fun",".",".")
             </member>
         </simplelist>
     </refsection>
+    <refsection role="history">
+        <title>History</title>
+        <revhistory>
+            <revision>
+                <revnumber>6.0.1</revnumber>
+                <revdescription>
+                  Numerical HTML entities like <literal>&amp;#969;</literal> are now accepted in
+                  heading comments.
+                </revdescription>
+            </revision>
+        </revhistory>
+    </refsection>
 </refentry>