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

README.txt 2.1 KB
History Raw

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556 
  1. 

  2. -- SUMMARY --
    3. 

  3. 

  4. The Synonyms module extends the Drupal core Taxonomy features. Currently
    5. 

  5. the module provides this additional functionality:
    6. 

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

  7.    is created, attached to a term can be enabled as source of synonyms.
    8. 

  8. * synonym-friendly autocomplete widget for taxonomy_term_reference fields
    9. 

  9. * integration with Drupal search functionality enabling searching content by
    10. 

  10.    synonyms of the terms that the content references
    11. 

  11. * integration with Search API. If you include synonyms of a term into your
    12. 

  12.    Search API search index, your clients will be able to find content with
    13. 

  13.    search keywords that contain synonyms and not actual names of terms.
    14. 

  14. 

  15. -- REQUIREMENTS --
    16. 

  16. 

  17. The Synonyms module requires the following modules:
    18. 

  18. * Taxonomy module
    19. 

  19. * Text module
    20. 

  20. 

  21. -- SYNONYMS EXTRACTORS, SUPPORTED FIELD TYPES --
    22. 

  22. 

  23. Module ships with ability to extract synonyms from the following field types:
    24. 

  24. * Text
    25. 

  25. * Taxonomy Term Reference
    26. 

  26. * Entity Reference
    27. 

  27. * Number
    28. 

  28. * Float
    29. 

  29. * Decimal
    30. 

  30. 

  31. If you want to implement your own synonyms extractor that would enable support
    32. 

  32. for any other field type, please, refer to synonyms.api.php file for
    33. 

  33. instructions on how to do it, or file an issue against Synonyms module. We will
    34. 

  34. try to implement support for your field type too. If you have written your
    35. 

  35. synonyms extractor, please share by opening an issue, and it will be included
    36. 

  36. into this module.
    37. 

  37. 

  38. -- INSTALLATION --
    39. 

  39. 

  40. * Install as usual
    41. 

  41. 

  42. -- CONFIGURATION --
    43. 

  43. 

  44. * The module itself does not provide any configuration as of the moment.
    45. 

  45. Although during creation/editing of a Taxonomy vocabulary you will be able
    46. 

  46. to enable/disable for that particular vocabulary the additional functionality
    47. 

  47. this module provides, you will find additional fieldset at the bottom of
    48. 

  48. vocabulary edit page.
    49. 

  49. 

  50. -- FUTURE DEVELOPMENT --
    51. 

  51. 

  52. * If you are interested into converting this module from synonyms for Taxonomy
    53. 

  53. terms into synonyms for any entity types, please go to this issue
    54. 

  54. http://drupal.org/node/1194802 and leave a comment. Once we see some demand for
    55. 

  55. this great feature and the Synonyms module gets a little more mature, we will
    56. 

  56. try to make it happen.
    57.