rougail-output-doc/tests/docs/base/44_4leadership_mandatory.md

45 lines
4.6 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.1'
leader:
description: a leadership
type: leadership
leader:
description: a leader
multi: true
mandatory: true
follower1:
description: a follower
mandatory: false
```
# 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` `mandatory` `unique` `multiple` | A leader. |
| **rougail.leader.follower1**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower. |
# Example with all variables modifiable
```yaml
---
rougail:
leader:
- leader: example
follower1: example
```