Skip to content

Commit 497dfd9

Browse files
committed
Merge pull request #80 from abookyun/patch-1
Update and rename README.textile to README.md
2 parents 7dcffad + 8f732ed commit 497dfd9

File tree

1 file changed

+10
-16
lines changed

1 file changed

+10
-16
lines changed

README.textile renamed to README.md

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,7 @@ IK Analysis for ElasticSearch
22
==================================
33

44
更新说明:
5-
对于使用es集群,用ik作为分词插件,经常会修改自定义词典,增加远程加载,每次更新都会重新加载词典,不必重启es服务。
6-
7-
5+
对于使用es集群,用ik作为分词插件,经常会修改自定义词典,增加远程加载,每次更新都会重新加载词典,不必重启es服务。
86

97
The IK Analysis plugin integrates Lucene IK analyzer into elasticsearch, support customized dictionary.
108

@@ -26,7 +24,6 @@ Version
2624
1.1.2 | 0.19.x
2725
1.0.0 | 0.16.2 -> 0.19.0
2826

29-
3027
Thanks
3128
-------------
3229
YourKit supports IK Analysis for ElasticSearch project with its full-featured Java Profiler.
@@ -35,7 +32,6 @@ Java and .NET applications. Take a look at YourKit's leading software products:
3532
<a href="http://www.yourkit.com/java/profiler/index.jsp">YourKit Java Profiler</a> and
3633
<a href="http://www.yourkit.com/.net/profiler/index.jsp">YourKit .NET Profiler</a>.
3734

38-
3935
Install
4036
-------------
4137
you can download this plugin from RTF project(https://github.com/medcl/elasticsearch-rtf)
@@ -53,7 +49,7 @@ https://github.com/medcl/elasticsearch-analysis-ik/blob/master/config/ik/IKAnaly
5349

5450
<pre>
5551

56-
<?xml version="1.0" encoding="UTF-8"?>
52+
<?xml version="1.0" encoding="UTF-8"?>
5753
<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
5854
<properties>
5955
<comment>IK Analyzer 扩展配置</comment>
@@ -72,7 +68,7 @@ https://github.com/medcl/elasticsearch-analysis-ik/blob/master/config/ik/IKAnaly
7268
Analysis Configuration (elasticsearch.yml)
7369
-------------
7470

75-
<Pre>
71+
<pre>
7672
index:
7773
analysis:
7874
analyzer:
@@ -222,12 +218,11 @@ here is the query result
222218

223219
</pre>
224220

225-
226221
have fun.
227222

228223
热更新IK分词使用方法
229224
----------
230-
目前该插件支持热更新IK分词,通过上文在ik配置文件中提到的如下配置
225+
目前该插件支持热更新 ik 分词,通过上文在 ik 配置文件中提到的如下配置
231226

232227
<pre>
233228
<!--用户可以在这里配置远程扩展字典 -->
@@ -236,24 +231,23 @@ have fun.
236231
<entry key="remote_ext_stopwords">location</entry>
237232
</pre>
238233

239-
其中`location`是指一个url,比如`http://yoursite.com/getCustomDict`,该请求只需满足一下两点即可完成分词热更新。
240-
241-
1. 该http请求需要返回两个头部,一个是`Last-Modified`,一个是`ETags`,这两者都是字符串类型,只要有一个发生变化,该插件就会去抓取新的分词进而更新词库。
234+
其中 `location` 是指一个 url,比如 `http://yoursite.com/getCustomDict`,该请求只需满足一下两点即可完成分词热更新。
242235

243-
2. 该http请求返回的内容格式是一行一个分词,换行符用`\n`即可。
236+
1. 该 http 请求需要返回两个头部,一个是 `Last-Modified`,一个是 `ETags`,这两者都是字符串类型,只要有一个发生变化,该插件就会去抓取新的分词进而更新词库。
244237

245-
满足上面两点要求就可以实现热更新分词了,不需要重启es实例。
238+
2. 该 http 请求返回的内容格式是一行一个分词,换行符用 `\n` 即可。
246239

240+
满足上面两点要求就可以实现热更新分词了,不需要重启 es 实例。
247241

248242
常见问题:
249243
-------------
250244
1.自定义词典为什么没有生效?
251-
请确保你的扩展词典的文本格式为UTF8编码
245+
请确保你的扩展词典的文本格式为 UTF8 编码
252246

253247
2.如何手动安装,以 1.3.0 為例?(参考:https://github.com/medcl/elasticsearch-analysis-ik/issues/46)
254248

255249
`git clone https://github.com/medcl/elasticsearch-analysis-ik`
256250
`cd elasticsearch-analysis-ik`
257251
`mvn compile`
258252
`mvn package`
259-
`plugin --install analysis-ik --url file:///#{project_path}/elasticsearch-analysis-ik/target/releases/elasticsearch-analysis-ik-1.3.0.zip`
253+
`plugin --install analysis-ik --url file:///#{project_path}/elasticsearch-analysis-ik/target/releases/elasticsearch-analysis-ik-1.3.0.zip`

0 commit comments

Comments
 (0)