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

76 lines
2.1 KiB
Text

== dictionaries/rougail/00-base.yml
[,yaml]
----
version: '1.1'
general: # a family
int:
description: a first number
type: number
validators:
- type: jinja
jinja: |
{% if _.int == int2 %}
int and int2 must be different
{% endif %}
params:
int2:
type: variable
variable: _.int2
optional: true
description: int and int2 must be different
- type: jinja
jinja: |
{% if _.int == int3 %}
int and int3 must be different
{% endif %}
params:
int3:
type: variable
variable: _.int3
optional: true
description: int and int3 must be different
int2: 1 # a second number
----
== Variables for "rougail"
=== a family
`basic`
[cols="108a,108a",options="header"]
|====
| Variable | Description
|
**rougail.general.int** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `basic` `mandatory` |
A first number. +
**Validators**:
* int and int2 must be different.
* int and int3 must be different.
|
**rougail.general.int2** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` |
A second number. +
**Default**: 1
|====
== Example with mandatory variables not filled in
[,yaml]
----
rougail:
general:
int: 42
----
== Example with all variables modifiable
[,yaml]
----
rougail:
general:
int: 42
int2: 1
----