Home Explore Help
Sign In
bachir
/
edlp_d8
1
0
Fork 0
Files Issues 8 Pull Requests 0 Wiki
Tree: f883747af3
Branches Tags
edlp_d8
/
sites
/
all
/
modules
/
contrib
/
taxonomy
/
synonyms
/
README.txt

README.txt 2.5 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263 
  1. 

  2. -- SUMMARY --
    3. 

  3. 

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

  5. Currently the module provides the following functionality:
    6. 

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

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

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

  9.   type.
    10. 

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

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

  12.   synonyms.
    13. 

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

  14.   autocomplete and select.
    15. 

  15. 

  16. -- REQUIREMENTS --
    17. 

  17. 

  18. The Synonyms module requires only Drupal core.
    19. 

  19. 

  20. -- SUPPORTED SYNONYMS PROVIDERS --
    21. 

  21. 

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

  23. * "Text" field type
    24. 

  24. * "Entity Reference" field type
    25. 

  25. * "Number" field type
    26. 

  26. * "Float" field type
    27. 

  27. * "Decimal" field type
    28. 

  28. * "Email" field type
    29. 

  29. * "Telephone" field type
    30. 

  30. 

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

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

  33. details on how to accomplish it.
    34. 

  34. 

  35. -- GRANULATION WITHIN SYNONYMS BEHAVIOR --
    36. 

  36. 

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

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

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

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

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

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

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

  44. can extend this list):
    45. 

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

  46.   autocomplete suggestions. This module ships with synonyms friendly
    47. 

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

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

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

  50.   synonyms friendly select widget.
    51. 

  51. 

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

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

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

  55. 

  56. -- INSTALLATION --
    57. 

  57. 

  58. * Install as usual
    59. 

  59. 

  60. -- CONFIGURATION --
    61. 

  61. 

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

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