Browse Source

Mainpage for doxygen

prieto 7 years ago
parent
commit
2c7e0f6703

BIN
doc/img/dia/auth_client_user_session.dia View File


BIN
doc/img/dia/authorizations_handling.dia View File


BIN
doc/img/dia/session_creation.dia View File


+ 0
- 14
doc/img/graphviz/Makefile View File

@@ -1,14 +0,0 @@
1
-dotfiles := $(wildcard *.dot)
2
-images := $(patsubst %.dot,%.png,$(wildcard *.dot))
3
-
4
-all: $(images)
5
-	
6
-%.png: %.dot
7
-	dot -Tpng $< > $@
8
-
9
-.PHONY: clean distclean
10
-
11
-clean:
12
-	-rm $(images)
13
-
14
-distclean: clean

BIN
doc/img/openedition_logo.png View File


+ 1
- 1
lodel/leapi/lefactory.py View File

@@ -1,5 +1,5 @@
1 1
 #-*- coding: utf-8 -*-
2
-
2
+## @package lodel.leapi.lefactory
3 3
 import os
4 4
 import os.path
5 5
 import functools

+ 0
- 1
lodel/leapi/leobject.py View File

@@ -1,5 +1,4 @@
1 1
 #-*- coding: utf-8 -*-
2
-
3 2
 ## @package lodel.leapi.leobject
4 3
 # This module is centered around the basic LeObject class, which is the main class for all the objects managed by lodel.
5 4
 

+ 1
- 1
lodel/leapi/query.py View File

@@ -1,5 +1,5 @@
1 1
 #-*- coding: utf-8 -*-
2
-
2
+## @package lodel.leapi.lequery
3 3
 import re
4 4
 import copy
5 5
 import inspect

+ 1
- 0
lodel/plugin/plugins.py View File

@@ -1,4 +1,5 @@
1 1
 #-*- coding: utf-8 -*-
2
+# @package lodel.plugin.plugins
2 3
 
3 4
 import sys
4 5
 import os.path

+ 54
- 0
mainpage.dox View File

@@ -0,0 +1,54 @@
1
+ /**
2
+\mainpage Lodel 2 documentation
3
+
4
+Lodel2 has two modes of operations : a standalone one, in that case Lodel2 is a customized CMS or and one, multisite case, in which it can be seen as a manager of CMS.
5
+
6
+Lodel2 has to perform 2 distinct tasks : to produce sites (cms), and to be a site.
7
+Plus, in the case of multisite install, it has to manage the produced sites.
8
+2 parts :
9
+- Editorial Model, whom the goal is to describe the structure of the content managed by the instance. This Editorial Model has to be built, and has to produce the python code which will represent the content.
10
+- LeAPI, which is a python API to manipulate the objetcs created by the first part.
11
+
12
+In case of multisite install the manager of the sites is a lodel site itself, like the others, with a adapted Editorial Model.
13
+
14
+Editorial Model part
15
+====================
16
+
17
+To represent the content we have :
18
+
19
+- Classes, the [EmClass](@ref lodel.editorial_model.components) module, it is a fields container which is named.
20
+- Fields, the [emField](@ref lodel.editorial_model.components) module
21
+
22
+These two modules are the components (see [EmComponent](@ref lodel.editorial_model.components)) of the content.
23
+
24
+In order to organize the different Editorial Models (for the different sites) from a single one, we have set up a system of groups, 
25
+the [EmGroup](@ref lodel.editorial_model.components). This system allows each site to activate or not certain groups. 
26
+A EmGroup can be seen as a EmClass end EmField named container.
27
+ Some groups can depend of other groups. 
28
+ This means that if EmGroup A is selected and it depends of EmGroup B, it must also be activated.
29
+
30
+CMS part
31
+========
32
+
33
+The Editorial Model, in fact, is the configuration of a lodel site, the cms.
34
+
35
+The produced CMS are instances of Lodel2.
36
+
37
+To manipulate the content (which is EmClass ) we have the [LeObject](@ref lodel.leapi.leobject) API. This class allows CRUD operations on content objects. To perform these operations it uses [LeQuery](@ref lodel.leapi.lequery) API, the bridge with the datasource.
38
+
39
+Datasources are [plugins](@ref lodel.plugin.plugins), like interfaces (IHM, cli, ...), extensions, scripts, session handlers.
40
+
41
+Plugins part
42
+============
43
+
44
+A lodel2 instance is an API. To produce a running application, we need plugins.
45
+
46
+Several types of plugins are mandatory : datasource, interface for now.
47
+
48
+LeFactory - Migration Handler
49
+=============================
50
+
51
+
52
+
53
+
54
+*/

Loading…
Cancel
Save