rougail-tutorials/firefox/20-manual.yml

---
manual:

  use_for_https: true  # Also use this proxy for HTTPS

  "{{ suffix }}_proxy":
    description: "{{ suffix }} Proxy"
    dynamic:
      - HTTPS
      - SOCKS
    hidden:
      variable: _.use_for_https

    address:
      description: "{{ suffix }} address"
      default:
        variable: __.http_proxy.address

    port:
      description: "{{ suffix }} port"
      default:
        variable: __.http_proxy.port
[tutorial 020] A boolean variable Let's create a boolean variable. 2024-09-07 19:06:42 +02:00			`---`
			`manual:`

[tutorial 022] A variable in "shorthand" mode Transform it in "shorthand" mode. In this notation we can only define: - name - default value (so deduct the type) - description 2024-09-07 19:06:44 +02:00			`use_for_https: true # Also use this proxy for HTTPS`
[tutorial 023] Conditional hidden family and calculated default value Add a sub family "https_proxy" which will be hidden if "use_for_https" is True. Hidden means that we cannot change value, but we can access to it in read only mode. Inside, we add two variable with calculated default value (with variable type). So, if user set "use_for_https" to True, the default values of HTTPS configuration will be a copy of HTTP values. The use can change HTTPS values if needed. If user set "use_for_https" to False, the default values of HTTPS configuration will only be a copy of HTTP values. 2024-09-07 19:06:45 +02:00
[tutorial 028] Description of Jinja calculation By default, the Jinja calculation is generic in documentation. We can add a useful description. We add a new variable "version" only accessible in "Socks" family. 2024-09-07 19:06:50 +02:00			`"{{ suffix }}_proxy":`
			`description: "{{ suffix }} Proxy"`
			`dynamic:`
			`- HTTPS`
			`- SOCKS`
[tutorial 024] Conditional hidden family and calculated default value Add a sub family "https_proxy" which will be hidden if "use_for_https" is True. Hidden means that we cannot change value, but we can access to it in read only mode. Inside, we add two variable with calculated default value (with variable type). So, if user set "use_for_https" to True, the default values of HTTPS configuration will be a copy of HTTP values. The use can change HTTPS values if needed. If user set "use_for_https" to False, the default values of HTTPS configuration will only be a copy of HTTP values. 2024-09-07 19:06:46 +02:00			`hidden:`
[tutorial 026] A dynamic family HTTPS and socks proxy are very similar. It could be interesting to do on dynamic family instead of duplicate family and variable description. First of all, we add a dynamic attribute to the family. Dynamic is here a static list of suffix. It could be a variable or jinja informations too. The dynamic family is only hidden in the HTTPs case. Hidden is now a Jinja calculation with a parameter named "suffix". The suffix is use in: - family name - family description - variables name - variables description 2024-09-07 19:06:48 +02:00			`variable: _.use_for_https`
[tutorial 023] Conditional hidden family and calculated default value Add a sub family "https_proxy" which will be hidden if "use_for_https" is True. Hidden means that we cannot change value, but we can access to it in read only mode. Inside, we add two variable with calculated default value (with variable type). So, if user set "use_for_https" to True, the default values of HTTPS configuration will be a copy of HTTP values. The use can change HTTPS values if needed. If user set "use_for_https" to False, the default values of HTTPS configuration will only be a copy of HTTP values. 2024-09-07 19:06:45 +02:00
			`address:`
[tutorial 028] Description of Jinja calculation By default, the Jinja calculation is generic in documentation. We can add a useful description. We add a new variable "version" only accessible in "Socks" family. 2024-09-07 19:06:50 +02:00			`description: "{{ suffix }} address"`
[tutorial 025] Conditional hidden family and calculated default value Add a sub family "https_proxy" which will be hidden if "use_for_https" is True. Hidden means that we cannot change value, but we can access to it in read only mode. Inside, we add two variable with calculated default value (with variable type). So, if user set "use_for_https" to True, the default values of HTTPS configuration will be a copy of HTTP values. The use can change HTTPS values if needed. If user set "use_for_https" to False, the default values of HTTPS configuration will only be a copy of HTTP values. 2024-09-07 19:06:47 +02:00			`default:`
[tutorial 026] A dynamic family HTTPS and socks proxy are very similar. It could be interesting to do on dynamic family instead of duplicate family and variable description. First of all, we add a dynamic attribute to the family. Dynamic is here a static list of suffix. It could be a variable or jinja informations too. The dynamic family is only hidden in the HTTPs case. Hidden is now a Jinja calculation with a parameter named "suffix". The suffix is use in: - family name - family description - variables name - variables description 2024-09-07 19:06:48 +02:00			`variable: __.http_proxy.address`
[tutorial 023] Conditional hidden family and calculated default value Add a sub family "https_proxy" which will be hidden if "use_for_https" is True. Hidden means that we cannot change value, but we can access to it in read only mode. Inside, we add two variable with calculated default value (with variable type). So, if user set "use_for_https" to True, the default values of HTTPS configuration will be a copy of HTTP values. The use can change HTTPS values if needed. If user set "use_for_https" to False, the default values of HTTPS configuration will only be a copy of HTTP values. 2024-09-07 19:06:45 +02:00
			`port:`
[tutorial 028] Description of Jinja calculation By default, the Jinja calculation is generic in documentation. We can add a useful description. We add a new variable "version" only accessible in "Socks" family. 2024-09-07 19:06:50 +02:00			`description: "{{ suffix }} port"`
[tutorial 025] Conditional hidden family and calculated default value Add a sub family "https_proxy" which will be hidden if "use_for_https" is True. Hidden means that we cannot change value, but we can access to it in read only mode. Inside, we add two variable with calculated default value (with variable type). So, if user set "use_for_https" to True, the default values of HTTPS configuration will be a copy of HTTP values. The use can change HTTPS values if needed. If user set "use_for_https" to False, the default values of HTTPS configuration will only be a copy of HTTP values. 2024-09-07 19:06:47 +02:00			`default:`
[tutorial 026] A dynamic family HTTPS and socks proxy are very similar. It could be interesting to do on dynamic family instead of duplicate family and variable description. First of all, we add a dynamic attribute to the family. Dynamic is here a static list of suffix. It could be a variable or jinja informations too. The dynamic family is only hidden in the HTTPs case. Hidden is now a Jinja calculation with a parameter named "suffix". The suffix is use in: - family name - family description - variables name - variables description 2024-09-07 19:06:48 +02:00			`variable: __.http_proxy.port`