You are here

Home » API reference » Community Tags 6.2

README.txt in Community Tags 6.2

Same filename in this branch
  1. 6.2 README.txt
  2. 6.2 community_tags_unitag/README.txt
  3. 6.2 community_tags_authcache/README.txt
  4. 6.2 community_tags_views/README.txt
  5. 6.2 community_tags_node/README.txt
; $Id$

OVERVIEW
========

Unitag helps to keep a taxonomy clean, consistent, and relevant. As well as cleaning, de-duplicating, and filtering tags automatically, it can be configured to place all new tags in a moderation queue. It is the perfect partner to community tagging, dealing with most of the issues that are encountered when allowing a large set of users to tag content.

This sub-module integrates Community tags with Unitag.


FEATURES
========

* Synonym replacement. If a user enters a tag which is a synonym of another tag, the tag is replaced with the synonym.
* Moderation of new tags. New tags may be queued for moderation. Whilst queued the user will see their pending tags in the "my tags" list. If approved their new tag will also appear in the "all tags" list.
* Tag moderation can be set for all users/untrusted users/or never and is independent of the Unitag read-only setting.
* Tag sanitisation - remove whitespace and optionally convert all to lower case.
* Tag blacklist. Add inappropriate tags to a blacklist. Tagging is not permitted with blacklisted terms.
* Works independently of node terms.
* Maintains unitag queue referential integrity.
* Handles removal of tags pending moderation. Removed tags are removed from the unitag moderation queue if not suggested by anyone else.


TO USE
======

* Install and set up Unitag as desired.
* Install this module.
* With this module enabled, Unitag processing is enabled by default for every enabled vocabulary/content type pair.
* Unitag processing can be disabled via the settings page for each vocabulary/content type pair.
* Moderation etc is via the Unitag management page.
* Moderation status is provided on the community tags settings page and if required a link to the Unitag moderation queue.


LIMITATIONS
===========

If a taxonomy is set to Unitag read-only mode then terms added via the node edit form that should also be added as a community tag via node term synchronisation will not be added as node terms if approved, unless reverse node term synchronisation is enabled.


TO DO
=====

* Feedback: Via ajax, provide feedback to the tagger if their tag was not directly added. E.g. queued for moderation, tagged with synonym, tagged with synonym and related terms, blacklisted term.
* Notification: For admin, e.g. terms awaiting moderation. For users, your tag was blacklisted or not approved etc. Probably do this via the admin status callback.

File

community_tags_unitag/README.txt
View source 
  1. ; $Id$

  2. 

  3. OVERVIEW

  4. ========

  5. 

  6. Unitag helps to keep a taxonomy clean, consistent, and relevant. As well as cleaning, de-duplicating, and filtering tags automatically, it can be configured to place all new tags in a moderation queue. It is the perfect partner to community tagging, dealing with most of the issues that are encountered when allowing a large set of users to tag content.

  7. 

  8. This sub-module integrates Community tags with Unitag.

  9. 

  10. 

  11. FEATURES

  12. ========

  13. 

  14. * Synonym replacement. If a user enters a tag which is a synonym of another tag, the tag is replaced with the synonym.

  15. * Moderation of new tags. New tags may be queued for moderation. Whilst queued the user will see their pending tags in the "my tags" list. If approved their new tag will also appear in the "all tags" list.

  16. * Tag moderation can be set for all users/untrusted users/or never and is independent of the Unitag read-only setting.

  17. * Tag sanitisation - remove whitespace and optionally convert all to lower case.

  18. * Tag blacklist. Add inappropriate tags to a blacklist. Tagging is not permitted with blacklisted terms.

  19. * Works independently of node terms.

  20. * Maintains unitag queue referential integrity.

  21. * Handles removal of tags pending moderation. Removed tags are removed from the unitag moderation queue if not suggested by anyone else.

  22. 

  23. 

  24. TO USE

  25. ======

  26. 

  27. * Install and set up Unitag as desired.

  28. * Install this module.

  29. * With this module enabled, Unitag processing is enabled by default for every enabled vocabulary/content type pair.

  30. * Unitag processing can be disabled via the settings page for each vocabulary/content type pair.

  31. * Moderation etc is via the Unitag management page.

  32. * Moderation status is provided on the community tags settings page and if required a link to the Unitag moderation queue.

  33. 

  34. 

  35. LIMITATIONS

  36. ===========

  37. 

  38. If a taxonomy is set to Unitag read-only mode then terms added via the node edit form that should also be added as a community tag via node term synchronisation will not be added as node terms if approved, unless reverse node term synchronisation is enabled.

  39. 

  40. 

  41. TO DO

  42. =====

  43. 

  44. * Feedback: Via ajax, provide feedback to the tagger if their tag was not directly added. E.g. queued for moderation, tagged with synonym, tagged with synonym and related terms, blacklisted term.

  45. * Notification: For admin, e.g. terms awaiting moderation. For users, your tag was blacklisted or not approved etc. Probably do this via the admin status callback.