more doc stable
authorSylvain Thénault <sylvain.thenault@logilab.fr>
Tue, 23 Mar 2010 11:34:38 +0100
branchstable
changeset 106 d9746abcdd02
parent 105 0f164eed9ba8
child 107 d7b05aec0868
more doc
__pkginfo__.py
--- a/__pkginfo__.py	Mon Feb 15 17:14:30 2010 +0100
+++ b/__pkginfo__.py	Tue Mar 23 11:34:38 2010 +0100
@@ -15,29 +15,34 @@
 author_email = "contact@logilab.fr"
 web = 'http://www.cubicweb.org/project/%s' % distname
 
-short_desc = "keyword component for the Cubicweb framework"
+short_desc = "classification schemes system for the Cubicweb framework"
 long_desc = """Summary
 -------
 The `keyword` cube provides classification by using hierarchies of keywords to
 classify content.
 
+Each classification is represented using a `Classification` entity, which will
+hold a keywords tree.
+
 There is two types of keywords:
 
 - `Keyword` which contains a description,
-- `CodeKeyword` which contains the keyword description and the
-  associated code.
+
+- `CodeKeyword` which contains the keyword description and the associated code.
 
-In order to link an entity to a keyword, you have to add a relation
-`applied_to` in the schema.
+In order to link an entity to a keyword, you have to add a relation `applied_to`
+in the schema.
 
-Each keyword has the `subkeyword_of` relation definition. This allows
-to navigate in the classification without a Modified Preorder Tree
-Traversal representation of the data.
+Each keyword has the `subkeyword_of` relation definition. This allows to
+navigate in the classification without a Modified Preorder Tree Traversal
+representation of the data.
 
-Some methods are defined in order to get parents and children or get
-the status of a keyword (leaf or root).
+Some methods are defined in order to get parents and children or get the status
+of a keyword (leaf or root).
 
-See also cubicweb-tag as another (simpler) way to classify content.
+See also `cubicweb-tag`_ as another (simpler) way to classify content.
+
+.. _`cubicweb-tag`: http://www.cubicweb.org/project/cubicweb-tag
 """
 
 classifiers = [