update

build.py

@@ -9,7 +9,7 @@ from bs4 import BeautifulSoup
 
 from rougail import Rougail
 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.output_doc import RougailOutputDoc
 
@@ -50,7 +50,8 @@ if __name__ == "__main__":
     inventory = RougailOutputDoc(config, rougailconfig=rougailconfig)
     inventory.load_formatter()
     inv_formatter = inventory.formatter
-    rougailconfig['step.output'] = 'console'
+    rougailconfig['step.output'] = 'display'
+    rougailconfig['display.console.max_width'] = 80
     summary = Path('summary_before.md')
     if summary.is_file():
         with summary.open('r') as sfh:
@@ -78,7 +79,10 @@ if __name__ == "__main__":
         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"
+            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():
         if f.name.startswith('DISPLAY_'):
             filename = f.name[8:]
@@ -115,7 +119,7 @@ if __name__ == "__main__":
         doc += inv_doc
     if previous.is_file():
         rougailconfig["doc.contents"] = ["changelog"]
-        rougailconfig["doc.previous_json_file"] = str(previous)
+        rougailconfig["doc.changelog.previous_json_file"] = str(previous)
         inv_doc = inventory.run()[1]
         if inv_doc:
             doc += inv_formatter.title("Let's generate the changelog", 3)
@@ -130,7 +134,7 @@ if __name__ == "__main__":
         with previous.open('w') as fh:
             dump(loads(data), fh)
     #
-    rougailconfig['step.output'] = 'console'
+    rougailconfig['step.output'] = 'display'
     config = Path('config')
     if config.is_dir():
         doc += inv_formatter.title('User datas', 2)
@@ -153,8 +157,9 @@ if __name__ == "__main__":
                     rougailconfig['yaml.filename'] = [str(filename)]
                     data = RougailUserDataYaml(tiramisu_config, rougailconfig=rougailconfig)
                     ret = data.run()
-                    errors = rougail.user_datas(ret)
+                    errors = rougail.user_data(ret)
-                    export = RougailOutputConsole(tiramisu_config,
+                    rougailconfig['display.output_format'] = "console"
+                    export = RougailOutputDisplay(tiramisu_config,
                                                   rougailconfig=rougailconfig,
                                                   user_data_errors=errors['errors'],
                                                   user_data_warnings=errors['warnings'],
@@ -167,12 +172,19 @@ if __name__ == "__main__":
                         fh.write(cmd)
                     doc += f"```shell\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)
+                    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]
                     if (dirname / 'invalid').is_file():
-                        errors2 = rougail.user_datas(ret, invalid_user_datas_error=True)
+                        errors2 = rougail.user_data(ret, invalid_user_data_error=True)
-                        export = RougailOutputConsole(tiramisu_config,
+                        rougailconfig['display.output_format'] = "console"
+                        export = RougailOutputDisplay(tiramisu_config,
                                                       rougailconfig=rougailconfig,
                                                       user_data_errors=errors2['errors'],
                                                       user_data_warnings=errors2['warnings'],
@@ -180,20 +192,27 @@ if __name__ == "__main__":
                         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"
+                        cmd2 = cmd + " --cli.invalid_user_data_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)
+                        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]
                     if (dirname / 'read_write').is_file():
                         trougailconfig = rougailconfig.copy()
-                        trougailconfig["console.mandatory"] = False
+                        trougailconfig["display.mandatory"] = False
                         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,
+                        rougailconfig['display.output_format'] = "console"
+                        export = RougailOutputDisplay(tiramisu_config,
                                                       rougailconfig=trougailconfig,
                                                       user_data_errors=errors2['errors'],
                                                       user_data_warnings=errors2['warnings'],
@@ -206,9 +225,15 @@ if __name__ == "__main__":
                             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_rw.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]
                         tiramisu_config.property.read_only()
     #
     summary = Path('summary_after.md')

build.sh

@@ -62,7 +62,7 @@ for i in $(ls -d "examples"/* | sort); do
         echo "$num"
         commit_id="v${VERSION}_$num"
         title=$(head -n 1 $i/README.md)
-        summary="[tutorial $commit_id)] $title"
+        summary="[tutorial $commit_id] $title"
         if [ -f $i/URL ]; then
             base_url_doc=$(cat $i/URL)
         fi

examples/000/SUBTITLE.md

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

examples/001/SUBTITLE.md

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

examples/002/README.md

@@ -1,9 +1 @@
 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/003/README.md

@@ -1,7 +1 @@
 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/004/README.md

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

examples/010/README.md

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

examples/010/SUBTITLE.md

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

examples/010/TITLE.md

@@ -0,0 +1 @@
+A variable with a list of possible values

examples/010/URL

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

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

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 +0,0 @@
-Putting a variable inside of a family or a sub family

examples/012/config/02/config.yml

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

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

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

examples/020/README.md

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

examples/020/TITLE.md

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

examples/020/URL

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

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
+manual:
-
+  description: Manual proxy configuration
-  http_proxy:  # HTTP Proxy
+  type: family
-
-    address:
-      description: HTTP address
-      type: domainname
 ...

examples/021/README.md

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

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
+  http_proxy:
-
+    description: HTTP Proxy
-    address:
+    type: family
-      description: HTTP address
-      type: domainname
-      params:
-        allow_ip: true
 ...

examples/022/README.md

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

examples/022/config/01/config.yml

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

examples/022/config/02/config.yml

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

examples/022/config/03/config.yml

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

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

@@ -6,14 +6,5 @@ manual:  # Manual proxy configuration
 
   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
 ...

examples/023/README.md

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

examples/023/config/01/config.yml

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

examples/023/config/02/config.yml

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

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

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

examples/030/README.md

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

examples/030/TITLE.md

@@ -1 +1 @@
-Define access to variable or family
+Constrainte the value of a variable with it's type

examples/030/URL

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

examples/030/config/01/config.yml

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

examples/030/config/02/config.yml

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

examples/030/config/03/config.yml

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

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

@@ -2,20 +2,11 @@
 ---
 version: 1.1
 
-manual:
+manual:  # Manual proxy configuration
-  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
 ...

examples/031/README.md

@@ -1 +1 @@
-A conditional disabled family
+A variable with type's parameters

examples/031/config/01/config.yml

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

examples/031/config/02/config.yml

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

examples/031/config/03/config.yml

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

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

@@ -2,11 +2,7 @@
 ---
 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
 
@@ -15,9 +11,4 @@ manual:
       type: domainname
       params:
         allow_ip: true
-
-    port:
-      description: HTTP Port
-      type: port
-      default: 8080
 ...

examples/032/README.md

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

examples/032/config/01/config.yml

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

examples/032/config/02/config.yml

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

examples/032/config/03/config.yml

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

examples/032/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/033/README.md

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

examples/033/config/01/config.yml

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

examples/033/config/02/config.yml

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

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

@@ -5,20 +5,4 @@ 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
-      type: domainname
-      params:
-        allow_ip: true
-
-    port:
-      description: HTTPS Port
-      type: port
-      default: 8080
 ...

examples/040/README.md

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

examples/040/TITLE.md

@@ -1 +1 @@
-Calculated default value for a variable
+Define access to variable or family

examples/040/config/01/config.yml

@@ -1,9 +1 @@
 ---
-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/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/040/structural_files/firefox/10-manual.yml

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

examples/041/README.md

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

examples/041/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/041/structural_files/firefox/10-manual.yml

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

examples/042/README.md

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

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

@@ -6,7 +6,9 @@ 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/043/README.md

@@ -0,0 +1 @@
+A conditional hidden family

examples/043/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/043/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: true

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

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

examples/050/README.md

@@ -1 +1 @@
-Family: a dynamic family
+A calculated default value

examples/050/TITLE.md

@@ -1 +1 @@
-Dynamic family
+Calculated default value for a variable

examples/050/URL

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

examples/050/config

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