Doc/Config/LSattribute : Added notes about generation methods of the value.

This commit is contained in:
Benjamin Renard 2010-01-06 19:18:53 +01:00
parent c05741a489
commit b591ab3a27

View file

@ -28,8 +28,9 @@
), ),
'multiple' => 0, 'multiple' => 0,
'required' => 1, 'required' => 1,
'default_value' => 'valeur1', 'generate_function' => 'fonction1',
'generate_value_format' => '[LSformat]', 'generate_value_format' => '[LSformat]',
'default_value' => 'valeur1',
'check_data' => array ( 'check_data' => array (
// Régle de vérification syntaxique des données saisies // Régle de vérification syntaxique des données saisies
), ),
@ -50,7 +51,6 @@
'dependAttrs' => array( 'dependAttrs' => array(
// Attributs en dépendance // Attributs en dépendance
), ),
'generate_function' => 'fonction1',
'onDisplay' => 'fonction2' 'onDisplay' => 'fonction2'
), ),
/* ----------- end -----------*/ /* ----------- end -----------*/
@ -133,10 +133,11 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>default_value</term> <term>generate_function</term>
<listitem> <listitem>
<simpara>Valeur par défaut de l'attribut.</simpara> <simpara>Nom de la fonction permettant de générer la valeur de l'attribut.
<simpara>Valeurs possibles : <emphasis>0</emphasis> ou <emphasis>1</emphasis></simpara> Cette fonction sera éxecutée, en passant en premier paramètre, l'objet
&LSobject; courant.</simpara>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -144,6 +145,18 @@
<term>generate_value_format</term> <term>generate_value_format</term>
<listitem> <listitem>
<simpara>&LSformat; permettant la génération de l'attribut.</simpara> <simpara>&LSformat; permettant la génération de l'attribut.</simpara>
<note><simpara>Cette méthode de génération est utilisée uniquement si aucune fonction de génération
de la valeur n'est définie (paramètre <parameter>generate_function</parameter>).</simpara></note>
</listitem>
</varlistentry>
<varlistentry>
<term>default_value</term>
<listitem>
<simpara>Valeur par défaut de l'attribut.</simpara>
<simpara>Valeurs possibles : <emphasis>0</emphasis> ou <emphasis>1</emphasis></simpara>
<note><simpara>Cette valeur est également utilisée dans le cadre de la génération automatique
de la valeur de l'attribut si aucune autre méthode n'est disponible (via une fonction ou un &LSformat;).</simpara></note>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -208,15 +221,6 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term>generate_function</term>
<listitem>
<simpara>Nom de la fonction permettant de générer la valeur de l'attribut.
Cette fonction sera éxecutée, en passant en premier paramètre, l'objet
&LSobject; courant.</simpara>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term>onDisplay</term> <term>onDisplay</term>
<listitem> <listitem>