README.txt 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. -- SUMMARY --
  2. The Synonyms module extends the Drupal core Taxonomy features. Currently
  3. the module provides this additional functionality:
  4. * support of synonyms through Field API. Any field, for which synonyms extractor
  5. is created, attached to a term can be enabled as source of synonyms.
  6. * synonym-friendly autocomplete widget for taxonomy_term_reference fields
  7. * integration with Drupal search functionality enabling searching content by
  8. synonyms of the terms that the content references
  9. -- REQUIREMENTS --
  10. The Synonyms module requires the following modules:
  11. * Taxonomy module
  12. * Text module
  13. -- SYNONYMS EXTRACTORS, SUPPORTED FIELD TYPES --
  14. Module ships with ability to extract synonyms from the following field types:
  15. * Text
  16. * Taxonomy Term Reference
  17. * Entity Reference
  18. * Number
  19. * Float
  20. * Decimal
  21. If you want to implement your own synonyms extractor that would enable support
  22. for any other field type, please, refer to synonyms.api.php file for
  23. instructions on how to do it, or file an issue against Synonyms module. We will
  24. try to implement support for your field type too. If you have written your
  25. synonyms extractor, please share by opening an issue, and it will be included
  26. into this module.
  27. -- INSTALLATION --
  28. * Install as usual
  29. -- CONFIGURATION --
  30. * The module itself does not provide any configuration as of the moment.
  31. Although during creation/editing of a Taxonomy vocabulary you will be able
  32. to enable/disable for that particular vocabulary the additional functionality
  33. this module provides, you will find additional fieldset at the bottom of
  34. vocabulary edit page.
  35. -- FUTURE DEVELOPMENT --
  36. * If you are interested into converting this module from synonyms for Taxonomy
  37. terms into synonyms for any entity types, please go to this issue
  38. http://drupal.org/node/1194802 and leave a comment. Once we see some demand for
  39. this great feature and the Synonyms module gets a little more mature, we will
  40. try to make it happen.