rougail-output-doc/tests/docs/base/40_2leadership_leader_calculation.md

54 lines
6.3 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
default:
type: jinja
jinja: |
val1
val2
description: returns val1 and val2
follower1: # a first follower
follower2: # a second follower
```
# 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) `standard` `mandatory` `unique` `multiple` | A leader.<br/>**Default**: returns val1 and val2. |
| **rougail.leader.follower1**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A first follower. |
| **rougail.leader.follower2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A second follower. |
# Example with all variables modifiable
```yaml
---
rougail:
leader:
- leader: val1
follower1: example
follower2: example
- leader: val2
follower1: example
follower2: example
```