Compare commits
No commits in common. "1.1" and "v1.1_080" have entirely different histories.
17 changed files with 359 additions and 73 deletions
256
README.md
256
README.md
|
|
@ -1,24 +1,26 @@
|
|||
# Description
|
||||
- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
|
||||
- [[tutorial v1.1_072] Jinja with a parameter](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_072/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_072~1..v1.1_072))
|
||||
|
||||
This tutorial shows to you an example of Rougail use on how to set a proxy in the Mozilla Firefox browser.
|
||||
# [tutorial v1.1_080] A conditional disabled variable with type web_address
|
||||
|
||||
More precisely, this tutorial aims at reproducing this [Mozilla Firefox](https://www.mozilla.org/firefox/new/) settings page:
|
||||
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_080~1..v1.1_080)
|
||||
|
||||
|
||||
[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-conditional-disabled-variable-with-type-web_address)
|
||||
|
||||
And the integration of part of the [Firefox FoxyProxy plugin](https://addons.mozilla.org/firefox/addon/foxyproxy-standard/).
|
||||
|
||||
The idea is to have a namespace specific to FoxyProxy and to find in it part of the settings that we will have made in the main namespace.
|
||||
## Screenshot
|
||||
|
||||
This is what the page looks like:
|
||||
|
||||
|
||||
<img src="firefox.png" width=50% height=50% alt="Firefox Proxy setting"/>
|
||||
|
||||
|
||||
## Clone and install
|
||||
|
||||
|
||||
# Installation
|
||||
|
||||
To test this tutorial, you need to download this repository and install Rougail:
|
||||
|
||||
```bash
|
||||
```shell
|
||||
git clone -b 1.1 https://forge.cloud.silique.fr/stove/rougail-tutorials.git
|
||||
cd rougail-tutorials
|
||||
python -m venv venv_rougail
|
||||
|
|
@ -26,69 +28,177 @@ python -m venv venv_rougail
|
|||
pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user-data-yaml
|
||||
```
|
||||
|
||||
# Summary
|
||||
Then switch to the tutorial page:
|
||||
|
||||
Each step is a separerate commit. You can navigate to history to discover different aspect to the Rougail format.
|
||||
```shell
|
||||
git switch --detach v1.1_080
|
||||
```
|
||||
|
||||
- Getting started
|
||||
- [[tutorial v1.1_000] Creating a structure file](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_000/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#creating-a-structure-file) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_000~1..v1.1_000))
|
||||
- [[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) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#let-s-add-our-first-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_001~1..v1.1_001))
|
||||
- [[tutorial v1.1_002] Describe the variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_002/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#describe-the-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_002~1..v1.1_002))
|
||||
- [[tutorial v1.1_003] Set a default value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_003/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#set-a-default-value) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_003~1..v1.1_003))
|
||||
- A variable with a list of possible values
|
||||
- [[tutorial v1.1_010] A variable with a list of possible values](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_010/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#a-variable-with-a-list-of-possible-values) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_010~1..v1.1_010))
|
||||
- Group variables inside "families"
|
||||
- [[tutorial v1.1_020] Creating a new family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_020/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/proxymode.html#creating-a-new-family) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_020~1..v1.1_020))
|
||||
- [[tutorial v1.1_021] Or a sub family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_021/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/proxymode.html#or-a-sub-family) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_021~1..v1.1_021))
|
||||
- [[tutorial v1.1_022] Putting a variable inside of a family or a sub family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_022/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/proxymode.html#putting-a-variable-inside-of-a-family-or-a-sub-family) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_022~1..v1.1_022))
|
||||
- Constrainte the value of a variable with it's type
|
||||
- [[tutorial v1.1_030] A variable with type "domainname"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_030/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-variable-with-type-"domainname") - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_030~1..v1.1_030))
|
||||
- [[tutorial v1.1_031] A variable with type's parameters](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_031/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-variable-with-type's-parameters) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_031~1..v1.1_031))
|
||||
- [[tutorial v1.1_032] A variable with type "port"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_032/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-variable-with-type-"port") - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_032~1..v1.1_032))
|
||||
- [[tutorial v1.1_033] A variable with type "boolean"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_033/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-variable-with-type-"boolean") - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_033~1..v1.1_033))
|
||||
- Define access to variable or family
|
||||
- Property disabled
|
||||
- [[tutorial v1.1_040] A disabled family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_040/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-disabled-family) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_040~1..v1.1_040))
|
||||
- [[tutorial v1.1_041] A conditional disabled family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_041/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-conditional-disabled-family) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_041~1..v1.1_041))
|
||||
- Property hidden
|
||||
- [[tutorial v1.1_042] Copy HTTP manual proxy to HTTPS manual proxy](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_042/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#copy-http-manual-proxy-to-https-manual-proxy) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_042~1..v1.1_042))
|
||||
- [[tutorial v1.1_043] A conditional hidden family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_043/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-conditional-hidden-family) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_043~1..v1.1_043))
|
||||
- Calculated default value for a variable
|
||||
- [[tutorial v1.1_050] A calculated default value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_050/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-calculated-default-value) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_050~1..v1.1_050))
|
||||
- Dynamic family
|
||||
- [[tutorial v1.1_060] Family: a dynamic family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_060/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/dynfam.html#family:-a-dynamic-family) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_060~1..v1.1_060))
|
||||
- [[tutorial v1.1_061] A conditional disabled variable with dynamic identifier](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_061/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/dynfam.html#a-conditional-disabled-variable-with-dynamic-identifier) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_061~1..v1.1_061))
|
||||
- Playing with Jinja
|
||||
- [[tutorial v1.1_070] A conditional hidden family with Jinja](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_070/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-conditional-hidden-family-with-jinja) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_070~1..v1.1_070))
|
||||
- [[tutorial v1.1_071] Jinja with a description](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_071/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#jinja-with-a-description) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_071~1..v1.1_071))
|
||||
- [[tutorial v1.1_072] Jinja with a parameter](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_072/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#jinja-with-a-parameter) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_072~1..v1.1_072))
|
||||
- Various variables
|
||||
- [[tutorial v1.1_080] A conditional disabled variable with type web_address](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_080/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-conditional-disabled-variable-with-type-web_address) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_080~1..v1.1_080))
|
||||
- [[tutorial v1.1_090] A conditional disabled variable with type domainname and parameters](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-conditional-disabled-variable-with-type-domainname-and-parameters) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_090~1..v1.1_090))
|
||||
- Multiple variable
|
||||
- [[tutorial v1.1_091] A variable with multiple value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_091/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-variable-with-multiple-value) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_091~1..v1.1_091))
|
||||
- Mandatory
|
||||
- [[tutorial v1.1_092] A non mandatory variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_092/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-non-mandatory-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_092~1..v1.1_092))
|
||||
- Extras informations for a variable
|
||||
- [[tutorial v1.1_093] Examples](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_093/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#examples) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_093~1..v1.1_093))
|
||||
- [[tutorial v1.1_094] Help](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_094/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#help) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_094~1..v1.1_094))
|
||||
- Various variables
|
||||
- [[tutorial v1.1_095] A conditional disabled boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-conditional-disabled-boolean-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_095~1..v1.1_095))
|
||||
- [[tutorial v1.1_096] A boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-boolean-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_096~1..v1.1_096))
|
||||
- [[tutorial v1.1_097] A Jinja conditional disabled boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_097/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-jinja-conditional-disabled-boolean-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_097~1..v1.1_097))
|
||||
- Mode
|
||||
- [[tutorial v1.1_098] A variable in avanced mode](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_098/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-variable-in-avanced-mode) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_098~1..v1.1_098))
|
||||
- Various variables
|
||||
- [[tutorial v1.1_100] A boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-boolean-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_100~1..v1.1_100))
|
||||
- [[tutorial v1.1_101] A choice variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_101/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-choice-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_101~1..v1.1_101))
|
||||
- [[tutorial v1.1_102] A web_address variable ](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_102/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-web_address-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_102~1..v1.1_102))
|
||||
- Validators
|
||||
- [[tutorial v1.1_103] A variable with custom validation](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_103/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-variable-with-custom-validation) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_103~1..v1.1_103))
|
||||
- Namespace
|
||||
- [[tutorial v1.1_110] Namespace](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_110/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#namespace) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_110~1..v1.1_110))
|
||||
- [[tutorial v1.1_111] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_111/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#xxx) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_111~1..v1.1_111))
|
||||
- [[tutorial v1.1_112] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_112/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#xxx) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_112~1..v1.1_112))
|
||||
- [[tutorial v1.1_113] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_113/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#xxx) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_113~1..v1.1_113))
|
||||
- [[tutorial v1.1_114] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_114/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#xxx) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_114~1..v1.1_114))
|
||||
- [[tutorial v1.1_120] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#xxx) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_120~1..v1.1_120))
|
||||
## Structure
|
||||
|
||||
|
||||
|
||||
<p>
|
||||
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_080/./">.</a><br/>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_080/./firefox/">firefox</a><br/>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_080/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_080/./firefox/10-manual.yml">10-manual.yml</a><br/>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_080/./firefox/20-manual.yml">20-manual.yml</a><br/>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_080/./firefox/30-auto.yml">30-auto.yml</a><br/>
|
||||
<br/><br/></p>
|
||||
|
||||
Contents of the firefox/30-auto.yml file
|
||||
|
||||
```yml
|
||||
%YAML 1.2
|
||||
---
|
||||
version: 1.1
|
||||
|
||||
auto:
|
||||
description: Automatic proxy configuration URL
|
||||
type: web_address
|
||||
disabled:
|
||||
variable: _.proxy_mode
|
||||
when_not: Automatic proxy configuration URL
|
||||
...
|
||||
|
||||
```
|
||||
### Let's generate the documentation
|
||||
|
||||
```shell
|
||||
rougail -m firefox/ -o doc
|
||||
```
|
||||
| Variable | Description |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **<a id="proxy_mode" name="proxy_mode">proxy_mode</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet.<br/>**Choices**: <br/>• No proxy **← (default)**<br/>• Auto-detect proxy settings for this network<br/>• Use system proxy settings<br/>• Manual proxy configuration<br/>• Automatic proxy configuration URL |
|
||||
|
||||
#### Manual proxy configuration
|
||||
|
||||
> **🛈 Informations**
|
||||
>
|
||||
> **Path**: manual\
|
||||
> *`disabled`*\
|
||||
> **Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" hasn't the value "Manual proxy configuration"
|
||||
|
||||
##### HTTP Proxy
|
||||
|
||||
> **🛈 Informations**
|
||||
>
|
||||
> **Path**: manual.http_proxy
|
||||
|
||||
| Variable | Description |
|
||||
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **<a id="manual.http_proxy.address" name="manual.http_proxy.address">manual.http_proxy.address</a>**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address.<br/>**Validators**: <br/>• type domainname<br/>• the domain name can be an IP |
|
||||
| **<a id="manual.http_proxy.port" name="manual.http_proxy.port">manual.http_proxy.port</a>**<br/>[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP Port.<br/>**Validators**: <br/>• well-known ports (1 to 1023) are allowed<br/>• registred ports (1024 to 49151) are allowed<br/>• private ports (greater than 49152) are allowed<br/>**Default**: 8080 |
|
||||
|
||||
| Variable | Description |
|
||||
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|
|
||||
| **<a id="manual.use_for_https" name="manual.use_for_https">manual.use_for_https</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Also use this proxy for HTTPS.<br/>**Default**: true |
|
||||
|
||||
##### *HTTPS* Proxy or *SOCKS* Proxy
|
||||
|
||||
> **🛈 Informations**
|
||||
>
|
||||
> This family builds families dynamically.\
|
||||
> **Path**:
|
||||
> - manual.*https*_proxy
|
||||
> - manual.*socks*_proxy\
|
||||
> *`hidden`*\
|
||||
> **Hidden**: in HTTPS case if "[Also use this proxy for HTTPS](#manual.use_for_https)" is set to "true"\
|
||||
> **Identifiers**:
|
||||
> - HTTPS
|
||||
> - SOCKS
|
||||
|
||||
| Variable | Description |
|
||||
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **<a id="manual.:::identifier:::_proxy.address" name="manual.:::identifier:::_proxy.address">manual.*https*_proxy.address</a>**<br/>**manual.*socks*_proxy.address**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | *HTTPS* or *SOCKS* address.<br/>**Validators**: <br/>• type domainname<br/>• the domain name can be an IP<br/>**Default**: the value of the variable "[HTTP address](#manual.http_proxy.address)" |
|
||||
| **<a id="manual.:::identifier:::_proxy.port" name="manual.:::identifier:::_proxy.port">manual.*https*_proxy.port</a>**<br/>**manual.*socks*_proxy.port**<br/>[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | *HTTPS* or *SOCKS* port.<br/>**Validators**: <br/>• well-known ports (1 to 1023) are allowed<br/>• registred ports (1024 to 49151) are allowed<br/>• private ports (greater than 49152) are allowed<br/>**Default**: the value of the variable "[HTTP Port](#manual.http_proxy.port)" |
|
||||
| **<a id="manual.:::identifier:::_proxy.version" name="manual.:::identifier:::_proxy.version">manual.*https*_proxy.version</a>**<br/>**manual.*socks*_proxy.version**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | SOCKS host version used by proxy.<br/>**Choices**: <br/>• v4<br/>• v5 **← (default)**<br/>**Disabled**: when the identifier is "HTTPS" |
|
||||
|
||||
| Variable | Description |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **<a id="auto" name="auto">auto</a>**<br/>[`web address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Automatic proxy configuration URL.<br/>**Validators**: <br/>• well-known ports (1 to 1023) are allowed<br/>• registred ports (1024 to 49151) are allowed<br/>• type domainname<br/>• the domain name can be a hostname<br/>**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" hasn't the value "Automatic proxy configuration URL" |
|
||||
|
||||
### Let's generate the changelog
|
||||
|
||||
```shell
|
||||
rougail -m firefox/ -o doc --doc.contents changelog
|
||||
```
|
||||
#### New variable
|
||||
|
||||
| Variable | Description |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **<a id="auto" name="auto">auto</a>**<br/>[`web address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Automatic proxy configuration URL.<br/>**Validators**: <br/>• well-known ports (1 to 1023) are allowed<br/>• registred ports (1024 to 49151) are allowed<br/>• type domainname<br/>• the domain name can be a hostname<br/>**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" hasn't the value "Automatic proxy configuration URL" |
|
||||
|
||||
|
||||
## User datas
|
||||
|
||||
### Example 1
|
||||
|
||||
#### config/01/config.yml
|
||||
|
||||
|
||||
```yml
|
||||
---
|
||||
auto: https://auto.proxy.net/wpad.dat
|
||||
```
|
||||
#### Output
|
||||
|
||||
```shell
|
||||
rougail -m firefox/ -u yaml -yf config/01/config.yml
|
||||
```
|
||||
<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
|
||||
<span style="color: #ffff00">┗━━ </span>variable "auto" (Automatic proxy configuration URL) is disabled, it will be
|
||||
<span style="color: #ffff00"> </span>ignored when loading from the YAML file "config/01/config.yml"
|
||||
╭──────────────────── Caption ─────────────────────╮
|
||||
│ <span style="color: #ff0000">Undocumented but modified variable</span> <span style="color: #ffd700">Default value</span> │
|
||||
╰──────────────────────────────────────────────────╯
|
||||
Variables:
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Configure Proxy Access to the Internet</span>: <span style="color: #ffd700">No proxy</span>
|
||||
</pre>
|
||||
### Example 2
|
||||
|
||||
#### config/02/config.yml
|
||||
|
||||
|
||||
```yml
|
||||
---
|
||||
proxy_mode: Automatic proxy configuration URL
|
||||
```
|
||||
#### Output
|
||||
|
||||
```shell
|
||||
rougail -m firefox/ -u yaml -yf config/02/config.yml
|
||||
```
|
||||
<pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
|
||||
<span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value:
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>Automatic proxy configuration URL
|
||||
</pre>
|
||||
### Example 3
|
||||
|
||||
#### config/03/config.yml
|
||||
|
||||
|
||||
```yml
|
||||
---
|
||||
proxy_mode: Automatic proxy configuration URL
|
||||
auto: https://auto.proxy.net/wpad.dat
|
||||
```
|
||||
#### Output
|
||||
|
||||
```shell
|
||||
rougail -m firefox/ -u yaml -yf config/03/config.yml
|
||||
```
|
||||
<pre>╭─────────────────────────── Caption ────────────────────────────╮
|
||||
│ <span style="color: #ff0000">Undocumented but modified variable</span> <span style="color: #00aa00">Modified value</span> │
|
||||
│ (⏳ Original default value) │
|
||||
╰────────────────────────────────────────────────────────────────╯
|
||||
Variables:
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Configure Proxy Access to the Internet</span>: <span style="color: #00aa00">Automatic proxy configuration URL</span>
|
||||
<span style="color: #5c5cff">┃ </span>◀ loaded from the YAML file "config/03/config.yml" (⏳ No proxy)
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Automatic proxy configuration URL</span>: <span style="color: #00aa00">https://auto.proxy.net/wpad.dat</span> ◀
|
||||
<span style="color: #5c5cff"> </span>loaded from the YAML file "config/03/config.yml"
|
||||
</pre>
|
||||
|
||||
|
||||
- [[tutorial v1.1_090] A conditional disabled variable with type domainname and parameters](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_090~1..v1.1_090))
|
||||
|
|
|
|||
1
config/01/cmd_ro.txt
Normal file
1
config/01/cmd_ro.txt
Normal file
|
|
@ -0,0 +1 @@
|
|||
rougail -m firefox/ -u yaml -yf config/01/config.yml
|
||||
2
config/01/config.yml
Normal file
2
config/01/config.yml
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
---
|
||||
auto: https://auto.proxy.net/wpad.dat
|
||||
9
config/01/output_ro.html
Normal file
9
config/01/output_ro.html
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
|
||||
<span style="color: #ffff00">┗━━ </span>variable "auto" (Automatic proxy configuration URL) is disabled, it will be
|
||||
<span style="color: #ffff00"> </span>ignored when loading from the YAML file "config/01/config.yml"
|
||||
╭──────────────────── Caption ─────────────────────╮
|
||||
│ <span style="color: #ff0000">Undocumented but modified variable</span> <span style="color: #ffd700">Default value</span> │
|
||||
╰──────────────────────────────────────────────────╯
|
||||
Variables:
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Configure Proxy Access to the Internet</span>: <span style="color: #ffd700">No proxy</span>
|
||||
</pre>
|
||||
1
config/02/cmd_ro.txt
Normal file
1
config/02/cmd_ro.txt
Normal file
|
|
@ -0,0 +1 @@
|
|||
rougail -m firefox/ -u yaml -yf config/02/config.yml
|
||||
2
config/02/config.yml
Normal file
2
config/02/config.yml
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
---
|
||||
proxy_mode: Automatic proxy configuration URL
|
||||
4
config/02/output_ro.html
Normal file
4
config/02/output_ro.html
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
<pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
|
||||
<span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value:
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>Automatic proxy configuration URL
|
||||
</pre>
|
||||
1
config/03/cmd_ro.txt
Normal file
1
config/03/cmd_ro.txt
Normal file
|
|
@ -0,0 +1 @@
|
|||
rougail -m firefox/ -u yaml -yf config/03/config.yml
|
||||
3
config/03/config.yml
Normal file
3
config/03/config.yml
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
---
|
||||
proxy_mode: Automatic proxy configuration URL
|
||||
auto: https://auto.proxy.net/wpad.dat
|
||||
10
config/03/output_ro.html
Normal file
10
config/03/output_ro.html
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
<pre>╭─────────────────────────── Caption ────────────────────────────╮
|
||||
│ <span style="color: #ff0000">Undocumented but modified variable</span> <span style="color: #00aa00">Modified value</span> │
|
||||
│ (⏳ Original default value) │
|
||||
╰────────────────────────────────────────────────────────────────╯
|
||||
Variables:
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Configure Proxy Access to the Internet</span>: <span style="color: #00aa00">Automatic proxy configuration URL</span>
|
||||
<span style="color: #5c5cff">┃ </span>◀ loaded from the YAML file "config/03/config.yml" (⏳ No proxy)
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Automatic proxy configuration URL</span>: <span style="color: #00aa00">https://auto.proxy.net/wpad.dat</span> ◀
|
||||
<span style="color: #5c5cff"> </span>loaded from the YAML file "config/03/config.yml"
|
||||
</pre>
|
||||
BIN
firefox.png
BIN
firefox.png
Binary file not shown.
|
Before Width: | Height: | Size: 123 KiB After Width: | Height: | Size: 118 KiB |
14
firefox/00-proxy.yml
Normal file
14
firefox/00-proxy.yml
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
%YAML 1.2
|
||||
---
|
||||
version: 1.1
|
||||
|
||||
proxy_mode:
|
||||
description: Configure Proxy Access to the Internet
|
||||
choices:
|
||||
- No proxy
|
||||
- Auto-detect proxy settings for this network
|
||||
- Use system proxy settings
|
||||
- Manual proxy configuration
|
||||
- Automatic proxy configuration URL
|
||||
default: No proxy
|
||||
...
|
||||
23
firefox/10-manual.yml
Normal file
23
firefox/10-manual.yml
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
%YAML 1.2
|
||||
---
|
||||
version: 1.1
|
||||
|
||||
manual:
|
||||
description: Manual proxy configuration
|
||||
disabled:
|
||||
variable: _.proxy_mode
|
||||
when_not: Manual proxy configuration
|
||||
|
||||
http_proxy: # HTTP Proxy
|
||||
|
||||
address:
|
||||
description: HTTP address
|
||||
type: domainname
|
||||
params:
|
||||
allow_ip: true
|
||||
|
||||
port:
|
||||
description: HTTP Port
|
||||
type: port
|
||||
default: 8080
|
||||
...
|
||||
43
firefox/20-manual.yml
Normal file
43
firefox/20-manual.yml
Normal file
|
|
@ -0,0 +1,43 @@
|
|||
%YAML 1.2
|
||||
---
|
||||
version: 1.1
|
||||
|
||||
manual:
|
||||
|
||||
use_for_https: true # Also use this proxy for HTTPS
|
||||
|
||||
'{{ identifier }}_proxy':
|
||||
description: '{{ identifier }} Proxy'
|
||||
hidden:
|
||||
jinja: |-
|
||||
{% if my_identifier == 'HTTPS' and _.use_for_https %}
|
||||
HTTPS is same has HTTP
|
||||
{% endif %}
|
||||
description: in HTTPS case if "_.use_for_https" is set to "true"
|
||||
params:
|
||||
my_identifier:
|
||||
type: identifier
|
||||
dynamic:
|
||||
- HTTPS
|
||||
- SOCKS
|
||||
|
||||
address:
|
||||
description: '{{ identifier }} address'
|
||||
default:
|
||||
variable: __.http_proxy.address
|
||||
|
||||
port:
|
||||
description: '{{ identifier }} port'
|
||||
default:
|
||||
variable: __.http_proxy.port
|
||||
|
||||
version:
|
||||
description: SOCKS host version used by proxy
|
||||
choices:
|
||||
- v4
|
||||
- v5
|
||||
default: v5
|
||||
disabled:
|
||||
type: identifier
|
||||
when: HTTPS
|
||||
...
|
||||
11
firefox/30-auto.yml
Normal file
11
firefox/30-auto.yml
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
%YAML 1.2
|
||||
---
|
||||
version: 1.1
|
||||
|
||||
auto:
|
||||
description: Automatic proxy configuration URL
|
||||
type: web_address
|
||||
disabled:
|
||||
variable: _.proxy_mode
|
||||
when_not: Automatic proxy configuration URL
|
||||
...
|
||||
5
install.txt
Normal file
5
install.txt
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
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
|
||||
47
tree.html
Normal file
47
tree.html
Normal file
|
|
@ -0,0 +1,47 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<meta name="Author" content="Made by 'tree'">
|
||||
<meta name="GENERATOR" content="tree v2.2.1 © 1996 - 2024 by Steve Baker, Thomas Moore, Francesc Rocher, Florian Sesser, Kyosuke Tokoro">
|
||||
<title>Directory Tree</title>
|
||||
<style type="text/css">
|
||||
BODY { font-family : monospace, sans-serif; color: black;}
|
||||
P { font-family : monospace, sans-serif; color: black; margin:0px; padding: 0px;}
|
||||
A:visited { text-decoration : none; margin : 0px; padding : 0px;}
|
||||
A:link { text-decoration : none; margin : 0px; padding : 0px;}
|
||||
A:hover { text-decoration: underline; background-color : yellow; margin : 0px; padding : 0px;}
|
||||
A:active { margin : 0px; padding : 0px;}
|
||||
.VERSION { font-size: small; font-family : arial, sans-serif; }
|
||||
.NORM { color: black; }
|
||||
.FIFO { color: purple; }
|
||||
.CHAR { color: yellow; }
|
||||
.DIR { color: blue; }
|
||||
.BLOCK { color: yellow; }
|
||||
.LINK { color: aqua; }
|
||||
.SOCK { color: fuchsia;}
|
||||
.EXEC { color: green; }
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<h1>Directory Tree</h1><p>
|
||||
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_080/./">.</a><br>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_080/./firefox/">firefox</a><br>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_080/./firefox/00-proxy.yml">00-proxy.yml</a><br>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_080/./firefox/10-manual.yml">10-manual.yml</a><br>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_080/./firefox/20-manual.yml">20-manual.yml</a><br>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_080/./firefox/30-auto.yml">30-auto.yml</a><br>
|
||||
<br><br><p>
|
||||
|
||||
2 directories, 4 files
|
||||
|
||||
</p>
|
||||
<hr>
|
||||
<p class="VERSION">
|
||||
tree v2.2.1 © 1996 - 2024 by Steve Baker and Thomas Moore <br>
|
||||
HTML output hacked and copyleft © 1998 by Francesc Rocher <br>
|
||||
JSON output hacked and copyleft © 2014 by Florian Sesser <br>
|
||||
Charsets / OS/2 support © 2001 by Kyosuke Tokoro
|
||||
</p>
|
||||
</body>
|
||||
</html>
|
||||
Loading…
Reference in a new issue