lodel2_mirror/Lodel/__init__.py

## @mainpage
#
# @section Introduction
#
# For basics Lodel2 configuration & usage see README.md
#
# - @subpage lodel2_doc
# - Main packages
#  - Lodel
#   - Lodel.settings
#  - EditorialModel
#   - EditorialModel.fieldtypes
#   - EditorialModel.backend
#  - @ref leapi
#  - DataSource
#   - DataSource.MySQL

## @page lodel2_doc Lodel2 documentation
# @tableofcontents
#
# @section mainpage_docs Documentation
#
# - @subpage lodel2_arch 
#  - @subpage lodel_settings
#  - @subpage api_user_side
#   - @subpage lecrud_instanciation
#  - @subpage lodel2_fieldtypes
#
#


## @page lodel2_arch Lodel2 architecture
#
# @tableofcontents
#
# @section lodel2_arch_basic Lodel2
#
# Lodel 2 is a CMS that allows to define content types ......
#
# @section lodel2_arch_edmod Lodel2 Editorial Model
#
# The editorial model is the part of lodel2 that allows to defines content types.
#
# To handle this the editorial model has 3  abstractions :
# - Classes
# - Types
# - Fields
#
# @warning An editorial model does NOT contains values.
#
# The editorial model is used to generate the dynamic part of the Lodel2 API ( see @ref leapi )
#
# @subsection lodel2_arch_edmod_classes Editorial model classes ( EmClass )
#
# An EmClass is basically a named collection of EmFields ( see @ref lodel2_arch_edmod_fields ) associated with a classtype.
#
# Classtypes are "family" of EmClasses. They defines allowed hierarchical relations between EmClass.
# 
# @subsection lodel2_arch_edmod_types Editorial model types ( EmType )
#
# An EmType is a named EmClass specialization. In fact some EmField in an EmClass can be defined as optionnal and then be selected
# or not to be included in an EmType.
# 
# @subsection lodel2_arch_edmod_fields Editorial model fields ( EmField )
#
# 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.
#
# @section lodel2_arch_ui Lodel2 user interfaces
#
# 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
# @subsection lodel2_arch_edmod_fig_relations Editorial model relations between components
# @image html graphviz/em_relations.png
# @subsection lodel2_arch_edmod_fig_hierarchy Hierarchical relations between EmTypes given a classtype
# @image html graphviz/em_types_hierarch.png
# @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