57 lines
9.9 KiB
Markdown
57 lines
9.9 KiB
Markdown
|
---
|
||
|
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: value # the forth variable
|
||
|
var5:
|
||
|
description: the fifth variable
|
||
|
default: value
|
||
|
var6:
|
||
|
description: the sixth variable
|
||
|
type: string
|
||
|
default: value
|
||
|
```
|
||
|
# Variables
|
||
|
|
||
|
| Variable | Description |
|
||
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||
|
| **var1**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable. |
|
||
|
| **var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable. |
|
||
|
| **var3**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The third variable. |
|
||
|
| **var4**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The forth variable.<br/>**Default**: value |
|
||
|
| **var5**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.<br/>**Default**: value |
|
||
|
| **var6**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.<br/>**Default**: value |
|
||
|
|
||
|
|
||
|
# Example with mandatory variables not filled in
|
||
|
|
||
|
```yaml
|
||
|
---
|
||
|
var1: example
|
||
|
var2: example
|
||
|
var3: example
|
||
|
```
|
||
|
# Example with all variables modifiable
|
||
|
|
||
|
```yaml
|
||
|
---
|
||
|
var1: example
|
||
|
var2: example
|
||
|
var3: example
|
||
|
var4: value
|
||
|
var5: value
|
||
|
var6: value
|
||
|
```
|