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