rougail-tutorials/README.md

- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)

# [tutorial v1.1_000] Creating a structure file

[Read the tutorial "Creating a structure file" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#creating-a-structure-file)


## Screenshot


<img src="firefox.png" width=50% height=50% alt="Firefox Proxy setting"/>


## Clone and install



To test this tutorial, you need to download this repository and install Rougail:

```shell
git clone -b 1.1 https://forge.cloud.silique.fr/stove/rougail-tutorials.git
cd rougail-tutorials
python -m venv venv_rougail
. venv_rougail/bin/activate
pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user-data-yaml
```

Then switch to the tutorial page:

```shell
git switch --detach v1.1_000
```

## Structure



<p>
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_000/./">.</a><br/>
	└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_000/./firefox/">firefox</a><br/>
	    └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_000/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
<br/><br/></p>

Contents of the firefox/00-proxy.yml file

```yml
%YAML 1.2
---
version: 1.1
...

```

***
## User datas

### Example 1

#### config/01/config.yml


```yml
---
```

***
#### Output

```shell
rougail -m firefox/ -u yaml -yf config/01/config.yml
```

***


- [[tutorial v1.1_001] Let’s add our first variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_001/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_001~1..v1.1_001))