How to write a simple XML scilab help page: an example
The root element of a document which conforms to the Scilab DocBook 5 subset must have version attribute set to "5.0-subset Scilab".
<?xml version="1.0" encoding="UTF-8"?> <refentry xmlns:scilab="http://www.scilab.org" xml:id="foo" xml:lang="en" 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">
Example:
function y=foo(a, b, c) y = a + 2 * b + c; endfunction path = help_skeleton('foo', TMPDIR) if (isdef('editor') | (funptr('editor')<>0)) then editor(path); end |  |  |
Generated foo.xml in TMPDIR:
<?xml version="1.0" encoding="UTF-8"?> <!-- * Add some comments about XML file --> <refentry xmlns:scilab="http://www.scilab.org" xml:id="foo" xml:lang="en" 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"> <refnamediv> <refname>foo</refname> <refpurpose>Add short description here. </refpurpose> </refnamediv> <refsynopsisdiv> <title>Syntax</title> <synopsis>y = foo(a,b,c)</synopsis> </refsynopsisdiv> <refsection> <title>Arguments</title> <variablelist> <varlistentry> <term>a</term> <listitem> <para> Add here the input argument description. </para> </listitem> </varlistentry> <varlistentry> <term>b</term> <listitem> <para> Add here the input argument description. </para> </listitem> </varlistentry> <varlistentry> <term>c</term> <listitem> <para> Add here the input argument description. </para> </listitem> </varlistentry> <varlistentry> <term>y</term> <listitem> <para> Add here the output argument description. </para> </listitem> </varlistentry> </variablelist> </refsection> <refsection> <title>Description</title> <para> Add here a paragraph of the function description. Other paragraph can be added </para> <para>With a latex expression <latex> \begin{eqnarray} f(x,a,r) = \frac{1}{r^{-a}\Gamma(a)} \int_0^x t^{a-1} \exp\left(-rt\right) dt \end{eqnarray} </latex> </para> </refsection> <refsection> <title>More information</title> <note><para>A note about foo</para></note> <caution><para>A caution about foo</para></caution> <warning><para>A warning about foo</para></warning> <important><para>A important about foo</para></important> <tip><para>A tip about foo</para></tip> </refsection> <refsection> <title>Examples</title> <programlisting role="example"><![CDATA[ Add here scilab instructions and comments ]]></programlisting> </refsection> <refsection role="see-also"> <title>See also</title> <simplelist type="inline"> <member> <link linkend="add a reference name" >add a reference</link> </member> <member> <link linkend="add a reference name">add a reference</link> </member> </simplelist> </refsection> <refsection> <title>Authors</title> <simplelist type="vert"> <member>add the author name and author reference</member> <member>add another author name and it's reference</member> </simplelist> </refsection> <refsection role="bibliography"> <title>Bibliography</title> <para> Add here the function bibliography </para> </refsection> <refsection role="history"> <title>History</title> <revhistory> <revision> <revnumber>X.Y</revnumber> <revdescription>Function foo added</revdescription> </revision> </revhistory> </refsection> <refsection> <title>Used Functions</title> <para> Add here the Scilab, C,... used code references </para> </refsection> </refentry>