doc/book/en/development/datamodel/metadata.rst
changeset 4437 21f2e01fdd6a
parent 1714 a721966779be
child 4446 a413fac5ff5e
--- a/doc/book/en/development/datamodel/metadata.rst	Wed Feb 03 14:46:32 2010 +0100
+++ b/doc/book/en/development/datamodel/metadata.rst	Wed Feb 03 18:44:24 2010 +0100
@@ -1,43 +1,54 @@
 
 Meta-data
-----------
+---------
 
-Each entity type has at least the following meta-relations:
+.. index::
+   schema: meta-data;
+   schema: eid; creation_date; modification_data; cwuri
+   schema: created_by; owned_by; is; is_instance;
+
+Each entity type in |cubicweb| has at least the following meta-data attributes and relations:
 
 eid
-~~~
-Each entity in *CubicWeb* has an associated identifier which is unique
-in an instance. We usually call this identifier `eid`.
+  entity's identifier which is unique in an instance. We usually call this identifier `eid` for historical reason.
+
+creation_date
+  Date and time of the creation of the entity.
+
+modification_date
+  Date and time of the latest modification of an entity.
+
+cwuri
+  Reference URL of the entity, which is not expected to change.
 
-`creation_date` and `modification_date`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Date and time of the creation / lastest modification of an entity.
+created_by
+  Relation to the :ref:`users <CWUser>` who has created the entity
+
+owned_by
+  Relation to :ref:`users <CWUser>` whom the entity belongs; usually the creator but not
+  necessary, and it could have multiple owners notably for permission control
+
+is
+  Relation to the :ref:`entity type <CWEType>` of which type the entity is.
+
+is_instance
+  Relation to the :ref:`entity types <CWEType>` of which type the
+  entity is an instance of.
 
 
-`created_by`
-~~~~~~~~~~~~
-relation to the :ref:`users <CWUser>` who has created the entity
+Virtual RQL relations
+---------------------
+XXX move this to the RQL chapter.
+
+Those relations may only be used in RQL query and are not actual attributes of your entities...
 
-`owned_by`
-~~~~~~~~~~
-relation to :ref:`users <CWUser>` whom the entity belongs; usually the creator but not
-necessary, and it could have multiple owners notably for permission control
+has_text
+  Relation to use to query the full text index (only for entities having fulltextindexed attributes).
 
-`is`
-~~~~~
-relation to the :ref:`entity type <CWEType>` of which type the entity is.
-
-`is_instance`
-~~~~~~~~~~~~~
-relation to the :ref:`entity types <CWEType>` of which type the entity is an instance of.
+identity
+  Relation to use to tell that a RQL variable should be the same as entity another
+(but you've to use two different rql variables for querying purpose)
 
 
-Special relations
------------------
-`has_text`
-~~~~~~~~~~
-query the full text index (only for entities having fulltextindexed attributes)
 
-`identity`
-~~~~~~~~~~
-XXX
\ No newline at end of file
+.. |cubicweb| replace:: *CubicWeb*
\ No newline at end of file