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

56 lines
5.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: leadership
type: leadership
leader: # a leader
- a
- b
- c
follower1:
description: a follower
type: number
default:
type: jinja
jinja: '{{ index }}'
params:
index:
type: index
description: returns index
```
# Variables for "rougail"
## leadership
`standard`
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**: <br/>- a<br/>- b<br/>- c |
| **rougail.leader.follower1**<br/>[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower.<br/>**Default**: returns index. |
# Example with all variables modifiable
```yaml
---
rougail:
leader:
- leader: a
follower1: 2
- leader: b
follower1: 2
- leader: c
follower1: 2
```