258330a4ef7e265f838e66d2ef078febeafd9097
[scilab.git] / scilab / modules / helptools / help / en_US / man.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) 2008 - INRIA
5  * Copyright (C) 2010 - DIGITEO - Allan CORNET
6  *
7  * Copyright (C) 2012 - 2016 - Scilab Enterprises
8  *
9  * This file is hereby licensed under the terms of the GNU GPL v2.0,
10  * pursuant to article 5.3.4 of the CeCILL v.2.1.
11  * This file was originally licensed under the terms of the CeCILL v2.1,
12  * and continues to be available under such terms.
13  * For more information, see the COPYING file which you should have received
14  * along with this program.
15  *
16  -->
17 <refentry 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" xmlns:scilab="http://www.scilab.org" xml:id="man" xml:lang="en">
18     <refnamediv>
19         <refname>Scilab documentation format</refname>
20         <refpurpose>on line help XML file description format</refpurpose>
21     </refnamediv>
22     <refsection>
23         <title>Description</title>
24         <para>The on line help source files are written in XML.</para>
25         <para>Source files (with extension .xml) can be found in the
26             <literal>&lt;SCIDIR&gt;/modules/&lt;MODULE
27                 NAME&gt;/help/&lt;language&gt;/*
28             </literal>
29             directories. The file name is
30             usually associated to a keyword (corresponding to a function name most of
31             the cases) it describes.
32         </para>
33     </refsection>
34     <refsection>
35         <title>A few words about XML</title>
36         <para>A XML file is similar to a HTML file but with a more rigid syntax.
37             The documentation of Scilab must be written using the strict subset of
38             DocBook 5 defined in SCI/modules/helptools/schema/scilab.rnc. DocBook 5
39             elements are fully documented in <ulink url="http://docbook.org/tdg5/en/html/docbook.html">"DocBook 5.0: The Definitive Guide"</ulink>
40         </para>
41         <para>
42             Scilab is able to understand a large subset of Docbook tags. However, if any are missing, a bug report can be reported on the <ulink url="http://bugzilla.scilab.org/">Scilab bug tracker</ulink>.
43         </para>
44     </refsection>
45     <refsection>
46         <title>How to write a simple XML scilab help page:</title>
47         <para>If one want to write the XML file associated to a new scilab
48             function he or she may use the Scilab function <link linkend="help_skeleton">help_skeleton</link> to produce the skeleton of
49             the XML file. In most cases, the user will not be required to know XML
50             syntax.
51         </para>
52     </refsection>
53     <refsection>
54         <title>How to write a simple XML scilab help page: an example</title>
55         <para>The root element of a document which conforms to the Scilab DocBook
56             5 subset must have version attribute set to "5.0-subset Scilab".
57         </para>
58         <programlisting role="xml"><![CDATA[
59 &lt;?xml version="1.0" encoding="UTF-8"?&gt;
60 &lt;refentry xmlns:scilab="http://www.scilab.org" xml:id="foo" xml:lang="en"
61 xmlns="http://docbook.org/ns/docbook"
62 xmlns:xlink="http://www.w3.org/1999/xlink"
63 xmlns:svg="http://www.w3.org/2000/svg"
64 xmlns:ns4="http://www.w3.org/1999/xhtml"
65 xmlns:mml="http://www.w3.org/1998/Math/MathML"
66 xmlns:db="http://docbook.org/ns/docbook"&gt;
67  ]]></programlisting>
68         <para role="bold">Example:</para>
69         <programlisting role="example"><![CDATA[
70 function y = foo(a,b,c)
71    y = a + 2 * b + c;
72 endfunction
73
74 path = help_skeleton('foo', TMPDIR)
75 if (isdef('editor') | (funptr('editor')&lt;&gt;0)) then
76    editor(path);
77 end
78          ]]></programlisting>
79         <para role="bold">Generated foo.xml in TMPDIR:</para>
80         <programlisting role="xml"><![CDATA[
81 &lt;?xml version="1.0" encoding="UTF-8"?&gt;
82 &lt;!--
83 * Add some comments about XML file
84 --&gt;
85 &lt;refentry xmlns:scilab="http://www.scilab.org" xml:id="foo" xml:lang="en"
86           xmlns="http://docbook.org/ns/docbook"
87           xmlns:xlink="http://www.w3.org/1999/xlink"
88           xmlns:svg="http://www.w3.org/2000/svg"
89           xmlns:ns4="http://www.w3.org/1999/xhtml"
90           xmlns:mml="http://www.w3.org/1998/Math/MathML"
91           xmlns:db="http://docbook.org/ns/docbook"&gt;
92   &lt;refnamediv&gt;
93     &lt;refname&gt;foo&lt;/refname&gt;
94     &lt;refpurpose&gt;Add short description here. &lt;/refpurpose&gt;
95   &lt;/refnamediv&gt;
96   &lt;refsynopsisdiv&gt;
97     &lt;title&gt;Syntax&lt;/title&gt;
98     &lt;synopsis&gt;y = foo(a,b,c)&lt;/synopsis&gt;
99   &lt;/refsynopsisdiv&gt;
100   &lt;refsection&gt;
101     &lt;title&gt;Arguments&lt;/title&gt;
102     &lt;variablelist&gt;
103       &lt;varlistentry&gt;
104         &lt;term&gt;a&lt;/term&gt;
105         &lt;listitem&gt;
106           &lt;para&gt;
107             Add here the input argument description.
108           &lt;/para&gt;
109         &lt;/listitem&gt;
110       &lt;/varlistentry&gt;
111       &lt;varlistentry&gt;
112         &lt;term&gt;b&lt;/term&gt;
113         &lt;listitem&gt;
114           &lt;para&gt;
115             Add here the input argument description.
116           &lt;/para&gt;
117         &lt;/listitem&gt;
118       &lt;/varlistentry&gt;
119       &lt;varlistentry&gt;
120         &lt;term&gt;c&lt;/term&gt;
121         &lt;listitem&gt;
122           &lt;para&gt;
123             Add here the input argument description.
124           &lt;/para&gt;
125         &lt;/listitem&gt;
126       &lt;/varlistentry&gt;
127       &lt;varlistentry&gt;
128         &lt;term&gt;y&lt;/term&gt;
129         &lt;listitem&gt;
130           &lt;para&gt;
131             Add here the output argument description.
132           &lt;/para&gt;
133         &lt;/listitem&gt;
134       &lt;/varlistentry&gt;
135     &lt;/variablelist&gt;
136   &lt;/refsection&gt;
137   &lt;refsection&gt;
138     &lt;title&gt;Description&lt;/title&gt;
139     &lt;para&gt;
140       Add here a paragraph of the function description.
141       Other paragraph can be added
142     &lt;/para&gt;
143     &lt;para&gt;With a latex expression
144     &lt;latex&gt;
145       \begin{eqnarray}
146       f(x,a,r) = \frac{1}{r^{-a}\Gamma(a)} \int_0^x t^{a-1} \exp\left(-rt\right) dt
147       \end{eqnarray}
148     &lt;/latex&gt;
149     &lt;/para&gt;
150   &lt;/refsection&gt;
151   &lt;refsection&gt;
152     &lt;title&gt;More information&lt;/title&gt;
153     &lt;note&gt;&lt;para&gt;A note about foo&lt;/para&gt;&lt;/note&gt;
154     &lt;caution&gt;&lt;para&gt;A caution about foo&lt;/para&gt;&lt;/caution&gt;
155     &lt;warning&gt;&lt;para&gt;A warning about foo&lt;/para&gt;&lt;/warning&gt;
156     &lt;important&gt;&lt;para&gt;A important about foo&lt;/para&gt;&lt;/important&gt;
157     &lt;tip&gt;&lt;para&gt;A tip about foo&lt;/para&gt;&lt;/tip&gt;
158   &lt;/refsection&gt;
159   &lt;refsection&gt;
160     &lt;title&gt;Examples&lt;/title&gt;
161     &lt;programlisting role="example"&gt;&lt;![CDATA[
162     Add here scilab instructions and comments
163     ]]&gt;&lt;/programlisting&gt;
164   &lt;/refsection&gt;
165   &lt;refsection&gt;
166     &lt;title&gt;See Also&lt;/title&gt;
167     &lt;simplelist type="inline"&gt;
168       &lt;member&gt;
169         &lt;link linkend="add a reference name" &gt;add a reference&lt;/link&gt;
170       &lt;/member&gt;
171       &lt;member&gt;
172         &lt;link linkend="add a reference name"&gt;add a reference&lt;/link&gt;
173       &lt;/member&gt;
174     &lt;/simplelist&gt;
175   &lt;/refsection&gt;
176   &lt;refsection&gt;
177     &lt;title&gt;Authors&lt;/title&gt;
178     &lt;simplelist type="vert"&gt;
179       &lt;member&gt;add the author name and author reference&lt;/member&gt;
180       &lt;member&gt;add another author name and it's reference&lt;/member&gt;
181     &lt;/simplelist&gt;
182   &lt;/refsection&gt;
183   &lt;refsection&gt;
184     &lt;title&gt;Bibliography&lt;/title&gt;
185     &lt;para&gt;
186       Add here the function bibliography
187     &lt;/para&gt;
188   &lt;/refsection&gt;
189   &lt;refsection&gt;
190     &lt;title&gt;History&lt;/title&gt;
191     &lt;revhistory&gt;
192       &lt;revision&gt;
193         &lt;revnumber&gt;X.Y&lt;/revnumber&gt;
194         &lt;revdescription&gt;Function foo added&lt;/revdescription&gt;
195       &lt;/revision&gt;
196     &lt;/revhistory&gt;
197   &lt;/refsection&gt;
198   &lt;refsection&gt;
199     &lt;title&gt;Used Functions&lt;/title&gt;
200     &lt;para&gt;
201       Add here the Scilab, C,... used code references
202     &lt;/para&gt;
203   &lt;/refsection&gt;
204 &lt;/refentry&gt;
205         ]]></programlisting>
206     </refsection>
207     <refsection>
208         <title>How to create a help chapter</title>
209         <para>Create a directory and write down a set of XML files build as
210             described above. Then start Scilab and execute <literal>xmltojar
211             </literal>
212             (see <link linkend="xmltojar">xmltojar</link> for more details)
213             .
214         </para>
215     </refsection>
216     <refsection>
217         <title>How to make Scilab know a new help chapter</title>
218         <para>
219             This can be done by the function <link linkend="add_help_chapter">add_help_chapter</link>.
220         </para>
221     </refsection>
222     <refsection>
223         <title>List of docbook supported tags</title>
224         <para>Sectionning and referencing tags:
225             <informaltable border="1">
226                 <tr>
227                     <td>
228                         <ulink url="http://docbook.org/tdg/en/html/refentry.html">refentry</ulink>
229                     </td>
230                     <td>A reference page</td>
231                 </tr>
232                 <tr>
233                     <td>
234                         <ulink url="http://docbook.org/tdg/en/html/refsection.html">refsection</ulink>
235                     </td>
236                     <td>A recursive section in a refentry</td>
237                 </tr>
238                 <tr>
239                     <td>
240                         <ulink url="http://docbook.org/tdg/en/html/book.html">book</ulink>
241                     </td>
242                     <td>A book</td>
243                 </tr>
244                 <tr>
245                     <td>
246                         <ulink url="http://docbook.org/tdg/en/html/part.html">part</ulink>
247                     </td>
248                     <td>A division in a book</td>
249                 </tr>
250                 <tr>
251                     <td>
252                         <ulink url="http://docbook.org/tdg/en/html/chapter.html">chapter</ulink>
253                     </td>
254                     <td>A chapter, as of a book</td>
255                 </tr>
256                 <tr>
257                     <td>
258                         <ulink url="http://docbook.org/tdg/en/html/section.html">section</ulink>
259                     </td>
260                     <td>A recursive section</td>
261                 </tr>
262                 <tr>
263                     <td>
264                         <ulink url="http://docbook.org/tdg/en/html/para.html">para</ulink>
265                     </td>
266                     <td>A paragraph</td>
267                 </tr>
268             </informaltable>
269         </para>
270
271         <para>Contents types:
272             <informaltable border="1">
273                 <tr>
274                     <td>
275                         <ulink url="http://docbook.org/tdg/en/html/refnamediv.html">refnamediv</ulink>
276                     </td>
277                     <td>The name, purpose, and classification of a reference page</td>
278                 </tr>
279                 <tr>
280                     <td>
281                         <ulink url="http://docbook.org/tdg/en/html/refname.html">refname</ulink>
282                     </td>
283                     <td>The name of (one of) the subject(s) of a reference page</td>
284                 </tr>
285                 <tr>
286                     <td>
287                         <ulink url="http://docbook.org/tdg/en/html/refpurpose.html">refpurpose</ulink>
288                     </td>
289                     <td>A short (one sentence) synopsis of the topic of a reference page</td>
290                 </tr>
291                 <tr>
292                     <td>
293                         <ulink url="http://docbook.org/tdg/en/html/refsynopsisdiv.html">refsynopsisdiv</ulink>
294                     </td>
295                     <td>A syntactic synopsis of the subject of the reference page
296                     </td>
297                 </tr>
298                 <tr>
299                     <td>
300                         <ulink url="http://docbook.org/tdg/en/html/synopsis.html">synopsis</ulink>
301                     </td>
302                     <td>A general-purpose element for representing the syntax of commands or functions</td>
303                 </tr>
304                 <tr>
305                     <td>
306                         <ulink url="http://docbook.org/tdg/en/html/title.html">title</ulink>
307                     </td>
308                     <td>The text of the title of a section of a document or of a formal block-level element</td>
309                 </tr>
310                 <tr>
311                     <td>
312                         <ulink url="http://docbook.org/tdg/en/html/informalequation.html">informalequation</ulink>
313                     </td>
314                     <td>A displayed mathematical equation without a title
315                     </td>
316                 </tr>
317                 <tr>
318                     <td>
319                         <ulink url="http://docbook.org/tdg/en/html/programlisting.html">programlisting</ulink>
320                     </td>
321                     <td>A literal listing of all or part of a program</td>
322                 </tr>
323                 <tr>
324                     <td>
325                         <ulink url="http://docbook.org/tdg/en/html/screen.html">screen</ulink>
326                     </td>
327                     <td>Text that a user sees or might see on a computer screen</td>
328                 </tr>
329                 <tr>
330                     <td>
331                         <ulink url="http://docbook.org/tdg/en/html/caption.html">caption</ulink>
332                     </td>
333                     <td>A caption</td>
334                 </tr>
335                 <tr>
336                     <td>
337                         <ulink url="http://docbook.org/tdg/en/html/pubdate.html">pubdate</ulink>
338                     </td>
339                     <td>The date of publication of a document</td>
340                 </tr>
341                 <tr>
342                     <td>
343                         <ulink url="http://docbook.org/tdg/en/html/bibliomset.html">bibliomset</ulink>
344                     </td>
345                     <td>A 'cooked' container for related bibliographic information</td>
346                 </tr>
347                 <tr>
348                     <td>
349                         <ulink url="http://docbook.org/tdg/en/html/bibliomixed.html">bibliomixed</ulink>
350                     </td>
351                     <td>An entry in a Bibliography</td>
352                 </tr>
353                 <tr>
354                     <td>
355                         <ulink url="http://docbook.org/tdg/en/html/surname.html">surname</ulink>
356                     </td>
357                     <td>A family name; in western cultures the 'last name'</td>
358                 </tr>
359                 <tr>
360                     <td>
361                         <ulink url="http://docbook.org/tdg/en/html/firstname.html">firstname</ulink>
362                     </td>
363                     <td>The first name of a person
364                     </td>
365                 </tr>
366                 <tr>
367                     <td>
368                         <ulink url="http://docbook.org/tdg/en/html/replaceable.html">replaceable</ulink>
369                     </td>
370                     <td>Content that may or must be replaced by the user
371                     </td>
372                 </tr>
373             </informaltable>
374         </para>
375         <para>Contents styles:
376             <informaltable border="1">
377                 <tr>
378                     <td>
379                         <ulink url="http://docbook.org/tdg/en/html/function.html">function</ulink>
380                     </td>
381                     <td>The name of a function or subroutine, as in a programming language</td>
382                 </tr>
383                 <tr>
384                     <td>
385                         <ulink url="http://docbook.org/tdg/en/html/varname.html">varname</ulink>
386                     </td>
387                     <td>The name of a variable</td>
388                 </tr>
389                 <tr>
390                     <td>
391                         <ulink url="http://docbook.org/tdg/en/html/literal.html">literal</ulink>
392                     </td>
393                     <td>Inline text that is some literal value</td>
394                 </tr>
395                 <tr>
396                     <td>
397                         <ulink url="http://docbook.org/tdg/en/html/emphasis.html">emphasis</ulink>
398                     </td>
399                     <td>Emphasized text</td>
400                 </tr>
401                 <tr>
402                     <td>
403                         <ulink url="http://docbook.org/tdg/en/html/subscript.html">subscript</ulink>
404                     </td>
405                     <td>
406                         A subscript (as in H<subscript>2</subscript>O, the molecular formula for water)
407                     </td>
408                 </tr>
409                 <tr>
410                     <td>
411                         <ulink url="http://docbook.org/tdg/en/html/superscript.html">superscript</ulink>
412                     </td>
413                     <td>
414                         A superscript (as in x<superscript>2</superscript>, the mathematical notation for x multiplied by itself)
415                     </td>
416                 </tr>
417             </informaltable>
418         </para>
419         <para>Links:
420             <informaltable border="1">
421                 <tr>
422                     <td>
423                         <ulink url="http://docbook.org/tdg/en/html/ulink.html">ulink</ulink>
424                     </td>
425                     <td>A link that addresses its target by means of a URL (Uniform Resource Locator)</td>
426                 </tr>
427                 <tr>
428                     <td>
429                         <ulink url="http://docbook.org/tdg/en/html/link.html">link</ulink>
430                     </td>
431                     <td>A hypertext link</td>
432                 </tr>
433                 <tr>
434                     <td>
435                         <ulink url="http://docbook.org/tdg/en/html/xref.html">xref</ulink>
436                     </td>
437                     <td>A cross reference to another part of the document</td>
438                 </tr>
439             </informaltable>
440         </para>
441         <para>List tags:
442             <informaltable border="1">
443                 <tr>
444                     <td>
445                         <ulink url="http://docbook.org/tdg/en/html/simplelist.html">simplelist</ulink>
446                     </td>
447                     <td>An undecorated list of single words or short phrases</td>
448                 </tr>
449                 <tr>
450                     <td>
451                         <ulink url="http://docbook.org/tdg/en/html/member.html">member</ulink>
452                     </td>
453                     <td>An element of a simple list</td>
454                 </tr>
455                 <tr>
456                     <td>
457                         <ulink url="http://docbook.org/tdg/en/html/itemizedlist.html">itemizedlist</ulink>
458                     </td>
459                     <td>A list in which each entry is marked with a bullet or other dingbat
460                     </td>
461                 </tr>
462                 <tr>
463                     <td>
464                         <ulink url="http://docbook.org/tdg/en/html/orderedlist.html">orderedlist</ulink>
465                     </td>
466                     <td>A list in which each entry is marked with a sequentially incremented label
467                     </td>
468                 </tr>
469                 <tr>
470                     <td>
471                         <ulink url="http://docbook.org/tdg/en/html/listitem.html">listitem</ulink>
472                     </td>
473                     <td>A wrapper for the elements of a list item
474                     </td>
475                 </tr>
476                 <tr>
477                     <td>
478                         <ulink url="http://docbook.org/tdg/en/html/variablelist.html">variablelist</ulink>
479                     </td>
480                     <td>A list in which each entry is composed of a set of one or more terms and an associated description</td>
481                 </tr>
482                 <tr>
483                     <td>
484                         <ulink url="http://docbook.org/tdg/en/html/term.html">term</ulink>
485                     </td>
486                     <td>The word or phrase being defined or described in a variable list</td>
487                 </tr>
488                 <tr>
489                     <td>
490                         <ulink url="http://docbook.org/tdg/en/html/varlistentry.html">varlistentry</ulink>
491                     </td>
492                     <td>A wrapper for a set of terms and the associated description in a variable list</td>
493                 </tr>
494             </informaltable>
495         </para>
496         <para>Table tags:
497             <informaltable border="1">
498                 <tr>
499                     <td>
500                         <ulink url="http://docbook.org/tdg/en/html/table.html">table</ulink>
501                     </td>
502                     <td>A formal table in a document</td>
503                 </tr>
504                 <tr>
505                     <td>
506                         <ulink url="http://docbook.org/tdg/en/html/informaltable.html">informaltable</ulink>
507                     </td>
508                     <td>A table without a title</td>
509                 </tr>
510                 <tr>
511                     <td>
512                         <ulink url="http://docbook.org/tdg/en/html/tbody.html">tbody</ulink>
513                     </td>
514                     <td>A wrapper for the rows of a table or informal table</td>
515                 </tr>
516                 <tr>
517                     <td>
518                         <ulink url="http://docbook.org/tdg/en/html/tr.html">tr</ulink>
519                     </td>
520                     <td>A row in an HTML table</td>
521                 </tr>
522                 <tr>
523                     <td>
524                         <ulink url="http://docbook.org/tdg/en/html/td.html">td</ulink>
525                     </td>
526                     <td>A table entry in an HTML table</td>
527                 </tr>
528                 <tr>
529                     <td>
530                         <ulink url="http://docbook.org/tdg/en/html/th.html">th</ulink>
531                     </td>
532                     <td>A table header entry in an HTML table</td>
533                 </tr>
534                 <tr>
535                     <td>
536                         bgcolor
537                     </td>
538                     <td>A HTML attribute for a table, a tr or a td to set the background color</td>
539                 </tr>
540             </informaltable>
541         </para>
542         <para>Image tags:
543             <informaltable border="1">
544                 <tr>
545                     <td>
546                         <ulink url="http://docbook.org/tdg/en/html/imagedata.html">imagedata</ulink>
547                     </td>
548                     <td>Pointer to external image data</td>
549                 </tr>
550                 <tr>
551                     <td>
552                         <ulink url="http://docbook.org/tdg/en/html/imageobject.html">imageobject</ulink>
553                     </td>
554                     <td>A wrapper for image data and its associated meta-information</td>
555                 </tr>
556                 <tr>
557                     <td>
558                         <ulink url="http://docbook.org/tdg/en/html/inlinemediaobject.html">inlinemediaobject</ulink>
559                     </td>
560                     <td>An inline media object (video, audio, image, and so on)</td>
561                 </tr>
562                 <tr>
563                     <td>
564                         <ulink url="http://docbook.org/tdg/en/html/screenshot.html">screenshot</ulink>
565                     </td>
566                     <td>A representation of what the user sees or might see on a computer screen</td>
567                 </tr>
568                 <tr>
569                     <td>
570                         <ulink url="http://docbook.org/tdg/en/html/mediaobject.html">mediaobject</ulink>
571                     </td>
572                     <td>A displayed media object (video, audio, image, etc.)</td>
573                 </tr>
574                 <tr>
575                     <td>
576                         scilab:image
577                     </td>
578                     <td>
579                         Any Scilab code into the &lt;scilab:image&gt; foo() &lt;scilab:image&gt; will be executed by an instance of Scilab and the generated graphic included directly into the documentation. This is a Scilab extension of Docbook and is based on the <link linkend="xinit">driver/xinit/xend</link> feature.
580                     </td>
581                 </tr>
582             </informaltable>
583         </para>
584         <para>FAQ tags:
585             <informaltable border="1">
586                 <tr>
587                     <td>
588                         <ulink url="http://docbook.org/tdg/en/html/question.html">question</ulink>
589                     </td>
590                     <td>A question in a QandASet</td>
591                 </tr>
592                 <tr>
593                     <td>
594                         <ulink url="http://docbook.org/tdg/en/html/answer.html">answer</ulink>
595                     </td>
596                     <td>An answer to a question posed in a QandASet</td>
597                 </tr>
598                 <tr>
599                     <td>
600                         <ulink url="http://docbook.org/tdg/en/html/qandaentry.html">qandaentry</ulink>
601                     </td>
602                     <td>A question/answer set within a QandASet</td>
603                 </tr>
604                 <tr>
605                     <td>
606                         <ulink url="http://docbook.org/tdg/en/html/qandaset.html">qandaset</ulink>
607                     </td>
608                     <td>A question-and-answer set</td>
609                 </tr>
610             </informaltable>
611         </para>
612         <para>History tags:
613             <informaltable border="1">
614                 <tr>
615                     <td>
616                         <ulink url="http://docbook.org/tdg/en/html/revhistory.html">revhistory</ulink>
617                     </td>
618                     <td>A history of the revisions to a document</td>
619                 </tr>
620                 <tr>
621                     <td>
622                         <ulink url="http://docbook.org/tdg/en/html/revision.html">revision</ulink>
623                     </td>
624                     <td>An entry describing a single revision in the history of the revisions to a document</td>
625                 </tr>
626                 <tr>
627                     <td>
628                         <ulink url="http://docbook.org/tdg/en/html/revnumber.html">revnumber</ulink>
629                     </td>
630                     <td>A document revision number</td>
631                 </tr>
632                 <tr>
633                     <td>
634                         <ulink url="http://docbook.org/tdg/en/html/revremark.html">revremark</ulink>
635                     </td>
636                     <td>A description of a revision to a document</td>
637                 </tr>
638                 <tr>
639                     <td>
640                         <ulink url="http://docbook.org/tdg/en/html/revdescription.html">revdescription</ulink>
641                     </td>
642                     <td>A extended description of a revision to a document
643                     </td>
644                 </tr>
645             </informaltable>
646         </para>
647         <para>Information tags:
648             <informaltable border="1">
649                 <tr>
650                     <td>
651                         <ulink url="http://docbook.org/tdg/en/html/note.html">note</ulink>
652                     </td>
653                     <td>A message set off from the text
654                     </td>
655                 </tr>
656                 <tr>
657                     <td>
658                         <ulink url="http://docbook.org/tdg/en/html/warning.html">warning</ulink>
659                     </td>
660                     <td>An admonition set off from the text</td>
661                 </tr>
662                 <tr>
663                     <td>
664                         <ulink url="http://docbook.org/tdg/en/html/caution.html">caution</ulink>
665                     </td>
666                     <td>A note of caution</td>
667                 </tr>
668                 <tr>
669                     <td>
670                         <ulink url="http://docbook.org/tdg/en/html/tip.html">tip</ulink>
671                     </td>
672                     <td>A suggestion to the user, set off from the text
673                     </td>
674                 </tr>
675                 <tr>
676                     <td>
677                         <ulink url="http://docbook.org/tdg/en/html/important.html">important</ulink>
678                     </td>
679                     <td>An admonition set off from the text</td>
680                 </tr>
681             </informaltable>
682         </para>
683         <para>Scilab specific tag:
684             <informaltable border="1">
685                 <tr>
686                     <td>latex</td><td>Scilab extension to write directly LaTeX expression in the help pages</td>
687                 </tr>
688             </informaltable>
689         </para>
690     </refsection>
691     <refsection>
692         <title>History</title>
693         <revhistory>
694             <revision>
695                 <revnumber>5.4.0</revnumber>
696                 <revdescription>Management of tags &lt;note&gt;, &lt;caution&gt;, &lt;warning&gt;, &lt;important&gt; and &lt;tip&gt;
697                 </revdescription>
698             </revision>
699         </revhistory>
700     </refsection>
701     <refsection role="see also">
702         <title>See Also</title>
703         <simplelist type="inline">
704             <member>
705                 <link linkend="apropos">apropos</link>
706             </member>
707             <member>
708                 <link linkend="help">help</link>
709             </member>
710             <member>
711                 <link linkend="help_skeleton">help_skeleton</link>
712             </member>
713             <member>
714                 <link linkend="help_from_sci">help_from_sci</link>
715             </member>
716             <member>
717                 <link linkend="xmltojar">xmltojar</link>
718             </member>
719             <member>
720                 <link linkend="add_help_chapter">add_help_chapter</link>
721             </member>
722         </simplelist>
723     </refsection>
724 </refentry>