* Extends function help_skeleton to propose the <revhistory>, <latex>, <note>, 99/5899/4
Sylvestre Ledru [Thu, 12 Jan 2012 17:15:16 +0000 (18:15 +0100)]
  <caution>, <warning>, <important> and <tip> examples.

Change-Id: I4a210a4640e0454a53d4f9499c8b4c897e48c04a

scilab/CHANGES_5.4.X
scilab/modules/helptools/macros/help_skeleton.sci

index 0364b56..63c2255 100644 (file)
@@ -22,6 +22,8 @@ Help
 * Management of Docbook tags <note>, <caution>, <warning>, <important> and
  <tip>. See bug #10505.
 
+* Function help_skeleton extended to propose the <revhistory>, <latex>, <note>,
+  <caution>, <warning>, <important> and <tip> tags in examples.
 
 Xcos
 ====
index 22edb21..c758974 100644 (file)
@@ -93,11 +93,12 @@ function txt = help_skeleton(funname, path, language)
    '    <title>' + _('Calling Sequence') + '</title>'
    '    <synopsis>' + Call + '</synopsis>'
    '  </refsynopsisdiv>'];
+
     //Arguments
     if size(args,'*') >0 then
       txt=[txt;
      '  <refsection>'
-     '    <title>' + _('Parameters') + '</title>'
+     '    <title>' + _('Arguments') + '</title>'
      '    <variablelist>']
       for a=args'
        txt=[txt;
@@ -105,7 +106,7 @@ function txt = help_skeleton(funname, path, language)
        '        <term>' + a + '</term>'
        '        <listitem>'
        '          <para>'
-     _('            Add here the parameter description.')
+     _('            Add here the input/output argument description.')
        '          </para>'
        '        </listitem>'
        '      </varlistentry>']
@@ -114,6 +115,7 @@ function txt = help_skeleton(funname, path, language)
      '    </variablelist>'
      '  </refsection>'];
     end
+
     //Description
     txt=[txt;
    '  <refsection>'
@@ -122,7 +124,26 @@ function txt = help_skeleton(funname, path, language)
  _('          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>'];
+
+    // More information
+    txt=[txt;
+   '  <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>An important about foo</para></important>'
+   '    <tip><para>A tip about foo</para></tip>'
    '  </refsection>'];
+
     //Example
    txt=[txt;
    '  <refsection>'
@@ -131,6 +152,7 @@ function txt = help_skeleton(funname, path, language)
  _('        Add here scilab instructions and comments')
    '    ]]></programlisting>'
    '  </refsection>'];
+
     //See Also
     txt=[txt;
    '  <refsection>'
@@ -144,6 +166,7 @@ function txt = help_skeleton(funname, path, language)
    '      </member>'
    '    </simplelist>'
    '  </refsection>'];
+
     //Authors
     txt=[txt;
    '  <refsection>'
@@ -162,6 +185,19 @@ function txt = help_skeleton(funname, path, language)
  _('         Add here the function bibliography')
    '       </para>'
    '     </refsection>'];
+
+    // History
+   txt = [txt;
+   '    <refsection>'
+   '       <title>' + _('History') + '</title>'
+   '      <revhistory>'
+   '        <revision>'
+   '          <revnumber>X.Y</revnumber>'
+   '          <revdescription>Function foo added</revdescription>'
+   '        </revision>'
+   '      </revhistory>'
+   '    </refsection>'];
+
     //Used functions
     txt=[txt;
    '  <refsection>'