First import of the toolbox guide
Pierre Marechal [Wed, 19 Apr 2006 13:49:56 +0000 (13:49 +0000)]
21 files changed:
scilab_doc/toolbox_guide/html/toolbox.css [new file with mode: 0644]
scilab_doc/toolbox_guide/html/toolbox.html [new file with mode: 0644]
scilab_doc/toolbox_guide/toolbox_example/README [new file with mode: 0644]
scilab_doc/toolbox_guide/toolbox_example/builder.sce [new file with mode: 0644]
scilab_doc/toolbox_guide/toolbox_example/interface/builder.sce [new file with mode: 0644]
scilab_doc/toolbox_guide/toolbox_example/interface/intfun1.c [new file with mode: 0644]
scilab_doc/toolbox_guide/toolbox_example/interface/intsumab.c [new file with mode: 0644]
scilab_doc/toolbox_guide/toolbox_example/loader.sce [new file with mode: 0644]
scilab_doc/toolbox_guide/toolbox_example/macros/builder.sce [new file with mode: 0644]
scilab_doc/toolbox_guide/toolbox_example/macros/foo1.sci [new file with mode: 0644]
scilab_doc/toolbox_guide/toolbox_example/macros/loader.sce [new file with mode: 0644]
scilab_doc/toolbox_guide/toolbox_example/man/builder.sce [new file with mode: 0644]
scilab_doc/toolbox_guide/toolbox_example/man/foo1.xml [new file with mode: 0644]
scilab_doc/toolbox_guide/toolbox_example/man/loader.sce [new file with mode: 0644]
scilab_doc/toolbox_guide/toolbox_example/man/scifoo2.xml [new file with mode: 0644]
scilab_doc/toolbox_guide/toolbox_example/man/scisum.xml [new file with mode: 0644]
scilab_doc/toolbox_guide/toolbox_example/src/builder.sce [new file with mode: 0644]
scilab_doc/toolbox_guide/toolbox_example/src/fun1.c [new file with mode: 0644]
scilab_doc/toolbox_guide/toolbox_example/src/fun2.c [new file with mode: 0644]
scilab_doc/toolbox_guide/toolbox_example/src/sumab.c [new file with mode: 0644]
scilab_doc/toolbox_guide/toolbox_example/tests/tests.sce [new file with mode: 0644]

diff --git a/scilab_doc/toolbox_guide/html/toolbox.css b/scilab_doc/toolbox_guide/html/toolbox.css
new file mode 100644 (file)
index 0000000..1651fc0
--- /dev/null
@@ -0,0 +1,7 @@
+<style type="text/css">
+var {font-style:italic;}
+table.entete {background-color:"#CCCCCC";
+                         border:thin solid black;}
+.souligne {text-decoration:underline;}
+P EM {text-decoration:underline;}
+</style>
\ No newline at end of file
diff --git a/scilab_doc/toolbox_guide/html/toolbox.html b/scilab_doc/toolbox_guide/html/toolbox.html
new file mode 100644 (file)
index 0000000..e4d9869
--- /dev/null
@@ -0,0 +1,717 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+
+<title>toolbox_example</title>
+<LINK rel=STYLESHEET href="toolbox.css" type="text/css">
+</head>
+
+<body>
+
+<h1 center>Guide for the toolboxes contribution (general application)</h1>
+<p>This article describes a standart method to create a Scilab toolbox.<br>
+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>
+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>
+For this article the reference toolbox name is <b>toolbox_example</b>.
+(The above standarisation is not mandatory) </p>
+
+<a href="#chap1">1. Toolbox composition</a><br><br>
+
+<a href="#chap2">2. Sub-builders and sub-loaders</a><br>
+<ul>
+<li><a href="#chap2.1">2.1 The macros directory</a><br></li>
+<ul>
+<li><a href="#chap2.1.1">2.1.1 Creation of the builder</a><br></li>
+<li><a href="#chap2.1.2">2.1.2 Creation of the loader</a><br></li>
+</ul>
+<li><a href="#chap2.2">2.2 The src directory</a><br></li>
+<ul>
+<li><a href="#chap2.2.1">2.2.1 Interface</a><br></li>
+<li><a href="#chap2.2.2">2.2.2 Creation of the builder</a><br></li>
+</ul>
+<li><a href="#chap2.3">2.3 The man directory</a><br>
+<ul>
+<li><a href="#chap2.3.1">2.3.1 Creation of .xml files</a><br></li>
+<li><a href="#chap2.3.2">2.3.2 Creation of the builder</a><br></li>
+<li><a href="#chap2.3.3">2.3.3 Creation of the loader</a><br><br></li>
+</ul>
+</ul>
+<a href="#chap3">3. The main builder and loader</a><br><br>
+<a href="#chap4">4. Upload your toolbox</a><br>
+
+
+<a name="#chap1"></a>
+<h2 class=souligne>1. Toolbox composition</h2>
+<p>The root directory has the generic name of the toolbox (here <b>toolbox_example</b>), it contains 7 sub-directories:</p> 
+
+<ul style="list-style-type: disc">
+<li><b>macros</b>: Scilab macros (all .sci files),the builder and loader scripts</li>
+<li><b>src</b>: code source (all .c and .f  files), a builder script</li>
+<li><b>interface</b>: interface programs, a builder</li>
+<li><b>man</b>: all .xml files, the builder and loader scripts</li>
+<li><b>doc</b>: .html, .pdf, .txt, .jpeg, ...</li>
+<li><b>tests</b>: scripts to test your toolbox</li>
+<li><b>demos</b>: different examples to illustrate your toolbox</li>
+</ul>
+and 3 files:
+<ul style="list-style-type: disc">
+<li><b>README</b>: toolbox description and installation</li>
+<li><b>builder.sce</b></li>
+<li><b>loader.sce</b></li>
+</ul>
+
+<a name="#chap2"></a>
+<h2 class=souligne>2. Sub-builders and sub-loaders</h2>
+<p>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.
+</p>
+
+<a name="#chap2.1"></a>
+<h3 class=souligne>2.1 The macros directoy</h3>
+<p>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.
+This directory included macros Scilab functions, a builder and a loader script.<br>
+A  macros is a function written in Scilab code (included in .sci file)<br>
+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.
+</p>
+foo1.sci<br />
+
+<table class=entete>
+       <tr>
+               <td>
+<pre>          
+function [X]=foo1(A)
+// This function returns the positive components of the A diagonal
+
+// Check the type and the size of A
+if  type(A)<>1 then
+    error("type of input argument must be a double");
+end
+if  size(A,1)<>size(A,2) then
+    error("input argument must be a square matrix");
+end
+//Extraction of the positive components
+X=[];
+for i=1:size(A,1)
+  if  A(i,i)>0 then
+    X($+1)=A(i,i);
+  end
+end
+endfunction
+</pre>
+               </td>
+       </tr>
+</table>
+
+
+<a name="#chap2.1.1"></a>
+<h4 class=souligne>2.1.1 Creation of the builder</h4>
+<p>The builder (see above script) creates a library variable, (named here: toolbox_examplelib= toolbox name +'lib') from functions .sci  include in the directory macros, and saves it in the file lib. 
+                The builder code is generic, it's done in 2 steps, the first to locate macrosbuilder.sce script (see help <var><strong>get_absolute_file_path</strong></var> function), and the second to generate the library (see help <strong><var>genlib</strong></var> function). 
+
+</p>
+builder.sce
+<table class=entete>
+       <tr>
+               <td>
+<pre>
+mode(-1)
+toolboxname='toolbox_example'
+pathB=get_absolute_file_path('builder.sce')
+disp('Building macros  in ' +pathB)
+genlib(toolboxname+'lib',pathB,%t)
+clear pathB genlib toolboxname
+</pre> 
+               </td>
+       </tr>
+</table>
+
+<br>
+To customize this template, replace the characters string 'toolbox_example' by the name of your toolbox.
+
+<a name="#chap2.1.2"></a>
+<h4 class=souligne>2.1.2 Creation of the loader</h4>
+<p>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)
+</p>
+
+loader.sce
+<table class=entete>
+       <tr>
+               <td>
+<pre>
+mode(-1)
+pathL=get_absolute_file_path('loader.sce')
+disp('Loading macros  in ' +pathL)
+load(pathL+'/lib')
+clear pathL 
+</pre> 
+               </td>
+       </tr>
+</table>
+
+
+<a name="#chap2.2"></a>
+<h3 class=souligne>2.2 The src directory</h3>
+<p>This directory included .c files and a builder script<br>
+A Scilab primitive is a Scilab function which calls a function written in C or fortran code (using an interface program)<br>
+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.  
+</p>
+
+<a name="#chap2.2.1"></a>
+<h4 class=souligne>2.2.1 Interface</h4>
+<p>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. 
+</p>
+
+<p>
+<EM>Example a</EM>: <br>             
+We consider an C routine sumab which returns the sum of  two vectors. I suppose that the name of the corresponding primitive is <var><strong>scisum</strong></var>. We can keep the same name that the C routine (sumab) or try an other name.<br>
+The both following scripts represent the C code of <var><strong>sumab</strong></var> and its associated interface program when we call the primitive <var><strong>scisum </strong></var>in a Scilab window as follows:<br>
+<var><strong>--> Y=scisum(A,B )</strong></var> <br><br>
+
+</p>
+
+sumab.c 
+<table class=entete>
+       <tr>
+               <td>
+<pre>
+void sumab(int n, double * a, double * b, double * y)
+{
+int k;
+for (k = 0; k < n; ++k) 
+    y[k] = a[k] + b[k];
+}
+</pre> 
+               </td>
+       </tr>
+</table>
+
+<br>
+intsumab.c<br>
+<table class=entete>
+       <tr>
+               <td>
+<pre>
+#include "stack-c.h"
+extern int sumab(int n, double * a, double * b, double * y); 
+
+void intsumab(char *fname){  
+       int l1, m1, n1, l2, m2, n2, l3, n;   
+
+/* 1 - Check the nuumber of input/output arguments  */  
+       int minlhs=1, maxlhs=1, minrhs=2, maxrhs=2; 
+       CheckRhs(minrhs,maxrhs) ; 
+       CheckLhs(minlhs,maxlhs) ; 
+
+/* 2 - Check input arguments type and get input arguments adress in the Scilab stack */  
+       GetRhsVar(1, "d", &m1, &n1, &l1);
+       GetRhsVar(2, "d", &m2, &n2, &l2);
+
+/* 3 - Check that the input arguments have the same size */
+       n=m2*n2; 
+       if( n1!=n2 || m1!=m2) 
+       {
+               cerro("input arguments must have the same size"); 
+               return 0; 
+       }       
+       if(n1!=0 && m1!=0)    
+               if(n1!=1 && m1!=1)   
+               {
+               cerro("input arguments must be vectors");    
+               return(0); 
+               }
+
+/* it's possible to use the chekdims and getscalar functions: a completer ................*/  
+
+/* 4 - Create the output argument */ 
+       CreateVar(3,"d",&m2,&n2,&l3);   
+       sumab(n,stk(l1),stk(l2),stk(l3));  
+
+/* 5 - Specif the ouput argument */  
+       LhsVar(1) = 3;  
+       return 0;
+}
+</pre> 
+               </td>
+       </tr>
+</table>               
+
+<br>
+<p>
+<EM>In Step 1</EM>: call the instructions <var><strong>CheckRhsVar(minrhs,maxrhs)</strong></var> and <var><strong>CheckLhsVar(minlhs,maxlhs)</strong></var><br>
+<var><strong>CheckRhsVar</strong></var> function uses the arguments <strong><var>minrhs</strong></var> and <var><strong>maxrhs</strong></var> to check that:<br>
+<var><strong>minrhs <= number of  input arguments <= maxrhs</strong></var><br>
+In this example the numbers of input (=2) and output (=1) arguments are constant, but for certains functions (see example2) they can be variable, in this case the variables <var><strong>minrhs/minlhs</strong></var> and <var><strong>maxrhs/maxlhs</strong></var> are different.<br>
+We can use directly the defined variables <var><strong>Rhs</strong></var>(=number of inputs) and <var><strong>Lhs</strong></var>(=number of outputs) instead of the functions <var><strong>CheckRhsVar</strong></var>  and  </var><strong>CheckLhsVar</strong></var>.<br>
+
+<br>
+
+<EM>In Step 2</EM>:  call the instruction <b><i>GetRhsVar(1,"d",&m1,&n1,&l1)</b></i><br>
+<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>
+We describe above all arguments of <b><i>GetRhsVar</b></i> function:<br>
+<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>
+<b><i>m1 </b></i>: gets the rows number of A (m2 for B)<br>
+<b><i>n1 </b></i>: gets the columns number of  A (n2 for B)<br>
+<b><i>l1 </b></i>: gets the adress of A in the Scilab stack (l2 for B)<br>
+
+<br>
+
+<EM>In Step 3</EM>: instruction <b><i>CreateVar(3,"d",&m2,&n2,&l3)</b></i><br>
+<b><i>CreateVar</b></i>  function creates the ouput argument (here Y) at the 3th position<br>
+<b><i>3 </b></i>: corresponds to the position of the first output argument Y. We should take the number which follows immediatly the last position of  the input arguments (which is 2)<br>
+<b><i>"d"</b></i>: sets the type of the output argument, a double <br>
+<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>
+<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>
+<b><i>l3</b></i>: gets the adress of the lhs in the Scilab stack <br>
+
+<br>
+
+<EM>In Step 4</EM>: instruction <b><i>LhsVar(1) = 3</b></i><br>
+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>
+
+<br>
+<br>
+
+<EM>Example b</EM>:<br>
+        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>
+
+<br>
+the first syntax is:</b></i><br>
+<b><i>--> [X, Y ]=scifun1(A);</b></i><br>
+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>
+
+<br>
+the second syntax is:<br>
+<b><i>--> [X ]=scifun1(A);</b></i><br>
+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>
+</p>
+
+<br>
+fun1.c 
+<table class=entete>
+       <tr>
+               <td>
+<pre>
+extern void  fun2(double *, int, int *);
+
+void fun1(double * a,  int na, int * nb,  double ** b , double * positive_sum){
+       int i, k1=0;
+       *positive_sum=0;
+       fun2(a, na, nb);
+       *b=(double *)malloc((*nb)*sizeof(double));
+       *positive_sum=0;
+       for(i=0;i<na;i++)
+       if(a[i]>0) {
+               *(*b+k1)=a[i];
+               *positive_sum += a[i];
+               k1++;
+       };
+}
+</pre> 
+               </td>
+       </tr>
+</table>
+
+<br>
+
+fun2.c
+<table class=entete>
+       <tr>
+               <td>
+<pre>
+void  fun2(double * a, int na, int * m)
+{
+int i;
+*m=0;
+for(i=0;i<na;i++)
+    if (a[i]>0)  
+      (*m)++;
+}
+</pre> 
+               </td>
+       </tr>
+</table>
+
+<br>
+
+intfun1.c
+<table class=entete>
+       <tr>
+               <td>
+<pre>
+#include "stack-c.h"
+
+extern void fun1(double * ,  int, int *, double **, double *);
+
+int intfun1(char *fname)
+{
+       int l1, m1, n1, m=1, nX, i, l2, l3;
+       double * X, S;
+/* 1 - Check the number of inputs and outputs arguments */
+/* You can use the variables: Lhs and Rhs */
+       int minlhs=1, maxlhs=2, minrhs=1, maxrhs=1;
+       CheckRhs(minrhs,maxrhs) ;
+       CheckLhs(minlhs,maxlhs) ;
+
+/* 2 - Check rhs type, get the rows number (m1) and the columns number (n1) of rhs, and its adress (l1) in the Scilab stack */
+       GetRhsVar(1, "d", &m1, &n1, &l1); 
+
+/* 3 - Check rhs is a vector */
+       if(m1!=0 && n1!=0 )
+       {
+               if(m1!=1 && n1!=1)
+               {
+                       cerro("input argument must be a vector");
+                       return(0);
+               }
+       }
+
+       fun1(stk(l1), n1*m1, &nX, &X, &S);
+  
+/* 4 - Create the place for the first output X ( a vector of doubles, size: m*n ) to the adress l2 in the Scilab stack */
+       CreateVar(2, "d", &m, &nX, &l2);
+  
+/* 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 */ 
+/* get the value of S, and put it in the Scilab stack */
+       if(Lhs==2)
+       {
+               CreateVar(3, "d", &m, &m, &l3);
+               *stk(l3)=S;
+       }
+/* get the components of  X, and put them in the Scilab stack */
+       for(i=0;i&gt;nX;i++) 
+               stk(l2)[i]=X[i];
+  
+/* free memory */
+       free(X);
+  
+/* 5 - Specification of outputs variables */
+       LhsVar(1) = 2;
+       if(Lhs==2)
+               LhsVar(2) = 3;
+       return 0;
+}
+</pre> 
+               </td>
+       </tr>
+</table>
+
+<br>
+
+<a name="#chap2.2.2"></a>
+<h4 class=souligne>2.2.2 Creation of the builder</h4>
+<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.
+<br>
+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. 
+And the other hand, the interface builder (see above script) which creates new shared libraries to link the compiled C or Fortran 
+new Scilab interface routines (thanks to src libraries), and generates a loader (see help <i><b>ilib_build</b></i> function). 
+This loader file calls the addinter function to dynamically load the shared library (see help <i><b>addinter</b></i> function)</p>
+
+the src builder
+<table class=entete>
+       <tr>
+               <td>
+<pre>
+ilib_for_link('toolboxsrc',['fun1.o' 'fun2.o','sumab.o'],[],"c")
+</pre> 
+               </td>
+       </tr>
+</table>
+
+<br>
+the interface builder<br>
+
+<table class=entete>
+       <tr>
+               <td>
+<pre>
+// must be run from this directory
+ilib_name  = 'libtoolbox_example'     // interface library name
+files = ['intfun1.o', 'intsumab.o'];  // objects files
+libs  = ["../src/libtooloxsrc"]                 // other libs needed for linking
+table = [ 'scifun1', 'intfun1';
+               'scisum','intsumab'];        // table of (scilab_name,interface-name)
+// do not modify below
+ilib_build(ilib_name,table,files,libs)
+</pre> 
+               </td>
+       </tr>
+</table>
+
+<br>
+
+               <td>
+       <tr>
+</table>
+
+<br>
+
+<a name="#chap2.2.2"></a>
+<h4 class=souligne>2.2.2 Creation of the builder</h4>
+<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.
+<br>
+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. 
+And the other hand, the interface builder (see above script) which creates new shared libraries to link the compiled C or Fortran 
+new Scilab interface routines (thanks to src libraries), and generates a loader (see help <i><b>ilib_build</b></i> function). 
+This loader file calls the addinter function to dynamically load the shared library (see help <i><b>addinter</b></i> function)</p>
+
+the src builder
+<table class=entete>
+       <tr>
+               <td>
+<pre>
+ilib_for_link('toolbox_examplesrc',['fun1.o' 'fun2.o','sumab.o'],[],"c")
+</pre> 
+               </td>
+       </tr>
+</table>
+
+<br>
+the interface builder<br>
+
+<table class=entete>
+       <tr>
+               <td>
+<pre>
+// must be run from this directory
+ilib_name  = 'libtoolbox_example'     // interface library name
+files = ['intfun1.o', 'intsumab.o'];  // objects files
+libs  = ["../src/libtoolbox_examplesrc"]                 // other libs needed for linking
+table = [ 'scifun1', 'intfun1';
+               'scisum','intsumab'];        // table of (scilab_name,interface-name)
+// do not modify below
+ilib_build(ilib_name,table,files,libs)
+</pre> 
+               </td>
+       </tr>
+</table>
+
+
+
+<br>
+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,  
+the vector <i><b>libs</b></i> contains the libraries needed for linking (here the library included in the src directory), 
+the variable <i><b>table</b></i> contains the primitives names (first column) and the corresponding interface program names (second column)
+
+<a name="#chap2.3"></a>
+<h3 class=souligne>2.3 The  man directory</h3>
+<p>This directory included .xml files, a manbuilder and a manloader scripts
+                On Unix/Linux systems: to create the manual pages you need 'sabcmd', an XML parser which is part of the Sablotron package.<br> 
+                (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>
+                (.................... a completer  ............................)
+</p>
+
+<a name="#chap2.3.1"></a>
+<h4 class=souligne>2.3.1 Creation of .xml files</h4>
+<p> 
+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.
+</p>
+
+<table class=entete>
+       <tr>
+               <td>
+<pre>
+&lt;?xml version=&quot;1.0&quot; encoding=&quot;ISO-8859-1&quot; standalone=&quot;no&quot;?&gt;
+&lt;!DOCTYPE MAN SYSTEM &quot;/home/scilab/scilab-3.0/man/manrev.dtd&quot;&gt;
+&lt;MAN&gt;
+  &lt;LANGUAGE&gt;eng&lt;/LANGUAGE&gt;
+  &lt;TITLE&gt;scifoo2&lt;/TITLE&gt;
+  &lt;TYPE&gt;Scilab Function  &lt;/TYPE&gt;
+  &lt;DATE&gt;20-Mar-2006&lt;/DATE&gt;
+  &lt;SHORT_DESCRIPTION name=&quot;add function name&quot;&gt;  add short decription here&lt;/SHORT_DESCRIPTION&gt;
+
+  &lt;CALLING_SEQUENCE&gt;
+  &lt;CALLING_SEQUENCE_ITEM&gt;add function syntax&lt;/CALLING_SEQUENCE_ITEM&gt;
+  &lt;/CALLING_SEQUENCE&gt;
+
+  &lt;PARAM&gt;
+  &lt;PARAM_INDENT&gt;
+    &lt;PARAM_ITEM&gt;
+    &lt;PARAM_NAME&gt;add param name&lt;/PARAM_NAME&gt;
+    &lt;PARAM_DESCRIPTION&gt;
+       &lt;SP&gt;
+       : add here the parameter description
+       &lt;/SP&gt;
+    &lt;/PARAM_DESCRIPTION&gt;
+    
+    &lt;PARAM_ITEM&gt;
+    &lt;PARAM_NAME&gt;add param name&lt;/PARAM_NAME&gt;
+    &lt;PARAM_DESCRIPTION&gt;
+       &lt;SP&gt;
+       : add here the parameter description
+       &lt;/SP&gt;
+    &lt;/PARAM_DESCRIPTION&gt;
+    &lt;/PARAM_ITEM&gt;
+  &lt;/PARAM_INDENT&gt;
+  &lt;/PARAM&gt;
+  &lt;DESCRIPTION&gt;
+     &lt;DESCRIPTION_INDENT&gt;
+     &lt;DESCRIPTION_ITEM&gt;
+     &lt;P&gt;
+      Add here a paragraph of the function description. 
+      Other paragraph can be added 
+     &lt;/P&gt;
+     &lt;/DESCRIPTION_ITEM&gt;
+     &lt;DESCRIPTION_ITEM&gt;
+     &lt;P&gt;
+      Add here a paragraph of the function description 
+     &lt;/P&gt;
+     &lt;/DESCRIPTION_ITEM&gt;
+     &lt;/DESCRIPTION_INDENT&gt;
+  &lt;/DESCRIPTION&gt;
+
+  &lt;EXAMPLE&gt;&lt;![CDATA[
+   Add here scilab instructions and comments
+  ]]&gt;&lt;/EXAMPLE&gt;
+
+  &lt;SEE_ALSO&gt;
+    &lt;SEE_ALSO_ITEM&gt; &lt;LINK&gt; add a key here&lt;/LINK&gt; &lt;/SEE_ALSO_ITEM&gt;
+    &lt;SEE_ALSO_ITEM&gt; &lt;LINK&gt; add a key here&lt;/LINK&gt; &lt;/SEE_ALSO_ITEM&gt;
+  &lt;/SEE_ALSO&gt;
+
+  &lt;BIBLIO&gt;
+    Add here the function bibliography if any
+  &lt;/BIBLIO&gt;
+
+  &lt;AUTHORS&gt;
+    &lt;AUTHORS_ITEM label='enter here the author name'&gt;
+    Add here the author  references
+    &lt;/AUTHORS_ITEM&gt;
+  &lt;/AUTHORS&gt;
+  &lt;USED_FUNCTIONS&gt;
+     Add here the used function name and  references
+  &lt;/USED_FUNCTIONS&gt;
+&lt;/MAN&gt;
+</pre> 
+               </td>
+       </tr>
+</table>
+
+<a name="#chap2.3.2"></a>
+<h4 class=souligne>2.3.2 Creation of the builder</h4>
+<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)
+</p>
+
+<br>
+
+builder.sce
+<table class=entete>
+       <tr>
+               <td>
+<pre>
+mode(-1) //force silent execution
+path=get_absolute_file_path('builder.sce');//get the absolute path of this file
+add_help_chapter("Title1",path);//add help chapter
+xmltohtml(path,"Title1")
+//clear the variable stack
+clear path add_help_chapter get_absolute_file_path 
+</pre> 
+               </td>
+       </tr>
+</table>
+
+
+<a name="#chap2.3.3"></a>
+<h4 class=souligne>2.3.3 Creation of the loader</h4>
+<p>The loader(see above script) add your help functions files in the help Scilab browser 
+</p>
+
+loader.sce
+<table class=entete>
+       <tr>
+               <td>
+<pre>
+mode(-1) //force silent execution
+path=get_absolute_file_path('loader.sce');//get the absolute path of this file
+add_help_chapter("Title1",path);//add help chapter
+clear path add_help_chapter get_absolute_file_
+</pre> 
+               </td>
+       </tr>
+</table>
+
+<a name="#chap3"></a>
+<h2 class=souligne>3. The main builder and loader</h2>
+The builder and loader are generic, they execute all sub-builder(s) and sub-loader(s), here the both scripts:<br><br>
+
+builder.sce
+<table class=entete>
+       <tr>
+               <td>
+<pre>
+mode(-1);
+mainpathB=get_absolute_file_path('builder.sce');
+chdir(mainpathB);
+if isdir('src') then
+  chdir('src');
+  exec('builder.sce');
+  chdir('..');
+end
+if isdir('interface') then
+  chdir('interface');
+  exec('builder.sce');
+  chdir('..');
+end
+if isdir('macros') then
+  chdir('macros');
+  exec('builder.sce');
+  chdir('..');
+end
+if isdir('man') then
+  chdir('man');
+  exec('builder.sce');
+  chdir('..');
+end
+clear mainpathB
+</pre> 
+               </td>
+       </tr>
+</table>
+
+<br>
+
+loader.sce
+<table class=entete>
+       <tr>
+               <td>
+<pre>
+mode(-1);
+mainpathL=get_absolute_file_path('loader.sce');
+chdir(mainpathL);
+if isdir('interface') then
+  chdir('interface');
+  exec('loader.sce');
+  chdir('..');
+end
+if isdir('macros') then
+  chdir('macros');
+  exec('loader.sce');
+  chdir('..');
+end
+if isdir('man') then
+  chdir('man');
+  exec('loader.sce');
+  chdir('..');
+end
+clear mainpathL
+</pre> 
+               </td>
+       </tr>
+</table>
+
+
+<a name="#chap4"></a>
+<h2 class=souligne>4. Upload your toolbox</h2>
+<ul style="list-style-type: disc">
+<li>Read the instructions about how to contribute , see the link: <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>
+<li>Archive and Compress your toolbox:   </li>
+<li>Complete the submission form document and add your package (here <b>toolbox_example.tar.gz</b> and <b>toolbox_example.zip</b>), 
+see the link: <A href="http://www.scilab.fr/contrib/index_contrib.php?page=upload.html">http://www.scilab.fr/contrib/index_contrib.php?page=upload.html </A>     </li>
+</ul>
+<p>
+
+</body>
+
+</html>
\ No newline at end of file
diff --git a/scilab_doc/toolbox_guide/toolbox_example/README b/scilab_doc/toolbox_guide/toolbox_example/README
new file mode 100644 (file)
index 0000000..1b5d646
--- /dev/null
@@ -0,0 +1,73 @@
+                Guide for the toolboxes contribution
+                ===================================
+
+
+
+Guide (version xxx)
+====================
+
+Information about toolbox_example can be found at 
+http://xxx.xxx//toolbox_example.html
+
+The program has been written by 
+XXXXXXXXX
+
+
+Installation
+============
+To Install this toolbox: (Scilab-4.0)
+
+We Suppose here that <PATH> stands for the path of the directory
+containing this README file.
+
+- On Unix/Linux systems
+     * User
+        Has to execute,once and for all, the following instruction 
+        within Scilab:
+        exec <PATH>/builder.sce 
+        
+        Should execute the following instruction within Scilab:
+        exec <PATH>/loader.sce 
+        before using the toolbox, he  can also put it  in his
+        .scilab startup file for automatic loading.
+
+- On Windows systems
+     * user
+        Has to execute, once and for all, the following instruction 
+        within Scilab:
+        exec <PATH>\builder.sce     
+        
+Should execute the following instruction within Scilab:
+        exec <PATH>\loader.sce
+        before using the toolbox, he  can also put it in his
+        .scilab startup file for automatic loading.
+
+
+Contents
+========
+README                 : this file
+builder.sce            : script to launche the sub-builders
+loader.sce             : script to launche the sub-loaders
+
+src                    : directory of Fortran and C routines
+       builder.sce     : script for building library (compilation and linking)
+       loader.sce      : script for loading library (generated)
+
+macros                 : directory of Scilab functions
+       builder.sce     : script for building library
+       loader.sce      : script for loading library
+       *.sci           : source versions
+       *.bin           : precompiled binary versions (generated)
+       lib             : scilab library binary save (generated)
+
+man                    : directory for help.
+       builder.sce     : translates the xml files to html
+       loader.sce      : add your help functions files in the help Scilab browser   
+       *.xml           : xml help file 
+       *.html          : html help file (generated) 
+       whatis          : short function description (generated) 
+
+demos                  : examples to illustrate your toolbox
+
+tests                  : directory of tests
+       tests.sce       : script to test toolbox_example 
\ No newline at end of file
diff --git a/scilab_doc/toolbox_guide/toolbox_example/builder.sce b/scilab_doc/toolbox_guide/toolbox_example/builder.sce
new file mode 100644 (file)
index 0000000..098c7c7
--- /dev/null
@@ -0,0 +1,24 @@
+mode(-1);
+mainpathB=get_absolute_file_path('builder.sce');
+chdir(mainpathB);
+if isdir('src') then
+  chdir('src');
+  exec('builder.sce');
+  chdir('..');
+end
+if isdir('interface') then
+  chdir('interface');
+  exec('builder.sce');
+  chdir('..');
+end
+if isdir('macros') then
+  chdir('macros');
+  exec('builder.sce');
+  chdir('..');
+end
+if isdir('man') then
+  chdir('man');
+  exec('builder.sce');
+  chdir('..');
+end
+clear mainpathB
\ No newline at end of file
diff --git a/scilab_doc/toolbox_guide/toolbox_example/interface/builder.sce b/scilab_doc/toolbox_guide/toolbox_example/interface/builder.sce
new file mode 100644 (file)
index 0000000..18f6570
--- /dev/null
@@ -0,0 +1,8 @@
+// must be run from this directory
+ilib_name  = 'libtoolbox_example'     // interface library name
+files = ['intfun1.o', 'intsumab.o'];  // objects files
+libs  = ["../src/libtoolboxsrc"]                 // other libs needed for linking
+table = [ 'scifun1', 'intfun1';
+               'scisum','intsumab'];        // table of (scilab_name,interface-name)
+// do not modify below
+ilib_build(ilib_name,table,files,libs)
diff --git a/scilab_doc/toolbox_guide/toolbox_example/interface/intfun1.c b/scilab_doc/toolbox_guide/toolbox_example/interface/intfun1.c
new file mode 100644 (file)
index 0000000..c819308
--- /dev/null
@@ -0,0 +1,56 @@
+#include "stack-c.h"
+
+extern void fun2(double * , int, int *);
+extern void fun1(double * ,  int, int *, double **, double *);
+
+int intfun1(char *fname)
+{
+  int l1, m1, n1, m=1, nX, i, l2, l3;
+  double * X, S;
+  /* 1 - Check the number of inputs and outputs arguments */
+  /* You can use the variables: Lhs and Rhs */
+  int minlhs=1, maxlhs=2, minrhs=1, maxrhs=1;
+  CheckRhs(minrhs,maxrhs) ;
+  CheckLhs(minlhs,maxlhs) ;
+
+  /* 2 - Check rhs type, get the rows number(m1) and the columns number(n1) of rhs, and its adress(l1) in the Scilab stack */
+  GetRhsVar(1, "d", &m1, &n1, &l1);
+  if(m1!=0 && n1!=0 )
+  {
+    if(m1!=1 && n1!=1)
+    {
+      cerro("input argument must be a vector");
+      return(0);
+    }
+  }
+  fun1(stk(l1), n1*m1, &nX, &X, &S);
+  /* 4 - Create the place for the firts output X ( a vector of doubles, size: m*n ) to the adress l2 in the Scilab stack */
+  CreateVar(2, "d", &m, &nX, &l2);
+  /* 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 */
+  /* get the value of S, and put it in the Scilab stack */
+  if(Lhs==2)
+  {
+  CreateVar(3, "d", &m, &m, &l3);
+  *stk(l3)=S;
+ }
+  /* get the components of  X, and put them in the Scilab stack */
+  for(i=0;i<nX;i++)
+  stk(l2)[i]=X[i];
+  /* free memory */
+  free(X);
+  /* 5 - Specification of outputs variables */
+  LhsVar(1) = 2;
+  if(Lhs==2)
+  LhsVar(2) = 3;
+  return 0;
+}
\ No newline at end of file
diff --git a/scilab_doc/toolbox_guide/toolbox_example/interface/intsumab.c b/scilab_doc/toolbox_guide/toolbox_example/interface/intsumab.c
new file mode 100644 (file)
index 0000000..68278a8
--- /dev/null
@@ -0,0 +1,41 @@
+#include "stack-c.h"
+
+extern int sumab(int n, double * a, double * b, double * y); 
+
+void intsumab(char *fname)
+{
+  int l1, m1, n1, l2, m2, n2, l3, n;
+  
+  /* 1 - Check rhs and lhs number  */
+  int minlhs=1, maxlhs=1, minrhs=2, maxrhs=2;
+  CheckRhs(minrhs,maxrhs) ;
+  CheckLhs(minlhs,maxlhs) ;
+
+  /* 2 - Check rhs type and get rhs adress in the Scilab stack */ 
+  GetRhsVar(1, "d", &m1, &n1, &l1);
+  GetRhsVar(2, "d", &m2, &n2, &l2);
+  
+  n=m2*n2;
+  if( n1!=n2 || m1!=m2) 
+    {
+      cerro("input arguments must have the same size");
+      return 0;
+    }  
+  
+  if(n1!=0 && m1!=0)
+    if(n1!=1 && m1!=1)
+    {
+      cerro("input arguments must be vectors");
+      return(0);
+    }
+
+  /* use chekdims and getscalar functions: a completer ................*/ 
+
+  /* 4 - Create the output argument */
+  CreateVar(3,"d",&m2,&n2,&l3); 
+  sumab(n,stk(l1),stk(l2),stk(l3));
+  
+  /* 5 - Specif the ouput argument */
+  LhsVar(1) = 3;
+  return 0;
+}
\ No newline at end of file
diff --git a/scilab_doc/toolbox_guide/toolbox_example/loader.sce b/scilab_doc/toolbox_guide/toolbox_example/loader.sce
new file mode 100644 (file)
index 0000000..0597483
--- /dev/null
@@ -0,0 +1,19 @@
+mode(-1);
+mainpathL=get_absolute_file_path('loader.sce');
+chdir(mainpathL);
+if isdir('interface') then
+  chdir('interface');
+  exec('loader.sce');
+  chdir('..');
+end
+if isdir('macros') then
+  chdir('macros');
+  exec('loader.sce');
+  chdir('..');
+end
+if isdir('man') then
+  chdir('man');
+  exec('loader.sce');
+  chdir('..');
+end
+clear mainpathL
\ No newline at end of file
diff --git a/scilab_doc/toolbox_guide/toolbox_example/macros/builder.sce b/scilab_doc/toolbox_guide/toolbox_example/macros/builder.sce
new file mode 100644 (file)
index 0000000..22e69e5
--- /dev/null
@@ -0,0 +1,6 @@
+mode(-1)
+toolboxname='toolbox_example'
+pathB=get_absolute_file_path('builder.sce')
+disp('Building macros  in ' +pathB)
+genlib(toolboxname+'lib',pathB,%t)
+clear pathB genlib toolboxname
\ No newline at end of file
diff --git a/scilab_doc/toolbox_guide/toolbox_example/macros/foo1.sci b/scilab_doc/toolbox_guide/toolbox_example/macros/foo1.sci
new file mode 100644 (file)
index 0000000..60743b4
--- /dev/null
@@ -0,0 +1,18 @@
+function [X]=foo1(A)
+// This function returns the positive components fo A diagonal
+
+// Check the type and the size of A
+if  type(A)<>1 then
+    error("type of input argument must be a double");
+end
+if  size(A,1)<>size(A,2) then
+    error("input argument must be square matrix");
+end
+//extraction of the positive components
+X=[];
+for i=1:size(A,1)
+  if  A(i,i)>0 then
+    X($+1)=A(i,i);
+  end
+end
+endfunction
diff --git a/scilab_doc/toolbox_guide/toolbox_example/macros/loader.sce b/scilab_doc/toolbox_guide/toolbox_example/macros/loader.sce
new file mode 100644 (file)
index 0000000..db9389d
--- /dev/null
@@ -0,0 +1,5 @@
+mode(-1)
+pathL=get_absolute_file_path('loader.sce')
+disp('Loading macros  in ' +pathL)
+load(pathL+'/lib')
+clear pathL 
\ No newline at end of file
diff --git a/scilab_doc/toolbox_guide/toolbox_example/man/builder.sce b/scilab_doc/toolbox_guide/toolbox_example/man/builder.sce
new file mode 100644 (file)
index 0000000..321eb41
--- /dev/null
@@ -0,0 +1,6 @@
+mode(-1) //force silent execution
+path=get_absolute_file_path('builder.sce');//get the absolute path of this file
+add_help_chapter("Title1",path);//add help chapter
+xmltohtml(path,"Title1")
+//clear the variable stack
+clear path add_help_chapter get_absolute_file_path 
\ No newline at end of file
diff --git a/scilab_doc/toolbox_guide/toolbox_example/man/foo1.xml b/scilab_doc/toolbox_guide/toolbox_example/man/foo1.xml
new file mode 100644 (file)
index 0000000..480b982
--- /dev/null
@@ -0,0 +1,68 @@
+<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
+<!DOCTYPE MAN SYSTEM "/home/scilab/scilab-3.0/man/manrev.dtd">
+<MAN>
+  <LANGUAGE>eng</LANGUAGE>
+  <TITLE>foo1</TITLE>
+  <TYPE>Scilab Function  </TYPE>
+  <DATE>25-Mar-2006</DATE>
+  <SHORT_DESCRIPTION name="foo1">  Returns the positive components of A diagonal</SHORT_DESCRIPTION>
+
+  <CALLING_SEQUENCE>
+  <CALLING_SEQUENCE_ITEM>X = foo1(A)</CALLING_SEQUENCE_ITEM>
+  </CALLING_SEQUENCE>
+
+  <PARAM>
+  <PARAM_INDENT>
+
+    <PARAM_ITEM>
+    <PARAM_NAME>A</PARAM_NAME>
+    <PARAM_DESCRIPTION>
+       <SP>
+       : a square matrix of reals
+       </SP>
+    </PARAM_DESCRIPTION>
+    </PARAM_ITEM>
+
+    <PARAM_ITEM>
+    <PARAM_NAME>X</PARAM_NAME>
+    <PARAM_DESCRIPTION>
+       <SP>
+       : a vector of positive reals
+       </SP>
+    </PARAM_DESCRIPTION>
+    </PARAM_ITEM>
+  </PARAM_INDENT>
+  </PARAM>
+  <DESCRIPTION>
+     <DESCRIPTION_INDENT>
+     <DESCRIPTION_ITEM>
+     <P>
+      This function returns a vector containing the positive components of the A diagonal. A must be a square matrix. 
+      Other paragraph can be added 
+     </P>
+     </DESCRIPTION_ITEM>
+     </DESCRIPTION_INDENT>
+  </DESCRIPTION>
+
+  <EXAMPLE><![CDATA[
+  A=rand(5,5)-1/2;
+  X=foo1(A);
+  ]]></EXAMPLE>
+
+  <SEE_ALSO>
+    <SEE_ALSO_ITEM> <LINK> diag</LINK> </SEE_ALSO_ITEM>
+  </SEE_ALSO>
+
+  <BIBLIO>
+    Add here the function bibliography if any
+  </BIBLIO>
+
+  <AUTHORS>
+    <AUTHORS_ITEM label='F.Belahcene'>
+    </AUTHORS_ITEM>
+  </AUTHORS>
+  <USED_FUNCTIONS>
+     Add here the used function name and  references
+  </USED_FUNCTIONS>
+</MAN>
diff --git a/scilab_doc/toolbox_guide/toolbox_example/man/loader.sce b/scilab_doc/toolbox_guide/toolbox_example/man/loader.sce
new file mode 100644 (file)
index 0000000..8ccc114
--- /dev/null
@@ -0,0 +1,4 @@
+mode(-1) //force silent execution
+path=get_absolute_file_path('loader.sce');//get the absolute path of this file
+add_help_chapter("Title1",path);//add help chapter
+clear path add_help_chapter get_absolute_file_path
\ No newline at end of file
diff --git a/scilab_doc/toolbox_guide/toolbox_example/man/scifoo2.xml b/scilab_doc/toolbox_guide/toolbox_example/man/scifoo2.xml
new file mode 100644 (file)
index 0000000..93a4202
--- /dev/null
@@ -0,0 +1,83 @@
+<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
+<!DOCTYPE MAN SYSTEM "/home/scilab/scilab-3.0/man/manrev.dtd">
+<MAN>
+  <LANGUAGE>eng</LANGUAGE>
+  <TITLE>scifoo2</TITLE>
+  <TYPE>Scilab Function  </TYPE>
+  <DATE>25-Mar-2006</DATE>
+  <SHORT_DESCRIPTION name="scifoo2">  add short decription here</SHORT_DESCRIPTION>
+
+  <CALLING_SEQUENCE>
+  <CALLING_SEQUENCE_ITEM>[x,y] = scifoo2(a)</CALLING_SEQUENCE_ITEM>
+  </CALLING_SEQUENCE>
+
+  <PARAM>
+  <PARAM_INDENT>
+
+    <PARAM_ITEM>
+    <PARAM_NAME>a</PARAM_NAME>
+    <PARAM_DESCRIPTION>
+       <SP>
+       : add here the parameter description
+       </SP>
+    </PARAM_DESCRIPTION>
+    </PARAM_ITEM>
+
+    <PARAM_ITEM>
+    <PARAM_NAME>x</PARAM_NAME>
+    <PARAM_DESCRIPTION>
+       <SP>
+       : add here the parameter description
+       </SP>
+    </PARAM_DESCRIPTION>
+    </PARAM_ITEM>
+
+    <PARAM_ITEM>
+    <PARAM_NAME>y</PARAM_NAME>
+    <PARAM_DESCRIPTION>
+       <SP>
+       : add here the parameter description
+       </SP>
+    </PARAM_DESCRIPTION>
+    </PARAM_ITEM>
+  </PARAM_INDENT>
+  </PARAM>
+  <DESCRIPTION>
+     <DESCRIPTION_INDENT>
+     <DESCRIPTION_ITEM>
+     <P>
+      Add here a paragraph of the function description. 
+      Other paragraph can be added 
+     </P>
+     </DESCRIPTION_ITEM>
+     <DESCRIPTION_ITEM>
+     <P>
+      Add here a paragraph of the function description 
+     </P>
+     </DESCRIPTION_ITEM>
+     </DESCRIPTION_INDENT>
+  </DESCRIPTION>
+
+  <EXAMPLE><![CDATA[
+   Add here scilab instructions and comments
+  ]]></EXAMPLE>
+
+  <SEE_ALSO>
+    <SEE_ALSO_ITEM> <LINK> add a key here</LINK> </SEE_ALSO_ITEM>
+    <SEE_ALSO_ITEM> <LINK> add a key here</LINK> </SEE_ALSO_ITEM>
+  </SEE_ALSO>
+
+  <BIBLIO>
+    Add here the function bibliography if any
+  </BIBLIO>
+
+  <AUTHORS>
+    <AUTHORS_ITEM label='enter here the author name'>
+    Add here the author  references
+    </AUTHORS_ITEM>
+  </AUTHORS>
+  <USED_FUNCTIONS>
+     Add here the used function name and  references
+  </USED_FUNCTIONS>
+</MAN>
diff --git a/scilab_doc/toolbox_guide/toolbox_example/man/scisum.xml b/scilab_doc/toolbox_guide/toolbox_example/man/scisum.xml
new file mode 100644 (file)
index 0000000..b53db11
--- /dev/null
@@ -0,0 +1,83 @@
+<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
+<!DOCTYPE MAN SYSTEM "/home/scilab/scilab-3.0/man/manrev.dtd">
+<MAN>
+  <LANGUAGE>eng</LANGUAGE>
+  <TITLE>scisum</TITLE>
+  <TYPE>Scilab Function  </TYPE>
+  <DATE>25-Mar-2006</DATE>
+  <SHORT_DESCRIPTION name="scisum">  add short decription here</SHORT_DESCRIPTION>
+
+  <CALLING_SEQUENCE>
+  <CALLING_SEQUENCE_ITEM>y = scisum(a,b)</CALLING_SEQUENCE_ITEM>
+  </CALLING_SEQUENCE>
+
+  <PARAM>
+  <PARAM_INDENT>
+
+    <PARAM_ITEM>
+    <PARAM_NAME>a</PARAM_NAME>
+    <PARAM_DESCRIPTION>
+       <SP>
+       : add here the parameter description
+       </SP>
+    </PARAM_DESCRIPTION>
+    </PARAM_ITEM>
+
+    <PARAM_ITEM>
+    <PARAM_NAME>b</PARAM_NAME>
+    <PARAM_DESCRIPTION>
+       <SP>
+       : add here the parameter description
+       </SP>
+    </PARAM_DESCRIPTION>
+    </PARAM_ITEM>
+
+    <PARAM_ITEM>
+    <PARAM_NAME>y</PARAM_NAME>
+    <PARAM_DESCRIPTION>
+       <SP>
+       : add here the parameter description
+       </SP>
+    </PARAM_DESCRIPTION>
+    </PARAM_ITEM>
+  </PARAM_INDENT>
+  </PARAM>
+  <DESCRIPTION>
+     <DESCRIPTION_INDENT>
+     <DESCRIPTION_ITEM>
+     <P>
+      Add here a paragraph of the function description. 
+      Other paragraph can be added 
+     </P>
+     </DESCRIPTION_ITEM>
+     <DESCRIPTION_ITEM>
+     <P>
+      Add here a paragraph of the function description 
+     </P>
+     </DESCRIPTION_ITEM>
+     </DESCRIPTION_INDENT>
+  </DESCRIPTION>
+
+  <EXAMPLE><![CDATA[
+   Add here scilab instructions and comments
+  ]]></EXAMPLE>
+
+  <SEE_ALSO>
+    <SEE_ALSO_ITEM> <LINK> add a key here</LINK> </SEE_ALSO_ITEM>
+    <SEE_ALSO_ITEM> <LINK> add a key here</LINK> </SEE_ALSO_ITEM>
+  </SEE_ALSO>
+
+  <BIBLIO>
+    Add here the function bibliography if any
+  </BIBLIO>
+
+  <AUTHORS>
+    <AUTHORS_ITEM label='enter here the author name'>
+    Add here the author  references
+    </AUTHORS_ITEM>
+  </AUTHORS>
+  <USED_FUNCTIONS>
+     Add here the used function name and  references
+  </USED_FUNCTIONS>
+</MAN>
diff --git a/scilab_doc/toolbox_guide/toolbox_example/src/builder.sce b/scilab_doc/toolbox_guide/toolbox_example/src/builder.sce
new file mode 100644 (file)
index 0000000..66a1a85
--- /dev/null
@@ -0,0 +1 @@
+ilib_for_link('toolboxsrc',['fun1.o' 'fun2.o','sumab.o'],[],"c")
diff --git a/scilab_doc/toolbox_guide/toolbox_example/src/fun1.c b/scilab_doc/toolbox_guide/toolbox_example/src/fun1.c
new file mode 100644 (file)
index 0000000..833a0a9
--- /dev/null
@@ -0,0 +1,17 @@
+void  fun2(double *, int, int *);
+
+void fun1(double * a,  int na, int * nb,  double ** b , double * positive_sum)
+{
+int i, k1=0;
+*positive_sum=0;
+fun2(a, na, nb);
+*b=(double *)malloc((*nb)*sizeof(double));
+*positive_sum=0;
+for(i=0;i<na;i++)
+  if(a[i]>0)
+    {
+    *(*b+k1)=a[i];
+    *positive_sum += a[i];
+    k1++;
+    };
+}
\ No newline at end of file
diff --git a/scilab_doc/toolbox_guide/toolbox_example/src/fun2.c b/scilab_doc/toolbox_guide/toolbox_example/src/fun2.c
new file mode 100644 (file)
index 0000000..fb26887
--- /dev/null
@@ -0,0 +1,8 @@
+void  fun2(double * a, int na, int * m)
+{
+int i;
+*m=0;
+for(i=0;i<na;i++)
+    if (a[i]>0) 
+      (*m)++;
+}
\ No newline at end of file
diff --git a/scilab_doc/toolbox_guide/toolbox_example/src/sumab.c b/scilab_doc/toolbox_guide/toolbox_example/src/sumab.c
new file mode 100644 (file)
index 0000000..994e967
--- /dev/null
@@ -0,0 +1,5 @@
+void sumab(int n, double * a, double * b, double * y)
+{int k;
+for (k = 0; k < n; ++k)
+    y[k] = a[k] + b[k];
+}
\ No newline at end of file
diff --git a/scilab_doc/toolbox_guide/toolbox_example/tests/tests.sce b/scilab_doc/toolbox_guide/toolbox_example/tests/tests.sce
new file mode 100644 (file)
index 0000000..92af3e6
--- /dev/null
@@ -0,0 +1,20 @@
+// Test the macros scilab: foo1
+ B=[1 2 3 4; 5 -6 7 8; 9 10 -11 12 ;-13 14 -15 16]
+ Xtest=[1;16]
+ X=foo1(B)
+ if norm(X-Xtest) > %eps then pause,end
+
+// Test the primitive: scisum
+ a=[1,2,3];b=[4,5,6]
+ c=scisum(a,b)
+ if norm(c-(a+b)) > %eps then pause,end
+
+// Test the primitivre: scifoo
+ A=[2 -4 6 8 9 -7 10 -3]
+ [X,Y]=scifun1(A)
+ Xtest=[2 6 8 9 10]
+ Ytest=35
+ if (norm(X-Xtest) > %eps | norm(Y-Ytest)) then pause,end
+ [Z]=scifun1(A)
+ Ztest=[2 6 8 9 10]
+ if norm(Z-Ztest) > %eps then pause,end