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