rougail-output-doc/tests/docs/base/01_6string_multi.md

87 lines
15 KiB
Markdown
Raw Normal View History

2024-07-10 21:27:48 +02:00
---
gitea: none
include_toc: true
---
# dictionaries/rougail/00-base.yml
```yaml
---
version: '1.1'
var1: [] # the first variable
var2:
description: the second variable
default: []
var3:
description: the third variable
type: string
var4: # the forth variable
- value
var5:
description: the fifth variable
default:
- value
var6:
description: the sixth variable
type: string
default:
- value
var7:
description: the seventh variable
multi: true
default:
- value
var8:
description: the eighth variable
type: string
multi: true
default:
- value
```
# Variables for "rougail"
| Variable                                                                                                                       | Description                                                                                                                    |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **rougail.var1**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The first variable. |
| **rougail.var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The second variable. |
| **rougail.var3**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The third variable. |
| **rougail.var4**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.<br/>**Default**: <br/>- value |
| **rougail.var5**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.<br/>**Default**: <br/>- value |
| **rougail.var6**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.<br/>**Default**: <br/>- value |
| **rougail.var7**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The seventh variable.<br/>**Default**: <br/>- value |
| **rougail.var8**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The eighth variable.<br/>**Default**: <br/>- value |
# Example with mandatory variables not filled in
```yaml
---
rougail:
var1:
- example
var2:
- example
var3: example
```
# Example with all variables modifiable
```yaml
---
rougail:
var1:
- example
var2:
- example
var3: example
var4:
- value
var5:
- value
var6:
- value
var7:
- value
var8:
- value
```