rougail-output-doc/tests/docs/base/41_0choice_leader.md

49 lines
5.1 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: The leadership
type: leadership
leader:
description: The leader
multi: true
mandatory: false
follower1:
type: choice
description: A follower
choices:
- a
- b
- c
```
# Variables for "rougail"
## The 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) `standard` `unique` `multiple` | The leader. |
| **rougail.leader.follower1**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower.<br/>**Choices**: <br/>- a<br/>- b<br/>- c |
# Example with all variables modifiable
```yaml
---
rougail:
leader:
- leader: example
follower1: a_choice
```