fix: update

build.py

@@ -47,7 +47,7 @@ if __name__ == "__main__":
 #    print(config.value.get())
     rougailconfig['doc.output_format'] = 'github'
     rougailconfig['doc.title_level'] = 3
-    inventory = RougailOutputDoc(config, rougailconfig=rougailconfig.copy())
+    inventory = RougailOutputDoc(config, rougailconfig=rougailconfig)
     inventory.load_formatter()
     inv_formatter = inventory.formatter
     rougailconfig['step.output'] = 'console'
@@ -79,9 +79,9 @@ if __name__ == "__main__":
         with tree.open() as fh:
             soup = BeautifulSoup(fh.read(), features="lxml")
             doc += str(soup.find('p')) + "\n\n"
-    for f in Path('.').iterdir():
+    for f in Path(".").iterdir():
         if f.name.startswith('DISPLAY_'):
-            filename = f.name[9:]
+            filename = f.name[8:]
             display_yml = Path(dirname) / filename
             break
     else:
@@ -116,12 +116,12 @@ if __name__ == "__main__":
     if previous.is_file():
         rougailconfig["doc.contents"] = ["changelog"]
         rougailconfig["doc.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 += f'```shell\n{cmd}\n```\n'
+            doc += f'```shell\n{cmd}\n```\n'
-        doc += inv_doc + "\n"
+            doc += inv_doc + "\n"
     # save PREVIOUS
     rougailconfig["doc.contents"] = ["variables"]
     rougailconfig['doc.output_format'] = 'json'
@@ -209,6 +209,7 @@ if __name__ == "__main__":
                         doc += conv_data
                         with open(dirname / 'output_rw.html', 'w') as fh_output:
                             fh_output.write(conv_data)
+                        tiramisu_config.property.read_only()
     #
     summary = Path('summary_after.md')
     if summary.is_file():

build.sh

@@ -15,7 +15,7 @@ export LC_ALL=C.UTF-8
 
 BUILDER="$(pwd)"
 mkdir -p $DEST/firefox
-rm -f summary.md
+rm -f summary.md previous.yml
 touch summary.md
 rm -f summary_total.md
 touch summary_total.md
@@ -44,7 +44,8 @@ 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)"
+    title="$(head -n 1 $i/README.md)"
+    summary="[tutorial $commit_id] $title"
     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
 
@@ -60,29 +61,32 @@ 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)"
+        title=$(head -n 1 $i/README.md)
+        summary="[tutorial $commit_id)] $title"
+        if [ -f $i/URL ]; then
+            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"
-        echo "    - [$summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/$commit_id/README.md) ([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"
         BEFORE=$PWD
         cd "$i/structural_files"
-		echo "====================="
         if [ -d firefox ]; then
             for j in $(ls firefox/*.yml 2>/dev/null); do
-				echo "++++ $j"
+                cp -v "$j" "$DEST/$j"
-                cp "$j" "$DEST/$j"
             done
         fi
         if [ -d foxyproxy ]; then
             mkdir -p $DEST/foxyproxy
             for j in $(ls foxyproxy/*.yml 2>/dev/null); do
-                cp "$j" "$DEST/$j"
+                cp -v "$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 -v DISPLAY_* "$DEST/" 2> /dev/null || true
         cp -f ../README.md "$DEST"
         if [ -d ../config ]; then
             cp -aL ../config "$DEST"
@@ -102,6 +106,8 @@ for i in $(ls -d "examples"/* | sort); do
         echo "# $summary" >> summary_before.md
         echo "" >> summary_before.md
         echo "[View the diff]($diff_url)" >> summary_before.md
+        echo "" >> summary_before.md
+        echo "[Read the documentation]($url_doc)" >> 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

examples/000/README.md

@@ -1 +1 @@
-An empty structured file with format version
+Creating a structure file

examples/000/URL

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

examples/001/README.md

@@ -1 +1 @@
-A first variable with only a name
+Let’s add our first variable

examples/010/URL

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

examples/020/URL

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

examples/024/README.md

@@ -1 +0,0 @@
-Copy HTTP manual proxy to HTTPS manual proxy

examples/024/config

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

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

@@ -1,21 +0,0 @@
-%YAML 1.2
----
-version: 1.1
-
-manual:
-
-  use_for_https: true  # Also use this proxy for HTTPS
-
-  https_proxy:  # HTTPS Proxy
-
-    address:
-      description: HTTPS address
-      type: domainname
-      params:
-        allow_ip: true
-
-    port:
-      description: HTTPS Port
-      type: port
-      default: 8080
-...

examples/030/SUBTITLE.md

@@ -1 +1 @@
-Disable a family
+Property disabled

examples/030/config/02/config.yml

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

examples/030/config/04/config.yml

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

examples/031/README.md

@@ -1 +1 @@
-A conditional disabled family with a variable
+A conditional disabled family

examples/031/config

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

examples/031/config/02/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/031/config/02/config.yml

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

examples/032/README.md

@@ -1 +1 @@
-An hidden family
+Copy HTTP manual proxy to HTTPS manual proxy

examples/032/SUBTITLE.md

@@ -1 +1 @@
-Property: hidden
+Property hidden

examples/032/config

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

examples/032/structural_files/firefox/20-manual.yml

@@ -6,9 +6,7 @@ manual:
 
   use_for_https: true  # Also use this proxy for HTTPS
 
-  https_proxy:
+  https_proxy:  # HTTPS Proxy
-    description: HTTPS Proxy
-    hidden: true
 
     address:
       description: HTTPS address

examples/033/README.md

@@ -1 +1 @@
-A conditional hidden family with a variable
+A conditional hidden family

examples/033/config

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

examples/033/config/01/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/033/config/01/config.yml

@@ -3,7 +3,7 @@ proxy_mode: Manual proxy configuration
 manual:
   http_proxy:
     address: http.proxy.net
-    port: '3128'
+    port: 3128
   use_for_https: false
   https_proxy:
     address: https.proxy.net

examples/033/config/02/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/033/config/02/config.yml

@@ -2,4 +2,6 @@
 proxy_mode: Manual proxy configuration
 manual:
   http_proxy:
-    address: example.net
+    address: http.proxy.net
+    port: 3128
+  use_for_https: true

examples/040/TITLE.md

@@ -1 +1 @@
-Variable: calculated default value
+Calculated default value for a variable

examples/040/config

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

examples/040/config/01/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/040/config/01/config.yml

@@ -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/040/structural_files/firefox/20-manual.yml

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

examples/041/README.md

@@ -1 +0,0 @@
-Variable type and parameters type are copied with default value

examples/041/config

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

examples/041/structural_files/firefox/20-manual.yml

@@ -1,23 +0,0 @@
-%YAML 1.2
----
-version: 1.1
-
-manual:
-
-  use_for_https: true  # Also use this proxy for HTTPS
-
-  https_proxy:
-    description: HTTPS Proxy
-    hidden:
-      variable: _.use_for_https
-
-    address:
-      description: HTTPS address
-      default:
-        variable: __.http_proxy.address
-
-    port:
-      description: HTTPS Port
-      default:
-        variable: __.http_proxy.port
-...

examples/050/SUBTITLE.md

@@ -1 +0,0 @@
-Family: dynamic

examples/050/TITLE.md

@@ -1 +1 @@
-SOCKS Manual mode
+Dynamic family

examples/050/URL

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

examples/051/README.md

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

examples/051/SUBTITLE.md

@@ -1 +0,0 @@
-Property: Jinja and identifier condition

examples/051/structural_files/firefox/20-manual.yml

@@ -9,10 +9,7 @@ manual:
   '{{ identifier }}_proxy':
     description: '{{ identifier }} Proxy'
     hidden:
-      jinja: |-
+      variable: _.use_for_https
-        {% if _.use_for_https %}
-          HTTPS is same has HTTP
-        {% endif %}
     dynamic:
       - HTTPS
       - SOCKS
@@ -26,4 +23,14 @@ manual:
       description: '{{ identifier }} port'
       default:
         variable: __.http_proxy.port
+
+    version:
+      description: SOCKS host version used by proxy
+      choices:
+        - v4
+        - v5
+      default: v5
+      disabled:
+        type: identifier
+        when: HTTPS
 ...

examples/053/README.md

@@ -1 +0,0 @@
-Jinja with a description

examples/054/README.md

@@ -1 +0,0 @@
-A conditional disabled variable with identifier

examples/060/README.md

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

examples/060/TITLE.md

@@ -1 +1 @@
-Automatic proxy
+Playing with Jinja

examples/060/URL

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

examples/060/config/01/config.yml

@@ -1,2 +0,0 @@
----
-auto: https://auto.proxy.net/wpad.dat

examples/060/config/02/config.yml

@@ -1,2 +0,0 @@
----
-proxy_mode: Automatic proxy configuration URL

examples/060/structural_files/firefox/20-manual.yml

@@ -10,12 +10,9 @@ manual:
     description: '{{ identifier }} Proxy'
     hidden:
       jinja: |-
-        {% if my_identifier == 'HTTPS' and _.use_for_https %}
+        {% if _.use_for_https %}
           HTTPS is same has HTTP
         {% endif %}
-      params:
-        my_identifier:
-          type: identifier
     dynamic:
       - HTTPS
       - SOCKS
@@ -29,4 +26,14 @@ manual:
       description: '{{ identifier }} port'
       default:
         variable: __.http_proxy.port
+
+    version:
+      description: SOCKS host version used by proxy
+      choices:
+        - v4
+        - v5
+      default: v5
+      disabled:
+        type: identifier
+        when: HTTPS
 ...

examples/060/structural_files/firefox/30-auto.yml

@@ -1,8 +0,0 @@
-%YAML 1.2
----
-version: 1.1
-
-auto:
-  description: Automatic proxy configuration URL
-  type: web_address
-...

examples/061/README.md

@@ -1 +1 @@
-A conditional disabled variable
+Jinja with a description

examples/061/config/01/README.md

@@ -1 +0,0 @@
-We cannot configure "auto" if "proxy_mode" is not "Automatic proxy configuration URL".

examples/061/config/01/config.yml

@@ -1,2 +0,0 @@
----
-auto: https://auto.proxy.net/wpad.dat

examples/061/config/02/config.yml

@@ -1,2 +0,0 @@
----
-proxy_mode: Automatic proxy configuration URL

examples/061/structural_files/firefox/20-manual.yml

@@ -10,13 +10,10 @@ manual:
     description: '{{ identifier }} Proxy'
     hidden:
       jinja: |-
-        {% if my_identifier == 'HTTPS' and _.use_for_https %}
+        {% if _.use_for_https %}
           HTTPS is same has HTTP
         {% endif %}
-      description: in HTTPS case if "_.use_for_https" is set to True
+      description: in HTTPS case if "_.use_for_https" is set to "true"
-      params:
-        my_identifier:
-          type: identifier
     dynamic:
       - HTTPS
       - SOCKS
@@ -30,4 +27,14 @@ manual:
       description: '{{ identifier }} port'
       default:
         variable: __.http_proxy.port
+
+    version:
+      description: SOCKS host version used by proxy
+      choices:
+        - v4
+        - v5
+      default: v5
+      disabled:
+        type: identifier
+        when: HTTPS
 ...

examples/062/structural_files/firefox/20-manual.yml

@@ -13,7 +13,7 @@ manual:
         {% if my_identifier == 'HTTPS' and _.use_for_https %}
           HTTPS is same has HTTP
         {% endif %}
-      description: in HTTPS case if "_.use_for_https" is set to True
+      description: in HTTPS case if "_.use_for_https" is set to "true"
       params:
         my_identifier:
           type: identifier

examples/070/README.md

@@ -1 +1 @@
-A variable with type "domainname", parameters type and disabled
+A conditional disabled variable with type web_address

examples/070/SUBTITLE.md

@@ -1 +0,0 @@
-Variable: multi and non mandatory

examples/070/TITLE.md

@@ -1 +1 @@
-Address for which proxy will be desactivated
+Various variables

examples/070/config/01/config.yml

@@ -1 +1,2 @@
 ---
+auto: https://auto.proxy.net/wpad.dat

examples/070/config/02/config.yml

@@ -1,4 +1,2 @@
 ---
 proxy_mode: Automatic proxy configuration URL
-auto: https://auto.proxy.net/wpad.dat
-no_proxy: 192.168.1.0/24

examples/071/README.md

@@ -1 +0,0 @@
-A variable with multiple value

examples/071/config/02/config.yml

@@ -1,6 +0,0 @@
----
-proxy_mode: Automatic proxy configuration URL
-auto: https://auto.proxy.net/wpad.dat
-no_proxy:
-  - example.net
-  - 192.168.1.0/24

examples/072/README.md

@@ -1 +0,0 @@
-A non mandatory variable

examples/073/README.md

@@ -1 +0,0 @@
-Examples

examples/073/SUBTITLE.md

@@ -1 +0,0 @@
-Variable: extra description

examples/075/README.md

@@ -1 +0,0 @@
-A variable

examples/075/TITLE.md

@@ -1 +0,0 @@
-Prompt for authentication if password is saved

examples/076/README.md

@@ -1 +0,0 @@
-A variable

examples/076/TITLE.md

@@ -1 +0,0 @@
-Use proxy DNS when using SOCKS v5

examples/077/README.md

@@ -1 +0,0 @@
-Jinja calculation for an hidden variable with a potential inaccessible varible

examples/080/README.md

@@ -1 +1 @@
-A boolean variable
+A conditional disabled variable with type domainname and parameters

examples/080/TITLE.md

@@ -1 +0,0 @@
-DNS over HTTPS

examples/080/config/02/config.yml

@@ -1,3 +1,4 @@
 ---
 proxy_mode: Automatic proxy configuration URL
 auto: https://auto.proxy.net/wpad.dat
+no_proxy: 192.168.1.0/24

examples/081/README.md

@@ -1 +1 @@
-A choice variable
+A variable with multiple value

examples/081/TITLE.md

@@ -0,0 +1 @@
+Multiple variable

examples/081/config/02/config.yml

@@ -1,3 +1,6 @@
 ---
-dns_over_https:
+proxy_mode: Automatic proxy configuration URL
-  enable_dns_over_https: true
+auto: https://auto.proxy.net/wpad.dat
+no_proxy:
+  - example.net
+  - 192.168.1.0/24