rougail-output-doc/tests/docs/base/24_0family_hidden_condition.adoc
2024-08-05 14:38:59 +02:00

62 lines
1.9 KiB
Text

== dictionaries/rougail/00-base.yml
[,yaml]
----
version: '1.1'
condition: no # the variable use has condition
family:
description: possibly hidden family
hidden:
type: jinja
jinja: |
{% if rougail.condition == "yes" %}
condition is yes
{% endif %}
description: if condition is yes
var1: # a variable
----
== Variables for "rougail"
[cols="105a,105a",options="header"]
|====
| Variable | Description
|
**rougail.condition** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` |
The variable use has condition. +
**Default**: no
|====
=== possibly hidden family
`basic` _`hidden`_
**Hidden**: if condition is yes.
[cols="105a,105a",options="header"]
|====
| Variable | Description
|
**rougail.family.var1** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` |
A variable.
|====
== Example with mandatory variables not filled in
[,yaml]
----
rougail:
family:
var1: example
----
== Example with all variables modifiable
[,yaml]
----
rougail:
condition: no
family:
var1: example
----