Changes between Version 4 and Version 5 of S3/S3Hierarchy

Timestamp:

05/21/14 19:59:57 (11 years ago)

Author:

Dominic König

Comment:

--

S3/S3Hierarchy

@@ -35 +35 @@
 == Data Model ==
 
-To store a hierarchical taxonomy, the database table must include a parent reference (self-reference). 
+To store a hierarchical taxonomy, the database table must include a parent reference (self-reference). This can either be a foreign key to the table, or - if the table is a super-entity instance - a (second) reference to the super-entity. 
 
-This can either be a foreign key to the table, or - if the table is a super-entity instance - a (second) reference to the super-entity. The diagrams below explain the two models.
+The diagrams explain the two models:
 
 [[Image(hierarchy_data_model.png)]]
+
+== Configuration ==
+
+The hierarchy is configured in the model as the field name of the parent reference:
+
+{{{#!python
+    self.configure(tablename, hierarchy="parent")
+}}}
+
+If categories (e.g. level) are to be used, the hierarchy is configured as tuple of parent reference and category field:
+
+{{{#!python
+    self.configure(tablename, hierarchy=("parent", "level"))
+}}}
+
+== Connecting to the Hierarchy ==
+
+  - ''tbw''