README.txt

   1 Introduction
   2 ============
   3 This packages adds support for categories with hierarchies.
   4 To accomplish this, it offers a widget for setting the categories
   5 on content, and a custom Indexer that takes care that the hierarchical
   6 nature is working with search too.
   7
   8 How to use it
   9 -------------
  10 1. Create a Vocabulary with a hierarchy in the ATVocabularyManager
  11 2. Create a Content type a Field that uses that vocabulary and the
  12    InlineTreeWidget.
  13 3. Add an instance of the content type and use it.
  14
  15 Search
  16 ------
  17 If somebody wants to search for all nodes, and some object has
  18 a subnode selected, the package assumes that given somebody also wants to
  19 find that object. If you want to see all cars and one item has the
  20 sub category beetle set, this item will be found too. This functionality
  21 is provided by a custom indexer 'tree_categories'.
  22
  23 InlineTreeWidget
  24 ----------------
  25 The widget is based on the jquery extension dynatree:
  26 http://wwwendt.de/tech/dynatree/index.html
  27
  28 It generates list of selected options and a button to show a tree of possible
  29 options. You can add Options by clicking on the checkbox, and you can remove
  30 buttons by clicking on the checkbox again. Additionally, the list of selected
  31 options have an x icon per option, that you can use for removing items too.
  32
  33 The changes are applied immediatelly.
  34
  35 Additionally to the possibility of having multiple fields that use the
  36 widget on a single content type, there exists support to use the widget
  37 in customized folder_contents view, for setting options on multiple content
  38 objects at once. That feature is still a bit experimental, so there is no
  39 documentation yet on how to use it.
  40
  41 Index
  42 -----
  43 Upon installing, a new index is added, tree_categories.
  44 The package also adds an indexer of its own, that tries
  45 to index all vocabulary Fields of all AT Content types.
  46 Be careful, that might slow indexing down!
  47
  48 Todo / Ideas
  49 ------------
  50 - It is untested if i18n with vdex categories work together with LinguaPlone
  51 - It would be nice, if we could be independent from ATVocabularyManager.
  52   That would mean, that this package would contain an utility of its own and
  53   one or more new views.
  54 - It would also be nice to make this work with dexterity