Compare commits

...

3 commits

Author SHA1 Message Date
d437131de9 fix: 2026-03-08 07:49:25 +01:00
21669746a3 fix: update 2026-02-28 10:45:28 +01:00
11ebbb8dc5 update 2026-01-07 08:36:06 +01:00
287 changed files with 710 additions and 346 deletions

154
build.py
View file

@ -8,8 +8,9 @@ from ansi2html import Ansi2HTMLConverter
from bs4 import BeautifulSoup from bs4 import BeautifulSoup
from rougail import Rougail from rougail import Rougail
from rougail.user_data import mandatories
from rougail.config import get_rougail_config from rougail.config import get_rougail_config
from rougail.output_console import RougailOutputConsole from rougail.output_display import RougailOutputDisplay
from rougail.user_data_yaml import RougailUserDataYaml from rougail.user_data_yaml import RougailUserDataYaml
from rougail.output_doc import RougailOutputDoc from rougail.output_doc import RougailOutputDoc
@ -35,6 +36,11 @@ if __name__ == "__main__":
has_foxyproxy = False has_foxyproxy = False
has_namespace = False has_namespace = False
rougailconfig['main_namespace'] = None rougailconfig['main_namespace'] = None
if Path('types').is_dir():
has_types = True
rougailconfig['types'] = [str(d) for d in Path('types').iterdir()]
else:
has_types = False
# rougailconfig['tiramisu_cache'] = "cache.py" # rougailconfig['tiramisu_cache'] = "cache.py"
if Path('mode').is_file(): if Path('mode').is_file():
rougailconfig['modes_level'] = ['basic', 'standard', 'advanced'] rougailconfig['modes_level'] = ['basic', 'standard', 'advanced']
@ -48,9 +54,11 @@ if __name__ == "__main__":
rougailconfig['doc.output_format'] = 'github' rougailconfig['doc.output_format'] = 'github'
rougailconfig['doc.title_level'] = 3 rougailconfig['doc.title_level'] = 3
inventory = RougailOutputDoc(config, rougailconfig=rougailconfig) inventory = RougailOutputDoc(config, rougailconfig=rougailconfig)
inventory.load()
inventory.load_formatter() inventory.load_formatter()
inv_formatter = inventory.formatter inv_formatter = inventory.formatter
rougailconfig['step.output'] = 'console' rougailconfig['step.output'] = 'display'
rougailconfig['display.console.max_width'] = 80
summary = Path('summary_before.md') summary = Path('summary_before.md')
if summary.is_file(): if summary.is_file():
with summary.open('r') as sfh: with summary.open('r') as sfh:
@ -78,7 +86,10 @@ if __name__ == "__main__":
doc += '\n' + inv_formatter.title('Structure', 2) + '\n\n' doc += '\n' + inv_formatter.title('Structure', 2) + '\n\n'
with tree.open() as fh: with tree.open() as fh:
soup = BeautifulSoup(fh.read(), features="lxml") soup = BeautifulSoup(fh.read(), features="lxml")
doc += str(soup.find('p')) + "\n\n" tree_content = str(soup.find('p'))
doc += tree_content + "\n\n"
with tree.open("w") as fh:
fh.write(tree_content)
for f in Path(".").iterdir(): for f in Path(".").iterdir():
if f.name.startswith('DISPLAY_'): if f.name.startswith('DISPLAY_'):
filename = f.name[8:] filename = f.name[8:]
@ -98,6 +109,7 @@ if __name__ == "__main__":
with display_yml.open(encoding="utf8") as file_fh: with display_yml.open(encoding="utf8") as file_fh:
doc += file_fh.read() doc += file_fh.read()
doc += '\n```\n' doc += '\n```\n'
doc += "\n***\n"
rougailconfig['step.output'] = 'doc' rougailconfig['step.output'] = 'doc'
rougailconfig["doc.title_level"] = 4 rougailconfig["doc.title_level"] = 4
inv_doc = inventory.run()[1] inv_doc = inventory.run()[1]
@ -106,6 +118,8 @@ if __name__ == "__main__":
CMD += "-s Firefox " CMD += "-s Firefox "
if has_foxyproxy: if has_foxyproxy:
CMD += "-xn FoxyProxy -xd 0 foxyproxy/ " CMD += "-xn FoxyProxy -xd 0 foxyproxy/ "
if has_types:
CMD += "--types " + " ".join(rougailconfig["types"]) + " "
if has_mode: if has_mode:
CMD += "--modes_level basic standard advanced " CMD += "--modes_level basic standard advanced "
if inv_doc: if inv_doc:
@ -113,15 +127,17 @@ if __name__ == "__main__":
cmd = CMD + "-o doc" cmd = CMD + "-o doc"
doc += f'```shell\n{cmd}\n```\n' doc += f'```shell\n{cmd}\n```\n'
doc += inv_doc doc += inv_doc
doc += "\n***\n"
if previous.is_file(): if previous.is_file():
rougailconfig["doc.contents"] = ["changelog"] rougailconfig["doc.contents"] = ["changelog"]
rougailconfig["doc.previous_json_file"] = str(previous) rougailconfig["doc.changelog.previous_json_file"] = str(previous)
inv_doc = inventory.run()[1] inv_doc = inventory.run()[1]
if inv_doc: if inv_doc:
doc += inv_formatter.title("Let's generate the changelog", 3) doc += inv_formatter.title("Let's generate the changelog", 3)
cmd = CMD + "-o doc --doc.contents changelog" cmd = CMD + "-o doc --doc.contents changelog --doc.changelog.previous_json_file previous.yml"
doc += f'```shell\n{cmd}\n```\n' doc += f'```shell\n{cmd}\n```\n'
doc += inv_doc + "\n" doc += inv_doc + "\n"
doc += "***\n"
# save PREVIOUS # save PREVIOUS
rougailconfig["doc.contents"] = ["variables"] rougailconfig["doc.contents"] = ["variables"]
rougailconfig['doc.output_format'] = 'json' rougailconfig['doc.output_format'] = 'json'
@ -130,11 +146,11 @@ if __name__ == "__main__":
with previous.open('w') as fh: with previous.open('w') as fh:
dump(loads(data), fh) dump(loads(data), fh)
# #
rougailconfig['step.output'] = 'console' rougailconfig['step.output'] = 'display'
config = Path('config') config_dir = Path('config')
if config.is_dir(): if config_dir.is_dir():
doc += inv_formatter.title('User datas', 2) doc += inv_formatter.title('User datas', 2)
configs = list(config.iterdir()) configs = list(config_dir.iterdir())
configs.sort() configs.sort()
for idx, dirname in enumerate(configs): for idx, dirname in enumerate(configs):
if dirname.is_file(): if dirname.is_file():
@ -147,14 +163,18 @@ if __name__ == "__main__":
with filename.open(encoding="utf8") as file_fh: with filename.open(encoding="utf8") as file_fh:
doc += file_fh.read() doc += file_fh.read()
doc += '```\n' doc += '```\n'
doc += "\n***\n"
rougail = Rougail(rougailconfig) rougail = Rougail(rougailconfig)
tiramisu_config = rougail.run() tiramisu_config = rougail.run()
rougailconfig['step.user_data'] = ['yaml'] rougailconfig['step.user_data'] = ['yaml']
rougailconfig['yaml.filename'] = [str(filename)] rougailconfig['yaml.filename'] = [str(filename)]
data = RougailUserDataYaml(tiramisu_config, rougailconfig=rougailconfig) data = RougailUserDataYaml(tiramisu_config, rougailconfig=rougailconfig)
ret = data.run() ret = data.run()
errors = rougail.user_datas(ret) errors = rougail.user_data(ret)
export = RougailOutputConsole(tiramisu_config, tiramisu_config.property.read_only()
mandatories(tiramisu_config, errors["errors"])
rougailconfig['display.output_format'] = "console"
export = RougailOutputDisplay(tiramisu_config,
rougailconfig=rougailconfig, rougailconfig=rougailconfig,
user_data_errors=errors['errors'], user_data_errors=errors['errors'],
user_data_warnings=errors['warnings'], user_data_warnings=errors['warnings'],
@ -167,33 +187,118 @@ if __name__ == "__main__":
fh.write(cmd) fh.write(cmd)
doc += f"```shell\n{cmd}\n```\n" doc += f"```shell\n{cmd}\n```\n"
conv_data = '<pre>' + conv.convert(console, full=False) + "</pre>\n" conv_data = '<pre>' + conv.convert(console, full=False) + "</pre>\n"
doc += conv_data
with open(dirname / 'output_ro.html', 'w') as fh_output: with open(dirname / 'output_ro.html', 'w') as fh_output:
fh_output.write(conv_data) fh_output.write(conv_data)
rougailconfig['display.output_format'] = "github"
export = RougailOutputDisplay(tiramisu_config,
rougailconfig=rougailconfig,
user_data_errors=errors['errors'],
user_data_warnings=errors['warnings'],
)
doc += export.run()[1]
doc += "\n***\n"
if (dirname / 'invalid').is_file(): if (dirname / 'invalid').is_file():
errors2 = rougail.user_datas(ret, invalid_user_datas_error=True) tiramisu_config.property.read_write()
export = RougailOutputConsole(tiramisu_config, errors2 = rougail.user_data(ret, invalid_user_data_error=True)
tiramisu_config.property.read_only()
mandatories(tiramisu_config, errors2["errors"])
rougailconfig['display.output_format'] = "console"
export = RougailOutputDisplay(tiramisu_config,
rougailconfig=rougailconfig, rougailconfig=rougailconfig,
user_data_errors=errors2['errors'], user_data_errors=errors2['errors'],
user_data_warnings=errors2['warnings'], user_data_warnings=errors2['warnings'],
) )
console = export.run()[1] console = export.run()[1]
conv = Ansi2HTMLConverter(inline=True) conv = Ansi2HTMLConverter(inline=True)
doc += inv_formatter.title('Output when invalid user datas is an error', 4) doc += inv_formatter.title('Output when invalid user data is an error', 4)
cmd2 = cmd + " --cli.invalid_user_datas_error" cmd2 = cmd + " --cli.invalid_user_data_error"
with (dirname / "cmd_invalid.txt").open("w") as fh: with (dirname / "cmd_invalid.txt").open("w") as fh:
fh.write(cmd2) fh.write(cmd2)
doc += f"```shell\n{cmd2}\n```\n" doc += f"```shell\n{cmd2}\n```\n"
conv_data = '<pre>' + conv.convert(console, full=False) + "</pre>\n" conv_data = '<pre>' + conv.convert(console, full=False) + "</pre>\n"
doc += conv_data
with open(dirname / 'output_invalid.html', 'w') as fh_output: with open(dirname / 'output_invalid.html', 'w') as fh_output:
fh_output.write(conv_data) fh_output.write(conv_data)
rougailconfig['display.output_format'] = "github"
export = RougailOutputDisplay(tiramisu_config,
rougailconfig=rougailconfig,
user_data_errors=errors2['errors'],
user_data_warnings=errors2['warnings'],
)
doc += export.run()[1]
doc += "\n***\n"
if (dirname / 'unknown').is_file():
tiramisu_config.property.read_write()
trougailconfig = rougailconfig.copy()
errors2 = rougail.user_data(ret, unknown_user_data_error=True)
tiramisu_config.property.read_only()
mandatories(tiramisu_config, errors2["errors"])
trougailconfig['display.output_format'] = "console"
export = RougailOutputDisplay(tiramisu_config,
rougailconfig=trougailconfig,
user_data_errors=errors2['errors'],
user_data_warnings=errors2['warnings'],
)
console = export.run()[1]
conv = Ansi2HTMLConverter(inline=True)
doc += inv_formatter.title('Output when unknown user data is an error', 4)
cmd2 = cmd + " --cli.unknown_user_data_error"
with (dirname / "cmd_unknown.txt").open("w") as fh:
fh.write(cmd2)
doc += f"```shell\n{cmd2}\n```\n"
conv_data = '<pre>' + conv.convert(console, full=False) + "</pre>\n"
with open(dirname / 'output_unknown.html', 'w') as fh_output:
fh_output.write(conv_data)
trougailconfig['display.output_format'] = "github"
export = RougailOutputDisplay(tiramisu_config,
rougailconfig=trougailconfig,
user_data_errors=errors2['errors'],
user_data_warnings=errors2['warnings'],
)
doc += export.run()[1]
doc += "\n***\n"
if (dirname / 'root').is_file():
tiramisu_config.property.read_write()
trougailconfig = rougailconfig.copy()
errors2 = rougail.user_data(ret, unknown_user_data_error=True)
tiramisu_config.property.read_only()
with (dirname / 'root').open() as root_fh:
root_path = root_fh.read().strip()
root_tiramisu_config = tiramisu_config
for r in root_path.split('.'):
root_tiramisu_config = root_tiramisu_config.option(r)
mandatories(tiramisu_config, errors2["errors"])
trougailconfig['display.output_format'] = "console"
export = RougailOutputDisplay(root_tiramisu_config,
root_config=tiramisu_config,
rougailconfig=trougailconfig,
user_data_errors=errors2['errors'],
user_data_warnings=errors2['warnings'],
)
console = export.run()[1]
conv = Ansi2HTMLConverter(inline=True)
doc += inv_formatter.title(f'Output for "{root_path}"', 4)
cmd2 = cmd + f" --cli.root {root_path}"
with (dirname / "cmd_root.txt").open("w") as fh:
fh.write(cmd2)
doc += f"```shell\n{cmd2}\n```\n"
conv_data = '<pre>' + conv.convert(console, full=False) + "</pre>\n"
with open(dirname / 'output_root.html', 'w') as fh_output:
fh_output.write(conv_data)
trougailconfig['display.output_format'] = "github"
export = RougailOutputDisplay(root_tiramisu_config,
root_config = tiramisu_config,
rougailconfig=trougailconfig,
user_data_errors=errors2['errors'],
user_data_warnings=errors2['warnings'],
)
doc += export.run()[1]
doc += "\n***\n"
if (dirname / 'read_write').is_file(): if (dirname / 'read_write').is_file():
trougailconfig = rougailconfig.copy() trougailconfig = rougailconfig.copy()
trougailconfig["console.mandatory"] = False
tiramisu_config.property.read_write() tiramisu_config.property.read_write()
errors2 = rougail.user_datas(ret, invalid_user_datas_error=True) errors2 = rougail.user_data(ret, invalid_user_data_error=True)
export = RougailOutputConsole(tiramisu_config, trougailconfig['display.output_format'] = "console"
export = RougailOutputDisplay(tiramisu_config,
rougailconfig=trougailconfig, rougailconfig=trougailconfig,
user_data_errors=errors2['errors'], user_data_errors=errors2['errors'],
user_data_warnings=errors2['warnings'], user_data_warnings=errors2['warnings'],
@ -206,9 +311,16 @@ if __name__ == "__main__":
fh.write(cmd2) fh.write(cmd2)
doc += f"```shell\n{cmd2}\n```\n" doc += f"```shell\n{cmd2}\n```\n"
conv_data = '<pre>' + conv.convert(console, full=False) + "</pre>\n" conv_data = '<pre>' + conv.convert(console, full=False) + "</pre>\n"
doc += conv_data
with open(dirname / 'output_rw.html', 'w') as fh_output: with open(dirname / 'output_rw.html', 'w') as fh_output:
fh_output.write(conv_data) fh_output.write(conv_data)
trougailconfig['display.output_format'] = "github"
export = RougailOutputDisplay(tiramisu_config,
rougailconfig=trougailconfig,
user_data_errors=errors2['errors'],
user_data_warnings=errors2['warnings'],
)
doc += export.run()[1]
doc += "\n***\n"
tiramisu_config.property.read_only() tiramisu_config.property.read_only()
# #
summary = Path('summary_after.md') summary = Path('summary_after.md')

View file

@ -50,8 +50,11 @@ for i in $(ls -d "examples"/* | sort); do
done done
for i in $(ls -d "examples"/* | sort); do for i in $(ls -d "examples"/* | sort); do
if [ -f $i/URL ]; then
base_url_doc=$(cat $i/URL)
fi
if [ -f "$i/TITLE.md" ]; then if [ -f "$i/TITLE.md" ]; then
echo "- $(head -n 1 $i/TITLE.md)" >> summary.md echo "- $(head -n 1 $i/TITLE.md) ([doc]($base_url_doc))" >> summary.md
fi fi
if [ -f "$i/SUBTITLE.md" ]; then if [ -f "$i/SUBTITLE.md" ]; then
echo " - $(head -n 1 $i/SUBTITLE.md)" >> summary.md echo " - $(head -n 1 $i/SUBTITLE.md)" >> summary.md
@ -62,11 +65,8 @@ for i in $(ls -d "examples"/* | sort); do
echo "$num" echo "$num"
commit_id="v${VERSION}_$num" commit_id="v${VERSION}_$num"
title=$(head -n 1 $i/README.md) title=$(head -n 1 $i/README.md)
summary="[tutorial $commit_id)] $title" summary="[tutorial $commit_id] $title"
if [ -f $i/URL ]; then url_doc="$base_url_doc#$(echo $title | tr A-Z a-z | sed 's/ /-/g' | sed 's//-/g' | sed 's/\"//g')"
base_url_doc=$(cat $i/URL)
fi
url_doc="$base_url_doc#$(echo $title | tr A-Z a-z | sed 's/ /-/g' | sed 's//-/g')"
diff_url="https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/${commit_id}~1..$commit_id" diff_url="https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/${commit_id}~1..$commit_id"
echo " - [$summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/$commit_id/README.md) ([doc]($url_doc) - [diff]($diff_url))" >> summary.md echo " - [$summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/$commit_id/README.md) ([doc]($url_doc) - [diff]($diff_url))" >> summary.md
cp "summary_total.md" "$DEST" cp "summary_total.md" "$DEST"
@ -83,6 +83,12 @@ for i in $(ls -d "examples"/* | sort); do
cp -v "$j" "$DEST/$j" cp -v "$j" "$DEST/$j"
done done
fi fi
if [ -d ../types ]; then
mkdir -p $DEST/types
for j in $(ls -d ../types/* 2>/dev/null); do
cp -va "$j" "$DEST/types/"
done
fi
cd $DEST cd $DEST
tree -H $TUTO_ROOT/$commit_id/ -P "*.yml" > tree.html tree -H $TUTO_ROOT/$commit_id/ -P "*.yml" > tree.html
cd - > /dev/null cd - > /dev/null
@ -140,6 +146,9 @@ for i in $(ls -d "examples"/* | sort); do
fi fi
cd - > /dev/null cd - > /dev/null
# old_commit_id="$commit_id" # old_commit_id="$commit_id"
# echo "pouet $i"
# [ "$i" = "examples/120" ] && exit 1
if [ -f previous.yml ]; then cp -a previous.yml previous_old.yml; fi
fi fi
done done
cd "$DEST" cd "$DEST"

View file

@ -1 +0,0 @@
Making a structure file

View file

@ -1 +0,0 @@
Let's create our first "variable"

View file

@ -1,9 +1 @@
Describe the variable Describe the variable
We can add a description to this first variable.
This information is useful for:
- documentation
- error message
- help user to known which value to set to this variable (for example with [the user data plugin Questionary](https://forge.cloud.silique.fr/stove/rougail-user-data-questionary)).

View file

@ -1,7 +1 @@
Set a default value Set a default value
Now we can define the default value of this variable.
If the user doesn't touch this variable's value, the value is "No proxy"
As user intervention is no more required, so the variable change it's default mode too (from "basic" to "standard").

View file

@ -1,7 +0,0 @@
Limits the possible values for the variable
"Foo" should not be an option to the "proxy_mode" variable.
Now the "proxy_mode" type is "choice", that means that there is a list of available values that can be selected.
We say that the "proxy_mode" variable is constrained (by choices): this variable accept, in fact, only a list of choices.

View file

@ -1 +1 @@
Creating a new family A variable with a list of possible values

View file

@ -1 +0,0 @@
Group variables inside "families"

1
examples/010/TITLE.md Normal file
View file

@ -0,0 +1 @@
A variable with possible values

View file

@ -1 +1 @@
https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/proxymode.html https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/choice.html

View file

@ -1,8 +0,0 @@
%YAML 1.2
---
version: 1.1
manual:
description: Manual proxy configuration
type: family
...

View file

@ -1,8 +0,0 @@
Or a sub family
Inside a family, we can have variables or families.
The "type" for family "manual" became unecessary because container an other family, so it's not a variable.
The description can now be has family comment.
In disabled attribute, it's better tu use relative path (we will see the reason in an other slide).

View file

@ -1,10 +0,0 @@
%YAML 1.2
---
version: 1.1
manual: # Manual proxy configuration
http_proxy:
description: HTTP Proxy
type: family
...

View file

@ -1 +0,0 @@
Putting a variable inside of a family or a sub family

View file

@ -1,4 +0,0 @@
---
manual:
http_proxy:
address: example.net

View file

@ -1,10 +0,0 @@
%YAML 1.2
---
version: 1.1
manual: # Manual proxy configuration
http_proxy: # HTTP Proxy
address: # HTTP address
...

View file

@ -1 +1 @@
A variable with type "domainname" Creating a new family

View file

@ -1 +1 @@
Constrainte the value of a variable with it's type Group variables inside families

View file

@ -1 +1 @@
https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/family.html

View file

@ -1,4 +0,0 @@
---
manual:
http_proxy:
address: 192.168.0.1

View file

@ -1,4 +0,0 @@
---
manual:
http_proxy:
address: not a valid domain name

View file

Before

Width:  |  Height:  |  Size: 117 KiB

After

Width:  |  Height:  |  Size: 117 KiB

View file

@ -2,11 +2,7 @@
--- ---
version: 1.1 version: 1.1
manual: # Manual proxy configuration manual:
description: Manual proxy configuration
http_proxy: # HTTP Proxy type: family
address:
description: HTTP address
type: domainname
... ...

View file

@ -1 +1,8 @@
A variable with type's parameters Or a sub family
Inside a family, we can have variables or families.
The "type" for family "manual" became unecessary because container an other family, so it's not a variable.
The description can now be has family comment.
In disabled attribute, it's better tu use relative path (we will see the reason in an other slide).

View file

@ -1 +0,0 @@
../020/config

View file

@ -4,11 +4,7 @@ version: 1.1
manual: # Manual proxy configuration manual: # Manual proxy configuration
http_proxy: # HTTP Proxy http_proxy:
description: HTTP Proxy
address: type: family
description: HTTP address
type: domainname
params:
allow_ip: true
... ...

View file

@ -1 +1 @@
A variable with type "port" Putting a variable inside of a family or a sub family

View file

@ -1,5 +1 @@
--- ---
proxy_mode: Manual proxy configuration
manual:
http_proxy:
address: example.net

View file

@ -1,6 +1,4 @@
--- ---
proxy_mode: Manual proxy configuration
manual: manual:
http_proxy: http_proxy:
address: example.net address: example.net
port: 3128

View file

@ -1,6 +1,5 @@
--- ---
proxy_mode: Manual proxy configuration
manual: manual:
http_proxy: http_proxy:
address: example.net address: example.net
port: 100000 port: 3128

View file

@ -6,14 +6,5 @@ manual: # Manual proxy configuration
http_proxy: # HTTP Proxy http_proxy: # HTTP Proxy
address: address: # HTTP address
description: HTTP address
type: domainname
params:
allow_ip: true
port:
description: HTTP Port
type: port
default: 8080
... ...

View file

@ -1 +0,0 @@
A variable with type "boolean"

View file

@ -1,4 +0,0 @@
---
manual:
http_proxy:
address: example.net

View file

@ -1,5 +0,0 @@
---
manual:
http_proxy:
address: example.net
use_for_https: false

View file

@ -1,8 +0,0 @@
%YAML 1.2
---
version: 1.1
manual:
use_for_https: true # Also use this proxy for HTTPS
...

View file

@ -1 +1 @@
A disabled family A variable with type "domainname"

View file

@ -1 +0,0 @@
Property disabled

View file

@ -1 +1 @@
Define access to variable or family Some suitable types

1
examples/030/URL Normal file
View file

@ -0,0 +1 @@
https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/types.html

View file

@ -1 +1,4 @@
--- ---
manual:
http_proxy:
address: example.net

View file

@ -1,7 +1,4 @@
--- ---
proxy_mode: Manual proxy configuration
manual: manual:
http_proxy: http_proxy:
address: http.proxy.net address: 192.168.0.1
port: 3128
use_for_https: false

View file

@ -0,0 +1,4 @@
---
manual:
http_proxy:
address: not a valid domain name.com

View file

@ -2,20 +2,11 @@
--- ---
version: 1.1 version: 1.1
manual: manual: # Manual proxy configuration
description: Manual proxy configuration
disabled: true
http_proxy: # HTTP Proxy http_proxy: # HTTP Proxy
address: address:
description: HTTP address description: HTTP address
type: domainname type: domainname
params:
allow_ip: true
port:
description: HTTP Port
type: port
default: 8080
... ...

View file

@ -1 +1 @@
A conditional disabled family A variable with types parameters

View file

@ -1 +1,4 @@
--- ---
manual:
http_proxy:
address: example.net

View file

@ -1,7 +1,4 @@
--- ---
proxy_mode: Manual proxy configuration
manual: manual:
http_proxy: http_proxy:
address: http.proxy.net address: 192.168.0.1
port: 3128
use_for_https: false

View file

@ -0,0 +1,4 @@
---
manual:
http_proxy:
address: not a valid domain name.com

View file

@ -2,11 +2,7 @@
--- ---
version: 1.1 version: 1.1
manual: manual: # Manual proxy configuration
description: Manual proxy configuration
disabled:
variable: _.proxy_mode
when_not: Manual proxy configuration
http_proxy: # HTTP Proxy http_proxy: # HTTP Proxy
@ -15,9 +11,4 @@ manual:
type: domainname type: domainname
params: params:
allow_ip: true allow_ip: true
port:
description: HTTP Port
type: port
default: 8080
... ...

View file

@ -1 +1 @@
Copy HTTP manual proxy to HTTPS manual proxy A variable with type "port"

View file

@ -1 +0,0 @@
Property hidden

View file

@ -1,4 +1,5 @@
--- ---
proxy_mode: Manual proxy configuration
manual: manual:
http_proxy: http_proxy:
address: example.net address: example.net

View file

@ -1,4 +1,5 @@
--- ---
proxy_mode: Manual proxy configuration
manual: manual:
http_proxy: http_proxy:
address: example.net address: example.net

View file

@ -0,0 +1,6 @@
---
proxy_mode: Manual proxy configuration
manual:
http_proxy:
address: example.net
port: 100000

View file

@ -0,0 +1,19 @@
%YAML 1.2
---
version: 1.1
manual: # Manual proxy configuration
http_proxy: # HTTP Proxy
address:
description: HTTP address
type: domainname
params:
allow_ip: true
port:
description: HTTP Port
type: port
default: 8080
...

View file

@ -1 +1 @@
A conditional hidden family A variable with type "boolean"

View file

@ -1,9 +1,4 @@
--- ---
proxy_mode: Manual proxy configuration
manual: manual:
http_proxy: http_proxy:
address: http.proxy.net address: example.net
port: 3128
use_for_https: false
https_proxy:
address: https.proxy.net

View file

@ -1,7 +1,5 @@
--- ---
proxy_mode: Manual proxy configuration
manual: manual:
http_proxy: http_proxy:
address: http.proxy.net address: example.net
port: 3128 use_for_https: false
use_for_https: true

View file

Before

Width:  |  Height:  |  Size: 118 KiB

After

Width:  |  Height:  |  Size: 118 KiB

View file

@ -5,20 +5,4 @@ version: 1.1
manual: manual:
use_for_https: true # Also use this proxy for HTTPS use_for_https: true # Also use this proxy for HTTPS
https_proxy:
description: HTTPS Proxy
hidden:
variable: _.use_for_https
address:
description: HTTPS address
type: domainname
params:
allow_ip: true
port:
description: HTTPS Port
type: port
default: 8080
... ...

View file

@ -1 +1 @@
A calculated default value HTTPS family

1
examples/040/URL Normal file
View file

@ -0,0 +1 @@
https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/properties.html

View file

@ -6,18 +6,16 @@ manual:
use_for_https: true # Also use this proxy for HTTPS use_for_https: true # Also use this proxy for HTTPS
https_proxy: https_proxy: # HTTPS Proxy
description: HTTPS Proxy
hidden:
variable: _.use_for_https
address: address:
description: HTTPS address description: HTTPS address
default: type: domainname
variable: __.http_proxy.address params:
allow_ip: true
port: port:
description: HTTPS Port description: HTTPS Port
default: type: port
variable: __.http_proxy.port default: 8080
... ...

1
examples/041/README.md Normal file
View file

@ -0,0 +1 @@
A default value calculated from another variable

View file

@ -10,12 +10,11 @@ manual:
address: address:
description: HTTPS address description: HTTPS address
type: domainname default:
params: variable: __.http_proxy.address
allow_ip: true
port: port:
description: HTTPS Port description: HTTPS Port
type: port default:
default: 8080 variable: __.http_proxy.port
... ...

View file

@ -1 +1 @@
Family: a dynamic family A disabled family

View file

@ -1 +1 @@
Dynamic family Define access to variable or family

View file

@ -1 +0,0 @@
https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/dynfam.html

View file

@ -1 +0,0 @@
../018/config

View file

@ -0,0 +1,7 @@
---
proxy_mode: Manual proxy configuration
manual:
http_proxy:
address: http.proxy.net
port: 3128
use_for_https: false

BIN
examples/050/firefox.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 117 KiB

View file

@ -0,0 +1,21 @@
%YAML 1.2
---
version: 1.1
manual:
description: Manual proxy configuration
disabled: true
http_proxy: # HTTP Proxy
address:
description: HTTP address
type: domainname
params:
allow_ip: true
port:
description: HTTP Port
type: port
default: 8080
...

View file

@ -1 +1 @@
A conditional disabled variable with dynamic identifier A conditional disabled family

View file

@ -1 +0,0 @@
../018/config

View file

@ -0,0 +1,7 @@
---
proxy_mode: Manual proxy configuration
manual:
http_proxy:
address: http.proxy.net
port: 3128
use_for_https: false

View file

@ -0,0 +1,23 @@
%YAML 1.2
---
version: 1.1
manual:
description: Manual proxy configuration
disabled:
variable: _.proxy_mode
when_not: Manual proxy configuration
http_proxy: # HTTP Proxy
address:
description: HTTP address
type: domainname
params:
allow_ip: true
port:
description: HTTP Port
type: port
default: 8080
...

Some files were not shown because too many files have changed in this diff Show more