some doc
authorSylvain Thénault <sylvain.thenault@logilab.fr>
Wed, 10 Feb 2010 07:34:24 +0100
changeset 98 774fd2ef5a2f
parent 92 87b2293a11df
child 99 c9f8c151ccdf
some doc
__pkginfo__.py
doc/schema.png
doc/screenshot_keyword_tree.png
--- a/__pkginfo__.py	Wed Dec 09 11:33:23 2009 +0100
+++ b/__pkginfo__.py	Wed Feb 10 07:34:24 2010 +0100
@@ -8,7 +8,7 @@
 version = '.'.join(str(num) for num in numversion)
 
 license = 'LGPL'
-copyright = '''Copyright (c) 2003-2009 LOGILAB S.A. (Paris, FRANCE).
+copyright = '''Copyright (c) 2003-2010 LOGILAB S.A. (Paris, FRANCE).
 http://www.logilab.fr/ -- mailto:contact@logilab.fr'''
 
 author = "Logilab"
@@ -16,10 +16,28 @@
 web = 'http://www.cubicweb.org/project/%s' % distname
 
 short_desc = "keyword component for the Cubicweb framework"
-long_desc = """This Cubicweb component provides classification (hierarchies of keywords)
-to classify content. See also cubicweb-tag.
+long_desc = """Summary
+-------
+The `keyword` cube provides classification by using hierarchies of keywords to
+classify content.
+
+There is two types of keywords:
+
+- `Keyword` which contains a description,
+- `CodeKeyword` which contains the keyword description and the
+  associated code.
 
-CubicWeb is a semantic web application framework, see http://www.cubicweb.org
+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.
+
+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.
 """
 
 classifiers = [
Binary file doc/schema.png has changed
Binary file doc/screenshot_keyword_tree.png has changed