rougail-output-doc/tests/docs/base/00_9default_calculation_param_optional.md

49 lines
5.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'
var1:
description: a first variable
default:
type: jinja
jinja: '{% if var2 is defined %} {{ var2 }} {% elif var3 is defined %} {{ var3
}} {% elif var4 is defined %} {{ var4 }} {% else %} {{ _.var2 }} {% endif %} '
params:
var2:
type: variable
variable: _.var2
optional: true
var3:
type: variable
variable: _.var3
optional: true
var4:
type: variable
variable: _.unknown_family.var
optional: true
description: returns a value
mandatory: false
var2: no # a second variable
```
# Variables for "rougail"
| Variable                                                                                                   | Description                                                                                                |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **rougail.var1**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A first variable.<br/>**Default**: returns a value. |
| **rougail.var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.<br/>**Default**: no |
# Example with all variables modifiable
```yaml
---
rougail:
var1: no
var2: no
```