Documentation update : add something about Lodel2 UI and ACL

EditorialModel/backend/graphviz.py

@@ -109,8 +109,8 @@ class EmBackendGraphviz(EmBackendDummy):
                         rel_field += rel_node
 
                         ref_node = EmBackendGraphviz._component_id(em.component(f.rel_to_type_id))
-                        self.edges += '%s:f%d -> %s [ color="purple" ]\n'%(EmBackendGraphviz._component_id(c), cntref, rel_node_id)
-                        self.edges += '%s -> %s [color="purple"]\n'%(rel_node_id, ref_node)
+                        self.edges += '%s:f%d -> %s [ color="purple" dir="both" ]\n'%(EmBackendGraphviz._component_id(c), cntref, rel_node_id)
+                        self.edges += '%s -> %s [color="purple" dir="both" ]\n'%(rel_node_id, ref_node)
 
                     ret += '|'
                     if first:

Lodel/__init__.py

@@ -67,13 +67,26 @@
 # EmFields defines what kind of datas can be stored in EmTypes. Actually its the associationg with an EmFieldtype ( see @ref lodel2_fieldtypes )
 # that really defines what kind of datas can be stored.
 #
-# @subsection lodel2_arch_edmod_fig Editorial model figures
+# @section lodel2_arch_ui Lodel2 user interfaces
 #
-# @subsubsection lodel2_arch_edmod_fig_components Editorial model main components
+# All access to datas are made via UI. UI actions are composed with 3 or 4 elements :
+# - user
+# - action (Crud actions ?)
+# - target
+# - sometimes datas
+#
+# Each actions are send to Lodel2 ACL that check permissions and forward the actions to leapi. leapi send back a reply to the
+# UI. And the response get formatted by UI templates. ( see @ref lodel2_arch_ui_fig )
+#
+# @section lodel2_arch_fig Figures
+#
+# @subsection lodel2_arch_edmod_fig_components Editorial model main components
 # @image html graphviz/em_components.png
-# @subsubsection lodel2_arch_edmod_fig_relations Editorial model relations between components
+# @subsection lodel2_arch_edmod_fig_relations Editorial model relations between components
 # @image html graphviz/em_relations.png
-# @subsubsection lodel2_arch_edmod_fig_hierarchy Hierarchical relations between EmTypes given a classtype
+# @subsection lodel2_arch_edmod_fig_hierarchy Hierarchical relations between EmTypes given a classtype
 # @image html graphviz/em_types_hierarch.png
-# @subsubsection lodel2_arch_edmod_fig_em_example Example of editorial model
+# @subsection lodel2_arch_edmod_fig_em_example Example of editorial model
 # @image html graphviz/example_em_graph.png
+# @subsection lodel2_arch_ui_fig Lodel2 UI schema
+# @image html graphviz/lodel2_ui.png

Makefile

@@ -25,10 +25,10 @@ docimages:
 #
 .PHONY: check doc clean cleanpyc cleandoc cleanpycache
 
-clean: cleanpyc cleandoc cleanpycache
+clean: cleanpyc cleandoc cleanpycache cleandocimages
 
 # Documentation cleaning
-cleandoc: cleandocimages
+cleandoc:
 	-rm -Rfv ./doc/html ./doc/doxygen_sqlite3.db
 
 cleandocimages:

doc/img/graphviz/example_em_graph.dot

@@ -26,8 +26,8 @@ style="invis"
 emcomp1 -> ctentity [ style="dashed" ]
 emcomp2 -> ctperson [ style="dashed" ]
 emcomp13 -> ctentity [ style="dashed" ]
-emcomp5:f0 -> emcomp5emcomp6 [ color="purple" ]
-emcomp5emcomp6 -> emcomp6 [color="purple"]
+emcomp5:f0 -> emcomp5emcomp6 [ color="purple" dir="both" ]
+emcomp5emcomp6 -> emcomp6 [color="purple" dir="both" ]
 emcomp5 -> emcomp1 [ style="dotted" ]
 emcomp5 -> emcomp14 [ label="parent" color="green" ]
 emcomp6 -> emcomp2 [ style="dotted" ]

doc/img/graphviz/lodel2_archi.dot

@@ -1,14 +0,0 @@
-digraph Lodel2_architecture {
-	
-
-	ui [ label="User interface" ]
-	leapi [ label="<api>Lodel Editorial API|{Static API|<dynamic> Dynamically generated API}", shape=record ]
-	editorial_model [ label="<em>Editorial Model|{Classes|Types|{<fields>Fields|<ftype>fieldtypes}}", shape=record ]
-
-	editorial_model:em -> leapi:dynamic [ label="Generate" ]
-	editorial_model:ftype -> editorial_model:fields [ label="Defines field value" ]
-	leapi -> editorial_model:ftype [ label="Asks for data validation" ]
-	ui -> leapi:api
-	leapi:api -> ui
-
-}

doc/img/graphviz/lodel2_ui.dot

@@ -0,0 +1,15 @@
+digraph Lodel2_architecture {
+	
+	ui [label="<ui> UI|{web|cli|lodel2fs}|<tpl> templates", shape=record]
+
+	action [label="{user|action|target}|<datas> datas}", shape=record]
+	ACL
+	leapi [label="LeAPI"]
+
+	ui:ui -> action
+	action -> ACL
+	ACL -> leapi
+	action:datas -> leapi
+	leapi -> ui:tpl
+
+}