doc/book/en/development/datamodel/baseschema.rst
branchtls-sprint
changeset 1714 a721966779be
child 2172 cf8f9180e63e
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/book/en/development/datamodel/baseschema.rst	Thu May 07 16:33:22 2009 +0200
@@ -0,0 +1,38 @@
+
+Pre-defined schemas in the library
+----------------------------------
+
+The library defines a set of entity schemas that are required by the system
+or commonly used in `CubicWeb` applications.
+
+
+Entity types used to store the schema
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+* `CWEType`, entity type
+* `CWRType`, relation type
+* `CWRelation`, relation definition
+* `CWAttribute`, attribute relation definition
+* `CWConstraint`,  `CWConstraintType`, `RQLExpression`
+
+Entity types used to manage users and permissions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+* `CWUser`, system users
+* `CWGroup`, users groups
+* `CWPermission`, used to configure the security of the application
+
+Entity types used to manage workflows
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+* `State`, workflow state
+* `Transition`, workflow transition
+* `TrInfo`, record of a transition trafic for an entity 
+
+Other entity types
+~~~~~~~~~~~~~~~~~~
+* `CWCache`
+* `CWProperty`, used to configure the application
+
+* `EmailAddress`, email address, used by the system to send notifications
+  to the users and also used by others optionnals schemas
+
+* `Bookmark`, an entity type used to allow a user to customize his links within
+  the application