You are here

Home » API reference » Synonyms 8

README.txt in Synonyms 8

Same filename and directory in other branches
  1. 7 README.txt
-- SUMMARY --

The Synonyms module enriches content Entities with the notion of synonyms.
Currently the module provides the following functionality:
* support of synonyms through Fields both base and attached ones. Any field,
  for which synonyms provider exists, can be enabled as source of synonyms.
* synonyms-friendly autocomplete and select widgets for entity reference field
  type.
* integration with Views: Synonyms module provides a few filters and contextual
  filters that allow filtering not only by entity name but also by one of its
  synonyms.
* 2 form elements are provided for developers: synonyms-friendly entity
  autocomplete and select.

-- REQUIREMENTS --

The Synonyms module requires only Drupal core.

-- SUPPORTED SYNONYMS PROVIDERS --

Module ships with ability to provide synonyms from the following field types:
* "Text" field type
* "Entity Reference" field type
* "Number" field type
* "Float" field type
* "Decimal" field type
* "Email" field type
* "Telephone" field type

Worth mentioning here: this list is easily extended further by implementing new
synonyms providers in your code. Refer to Synonyms documentation for more
details on how to accomplish it.

-- GRANULATION WITHIN SYNONYMS BEHAVIOR --

In order to achieve greater flexibility, this module introduced additional
granularity into what "synonyms" mean. This granularity is expressed via
"synonyms behavior" idea whatsoever. Therefore each synonyms behavior may have
its own synonyms provider than you can enable and configure through admin UI of
the Synonyms module. For example, field "Typos" can be part of autocomplete
behavior, while field "Other spellings" can be part of select behavior.
Currently the following synonym behaviors are recognized (other modules actually
can extend this list):
* Autocomplete - whether synonyms from this provider should participate in
  autocomplete suggestions. This module ships with synonyms friendly
  autocomplete widget and the autocomplete suggestions will be filled in with
  the synonyms from enabled providers for "autocomplete" behavior
* Select - whether synonyms from this provider should be included in the
  synonyms friendly select widget.

That way on the Synonyms configuration page you will get to add/remove certain
synonym providers for certain synonym behaviors. Also, each behavior and
provider may have its own settings that you get to configure too.

-- INSTALLATION --

* Install as usual

-- CONFIGURATION --

* You can configure synonyms of all eligible entity types by going to Admin ->
  Structure -> Synonyms (/admin/structure/synonyms)

File

README.txt
View source 
  1. 

  2. -- SUMMARY --

  3. 

  4. The Synonyms module enriches content Entities with the notion of synonyms.

  5. Currently the module provides the following functionality:

  6. * support of synonyms through Fields both base and attached ones. Any field,

  7.   for which synonyms provider exists, can be enabled as source of synonyms.

  8. * synonyms-friendly autocomplete and select widgets for entity reference field

  9.   type.

  10. * integration with Views: Synonyms module provides a few filters and contextual

  11.   filters that allow filtering not only by entity name but also by one of its

  12.   synonyms.

  13. * 2 form elements are provided for developers: synonyms-friendly entity

  14.   autocomplete and select.

  15. 

  16. -- REQUIREMENTS --

  17. 

  18. The Synonyms module requires only Drupal core.

  19. 

  20. -- SUPPORTED SYNONYMS PROVIDERS --

  21. 

  22. Module ships with ability to provide synonyms from the following field types:

  23. * "Text" field type

  24. * "Entity Reference" field type

  25. * "Number" field type

  26. * "Float" field type

  27. * "Decimal" field type

  28. * "Email" field type

  29. * "Telephone" field type

  30. 

  31. Worth mentioning here: this list is easily extended further by implementing new

  32. synonyms providers in your code. Refer to Synonyms documentation for more

  33. details on how to accomplish it.

  34. 

  35. -- GRANULATION WITHIN SYNONYMS BEHAVIOR --

  36. 

  37. In order to achieve greater flexibility, this module introduced additional

  38. granularity into what "synonyms" mean. This granularity is expressed via

  39. "synonyms behavior" idea whatsoever. Therefore each synonyms behavior may have

  40. its own synonyms provider than you can enable and configure through admin UI of

  41. the Synonyms module. For example, field "Typos" can be part of autocomplete

  42. behavior, while field "Other spellings" can be part of select behavior.

  43. Currently the following synonym behaviors are recognized (other modules actually

  44. can extend this list):

  45. * Autocomplete - whether synonyms from this provider should participate in

  46.   autocomplete suggestions. This module ships with synonyms friendly

  47.   autocomplete widget and the autocomplete suggestions will be filled in with

  48.   the synonyms from enabled providers for "autocomplete" behavior

  49. * Select - whether synonyms from this provider should be included in the

  50.   synonyms friendly select widget.

  51. 

  52. That way on the Synonyms configuration page you will get to add/remove certain

  53. synonym providers for certain synonym behaviors. Also, each behavior and

  54. provider may have its own settings that you get to configure too.

  55. 

  56. -- INSTALLATION --

  57. 

  58. * Install as usual

  59. 

  60. -- CONFIGURATION --

  61. 

  62. * You can configure synonyms of all eligible entity types by going to Admin ->

  63.   Structure -> Synonyms (/admin/structure/synonyms)