Bez popisu
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

__init__.py 3.0KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091
  1. ## @mainpage
  2. #
  3. # @section Introduction
  4. #
  5. # For basics Lodel2 configuration & usage see README.md
  6. #
  7. # - @subpage lodel2_doc
  8. # - Main packages
  9. # - Lodel
  10. # - Lodel.settings
  11. # - EditorialModel
  12. # - EditorialModel.fieldtypes
  13. # - EditorialModel.backend
  14. # - @ref leapi
  15. # - DataSource
  16. # - DataSource.MySQL
  17. ## @page lodel2_doc Lodel2 documentation
  18. # @tableofcontents
  19. #
  20. # @section mainpage_docs Documentation
  21. #
  22. # - @subpage lodel2_arch
  23. # - @subpage lodel_settings
  24. # - @subpage api_user_side
  25. # - @subpage lecrud_instanciation
  26. # - @subpage lodel2_fieldtypes
  27. #
  28. #
  29. ## @page lodel2_arch Lodel2 architecture
  30. #
  31. # @tableofcontents
  32. #
  33. # @section lodel2_arch_basic Lodel2
  34. #
  35. # Lodel 2 is a CMS that allows to define content types ......
  36. #
  37. # @section lodel2_arch_edmod Lodel2 Editorial Model
  38. #
  39. # The editorial model is the part of lodel2 that allows to defines content types.
  40. #
  41. # To handle this the editorial model has 3 abstractions :
  42. # - Classes
  43. # - Types
  44. # - Fields
  45. #
  46. # @warning An editorial model does NOT contains values.
  47. #
  48. # The editorial model is used to generate the dynamic part of the Lodel2 API ( see @ref leapi )
  49. #
  50. # @subsection lodel2_arch_edmod_classes Editorial model classes ( EmClass )
  51. #
  52. # An EmClass is basically a named collection of EmFields ( see @ref lodel2_arch_edmod_fields ) associated with a classtype.
  53. #
  54. # Classtypes are "family" of EmClasses. They defines allowed hierarchical relations between EmClass.
  55. #
  56. # @subsection lodel2_arch_edmod_types Editorial model types ( EmType )
  57. #
  58. # An EmType is a named EmClass specialization. In fact some EmField in an EmClass can be defined as optionnal and then be selected
  59. # or not to be included in an EmType.
  60. # @subsection lodel2_arch_edmod_fields Editorial model fields ( EmField )
  61. #
  62. # EmFields defines what kind of datas can be stored in EmTypes. Actually its the associationg with an EmFieldtype ( see @ref lodel2_fieldtypes )
  63. # that really defines what kind of datas can be stored.
  64. #
  65. # @section lodel2_arch_ui Lodel2 user interfaces
  66. #
  67. # All access to datas are made via UI. UI actions are composed with 3 or 4 elements :
  68. # - user
  69. # - action (Crud actions ?)
  70. # - target
  71. # - sometimes datas
  72. #
  73. # Each actions are send to Lodel2 ACL that check permissions and forward the actions to leapi. leapi send back a reply to the
  74. # UI. And the response get formatted by UI templates. ( see @ref lodel2_arch_ui_fig )
  75. #
  76. # @section lodel2_arch_fig Figures
  77. #
  78. # @subsection lodel2_arch_edmod_fig_components Editorial model main components
  79. # @image html graphviz/em_components.png
  80. # @subsection lodel2_arch_edmod_fig_relations Editorial model relations between components
  81. # @image html graphviz/em_relations.png
  82. # @subsection lodel2_arch_edmod_fig_hierarchy Hierarchical relations between EmTypes given a classtype
  83. # @image html graphviz/em_types_hierarch.png
  84. # @subsection lodel2_arch_edmod_fig_em_example Example of editorial model
  85. # @image html graphviz/example_em_graph.png
  86. # @subsection lodel2_arch_ui_fig Lodel2 UI schema
  87. # @image html graphviz/lodel2_ui.png