rougail-output-doc/tests/docs/base/68_0family_leadership_mode.md

50 lines
6.2 KiB
Markdown
Raw Normal View History

2024-07-10 21:27:48 +02:00
---
gitea: none
include_toc: true
---
# dictionaries/rougail/00-base.yml
```yaml
---
version: '1.0'
leader:
description: A leadership
type: leadership
leader:
description: A leader
multi: true
mandatory: false
follower1:
description: a follower1
mandatory: false
follower2:
description: a follower2
mode: basic
```
# Variables for "rougail"
## A leadership
`basic`
This family contains lists of variable blocks.
| Variable                                                                                                | Description                                                                                             |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **rougail.leader.leader**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `unique` `multiple` | A leader. |
| **rougail.leader.follower1**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower1. |
| **rougail.leader.follower2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower2. |
# Example with all variables modifiable
```yaml
---
rougail:
leader:
- leader: example
follower1: example
follower2: example
```