1 .. -*- coding: utf-8 -*- |
|
2 |
|
3 Pre-defined schemas in the library |
|
4 ---------------------------------- |
|
5 |
|
6 The library defines a set of entities schemas that are required by the system |
|
7 or commonly used in `LAX` applications. |
|
8 Of course, you can extend those schemas if necessarry. |
|
9 |
|
10 System schemas |
|
11 `````````````` |
|
12 Those are defined in:: |
|
13 |
|
14 ./myapp/ginco/schemas/ |
|
15 ./myapp/ginco/entities/ |
|
16 |
|
17 ``schemas/`` defines the data model you will use in your application. |
|
18 It allows you to describre the entities and the relations you will need. |
|
19 |
|
20 ``entities/`` deifnes the methods you might need on the entities you |
|
21 defined in your schema. |
|
22 |
|
23 The system entities available are: |
|
24 |
|
25 * `EUser`, system users |
|
26 * `EGroup`, users groups |
|
27 * `EEType`, entity type |
|
28 * `ERType`, relation type |
|
29 |
|
30 * `State`, workflow state |
|
31 * `Transition`, workflow transition |
|
32 * `TrInfo`, record of a transition trafic for an entity |
|
33 |
|
34 * `EmailAddress`, email address, used by the system to send notifications |
|
35 to the users and also used by others optionnals schemas |
|
36 |
|
37 * `EProperty`, used to configure the application |
|
38 * `EPermission`, used to configure the security of the application |
|
39 |
|
40 * `Card`, generic documenting card |
|
41 * `Bookmark`, an entity type used to allow a user to customize his links within |
|
42 the application |
|
43 |
|
44 |
|
45 Components in the library |
|
46 ````````````````````````` |
|
47 |
|
48 Those are defined in:: |
|
49 |
|
50 ./myapp/ginco-apps/ |
|
51 |
|
52 An application is based on several basic components. In the set of available |
|
53 basic components we can find by example: |
|
54 |
|
55 * `ecomment`, provides an entity type for `Comment` allowing us to comment others |
|
56 site's entities |
|
57 |
|
58 * `emailinglist`, provides an entity type for `Mailinglist` which groups informations |
|
59 in a discussion list |
|
60 |
|
61 * `efile`, provides entity types for `File` et `Image` used to represent |
|
62 files (text or binary) with additionnal informations such as MIME type or |
|
63 encoding. |
|
64 |
|
65 * `elink`, provides an entity type for hypertext link (`Link`) |
|
66 |
|
67 * `eblog`, provides an entity type weblog (`Blog`) |
|
68 |
|
69 * `eperson`, provides an entity type for a person (`Person`) |
|
70 |
|
71 * `eaddressbook`, provides an entity type used to represent phone |
|
72 numbers (`PhoneNumber`) and mailing address (`PostalAddress`) |
|
73 |
|
74 * `eclasstags`, categorization system based on tags (`Tag`) |
|
75 |
|
76 * `eclassfolders`, categorization system based on folders hierarchy in order |
|
77 to create navigation sections (`Folder`) |
|
78 |
|
79 * `eemail`, archiving management for emails (`Email`, `Emailpart`, |
|
80 `Emailthread`) |
|
81 |
|
82 * `ebasket`, basket management (`Basket`) allowing to group entities |
|
83 |
|
84 To declare the use of a component, once installed, add the name of the component |
|
85 to the variable `__use__` in the file `__pkginfo__.py` of your own component. |
|
86 |
|