diff --git a/README.md b/README.md index e685199b..0d45ea2f 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,24 @@ -- [List of all the tutorial steps](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md) -- [[Previous tutorial v1.1_230] Username is mandatory if a password is set](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_230/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_231~1..v1.1_231)) +# Description -# [tutorial v1.1_231] redefines the behavior to password mandatory if the user is defined +This tutorial shows to you an example of Rougail use on how to set a proxy in the Mozilla Firefox browser. -- [Read the tutorial "redefines the behavior to password mandatory if the user is defined" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html#redefines-the-behavior-to-password-mandatory-if-the-user-is-defined) -- [View the changes in the files](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_231~1..v1.1_231) +More precisely, this tutorial aims at reproducing this [Mozilla Firefox](https://www.mozilla.org/firefox/new/) settings page: +![Firefox Proxy setting](firefox.png) -## Screenshot -Firefox Proxy setting +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. -## Clone and install +This is what the page looks like: + +![Foxyproxy Proxy setting](foxyproxy.png) + +# Installation To test this tutorial, you need to download this repository and install Rougail: -```shell +```bash git clone -b 1.1 https://forge.cloud.silique.fr/stove/rougail-tutorials.git cd rougail-tutorials python -m venv venv_rougail @@ -23,233 +26,88 @@ python -m venv venv_rougail pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user-data-yaml ``` -Then switch to the tutorial page: +# Summary -```shell -git switch --detach v1.1_231 -``` +Each step is a separerate commit. You can navigate to history to discover different aspect to the Rougail format. -## Structure +- Getting started ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html)) + - [[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 possible values ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/choice.html)) + - [[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/choice.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 ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/family.html)) + - [[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/family.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/family.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/family.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)) +- Some suitable types ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/types.html)) + - [[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/types.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/types.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/types.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/types.html#a-variable-with-type-boolean) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_033~1..v1.1_033)) +- Calculated default value for a variable ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculated.html)) + - [[tutorial v1.1_040] HTTPS family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_040/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculated.html#https-family) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_040~1..v1.1_040)) + - [[tutorial v1.1_041] A default value calculated from another variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_041/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculated.html#a-default-value-calculated-from-another-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_041~1..v1.1_041)) +- Define access to variable or family ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/properties.html)) + - [[tutorial v1.1_050] A disabled family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_050/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/properties.html#a-disabled-family) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_050~1..v1.1_050)) + - [[tutorial v1.1_051] A conditional disabled family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_051/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/properties.html#a-conditional-disabled-family) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_051~1..v1.1_051)) + - [[tutorial v1.1_052] A hidden family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_052/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/properties.html#a-hidden-family) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_052~1..v1.1_052)) + - [[tutorial v1.1_053] A conditional hidden family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_053/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/properties.html#a-conditional-hidden-family) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_053~1..v1.1_053)) +- A dynamically built family ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/dynfam.html)) + - [[tutorial v1.1_060] Family: A dynamically built 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-dynamically-built-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 ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html)) + - [[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/jinja.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/jinja.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/jinja.html#jinja-with-a-parameter) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_072~1..v1.1_072)) + - [[tutorial v1.1_073] Jinja could returns a boolean](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_073/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#jinja-could-returns-a-boolean) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_073~1..v1.1_073)) +- Custom type ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/customtype.html)) + - [[tutorial v1.1_080] HTTP Proxy with "proxy" type](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_080/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/customtype.html#http-proxy-with-proxy-type) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_080~1..v1.1_080)) + - [[tutorial v1.1_081] HTTPS and SOCKS Proxy with "proxy" type](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_081/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/customtype.html#https-and-socks-proxy-with-proxy-type) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_081~1..v1.1_081)) + - [[tutorial v1.1_082] Add a variable in a family with custom type](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_082/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/customtype.html#add-a-variable-in-a-family-with-custom-type) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_082~1..v1.1_082)) + - [[tutorial v1.1_083] Redefine default value in custom type variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_083/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/customtype.html#redefine-default-value-in-custom-type-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_083~1..v1.1_083)) + - [[tutorial v1.1_084] Redefine other parameter in custom type for HTTP](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_084/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/customtype.html#redefine-other-parameter-in-custom-type-for-http) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_084~1..v1.1_084)) + - [[tutorial v1.1_085] Redefine other parameter in custom type for HTTPS and SOCKS](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_085/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/customtype.html#redefine-other-parameter-in-custom-type-for-https-and-socks) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_085~1..v1.1_085)) +- Nullable variable ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html)) + - [[tutorial v1.1_090] Variable with the value "null"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html#variable-with-the-value-null) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_090~1..v1.1_090)) + - [[tutorial v1.1_091] Variables disabled when condition is null](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_091/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html#variables-disabled-when-condition-is-null) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_091~1..v1.1_091)) +- A web_address variable ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html)) + - [[tutorial v1.1_100] A conditional disabled variable with type web_address](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html#a-conditional-disabled-variable-with-type-web_address) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_100~1..v1.1_100)) +- Variable with multiple values ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html)) + - [[tutorial v1.1_110] A conditional disabled non mandatory variable with type domainname and parameters](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_110/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html#a-conditional-disabled-non-mandatory-variable-with-type-domainname-and-parameters) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_110~1..v1.1_110)) + - [[tutorial v1.1_111] A variable with multiple values](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_111/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html#a-variable-with-multiple-values) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_111~1..v1.1_111)) +- A full documented variable ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html)) + - [[tutorial v1.1_120] Examples](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html#examples) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_120~1..v1.1_120)) + - [[tutorial v1.1_121] Help](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_121/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html#help) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_121~1..v1.1_121)) +- Practice ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html)) + - [[tutorial v1.1_130] A conditional disabled boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_130/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html#a-conditional-disabled-boolean-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_130~1..v1.1_130)) + - [[tutorial v1.1_131] A boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_131/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html#a-boolean-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_131~1..v1.1_131)) + - [[tutorial v1.1_132] A Jinja conditional disabled boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_132/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html#a-jinja-conditional-disabled-boolean-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_132~1..v1.1_132)) +- The Jinja propertyerror filter ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html)) + - [[tutorial v1.1_140] Disabled a variable when an other variable are disabled](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_140/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html#disabled-a-variable-when-an-other-variable-are-disabled) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_140~1..v1.1_140)) +- Mode ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html)) + - [[tutorial v1.1_150] A variable in avanced mode](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_150/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html#a-variable-in-avanced-mode) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_150~1..v1.1_150)) +- Practice ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html)) + - [[tutorial v1.1_160] A boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_160/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html#a-boolean-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_160~1..v1.1_160)) + - [[tutorial v1.1_161] A choice variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_161/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html#a-choice-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_161~1..v1.1_161)) + - [[tutorial v1.1_162] A web_address variable ](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_162/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html#a-web_address-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_162~1..v1.1_162)) +- Validators ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html)) + - [[tutorial v1.1_170] A variable with custom validation](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_170/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html#a-variable-with-custom-validation) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_170~1..v1.1_170)) +- Namespace ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html)) + - [[tutorial v1.1_180] Namespace](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_180/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html#namespace) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_180~1..v1.1_180)) + - [[tutorial v1.1_181] New "FoxyProxy" namespace](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_181/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html#new-foxyproxy-namespace) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_181~1..v1.1_181)) +- A leadership family ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html)) + - [[tutorial v1.1_190] A leadership family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_190/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html#a-leadership-family) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_190~1..v1.1_190)) +- Regexp type with calculation ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html)) + - [[tutorial v1.1_200] Regexp type](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_200/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html#regexp-type) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_200~1..v1.1_200)) + - [[tutorial v1.1_201] Calculate a random color](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_201/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html#calculate-a-random-color) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_201~1..v1.1_201)) + - [[tutorial v1.1_202] Auto save value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_202/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html#auto-save-value) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_202~1..v1.1_202)) +- A variable name with a known variable's attribute ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html)) + - [[tutorial v1.1_210] A variable name that conflict with a known the variable's attribute "type"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_210/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html#a-variable-name-that-conflict-with-a-known-the-variable's-attribute-type) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_210~1..v1.1_210)) +- Variable calculation with propertyerror ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html)) + - [[tutorial v1.1_220] Variable calculation with propertyerror](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_220/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html#variable-calculation-with-propertyerror) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_220~1..v1.1_220)) +- Redefine variable ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html)) + - [[tutorial v1.1_230] Username is mandatory if a password is set](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_230/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html#username-is-mandatory-if-a-password-is-set) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_230~1..v1.1_230)) + - [[tutorial v1.1_231] redefines the behavior to password mandatory if the user is defined](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_231/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html#redefines-the-behavior-to-password-mandatory-if-the-user-is-defined) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_231~1..v1.1_231)) -

-.
- ├── firefox
- │   ├── 00-proxy.yml
- │   ├── 10-manual.yml
- │   ├── 20-manual.yml
- │   ├── 30-auto.yml
- │   ├── 40-no_proxy.yml
- │   ├── 50-prompt_authentication.yml
- │   ├── 55-proxy_dns_socks5.yml
- │   └── 60-dns_over_https.yml
- ├── foxyproxy
- │   ├── 00-foxyproxy.yml
- │   └── 10-redefine.yml
- └── types
-     └── proxy
-         └── 00-type.yml
-

- -Contents of the foxyproxy/10-redefine.yml file - -```yml -%YAML 1.2 ---- -version: 1.1 - -proxies: - - username: - redefine: true - mandatory: false - - password: - redefine: true - hidden: - jinja: |- - {{ not _.username }} - return_type: boolean - description: if username is empty -... - -``` - -*** -### Let's generate the documentation - -```shell -rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/proxy --modes_level basic standard advanced -o doc -``` -[View the documentation file](DOCUMENTATION.md) - - -*** -### Let's generate the changelog - -```shell -rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/proxy --modes_level basic standard advanced -o doc --doc.contents changelog --doc.changelog.previous_json_file previous.yml -``` -[View the changelog file](CHANGELOG.md) - -*** -## User datas - -### Example 1 - -#### config/01/config.yml - - -```yml ---- -``` - -*** -#### Output - -```shell -rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/proxy --modes_level basic standard advanced -u yaml -yf config/01/config.yml -``` -> [!NOTE] -> -> **Caption:** -> - Variable -> - Default value - -Variables: -- :open_file_folder: firefox (Firefox) - - :notebook: proxy_mode (Configure Proxy Access to the Internet): No proxy - - :open_file_folder: dns_over_https (DNS over HTTPS) - - :notebook: enable_dns_over_https (Enable DNS over HTTPS): false -- :open_file_folder: foxyproxy (FoxyProxy) - - :open_file_folder: proxies (Proxy configuration): [] - -*** -### Example 2 - -#### config/02/config.yml - - -```yml ---- -foxyproxy: - proxies: - - title: My company - type: HTTP - color: '#66cc66' - address: proxy.company.net - port: 8080 - username: one_user - password: P4ssW0rD - - title: An other company - type: HTTP - address: proxy.company.net - port: 8080 -``` - -*** -#### Output - -```shell -rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/proxy --modes_level basic standard advanced -u yaml -yf config/02/config.yml -``` -> [!NOTE] -> -> **Caption:** -> - Variable -> - Unmodifiable variable -> - Default value -> - Modified value -> - (:hourglass_flowing_sand: Original default value) - -Variables: -- :open_file_folder: firefox (Firefox) - - :notebook: proxy_mode (Configure Proxy Access to the Internet): No proxy - - :open_file_folder: dns_over_https (DNS over HTTPS) - - :notebook: enable_dns_over_https (Enable DNS over HTTPS): false -- :open_file_folder: foxyproxy (FoxyProxy) - - :open_file_folder: proxies (Proxy configuration) - - :open_file_folder: title (Title or Description) - - :notebook: title (Title or Description): My company ← loaded from the YAML file "config/02/config.yml" - - :notebook: type (Proxy Type): HTTP ← loaded from the YAML file "config/02/config.yml" (:hourglass_flowing_sand: Direct (no proxy)) - - :notebook: color (Color): #66cc66 ← loaded from the YAML file "config/02/config.yml" - - :notebook: address (IP address, DNS name, server name): proxy.company.net ← loaded from the YAML file "config/02/config.yml" - - :notebook: port (Port): 8080 ← loaded from the YAML file "config/02/config.yml" - - :notebook: username (Username): one_user ← loaded from the YAML file "config/02/config.yml" - - :notebook: password (Password): ********** ← loaded from the YAML file "config/02/config.yml" - - :open_file_folder: title (Title or Description) - - :notebook: title (Title or Description): An other company ← loaded from the YAML file "config/02/config.yml" - - :notebook: type (Proxy Type): HTTP ← loaded from the YAML file "config/02/config.yml" (:hourglass_flowing_sand: Direct (no proxy)) - - :notebook: color (Color): #59f43d - - :notebook: address (IP address, DNS name, server name): proxy.company.net ← loaded from the YAML file "config/02/config.yml" - - :notebook: port (Port): 8080 ← loaded from the YAML file "config/02/config.yml" - - :notebook: username (Username): null - - :notebook: password (Password): null - -*** -### Example 3 - -#### config/03/config.yml - - -```yml ---- -foxyproxy: - proxies: - - title: My company - type: HTTP - color: '#66cc66' - address: proxy.company.net - port: 8080 - password: P4ssW0rD - - title: An other company - type: HTTP - address: proxy.company.net - port: 8080 -``` - -*** -#### Output - -```shell -rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/proxy --modes_level basic standard advanced -u yaml -yf config/03/config.yml -``` -> [!WARNING] -> -> - foxyproxy (FoxyProxy) -> - proxies (Proxy configuration) -> - password (Password): :bell: variable "password" (Password) at index "0" is hidden, it will be ignored when loading from the YAML file "config/03/config.yml" - -> [!NOTE] -> -> **Caption:** -> - Variable -> - Unmodifiable variable -> - Default value -> - Modified value -> - (:hourglass_flowing_sand: Original default value) - -Variables: -- :open_file_folder: firefox (Firefox) - - :notebook: proxy_mode (Configure Proxy Access to the Internet): No proxy - - :open_file_folder: dns_over_https (DNS over HTTPS) - - :notebook: enable_dns_over_https (Enable DNS over HTTPS): false -- :open_file_folder: foxyproxy (FoxyProxy) - - :open_file_folder: proxies (Proxy configuration) - - :open_file_folder: title (Title or Description) - - :notebook: title (Title or Description): My company ← loaded from the YAML file "config/03/config.yml" - - :notebook: type (Proxy Type): HTTP ← loaded from the YAML file "config/03/config.yml" (:hourglass_flowing_sand: Direct (no proxy)) - - :notebook: color (Color): #66cc66 ← loaded from the YAML file "config/03/config.yml" - - :notebook: address (IP address, DNS name, server name): proxy.company.net ← loaded from the YAML file "config/03/config.yml" - - :notebook: port (Port): 8080 ← loaded from the YAML file "config/03/config.yml" - - :notebook: username (Username): null - - :notebook: password (Password): null - - :open_file_folder: title (Title or Description) - - :notebook: title (Title or Description): An other company ← loaded from the YAML file "config/03/config.yml" - - :notebook: type (Proxy Type): HTTP ← loaded from the YAML file "config/03/config.yml" (:hourglass_flowing_sand: Direct (no proxy)) - - :notebook: color (Color): #44933d - - :notebook: address (IP address, DNS name, server name): proxy.company.net ← loaded from the YAML file "config/03/config.yml" - - :notebook: port (Port): 8080 ← loaded from the YAML file "config/03/config.yml" - - :notebook: username (Username): null - - :notebook: password (Password): null - -*** diff --git a/firefox.png b/firefox.png index d368003e..050f837f 100644 Binary files a/firefox.png and b/firefox.png differ diff --git a/firefox/00-proxy.yml b/firefox/00-proxy.yml deleted file mode 100644 index 92b75f58..00000000 --- a/firefox/00-proxy.yml +++ /dev/null @@ -1,14 +0,0 @@ -%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 -... diff --git a/firefox/10-manual.yml b/firefox/10-manual.yml deleted file mode 100644 index 62069c90..00000000 --- a/firefox/10-manual.yml +++ /dev/null @@ -1,24 +0,0 @@ -%YAML 1.2 ---- -version: 1.1 - -manual: - description: Manual proxy configuration - disabled: - variable: _.proxy_mode - when_not: Manual proxy configuration - - http_proxy: - description: HTTP Proxy - type: proxy - - address: - redefine: true - default: null - description: HTTP proxy address - - port: - redefine: true - default: 8080 - description: HTTP proxy port -... diff --git a/firefox/20-manual.yml b/firefox/20-manual.yml deleted file mode 100644 index 3735fdb6..00000000 --- a/firefox/20-manual.yml +++ /dev/null @@ -1,50 +0,0 @@ -%YAML 1.2 ---- -version: 1.1 - -manual: - - use_for_https: true # Also use this proxy for HTTPS - - https_proxy: - description: HTTPS Proxy - type: proxy - hidden: - variable: _.use_for_https - - address: - redefine: true - description: HTTPS proxy address - - port: - redefine: true - description: HTTPS proxy port - - socks_proxy: - description: SOCKS Proxy - type: proxy - - address: - redefine: true - description: SOCKS proxy address - default: null - mandatory: false - - port: - redefine: true - description: SOCKS proxy port - default: 1080 - disabled: - variable: _.address - when: null - - version: - description: SOCKS host version used by proxy - choices: - - v4 - - v5 - default: v5 - disabled: - variable: _.address - when: null -... diff --git a/firefox/30-auto.yml b/firefox/30-auto.yml deleted file mode 100644 index 50961391..00000000 --- a/firefox/30-auto.yml +++ /dev/null @@ -1,11 +0,0 @@ -%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 -... diff --git a/firefox/40-no_proxy.yml b/firefox/40-no_proxy.yml deleted file mode 100644 index 55a57242..00000000 --- a/firefox/40-no_proxy.yml +++ /dev/null @@ -1,23 +0,0 @@ -%YAML 1.2 ---- -version: 1.1 - -no_proxy: - description: Address for which proxy will be desactivated - help: Connections to localhost, 127.0.0.1/8 and ::1 are never proxied - examples: - - .mozilla.org - - .net.nz - - 192.168.1.0/24 - type: domainname - params: - allow_ip: true - allow_cidr_network: true - allow_without_dot: true - allow_startswith_dot: true - multi: true - mandatory: false - disabled: - variable: _.proxy_mode - when: No proxy -... diff --git a/firefox/50-prompt_authentication.yml b/firefox/50-prompt_authentication.yml deleted file mode 100644 index 57a548e6..00000000 --- a/firefox/50-prompt_authentication.yml +++ /dev/null @@ -1,11 +0,0 @@ -%YAML 1.2 ---- -version: 1.1 - -prompt_authentication: - description: Prompt for authentication if password is saved - default: true - disabled: - variable: _.proxy_mode - when: No proxy -... diff --git a/firefox/55-proxy_dns_socks5.yml b/firefox/55-proxy_dns_socks5.yml deleted file mode 100644 index 02d28232..00000000 --- a/firefox/55-proxy_dns_socks5.yml +++ /dev/null @@ -1,16 +0,0 @@ -%YAML 1.2 ---- -version: 1.1 - -proxy_dns_socks5: - description: Use proxy DNS when using SOCKS v5 - mode: advanced - default: false - disabled: - jinja: |- - {{ _.manual.socks_proxy.version is propertyerror or _.manual.socks_proxy.version == 'v4' }} - return_type: boolean - description: |- - if "_.proxy_mode" is not "Manual proxy configuration" - or "_.manual.socks_proxy.version" is "v4" -... diff --git a/firefox/60-dns_over_https.yml b/firefox/60-dns_over_https.yml deleted file mode 100644 index bc033240..00000000 --- a/firefox/60-dns_over_https.yml +++ /dev/null @@ -1,33 +0,0 @@ -%YAML 1.2 ---- -version: 1.1 - -dns_over_https: # DNS over HTTPS - - enable_dns_over_https: false # Enable DNS over HTTPS - - provider: - description: Use Provider - choices: - - Cloudflare - - NextDNS - - Custom - default: Cloudflare - disabled: - variable: _.enable_dns_over_https - when: false - - custom_dns_url: - description: Custom DNS URL - type: web_address - validators: - - jinja: |- - {{ _.custom_dns_url.startswith("http://") }} - return_type: boolean - description: must starts with 'https://' only - disabled: - jinja: |- - {{ _.provider is propertyerror or _.provider != 'Custom' }} - return_type: boolean - description: if "_.provider" is not "Custom" -... diff --git a/foxyproxy/00-foxyproxy.yml b/foxyproxy/00-foxyproxy.yml deleted file mode 100644 index 14f63f37..00000000 --- a/foxyproxy/00-foxyproxy.yml +++ /dev/null @@ -1,127 +0,0 @@ -%YAML 1.2 ---- -version: 1.1 - -proxies: - description: Proxy configuration - _type: leadership - - title: - description: Title or Description - mandatory: false - - type: - description: Proxy Type - choices: - - HTTP - - HTTPS/SSL - - SOCKS4 - - SOCKS5 - - PAC URL - - WPAD - - System (use system settings) - - Direct (no proxy) - default: Direct (no proxy) - - color: - description: Color - regexp: ^#(?:[0-9a-f]{3}){1,2}$ - default: - jinja: >- - #{%- for i in range(6) -%}{{- '0123456789abcdef' | random -}}{%- endfor -%} - description: random color value - auto_save: true - - address: - description: IP address, DNS name, server name - type: domainname - params: - allow_ip: true - allow_without_dot: true - default: - description: copy HTTP address if proxy is not "Manual" - variable: firefox.manual.http_proxy.address - propertyerror: false - disabled: - jinja: |- - {{ _.type not in ['HTTP', 'HTTPS/SSL', 'SOCKS4', 'SOCKS5'] }} - return_type: boolean - description: |- - if type not in: - - HTTP - - HTTPS/SSL - - SOCKS4 - - SOCKS5 - - port: - description: Port - type: port - default: - description: copy HTTP port if proxy is not "Manual" - variable: firefox.manual.http_proxy.port - propertyerror: false - disabled: - jinja: |- - {{ _.type not in ['HTTP', 'HTTPS/SSL', 'SOCKS4', 'SOCKS5'] }} - return_type: boolean - description: |- - if type not in: - - HTTP - - HTTPS/SSL - - SOCKS4 - - SOCKS5 - - username: - description: Username - type: unix_user - mandatory: - jinja: |- - {% if _.password is not propertyerror and _.password %} - true - {% else %} - false - {% endif %} - return_type: boolean - description: if a password is set - disabled: - jinja: |- - {{ _.type not in ['HTTP', 'HTTPS/SSL', 'SOCKS4', 'SOCKS5'] }} - return_type: boolean - description: |- - if type not in: - - HTTP - - HTTPS/SSL - - SOCKS4 - - SOCKS5 - - password: - description: Password - type: secret - mandatory: false - disabled: - jinja: |- - {{ _.type not in ['HTTP', 'HTTPS/SSL', 'SOCKS4', 'SOCKS5'] }} - return_type: boolean - description: |- - if type not in: - - HTTP - - HTTPS/SSL - - SOCKS4 - - SOCKS5 - - url: - description: URL - type: web_address - default: - description: copy HTTP address if proxy is "Auto" - variable: firefox.auto - propertyerror: false - disabled: - jinja: |- - {{ _.type not in ['PAC URL', 'WPAD'] }} - return_type: boolean - description: |- - if type is not in: - - PAC URL - - WPAD -... diff --git a/foxyproxy/10-redefine.yml b/foxyproxy/10-redefine.yml deleted file mode 100644 index bc50e801..00000000 --- a/foxyproxy/10-redefine.yml +++ /dev/null @@ -1,18 +0,0 @@ -%YAML 1.2 ---- -version: 1.1 - -proxies: - - username: - redefine: true - mandatory: false - - password: - redefine: true - hidden: - jinja: |- - {{ not _.username }} - return_type: boolean - description: if username is empty -... diff --git a/install.txt b/install.txt deleted file mode 100644 index 7f2478c9..00000000 --- a/install.txt +++ /dev/null @@ -1,5 +0,0 @@ -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 diff --git a/tree.html b/tree.html deleted file mode 100644 index bb01f032..00000000 --- a/tree.html +++ /dev/null @@ -1,18 +0,0 @@ -

-.
- ├── firefox
- │   ├── 00-proxy.yml
- │   ├── 10-manual.yml
- │   ├── 20-manual.yml
- │   ├── 30-auto.yml
- │   ├── 40-no_proxy.yml
- │   ├── 50-prompt_authentication.yml
- │   ├── 55-proxy_dns_socks5.yml
- │   └── 60-dns_over_https.yml
- ├── foxyproxy
- │   ├── 00-foxyproxy.yml
- │   └── 10-redefine.yml
- └── types
-     └── proxy
-         └── 00-type.yml
-

\ No newline at end of file