Browse Source

Mainpage.dox

prieto 7 years ago
parent
commit
1b01e6c7c3
2 changed files with 30 additions and 26 deletions
  1. 24
    25
      lodel/__init__.py
  2. 6
    1
      mainpage.dox

+ 24
- 25
lodel/__init__.py View File

@@ -1,4 +1,4 @@
1
-# 
1
+#
2 2
 # This file is part of Lodel 2 (https://github.com/OpenEdition)
3 3
 #
4 4
 # Copyright (C) 2015-2017 Cléo UMS-3287
@@ -25,7 +25,7 @@ dyncode = None
25 25
 # @par Lodel2 boot sequence
26 26
 # see @ref install/loader.py
27 27
 # 1. lodel package is imported
28
-# 2. settings are started 
28
+# 2. settings are started
29 29
 # 3. plugins are pre-loaded from conf to load plugins configuration specs
30 30
 # 4. settings are loaded from conf and checked
31 31
 # 3. plugins are loaded (hooks are registered etc)
@@ -79,11 +79,11 @@ dyncode = None
79 79
 #
80 80
 #Autotools provide a way to distribute a software on Posix platforms.
81 81
 #
82
-#@section lodel2_autotools_howto Howto use them
82
+#@section lodel2_autotools_howto How to use them
83 83
 #
84 84
 #Basically you have to run :
85
-#- <code>./bootstrap.sh</code> to generate the configure script( run 
86
-#approximatly <code>aclocal; autoconf; automake</code> or 
85
+#- <code>./bootstrap.sh</code> to generate the configure script( run
86
+#approximatly <code>aclocal; autoconf; automake</code> or
87 87
 #<code>autoreconf</code> )
88 88
 #- <code>./configure</code> to generate Makefile s
89 89
 #- <code>make</code> to build lodel2 (actually to generate lodel/buildconf.py
@@ -93,13 +93,13 @@ dyncode = None
93 93
 #- automake targets
94 94
 # - **all** compile the sources (don't do a lot for a script langage)
95 95
 # - **clean** delete compiled files (don't do a lot for a script langage)
96
-# - **distclean** enhanced comportment compared to default (delete compiled 
96
+# - **distclean** enhanced comportment compared to default (delete compiled
97 97
 #files and generated binary). Here it deletes everything generated by
98 98
 #<code>./bootstrap.sh && ./configure && make</code>
99
-# - **install** Install lodel2 (for the moment copy the lodel dir in 
99
+# - **install** Install lodel2 (for the moment copy the lodel dir in
100 100
 #the good path (configurable when running ./configure ) )
101 101
 # - **uninstall** Remove installed files
102
-#- lodel2 specific targets 
102
+#- lodel2 specific targets
103 103
 # - **tests**, **check** and **checks** are aliases for running tests
104 104
 # - **doc** generate the doxygen documentation
105 105
 # - **em_test** refresh the example/em_test.pickle file using em_test.py
@@ -109,17 +109,17 @@ dyncode = None
109 109
 #@section lodel2_autotools_why Why using autotools
110 110
 #
111 111
 #Python has a lot of packaging and distributing solutions, but none of them
112
-#is as convinent, complete, portable as GNU autotools. For example setup.py 
113
-#with distutils has no uninstall target; pip, wheel, easy-install etc brokes 
112
+#is as convinent, complete, portable as GNU autotools. For example setup.py
113
+#with distutils has no uninstall target; pip, wheel, easy-install etc brokes
114 114
 #totally your distribution packaging/upgrade system etc.
115 115
 #
116
-#Autotools are portable, integrated by debian packaging system ( see 
116
+#Autotools are portable, integrated by debian packaging system ( see
117 117
 #checkinstall) and can support multi langages.
118 118
 #
119 119
 #@section lodel2_autotools_whatfor For doing what
120 120
 #
121
-#Autotools are here to allow distributing and installing Lodel2 on 
122
-#Posix OS. 
121
+#Autotools are here to allow distributing and installing Lodel2 on
122
+#Posix OS.
123 123
 #
124 124
 #The distribution mechanisms handles dependencies checking (NO AUTO INSTALL
125 125
 #WITH BINARY BLOBS !!!), compiling .py files to pyc and pyo, and copy all files
@@ -128,12 +128,12 @@ dyncode = None
128 128
 #@section lodel2_autotools_how How autotools are integrated
129 129
 #
130 130
 #What we call autotools is in fact a lot of software. In our case we use only
131
-#both of them : 
131
+#both of them :
132 132
 #<a href="https://www.gnu.org/software/autoconf/autoconf.html#documentation">
133
-#autoconf</a> and 
133
+#autoconf</a> and
134 134
 #<a href="https://www.gnu.org/software/automake/#documentation">automake</a>
135 135
 #
136
-#A python file is generated ( lodel/buildconf.py from 
136
+#A python file is generated ( lodel/buildconf.py from
137 137
 #@ref lodel/buildconf.py.in) containing various informations gathered during
138 138
 #the build process (for example the presence of pymongo or the precense of
139 139
 #the dependency needed by webui etc.)
@@ -161,28 +161,28 @@ dyncode = None
161 161
 #Automake job is to transform the Makefile.am files into Makefile.in files.
162 162
 #It handles all target creation for build, clean, install, uninstall etc.
163 163
 #
164
-#@section lodel2_autotools_problems Encontered problems
164
+#@section lodel2_autotools_problems Encountered problems
165 165
 #
166 166
 #@ref lodel2_autoconf "Autoconf" use macro "written in m4" (not sure if m4
167
-#is the macro langage). We use two macros sources : automake default python 
167
+#is the macro langage). We use two macros sources : automake default python
168 168
 #support & pyconfigure automake macros.
169 169
 #
170
-#Those macros are broken with python3 (see 
170
+#Those macros are broken with python3 (see
171 171
 #<a href="https://bugs.launchpad.net/ubuntu/+source/python3-defaults/+bug/1408092">
172
-#the python3 sysconfig bug with debian OS</a> ). There is patched version of 
173
-#these macro in the m4 directory (and the associated patches : 
174
-#@ref m4/python.m4.patch "for automake python macros patch" and 
172
+#the python3 sysconfig bug with debian OS</a> ). There is patched version of
173
+#these macro in the m4 directory (and the associated patches :
174
+#@ref m4/python.m4.patch "for automake python macros patch" and
175 175
 #@ref m4/python_pyconfigure.m4.patch "for pyconfigure python macros patch")
176 176
 
177 177
 ##@file m4/python.m4.patch
178 178
 #@ingroup lodel2_deployment
179
-#@brief Patch of automake python macro to solve a bug in pythondir retrieval 
179
+#@brief Patch of automake python macro to solve a bug in pythondir retrieval
180 180
 #on debian
181 181
 #@see https://bugs.launchpad.net/ubuntu/+source/python3-defaults/+bug/1408092
182 182
 
183 183
 ##@file m4/python_pyconfigure.m4.patch
184 184
 #@ingroup lodel2_deployment
185
-#@brief Patch to solve a bug in pyconfigure ac macros in pythondir retrieval 
185
+#@brief Patch to solve a bug in pyconfigure ac macros in pythondir retrieval
186 186
 #on debian
187 187
 #@see https://bugs.launchpad.net/ubuntu/+source/python3-defaults/+bug/1408092
188 188
 
@@ -207,4 +207,3 @@ dyncode = None
207 207
 ##@file lodel/Makefile.am
208 208
 #@brief Makefile model for autotools
209 209
 #@ingroup lodel2_deployment
210
-

+ 6
- 1
mainpage.dox View File

@@ -34,7 +34,9 @@ The Editorial Model, in fact, is the configuration of a lodel site, the cms.
34 34
 
35 35
 The produced CMS are instances of Lodel2.
36 36
 
37
-To manipulate the content (which is composed by EmClass classes) 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.
37
+An API, [LeAPI](@ref lodel.leapi), allows to manipulate the content (which is composed by EmClass classes).
38
+
39
+For this, 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 40
 
39 41
 Datasources are [plugins](@ref lodel.plugin.plugins), like interfaces (IHM, cli, ...), extensions, scripts, session handlers.
40 42
 
@@ -54,5 +56,8 @@ This is done with [LeFactory] (@ref lodel.leapi.lefactory) module.
54 56
 Each change in the editorial model implies changes in dynamic code and datasources.
55 57
 These changes will be performed by the migration handler (not yet implemented).
56 58
 
59
+Deployment, administration
60
+==========================
61
+See [Boot mechanism](@ref lodel2_start), [Administration](@ref lodel2_instance_admin) and [Diffusion and deployment](@ref lodel2_autotools)
57 62
 
58 63
 */

Loading…
Cancel
Save