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

78 lines
2.7 KiB
Text

== dictionaries/rougail/00-base.yml
[,yaml]
----
version: '1.1'
condition1: false # a first conditional variable
condition2: false # a second conditional variable
family:
description: a family
hidden:
type: jinja
jinja: |
{% if not rougail.condition1 %}
condition1 is false
{% endif %}
description: if condition1 is false
variable:
description: a variable
hidden:
type: jinja
jinja: |
{% if rougail.condition2 %}
condition2 is true
{% endif %}
description: if condition2 is false
----
== Variables for "rougail"
[cols="116a,116a",options="header"]
|====
| Variable | Description
|
**rougail.condition1** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` |
A first conditional variable. +
**Default**: False
|
**rougail.condition2** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` |
A second conditional variable. +
**Default**: False
|====
=== a family
`basic` _`hidden`_
**Hidden**: if condition1 is false.
[cols="116a,116a",options="header"]
|====
| Variable | Description
|
**rougail.family.variable** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`hidden`_ |
A variable. +
**Hidden**: if condition2 is false.
|====
== Example with mandatory variables not filled in
[,yaml]
----
rougail:
family:
variable: example
----
== Example with all variables modifiable
[,yaml]
----
rougail:
condition1: false
condition2: false
family:
variable: example
----