README.txt 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  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. * integration with Search API. If you include synonyms of a term into your
  10. Search API search index, your clients will be able to find content with
  11. search keywords that contain synonyms and not actual names of terms.
  12. -- REQUIREMENTS --
  13. The Synonyms module requires the following modules:
  14. * Taxonomy module
  15. * Text module
  16. -- SYNONYMS EXTRACTORS, SUPPORTED FIELD TYPES --
  17. Module ships with ability to extract synonyms from the following field types:
  18. * Text
  19. * Taxonomy Term Reference
  20. * Entity Reference
  21. * Number
  22. * Float
  23. * Decimal
  24. If you want to implement your own synonyms extractor that would enable support
  25. for any other field type, please, refer to synonyms.api.php file for
  26. instructions on how to do it, or file an issue against Synonyms module. We will
  27. try to implement support for your field type too. If you have written your
  28. synonyms extractor, please share by opening an issue, and it will be included
  29. into this module.
  30. -- INSTALLATION --
  31. * Install as usual
  32. -- CONFIGURATION --
  33. * The module itself does not provide any configuration as of the moment.
  34. Although during creation/editing of a Taxonomy vocabulary you will be able
  35. to enable/disable for that particular vocabulary the additional functionality
  36. this module provides, you will find additional fieldset at the bottom of
  37. vocabulary edit page.
  38. -- FUTURE DEVELOPMENT --
  39. * If you are interested into converting this module from synonyms for Taxonomy
  40. terms into synonyms for any entity types, please go to this issue
  41. http://drupal.org/node/1194802 and leave a comment. Once we see some demand for
  42. this great feature and the Synonyms module gets a little more mature, we will
  43. try to make it happen.