rewrite variable doc
This commit is contained in:
parent
b04729762d
commit
44cd630abc
3 changed files with 57 additions and 26 deletions
|
@ -5,7 +5,6 @@
|
|||
- [Le conteneur des variables](variables.md)
|
||||
- [Les familles](family.md)
|
||||
- [Les variables](variable.md)
|
||||
- [Les modes](mode.md)
|
||||
|
||||
## Les contraintes
|
||||
|
||||
|
|
|
@ -34,11 +34,11 @@ En plus de la description, il est possible de préciser une aide complémentaire
|
|||
|
||||
## Mode de la famille
|
||||
|
||||
Le mode par défaut d'une famille correspond au mode le plus petite des variables dans cette famille.
|
||||
Le [mode](./mode.md) par défaut d'une famille correspond au [mode](./mode.md) le plus petite des variables dans cette famille.
|
||||
|
||||
Changer le mode d'une famille permet de définir le mode par défaut des variables inclusent dans cette famille.
|
||||
Changer le [mode](./mode.md) d'une famille permet de définir le [mode](./mode.md) par défaut des variables inclusent dans cette famille.
|
||||
|
||||
Pour définir le mode :
|
||||
Pour définir le [mode](./mode.md) :
|
||||
|
||||
```
|
||||
<family name="my_family" mode="expert"/>
|
||||
|
|
|
@ -6,17 +6,23 @@ Une variable est forcement dans une famille. Il faut donc déjà avoir créer un
|
|||
|
||||
Une variable est déjà un nom. C'est à dire qu'on pourra utiliser plus tard la variable via ce nom.
|
||||
|
||||
```<variable name="my_variable"/>```
|
||||
```
|
||||
<variable name="my_variable"/>
|
||||
```
|
||||
|
||||
## Description et aide sur la variable
|
||||
|
||||
En plus d'un nom, il est possible de mettre une "description" à la variable. C'est une information "utilisateur" qui nous permettra d'avoir des informations complémentaires sur le contenu de cette variable :
|
||||
|
||||
<variable name="my_variable" description="This is a greate variable"/>
|
||||
```
|
||||
<variable name="my_variable" description="This is a greate variable"/>
|
||||
```
|
||||
|
||||
En plus de la description, il est possible de préciser une aide complémentaire :
|
||||
|
||||
<variable name="my_variable" help="This is a greate variable"/>
|
||||
```
|
||||
<variable name="my_variable" help="This is a greate variable"/>
|
||||
```
|
||||
|
||||
## Le type de la variable
|
||||
|
||||
|
@ -49,7 +55,9 @@ Une variable a un type. Ce type permet de définir les valeurs acceptées par ce
|
|||
|
||||
Pour définir le type d'une variable :
|
||||
|
||||
```<variable name="my_variable" type="number"/>```
|
||||
```
|
||||
<variable name="my_variable" type="number"/>
|
||||
```
|
||||
|
||||
## Variable à valeur multiple
|
||||
|
||||
|
@ -57,15 +65,19 @@ Par défaut une variable ne peut acceuillir qu'une seule valeur. Il peut être u
|
|||
|
||||
Pour définir une variable à valeur multiple :
|
||||
|
||||
```<variable name="my_variable" multi="True"/>```
|
||||
```
|
||||
<variable name="my_variable" multi="True"/>
|
||||
```
|
||||
|
||||
## Mode de la variable
|
||||
|
||||
Le mode par défaut d'une variable correspond au mode de la famille.
|
||||
Le [mode](./mode.md) par défaut d'une variable correspond au [mode](./mode.md) de la famille.
|
||||
|
||||
Pour définir le mode :
|
||||
Pour définir le [mode](./mode.md) :
|
||||
|
||||
```<variable name="my_variable" mode="expert"/>```
|
||||
```
|
||||
<variable name="my_variable" mode="expert"/>
|
||||
```
|
||||
|
||||
## Cacher une variable
|
||||
|
||||
|
@ -76,7 +88,9 @@ Par contre cette variable sont accessibles lorsqu'on va l'utiliser.
|
|||
|
||||
Pour cacher une variable :
|
||||
|
||||
```<variable name="my_variable" hidden="True"/>```
|
||||
```
|
||||
<variable name="my_variable" hidden="True"/>
|
||||
```
|
||||
|
||||
## Désactiver une variable
|
||||
|
||||
|
@ -86,28 +100,36 @@ Désactiver une variable signifie qu'elle ne sera pas visible lorsqu'on modifie
|
|||
|
||||
Pour désactiver une variable :
|
||||
|
||||
```<variable name="my_variable" disabled="True"/>```
|
||||
```
|
||||
<variable name="my_variable" disabled="True"/>
|
||||
```
|
||||
|
||||
## Variable obligatoire
|
||||
|
||||
Variable dont une valeur est requise :
|
||||
|
||||
```<variable name="my_variable" mandatory="True"/>```
|
||||
```
|
||||
<variable name="my_variable" mandatory="True"/>
|
||||
```
|
||||
|
||||
## Valeur par défaut d'une variable
|
||||
|
||||
Il est possible de fixer les valeurs par défaut d'une variable :
|
||||
|
||||
```<variable name="my_variable">
|
||||
```
|
||||
<variable name="my_variable">
|
||||
<value>value</value>
|
||||
</variable>```
|
||||
</variable>
|
||||
```
|
||||
|
||||
Pour une variable multiple, il est possible de préciser plusieurs valeurs :
|
||||
|
||||
```<variable name="my_variable" multi="True">
|
||||
```
|
||||
<variable name="my_variable" multi="True">
|
||||
<value>value 1</value>
|
||||
<value>value 2</value>
|
||||
</variable>```
|
||||
</variable>
|
||||
```
|
||||
|
||||
Une valeur par défaut peut également être `une valeur calculer <fill.rst>`.
|
||||
|
||||
|
@ -127,13 +149,17 @@ Créons notre variable :
|
|||
|
||||
Et redéfinisons là :
|
||||
|
||||
```<variable name="my_variable" redefine="True" description="New description"/>```
|
||||
```
|
||||
<variable name="my_variable" redefine="True" description="New description"/>
|
||||
```
|
||||
|
||||
## Créer une variable inexistante
|
||||
|
||||
Il est parfois utile de créer une variable si elle n'existe pas dans un autre dictionnaire :
|
||||
|
||||
```<variable name="my_variable" exists="False"/>```
|
||||
```
|
||||
<variable name="my_variable" exists="False"/>
|
||||
```
|
||||
|
||||
Si cette variable existe dans un autre dictionnaire, elle ne sera pas modifier ni recréé
|
||||
|
||||
|
@ -141,7 +167,9 @@ Si cette variable existe dans un autre dictionnaire, elle ne sera pas modifier n
|
|||
|
||||
Parfois on veut pouvoir redéfinir une variable mais seulement dans le cas où elle existe déjà :
|
||||
|
||||
```<variable name="my_variable" redefine="True" exists="True" hidden="True"/>```
|
||||
```
|
||||
<variable name="my_variable" redefine="True" exists="True" hidden="True"/>
|
||||
```
|
||||
|
||||
## Variable à valeur automatiquement modifiée
|
||||
|
||||
|
@ -149,9 +177,11 @@ Une variable avec valeur automatiquement modifiée est une variable dont la vale
|
|||
|
||||
Voici une variable a valeur automatiquement modifiée :
|
||||
|
||||
```<variable name="my_variable" auto_save="True">
|
||||
```
|
||||
<variable name="my_variable" auto_save="True">
|
||||
<value>my_value</value>
|
||||
</variable>```
|
||||
</variable>
|
||||
```
|
||||
|
||||
Dans ce cas la valeur est fixée à la valeur actuelle.
|
||||
Par exemple, si la valeur de cette variable est issue d'un calcul, la valeur ne sera plus recalculée.
|
||||
|
@ -164,11 +194,13 @@ Une variable avec valeur en lecture seule automatique est une variable dont la v
|
|||
|
||||
Voici un variable à valeur en lecture seule automatique :
|
||||
|
||||
```<variable name="my_variable" auto_freeze="True"/>```
|
||||
```
|
||||
<variable name="my_variable" auto_freeze="True"/>
|
||||
```
|
||||
|
||||
Dans ce cas la valeur est fixée à la valeur actuelle et elle ne sera plus modifiable par l'utilisateur.
|
||||
Par exemple, si la valeur de cette variable est issue d'un calcul, la valeur ne sera plus recalculée.
|
||||
|
||||
Ces variables sont généralement des variables obligatoires. En effet ces variable ne sont en lecteur seul que si elles sont une valeurs.
|
||||
|
||||
<!ATTLIST variable test CDATA #IMPLIED>
|
||||
FIXME <!ATTLIST variable test CDATA #IMPLIED>
|
||||
|
|
Loading…
Reference in a new issue