stove/rougail
3
0
Fork 0
Code Issues 10 Pull requests 1 Projects Releases Wiki Activity

rewrite family

Browse source
This commit is contained in:
Emmanuel Garette 2021-02-06 16:14:24 +01:00
parent 7545aa50e9
commit b04729762d
2 changed files with 25 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
doc/family.md
View file

@ -6,23 +6,31 @@ Une famille est un conteneur de variables.
Pour décrire une famille il faut mettre au minimum un nom : Pour décrire une famille il faut mettre au minimum un nom :
```<family name="my_family"/>``` ```
<family name="my_family"/>
```
Cette famille doit être placé dans une balise "variables" : Cette famille doit être placé dans une balise "variables" :
```<variables> ```
<variables>
<family name="my_family"/> <family name="my_family"/>
</variables>``` </variables>
```
## Description et aide sur la famille ## Description et aide sur la famille
En plus d'un nom, il est possible de mettre une "description" à la famille. C'est une information "utilisateur" qui nous permettra d'avoir des informations complémentaires sur le contenu de cette famille : En plus d'un nom, il est possible de mettre une "description" à la famille. C'est une information "utilisateur" qui nous permettra d'avoir des informations complémentaires sur le contenu de cette famille :
```<family name="my_family" description="This is a great family"/>``` ```
<family name="my_family" description="This is a great family"/>
```
En plus de la description, il est possible de préciser une aide complémentaire : En plus de la description, il est possible de préciser une aide complémentaire :
```<family name="my_family" help="This is a great family"/>``` ```
<family name="my_family" help="This is a great family"/>
```
## Mode de la famille ## Mode de la famille
@ -32,7 +40,9 @@ Changer le mode d'une famille permet de définir le mode par défaut des variabl
Pour définir le mode : Pour définir le mode :
```<family name="my_family" mode="expert"/>``` ```
<family name="my_family" mode="expert"/>
```
# Cacher une famille # Cacher une famille
@ -43,7 +53,9 @@ Par contre ces variables sont accessibles lorsqu'on va utiliser ces variables.
Pour cacher une famille : Pour cacher une famille :
```<family name="my_family" hidden="True"/>``` ```
<family name="my_family" hidden="True"/>
```
## Les familles crées dynamiquement ## Les familles crées dynamiquement
@ -52,7 +64,8 @@ Le nom et la description de la famille et des variables qu'elle contient sera en
Par exemple : Par exemple :
```<family name='my_family'> ```
<family name='my_family'>
<variable name='varname' multi="True"> <variable name='varname' multi="True">
<value>val1</value> <value>val1</value>
<value>val2</value> <value>val2</value>
@ -60,7 +73,8 @@ Par exemple :
</family> </family>
<family name='my_dyn_family\_' dynamic="varname description="Describe ""> <family name='my_dyn_family\_' dynamic="varname description="Describe "">
<variable name='my_dyn_var\_'/> <variable name='my_dyn_var\_'/>
</family>``` </family>
```
Créera trois familles : Créera trois familles :

4
doc/variables.md
View file

@ -1,6 +1,6 @@
# Le conteneur des variables Variables # Le conteneur des variables
La balise variable est le conteneur de l'ensemble des familles dans laquelle on pourra placer des variables : La balise "variables" est le conteneur de l'ensemble des familles dans laquelle on pourra placer des variables :
``` ```
<?xml version='1.0' encoding='UTF-8'?> <?xml version='1.0' encoding='UTF-8'?>