ee0b1d94c13578bce76a2ebf8dcd7d185380e660
[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.1 defined in SCI/modules/helptools/schema/scilab.rng. DocBook 5.1
39             elements are fully documented in <ulink url="http://docbook.org/tdg51/en/html/docbook.html">"DocBook 5.1: 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 role="see-also"&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 role="bibliography"&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 role="history"&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/tdg51/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/tdg51/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/tdg51/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/tdg51/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/tdg51/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/tdg51/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/tdg51/en/html/para.html">para</ulink>
265                     </td>
266                     <td>A paragraph</td>
267                 </tr>
268             </informaltable>
269         </para>
270         <para>Contents types:
271             <informaltable border="1">
272                 <tr>
273                     <td>
274                         <ulink url="http://docbook.org/tdg51/en/html/refnamediv.html">refnamediv</ulink>
275                     </td>
276                     <td>The name, purpose, and classification of a reference page</td>
277                 </tr>
278                 <tr>
279                     <td>
280                         <ulink url="http://docbook.org/tdg51/en/html/refname.html">refname</ulink>
281                     </td>
282                     <td>The name of (one of) the subject(s) of a reference page</td>
283                 </tr>
284                 <tr>
285                     <td>
286                         <ulink url="http://docbook.org/tdg51/en/html/refpurpose.html">refpurpose</ulink>
287                     </td>
288                     <td>A short (one sentence) synopsis of the topic of a reference page</td>
289                 </tr>
290                 <tr>
291                     <td>
292                         <ulink url="http://docbook.org/tdg51/en/html/refsynopsisdiv.html">refsynopsisdiv</ulink>
293                     </td>
294                     <td>A syntactic synopsis of the subject of the reference page
295                     </td>
296                 </tr>
297                 <tr>
298                     <td>
299                         <ulink url="http://docbook.org/tdg51/en/html/synopsis.html">synopsis</ulink>
300                     </td>
301                     <td>A general-purpose element for representing the syntax of commands or functions</td>
302                 </tr>
303                 <tr>
304                     <td>
305                         <ulink url="http://docbook.org/tdg51/en/html/title.html">title</ulink>
306                     </td>
307                     <td>The text of the title of a section of a document or of a formal block-level element</td>
308                 </tr>
309                 <tr>
310                     <td>
311                         <ulink url="http://docbook.org/tdg51/en/html/informalequation.html">informalequation</ulink>
312                     </td>
313                     <td>A displayed mathematical equation without a title
314                     </td>
315                 </tr>
316                 <tr>
317                     <td>
318                         <ulink url="http://docbook.org/tdg51/en/html/programlisting.html">programlisting</ulink>
319                     </td>
320                     <td>A literal listing of all or part of a program</td>
321                 </tr>
322                 <tr>
323                     <td>
324                         <ulink url="http://docbook.org/tdg51/en/html/screen.html">screen</ulink>
325                     </td>
326                     <td>Text that a user sees or might see on a computer screen</td>
327                 </tr>
328                 <tr>
329                     <td>
330                         <ulink url="http://docbook.org/tdg51/en/html/caption.html">caption</ulink>
331                     </td>
332                     <td>A caption</td>
333                 </tr>
334                 <tr>
335                     <td>
336                         <ulink url="http://docbook.org/tdg51/en/html/pubdate.html">pubdate</ulink>
337                     </td>
338                     <td>The date of publication of a document</td>
339                 </tr>
340                 <tr>
341                     <td>
342                         <ulink url="http://docbook.org/tdg51/en/html/bibliomset.html">bibliomset</ulink>
343                     </td>
344                     <td>A 'cooked' container for related bibliographic information</td>
345                 </tr>
346                 <tr>
347                     <td>
348                         <ulink url="http://docbook.org/tdg51/en/html/bibliomixed.html">bibliomixed</ulink>
349                     </td>
350                     <td>An entry in a Bibliography</td>
351                 </tr>
352                 <tr>
353                     <td>
354                         <ulink url="http://docbook.org/tdg51/en/html/surname.html">surname</ulink>
355                     </td>
356                     <td>A family name; in western cultures the 'last name'</td>
357                 </tr>
358                 <tr>
359                     <td>
360                         <ulink url="http://docbook.org/tdg51/en/html/firstname.html">firstname</ulink>
361                     </td>
362                     <td>The first name of a person
363                     </td>
364                 </tr>
365                 <tr>
366                     <td>
367                         <ulink url="http://docbook.org/tdg51/en/html/replaceable.html">replaceable</ulink>
368                     </td>
369                     <td>Content that may or must be replaced by the user
370                     </td>
371                 </tr>
372             </informaltable>
373         </para>
374         <para>Contents styles:
375             <informaltable border="1">
376                 <tr>
377                     <td>
378                         <ulink url="http://docbook.org/tdg51/en/html/function.html">function</ulink>
379                     </td>
380                     <td>The name of a function or subroutine, as in a programming language</td>
381                 </tr>
382                 <tr>
383                     <td>
384                         <ulink url="http://docbook.org/tdg51/en/html/varname.html">varname</ulink>
385                     </td>
386                     <td>The name of a variable</td>
387                 </tr>
388                 <tr>
389                     <td>
390                         <ulink url="http://docbook.org/tdg51/en/html/literal.html">literal</ulink>
391                     </td>
392                     <td>Inline text that is some literal value</td>
393                 </tr>
394                 <tr>
395                     <td>
396                         <ulink url="http://docbook.org/tdg51/en/html/emphasis.html">emphasis</ulink>
397                     </td>
398                     <td>Emphasized text</td>
399                 </tr>
400                 <tr>
401                     <td>
402                         <ulink url="http://docbook.org/tdg51/en/html/subscript.html">subscript</ulink>
403                     </td>
404                     <td>
405                         A subscript (as in H<subscript>2</subscript>O, the molecular formula for water)
406                     </td>
407                 </tr>
408                 <tr>
409                     <td>
410                         <ulink url="http://docbook.org/tdg51/en/html/superscript.html">superscript</ulink>
411                     </td>
412                     <td>
413                         A superscript (as in x<superscript>2</superscript>, the mathematical notation for x multiplied by itself)
414                     </td>
415                 </tr>
416             </informaltable>
417         </para>
418         <para>Links:
419             <informaltable border="1">
420                 <tr>
421                     <td>
422                         <ulink url="http://docbook.org/tdg51/en/html/ulink.html">ulink</ulink>
423                     </td>
424                     <td>A link that addresses its target by means of a URL (Uniform Resource Locator)</td>
425                 </tr>
426                 <tr>
427                     <td>
428                         <ulink url="http://docbook.org/tdg51/en/html/link.html">link</ulink>
429                     </td>
430                     <td>A hypertext link</td>
431                 </tr>
432                 <tr>
433                     <td>
434                         <ulink url="http://docbook.org/tdg51/en/html/xref.html">xref</ulink>
435                     </td>
436                     <td>A cross reference to another part of the document</td>
437                 </tr>
438             </informaltable>
439         </para>
440         <para>List tags:
441             <informaltable border="1">
442                 <tr>
443                     <td>
444                         <ulink url="http://docbook.org/tdg51/en/html/simplelist.html">simplelist</ulink>
445                     </td>
446                     <td>An undecorated list of single words or short phrases</td>
447                 </tr>
448                 <tr>
449                     <td>
450                         <ulink url="http://docbook.org/tdg51/en/html/member.html">member</ulink>
451                     </td>
452                     <td>An element of a simple list</td>
453                 </tr>
454                 <tr>
455                     <td>
456                         <ulink url="http://docbook.org/tdg51/en/html/itemizedlist.html">itemizedlist</ulink>
457                     </td>
458                     <td>A list in which each entry is marked with a bullet or other dingbat
459                     </td>
460                 </tr>
461                 <tr>
462                     <td>
463                         <ulink url="http://docbook.org/tdg51/en/html/orderedlist.html">orderedlist</ulink>
464                     </td>
465                     <td>A list in which each entry is marked with a sequentially incremented label
466                     </td>
467                 </tr>
468                 <tr>
469                     <td>
470                         <ulink url="http://docbook.org/tdg51/en/html/listitem.html">listitem</ulink>
471                     </td>
472                     <td>A wrapper for the elements of a list item
473                     </td>
474                 </tr>
475                 <tr>
476                     <td>
477                         <ulink url="http://docbook.org/tdg51/en/html/variablelist.html">variablelist</ulink>
478                     </td>
479                     <td>A list in which each entry is composed of a set of one or more terms and an associated description</td>
480                 </tr>
481                 <tr>
482                     <td>
483                         <ulink url="http://docbook.org/tdg51/en/html/term.html">term</ulink>
484                     </td>
485                     <td>The word or phrase being defined or described in a variable list</td>
486                 </tr>
487                 <tr>
488                     <td>
489                         <ulink url="http://docbook.org/tdg51/en/html/varlistentry.html">varlistentry</ulink>
490                     </td>
491                     <td>A wrapper for a set of terms and the associated description in a variable list</td>
492                 </tr>
493             </informaltable>
494         </para>
495         <para>Table tags:
496             <informaltable border="1">
497                 <tr>
498                     <td>
499                         <ulink url="http://docbook.org/tdg51/en/html/table.html">table</ulink>
500                     </td>
501                     <td>A formal table in a document</td>
502                 </tr>
503                 <tr>
504                     <td>
505                         <ulink url="http://docbook.org/tdg51/en/html/informaltable.html">informaltable</ulink>
506                     </td>
507                     <td>A table without a title</td>
508                 </tr>
509                 <tr>
510                     <td>
511                         <ulink url="http://docbook.org/tdg51/en/html/tbody.html">tbody</ulink>
512                     </td>
513                     <td>A wrapper for the rows of a table or informal table</td>
514                 </tr>
515                 <tr>
516                     <td>
517                         <ulink url="http://docbook.org/tdg51/en/html/tr.html">tr</ulink>
518                     </td>
519                     <td>A row in an HTML table</td>
520                 </tr>
521                 <tr>
522                     <td>
523                         <ulink url="http://docbook.org/tdg51/en/html/td.html">td</ulink>
524                     </td>
525                     <td>A table entry in an HTML table</td>
526                 </tr>
527                 <tr>
528                     <td>
529                         <ulink url="http://docbook.org/tdg51/en/html/th.html">th</ulink>
530                     </td>
531                     <td>A table header entry in an HTML table</td>
532                 </tr>
533                 <tr>
534                     <td>
535                         bgcolor
536                     </td>
537                     <td>A HTML attribute for a table, a tr or a td to set the background color</td>
538                 </tr>
539             </informaltable>
540         </para>
541         <para>Image tags:
542             <informaltable border="1">
543                 <tr>
544                     <td>
545                         <ulink url="http://docbook.org/tdg51/en/html/imagedata.html">imagedata</ulink>
546                     </td>
547                     <td>Pointer to external image data</td>
548                 </tr>
549                 <tr>
550                     <td>
551                         <ulink url="http://docbook.org/tdg51/en/html/imageobject.html">imageobject</ulink>
552                     </td>
553                     <td>A wrapper for image data and its associated meta-information</td>
554                 </tr>
555                 <tr>
556                     <td>
557                         <ulink url="http://docbook.org/tdg51/en/html/inlinemediaobject.html">inlinemediaobject</ulink>
558                     </td>
559                     <td>An inline media object (video, audio, image, and so on)</td>
560                 </tr>
561                 <tr>
562                     <td>
563                         <ulink url="http://docbook.org/tdg51/en/html/screenshot.html">screenshot</ulink>
564                     </td>
565                     <td>A representation of what the user sees or might see on a computer screen</td>
566                 </tr>
567                 <tr>
568                     <td>
569                         <ulink url="http://docbook.org/tdg51/en/html/mediaobject.html">mediaobject</ulink>
570                     </td>
571                     <td>A displayed media object (video, audio, image, etc.)</td>
572                 </tr>
573                 <tr>
574                     <td>
575                         scilab:image
576                     </td>
577                     <td>
578                         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.
579                     </td>
580                 </tr>
581             </informaltable>
582         </para>
583         <para>FAQ tags:
584             <informaltable border="1">
585                 <tr>
586                     <td>
587                         <ulink url="http://docbook.org/tdg51/en/html/question.html">question</ulink>
588                     </td>
589                     <td>A question in a QandASet</td>
590                 </tr>
591                 <tr>
592                     <td>
593                         <ulink url="http://docbook.org/tdg51/en/html/answer.html">answer</ulink>
594                     </td>
595                     <td>An answer to a question posed in a QandASet</td>
596                 </tr>
597                 <tr>
598                     <td>
599                         <ulink url="http://docbook.org/tdg51/en/html/qandaentry.html">qandaentry</ulink>
600                     </td>
601                     <td>A question/answer set within a QandASet</td>
602                 </tr>
603                 <tr>
604                     <td>
605                         <ulink url="http://docbook.org/tdg51/en/html/qandaset.html">qandaset</ulink>
606                     </td>
607                     <td>A question-and-answer set</td>
608                 </tr>
609             </informaltable>
610         </para>
611         <para>History tags:
612             <informaltable border="1">
613                 <tr>
614                     <td>
615                         <ulink url="http://docbook.org/tdg51/en/html/revhistory.html">revhistory</ulink>
616                     </td>
617                     <td>A history of the revisions to a document</td>
618                 </tr>
619                 <tr>
620                     <td>
621                         <ulink url="http://docbook.org/tdg51/en/html/revision.html">revision</ulink>
622                     </td>
623                     <td>An entry describing a single revision in the history of the revisions to a document</td>
624                 </tr>
625                 <tr>
626                     <td>
627                         <ulink url="http://docbook.org/tdg51/en/html/revnumber.html">revnumber</ulink>
628                     </td>
629                     <td>A document revision number</td>
630                 </tr>
631                 <tr>
632                     <td>
633                         <ulink url="http://docbook.org/tdg51/en/html/revremark.html">revremark</ulink>
634                     </td>
635                     <td>A description of a revision to a document</td>
636                 </tr>
637                 <tr>
638                     <td>
639                         <ulink url="http://docbook.org/tdg51/en/html/revdescription.html">revdescription</ulink>
640                     </td>
641                     <td>A extended description of a revision to a document
642                     </td>
643                 </tr>
644             </informaltable>
645         </para>
646         <para>Information tags:
647             <informaltable border="1">
648                 <tr>
649                     <td>
650                         <ulink url="http://docbook.org/tdg51/en/html/note.html">note</ulink>
651                     </td>
652                     <td>A message set off from the text
653                     </td>
654                 </tr>
655                 <tr>
656                     <td>
657                         <ulink url="http://docbook.org/tdg51/en/html/warning.html">warning</ulink>
658                     </td>
659                     <td>An admonition set off from the text</td>
660                 </tr>
661                 <tr>
662                     <td>
663                         <ulink url="http://docbook.org/tdg51/en/html/caution.html">caution</ulink>
664                     </td>
665                     <td>A note of caution</td>
666                 </tr>
667                 <tr>
668                     <td>
669                         <ulink url="http://docbook.org/tdg51/en/html/tip.html">tip</ulink>
670                     </td>
671                     <td>A suggestion to the user, set off from the text
672                     </td>
673                 </tr>
674                 <tr>
675                     <td>
676                         <ulink url="http://docbook.org/tdg51/en/html/important.html">important</ulink>
677                     </td>
678                     <td>An admonition set off from the text</td>
679                 </tr>
680             </informaltable>
681         </para>
682         <para>Scilab specific tag:
683             <informaltable border="1">
684                 <tr>
685                     <td>latex</td><td>Scilab extension to write directly LaTeX expression in the help pages</td>
686                 </tr>
687             </informaltable>
688         </para>
689     </refsection>
690     <refsection role="see also">
691         <title>See also</title>
692         <simplelist type="inline">
693             <member>
694                 <link linkend="apropos">apropos</link>
695             </member>
696             <member>
697                 <link linkend="help">help</link>
698             </member>
699             <member>
700                 <link linkend="help_skeleton">help_skeleton</link>
701             </member>
702             <member>
703                 <link linkend="help_from_sci">help_from_sci</link>
704             </member>
705             <member>
706                 <link linkend="xmltojar">xmltojar</link>
707             </member>
708             <member>
709                 <link linkend="add_help_chapter">add_help_chapter</link>
710             </member>
711         </simplelist>
712     </refsection>
713     <refsection>
714         <title>History</title>
715         <revhistory>
716             <revision>
717                 <revnumber>5.4.0</revnumber>
718                 <revdescription>Management of tags &lt;note&gt;, &lt;caution&gt;, &lt;warning&gt;, &lt;important&gt; and &lt;tip&gt;
719                 </revdescription>
720                 <revnumber>6.0.0</revnumber>
721                 <revdescription>Update the documentation to Docbook 5.1</revdescription>
722             </revision>
723         </revhistory>
724     </refsection>
725 </refentry>