You are here

Home » API reference » Search API Synonym 8

README.txt in Search API Synonym 8 

CONTENTS OF THIS FILE
---------------------
 * Introduction
 * Requirements
 * Installation
 * Manage synonyms
 * Export synonyms
 * Developers
 * Troubleshooting
 * Sponsors
 * Maintainers

INTRODUCTION
------------
This module let editors or administrators manage synonyms for Search API
directly in Drupal.

Synonyms can be export using the build in Drupal Console command.
Drush command and automatic export using Drupal cron job is in development.

The module support the synonyms.txt format used in Apache Solr.
Other formats can be added using the Export plugin annotation.

REQUIREMENTS
------------
* No requirements.

INSTALLATION
------------
 * Install as you would normally install a contributed drupal module. See:
  https://www.drupal.org/documentation/install/modules-themes/modules-8
  for further information.

MANAGE SYNONYMS
---------------
After installation can you start managing your synonyms and spelling errors
at admin/config/search/search-api-synonyms.

EXPORT SYNONYMS
---------------

Drupal Console
--------------

Export the added synonyms using the Drupal Console command:

- drupal searchapi:synonym:export

Execute the command with --help to see the different options.

Drush 8 and previous versions
-----------------------------

Export synonyms using the Drush command:

- drush search-api-synonym-export

- drush sapi-syn-ex

Drush 9
-------

Export synonyms using the Drush command:

- drush search-api-synonym:export

- drush sapi-syn:export

- drush sapi-syn-ex

Examples
--------
Replace [COMMAND] with one of the above Drupal Console / Drush commands.

Export all Danish synonyms and spelling errors in the Solr format.

- [COMMAND] --plugin=solr --langcode=da

Export all Danish spelling errors in the Solr format.

- [COMMAND] --plugin=solr --langcode=da --type=spelling_error

Export all Danish synonyms without white spaces in the Solr format.

- [COMMAND] --plugin=solr --langcode=da --type=synonym --filter=nospace

Cron
----

Export using Drupal cron is supported. See the settings in /admin/config/search/search-api-synonyms/settings.

DEVELOPERS
----------

The Search API Synonym module provides the following ways for developers to
extend the functionality:

- Plugins
  Export plugin - see the annotation and the Solr plugin:
  - Drupal\search_api_synonym\Annotation\SearchApiSynonymExport
  - Drupal\search_api_synonym\Plugin\search_api_synonym\export\Solr

TROUBLESHOOTING
---------------
-

SPONSORS
--------
 * FFW - https://ffwagency.com

MAINTAINERS
-----------
Current maintainers:
 * Jens Beltofte (beltofte) - https://drupal.org/u/beltofte

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. ---------------------

  3.  * Introduction

  4.  * Requirements

  5.  * Installation

  6.  * Manage synonyms

  7.  * Export synonyms

  8.  * Developers

  9.  * Troubleshooting

  10.  * Sponsors

  11.  * Maintainers

  12. 

  13. INTRODUCTION

  14. ------------

  15. This module let editors or administrators manage synonyms for Search API

  16. directly in Drupal.

  17. 

  18. Synonyms can be export using the build in Drupal Console command.

  19. Drush command and automatic export using Drupal cron job is in development.

  20. 

  21. The module support the synonyms.txt format used in Apache Solr.

  22. Other formats can be added using the Export plugin annotation.

  23. 

  24. REQUIREMENTS

  25. ------------

  26. * No requirements.

  27. 

  28. INSTALLATION

  29. ------------

  30.  * Install as you would normally install a contributed drupal module. See:

  31.   https://www.drupal.org/documentation/install/modules-themes/modules-8

  32.   for further information.

  33. 

  34. MANAGE SYNONYMS

  35. ---------------

  36. After installation can you start managing your synonyms and spelling errors

  37. at admin/config/search/search-api-synonyms.

  38. 

  39. EXPORT SYNONYMS

  40. ---------------

  41. 

  42. Drupal Console

  43. --------------

  44. 

  45. Export the added synonyms using the Drupal Console command:

  46. 

  47. - drupal searchapi:synonym:export

  48. 

  49. Execute the command with --help to see the different options.

  50. 

  51. Drush 8 and previous versions

  52. -----------------------------

  53. 

  54. Export synonyms using the Drush command:

  55. 

  56. - drush search-api-synonym-export

  57. 

  58. - drush sapi-syn-ex

  59. 

  60. Drush 9

  61. -------

  62. 

  63. Export synonyms using the Drush command:

  64. 

  65. - drush search-api-synonym:export

  66. 

  67. - drush sapi-syn:export

  68. 

  69. - drush sapi-syn-ex

  70. 

  71. Examples

  72. --------

  73. Replace [COMMAND] with one of the above Drupal Console / Drush commands.

  74. 

  75. Export all Danish synonyms and spelling errors in the Solr format.

  76. 

  77. - [COMMAND] --plugin=solr --langcode=da

  78. 

  79. Export all Danish spelling errors in the Solr format.

  80. 

  81. - [COMMAND] --plugin=solr --langcode=da --type=spelling_error

  82. 

  83. Export all Danish synonyms without white spaces in the Solr format.

  84. 

  85. - [COMMAND] --plugin=solr --langcode=da --type=synonym --filter=nospace

  86. 

  87. Cron

  88. ----

  89. 

  90. Export using Drupal cron is supported. See the settings in /admin/config/search/search-api-synonyms/settings.

  91. 

  92. DEVELOPERS

  93. ----------

  94. 

  95. The Search API Synonym module provides the following ways for developers to

  96. extend the functionality:

  97. 

  98. - Plugins

  99.   Export plugin - see the annotation and the Solr plugin:

  100.   - Drupal\search_api_synonym\Annotation\SearchApiSynonymExport

  101.   - Drupal\search_api_synonym\Plugin\search_api_synonym\export\Solr

  102. 

  103. TROUBLESHOOTING

  104. ---------------

  105. -

  106. 

  107. SPONSORS

  108. --------

  109.  * FFW - https://ffwagency.com

  110. 

  111. MAINTAINERS

  112. -----------

  113. Current maintainers:

  114.  * Jens Beltofte (beltofte) - https://drupal.org/u/beltofte