Search API Synonym

Categories

Search

Component ID

2852476

Component name

Search API Synonym

Component type

module

Maintenance status

Actively maintained

Development status

Under active development

Component security advisory coverage

covered

Downloads

1093

Component created

Component changed

Component body

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 synonyms using the Drupal Console command:

drupal searchapi:synonym:export

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

Drush

Export synonyms using the Drush command:

drush search-api-synonym-export

drush sapi-syn-ex

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

Cron

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

IMPORT SYNONYMS

Synonyms can be imported as Synonym entities in Drupal using the import function in the synonym administration in Drupal.

At the moment is simple CSV, JSON and Solr (synonyms.txt) formats available. Example files can be downloaded from the import form. Choose a format and then download the example file.

Import files are expected to be in UTF-8!

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:

  • Drupalsearch_api_synonymAnnotationSearchApiSynonymExport
  • Drupalsearch_api_synonymPluginsearch_api_synonymexportSolr

Import plugin - see the annotation and the CSV plugin:

  • Drupalsearch_api_synonymAnnotationSearchApiSynonymImport
  • Drupalsearch_api_synonymPluginsearch_api_synonymimportCSV

SPONSORS

MAINTAINERS

Current maintainers:

Component url

https://www.drupal.org/project/search_api_synonym