helptools: fixed bugs 7134 and 7133 for help_from_sci
[scilab.git] / scilab / modules / helptools / help / en_US / help_from_sci.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2
3 <!--
4  *
5  * This help file was generated from help_from_sci.sci using help_from_sci().
6  *
7  -->
8
9 <refentry version="5.0-subset Scilab" xml:id="help_from_sci" xml:lang="en"
10           xmlns="http://docbook.org/ns/docbook"
11           xmlns:xlink="http://www.w3.org/1999/xlink"
12           xmlns:svg="http://www.w3.org/2000/svg"
13           xmlns:ns3="http://www.w3.org/1999/xhtml"
14           xmlns:mml="http://www.w3.org/1998/Math/MathML"
15           xmlns:db="http://docbook.org/ns/docbook">
16
17   <info>
18     <pubdate>$LastChangedDate: 05-Aug-2011 $</pubdate>
19   </info>
20
21   <refnamediv>
22     <refname>help_from_sci</refname><refpurpose>Generate help files and demo files from the head comments section of a .sci source file.</refpurpose>
23   </refnamediv>
24
25
26
27 <refsynopsisdiv>
28    <title>Calling Sequence</title>
29    <synopsis>
30    help_from_sci() // generate an empty function template
31    helptxt = help_from_sci() // generate an empty function template
32    help_from_sci(funname,helpdir) // generate helpdir/funname.xml from funname.sci.
33    help_from_sci(dirname,helpdir) // process dirname/*.sci and create helpdir/*.xml help files.
34    help_from_sci(dirname,helpdir,demodir) // as above but also creating demodir/*.dem.sce demo files.
35    [helptxt,demotxt]=help_from_sci(funname) // return funname.xml and funname.dem.sce code as two text matrixes.
36    </synopsis>
37 </refsynopsisdiv>
38
39 <refsection>
40    <title>Parameters</title>
41    <variablelist>
42    <varlistentry><term>funname:</term>
43       <listitem><para> the name of a single .sci source file to be processed.</para></listitem></varlistentry>
44    <varlistentry><term>dirname:</term>
45       <listitem><para> directory name where all .sci files will be processed.</para></listitem></varlistentry>
46    <varlistentry><term>helpdir:</term>
47       <listitem><para> optional path where the .xml help file will be created.</para></listitem></varlistentry>
48    <varlistentry><term>demodir:</term>
49       <listitem><para> optional path where .dem.sce demo files will be created based on code from the Examples section.</para></listitem></varlistentry>
50    <varlistentry><term>helptxt:</term>
51       <listitem><para> returns the XML help code if helpdir is empty, or the path to the .xml file.</para></listitem></varlistentry>
52    <varlistentry><term>demotxt:</term>
53       <listitem><para> returns the demo code if demodir is empty, or the path to the .dem.sce file.</para></listitem></varlistentry>
54    </variablelist>
55 </refsection>
56
57 <refsection>
58    <title>Description</title>
59    <para>
60 The help_from_sci function generates .xml help files based on the head comments section
61 of .sci source files. Optionally .dem.sce demo files can be generated based on
62 code from the Examples section in the head comments section of .sci files.
63    </para>
64    <para>
65 In order for help_from_sci to format the .xml file properly the
66 head comments section should comply with some simple formatting rules.
67    </para>
68    <para>
69 The first comment line following the function definition should contain a short description
70 of the function.
71    </para>
72    <para>
73 The remaining comments are formatted according to the following (optional) headlines:
74 "Calling Sequence", "Parameters", "Description", "Examples", "See also", "Used functions",
75 "Authors" and "Bibliography".
76    </para>
77    <para>
78 The following guidelines should be used when writing the source code comments:
79 <itemizedlist>
80 <listitem><para><literal>Calling Sequence</literal> - one example pr. line.</para></listitem>
81 <listitem><para><literal>Parameters</literal> - separate parameter name and
82 description by a ":". Keep the description of each parameter on the same line.</para></listitem>
83 <listitem><para><literal>Description</literal> - formatting of the text can be done
84 using XML commands. Compare the output of head_comments("help_from_sci") with help("help_from_sci")
85 to get some hints.
86 Adding an empty comment line in the Description section is interpreted as the
87 start of a new paragraph.</para></listitem>
88 <listitem><para><literal>See also</literal> - list one function name pr line.</para></listitem>
89 <listitem><para><literal>Authors</literal> - write one author on each line following
90 the Authors headline. Use ";" to separate the authors name
91 from any add additional information.</para></listitem>
92 <listitem><para><literal>Bibliography</literal> - write one reference pr line
93 following the References headline.</para></listitem>
94 </itemizedlist>
95    </para>
96    <para>
97 </para>
98 </refsection>
99
100 <refsection>
101    <title>Examples</title>
102    <programlisting role="example"><![CDATA[
103 help_from_sci()   // Open an empty source code template in the scinotes editor.
104 // Save this template as test_fun.sci in the current directory before running
105 // the next example commands.
106
107 help_from_sci("test_fun")        // return the xml skeleton as a text string
108
109 help_from_sci("test_fun",".")    // create the xml help file in the current directory.
110
111 // create both a xml help file and a demo file in the current directory.
112 help_from_sci("test_fun",".",".")
113
114 // From a toolbox root directory a typical calling sequence would be:
115 // help_from_sci("macros","help\en_US","demos")
116 // This command would process all .sci files in the macros directory
117 // and use the head comments section to update all .xml help files in the
118 // help\en_US directory an rebuild the .dem.sce files in the demos\ directory.
119
120    ]]></programlisting>
121 </refsection>
122
123 <refsection>
124    <title>See also</title>
125    <simplelist type="inline">
126    <member><link linkend="help">help</link></member>
127    <member><link linkend="help_skeleton">help_skeleton</link></member>
128    <member><link linkend="head_comments">head_comments</link></member>
129    </simplelist>
130 </refsection>
131
132 <refsection>
133    <title>Authors</title>
134    <simplelist type="vert">
135    <member>Copyright (C) 2008-2009 - T. Pettersen</member>
136    <member>Copyright (C) 2010 - DIGITEO - Allan CORNET</member>
137    <member>Copyright (C) 2011 - DIGITEO - Michael Baudin</member>
138    </simplelist>
139 </refsection>
140 </refentry>