diff --git a/docs/tutorial/customtype.rst b/docs/tutorial/customtype.rst index 8ce7a8d5f..c7a71b0d3 100644 --- a/docs/tutorial/customtype.rst +++ b/docs/tutorial/customtype.rst @@ -106,11 +106,15 @@ Let's modify the existing family using this new `proxy` type: type: proxy ... - We can see that the type declared for the `http_proxy` family is now `type: proxy`. -It's perfectly natural in the Rougail style. +It's perfectly natural in the Rougail style. -But in order to use our new type we need to declare it to Rougail otherwise the new type is not available. +Due to the type definition we can "omit" some settings in the structure file +such as the `domainname` type and the `allow_ip` parameter. +And the `address` variable it is not necessary to be specified at all in the structure file +because it's in the type definition. + +In order to use our new type we need to declare it to Rougail otherwise the new type is not available. The Rougail CLI has the `--types` type declaration command line option for this purpose. Let's launch the Rougail CLI with this command line parameter: @@ -126,28 +130,17 @@ We want the same behavior as usual. :url: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/commit/v1.1_080/config/01/output_ro.html :class: output -The type definition adds nothing to the structural logic. It's just a very convenient way to save time when writing structure files. - -Now in the `address` variable it is not necessary to be specified and all parameters (the `domainname` type and the `allow_ip` parameter) are available: - -.. code-block:: yaml - :caption: We can omit these settings now due to the type definition - - description: HTTP address - type: domainname - params: - allow_ip: true - HTTPS and SOCKS Proxy with "proxy" type --------------------------------------- .. type-along:: For those who follow the tutorial with the help of the git repository - Now you need to checkout the `v1.1_081` version:: + Now you need to checkout the :tutorial:`v1.1_081 ` version: git switch --detach v1.1_081 With this use of a type, it is possible to define our HTTPS and SOCKS Proxy in a much more conscious way: +It's very practical. In fact, the type definition adds nothing else to the structural logic. .. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/commit/v1.1_081/firefox/20-manual.yml :language: yaml @@ -184,7 +177,7 @@ Add a variable in a family with custom type .. type-along:: For those who follow the tutorial with the help of the git repository - Now you need to checkout the `v1.1_082` version:: + Now you need to checkout the :tutorial:`v1.1_082 ` version:: git switch --detach v1.1_082 @@ -209,7 +202,7 @@ Redefine default value in custom type variable .. type-along:: For those who follow the tutorial with the help of the git repository - Now you need to checkout the `v1.1_083` version:: + Now you need to checkout the :tutorial:`v1.1_083 ` version:: git switch --detach v1.1_083 @@ -379,7 +372,7 @@ Redefine other parameter in custom type for HTTP .. type-along:: For those who follow the tutorial with the help of the git repository - Now you need to checkout the `v1.1_084` version:: + Now you need to checkout the :tutorial:`v1.1_084 ` version:: git switch --detach v1.1_084 @@ -494,7 +487,7 @@ Redefine other parameter in custom type for HTTPS and SOCKS .. type-along:: For those who follow the tutorial with the help of the git repository - Now you need to checkout the `v1.1_085` version:: + Now you need to checkout the :tutorial:`v1.1_085 ` version:: git switch --detach v1.1_085