Infra
/
rougail
9
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

rewrite family doc

This commit is contained in:
Emmanuel Garette 2021-02-06 16:28:33 +01:00
parent 44cd630abc
commit fed7084916
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/family.md
View File

@ -18,7 +18,7 @@ Cette famille doit être placé dans une balise "variables" :
</variables>
```
## Description et aide sur la famille
## Description et aide de 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 :
@ -44,7 +44,7 @@ Pour définir le [mode](./mode.md) :
<family name="my_family" mode="expert"/>
```
# Cacher une famille
## Famille invisible
Il est possible de cacher une famille, ainsi toutes les variables inclusent dans cette famille.
@ -57,7 +57,7 @@ Pour cacher une famille :
<family name="my_family" hidden="True"/>
```
## Les familles crées dynamiquement
## Famille crées dynamiquement
Pour créer une famille crées dynamiquement, il faut créer une family fictive lié à une variable.
Le nom et la description de la famille et des variables qu'elle contient sera en réalité le prefix du nouveau nom/description. Le suffix viendra de la variable liée.
@ -71,8 +71,8 @@ Par exemple :
<value>val2</value>
</variable>
</family>
<family name='my_dyn_family\_' dynamic="varname description="Describe "">
<variable name='my_dyn_var\_'/>
<family name='my_dyn_family_' dynamic="varname description="Describe "">
<variable name='my_dyn_var_'/>
</family>
```