Some display improvements :
[scilab.git] / scilab_doc / toolbox_guide / html / toolbox.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
2 <html>
3         <head>
4                 <title>Toolbox Guide</title>
5                 <link rel="stylesheet" href="toolbox.css" type="text/css">
6         </head>
7         
8         <body>
9                 <h1 center>Guide for the toolboxes contribution (general application)<br /><hr></h1>
10                 <p>
11                         This article describes a standart method to create a Scilab toolbox.<br />
12                         The objective is to help the contributors to build a toolbox easily, but also that the users are able to install it with just the execution of a main builder and a main loader script.<br />
13                         We show in first time how to structure your toolbox (sub-directories contents, files, ...), in second time how to customize the templates to create the builder(s), the loader(s), and the Scilab help files. To finish we explain how to upload your contribution on the scilab website.<br />
14                         For this article the reference toolbox name is <b>toolbox_example</b>.
15                         (The above standarisation is not mandatory)
16                 </p>
17                 
18                 <h2>Table of content</h2>
19                 
20                 <ul>
21                         <a href="#chap1">1. Toolbox composition</a><br />
22                         <a href="#chap2">2. Sub-builders and sub-loaders</a><br />
23                         <ul>
24                                 <a href="#chap2.1">2.1. The macros directory</a><br />
25                                 <ul>
26                                         <a href="#chap2.1.1">2.1.1. Creation of the builder</a><br />
27                                         <a href="#chap2.1.2">2.1.2. Creation of the loader</a><br />
28                                 </ul>
29                                 <a href="#chap2.2">2.2. The src directory</a><br />
30                                 <ul>
31                                         <a href="#chap2.2.1">2.2.1. Interface</a><br />
32                                         <a href="#chap2.2.2">2.2.2. Creation of the builder</a><br />
33                                 </ul>
34                                         <a href="#chap2.3">2.3. The man directory</a><br />
35                                 <ul>
36                                         <a href="#chap2.3.1">2.3.1. Creation of .xml files</a><br />
37                                         <a href="#chap2.3.2">2.3.2. Creation of the builder</a><br />
38                                         <a href="#chap2.3.3">2.3.3. Creation of the loader</a><br />
39                                 </ul>
40                         </ul>
41                         <a href="#chap3">3. The main builder and loader</a><br />
42                         <a href="#chap4">4. Upload your toolbox</a><br />
43                 </ul>
44                 
45                 <a name="chap1"></a>
46                 <h2>1. Toolbox composition</h2>
47                 <p>The root directory has the generic name of the toolbox (here <b>toolbox_example</b>), it contains 7 sub-directories:</p> 
48                 
49                 <ul style="list-style-type: disc">
50                         <li><b>macros</b>: Scilab macros (all .sci files),the builder and loader scripts</li>
51                         <li><b>src</b>: code source (all .c and .f  files), a builder script</li>
52                         <li><b>interface</b>: interface programs, a builder</li>
53                         <li><b>man</b>: all .xml files, the builder and loader scripts</li>
54                         <li><b>doc</b>: .html, .pdf, .txt, .jpeg, ...</li>
55                         <li><b>tests</b>: scripts to test your toolbox</li>
56                         <li><b>demos</b>: different examples to illustrate your toolbox</li>
57                 </ul>
58                 
59                 and 3 files:
60                 
61                 <ul style="list-style-type: disc">
62                         <li><b>README</b>: toolbox description and installation</li>
63                         <li><b>builder.sce</b></li>
64                         <li><b>loader.sce</b></li>
65                 </ul>
66                 
67                 <a name="chap2"></a>
68                 <h2>2. Sub-builders and sub-loaders</h2>
69                         <p>
70                                 The main builder and main loader scripts launch respectively the sub-builders and sub-loaders included in the sub-directories (macros, src, man, ...), to generate and to load the necessary libraries and the Scilab help files.
71                         </p>
72                 
73                 <a name="#chap2.1"></a>
74                 <h3>2.1 The macros directoy</h3>
75                 <p>
76                         The main builder and main loader scripts launche respectively the sub-builders and sub-loaders included in the sub-directories (macros, man, ...), to generate and to load the necessary libraries and the Scilab help files.
77                         This directory included macros Scilab functions, a builder and a loader script.<br />
78                         A  macros is a function written in Scilab code (included in .sci file)<br />
79                         We consider that the macros directory of the toolbox <b>toolbox_example</b> contains just one .sci file: the function <var><strong>foo1</strong></var> (see above script). Given a matrix A, this function returns the positive components of the A diagonal.
80                 </p>
81                 foo1.sci<br />
82                 
83                 <pre class="entete">
84 function [X]=foo1(A)
85         // This function returns the positive components of the A diagonal
86         
87         // Check the type and the size of A
88         if  type(A)<>1 then
89                 error("type of input argument must be a double");
90         end
91         if  size(A,1)<>size(A,2) then
92                 error("input argument must be a square matrix");
93         end
94         //Extraction of the positive components
95         X=[];
96         for i=1:size(A,1)
97                 if A(i,i)>0 then
98                         X($+1)=A(i,i);
99                 end
100         end
101 endfunction</pre>
102                 
103                 <a name="chap2.1.1"></a>
104                 <h4>2.1.1 Creation of the builder</h4>
105                 <p>
106                         The builder (see above script) creates a library variable, (named here: toolbox_examplelib= toolbox name +'lib')
107                         from functions .sci  include in the directory macros, and saves it in the file lib.
108                         The builder code is generic, it's done in 2 steps, the first to locate macrosbuilder.sce script 
109                         (see help <var><strong>get_absolute_file_path</strong></var> function), and the second to generate the library
110                         (see help <strong><var>genlib</strong></var> function). 
111                 </p>
112                 builder.sce
113                 <pre class="entete">
114 mode(-1)
115 toolboxname='toolbox_example'
116 pathB=get_absolute_file_path('builder.sce')
117 disp('Building macros  in ' +pathB)
118 genlib(toolboxname+'lib',pathB,%t)
119 clear pathB genlib toolboxname</pre>    
120                 
121                 <br />
122                 To customize this template, replace the characters string 'toolbox_example' by the name of your toolbox.
123                 
124                 <a name="chap2.1.2"></a>
125                 <h4>2.1.2 Creation of the loader</h4>
126                 <p>
127                         The loader (see above script) loads the library lib included in the directory macros. Like the builder, the code is generic, the first step to locate macrosloader.sce script, and the second to load the library (see help <strong><var>load</strong></var> function)
128                 </p>
129                 
130                 loader.sce
131                 <pre class="entete">
132 mode(-1)
133 pathL=get_absolute_file_path('loader.sce')
134 disp('Loading macros  in ' +pathL)
135 load(pathL+'/lib')
136 clear pathL</pre>       
137                 
138                 <a name="chap2.2"></a>
139                 <h3>2.2 The src directory</h3>
140                 <p>
141                         This directory included .c files and a builder script<br />
142                         A Scilab primitive is a Scilab function which calls a function written in C or fortran code (using an interface program)<br />
143                         Before to write the builder, its necessary to create for each primitives the corresponding interface programs. When a Scilab primitive is called, the interface program checks that the number, the type and the size of  inputs/outputs arguments is correct (using CheckRhs and CheckLhs functions), and get the adress of the rhs arguments which are in Scilab internal stack to give this information at the interfaced function. So in the first part we explain, thanks to template, how to implement some interfaces programs (written in C code). In this article we don't describe all the possibilities of the interface programs, for more explanations see the directory SCI/examples.  
144                 </p>
145                 
146                 <a name="chap2.2.1"></a>
147                 <h4>2.2.1 Interface</h4>
148                 <p>
149                         Here two examples which enable to write many interfaces, so it's important to understand it, and know how to customize it for your toolbox. 
150                 </p>
151                 
152                 <p>
153                         <EM>Example a</EM>: <br />             
154                         We consider an C routine sumab which returns the sum of  two vectors. I suppose that the name of the corresponding primitive is 
155                         <var><strong>scisum</strong></var>. We can keep the same name that the C routine (sumab) or try an other name.<br />
156                         The both following scripts represent the C code of <var><strong>sumab</strong></var> and its associated interface program when 
157                         we call the primitive <var><strong>scisum </strong></var>in a Scilab window as follows:<br />
158                         <var><strong>--> Y=scisum(A,B )</strong></var> <br /><br />
159                 </p>
160                 
161                 sumab.c 
162                 <pre class="entete">
163 void sumab(int n, double * a, double * b, double * y)
164 {
165         int k;
166         for (k = 0; k < n; ++k) 
167         y[k] = a[k] + b[k];
168 }</pre> 
169                         
170                 <br />
171                 intsumab.c<br />
172                 <pre class="entete">
173 #include "stack-c.h"
174 extern int sumab(int n, double * a, double * b, double * y); 
175
176 void intsumab(char *fname){  
177 int l1, m1, n1, l2, m2, n2, l3, n;   
178                 
179 /* 1 - Check the nuumber of input/output arguments  */  
180 int minlhs=1, maxlhs=1, minrhs=2, maxrhs=2; 
181 CheckRhs(minrhs,maxrhs) ; 
182 CheckLhs(minlhs,maxlhs) ; 
183
184 /* 2 - Check input arguments type and get input arguments adress in the Scilab stack */  
185 GetRhsVar(1, "d", &m1, &n1, &l1);
186 GetRhsVar(2, "d", &m2, &n2, &l2);
187                 
188 /* 3 - Check that the input arguments have the same size */
189 n=m2*n2; 
190 if( n1!=n2 || m1!=m2) 
191 {
192         cerro("input arguments must have the same size"); 
193         return 0; 
194 }       
195 if(n1!=0 && m1!=0)    
196         if(n1!=1 && m1!=1)   
197         {
198                 cerro("input arguments must be vectors");    
199                 return(0); 
200         }
201                 
202 /* it's possible to use the chekdims and getscalar functions: a completer ................*/  
203                 
204 /* 4 - Create the output argument */ 
205 CreateVar(3,"d",&m2,&n2,&l3);   
206 sumab(n,stk(l1),stk(l2),stk(l3));  
207                 
208 /* 5 - Specif the ouput argument */  
209 LhsVar(1) = 3;  
210 return 0;
211 }</pre>             
212                 
213                 <br />
214                 <p>
215                         <EM>In Step 1</EM>: call the instructions <var><strong>CheckRhsVar(minrhs,maxrhs)</strong></var> and <var><strong>
216                         CheckLhsVar(minlhs,maxlhs)</strong></var><br />
217                         <var><strong>CheckRhsVar</strong></var> function uses the arguments <strong><var>minrhs</strong></var> 
218                         and <var><strong>maxrhs</strong></var> to check that:<br />
219                         <var><strong>minrhs <= number of  input arguments <= maxrhs</strong></var><br />
220                         In this example the numbers of input (=2) and output (=1) arguments are constant, but for certains functions (see example2)
221                         they can be variable, in this case the variables <var><strong>minrhs/minlhs</strong></var> and <var><strong>maxrhs/maxlhs</strong>
222                         </var> are different.<br /> We can use directly the defined variables <var><strong>Rhs</strong></var>(=number of inputs) and 
223                         <var><strong>Lhs</strong></var>(=number of outputs) instead of the functions <var><strong>CheckRhsVar</strong></var>  and  
224                         </var><strong>CheckLhsVar</strong></var>.<br />
225                         
226                         <br />
227                         
228                         <EM>In Step 2</EM>:  call the instruction <b><i>GetRhsVar(1,"d",&m1,&n1,&l1)</b></i><br />
229                         <b><i>GetRhsVar</b></i> function checks that the type of inputs argument is correct, and gets their size and their adress in the Scilab stack.<br />
230                         We describe above all arguments of <b><i>GetRhsVar</b></i> function:<br />
231                         <b><i>1</b></i> : corresponds to the position of the first input argument of scisum(A,B ), i.e A, (2 corresponds to B,...)<br />
232                         <b><i>m1 </b></i>: gets the rows number of A (m2 for B)<br />
233                         <b><i>n1 </b></i>: gets the columns number of  A (n2 for B)<br />
234                         <b><i>l1 </b></i>: gets the adress of A in the Scilab stack (l2 for B)<br />
235                         
236                         <br />
237                         
238                         <EM>In Step 3</EM>: instruction <b><i>CreateVar(3,"d",&m2,&n2,&l3)</b></i><br />
239                         <b><i>CreateVar</b></i>  function creates the ouput argument (here Y) at the 3th position<br />
240                         <b><i>3 </b></i>: corresponds to the position of the first output argument Y. We should take the number which follows 
241                         immediatly the last position of  the input arguments (which is 2)<br />
242                         <b><i>"d"</b></i>: sets the type of the output argument, a double <br />
243                         <b><i>m2</b></i>: sets the rows number of the output argument (here equal to the rows number of the second input argument B: m2)<br />
244                         <b><i>n2</b></i>: sets the columns number of the first output argument (here equal to the columns number of the second input argument B: n2)<br />
245                         <b><i>l3</b></i>: gets the adress of the lhs in the Scilab stack <br />
246                         
247                         <br />
248                         
249                         <EM>In Step 4</EM>: instruction <b><i>LhsVar(1) = 3</b></i><br />
250                         The instruction <b><i>LhsVar(1) = 3</b></i> means the first output argument take the value of the variable placed in the 3th position (i.e Y)<br />
251                         
252                         <br />
253                         <br />
254                         
255                         <EM>Example b</EM>:<br />
256                                 In the second example we describe the interface program (see above script) of the primitive </b></i>scifun1</b></i> which uses the C functions <b><i>fun1</b></i> and <b><i>fun2</b></i> (see above script). This primitive have two syntaxes:<br />
257                         
258                         <br />
259                         the first syntax is:</b></i><br />
260                         <b><i>--> [X, Y ]=scifun1(A);</b></i><br />
261                         Given a vector <b><i>A</b></i>, this function returns the positive components of <b><i>A</b></i> in a vector <b><i>X</b></i> and the sum of its positive components in a scalar <b><i>Y</b></i>. In this case the number of output arguments (=Lhs) is 2.<br />
262                         
263                         <br />
264                         the second syntax is:<br />
265                         <b><i>--> [X ]=scifun1(A);</b></i><br />
266                         Given a vector <b><i>A</b></i>, this function returns the positive components of <b><i>A</b></i> in a vector <b><i>X</b></i>. In this case <b><i>Lhs=1</b></i>.<br />
267                 </p>
268                 
269                 <br />
270                 fun1.c 
271                 <pre class="entete">
272 extern void  fun2(double *, int, int *);
273
274 void fun1(double * a,  int na, int * nb,  double ** b , double * positive_sum){
275         int i, k1=0;
276         *positive_sum=0;
277         fun2(a, na, nb);
278         *b=(double *)malloc((*nb)*sizeof(double));
279         *positive_sum=0;
280         for(i=0;i<na;i++)
281         if(a[i]>0) {
282                 *(*b+k1)=a[i];
283                 *positive_sum += a[i];
284                 k1++;
285         };
286 }</pre> 
287                 
288                 <br />
289                 
290                 fun2.c
291                 <pre class="entete">
292 void  fun2(double * a, int na, int * m)
293 {
294         int i;
295         *m=0;
296         for(i=0;i<na;i++)
297         if (a[i]>0)  
298                 (*m)++;
299 }</pre> 
300                 
301                 <br />
302                 
303                 intfun1.c
304                 <pre class="entete">
305 #include "stack-c.h"
306
307 extern void fun1(double * ,  int, int *, double **, double *);
308
309 int intfun1(char *fname)
310 {
311         int l1, m1, n1, m=1, nX, i, l2, l3;
312         double * X, S;
313
314         /* 1 - Check the number of inputs and outputs arguments */
315         /* You can use the variables: Lhs and Rhs */
316         int minlhs=1, maxlhs=2, minrhs=1, maxrhs=1;
317         CheckRhs(minrhs,maxrhs) ;
318         CheckLhs(minlhs,maxlhs) ;
319
320         /* 2 - Check rhs type, get the rows number (m1) and the columns number (n1) of rhs, and its adress (l1) in the Scilab stack */
321         GetRhsVar(1, "d", &m1, &n1, &l1); 
322
323         /* 3 - Check rhs is a vector */
324         if(m1!=0 && n1!=0 )
325         {
326                 if(m1!=1 && n1!=1)
327                 {
328                         cerro("input argument must be a vector");
329                         return(0);
330                 }
331         }
332
333         fun1(stk(l1), n1*m1, &nX, &X, &S);
334
335         /* 4 - Create the place for the first output X ( a vector of doubles, size: m*n ) to the adress l2 in the Scilab stack */
336         CreateVar(2, "d", &m, &nX, &l2);
337
338         /* if there are two outputs variable then: Create the place for the second output S ( a double, size 1*1) to the adress l3 in the Scilab stack */ 
339         /* get the value of S, and put it in the Scilab stack */
340         if(Lhs==2)
341         {
342                 CreateVar(3, "d", &m, &m, &l3);
343                 *stk(l3)=S;
344         }
345
346         /* get the components of  X, and put them in the Scilab stack */
347         for(i=0;i&gt;nX;i++) 
348                 stk(l2)[i]=X[i];
349
350         /* free memory */
351         free(X);
352
353         /* 5 - Specification of outputs variables */
354         LhsVar(1) = 2;
355         if(Lhs==2)
356                 LhsVar(2) = 3;
357         return 0;
358 }</pre> 
359                 
360                 <br />
361                 
362                 <a name="chap2.2.2"></a>
363                 <h4>2.2.2 Creation of the builder</h4>
364                 <p>
365                         Now the src directory of the toolbox toolbox_example contains all the necessary files (<b><i>fun1.c</b></i>,
366                         <b><i>fun2.c</b></i>, <b><i>intfun1.c</b></i>, <b><i>sumab.c</b></i>, <b><i>intsumab.c</b></i>) to create the 
367                          builder (see above template) for the primitives scifun1 and scisum.
368                         <br />
369                         We need to write two builders: one the hand, the src builder (see above script) which creates a shared libraries (see help <i><b>ilib_for_link</b></i> function) corresponding to the .c functions. 
370                         And the other hand, the interface builder (see above script) which creates new shared libraries to link the compiled C or Fortran 
371                         new Scilab interface routines (thanks to src libraries), and generates a loader (see help <i><b>ilib_build</b></i> function). 
372                         This loader file calls the addinter function to dynamically load the shared library (see help <i><b>addinter</b></i> function)
373                 </p>
374                 
375                 the src builder
376                 <pre class="entete">
377 ilib_for_link('toolboxsrc',['fun1.o' 'fun2.o','sumab.o'],[],"c")</pre>  
378                 
379                 <br />
380                 the interface builder<br />
381                 
382                 <pre class="entete">
383 // must be run from this directory
384 ilib_name  = 'libtoolbox_example'     // interface library name
385 files = ['intfun1.o', 'intsumab.o'];  // objects files
386 libs  = ["../src/libtooloxsrc"]                 // other libs needed for linking
387 table = [ 'scifun1', 'intfun1';
388         'scisum','intsumab'];        // table of (scilab_name,interface-name)
389 // do not modify below
390 ilib_build(ilib_name,table,files,libs)</pre>    
391                 
392                 <br />  
393                 <br />
394                 
395                 <a name="chap2.2.2"></a>
396                 <h4>2.2.2 Creation of the builder</h4>
397                 <p>Now the src directory of the toolbox toolbox_example contains all the necessary files (<b><i>fun1.c</b></i>, <b><i>fun2.c</b></i>, <b><i>intfun1.c</b></i>, <b><i>sumab.c</b></i>, <b><i>intsumab.c</b></i>) to create the builder (see above template) for the primitives scifun1 and scisum.
398                 <br />
399                 We need to write two builders: one the hand, the src builder (see above script) which creates a shared libraries (see help <i><b>ilib_for_link</b></i> function) corresponding to the .c functions. 
400                 And the other hand, the interface builder (see above script) which creates new shared libraries to link the compiled C or Fortran 
401                 new Scilab interface routines (thanks to src libraries), and generates a loader (see help <i><b>ilib_build</b></i> function). 
402                 This loader file calls the addinter function to dynamically load the shared library (see help <i><b>addinter</b></i> function)</p>
403                 
404                 the src builder
405                 <pre class="entete">
406 ilib_for_link('toolbox_examplesrc',['fun1.o' 'fun2.o','sumab.o'],[],"c")</pre>  
407                 
408                 <br />
409                 the interface builder<br />
410                 
411                 <pre class="entete">
412 // must be run from this directory
413 ilib_name  = 'libtoolbox_example'     // interface library name
414 files = ['intfun1.o', 'intsumab.o'];  // objects files
415 libs  = ["../src/libtoolbox_examplesrc"]                 // other libs needed for linking
416 table = [ 'scifun1', 'intfun1';
417         'scisum','intsumab'];        // table of (scilab_name,interface-name)
418 // do not modify below
419 ilib_build(ilib_name,table,files,libs)</pre>    
420                 
421                 <br />
422                 The <i><b>ilib_name</b></i> value is the interface library name, the vector <i><b>files</b></i> contains all the object interface files,  
423                 the vector <i><b>libs</b></i> contains the libraries needed for linking (here the library included in the src directory), 
424                 the variable <i><b>table</b></i> contains the primitives names (first column) and the corresponding interface program names (second column)
425                 
426                 <a name="chap2.3"></a>
427                 <h3>2.3 The  man directory</h3>
428                 <p>This directory included .xml files, a manbuilder and a manloader scripts
429                                 On Unix/Linux systems: to create the manual pages you need 'sabcmd', an XML parser which is part of the Sablotron package.<br /> 
430                                 (here link to download it:<A href="http://www.scilab.org/download/index_download.php?page=related_tool.html">  http://www.scilab.org/download/index_download.php?page=related_tool.html</A>)<br />
431                                 (.................... a completer  ............................)
432                 </p>
433                 
434                 <a name="chap2.3.1"></a>
435                 <h4>2.3.1 Creation of .xml files</h4>
436                 <p> 
437                 Here a template which helps you to write the .xml help files. You should just fill the different items(Langage, title, type, date, short description, ...) for the .xml files of your functions (here <b><i>foo1.xml</i></b>, <b><i>scifun1.xml</i></b>, <b><i>scisum.xml</i></b>) and put them in the man directory.
438                 </p>
439                 
440                 <pre class="entete">
441 &lt;?xml version=&quot;1.0&quot; encoding=&quot;ISO-8859-1&quot; standalone=&quot;no&quot;?&gt;
442 &lt;!DOCTYPE MAN SYSTEM &quot;/home/scilab/scilab-3.0/man/manrev.dtd&quot;&gt;
443 &lt;MAN&gt;
444 &lt;LANGUAGE&gt;eng&lt;/LANGUAGE&gt;
445 &lt;TITLE&gt;scifoo2&lt;/TITLE&gt;
446 &lt;TYPE&gt;Scilab Function  &lt;/TYPE&gt;
447 &lt;DATE&gt;20-Mar-2006&lt;/DATE&gt;
448 &lt;SHORT_DESCRIPTION name=&quot;add function name&quot;&gt;  add short decription here&lt;/SHORT_DESCRIPTION&gt;
449
450 &lt;CALLING_SEQUENCE&gt;
451 &lt;CALLING_SEQUENCE_ITEM&gt;add function syntax&lt;/CALLING_SEQUENCE_ITEM&gt;
452 &lt;/CALLING_SEQUENCE&gt;
453
454 &lt;PARAM&gt;
455 &lt;PARAM_INDENT&gt;
456 &lt;PARAM_ITEM&gt;
457 &lt;PARAM_NAME&gt;add param name&lt;/PARAM_NAME&gt;
458 &lt;PARAM_DESCRIPTION&gt;
459 &lt;SP&gt;
460 : add here the parameter description
461 &lt;/SP&gt;
462 &lt;/PARAM_DESCRIPTION&gt;
463
464 &lt;PARAM_ITEM&gt;
465 &lt;PARAM_NAME&gt;add param name&lt;/PARAM_NAME&gt;
466 &lt;PARAM_DESCRIPTION&gt;
467 &lt;SP&gt;
468 : add here the parameter description
469 &lt;/SP&gt;
470 &lt;/PARAM_DESCRIPTION&gt;
471 &lt;/PARAM_ITEM&gt;
472 &lt;/PARAM_INDENT&gt;
473 &lt;/PARAM&gt;
474
475 &lt;DESCRIPTION&gt;
476 &lt;DESCRIPTION_INDENT&gt;
477 &lt;DESCRIPTION_ITEM&gt;
478 &lt;P&gt;
479 Add here a paragraph of the function description. 
480 Other paragraph can be added 
481 &lt;/P&gt;
482 &lt;/DESCRIPTION_ITEM&gt;
483 &lt;DESCRIPTION_ITEM&gt;
484 &lt;P&gt;
485 Add here a paragraph of the function description 
486 &lt;/P&gt;
487 &lt;/DESCRIPTION_ITEM&gt;
488 &lt;/DESCRIPTION_INDENT&gt;
489 &lt;/DESCRIPTION&gt;
490
491 &lt;EXAMPLE&gt;&lt;![CDATA[
492 Add here scilab instructions and comments
493 ]]&gt;&lt;/EXAMPLE&gt;
494
495 &lt;SEE_ALSO&gt;
496 &lt;SEE_ALSO_ITEM&gt; &lt;LINK&gt; add a key here&lt;/LINK&gt; &lt;/SEE_ALSO_ITEM&gt;
497 &lt;SEE_ALSO_ITEM&gt; &lt;LINK&gt; add a key here&lt;/LINK&gt; &lt;/SEE_ALSO_ITEM&gt;
498 &lt;/SEE_ALSO&gt;
499
500 &lt;BIBLIO&gt;
501 Add here the function bibliography if any
502 &lt;/BIBLIO&gt;
503
504 &lt;AUTHORS&gt;
505 &lt;AUTHORS_ITEM label='enter here the author name'&gt;
506 Add here the author  references
507 &lt;/AUTHORS_ITEM&gt;
508 &lt;/AUTHORS&gt;
509 &lt;USED_FUNCTIONS&gt;
510 Add here the used function name and  references
511 &lt;/USED_FUNCTIONS&gt;
512 &lt;/MAN&gt;</pre>      
513                 
514                 <a name="chap2.3.2"></a>
515                 <h4>2.3.2 Creation of the builder</h4>
516                 <p>The manbuilder (see above) creates a whatis.htm file which is a short description of the functions, and translates the xml files to html (see help xmltohtml function)
517                 </p>
518                 
519                 <br />
520                 
521                 builder.sce
522                 <pre class="entete">
523 mode(-1) //force silent execution
524 path=get_absolute_file_path('builder.sce');//get the absolute path of this file
525 add_help_chapter("Title1",path);//add help chapter
526 xmltohtml(path,"Title1")
527 //clear the variable stack
528 clear path add_help_chapter get_absolute_file_path </pre>       
529                 
530                 <a name="chap2.3.3"></a>
531                 <h4>2.3.3 Creation of the loader</h4>
532                 <p>The loader(see above script) add your help functions files in the help Scilab browser 
533                 </p>
534                 
535                 loader.sce
536                 <pre class="entete">
537 mode(-1) //force silent execution
538 path=get_absolute_file_path('loader.sce');//get the absolute path of this file
539 add_help_chapter("Title1",path);//add help chapter
540 clear path add_help_chapter get_absolute_file_</pre>    
541                 
542                 <a name="chap3"></a>
543                 <h2>3. The main builder and loader</h2>
544                 The builder and loader are generic, they execute all sub-builder(s) and sub-loader(s), here the both scripts:<br /><br />
545                 
546                 builder.sce
547                 <pre class="entete">
548 mode(-1);
549 mainpathB=get_absolute_file_path('builder.sce');
550 chdir(mainpathB);
551 if isdir('src') then
552 chdir('src');
553 exec('builder.sce');
554 chdir('..');
555 end
556 if isdir('interface') then
557 chdir('interface');
558 exec('builder.sce');
559 chdir('..');
560 end
561 if isdir('macros') then
562 chdir('macros');
563 exec('builder.sce');
564 chdir('..');
565 end
566 if isdir('man') then
567 chdir('man');
568 exec('builder.sce');
569 chdir('..');
570 end
571 clear mainpathB</pre>   
572                 
573                 <br />
574                 
575                 loader.sce
576                 <pre class="entete">
577 mode(-1);
578 mainpathL=get_absolute_file_path('loader.sce');
579 chdir(mainpathL);
580 if isdir('interface') then
581 chdir('interface');
582 exec('loader.sce');
583 chdir('..');
584 end
585 if isdir('macros') then
586 chdir('macros');
587 exec('loader.sce');
588 chdir('..');
589 end
590 if isdir('man') then
591 chdir('man');
592 exec('loader.sce');
593 chdir('..');
594 end
595 clear mainpathL</pre>   
596
597                 <a name="chap4"></a>
598                 <h2>4. Upload your toolbox</h2>
599                 <ul style="list-style-type: disc">
600                         <li>Read the instructions about how to contribute , see the link: 
601                                 <A href="http://www.scilab.org/contrib/index_contrib.php?page=howto.html">http://www.scilab.org/contrib/index_contrib.php?page=howto.html </A></li>
602                                 <li>Archive and Compress your toolbox: </li>
603                                 <li>Complete the submission form document and add your package (here <b>toolbox_example.tar.gz</b> and <b>toolbox_example.zip</b>), 
604                                         see the link: <A href="http://www.scilab.org/contrib/index_contrib.php?page=upload.html">http://www.scilab.fr/contrib/index_contrib.php?page=upload.html </A></li>
605                 </ul>
606         </body>
607 </html>