rougail-output-doc/tests/docs/base/04_5disabled_calculation_optional.md

70 lines
7.4 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'
condition: no # a condition
var1:
description: a first variable
hidden:
type: jinja
jinja: |
{% if unknown is not defined %}
unknown is undefined
{% elif unknown == "no" %}
unknown is no
{% endif %}
params:
unknown:
type: variable
variable: _.unknown
optional: true
description: calculation from an unknown variable
var2:
description: a second variable
hidden:
type: jinja
jinja: |
{% if condition is not defined %}
condition is undefined
{% elif condition == "no" %}
condition is no
{% endif %}
params:
condition:
type: variable
variable: _.condition
optional: true
description: calculation from an condition variable
```
# Variables for "rougail"
| Variable                                                                                                           | Description                                                                                                        |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **rougail.condition**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.<br/>**Default**: no |
| **rougail.var1**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`hidden`_ | A first variable.<br/>**Hidden**: calculation from an unknown variable. |
| **rougail.var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`hidden`_ | A second variable.<br/>**Hidden**: calculation from an condition variable. |
# Example with mandatory variables not filled in
```yaml
---
rougail:
var1: example
var2: example
```
# Example with all variables modifiable
```yaml
---
rougail:
condition: no
var1: example
var2: example
```