Browse Source

Docs: Adding Ukrainian analyzer

Christoph Büscher 9 years ago
parent
commit
1f5adaa824

+ 42 - 0
docs/plugins/analysis-ukrainian.asciidoc

@@ -0,0 +1,42 @@
+[[analysis-ukrainian]]
+=== Ukrainian Analysis Plugin
+
+The Ukrainian Analysis plugin integrates Lucene's UkrainianMorfologikAnalyzer into elasticsearch.
+
+It provides stemming for Ukrainian using the http://github.com/morfologik/morfologik-stemming[Morfologik project]. 
+
+[[analysis-ukrainian-install]]
+[float]
+==== Installation
+
+This plugin can be installed using the plugin manager:
+
+[source,sh]
+----------------------------------------------------------------
+sudo bin/elasticsearch-plugin install analysis-ukrainian
+----------------------------------------------------------------
+
+The plugin must be installed on every node in the cluster, and each node must
+be restarted after installation.
+
+This plugin can be downloaded for <<plugin-management-custom-url,offline install>> from
+{plugin_url}/analysis-ukrainian/analysis-ukrainian-{version}.zip.
+
+[[analysis-ukrainian-remove]]
+[float]
+==== Removal
+
+The plugin can be removed with the following command:
+
+[source,sh]
+----------------------------------------------------------------
+sudo bin/elasticsearch-plugin remove analysis-ukrainian
+----------------------------------------------------------------
+
+The node must be stopped before removing the plugin.
+
+[[analysis-ukrainian-analyzer]]
+[float]
+==== `ukrainian` analyzer
+
+The plugin provides the `ukrainian` analyzer.

+ 5 - 0
docs/plugins/analysis.asciidoc

@@ -36,6 +36,10 @@ segmented into words.
 
 Provides high quality stemming for Polish.
 
+<<analysis-ukrainian,Ukrainian>>::
+
+Provides stemming for Ukrainian.
+
 [float]
 ==== Community contributed analysis plugins
 
@@ -62,5 +66,6 @@ include::analysis-smartcn.asciidoc[]
 
 include::analysis-stempel.asciidoc[]
 
+include::analysis-ukrainian.asciidoc[]
 
 

+ 1 - 0
docs/reference/cat/plugins.asciidoc

@@ -19,6 +19,7 @@ U7321H6 analysis-kuromoji       {version} The Japanese (kuromoji) Analysis plugi
 U7321H6 analysis-phonetic       {version} The Phonetic Analysis plugin integrates phonetic token filter analysis with elasticsearch.
 U7321H6 analysis-smartcn        {version} Smart Chinese Analysis plugin integrates Lucene Smart Chinese analysis module into elasticsearch.
 U7321H6 analysis-stempel        {version} The Stempel (Polish) Analysis plugin integrates Lucene stempel (polish) analysis module into elasticsearch.
+U7321H6 analysis-ukrainian        {version} The Ukrainian Analysis plugin integrates the Lucene UkrainianMorfologikAnalyzer into elasticsearch.
 U7321H6 discovery-azure-classic {version} The Azure Classic Discovery plugin allows to use Azure Classic API for the unicast discovery mechanism
 U7321H6 discovery-ec2           {version} The EC2 discovery plugin allows to use AWS API for the unicast discovery mechanism.
 U7321H6 discovery-file          {version} Discovery file plugin enables unicast discovery from hosts stored in a file.

+ 0 - 1
plugins/analysis-ukrainian/licenses/lucene-analyzers-morfologik-6.2.0.jar.sha1

@@ -1 +0,0 @@
-9005084a9bc71a7ce11618722f9509f6c669cce2

+ 1 - 0
plugins/analysis-ukrainian/licenses/lucene-analyzers-morfologik-6.3.0-snapshot-ed102d6.jar.sha1

@@ -0,0 +1 @@
+a08e5ddd375ea17a878ba077cc33ce59e68758c2