You are here

Home » API reference » Taxonomy dupecheck 6

README.txt in Taxonomy dupecheck 6

Same filename and directory in other branches
  1. 7 README.txt
// $Id$

CONTENTS OF THIS FILE
---------------------

* Introduction
* Installation
* Design Decisions

INTRODUCTION
------------

Current maintainer: Karen Ziv <me@karenziv.com>

Taxonomy dupecheck module prevents Drupal administrators from adding duplicate
taxonomy vocabularies and/or terms. It's helpful when entering large amounts
of terms or vocabularies in situations where each value must be unique. This
saves time by preventing administrators from having to enforce a unique value
policy through later cleanup of duplicate terms.

The module provides a configuration screen allowing administrators to choose
which should be unique: taxonomy terms, vocabularies or both. It defaults to
case-insensitive comparisons, with an option to change to case-sensitive. Both
stored and input terms/vocabularies are trimmed before comparison to handle
cases such as 'foo ' and 'foo'. Based on the settings, the user will see an
error message when adding a duplicate value.

INSTALLATION
------------

There are no special requirements for this module; installation uses the
standard Drupal process. If you're reading this, you've likely already
correctly installed this module.

1. Download the module from drupal.org.
2. Untar the archive into your modules directory.
3. Go to Admin > Site building > Modules and enable the Taxonomy dupecheck module.
4. Configure settings at Admin > Site configuration > Taxonomy dupecheck.

DESIGN DECISIONS
----------------

This module works by hooking into the taxonomy term and vocabulary admin
forms. Ideally, this would have happened instead in hook_taxonomy, but
this hook doesn't allow you to stop the save process, only run other tasks
based on the term/vocabulary info. This means that if you call
taxonomy_save_term or taxonomy_save_vocabulary programmatically, this
validation won't happen.

Note that the default comparison is case-insensitive. That is,
'foo' and 'Foo' will be considered duplicates. Case sensitivity can be
configured in the admin configuration (see INSTALLATION).

Also, all strings--stored and input--are trimmed before comparison. This is
not an option because no valid use case for values with preceding or trailing
spaces in term/vocabulary was found at the time of the design to add this
functionality. If this becomes problematic, please make a feature request
and it can be added as an option.

File

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

  2. 

  3. CONTENTS OF THIS FILE

  4. ---------------------

  5. 

  6. * Introduction

  7. * Installation

  8. * Design Decisions

  9. 

  10. INTRODUCTION

  11. ------------

  12. 

  13. Current maintainer: Karen Ziv 

  14. 

  15. Taxonomy dupecheck module prevents Drupal administrators from adding duplicate

  16. taxonomy vocabularies and/or terms. It's helpful when entering large amounts

  17. of terms or vocabularies in situations where each value must be unique. This

  18. saves time by preventing administrators from having to enforce a unique value

  19. policy through later cleanup of duplicate terms.

  20. 

  21. The module provides a configuration screen allowing administrators to choose

  22. which should be unique: taxonomy terms, vocabularies or both. It defaults to

  23. case-insensitive comparisons, with an option to change to case-sensitive. Both

  24. stored and input terms/vocabularies are trimmed before comparison to handle

  25. cases such as 'foo ' and 'foo'. Based on the settings, the user will see an

  26. error message when adding a duplicate value.

  27. 

  28. INSTALLATION

  29. ------------

  30. 

  31. There are no special requirements for this module; installation uses the

  32. standard Drupal process. If you're reading this, you've likely already

  33. correctly installed this module.

  34. 

  35. 1. Download the module from drupal.org.

  36. 2. Untar the archive into your modules directory.

  37. 3. Go to Admin > Site building > Modules and enable the Taxonomy dupecheck module.

  38. 4. Configure settings at Admin > Site configuration > Taxonomy dupecheck.

  39. 

  40. DESIGN DECISIONS

  41. ----------------

  42. 

  43. This module works by hooking into the taxonomy term and vocabulary admin

  44. forms. Ideally, this would have happened instead in hook_taxonomy, but

  45. this hook doesn't allow you to stop the save process, only run other tasks

  46. based on the term/vocabulary info. This means that if you call

  47. taxonomy_save_term or taxonomy_save_vocabulary programmatically, this

  48. validation won't happen.

  49. 

  50. Note that the default comparison is case-insensitive. That is,

  51. 'foo' and 'Foo' will be considered duplicates. Case sensitivity can be

  52. configured in the admin configuration (see INSTALLATION).

  53. 

  54. Also, all strings--stored and input--are trimmed before comparison. This is

  55. not an option because no valid use case for values with preceding or trailing

  56. spaces in term/vocabulary was found at the time of the design to add this

  57. functionality. If this becomes problematic, please make a feature request

  58. and it can be added as an option.