Help check: validate the help files on compilation against a derivated docbook schema
[scilab.git] / scilab / modules / xcos / help / fr_FR / scilab_utilities_functions / block_parameter_error.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) 2011 - Bernard DUJARDIN <develop.dujardin@numericable.fr>\
5  *\
6  * This file must be used under the terms of the CeCILL.\
7  * This source file is licensed as described in the file COPYING, which\
8  * you should have received as part of this distribution.  The terms\
9  * are also available at\
10  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt\
11  *\
12  -->
13 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="block_parameter_error" xml:lang="fr_FR">
14   <info>
15     <pubdate>$LastChangedDate: 15-Fév-2011 $</pubdate>
16   </info>
17   <refnamediv>
18     <refname>block_parameter_error</refname>
19     <refpurpose>
20       Affiche une boîte d'erreur de saisie de paramètre pour un bloc Xcos.
21     </refpurpose>
22   </refnamediv>
23   <refsynopsisdiv>
24     <title>Séquence d'appel</title>
25     <synopsis>
26       block_parameter_error(inform, expected)
27       </synopsis>
28   </refsynopsisdiv>
29   <refsection>
30     <title>Paramètres</title>
31     <variablelist>
32       <varlistentry>
33         <term>inform:</term>
34         <listitem>
35           <para> une chaîne, le type d'erreur</para>
36         </listitem>
37       </varlistentry>
38       <varlistentry>
39         <term>expected:</term>
40         <listitem>
41           <para> une chaîne, la valeur ou la gamme de valeurs attendues</para>
42         </listitem>
43       </varlistentry>
44     </variablelist>
45   </refsection>
46   <refsection>
47     <title>Description</title>
48     <para>
49         Le but de cette fonction est de donner à l'utilisateur une information précise sur son erreur
50         lorsqu'il entre un paramètre de bloc. L'information utilisateur est affichée sur deux lignes
51         données respectivement par les paramètres :
52       </para>
53     <itemizedlist>
54       <listitem>
55         <para><emphasis role="bold">inform</emphasis>: elle est réservée à l'information de
56             l'utilisateur sur son erreur. La meilleure façon de le faire est de rappeler le
57             nom du paramètre et la valeur erronée fournie par l'utilisateur.
58           </para>
59       </listitem>
60       <listitem>
61         <para><emphasis role="bold">expected</emphasis>: une information positive pour
62             guider l'utilisateur en vue de la correction de l'erreur. Par exemple, si
63             le paramètre est un entier, le message peut être "Doit être entier", pour
64             une gamme de valeurs on peut utiliser un message comme celui-ci:
65           </para>
66         <para/>
67         <programlisting role="example"><![CDATA[
68           msprintf(gettext("Must be in the interval %s."), "[3, 8]")
69           ]]></programlisting>
70       </listitem>
71     </itemizedlist>
72   </refsection>
73   <refsection>
74     <title>Exemples</title>
75     <para>
76         L'exemple ci-dessous est une cas d'utilisation simple de la fonction. L'utilisateur entre
77         une valeur dans la boîte de dialogue de paramètre. Si la valeur n'est pas valide, l'exemple
78         affiche cette boîte d'erreur :
79       </para>
80     <para/>
81     <mediaobject>
82       <imageobject>
83         <imagedata align="center" fileref="../../examples/scilab_utilities_functions/fr_FR/block_parameter_error_fr_FR.png"/>
84       </imageobject>
85     </mediaobject>
86     <para/>
87     <programlisting role="example"><![CDATA[
88   loadXcosLibs // Inutile dans un contexte de programmation de bloc Xcos
89
90   ok = %f;
91
92   while ~ok do
93       // Entrée du paramètre
94       [Datatype] = x_mdialog( ..
95           "Entrée de paramètre", ..
96           "Type de données (3:int32, 4:int16, 5:int8, ...) ?", ..
97           "3" ..
98       );
99
100       if isempty(Datatype) then // Annuler ou OK ?
101           break;
102
103       else
104           Datatype = evstr(Datatype);
105
106       end
107       // Tester le paramètre 'Data Type et afficher une boîte d'erreur si nécessaire
108       if Datatype < 3 | Datatype > 8 then
109           block_parameter_error( ..
110               msprintf("Valeur erronée pour le paramètre ''Type de données'' : %d.", Datatype), ..
111               msprintf("Doit être dans l''intervalle %s.", "[3, 8]") ..
112           );
113           ok = %f;
114
115       else // Le paramètre est valide continuer le travail
116           ok = %t;
117           print(%io(2), "Le paramètre ''Type de données'' est valide");
118       end
119   end
120     ]]></programlisting>
121   </refsection>
122   <refsection role="see also">
123     <title>See also</title>
124     <itemizedlist>
125       <listitem>
126         <para>
127           <link linkend="x_mdialog">x_mdialog</link>
128         </para>
129       </listitem>
130     </itemizedlist>
131   </refsection>
132   <refsection>
133     <title>Authors</title>
134     <simplelist type="vert">
135       <member>Bernard DUJARDIN</member>
136     </simplelist>
137   </refsection>
138 </refentry>