Skip to content
Snippets Groups Projects
Commit 1594d00d authored by Urvashi Vora's avatar Urvashi Vora Committed by Yutaro Ohno
Browse files

Issue #3372407 by urvashi_vora: Fix the issues reported by phpcs

parent fd32a71b
No related branches found
No related tags found
No related merge requests found
......@@ -8,19 +8,25 @@ CONTENTS OF THIS FILE
INTRODUCTION
------------
The Search API Kana convert module provides a processor plugin for the Search API module. It's basically a wrapper of PHP mb_convert_kana function which allows Japanese character types(zenkaku, hankaku, hiragana, katakana) to be converted from one another.
The Search API Kana convert module provides a processor plugin for the Search
API module. It's basically a wrapper of PHP mb_convert_kana function which
allows Japanese character types(zenkaku, hankaku, hiragana, katakana) to be
converted from one another.
USE CASES
------------
- Normalize the data so the same words in different word types can be matched. (E.g convert "ABC 123" to "ABC 123" or "ひと" to "ヒト".)
- convert full-width space " " to half-width space " " so the data can be properly splitted by tokenizer.
- Normalize the data so the same words in different word types can be matched.
(E.g convert "ABC 123" to "ABC 123" or "ひと" to "ヒト".)
- convert full-width space " " to half-width space " " so the data can be
properly splitted by tokenizer.
REQUIREMENTS
------------
This module requires the following modules:
* [Search API](https://www.drupal.org/project/search_api)
You must configure the Search API module to be able to search content.
For information on how to set up the Search API module, please refer to the documentation of the Search API module.
For information on how to set up the Search API module, please refer to the
documentation of the Search API module.
INSTALLATION
------------
......@@ -29,10 +35,15 @@ https://www.drupal.org/node/1897420 for further information.
CONFIGURATION
-------------
* In the processor configuration page (/admin/config/search/search-api/index/[my_index]/processors),
* In the processor configuration page
(/admin/config/search/search-api/index/[my_index]/processors),
- Enable "Kana convert".
- If "Tokenizer" is enabled, place "Kana convert" above Tokenizer in the "Processor Order" section.
- Set the options accordingly in the "Kana convert" settings section.The default setup is usually fine. See the mb_convert_kana function documentation for more configuration options. https://www.php.net/manual/en/function.mb-convert-kana.php
- If "Tokenizer" is enabled, place "Kana convert" above Tokenizer in the
"Processor Order" section.
- Set the options accordingly in the "Kana convert" settings section. The
default setup is usually fine. See the mb_convert_kana function
documentation for more configuration options.
https://www.php.net/manual/en/function.mb-convert-kana.php
* Reindex your search index.
MAINTAINERS
......
......@@ -4,4 +4,4 @@ description: Provides Japanese kana convert processor for Search API module.
package: Search
core_version_requirement: ^9 || ^10
dependencies:
- search_api
- search_api:search_api
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment