build.py

@@ -5,7 +5,6 @@ from json import dump, loads
 from pathlib import Path
 from ruamel.yaml import YAML
 from ansi2html import Ansi2HTMLConverter
-from bs4 import BeautifulSoup
 
 from rougail import Rougail
 from rougail.config import get_rougail_config
@@ -14,12 +13,11 @@ from rougail.user_data_yaml import RougailUserDataYaml
 from rougail.output_doc import RougailOutputDoc
 
 
+PREVIOUS = Path("previous.yml")
+
+
 if __name__ == "__main__":
-    builder_dir = sys.argv[1]
-    previous = Path(builder_dir) / "previous.yml"
-    with Path("install.txt").open() as fh:
-        cmd = fh.read()
-    commit_id = sys.argv[2]
+    commit_id = sys.argv[1]
 #    rougailconfig = RougailConfig.copy()
     rougailconfig = get_rougail_config(backward_compatibility=False, add_extra_options=False)
     rougailconfig['main_structural_directories'] = ['firefox']
@@ -41,10 +39,10 @@ if __name__ == "__main__":
         has_mode = True
     else:
         has_mode = False
-    rougailconfig['step.output'] = 'doc'
     rougail = Rougail(rougailconfig)
     config = rougail.run()
 #    print(config.value.get())
+    rougailconfig['step.output'] = 'doc'
     rougailconfig['doc.output_format'] = 'github'
     rougailconfig['doc.title_level'] = 3
     inventory = RougailOutputDoc(config, rougailconfig=rougailconfig.copy())
@@ -59,81 +57,70 @@ if __name__ == "__main__":
         doc = ''
     yaml = YAML()
     namespace = 'firefox'
+    file_found = False
     if rougailconfig['main_namespace']:
-        dirname = "foxyproxy"
+        all_dirs = [[rougailconfig['main_structural_directories']], [['foxyproxy']]]
     else:
-        dirname = "firefox"
+        all_dirs = [[rougailconfig['main_structural_directories']]]
+
     doc += inv_formatter.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' + inv_formatter.title('Clone and install', 2) + '\n\n'
-    doc += "To test this tutorial, you need to download this repository and install Rougail:\n\n"
-    doc += f'```shell\n{cmd}```\n\n'
-    doc += "Then switch to the tutorial page:\n\n"
-    doc += f"```shell\ngit switch --detach {commit_id}\n```\n"
-    tree = Path('tree.html')
-    display_yml = None
-    if tree.is_file():
-        doc += '\n' + inv_formatter.title('Structure', 2) + '\n\n'
-        with tree.open() as fh:
-            soup = BeautifulSoup(fh.read(), features="lxml")
-            doc += str(soup.find('p')) + "\n\n"
-    for f in Path('.').iterdir():
-        if f.name.startswith('DISPLAY_'):
-            filename = f.name[9:]
-            display_yml = Path(dirname) / filename
-            break
-    else:
-        files = list(Path(dirname).iterdir())
-        files.sort()
-        for f in reversed(files):
-            if not f.name.endswith('.yml'):
-                continue
-            display_yml = f
-            break
-    if display_yml:
-        doc += f"Contents of the {str(display_yml)} file"
-        doc += '\n\n```yml\n'
-        with display_yml.open(encoding="utf8") as file_fh:
-            doc += file_fh.read()
-        doc += '\n```\n'
+    doc += '\n' + inv_formatter.title('Structure', 2) + '\n'
+    print(all_dirs)
+    for r in all_dirs:
+        for dirs in r:
+            for d in dirs:
+                print(d)
+                files = list(Path(d).iterdir())
+                files.sort()
+                for f in files:
+                    namespace = f.parent.name
+                    file_found = True
+                    if f.name.endswith('.yml') or f.name.endswith('.yaml'):
+                        doc += inv_formatter.title(str(f), 3)
+                        doc += '\n```yml\n'
+                        with f.open(encoding="utf8") as file_fh:
+                            doc += file_fh.read()
+                        doc += '\n```\n'
     rougailconfig['step.output'] = 'doc'
-    rougailconfig["doc.title_level"] = 4
     inv_doc = inventory.run()[1]
-    CMD = "rougail -m firefox/ "
-    if has_namespace:
-        CMD += "-s Firefox "
-    if has_foxyproxy:
-        CMD += "-xn FoxyProxy -xd 0 foxyproxy/ "
-    if has_mode:
-        CMD += "--modes_level basic standard advanced "
-    if inv_doc:
-        doc += inv_formatter.title("Let's generate the documentation", 3)
-        cmd = CMD + "-o doc"
-        doc += f'```shell\n{cmd}\n```\n'
+    if file_found and inv_doc:
+        doc += inv_formatter.title('Generated documentation', 3)
+        CMD = f"foo@bar:~$ git switch --detach {commit_id}\n"
+        CMD += "foo@bar:~$ rougail -m firefox/ "
+        if has_namespace:
+            CMD += "-s Firefox "
+        if has_foxyproxy:
+            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 += inv_doc
-    if previous.is_file():
+    if PREVIOUS.is_file():
+        rougailconfig["doc.title_level"] = 5
         rougailconfig["doc.contents"] = ["changelog"]
-        rougailconfig["doc.previous_json_file"] = str(previous)
+        rougailconfig["doc.previous_json_file"] = str(PREVIOUS)
     inv_doc = inventory.run()[1]
-    if inv_doc:
-        doc += inv_formatter.title("Let's generate the changelog", 3)
-        cmd = CMD + "-o doc --doc.contents changelog"
-        doc += f'```shell\n{cmd}\n```\n'
-        doc += inv_doc + "\n"
+    if file_found and inv_doc:
+        doc += inv_formatter.title('Changelog', 3)
+        cmd = CMD + "-o doc --doc.contents variables changelog -do github"
+        doc += f'```console\n{cmd}\n```\n'
+        doc += inv_doc
     # save PREVIOUS
     rougailconfig["doc.contents"] = ["variables"]
     rougailconfig['doc.output_format'] = 'json'
     data = inventory.run()[1]
     if data:
-        with previous.open('w') as fh:
+        with PREVIOUS.open('w') as fh:
             dump(loads(data), fh)
     #
     rougailconfig['step.output'] = 'console'
     config = Path('config')
     if config.is_dir():
-        doc += inv_formatter.title('User datas', 2)
+        doc += inv_formatter.title('User data', 2)
         configs = list(config.iterdir())
         configs.sort()
         for idx, dirname in enumerate(configs):
@@ -146,7 +133,15 @@ if __name__ == "__main__":
                     doc += '\n```yml\n'
                     with filename.open(encoding="utf8") as file_fh:
                         doc += file_fh.read()
-                    doc += '```\n'
+                    doc += '\n```\n'
+#                    with filename.open(encoding="utf8") as file_fh:
+#                        objects = yaml.load(file_fh)
+#                    doc += inv_formatter.yaml(objects)
+                    #readme = dirname / 'README.md'
+                    #if readme.is_file():
+                    #    doc += inv_formatter.title('Description', 4)
+                    #    with readme.open() as fh:
+                    #        doc += fh.read() + '\n\n'
                     rougail = Rougail(rougailconfig)
                     tiramisu_config = rougail.run()
                     rougailconfig['step.user_data'] = ['yaml']
@@ -162,51 +157,26 @@ if __name__ == "__main__":
                     console = export.run()[1]
                     conv = Ansi2HTMLConverter(inline=True)
                     doc += inv_formatter.title('Output', 4)
-                    cmd = CMD + f"-u yaml -yf {filename}"
-                    with (dirname / "cmd_ro.txt").open("w") as fh:
-                        fh.write(cmd)
-                    doc += f"```shell\n{cmd}\n```\n"
+                    cmd = CMD + f"-u yaml -ff {filename}"
+                    doc += f"```console\n{cmd}\n```\n"
                     conv_data = '<pre>' + conv.convert(console, full=False) + "</pre>\n"
                     doc += conv_data
                     with open(dirname / 'output_ro.html', 'w') as fh_output:
                         fh_output.write(conv_data)
-                    if (dirname / 'invalid').is_file():
-                        errors2 = rougail.user_datas(ret, invalid_user_datas_error=True)
+                    if (config / 'read_write').is_file():
+                        tiramisu_config.property.read_write
                         export = RougailOutputConsole(tiramisu_config,
                                                       rougailconfig=rougailconfig,
-                                                      user_data_errors=errors2['errors'],
-                                                      user_data_warnings=errors2['warnings'],
-                                                      )
-                        console = export.run()[1]
-                        conv = Ansi2HTMLConverter(inline=True)
-                        doc += inv_formatter.title('Output when invalid user datas is an error', 4)
-                        cmd2 = cmd + " --cli.invalid_user_datas_error"
-                        with (dirname / "cmd_invalid.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"
-                        doc += conv_data
-                        with open(dirname / 'output_invalid.html', 'w') as fh_output:
-                            fh_output.write(conv_data)
-                    if (dirname / 'read_write').is_file():
-                        trougailconfig = rougailconfig.copy()
-                        trougailconfig["console.mandatory"] = False
-                        tiramisu_config.property.read_write()
-                        errors2 = rougail.user_datas(ret, invalid_user_datas_error=True)
-                        export = RougailOutputConsole(tiramisu_config,
-                                                      rougailconfig=trougailconfig,
-                                                      user_data_errors=errors2['errors'],
-                                                      user_data_warnings=errors2['warnings'],
+                                                      user_data_errors=data.errors,
+                                                      user_data_warnings=data.warnings,
                                                       )
                         console = export.run()[1]
                         conv = Ansi2HTMLConverter(inline=True)
                         doc += inv_formatter.title('Output in read write mode', 4)
-                        cmd2 = cmd + " --cli.read_write"
-                        with (dirname / "cmd_rw.txt").open("w") as fh:
-                            fh.write(cmd2)
-                        doc += f"```shell\n{cmd2}\n```\n"
+                        cmd = cmd + " --cli.read_write"
+                        doc += f"```console\n{cmd}\n```\n"
                         conv_data = '<pre>' + conv.convert(console, full=False) + "</pre>\n"
-                        doc += conv_data
+                        doc += '<pre>' + conv_data + "</pre>\n"
                         with open(dirname / 'output_rw.html', 'w') as fh_output:
                             fh_output.write(conv_data)
     #

build.sh

@@ -11,7 +11,7 @@ if [ -d $DEST ]; then
     exit 1
 fi
 
-export LC_ALL=C.UTF-8
+export LC_ALL=C
 
 BUILDER="$(pwd)"
 mkdir -p $DEST/firefox
@@ -22,15 +22,12 @@ touch summary_total.md
 cd "$DEST"
 DEST="$(pwd)"
 
-TUTO_ROOT=https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit
-
 
 cp "$BUILDER"/firefox.png .
 cp "$BUILDER"/foxyproxy.png .
 cp "$BUILDER"/summary.md .
-cp "$BUILDER"/install.txt .
 touch README.md
-"$BUILDER"/build.py "$BUILDER" "$VERSION"
+"$BUILDER"/build.py "$VERSION"
 rm -rf summary.md
 rm -rf summary_total.md
 rm -rf jinja_caches
@@ -41,11 +38,11 @@ git commit -am"$(cat $BUILDER/TITLE)"
 cd - > /dev/null
 
 for i in $(ls -d "examples"/* | sort); do
-    num=$(echo $(basename "$i"))
-    echo "$num"
-    commit_id="v${VERSION}_$num"
-    summary="[tutorial $commit_id] $(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
+        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
@@ -56,20 +53,17 @@ for i in $(ls -d "examples"/* | sort); do
         echo "  - $(head -n 1 $i/SUBTITLE.md)" >> summary.md
     fi
     if [ -f "$i/README.md" ]; then
-        rm -rf "$DEST/config" "$DEST/tree.html"
+        rm -rf "$DEST/config"
         num=$(echo $(basename "$i"))
         echo "$num"
         commit_id="v${VERSION}_$num"
-        summary="[tutorial $commit_id)] $(head -n 1 $i/README.md)"
+        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"
-        BEFORE=$PWD
         cd "$i/structural_files"
-		echo "====================="
         if [ -d firefox ]; then
             for j in $(ls firefox/*.yml 2>/dev/null); do
-				echo "++++ $j"
                 cp "$j" "$DEST/$j"
             done
         fi
@@ -79,18 +73,14 @@ for i in $(ls -d "examples"/* | sort); do
                 cp "$j" "$DEST/$j"
             done
         fi
-		cp "DISPLAY_*" "$DEST/" 2> /dev/null || true
-        cd $DEST
-        tree -H $TUTO_ROOT/$commit_id/ -P "*.yml" > tree.html
-        cd - > /dev/null
         cp -f ../README.md "$DEST"
         if [ -d ../config ]; then
             cp -aL ../config "$DEST"
         fi
-        msg="[tutorial $commit_id] $(cat ../README.md)"
+        msg="[tutorial $(basename $i)] $(cat ../README.md)"
         [ -e ../firefox.png ] && cp ../firefox.png "$DEST"
         [ -e ../foxyproxy.png ] && cp ../foxyproxy.png "$DEST"
-        cd $BEFORE
+        cd - > /dev/null
         cd "$DEST"
         #
         before=$(grep "commit/$commit_id/README.md" summary_total.md -B1 | wc -l)
@@ -110,8 +100,8 @@ for i in $(ls -d "examples"/* | sort); do
         if [ -f config/mode ]; then
             mv config/mode mode
         fi
-        "$BUILDER"/build.py "$BUILDER" "$commit_id"
-        rm -rf config/*/README.md config/*/read_write config/namespace config/*/invalid DISPLAY_*
+        "$BUILDER"/build.py "$commit_id"
+        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
@@ -119,7 +109,7 @@ for i in $(ls -d "examples"/* | sort); do
         else
             MODE=0
         fi
-        git add *.png README.md install.txt tree.html
+        git add *.png README.md
         if [ -d config ]; then
             git add config
         else
@@ -155,11 +145,11 @@ This is what the page looks like:
 " > README.md
 echo '# Installation
 
-To test this tutorial, you need to download this repository and install Rougail:
-
-```bash' >> README.md
-cat install.txt >> README.md
-echo '```
+```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
 
@@ -169,7 +159,7 @@ cp "$BUILDER"/firefox.png .
 cp "$BUILDER"/foxyproxy.png .
 cat "$BUILDER"/summary.md >> README.md
 echo >> README.md
-rm -rf firefox foxyproxy mode install.txt tree.html
+rm -rf firefox foxyproxy mode
 git add .
 git commit -am"Summary"
 #

examples/000/README.md

@@ -1 +1 @@
-An empty structured file with format version
+A structured file with format version

examples/000/SUBTITLE.md

@@ -1 +1 @@
-Making a structure file
+Structural file

examples/001/README.md

@@ -1 +0,0 @@
-A first variable with only a name

examples/001/SUBTITLE.md

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

examples/001/config/01/README.md

@@ -1 +0,0 @@
-The user data file is empty. So it's only default value that will be used.

examples/002/README.md

@@ -1,9 +0,0 @@
-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)).

examples/002/config/01/README.md

@@ -1 +0,0 @@
-The user data file is empty. So it's only default value that will be used.

examples/002/config/02/config.yml

@@ -1,2 +0,0 @@
----
-proxy_mode: No proxy

examples/003/README.md

@@ -1,7 +0,0 @@
-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").

examples/003/config/01/README.md

@@ -1 +0,0 @@
-The user data file is empty. So it's only default value that will be used.

examples/003/config/02/config.yml

@@ -1,2 +0,0 @@
----
-proxy_mode: No proxy

examples/003/config/03/README.md

@@ -1 +0,0 @@
-"foo" should be an invalid value for this variable.

examples/003/config/03/config.yml

@@ -1,2 +0,0 @@
----
-proxy_mode: foo

examples/004/config/01/README.md

@@ -1 +0,0 @@
-The user data file is empty. So it's only default value that will be used.

examples/004/config/02/config.yml

@@ -1,2 +0,0 @@
----
-proxy_mode: No proxy

examples/004/config/04/README.md

@@ -1 +0,0 @@
-"foo" should be an invalid value for this variable.

examples/004/config/04/config.yml

@@ -1,2 +0,0 @@
----
-proxy_mode: foo

examples/010/README.md

@@ -1 +1 @@
-Creating a new family
+A first variable with only a name

examples/010/SUBTITLE.md

@@ -1 +1 @@
-Group variables inside "families"
+Variable: choice the proxy mode

examples/010/structural_files/firefox/10-manual.yml

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

examples/011/README.md

@@ -1,8 +1,9 @@
-Or a sub family
+The variable description
 
-Inside a family, we can have variables or families.
+We can add a description to this first variable.
 
-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.
+This information is useful for:
 
-In disabled attribute, it's better tu use relative path (we will see the reason in an other slide).
+- 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)).

examples/011/config

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

examples/011/structural_files/firefox/10-manual.yml

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

examples/012/README.md

@@ -1 +1,7 @@
-Putting a variable inside of a family or a sub family
+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").

examples/012/config

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

examples/012/config/02/config.yml

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

examples/012/config/03/config.yml

@@ -1,5 +0,0 @@
----
-manual:
-  http_proxy:
-    address: example.net
-    port: 3128

examples/013/README.md

@@ -1,4 +1,4 @@
-Limits the possible values for the variable
+A variable with type "choice"
 
 "Foo" should not be an option to the "proxy_mode" variable.
 

examples/013/config

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

examples/013/structural_files/firefox/00-proxy.yml

@@ -0,0 +1,15 @@
+%YAML 1.2
+---
+version: 1.1
+
+proxy_mode:
+  description: Configure Proxy Access to the Internet
+  type: choice
+  choices:
+    - No proxy
+    - Auto-detect proxy settings for this network
+    - Use system proxy settings
+    - Manual proxy configuration
+    - Automatic proxy configuration URL
+  default: No proxy
+...

examples/014/README.md

@@ -0,0 +1,3 @@
+Choice type is optional
+
+The type is optional in choice type (if we have choices attributes, it's a choice option).

examples/014/config

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

examples/020/README.md

@@ -1 +1,14 @@
-A variable with type "domainname"
+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.

examples/020/SUBTITLE.md

@@ -0,0 +1 @@
+Family: proxy manual

examples/020/TITLE.md

@@ -1 +0,0 @@
-Constrainte the value of a variable with it's type

examples/020/config/01/config.yml

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

examples/020/config/02/config.yml

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

examples/020/config/03/config.yml

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

examples/020/structural_files/firefox/10-manual.yml

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

examples/021/README.md

@@ -1 +1,8 @@
-A variable with type's parameters
+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).

examples/021/config

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

examples/021/structural_files/firefox/10-manual.yml

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

examples/022/README.md

@@ -1 +1 @@
-A variable with type "port"
+A variable inside sub family

examples/022/config/03/config.yml

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

examples/022/structural_files/firefox/10-manual.yml

@@ -6,14 +6,5 @@ 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
+    address:  # HTTP address
 ...

examples/023/README.md

@@ -1 +1 @@
-A variable with type "boolean"
+A variable with type "domainname"

examples/023/SUBTITLE.md

@@ -0,0 +1 @@
+Variable: type and type parameters

examples/023/TITLE.md

@@ -0,0 +1 @@
+HTTP Manual mode

examples/023/config/01/config.yml

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

examples/023/config/02/config.yaml

@@ -0,0 +1,2 @@
+---
+proxy_mode: Manual proxy configuration

examples/023/config/02/config.yml

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

examples/023/config/04/config.yaml

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

examples/023/config/05/README.md

@@ -0,0 +1,2 @@
+If "use_for_https" is false, HTTPS variables are visible in read only mode and in read write mode.
+

examples/023/config/05/config.yaml

@@ -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

examples/023/structural_files/firefox/10-manual.yml

@@ -6,5 +6,7 @@ manual:  # Manual proxy configuration
 
   http_proxy:  # HTTP Proxy
 
-    address:  # HTTP address
+    address:
+      description: HTTP address
+      type: domainname
 ...

examples/024/README.md

@@ -1 +1 @@
-Copy HTTP manual proxy to HTTPS manual proxy
+A variable with type's parameters

examples/024/config

@@ -1 +1 @@
-../020/config
+../022/config

examples/024/structural_files/firefox/10-manual.yml

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

examples/025/README.md

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

examples/025/config

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

examples/025/structural_files/firefox/10-manual.yml

@@ -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
+...

examples/026/README.md

@@ -0,0 +1 @@
+A disabled family

examples/026/SUBTITLE.md

@@ -0,0 +1 @@
+Property: disabled

examples/026/config

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