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 `CubicWeb` applications. |
|
8 Of course, you can extend those schemas if necessarry. |
|
9 |
|
10 |
|
11 System schemas |
|
12 `````````````` |
|
13 The system entities available are : |
|
14 |
|
15 * `EUser`, system users |
|
16 * `EGroup`, users groups |
|
17 * `EEType`, entity type |
|
18 * `ERType`, relation type |
|
19 |
|
20 * `State`, workflow state |
|
21 * `Transition`, workflow transition |
|
22 * `TrInfo`, record of a transition trafic for an entity |
|
23 |
|
24 * `EmailAddress`, email address, used by the system to send notifications |
|
25 to the users and also used by others optionnals schemas |
|
26 |
|
27 * `EProperty`, used to configure the application |
|
28 * `EPermission`, used to configure the security of the application |
|
29 |
|
30 * `Card`, generic documenting card |
|
31 * `Bookmark`, an entity type used to allow a user to customize his links within |
|
32 the application |
|
33 |
|
34 Cubes in the library |
|
35 ```````````````````` |
|
36 |
|
37 An application is based on several basic cubes. In the set of available |
|
38 basic cubes we can find by example : |
|
39 |
|
40 * `comment`, provides an entity type for `Comment` allowing us to comment others |
|
41 site's entities |
|
42 |
|
43 * `mailinglist`, provides an entity type for `Mailinglist` which groups informations |
|
44 in a discussion list |
|
45 |
|
46 * `file`, provides entity types for `File` et `Image` used to represent |
|
47 files (text or binary) with additionnal informations such as MIME type or |
|
48 encoding. |
|
49 |
|
50 * `link`, provides an entity type for hypertext link (`Link`) |
|
51 |
|
52 * `blog`, provides an entity type weblog (`Blog`) |
|
53 |
|
54 * `person`, provides an entity type for a person (`Person`) |
|
55 |
|
56 * `addressbook`, provides an entity type used to represent phone |
|
57 numbers (`PhoneNumber`) and mailing address (`PostalAddress`) |
|
58 |
|
59 * `classtags`, categorization system based on tags (`Tag`) |
|
60 |
|
61 * `classfolders`, categorization system based on folders hierarchy in order |
|
62 to create navigation sections (`Folder`) |
|
63 |
|
64 * `email`, archiving management for emails (`Email`, `Emailpart`, |
|
65 `Emailthread`) |
|
66 |
|
67 * `basket`, basket management (`Basket`) allowing to group entities |
|
68 |
|
69 To declare the use of a component, once installed, add the name of the component |
|
70 to the variable `__use__` in the file `__pkginfo__.py` of your own component. |
|
71 |
|