rougail-output-doc/tests/docs/base/04_5disabled_calculation_optional.md

Table of Contents

• dictionaries/rougail/00-base.yml
• Variables for "rougail"
• Example with mandatory variables not filled in
• Example with all variables modifiable

dictionaries/rougail/00-base.yml

---
version: '1.1'
condition: no    # a condition
var1:
  description: a first variable
  hidden:
    type: jinja
    jinja: |
      {% if unknown is not defined %}
      unknown is undefined
      {% elif unknown == "no" %}
      unknown is no
      {% endif %}
      params:
        unknown:
          type: variable
          variable: _.unknown
          optional: true      
    description: calculation from an unknown variable
var2:
  description: a second variable
  hidden:
    type: jinja
    jinja: |
      {% if condition is not defined %}
      condition is undefined
      {% elif condition == "no" %}
      condition is no
      {% endif %}
      params:
        condition:
          type: variable
          variable: _.condition
          optional: true      
    description: calculation from an condition variable

Variables for "rougail"

Variable	Description
rougail.condition string standard mandatory	A condition. Default: no
rougail.var1 string basic mandatory hidden	A first variable. Hidden: calculation from an unknown variable.
rougail.var2 string basic mandatory hidden	A second variable. Hidden: calculation from an condition variable.

Example with mandatory variables not filled in

---
rougail:
  var1: example
  var2: example

Example with all variables modifiable

---
rougail:
  condition: no
  var1: example
  var2: example