[doc] misc. fix & improvements
[scilab.git] / scilab / modules / m2sci / help / fr_FR / m2scideclare.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) 2002-2004 - INRIA - Vincent COUVERT
5     *
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14     *
15     -->
16 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
17           xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML"
18           xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"
19           xml:lang="fr" xml:id="m2scideclare">
20     <refnamediv>
21         <refname>m2scideclare</refname>
22         <refpurpose>Donner des indices pour aider M2SCI...</refpurpose>
23     </refnamediv>
24     <refsection>
25         <title>Description</title>
26         <para>
27             La principale difficulté de M2SCI (<literal>mfile2sci</literal>) est de trouver
28             ce que sont les variables : dimensions, type...
29         </para>
30         <para>
31             Pour aider cet outil, il suffit d'ajouter des commentaires commencant par
32             <literal>%m2scideclare</literal> dans le fichier Matlab à convertir,
33             (<literal>%m2sciassume</literal> était utilisée dans les versions précédentes
34             de Scilab mais est maintenant obsolète).
35         </para>
36         <para>
37             La syntaxe de cette commande est :
38         </para>
39         <para>
40             <literal>%m2scideclare nom_de_variable|dimensions|type_de_données|propriété</literal>
41         </para>
42         <para>
43             avec :
44         </para>
45           <itemizedlist>
46             <listitem>
47               <para>
48                 nom_de_variable : nom de la variable déclarée. Ce nom peut être
49                 un champ de Struct (e.g. <literal>x(1,2).nom</literal>)
50                 ou décrire le contenu d'une Cell en utilisant la syntaxe
51                 <literal>x(1,2).entries</literal>. NOTEZ que pour les Cells et les
52                 Structs <literal>*</literal> peut être utilisé comme index.
53               </para>
54             </listitem>
55             <listitem>
56               <para>
57                 dimensions : dimensions de la variable déclarée séparées par des espaces,
58                 si une dimension est inconnue, remplacez la par <literal>?</literal>. NOTEZ que
59                 les dimensions des chaînes de caractère doivent être identiques aux dimensions
60                 Matlab e.g. <literal>1 6</literal> pour la chaîne de caractères 'chaine'.
61               </para>
62             </listitem>
63             <listitem>
64               <para>
65                 type_de_données: le type de donnée de la variable qui peut être :
66               </para>
67               <informaltable border="1">
68                 <tr>
69                   <td>Type de donnée m2scideclare</td>
70                   <td>Type Scilab "équivalent"</td>
71                 </tr>
72                 <tr>
73                   <td>Double</td>
74                   <td>1</td>
75                 </tr>
76                 <tr>
77                   <td>Boolean</td>
78                   <td>4</td>
79                 </tr>
80                 <tr>
81                   <td>Sparse</td>
82                   <td>5</td>
83                 </tr>
84                 <tr>
85                   <td>Int</td>
86                   <td>8</td>
87                 </tr>
88                 <tr>
89                   <td>Handle</td>
90                   <td>9</td>
91                 </tr>
92                 <tr>
93                   <td>String</td>
94                   <td>10</td>
95                 </tr>
96                 <tr>
97                   <td>Struct</td>
98                   <td>Struct Matlab (16)</td>
99                 </tr>
100                 <tr>
101                   <td>Cell</td>
102                   <td>Cell Matlab (17)</td>
103                 </tr>
104                 <tr>
105                   <td>Void</td>
106                   <td>Sans type (0)</td>
107                 </tr>
108                 <tr>
109                   <td>?</td>
110                   <td>Type inconnu</td>
111                 </tr>
112               </informaltable>
113             </listitem>
114             <listitem>
115               <para>
116                 propriété : propriété de la variable qui peut être :
117               </para>
118               <informaltable border="1">
119                 <tr>
120                   <td>Propriété m2scideclare</td>
121                   <td>"Equivalent" Scilab</td>
122                 </tr>
123                 <tr>
124                   <td>Real</td>
125                   <td>Donnée réelle</td>
126                 </tr>
127                 <tr>
128                   <td>Complex</td>
129                   <td>Donnée complexe</td>
130                 </tr>
131                 <tr>
132                   <td>?</td>
133                   <td>Property inconnue</td>
134                 </tr>
135               </informaltable>
136               <para>
137                 Ce champ est ignoré pour les types de données suivants : <literal>Cell</literal>,
138                 <literal>Struct</literal>, <literal>String</literal> et <literal>Boolean</literal>.
139               </para>
140             </listitem>
141           </itemizedlist>
142         <para>
143             Toutes les informations données par <literal>m2scideclare</literal> sont comparées avec
144             les données inférées, en cas de conflit, les données inférées sont conservées et
145             un warning est affiché. Si vous êtes sûrs de vos informations, rapportez ce bug.
146         </para>
147         <para>Voici quelques exemples :</para>
148            <itemizedlist>
149               <listitem>
150                 <literal>%m2scideclare var1|2 3|Double|Real</literal>
151                 <para>
152                   var1 est déclarée comme une matrice de Doubles de taille 2x3
153                   et contenant des données réelles
154                 </para>
155               </listitem>
156               <listitem>
157                 <literal>%m2scideclare var2|2 3 10|Double|Complex</literal>
158                 <para>
159                   var2 est déclarée comme une hypermatrice de Doubles de taille 2x3x10
160                   et contenant des données complexes
161                 </para>
162               </listitem>
163               <listitem>
164                 <literal>%m2scideclare var3(1,2).name|1 10|String|?</literal>
165                 <para>
166                   var3 est déclarée comme un tableau de Structs contenant une chaîne de
167                   caractères de taille 1x10 dans le champ 'name' de la Struct à l'indice (1,2)
168                 </para>
169               </listitem>
170               <listitem>
171                 <literal>%m2scideclare var4(1,5).entries|1 ?|Boolean|?</literal>
172                 <para>
173                   var4 est déclarée comme un tableau de Cells contenant
174                   un vecteur ligne de booléens à l'indice (1,5)
175                 </para>
176               </listitem>
177               <listitem>
178                 <literal>%m2scideclare var4(1,6).entries|? ?|Int|?</literal>
179                 <para>
180                   var4 est déclarée comme un tableau de Cells contenant
181                   un vecteur ligne de booléens à l'indice (1,5)
182                   et des données entières à l'indice (1,6)
183                 </para>
184               </listitem>
185               <listitem>
186                 <literal>%m2scideclare var5(*,*).name|1 ?|String|?</literal>
187                 <para>
188                   var5 est déclarée comme un tableau de Structs contenant une
189                   chaîne de caractères de taille 1xn dans chaque champ 'name'
190                 </para>
191               </listitem>
192               <listitem>
193                 <literal>%m2scideclare var6(2,*).entries|1 3|Double|Real</literal>
194                 <para>
195                   var6 est déclarée comme un tableau de Cells contenant un
196                   veteur de Doubles de taille 1x3 dans chaque élement de sa
197                   seconde ligne.
198                 </para>
199               </listitem>
200           </itemizedlist>
201     </refsection>
202 </refentry>