rougail-output-doc/tests/docs/base/24_0family_mandatory_condition.md

---
gitea: none
include_toc: true
---
# dictionaries/rougail/00-base.yml

```yaml
---
version: '1.1'
condition: no    # a condition
var:
  description: a variable
  mandatory:
    type: jinja
    jinja: |
      {% if _.condition == "yes" %}
      condition is yes
      {% endif %}
    description: only if rougail.condition has the value "yes"
```
# 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.var**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` _`mandatory`_                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | A variable.<br/>**Mandatory**: only if rougail.condition has the value "yes".                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |


# Example with all variables modifiable

```yaml
---
rougail:
  condition: no
  var: example
```