doc/book/en/B0011-schema-stdlib.en.txt
author Emile Anclin <emile.anclin@logilab.fr>
Wed, 01 Apr 2009 17:31:20 +0200
changeset 1205 79d33f7db590
parent 1193 24486ce4dea1
child 1398 5fe84a5f7035
permissions -rw-r--r--
[doc] some more small improvements
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
     1
.. -*- coding: utf-8 -*-
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
     2
101
c9138325b89f [doc] Initial translation for data model chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
     3
Pre-defined schemas in the library
c9138325b89f [doc] Initial translation for data model chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
     4
----------------------------------
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
     5
1163
232aef110a0a doc improvements; typos
Emile Anclin <emile.anclin@logilab.fr>
parents: 466
diff changeset
     6
The library defines a set of entity schemas that are required by the system
101
c9138325b89f [doc] Initial translation for data model chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
     7
or commonly used in `CubicWeb` applications.
301
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 292
diff changeset
     8
Of course, you can extend those schemas if necessary.
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
     9
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    10
101
c9138325b89f [doc] Initial translation for data model chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
    11
System schemas
c9138325b89f [doc] Initial translation for data model chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
    12
``````````````
1205
79d33f7db590 [doc] some more small improvements
Emile Anclin <emile.anclin@logilab.fr>
parents: 1193
diff changeset
    13
The available system entities are:
101
c9138325b89f [doc] Initial translation for data model chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
    14
c9138325b89f [doc] Initial translation for data model chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
    15
* `EUser`, system users
c9138325b89f [doc] Initial translation for data model chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
    16
* `EGroup`, users groups
c9138325b89f [doc] Initial translation for data model chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
    17
* `EEType`, entity type
c9138325b89f [doc] Initial translation for data model chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
    18
* `ERType`, relation type
c9138325b89f [doc] Initial translation for data model chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
    19
c9138325b89f [doc] Initial translation for data model chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
    20
* `State`, workflow state
c9138325b89f [doc] Initial translation for data model chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
    21
* `Transition`, workflow transition
c9138325b89f [doc] Initial translation for data model chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
    22
* `TrInfo`, record of a transition trafic for an entity 
c9138325b89f [doc] Initial translation for data model chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
    23
c9138325b89f [doc] Initial translation for data model chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
    24
* `EmailAddress`, email address, used by the system to send notifications
c9138325b89f [doc] Initial translation for data model chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
    25
  to the users and also used by others optionnals schemas
c9138325b89f [doc] Initial translation for data model chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
    26
c9138325b89f [doc] Initial translation for data model chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
    27
* `EProperty`, used to configure the application
c9138325b89f [doc] Initial translation for data model chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
    28
* `EPermission`, used to configure the security of the application
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    29
101
c9138325b89f [doc] Initial translation for data model chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
    30
* `Card`, generic documenting card
c9138325b89f [doc] Initial translation for data model chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
    31
* `Bookmark`, an entity type used to allow a user to customize his links within
c9138325b89f [doc] Initial translation for data model chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
    32
  the application
c9138325b89f [doc] Initial translation for data model chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
    33
1168
ebf7328c251e improve migration doc
Emile Anclin <emile.anclin@logilab.fr>
parents: 1163
diff changeset
    34
(The first 'E' in some of the names is the first letter of 'Erudi', 
ebf7328c251e improve migration doc
Emile Anclin <emile.anclin@logilab.fr>
parents: 1163
diff changeset
    35
`CubicWeb`'s old name; it might be changed/removed some day.)
ebf7328c251e improve migration doc
Emile Anclin <emile.anclin@logilab.fr>
parents: 1163
diff changeset
    36
1205
79d33f7db590 [doc] some more small improvements
Emile Anclin <emile.anclin@logilab.fr>
parents: 1193
diff changeset
    37
Available cubes
1193
24486ce4dea1 [doc] Improve a little bit postgres configuration and environment variables set-up. Needs to be finalized.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1168
diff changeset
    38
```````````````
101
c9138325b89f [doc] Initial translation for data model chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
    39
c9138325b89f [doc] Initial translation for data model chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
    40
An application is based on several basic cubes. In the set of available
229
767ff7f5d5a7 [doc] Replace all : s/by example/for example/
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
    41
basic cubes we can find for example :
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    42
466
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    43
* addressbook_: PhoneNumber and PostalAddress
101
c9138325b89f [doc] Initial translation for data model chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
    44
466
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    45
* basket_: Basket (like a shopping cart)
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    46
466
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    47
* blog_: Blog (a *very* basic blog)
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    48
466
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    49
* comment_: Comment (to attach comment threads to entities)
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    50
466
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    51
* email_: archiving management for emails (`Email`, `Emailpart`,
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    52
  `Emailthread`)
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    53
466
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    54
* event_: Event (define events, display them in calendars)
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    55
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    56
* file_: File (to allow users to upload and store binary or text files)
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    57
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    58
* folder_: Folder (to organize things but grouping them in folders)
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    59
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    60
* keyword_: Keyword (to define classification schemes)
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    61
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    62
* link_: Link (to collect links to web resources)
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    63
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    64
* mailinglist_: MailingList (to reference a mailing-list and the URLs
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    65
  for its archives and its admin interface)
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    66
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    67
* person_: Person (easily mixed with addressbook)
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    68
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    69
* tag_: Tag (to tag anything)
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    70
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    71
* task_: Task (something to be done between start and stop date)
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    72
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    73
* zone_: Zone (to define places within larger places, for example a
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    74
  city in a state in a country)
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    75
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    76
.. _addressbook: http://www.cubicweb.org/project/cubicweb-addressbook
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    77
.. _basket: http://www.cubicweb.org/project/cubicweb-basket
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    78
.. _blog: http://www.cubicweb.org/project/cubicweb-blog
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    79
.. _comment: http://www.cubicweb.org/project/cubicweb-comment
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    80
.. _email: http://www.cubicweb.org/project/cubicweb-email
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    81
.. _event: http://www.cubicweb.org/project/cubicweb-event
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    82
.. _file: http://www.cubicweb.org/project/cubicweb-file
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    83
.. _folder: http://www.cubicweb.org/project/cubicweb-folder
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    84
.. _keyword: http://www.cubicweb.org/project/cubicweb-keyword
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    85
.. _link: http://www.cubicweb.org/project/cubicweb-link
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    86
.. _mailinglist: http://www.cubicweb.org/project/cubicweb-mailinglist
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    87
.. _person: http://www.cubicweb.org/project/cubicweb-person
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    88
.. _tag: http://www.cubicweb.org/project/cubicweb-tag
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    89
.. _task: http://www.cubicweb.org/project/cubicweb-task
bef394c66f10 updated list of cubes in the doc
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 301
diff changeset
    90
.. _zone: http://www.cubicweb.org/project/cubicweb-zone
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    91
101
c9138325b89f [doc] Initial translation for data model chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
    92
To declare the use of a component, once installed, add the name of the component
c9138325b89f [doc] Initial translation for data model chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
    93
to the variable `__use__` in the file `__pkginfo__.py` of your own component.
c9138325b89f [doc] Initial translation for data model chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
    94
271
e150b92237d9 [doc] Add link to cubicweb's forge for cubes available.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 229
diff changeset
    95
.. note::
e150b92237d9 [doc] Add link to cubicweb's forge for cubes available.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 229
diff changeset
    96
  The listed cubes above are available as debian-packages on `CubicWeb's forge`_.
e150b92237d9 [doc] Add link to cubicweb's forge for cubes available.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 229
diff changeset
    97
e150b92237d9 [doc] Add link to cubicweb's forge for cubes available.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 229
diff changeset
    98
.. _`CubicWeb's forge`: http://www.cubicweb.org/project?vtitle=All%20cubicweb%20projects