README.txt 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. -- SUMMARY --
  2. The Synonyms module enriches content Entities with the notion of synonyms.
  3. Currently the module provides the following functionality:
  4. * support of synonyms through Fields both base and attached ones. Any field,
  5. for which synonyms provider exists, can be enabled as source of synonyms.
  6. * synonyms-friendly autocomplete and select widgets for entity reference field
  7. type.
  8. * integration with Views: Synonyms module provides a few filters and contextual
  9. filters that allow filtering not only by entity name but also by one of its
  10. synonyms.
  11. * 2 form elements are provided for developers: synonyms-friendly entity
  12. autocomplete and select.
  13. -- REQUIREMENTS --
  14. The Synonyms module requires only Drupal core.
  15. -- SUPPORTED SYNONYMS PROVIDERS --
  16. Module ships with ability to provide synonyms from the following field types:
  17. * "Text" field type
  18. * "Entity Reference" field type
  19. * "Number" field type
  20. * "Float" field type
  21. * "Decimal" field type
  22. * "Email" field type
  23. * "Telephone" field type
  24. Worth mentioning here: this list is easily extended further by implementing new
  25. synonyms providers in your code. Refer to Synonyms documentation for more
  26. details on how to accomplish it.
  27. -- GRANULATION WITHIN SYNONYMS BEHAVIOR --
  28. In order to achieve greater flexibility, this module introduced additional
  29. granularity into what "synonyms" mean. This granularity is expressed via
  30. "synonyms behavior" idea whatsoever. Therefore each synonyms behavior may have
  31. its own synonyms provider than you can enable and configure through admin UI of
  32. the Synonyms module. For example, field "Typos" can be part of autocomplete
  33. behavior, while field "Other spellings" can be part of select behavior.
  34. Currently the following synonym behaviors are recognized (other modules actually
  35. can extend this list):
  36. * Autocomplete - whether synonyms from this provider should participate in
  37. autocomplete suggestions. This module ships with synonyms friendly
  38. autocomplete widget and the autocomplete suggestions will be filled in with
  39. the synonyms from enabled providers for "autocomplete" behavior
  40. * Select - whether synonyms from this provider should be included in the
  41. synonyms friendly select widget.
  42. That way on the Synonyms configuration page you will get to add/remove certain
  43. synonym providers for certain synonym behaviors. Also, each behavior and
  44. provider may have its own settings that you get to configure too.
  45. -- INSTALLATION --
  46. * Install as usual
  47. -- CONFIGURATION --
  48. * You can configure synonyms of all eligible entity types by going to Admin ->
  49. Structure -> Synonyms (/admin/structure/synonyms)