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

888 lines
No EOL
26 KiB
JSON

{
"firefox": {
"type": "namespace",
"informations": {
"path": "firefox",
"names": [
"firefox"
],
"description": "Firefox",
"properties": [],
"mode": "basic",
"help": [
"This family is a namespace"
]
},
"children": {
"proxy_mode": {
"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"
]
},
"path": "firefox.proxy_mode",
"names": [
"proxy_mode"
],
"description": "Configure Proxy Access to the Internet.",
"properties": [
{
"type": "property",
"name": "mandatory",
"ori_name": "mandatory",
"access_control": false
}
],
"mode": "standard",
"gen_examples": [
"No proxy"
],
"mandatory_without_value": false
},
"manual": {
"type": "family",
"informations": {
"path": "firefox.manual",
"names": [
"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": "firefox.proxy_mode"
},
"description": "Configure Proxy Access to the Internet"
}
}
],
"mode": "basic"
},
"children": {
"http_proxy": {
"type": "family",
"informations": {
"path": "firefox.manual.http_proxy",
"names": [
"http_proxy"
],
"description": "HTTP Proxy",
"properties": [],
"mode": "basic"
},
"children": {
"address": {
"type": "variable",
"variable_type": "domainname",
"validators": {
"name": "Validators",
"values": [
"type domainname",
"the domain name can be an IP"
]
},
"path": "firefox.manual.http_proxy.address",
"names": [
"address"
],
"description": "Proxy address.",
"properties": [
{
"type": "property",
"name": "mandatory",
"ori_name": "mandatory",
"access_control": false
}
],
"mode": "basic",
"gen_examples": [
"example.net"
],
"mandatory_without_value": true
},
"port": {
"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"
]
},
"path": "firefox.manual.http_proxy.port",
"names": [
"port"
],
"description": "Proxy port.",
"properties": [
{
"type": "property",
"name": "mandatory",
"ori_name": "mandatory",
"access_control": false
}
],
"mode": "standard",
"gen_examples": [
"8080"
],
"mandatory_without_value": false
}
}
},
"use_for_https": {
"type": "variable",
"default": {
"name": "Default",
"values": true
},
"variable_type": "boolean",
"path": "firefox.manual.use_for_https",
"names": [
"use_for_https"
],
"description": "Also use this proxy for HTTPS.",
"properties": [
{
"type": "property",
"name": "mandatory",
"ori_name": "mandatory",
"access_control": false
}
],
"mode": "standard",
"gen_examples": [
true
],
"mandatory_without_value": false
},
"https_proxy": {
"type": "family",
"informations": {
"path": "firefox.manual.https_proxy",
"names": [
"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": "firefox.manual.use_for_https"
},
"description": "Also use this proxy for HTTPS"
}
}
],
"mode": "standard"
},
"children": {
"address": {
"type": "variable",
"default": {
"name": "Default",
"values": {
"message": "the value of the variable \"{0}\"",
"path": {
"path": "firefox.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"
]
},
"path": "firefox.manual.https_proxy.address",
"names": [
"address"
],
"description": "Proxy address.",
"properties": [
{
"type": "property",
"name": "mandatory",
"ori_name": "mandatory",
"access_control": false
}
],
"mode": "standard",
"gen_examples": [
"example.net"
],
"mandatory_without_value": false
},
"port": {
"type": "variable",
"default": {
"name": "Default",
"values": {
"message": "the value of the variable \"{0}\"",
"path": {
"path": "firefox.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"
]
},
"path": "firefox.manual.https_proxy.port",
"names": [
"port"
],
"description": "Proxy port.",
"properties": [
{
"type": "property",
"name": "mandatory",
"ori_name": "mandatory",
"access_control": false
}
],
"mode": "standard",
"gen_examples": [
"8080"
],
"mandatory_without_value": false
}
}
},
"socks_proxy": {
"type": "family",
"informations": {
"path": "firefox.manual.socks_proxy",
"names": [
"socks_proxy"
],
"description": "SOCKS Proxy",
"properties": [],
"mode": "standard"
},
"children": {
"address": {
"type": "variable",
"default": {
"name": "Default",
"values": {
"message": "the value of the variable \"{0}\"",
"path": {
"path": "firefox.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"
]
},
"path": "firefox.manual.socks_proxy.address",
"names": [
"address"
],
"description": "Proxy address.",
"properties": [
{
"type": "property",
"name": "mandatory",
"ori_name": "mandatory",
"access_control": false
}
],
"mode": "standard",
"gen_examples": [
"example.net"
],
"mandatory_without_value": false
},
"port": {
"type": "variable",
"default": {
"name": "Default",
"values": {
"message": "the value of the variable \"{0}\"",
"path": {
"path": "firefox.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"
]
},
"path": "firefox.manual.socks_proxy.port",
"names": [
"port"
],
"description": "Proxy port.",
"properties": [
{
"type": "property",
"name": "mandatory",
"ori_name": "mandatory",
"access_control": false
}
],
"mode": "standard",
"gen_examples": [
"8080"
],
"mandatory_without_value": false
},
"version": {
"type": "variable",
"default": {
"name": "Default",
"values": "v5"
},
"variable_type": "choice",
"choices": {
"name": "Choices",
"values": [
"v4",
"v5"
]
},
"path": "firefox.manual.socks_proxy.version",
"names": [
"version"
],
"description": "SOCKS host version used by proxy.",
"properties": [
{
"type": "property",
"name": "mandatory",
"ori_name": "mandatory",
"access_control": false
}
],
"mode": "standard",
"gen_examples": [
"v5"
],
"mandatory_without_value": false
}
}
}
}
},
"auto": {
"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"
]
},
"path": "firefox.auto",
"names": [
"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": "firefox.proxy_mode"
},
"description": "Configure Proxy Access to the Internet"
}
}
],
"mode": "basic",
"gen_examples": [
"https://example.net"
],
"mandatory_without_value": true
},
"no_proxy": {
"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"
]
},
"path": "firefox.no_proxy",
"names": [
"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": "firefox.proxy_mode"
},
"description": "Configure Proxy Access to the Internet"
}
},
{
"type": "property",
"name": "unique",
"ori_name": "unique",
"access_control": false
}
],
"mode": "standard",
"multiple": true,
"examples": {
"name": "Examples",
"values": [
".mozilla.org",
".net.nz",
"192.168.1.0/24"
]
},
"gen_examples": [
[
".mozilla.org",
".net.nz",
"192.168.1.0/24"
]
],
"mandatory_without_value": false
},
"prompt_authentication": {
"type": "variable",
"default": {
"name": "Default",
"values": true
},
"variable_type": "boolean",
"path": "firefox.prompt_authentication",
"names": [
"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": "firefox.proxy_mode"
},
"description": "Configure Proxy Access to the Internet"
}
}
],
"mode": "standard",
"gen_examples": [
true
],
"mandatory_without_value": false
},
"proxy_dns_socks5": {
"type": "variable",
"default": {
"name": "Default",
"values": false
},
"variable_type": "boolean",
"path": "firefox.proxy_dns_socks5",
"names": [
"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": "firefox.proxy_mode",
"description": "Configure Proxy Access to the Internet"
},
{
"path": "firefox.manual.socks_proxy.version",
"description": "SOCKS host version used by proxy"
}
]
}
}
],
"mode": "advanced",
"gen_examples": [
false
],
"mandatory_without_value": false
},
"dns_over_https": {
"type": "family",
"informations": {
"path": "firefox.dns_over_https",
"names": [
"dns_over_https"
],
"description": "DNS over HTTPS",
"properties": [],
"mode": "basic"
},
"children": {
"enable_dns_over_https": {
"type": "variable",
"default": {
"name": "Default",
"values": false
},
"variable_type": "boolean",
"path": "firefox.dns_over_https.enable_dns_over_https",
"names": [
"enable_dns_over_https"
],
"description": "Enable DNS over HTTPS.",
"properties": [
{
"type": "property",
"name": "mandatory",
"ori_name": "mandatory",
"access_control": false
}
],
"mode": "standard",
"gen_examples": [
false
],
"mandatory_without_value": false
},
"provider": {
"type": "variable",
"default": {
"name": "Default",
"values": "Cloudflare"
},
"variable_type": "choice",
"choices": {
"name": "Choices",
"values": [
"Cloudflare",
"NextDNS",
"Custom"
]
},
"path": "firefox.dns_over_https.provider",
"names": [
"provider"
],
"description": "Use Provider.",
"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 \"false\"",
"path": {
"path": "firefox.dns_over_https.enable_dns_over_https"
},
"description": "Enable DNS over HTTPS"
}
}
],
"mode": "standard",
"gen_examples": [
"Cloudflare"
],
"mandatory_without_value": false
},
"custom_dns_url": {
"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",
{
"description": "must starts with 'https://' only"
}
]
},
"path": "firefox.dns_over_https.custom_dns_url",
"names": [
"custom_dns_url"
],
"description": "Custom DNS URL.",
"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 \"Custom\"",
"variables": [
{
"path": "firefox.dns_over_https.provider",
"description": "Use Provider"
}
]
}
}
],
"mode": "basic",
"gen_examples": [
"https://example.net"
],
"mandatory_without_value": true
}
}
}
}
},
"foxyproxy": {
"type": "namespace",
"informations": {
"path": "foxyproxy",
"names": [
"foxyproxy"
],
"description": "Foxyproxy",
"properties": [],
"mode": "basic",
"help": [
"This family is a namespace"
]
},
"children": {
"proxies": {
"type": "leadership",
"informations": {
"path": "foxyproxy.proxies",
"names": [
"proxies"
],
"description": "Proxy configuration",
"properties": [],
"mode": "basic",
"help": [
"This family contains lists of variable blocks"
]
},
"children": {
"title": {
"type": "variable",
"variable_type": "string",
"path": "foxyproxy.proxies.title",
"names": [
"title"
],
"description": "Title or Description.",
"properties": [
{
"type": "property",
"name": "unique",
"ori_name": "unique",
"access_control": false
}
],
"mode": "standard",
"multiple": true,
"gen_examples": [
[
"example"
]
],
"mandatory_without_value": false
},
"type": {
"type": "variable",
"default": {
"name": "Default",
"values": "Direct (no proxy)"
},
"variable_type": "choice",
"choices": {
"name": "Choices",
"values": [
"HTTP",
"HTTPS/SSL",
"SOCKS4",
"SOCKS5",
"PAC URL",
"WPAD",
"System (use system settings)",
"Direct (no proxy)"
]
},
"path": "foxyproxy.proxies.type",
"names": [
"type"
],
"description": "Proxy Type.",
"properties": [
{
"type": "property",
"name": "mandatory",
"ori_name": "mandatory",
"access_control": false
}
],
"mode": "standard",
"gen_examples": [
[
"Direct (no proxy)"
]
],
"mandatory_without_value": false
},
"color": {
"type": "variable",
"default": {
"name": "Default",
"values": {
"description": "random color value"
}
},
"variable_type": "regexp",
"validators": {
"name": "Validator",
"values": "text based with regular expressions \"^#(?:[0-9a-f]{3}){1,2}$\""
},
"path": "foxyproxy.proxies.color",
"names": [
"color"
],
"description": "Color.",
"properties": [
{
"type": "property",
"name": "mandatory",
"ori_name": "mandatory",
"access_control": false
},
{
"type": "property",
"name": "auto modified",
"ori_name": "force_store_value",
"access_control": false
}
],
"mode": "basic",
"gen_examples": [
[
"#d9102f"
]
],
"mandatory_without_value": false
}
}
}
}
}
}