toolchain description update

toolchain/README.md

@@ -4,9 +4,15 @@
 The W3C WoT specification generation process toolchain is depicted as a Business Process Modeling Notation diagram. There are 4 actors involved:
 1. ***Semantic Web Expert***
 2. ***WoT Toolchain***
-3. ***SPARQL Template Transformation Language***
+3. ***SPARQL Template Transformation Language Engine***
 4. ***Parser Creation***
 
-The Semantic Web Expert has the main responsibility to iteratively define the schema of different vocabularies such as TD, TM, WoTsec, HCTL and any extensions required, as well as the JSON Schema definition and SHACL shapes for validation. These different tasks are performed in an adhoc manner until agreement is achieved among the experts. In addition, they define a set of templates for the specification according to the SPARQL Template Transformation Language (STTL).
+The Semantic Web Expert has the main responsibility to iteratively define the schema of different TD model specifications such as TD core, TM, WoTsec, HCTL or any extensions required. Also, the JSON Schema definition is defined for syntacticAL validation of JSON-LD data and Shapes Constraint Language (SHACL) shapes for Validating RDF graphs. These different tasks are performed in an adhoc manner until agreement is achieved among the experts. In addition, the experts define a set of transformations for the specification generation according to the SPARQL Template Transformation Language (STTL). The templates expressed in STTL describe different rules for transforming a source RDF graph into a result text.
 
-The WoT Toolchain is a shell script (render.sh), which manages the interaction between different Node.js scripts. It receives the different JSON-LD context files for each schema, aggregates them into one and converts them into Turtle representation format. 
+The WoT Toolchain is a shell script (render.sh), which manages the interaction between different Node.js scripts developed to achieve different objectives. It receives the different JSON-LD context files for each vocabulary in the TD model and aggregates them into one. The resulting JSON-LD context is then converted into RDF Turtle representation format. The artifacts provided by the Semantic Web Experts and the RDF graphs are provided as input to the STTL Engine.
+
+The STTL engine takes different RDF graphs: TD model ontologies, SHACL shapes (validation/td-validation.ttl), merged context (context/td-context.ttl), a transformation (a set of templates), and a specific starting node that determines the starting HTML node pointing to the WoT Things Descriptions as a set of command-line arguments. The TD model ontologies and SHACL shapes are loaded and stored in an RDF store for semantic processing and querying. Then, the STTL templates are parsed according to the parser developed by the Parser Creation actor. This is followed by matching the input HTML node with one of the transformation names specified in the template. A template in a transformation may apply other templates or include different utility functions or SPARQL functions. Therefore, the Apply Template sub-process identifies these different cases and applies the rules which includes the following activities: evaluate patterns, variables and expressions in a template, construct the query to execute using a JSON format, and executing the query on the RDF graph. The output is generated HTML textual output format corresponding to the index.html file of the TD specification and the different ontology specifications.
+
+The TD specification include diagrams that are also generated from the same SHACL and merged context sources. The STTL Engine is run once more to generated diagrams in textual form (DOT text files) and then turned into graphics using Graphviz tool. The output is the SVG figures of the TD specification, which is then manually converted into PNG using a desired tool of choice. These PNG files are used to feed the HTML specification. 
+
+The Parser Creation process is mainly performed by a developer using a 2-step process. The grammar is developed manually using to context-free grammar according to the semantics of STTL language. Then, Jison tool takes the grammar as input and outputs a JavaScript file capable of parsing the language described by that grammar. The generated script is then used to parse visualization template inputs in the STTL Engine.

toolchain/wot-toolchain-bpmn.drawio

@@ -1,13 +1,13 @@
-<mxfile host="Electron" modified="2023-11-16T09:52:31.173Z" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/21.6.1 Chrome/112.0.5615.204 Electron/24.6.1 Safari/537.36" etag="ZNK8b1LCzX6-PIAcGtKb" version="21.6.1" type="device">
+<mxfile host="Electron" modified="2024-01-17T10:11:30.820Z" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/21.6.1 Chrome/112.0.5615.204 Electron/24.6.1 Safari/537.36" etag="WIhbVi0L6RYXgLBzNHQU" version="21.6.1" type="device">
   <diagram id="60j3HPYKAk5_ia8UwMvO" name="wot-bpmn">
-    <mxGraphModel dx="1553" dy="2179" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
+    <mxGraphModel dx="1242" dy="1962" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
       <root>
         <mxCell id="0" />
         <mxCell id="1" parent="0" />
         <mxCell id="VGzt8ICLMrnI1Oa5_CKK-1" value="&lt;font style=&quot;font-size: 18px;&quot; face=&quot;Open Sans&quot;&gt;W3C Web of Things Specification Generation Process&lt;/font&gt;" style="swimlane;html=1;childLayout=stackLayout;resizeParent=1;resizeParentMax=0;horizontal=0;startSize=20;horizontalStack=0;whiteSpace=wrap;fillColor=#eeeeee;strokeColor=#36393d;rounded=1;" parent="1" vertex="1">
           <mxGeometry x="4" y="4" width="1670" height="1000" as="geometry" />
         </mxCell>
-        <mxCell id="VGzt8ICLMrnI1Oa5_CKK-2" value="&lt;font face=&quot;Open Sans&quot; style=&quot;font-size: 16px; font-weight: normal;&quot;&gt;Semantic Web Expert&lt;/font&gt;" style="swimlane;html=1;startSize=20;horizontal=0;rotation=0;fillColor=#eeeeee;strokeColor=#36393d;rounded=1;" parent="VGzt8ICLMrnI1Oa5_CKK-1" vertex="1">
+        <mxCell id="VGzt8ICLMrnI1Oa5_CKK-2" value="&lt;font face=&quot;Open Sans&quot; style=&quot;font-size: 16px; font-weight: normal;&quot;&gt;TD Task Force Participants&lt;/font&gt;" style="swimlane;html=1;startSize=20;horizontal=0;rotation=0;fillColor=#eeeeee;strokeColor=#36393d;rounded=1;" parent="VGzt8ICLMrnI1Oa5_CKK-1" vertex="1">
           <mxGeometry x="20" width="1650" height="370" as="geometry" />
         </mxCell>
         <mxCell id="dqQZkA_G8O030KViG1e_-3" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.999;exitY=0.446;exitDx=0;exitDy=0;exitPerimeter=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;entryPerimeter=0;fontFamily=Helvetica;fontSize=12;fontColor=default;strokeWidth=2;" parent="VGzt8ICLMrnI1Oa5_CKK-2" source="pAAA9KgtSf3Se2AW9XY_-3" target="GyIcix-912z4nd1oCBAl-30" edge="1">
@@ -144,7 +144,7 @@
         <mxCell id="GyIcix-912z4nd1oCBAl-50" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;exitPerimeter=0;strokeWidth=2;" parent="VGzt8ICLMrnI1Oa5_CKK-2" source="GyIcix-912z4nd1oCBAl-36" target="GyIcix-912z4nd1oCBAl-48" edge="1">
           <mxGeometry relative="1" as="geometry" />
         </mxCell>
-        <mxCell id="VGzt8ICLMrnI1Oa5_CKK-3" value="&lt;font style=&quot;font-size: 16px; font-weight: normal;&quot; face=&quot;Open Sans&quot;&gt;WoT Toolchain&lt;/font&gt;" style="swimlane;html=1;startSize=20;horizontal=0;rotation=0;fillColor=#eeeeee;strokeColor=#36393d;rounded=1;swimlaneLine=1;glass=0;shadow=0;" parent="VGzt8ICLMrnI1Oa5_CKK-1" vertex="1">
+        <mxCell id="VGzt8ICLMrnI1Oa5_CKK-3" value="&lt;font face=&quot;Open Sans&quot;&gt;&lt;span style=&quot;font-size: 16px; font-weight: 400;&quot;&gt;Render Script&lt;br&gt;&lt;/span&gt;&lt;/font&gt;" style="swimlane;html=1;startSize=20;horizontal=0;rotation=0;fillColor=#eeeeee;strokeColor=#36393d;rounded=1;swimlaneLine=1;glass=0;shadow=0;" parent="VGzt8ICLMrnI1Oa5_CKK-1" vertex="1">
           <mxGeometry x="20" y="370" width="1650" height="230" as="geometry" />
         </mxCell>
         <mxCell id="ePJhNjqC5I8l9NKkh14M-7" value="" style="edgeStyle=elbowEdgeStyle;fontSize=18;html=1;endArrow=blockThin;endFill=1;rounded=0;fontFamily=Open Sans;strokeWidth=3;entryX=0;entryY=0.5;entryDx=0;entryDy=0;entryPerimeter=0;exitX=1;exitY=0.5;exitDx=0;exitDy=0;exitPerimeter=0;" parent="VGzt8ICLMrnI1Oa5_CKK-3" source="ePJhNjqC5I8l9NKkh14M-2" target="ePJhNjqC5I8l9NKkh14M-5" edge="1">