Home Explore Help
Sign In
bachir
/
materio-base-d7
1
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: fedd8f4216
Branches Tags
materio-base...
/
sites
/
all
/
modules
/
contrib
/
taxonomy
/
synonyms
/
README.txt

README.txt 4.0 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596 
  1. 

  2. -- SUMMARY --
    3. 

  3. 

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

  5. module provides the following functionality:
    6. 

  6. * support of synonyms through Field API. Any field, for which synonyms behavior
    7. 

  7.   implementation exists, can be enabled as source of synonyms.
    8. 

  8. * support of synonyms through Entity properties. Entity properties stored in
    9. 

  9.   database (as opposed to being calculated on-the-fly) can be enabled as source
    10. 

  10.   of synonyms.
    11. 

  11. * synonyms-friendly autocomplete and select widgets for taxonomy_term_reference,
    12. 

  12.   entityreference, and commerce_product_reference (through Synonyms Commerce
    13. 

  13.   submodule) fields.
    14. 

  14. * integration with Drupal search functionality through Synonyms Search
    15. 

  15.   submodule. It enables searching content by synonyms of the terms that the
    16. 

  16.   content references. Synonyms Search submodule also integrates with Term Search
    17. 

  17.   contributed module in a fashion that allows your terms to be found by their
    18. 

  18.   synonyms.
    19. 

  19. * integration with Search API. If you include entity synonyms into your Search
    20. 

  20.   API search index, your clients will be able to find content with search
    21. 

  21.   keywords that contain synonyms and not actual names of entities.
    22. 

  22. * integration with Views. Synonyms module provides a few filters and contextual
    23. 

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

  24.   synonyms. Synonyms module also provides a Views field for all eligible
    25. 

  25.   entities that contains a list of synonyms associated with the entity in
    26. 

  26.   question.
    27. 

  27. 

  28. -- REQUIREMENTS --
    29. 

  29. 

  30. The Synonyms module requires the following modules:
    31. 

  31. * Entity API module
    32. 

  32. 

  33. The Synonyms module integrates with (but does not require) the following
    34. 

  34. modules:
    35. 

  35. * Taxonomy
    36. 

  36. * Search
    37. 

  37. * Term Search
    38. 

  38. * Entity Reference
    39. 

  39. * Views
    40. 

  40. * Commerce
    41. 

  41. * Features
    42. 

  42. * Term Merge
    43. 

  43. 

  44. -- SUPPORTED SYNONYMS PROVIDERS --
    45. 

  45. 

  46. Module ships with ability to provide synonyms from the following locations:
    47. 

  47. * "Text" field type
    48. 

  48. * "Taxonomy Term Reference" field type
    49. 

  49. * "Entity Reference" field type
    50. 

  50. * "Commerce Product Reference" field type
    51. 

  51. * "Number" field type
    52. 

  52. * "Float" field type
    53. 

  53. * "Decimal" field type
    54. 

  54. * Entity properties stored in database
    55. 

  55. 

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

  57. synonyms providers in your code. Refer to Synonyms advanced help for more
    58. 

  58. details on how to accomplish it.
    59. 

  59. 

  60. -- GRANULATION WITHIN SYNONYMS BEHAVIOR --
    61. 

  61. 

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

  63. granularity into what "synonyms" mean. This granularity is expressed via
    64. 

  64. "synonyms behavior" idea whatsoever. Then you can enable different synonyms
    65. 

  65. behaviors for different synonyms providers. For example, field "Typos" can be
    66. 

  66. part of autocomplete behavior, while field "Other spellings" can be part of
    67. 

  67. search integration behavior. Currently the following synonym behaviors are
    68. 

  68. recognized (other modules actually can extend this list):
    69. 

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

  70.   autocomplete suggestions. This module ships with autocomplete synonyms
    71. 

  71.   friendly widgets and their autocomplete suggestions will be filled in with the
    72. 

  72.   synonyms of providers that have this behavior enabled.
    73. 

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

  74.   synonyms friendly select widgets.
    75. 

  75. * Search integration (requires Synonyms Search enabled) - allows your content to
    76. 

  76.   be found by synonyms of the terms it references. Your nodes will be found by
    77. 

  77.   all synonyms that have this behavior enabled.
    78. 

  78. 

  79. Therefore, on the Synonyms configuration page you will see a table, where rows
    80. 

  80. are synonym providers and columns are these "synonym behaviors" and you decide
    81. 

  81. what synonym behaviors to activate on what synonym providers.
    82. 

  82. 

  83. -- INSTALLATION --
    84. 

  84. 

  85. * Install as usual
    86. 

  86. 

  87. -- CONFIGURATION --
    88. 

  88. 

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

  90.   Structure -> Synonyms (admin/structure/synonyms)
    91. 

  91. 

  92. -- FUTURE DEVELOPMENT --
    93. 

  93. 

  94. * No good directions for future development are known at the moment. If you
    95. 

  95.   would like to suggest one, report an issue (future request) against Synonyms
    96. 

  96.   issue queue on Drupal.org.
    97.