Overview:

• ATVocabularyManager offers central through the Plone management of dynamic vocabularies.
• This product is based on Archetypes and made to work with Archetypes as well as with other Products. It is intended use is within Archetypes Fields. Using it as a vocabulary provider for CMFMetadata worked out fine too.
• to use a managed vocabulary simply add the term vocabulary = NamedVocabulary("myvocabulary") to the fields of your Archetypes Schema, import NamedVocabulary from this Product and create your vocabulary with id myvocabulary in portal_vocabularies tool (available through Plone Site-Setup).
• ATVocabularyManager supports:
  • simple flat key - value vocabularies,
  • tree like hierachical vocabularies (see Limitations),
  • IMS Vocabulary Definition Exchange Format (VDEX) aware vocabularies with XML Import and Export.
• Vocabularies are pluggable types. ATVocabularyManager is prepared for extension with your special vocabulary type.
• Each vocabulary term needs to be an CMF aware content type. Reuse normal rich content as a vocabularies.
• ArchGenXML 1.4 code-generator does full integration of ATVocabularyManager: via tagged value defined named vocabularies are registered transparently, VDEX-XML files are imported at install-time, stub vocabularies are created at install time and custom types are registered by just providing appropriate stereotypes.
• ATVM is Linguaplone compatible (only tested with SimpleVocabulary, and TreeVocabulary) Add a simple vocabulary with some items, install and configure Linguaplone, translate the vocabulary to the language(s) of your choice, translate every item to the language(s) of your choice. NamedVocabulary() will return the vocabulary as usual, the keys will stay the same disregarding language settings, the values will show in the currently selected language.
• you can do hierachy-aware searches on treevocabularies (for more information on this see doc/search_treevocabulary.txt) attention: curently certain changes in the term hierachy require a catalog rebuild (see Limitations)

Installation

You install it the usual way - either using Plone Setup, QuickInstaller or make an External method the CMF way.

Dependencies:

• Archetypes (1.3.9)

Todo

• UI work
• create methods for easy cmfmetadata integration
• add some caching, atm using this kind of vocabulary is expensive, because it wakes up plenty of objects. May ZCacheable mixin might be an good idea.

Limitations

• TreeVocabulary catalog updates If you are using the hierachy-aware catalog search support of treevocabularies you need to rebuild the uid_catalog and portal_catalog if you move a vocabularyterm that has other terms below it.

Known Bugs

• UI does not show in all cases vocabulary/items properly.
• Adding/Editing VDEX TTW is a pain. Take an editor of your choice, create the vocab and upload it or help writing an UI.

Feel free to add bugs in here!

Support

The author offers professional support. The classical well-working community support is found at the mailing-lists and IRC-channels announced at plone.org:http://plone.org

Credits

Several parts code was created for the ZUCCARO project. ZUCCARO (Zope-based Universally Configurable Classes for Academic Research Online) is a database framework for the Humanities developed by the Bibliotheca Hertziana, Max Planck Institute for Art History For further information: zuccaro.biblhertz.it

Copyright/ Author/ Licence

copyright

2004-2006 by BlueDynamics Alliance, Klein & Partner KEG, Austria and parts eduplone Open Source Business Network EEIG, Austria

author

Jens Klein

contributions

Harald Friessnegger: i18n, cleanup, more cleanup of hierachical vocabularies (see HISTORY.txt)

more contributions

several people committed smaller fixes and translations, thank you guys.

license

This software is under a BSD-like Licence. See separate file LICENCE.txt