fix: update
This commit is contained in:
parent
6f6295529a
commit
89564ccbb3
279 changed files with 1225 additions and 745 deletions
151
build.py
151
build.py
|
|
@ -1,28 +1,34 @@
|
|||
#!/usr/bin/env python3
|
||||
|
||||
import sys
|
||||
from pathlib import Path
|
||||
from ruamel.yaml import YAML
|
||||
from ansi2html import Ansi2HTMLConverter
|
||||
|
||||
from rougail import RougailConfig, Rougail
|
||||
from rougail import Rougail
|
||||
from rougail.config import get_rougail_config
|
||||
from rougail.output_exporter import RougailOutputExporter
|
||||
from rougail.user_data_file import RougailUserDataFile
|
||||
from rougail.output_doc import RougailOutputDoc
|
||||
|
||||
|
||||
NUM="50"
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
rougailconfig = RougailConfig.copy()
|
||||
version = sys.argv[1]
|
||||
# rougailconfig = RougailConfig.copy()
|
||||
rougailconfig = get_rougail_config(backward_compatibility=False, add_extra_options=False)
|
||||
rougailconfig['main_dictionaries'] = ['firefox']
|
||||
rougailconfig['default_dictionary_format_version'] = '1.1'
|
||||
if Path('foxyproxy').is_dir():
|
||||
rougailconfig['default_dictionary_format_version'] = version
|
||||
if Path('config/namespace').is_file():
|
||||
has_namespace = True
|
||||
has_foxyproxy = False
|
||||
elif Path('foxyproxy').is_dir():
|
||||
has_foxyproxy = True
|
||||
has_namespace = True
|
||||
rougailconfig['main_namespace'] = 'Firefox'
|
||||
rougailconfig['extra_dictionaries'] = {'FoxyProxy': ['foxyproxy']}
|
||||
else:
|
||||
has_foxyproxy = True
|
||||
has_foxyproxy = False
|
||||
has_namespace = False
|
||||
rougailconfig['main_namespace'] = None
|
||||
# rougailconfig['tiramisu_cache'] = "cache.py"
|
||||
# rougail = Rougail(rougailconfig)
|
||||
|
|
@ -31,19 +37,33 @@ if __name__ == "__main__":
|
|||
rougailconfig['step.output'] = 'doc'
|
||||
rougailconfig['doc.output_format'] = 'github'
|
||||
rougailconfig['doc.title_level'] = 3
|
||||
inventory = RougailOutputDoc(rougailconfig=rougailconfig)
|
||||
if Path('mode').is_file():
|
||||
rougailconfig['modes_level'] = ['basic', 'standard', 'advanced']
|
||||
has_mode = True
|
||||
else:
|
||||
has_mode = False
|
||||
inventory = RougailOutputDoc(rougailconfig=rougailconfig.copy())
|
||||
rougailconfig['step.output'] = 'exporter'
|
||||
header = inventory.formater.header()
|
||||
doc = ''
|
||||
summary = Path('summary_before.md')
|
||||
if summary.is_file():
|
||||
with summary.open('r') as sfh:
|
||||
doc = sfh.read() + '\n\n'
|
||||
else:
|
||||
doc = ''
|
||||
yaml = YAML()
|
||||
namespace = 'firefox'
|
||||
file_found = False
|
||||
subdoc = ''
|
||||
if rougailconfig['main_namespace']:
|
||||
all_dirs = [[rougailconfig['main_dictionaries']], rougailconfig['extra_dictionaries'].values()]
|
||||
else:
|
||||
all_dirs = [[rougailconfig['main_dictionaries']]]
|
||||
|
||||
doc += inventory.formater.title('Screenshot', 2) + '\n'
|
||||
doc += f'<img src="{namespace}.png" width=50% height=50% alt="{namespace.capitalize()} Proxy setting"/>\n\n'
|
||||
# with doc_file.open('r') as docfh:
|
||||
# doc += docfh.read()
|
||||
doc += '\n' + inventory.formater.title('Structure', 2) + '\n'
|
||||
for r in all_dirs:
|
||||
for dirs in r:
|
||||
for d in dirs:
|
||||
|
|
@ -53,80 +73,97 @@ if __name__ == "__main__":
|
|||
namespace = f.parent.name
|
||||
file_found = True
|
||||
if f.name.endswith('.yml') or f.name.endswith('.yaml'):
|
||||
subdoc += inventory.formater.title(str(f), 2)
|
||||
doc += inventory.formater.title(str(f), 3)
|
||||
doc += '\n```yml\n'
|
||||
with f.open(encoding="utf8") as file_fh:
|
||||
objects = yaml.load(file_fh)
|
||||
subdoc += inventory.formater.yaml(objects)
|
||||
# doc += f'\n'
|
||||
doc += f'<img src="{namespace}.png" width=50% height=50% alt="{namespace.capitalize()} Proxy setting"/>\n\n'
|
||||
with Path('summary.md').open('r') as sfh:
|
||||
summary = sfh.read()
|
||||
doc_file = Path('README.md')
|
||||
doc = header + inventory.formater.title('Summary', 1) + '\n' + summary + '\n\n' + inventory.formater.title('Structural files', 1) + doc + '\n' + subdoc
|
||||
with doc_file.open('r') as docfh:
|
||||
doc += inventory.formater.title('Description', 2) + docfh.read()
|
||||
if file_found:
|
||||
doc += inventory.formater.title('Generated documentation', 2)
|
||||
doc += file_fh.read()
|
||||
doc += '\n```\n'
|
||||
inv_doc = inventory.gen_doc()
|
||||
if file_found and inv_doc:
|
||||
doc += inventory.formater.title('Generated documentation', 3)
|
||||
CMD = f"foo@bar:~$ rougail -v {version} -m firefox/ "
|
||||
if has_namespace:
|
||||
CMD += "-s Firefox "
|
||||
if has_foxyproxy:
|
||||
cmd = f"foo@bar:~$ rougail -v 1.1 -m firefox -o doc -do github"
|
||||
else:
|
||||
cmd = f"foo@bar:~$ rougail -v 1.1 -m firefox -n Firefox -e FoxyProxy -d 1 foxyproxy -o doc -do github"
|
||||
CMD += "-xn FoxyProxy -xd 0 foxyproxy/ "
|
||||
if has_mode:
|
||||
CMD += "--modes_level basic standard advanced "
|
||||
cmd = CMD + "-o doc -do github"
|
||||
doc += f'```console\n{cmd}\n```\n'
|
||||
doc += inventory.gen_doc()
|
||||
doc += inv_doc
|
||||
#
|
||||
config = Path('config')
|
||||
if config.is_dir():
|
||||
doc += inventory.formater.title('User data', 1)
|
||||
doc += inventory.formater.title('User data', 2)
|
||||
configs = list(config.iterdir())
|
||||
configs.sort()
|
||||
for idx, dirname in enumerate(configs):
|
||||
if dirname.is_file():
|
||||
continue
|
||||
for filename in dirname.iterdir():
|
||||
if filename.name.endswith('.yml') or filename.name.endswith('.yaml'):
|
||||
doc += inventory.formater.title(f'Example {idx + 1}', 2)
|
||||
doc += inventory.formater.title(f'Example {idx + 1}', 3)
|
||||
doc += inventory.formater.title(str(filename), 4)
|
||||
doc += '\n```yml\n'
|
||||
with filename.open(encoding="utf8") as file_fh:
|
||||
objects = yaml.load(file_fh)
|
||||
doc += inventory.formater.title(str(filename), 3)
|
||||
doc += inventory.formater.yaml(objects)
|
||||
readme = dirname / 'README.md'
|
||||
if readme.is_file():
|
||||
doc += inventory.formater.title('Description', 3)
|
||||
with readme.open() as fh:
|
||||
doc += fh.read() + '\n\n'
|
||||
doc += file_fh.read()
|
||||
doc += '\n```\n'
|
||||
# with filename.open(encoding="utf8") as file_fh:
|
||||
# objects = yaml.load(file_fh)
|
||||
# doc += inventory.formater.yaml(objects)
|
||||
#readme = dirname / 'README.md'
|
||||
#if readme.is_file():
|
||||
# doc += inventory.formater.title('Description', 4)
|
||||
# with readme.open() as fh:
|
||||
# doc += fh.read() + '\n\n'
|
||||
rougail = Rougail(rougailconfig)
|
||||
tiramisu_config = rougail.get_config()
|
||||
rougailconfig['step.user_data'] = ['file']
|
||||
rougailconfig['file.filename'] = str(filename.absolute())
|
||||
rougailconfig['file.filename'] = [str(filename.absolute())]
|
||||
data = RougailUserDataFile(tiramisu_config, rougailconfig=rougailconfig)
|
||||
data.read()
|
||||
export = RougailOutputExporter(tiramisu_config, rougailconfig=rougailconfig)
|
||||
export.errors = data.errors
|
||||
export.warnings = data.warnings
|
||||
ret = data.run()
|
||||
errors = rougail.user_datas(ret)
|
||||
export = RougailOutputExporter(tiramisu_config,
|
||||
rougailconfig=rougailconfig,
|
||||
user_data_errors=errors['errors'],
|
||||
user_data_warnings=errors['warnings'],
|
||||
)
|
||||
export.exporter()
|
||||
with export.formater.console.capture() as capture:
|
||||
export.print()
|
||||
conv = Ansi2HTMLConverter(inline=True)
|
||||
doc += inventory.formater.title('Output', 3)
|
||||
if has_foxyproxy:
|
||||
cmd = f"foo@bar:~$ rougail -v 1.1 -m firefox -u file -ff {filename}"
|
||||
else:
|
||||
cmd = f"foo@bar:~$ rougail -v 1.1 -m firefox -n Firefox -e FoxyProxy -d 1 foxyproxy -u file -ff {filename}"
|
||||
doc += inventory.formater.title('Output', 4)
|
||||
cmd = CMD + f"-u file -ff {filename}"
|
||||
doc += f"```console\n{cmd}\n```\n"
|
||||
doc += '<pre>' + conv.convert(capture.get(), full=False) + "</pre>\n"
|
||||
if (dirname / 'read_write').is_file():
|
||||
conv_data = '<pre>' + conv.convert(capture.get(), full=False) + "</pre>\n"
|
||||
doc += conv_data
|
||||
with open(dirname / 'output_ro.html', 'w') as fh_output:
|
||||
fh_output.write(conv_data)
|
||||
if (config / 'read_write').is_file():
|
||||
rougailconfig['exporter.read_write'] = True
|
||||
export = RougailOutputExporter(tiramisu_config, rougailconfig=rougailconfig)
|
||||
export = RougailOutputExporter(tiramisu_config,
|
||||
rougailconfig=rougailconfig,
|
||||
user_data_errors=data.errors,
|
||||
user_data_warnings=data.warnings,
|
||||
)
|
||||
export.exporter()
|
||||
with export.formater.console.capture() as capture:
|
||||
export.print()
|
||||
conv = Ansi2HTMLConverter(inline=True)
|
||||
doc += inventory.formater.title('Output in read write mode', 3)
|
||||
if has_foxyproxy:
|
||||
cmd = f"foo@bar:~$ rougail -v 1.1 -m firefox -u file -ff {filename} --exporter.read_write"
|
||||
else:
|
||||
cmd = f"foo@bar:~$ rougail -v 1.1 -m firefox -n Firefox -e FoxyProxy -d 1 foxyproxy -u file -ff {filename} --exporter.read_write"
|
||||
doc += inventory.formater.title('Output in read write mode', 4)
|
||||
cmd = cmd + " --exporter.read_write"
|
||||
doc += f"```console\n{cmd}\n```\n"
|
||||
doc += '<pre>' + conv.convert(capture.get(), full=False) + "</pre>\n"
|
||||
conv_data = '<pre>' + conv.convert(capture.get(), full=False) + "</pre>\n"
|
||||
doc += '<pre>' + conv_data + "</pre>\n"
|
||||
with open(dirname / 'output_rw.html', 'w') as fh_output:
|
||||
fh_output.write(conv_data)
|
||||
#
|
||||
summary = Path('summary_after.md')
|
||||
if summary.is_file():
|
||||
with summary.open('r') as sfh:
|
||||
doc += '\n\n' + sfh.read()
|
||||
#
|
||||
doc_file = Path('README.md')
|
||||
with doc_file.open('w') as docfh:
|
||||
docfh.write(doc)
|
||||
with doc_file.open('w') as docfh:
|
||||
|
|
|
|||
100
build.sh
100
build.sh
|
|
@ -1,4 +1,8 @@
|
|||
#!/bin/bash -e
|
||||
|
||||
#-----------------------
|
||||
VERSION=1.1
|
||||
#-----------------------
|
||||
set -x
|
||||
DEST=../rougail-tutorials
|
||||
|
||||
|
|
@ -13,6 +17,8 @@ BUILDER="$(pwd)"
|
|||
mkdir -p $DEST/firefox
|
||||
rm -f summary.md
|
||||
touch summary.md
|
||||
rm -f summary_total.md
|
||||
touch summary_total.md
|
||||
cd "$DEST"
|
||||
DEST="$(pwd)"
|
||||
|
||||
|
|
@ -21,20 +27,40 @@ cp "$BUILDER"/firefox.png .
|
|||
cp "$BUILDER"/foxyproxy.png .
|
||||
cp "$BUILDER"/summary.md .
|
||||
touch README.md
|
||||
"$BUILDER"/build.py
|
||||
"$BUILDER"/build.py "$VERSION"
|
||||
rm -rf summary.md
|
||||
rm -rf summary_total.md
|
||||
rm -rf jinja_caches
|
||||
git init -b 1.1
|
||||
git init -b "$VERSION"
|
||||
git add .
|
||||
git commit -am"$(cat $BUILDER/TITLE)"
|
||||
#old_commit_id="$(git rev-parse HEAD)"
|
||||
cd - > /dev/null
|
||||
|
||||
for i in $(ls -d "examples"/* | sort); do
|
||||
num=$(echo $(basename "$i"))
|
||||
echo "$num"
|
||||
commit_id="v$VERSION_$num"
|
||||
summary="[tutorial $(basename $i)] $(head -n 1 $i/README.md)"
|
||||
echo "- [$summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/$commit_id/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/${commit_id}~1..$commit_id))" >> summary_total.md
|
||||
done
|
||||
|
||||
for i in $(ls -d "examples"/* | sort); do
|
||||
if [ -f "$i/TITLE.md" ]; then
|
||||
echo "- $(head -n 1 $i/TITLE.md)" >> summary.md
|
||||
fi
|
||||
if [ -f "$i/SUBTITLE.md" ]; then
|
||||
echo " - $(head -n 1 $i/SUBTITLE.md)" >> summary.md
|
||||
fi
|
||||
if [ -f "$i/README.md" ]; then
|
||||
rm -rf "$DEST/config"
|
||||
cp "summary.md" "$DEST"
|
||||
echo $(basename "$i")
|
||||
#
|
||||
rm -rf "$DEST/config"
|
||||
num=$(echo $(basename "$i"))
|
||||
echo "$num"
|
||||
commit_id="v$VERSION_$num"
|
||||
summary="[tutorial $(basename $i)] $(head -n 1 $i/README.md)"
|
||||
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) ([diff]($diff_url))" >> summary.md
|
||||
cp "summary_total.md" "$DEST"
|
||||
cd "$i/dictionaries"
|
||||
if [ -d firefox ]; then
|
||||
for j in $(ls firefox/*.yml 2>/dev/null); do
|
||||
|
|
@ -52,20 +78,52 @@ for i in $(ls -d "examples"/* | sort); do
|
|||
cp -aL ../config "$DEST"
|
||||
fi
|
||||
msg="[tutorial $(basename $i)] $(cat ../README.md)"
|
||||
summary="[tutorial $(basename $i)] $(head -n 1 ../README.md)"
|
||||
[ -e ../firefox.png ] && cp ../firefox.png "$DEST"
|
||||
[ -e ../foxyproxy.png ] && cp ../foxyproxy.png "$DEST"
|
||||
cd - > /dev/null
|
||||
cd "$DEST"
|
||||
echo "- $summary" >> summary.md
|
||||
"$BUILDER"/build.py
|
||||
rm -rf config/*/README.md config/*/read_write
|
||||
rm -rf jinja_caches summary.md
|
||||
#
|
||||
before=$(grep "commit/$commit_id/README.md" summary_total.md -B1 | wc -l)
|
||||
echo "- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/$VERSION/README.md)" > summary_before.md
|
||||
if [ "$before" = "2" ]; then
|
||||
echo $(grep "commit/$commit_id/README.md" summary_total.md -B1 | head -n 1) >> summary_before.md
|
||||
fi
|
||||
echo "" >> summary_before.md
|
||||
echo "# $summary" >> summary_before.md
|
||||
echo "" >> summary_before.md
|
||||
echo "[View the diff]($diff_url)" >> summary_before.md
|
||||
after=$(grep "commit/$commit_id/README.md" summary_total.md -A1 | wc -l)
|
||||
if [ "$after" = "2" ]; then
|
||||
echo $(grep "commit/$commit_id/README.md" summary_total.md -A1 | tail -n 1) > summary_after.md
|
||||
fi
|
||||
#
|
||||
if [ -f config/mode ]; then
|
||||
mv config/mode mode
|
||||
fi
|
||||
"$BUILDER"/build.py "$VERSION"
|
||||
rm -rf config/*/README.md config/read_write config/namespace
|
||||
rm -rf jinja_caches summary.md summary_before.md summary_after.md summary_total.md
|
||||
if [ -f mode ]; then
|
||||
MODE=1
|
||||
rm -f mode
|
||||
else
|
||||
MODE=0
|
||||
fi
|
||||
git add *.png README.md
|
||||
if [ -d config ]; then
|
||||
git add config
|
||||
else
|
||||
git status |grep -q config && git add config
|
||||
fi
|
||||
git commit -m"$summary (config and doc)"
|
||||
git add .
|
||||
git commit -am"$msg"
|
||||
commit_id="$(git rev-parse HEAD)"
|
||||
git tag -a "$commit_id" -m"format version $VERSION: $num"
|
||||
if [ "$MODE" = 1 ]; then
|
||||
touch mode
|
||||
fi
|
||||
cd - > /dev/null
|
||||
echo "- [$summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/$commit_id/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/commit/$commit_id))" >> summary.md
|
||||
# old_commit_id="$commit_id"
|
||||
fi
|
||||
done
|
||||
cd "$DEST"
|
||||
|
|
@ -85,18 +143,30 @@ This is what the page looks like:
|
|||
|
||||
|
||||
" > README.md
|
||||
echo '# Installation
|
||||
|
||||
```bash
|
||||
# python -m venv rougail
|
||||
# . rougail/bin/activate
|
||||
# pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user-data-file
|
||||
```
|
||||
' >> README.md
|
||||
echo "# Summary
|
||||
|
||||
Each step is a separerate commit. You can navigate to history to discover different aspect to the Rougail format.
|
||||
" >> README.md
|
||||
cp "$BUILDER"/firefox.png .
|
||||
cp "$BUILDER"/foxyproxy.png .
|
||||
cat "$BUILDER"/summary.md >> README.md
|
||||
echo >> README.md
|
||||
rm -rf firefox foxyproxy mode
|
||||
git add .
|
||||
rm -rf firefox foxyproxy
|
||||
git commit -am"Summary"
|
||||
#
|
||||
git remote add origin ssh://git@forge.cloud.silique.fr:2222/stove/rougail-tutorials.git
|
||||
git push --set-upstream origin 1.1 --force
|
||||
git push --set-upstream origin $VERSION --force
|
||||
git push --tag --force
|
||||
|
||||
rm -f summary.md summary_total.md
|
||||
echo "FAIT"
|
||||
exit 0
|
||||
|
|
|
|||
1
examples/000/README.md
Normal file
1
examples/000/README.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
A structured file with format version
|
||||
1
examples/000/SUBTITLE.md
Normal file
1
examples/000/SUBTITLE.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
Structural file
|
||||
1
examples/000/TITLE.md
Normal file
1
examples/000/TITLE.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
Getting started
|
||||
2
examples/000/dictionaries/firefox/00-proxy.yml
Normal file
2
examples/000/dictionaries/firefox/00-proxy.yml
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
---
|
||||
version: 1.1
|
||||
|
|
@ -1,10 +1 @@
|
|||
A first variable
|
||||
|
||||
In the Firefox configuration, it is possible to define several configuration modes,
|
||||
from no proxy at all ("No proxy") to a kind of automatic configuration mode from a file
|
||||
("Automatic proxy configuration URL").
|
||||
|
||||
We’re gonna create a first variable called "proxy_mode":
|
||||
|
||||
- accepts only a string as value
|
||||
- requires a value (that is, None is not an option)
|
||||
The format version in commandline
|
||||
|
|
|
|||
|
|
@ -1,2 +1 @@
|
|||
---
|
||||
proxy_mode:
|
||||
|
|
|
|||
Binary file not shown.
|
Before Width: | Height: | Size: 119 KiB |
|
|
@ -1,9 +0,0 @@
|
|||
The variable description
|
||||
|
||||
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/gnunux/rougail-user-data-questionary)).
|
||||
|
|
@ -1 +0,0 @@
|
|||
../001/config
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
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").
|
||||
|
|
@ -1 +0,0 @@
|
|||
../001/config
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
A variable with type choice
|
||||
|
||||
"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.
|
||||
|
|
@ -1 +0,0 @@
|
|||
../001/config
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
Choice type is optional
|
||||
|
||||
The type is optional in choice type (if we have choices attributes, it's a choice option).
|
||||
|
|
@ -1 +0,0 @@
|
|||
../001/config
|
||||
|
|
@ -1,14 +1 @@
|
|||
A family
|
||||
|
||||
The "manual" mode structural descriptions are write in a new files to separate things. But Rougail will concatenate variables and families.
|
||||
|
||||
We create a family, which will contain other variables.
|
||||
|
||||
This family has:
|
||||
|
||||
- a description
|
||||
- a type
|
||||
|
||||
As there is no variable inside this family, the type is mandatory. Without it, Rougail will create a variable.
|
||||
|
||||
In fact, this family will be deleted by Rougail too because it is empty.
|
||||
A first variable with only a name
|
||||
|
|
|
|||
1
examples/010/SUBTITLE.md
Normal file
1
examples/010/SUBTITLE.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
Variable: choice the proxy mode
|
||||
2
examples/010/dictionaries/firefox/00-proxy.yml
Normal file
2
examples/010/dictionaries/firefox/00-proxy.yml
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
---
|
||||
proxy_mode:
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 118 KiB After Width: | Height: | Size: 119 KiB |
Binary file not shown.
|
|
@ -1,5 +1,9 @@
|
|||
Conditional desactived family
|
||||
The variable description
|
||||
|
||||
This family will be desactived if "proxy_mode" is not "manual proxy configuration".
|
||||
We can add a description to this first variable.
|
||||
|
||||
Desactived a variable or a family means that this variable will never be accessible.
|
||||
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/gnunux/rougail-user-data-questionary)).
|
||||
|
|
|
|||
1
examples/011/config
Symbolic link
1
examples/011/config
Symbolic link
|
|
@ -0,0 +1 @@
|
|||
../010/config
|
||||
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
manual:
|
||||
description: Manual proxy configuration
|
||||
type: family
|
||||
disabled:
|
||||
type: variable
|
||||
variable: proxy_mode
|
||||
when_not: 'Manual proxy configuration'
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
A sub family
|
||||
A default value
|
||||
|
||||
Inside a family, we can have variables or families.
|
||||
Now we can define the default value of this variable.
|
||||
|
||||
The "type" for family "manual" became unecessary because container an other family, so it's not a variable.
|
||||
If the user doesn't touch this variable's value, the value is "No proxy"
|
||||
|
||||
In disabled attribute, it's better tu use relative path (we will see the reason in an other slide).
|
||||
As user intervention is no more required, so the variable change it's default mode too (from "basic" to "standard").
|
||||
|
|
|
|||
1
examples/012/config
Symbolic link
1
examples/012/config
Symbolic link
|
|
@ -0,0 +1 @@
|
|||
../010/config
|
||||
|
|
@ -1,5 +1,7 @@
|
|||
Family in "shorthand" mode
|
||||
A variable with type "choice"
|
||||
|
||||
The sub family is now in "shorthand" mode. In this mode we can only define "name" and "description" attributes.
|
||||
"Foo" should not be an option to the "proxy_mode" variable.
|
||||
|
||||
Inside the sub family we add two variables (with domainname and port types).
|
||||
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.
|
||||
|
|
|
|||
1
examples/013/config
Symbolic link
1
examples/013/config
Symbolic link
|
|
@ -0,0 +1 @@
|
|||
../010/config
|
||||
|
|
@ -1,3 +1,3 @@
|
|||
A boolean variable
|
||||
Choice type is optional
|
||||
|
||||
Let's create a boolean variable.
|
||||
The type is optional in choice type (if we have choices attributes, it's a choice option).
|
||||
|
|
|
|||
1
examples/014/config
Symbolic link
1
examples/014/config
Symbolic link
|
|
@ -0,0 +1 @@
|
|||
../010/config
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
Bases type is optional if default value
|
||||
|
||||
The type is deduct with the default value type. This is only true for "string", "number", "float" or "boolean" variables.
|
||||
|
|
@ -1 +0,0 @@
|
|||
../014/config
|
||||
|
|
@ -1,9 +0,0 @@
|
|||
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
|
||||
|
|
@ -1 +0,0 @@
|
|||
../014/config
|
||||
|
|
@ -1,9 +0,0 @@
|
|||
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.
|
||||
|
|
@ -1 +0,0 @@
|
|||
If "use_for_https" is true, HTTPS variables are visible in read only mode, but not in read write mode.
|
||||
|
|
@ -1,44 +0,0 @@
|
|||
---
|
||||
manual:
|
||||
description: Manual proxy configuration
|
||||
disabled:
|
||||
type: variable
|
||||
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
|
||||
|
||||
use_for_https: true # Also use this proxy for HTTPS
|
||||
|
||||
https_proxy:
|
||||
description: HTTPS Proxy
|
||||
hidden:
|
||||
type: variable
|
||||
variable: _.use_for_https
|
||||
|
||||
address:
|
||||
description: HTTPS address
|
||||
type: domainname
|
||||
params:
|
||||
allow_ip: true
|
||||
default:
|
||||
type: variable
|
||||
variable: __.http_proxy.address
|
||||
|
||||
port:
|
||||
description: HTTPS Port
|
||||
type: port
|
||||
default:
|
||||
type: variable
|
||||
variable: __.http_proxy.port
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
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
|
||||
|
|
@ -1,54 +0,0 @@
|
|||
---
|
||||
manual:
|
||||
description: Manual proxy configuration
|
||||
disabled:
|
||||
type: variable
|
||||
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
|
||||
|
||||
use_for_https: true # Also use this proxy for HTTPS
|
||||
|
||||
"{{ suffix }}_proxy":
|
||||
description: "{{ suffix }} Proxy"
|
||||
type: dynamic
|
||||
dynamic:
|
||||
- HTTPS
|
||||
- SOCKS
|
||||
hidden:
|
||||
type: jinja
|
||||
jinja: |
|
||||
{% if suffix == 'HTTPS' and _.use_for_https %}
|
||||
HTTPS is same has HTTP
|
||||
{% endif %}
|
||||
params:
|
||||
suffix:
|
||||
type: suffix
|
||||
|
||||
address:
|
||||
description: "{{ suffix }} address"
|
||||
type: domainname
|
||||
params:
|
||||
allow_ip: true
|
||||
default:
|
||||
type: variable
|
||||
variable: __.http_proxy.address
|
||||
|
||||
port:
|
||||
description: "{{ suffix }} port"
|
||||
type: port
|
||||
default:
|
||||
type: variable
|
||||
variable: __.http_proxy.port
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
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.
|
||||
|
|
@ -1,70 +0,0 @@
|
|||
---
|
||||
manual:
|
||||
description: Manual proxy configuration
|
||||
disabled:
|
||||
type: variable
|
||||
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
|
||||
|
||||
use_for_https: true # Also use this proxy for HTTPS
|
||||
|
||||
"{{ suffix }}_proxy":
|
||||
description: "{{ suffix }} Proxy"
|
||||
type: dynamic
|
||||
dynamic:
|
||||
- HTTPS
|
||||
- SOCKS
|
||||
hidden:
|
||||
type: jinja
|
||||
jinja: |
|
||||
{% if suffix == 'HTTPS' and _.use_for_https %}
|
||||
HTTPS is same has HTTP
|
||||
{% endif %}
|
||||
params:
|
||||
suffix:
|
||||
type: suffix
|
||||
description: |
|
||||
if "use_for_https" is set to True
|
||||
|
||||
address:
|
||||
description: "{{ suffix }} address"
|
||||
default:
|
||||
type: variable
|
||||
variable: __.http_proxy.address
|
||||
|
||||
port:
|
||||
description: "{{ suffix }} port"
|
||||
default:
|
||||
type: variable
|
||||
variable: __.http_proxy.port
|
||||
|
||||
version:
|
||||
description: SOCKS host version used by proxy
|
||||
choices:
|
||||
- v4
|
||||
- v5
|
||||
default: v5
|
||||
disabled:
|
||||
type: jinja
|
||||
jinja: |
|
||||
{% if suffix == 'HTTPS' %}
|
||||
if HTTPS
|
||||
{% endif %}
|
||||
params:
|
||||
suffix:
|
||||
type: suffix
|
||||
description: |
|
||||
if not SOCKS
|
||||
|
|
@ -1,3 +1,14 @@
|
|||
A conditional disabled variable
|
||||
A family
|
||||
|
||||
Add a new "auto" variable.
|
||||
The "manual" mode structural descriptions are write in a new files to separate things. But Rougail will concatenate variables and families.
|
||||
|
||||
We create a family, which will contain other variables.
|
||||
|
||||
This family has:
|
||||
|
||||
- a description
|
||||
- a type
|
||||
|
||||
As there is no variable inside this family, the type is mandatory. Without it, Rougail will create a variable.
|
||||
|
||||
In fact, this family will be deleted by Rougail too because it is empty.
|
||||
|
|
|
|||
1
examples/020/SUBTITLE.md
Normal file
1
examples/020/SUBTITLE.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
Family: proxy manual
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 118 KiB After Width: | Height: | Size: 117 KiB |
Binary file not shown.
7
examples/021/README.md
Normal file
7
examples/021/README.md
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
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.
|
||||
|
||||
In disabled attribute, it's better tu use relative path (we will see the reason in an other slide).
|
||||
|
|
@ -1,10 +1,7 @@
|
|||
---
|
||||
manual:
|
||||
description: Manual proxy configuration
|
||||
disabled:
|
||||
type: variable
|
||||
variable: _.proxy_mode
|
||||
when_not: 'Manual proxy configuration'
|
||||
type: family
|
||||
|
||||
http_proxy:
|
||||
description: HTTP Proxy
|
||||
1
examples/022/README.md
Normal file
1
examples/022/README.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
A variable inside sub family
|
||||
11
examples/022/dictionaries/firefox/10-manual.yml
Normal file
11
examples/022/dictionaries/firefox/10-manual.yml
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
---
|
||||
manual:
|
||||
description: Manual proxy configuration
|
||||
type: family
|
||||
|
||||
http_proxy:
|
||||
description: HTTP Proxy
|
||||
type: family
|
||||
|
||||
address:
|
||||
description: HTTP address
|
||||
1
examples/023/README.md
Normal file
1
examples/023/README.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
Family type is optional
|
||||
1
examples/023/config
Symbolic link
1
examples/023/config
Symbolic link
|
|
@ -0,0 +1 @@
|
|||
../010/config
|
||||
9
examples/023/dictionaries/firefox/10-manual.yml
Normal file
9
examples/023/dictionaries/firefox/10-manual.yml
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
---
|
||||
manual:
|
||||
description: Manual proxy configuration
|
||||
|
||||
http_proxy:
|
||||
description: HTTP Proxy
|
||||
|
||||
address:
|
||||
description: HTTP address
|
||||
1
examples/024/README.md
Normal file
1
examples/024/README.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
A variable with type "domainname"
|
||||
1
examples/024/SUBTITLE.md
Normal file
1
examples/024/SUBTITLE.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
Variable: type and type parameters
|
||||
1
examples/024/TITLE.md
Normal file
1
examples/024/TITLE.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
HTTP Manual mode
|
||||
2
examples/024/config/02/config.yaml
Normal file
2
examples/024/config/02/config.yaml
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
---
|
||||
proxy_mode: Manual proxy configuration
|
||||
5
examples/024/config/03/config.yaml
Normal file
5
examples/024/config/03/config.yaml
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
proxy_mode: Manual proxy configuration
|
||||
manual:
|
||||
http_proxy:
|
||||
address: example.net
|
||||
6
examples/024/config/04/config.yaml
Normal file
6
examples/024/config/04/config.yaml
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
proxy_mode: Manual proxy configuration
|
||||
manual:
|
||||
http_proxy:
|
||||
address: example.net
|
||||
port: '3128'
|
||||
2
examples/024/config/05/README.md
Normal file
2
examples/024/config/05/README.md
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
If "use_for_https" is false, HTTPS variables are visible in read only mode and in read write mode.
|
||||
|
||||
9
examples/024/config/05/config.yaml
Normal file
9
examples/024/config/05/config.yaml
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
---
|
||||
proxy_mode: Manual proxy configuration
|
||||
manual:
|
||||
http_proxy:
|
||||
address: http.proxy.net
|
||||
port: '3128'
|
||||
use_for_https: false
|
||||
https_proxy:
|
||||
address: https.proxy.net
|
||||
10
examples/024/dictionaries/firefox/10-manual.yml
Normal file
10
examples/024/dictionaries/firefox/10-manual.yml
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
---
|
||||
manual:
|
||||
description: Manual proxy configuration
|
||||
|
||||
http_proxy:
|
||||
description: HTTP Proxy
|
||||
|
||||
address:
|
||||
description: HTTP address
|
||||
type: domainname
|
||||
1
examples/025/README.md
Normal file
1
examples/025/README.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
A variable with type's parameters
|
||||
1
examples/025/config
Symbolic link
1
examples/025/config
Symbolic link
|
|
@ -0,0 +1 @@
|
|||
../022/config
|
||||
12
examples/025/dictionaries/firefox/10-manual.yml
Normal file
12
examples/025/dictionaries/firefox/10-manual.yml
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
---
|
||||
manual:
|
||||
description: Manual proxy configuration
|
||||
|
||||
http_proxy:
|
||||
description: HTTP Proxy
|
||||
|
||||
address:
|
||||
description: HTTP address
|
||||
type: domainname
|
||||
params:
|
||||
allow_ip: true
|
||||
1
examples/026/README.md
Normal file
1
examples/026/README.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
A variable with type "port"
|
||||
1
examples/026/config
Symbolic link
1
examples/026/config
Symbolic link
|
|
@ -0,0 +1 @@
|
|||
../022/config
|
||||
17
examples/026/dictionaries/firefox/10-manual.yml
Normal file
17
examples/026/dictionaries/firefox/10-manual.yml
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
---
|
||||
manual:
|
||||
description: Manual proxy configuration
|
||||
|
||||
http_proxy:
|
||||
description: HTTP Proxy
|
||||
|
||||
address:
|
||||
description: HTTP address
|
||||
type: domainname
|
||||
params:
|
||||
allow_ip: true
|
||||
|
||||
port:
|
||||
description: HTTP Port
|
||||
type: port
|
||||
default: 8080
|
||||
1
examples/027/README.md
Normal file
1
examples/027/README.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
A disabled family
|
||||
1
examples/027/SUBTITLE.md
Normal file
1
examples/027/SUBTITLE.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
Property: disabled
|
||||
1
examples/027/config
Symbolic link
1
examples/027/config
Symbolic link
|
|
@ -0,0 +1 @@
|
|||
../022/config
|
||||
18
examples/027/dictionaries/firefox/10-manual.yml
Normal file
18
examples/027/dictionaries/firefox/10-manual.yml
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
manual:
|
||||
description: Manual proxy configuration
|
||||
disabled: true
|
||||
|
||||
http_proxy:
|
||||
description: HTTP Proxy
|
||||
|
||||
address:
|
||||
description: HTTP address
|
||||
type: domainname
|
||||
params:
|
||||
allow_ip: true
|
||||
|
||||
port:
|
||||
description: HTTP Port
|
||||
type: port
|
||||
default: 8080
|
||||
1
examples/028/README.md
Normal file
1
examples/028/README.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
A conditional disabled family with a variable
|
||||
1
examples/028/config
Symbolic link
1
examples/028/config
Symbolic link
|
|
@ -0,0 +1 @@
|
|||
../022/config
|
||||
|
|
@ -3,10 +3,11 @@ manual:
|
|||
description: Manual proxy configuration
|
||||
disabled:
|
||||
type: variable
|
||||
variable: _.proxy_mode
|
||||
variable: proxy_mode
|
||||
when_not: 'Manual proxy configuration'
|
||||
|
||||
http_proxy: # HTTP Proxy
|
||||
http_proxy:
|
||||
description: HTTP Proxy
|
||||
|
||||
address:
|
||||
description: HTTP address
|
||||
|
|
@ -18,7 +19,3 @@ manual:
|
|||
description: HTTP Port
|
||||
type: port
|
||||
default: 8080
|
||||
|
||||
use_for_https:
|
||||
description: Also use this proxy for HTTPS
|
||||
default: true
|
||||
1
examples/029/README.md
Normal file
1
examples/029/README.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
Type variable is optional
|
||||
|
|
@ -2,11 +2,11 @@
|
|||
manual:
|
||||
description: Manual proxy configuration
|
||||
disabled:
|
||||
type: variable
|
||||
variable: _.proxy_mode
|
||||
variable: proxy_mode
|
||||
when_not: 'Manual proxy configuration'
|
||||
|
||||
http_proxy: # HTTP Proxy
|
||||
http_proxy:
|
||||
description: HTTP Proxy
|
||||
|
||||
address:
|
||||
description: HTTP address
|
||||
|
|
@ -18,8 +18,3 @@ manual:
|
|||
description: HTTP Port
|
||||
type: port
|
||||
default: 8080
|
||||
|
||||
use_for_https:
|
||||
description: Also use this proxy for HTTPS
|
||||
type: boolean
|
||||
default: true
|
||||
|
|
@ -1,4 +1 @@
|
|||
A conditional disabled variable
|
||||
|
||||
Add a new "no\_proxy" variable.
|
||||
|
||||
A variable with type "boolean"
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue