rougail-output-doc/tests/result_tutorial/120/doc.json

{
  "proxy_mode": {
    "path": "proxy_mode",
    "name": "proxy_mode",
    "description": "Configure Proxy Access to the Internet.",
    "properties": [
      {
        "type": "property",
        "name": "mandatory",
        "ori_name": "mandatory",
        "access_control": false
      }
    ],
    "mode": "standard",
    "type": "variable",
    "default": {
      "name": "Default",
      "values": "No proxy"
    },
    "variable_type": "choice",
    "choices": {
      "name": "Choices",
      "values": [
        "No proxy",
        "Auto-detect proxy settings for this network",
        "Use system proxy settings",
        "Manual proxy configuration",
        "Automatic proxy configuration URL"
      ]
    }
  },
  "manual": {
    "type": "family",
    "informations": {
      "path": "manual",
      "name": "manual",
      "description": "Manual proxy configuration",
      "properties": [
        {
          "type": "property",
          "name": "disabled",
          "ori_name": "disabled",
          "access_control": true,
          "annotation": {
            "message": "when the variable \"{0}\" hasn't the value \"Manual proxy configuration\".",
            "path": {
              "path": "proxy_mode"
            },
            "description": "Configure Proxy Access to the Internet"
          }
        }
      ],
      "mode": "basic"
    },
    "children": {
      "http_proxy": {
        "type": "family",
        "informations": {
          "path": "manual.http_proxy",
          "name": "http_proxy",
          "description": "HTTP Proxy",
          "properties": [],
          "mode": "basic"
        },
        "children": {
          "address": {
            "path": "manual.http_proxy.address",
            "name": "address",
            "description": "Proxy address.",
            "properties": [
              {
                "type": "property",
                "name": "mandatory",
                "ori_name": "mandatory",
                "access_control": false
              }
            ],
            "mode": "basic",
            "type": "variable",
            "variable_type": "domainname",
            "validators": {
              "name": "Validators",
              "values": [
                "type domainname",
                "the domain name can be an IP"
              ]
            }
          },
          "port": {
            "path": "manual.http_proxy.port",
            "name": "port",
            "description": "Proxy port.",
            "properties": [
              {
                "type": "property",
                "name": "mandatory",
                "ori_name": "mandatory",
                "access_control": false
              }
            ],
            "mode": "standard",
            "type": "variable",
            "default": {
              "name": "Default",
              "values": "8080"
            },
            "variable_type": "port",
            "validators": {
              "name": "Validators",
              "values": [
                "well-known ports (1 to 1023) are allowed",
                "registred ports (1024 to 49151) are allowed",
                "private ports (greater than 49152) are allowed"
              ]
            }
          }
        }
      },
      "use_for_https": {
        "path": "manual.use_for_https",
        "name": "use_for_https",
        "description": "Also use this proxy for HTTPS.",
        "properties": [
          {
            "type": "property",
            "name": "mandatory",
            "ori_name": "mandatory",
            "access_control": false
          }
        ],
        "mode": "standard",
        "type": "variable",
        "default": {
          "name": "Default",
          "values": true
        },
        "variable_type": "boolean"
      },
      "https_proxy": {
        "type": "family",
        "informations": {
          "path": "manual.https_proxy",
          "name": "https_proxy",
          "description": "HTTPS Proxy",
          "properties": [
            {
              "type": "property",
              "name": "hidden",
              "ori_name": "hidden",
              "access_control": true,
              "annotation": {
                "message": "when the variable \"{0}\" has the value \"true\".",
                "path": {
                  "path": "manual.use_for_https"
                },
                "description": "Also use this proxy for HTTPS"
              }
            }
          ],
          "mode": "standard"
        },
        "children": {
          "address": {
            "path": "manual.https_proxy.address",
            "name": "address",
            "description": "Proxy address.",
            "properties": [
              {
                "type": "property",
                "name": "mandatory",
                "ori_name": "mandatory",
                "access_control": false
              }
            ],
            "mode": "standard",
            "type": "variable",
            "default": {
              "name": "Default",
              "values": {
                "message": "the value of the variable \"{0}\"",
                "path": {
                  "path": "manual.http_proxy.address",
                  "type": "variable"
                },
                "description": "Proxy address"
              }
            },
            "variable_type": "domainname",
            "validators": {
              "name": "Validators",
              "values": [
                "type domainname",
                "the domain name can be an IP"
              ]
            }
          },
          "port": {
            "path": "manual.https_proxy.port",
            "name": "port",
            "description": "Proxy port.",
            "properties": [
              {
                "type": "property",
                "name": "mandatory",
                "ori_name": "mandatory",
                "access_control": false
              }
            ],
            "mode": "standard",
            "type": "variable",
            "default": {
              "name": "Default",
              "values": {
                "message": "the value of the variable \"{0}\"",
                "path": {
                  "path": "manual.http_proxy.port",
                  "type": "variable"
                },
                "description": "Proxy port"
              }
            },
            "variable_type": "port",
            "validators": {
              "name": "Validators",
              "values": [
                "well-known ports (1 to 1023) are allowed",
                "registred ports (1024 to 49151) are allowed",
                "private ports (greater than 49152) are allowed"
              ]
            }
          }
        }
      },
      "socks_proxy": {
        "type": "family",
        "informations": {
          "path": "manual.socks_proxy",
          "name": "socks_proxy",
          "description": "SOCKS Proxy",
          "properties": [],
          "mode": "standard"
        },
        "children": {
          "address": {
            "path": "manual.socks_proxy.address",
            "name": "address",
            "description": "Proxy address.",
            "properties": [
              {
                "type": "property",
                "name": "mandatory",
                "ori_name": "mandatory",
                "access_control": false
              }
            ],
            "mode": "standard",
            "type": "variable",
            "default": {
              "name": "Default",
              "values": {
                "message": "the value of the variable \"{0}\"",
                "path": {
                  "path": "manual.http_proxy.address",
                  "type": "variable"
                },
                "description": "Proxy address"
              }
            },
            "variable_type": "domainname",
            "validators": {
              "name": "Validators",
              "values": [
                "type domainname",
                "the domain name can be an IP"
              ]
            }
          },
          "port": {
            "path": "manual.socks_proxy.port",
            "name": "port",
            "description": "Proxy port.",
            "properties": [
              {
                "type": "property",
                "name": "mandatory",
                "ori_name": "mandatory",
                "access_control": false
              }
            ],
            "mode": "standard",
            "type": "variable",
            "default": {
              "name": "Default",
              "values": {
                "message": "the value of the variable \"{0}\"",
                "path": {
                  "path": "manual.http_proxy.port",
                  "type": "variable"
                },
                "description": "Proxy port"
              }
            },
            "variable_type": "port",
            "validators": {
              "name": "Validators",
              "values": [
                "well-known ports (1 to 1023) are allowed",
                "registred ports (1024 to 49151) are allowed",
                "private ports (greater than 49152) are allowed"
              ]
            }
          },
          "version": {
            "path": "manual.socks_proxy.version",
            "name": "version",
            "description": "SOCKS host version used by proxy.",
            "properties": [
              {
                "type": "property",
                "name": "mandatory",
                "ori_name": "mandatory",
                "access_control": false
              }
            ],
            "mode": "standard",
            "type": "variable",
            "default": {
              "name": "Default",
              "values": "v5"
            },
            "variable_type": "choice",
            "choices": {
              "name": "Choices",
              "values": [
                "v4",
                "v5"
              ]
            }
          }
        }
      }
    }
  },
  "auto": {
    "path": "auto",
    "name": "auto",
    "description": "Automatic proxy configuration URL.",
    "properties": [
      {
        "type": "property",
        "name": "mandatory",
        "ori_name": "mandatory",
        "access_control": false
      },
      {
        "type": "property",
        "name": "disabled",
        "ori_name": "disabled",
        "access_control": true,
        "annotation": {
          "message": "when the variable \"{0}\" hasn't the value \"Automatic proxy configuration URL\".",
          "path": {
            "path": "proxy_mode"
          },
          "description": "Configure Proxy Access to the Internet"
        }
      }
    ],
    "mode": "basic",
    "type": "variable",
    "variable_type": "web address",
    "validators": {
      "name": "Validators",
      "values": [
        "well-known ports (1 to 1023) are allowed",
        "registred ports (1024 to 49151) are allowed",
        "type domainname",
        "the domain name can be a hostname"
      ]
    }
  },
  "no_proxy": {
    "path": "no_proxy",
    "name": "no_proxy",
    "description": "Address for which proxy will be desactivated.",
    "help": [
      "Connections to localhost, 127.0.0.1/8 and ::1 are never proxied."
    ],
    "properties": [
      {
        "type": "property",
        "name": "disabled",
        "ori_name": "disabled",
        "access_control": true,
        "annotation": {
          "message": "when the variable \"{0}\" has the value \"No proxy\".",
          "path": {
            "path": "proxy_mode"
          },
          "description": "Configure Proxy Access to the Internet"
        }
      },
      {
        "type": "property",
        "name": "unique",
        "ori_name": "unique",
        "access_control": false
      }
    ],
    "mode": "standard",
    "type": "variable",
    "variable_type": "domainname",
    "validators": {
      "name": "Validators",
      "values": [
        "type domainname",
        "the domain name can starts by a dot",
        "the domain name can be a hostname",
        "the domain name can be an IP",
        "the domain name can be network in CIDR format"
      ]
    },
    "multiple": true,
    "examples": {
      "name": "Examples",
      "values": [
        ".mozilla.org",
        ".net.nz",
        "192.168.1.0/24"
      ]
    }
  },
  "prompt_authentication": {
    "path": "prompt_authentication",
    "name": "prompt_authentication",
    "description": "Prompt for authentication if password is saved.",
    "properties": [
      {
        "type": "property",
        "name": "mandatory",
        "ori_name": "mandatory",
        "access_control": false
      },
      {
        "type": "property",
        "name": "disabled",
        "ori_name": "disabled",
        "access_control": true,
        "annotation": {
          "message": "when the variable \"{0}\" has the value \"No proxy\".",
          "path": {
            "path": "proxy_mode"
          },
          "description": "Configure Proxy Access to the Internet"
        }
      }
    ],
    "mode": "standard",
    "type": "variable",
    "default": {
      "name": "Default",
      "values": true
    },
    "variable_type": "boolean"
  },
  "proxy_dns_socks5": {
    "path": "proxy_dns_socks5",
    "name": "proxy_dns_socks5",
    "description": "Use proxy DNS when using SOCKS v5.",
    "properties": [
      {
        "type": "property",
        "name": "mandatory",
        "ori_name": "mandatory",
        "access_control": false
      },
      {
        "type": "property",
        "name": "disabled",
        "ori_name": "disabled",
        "access_control": true,
        "annotation": {
          "description": "if \"{0}\" is not \"Manual proxy configuration\"\nor \"{1}\" is \"v4\".",
          "variables": [
            {
              "path": "proxy_mode",
              "description": "Configure Proxy Access to the Internet"
            },
            {
              "path": "manual.socks_proxy.version",
              "description": "SOCKS host version used by proxy"
            }
          ]
        }
      }
    ],
    "mode": "standard",
    "type": "variable",
    "default": {
      "name": "Default",
      "values": false
    },
    "variable_type": "boolean"
  }
}