From ba8e012be90c8f3847bb638a99a75a1b994cf8c5 Mon Sep 17 00:00:00 2001 From: Benjamin Vetter Date: Mon, 13 Jan 2014 20:04:30 +0100 Subject: [PATCH] Referring to stop analyzer for stopword docs #329 --- docs/reference/analysis/analyzers.asciidoc | 8 -------- docs/reference/analysis/analyzers/lang-analyzer.asciidoc | 3 ++- .../analysis/analyzers/pattern-analyzer.asciidoc | 3 ++- .../analysis/analyzers/snowball-analyzer.asciidoc | 5 +++-- .../analysis/analyzers/standard-analyzer.asciidoc | 3 ++- docs/reference/analysis/analyzers/stop-analyzer.asciidoc | 3 ++- 6 files changed, 11 insertions(+), 14 deletions(-) diff --git a/docs/reference/analysis/analyzers.asciidoc b/docs/reference/analysis/analyzers.asciidoc index 22881a68904..b97231b0ab3 100644 --- a/docs/reference/analysis/analyzers.asciidoc +++ b/docs/reference/analysis/analyzers.asciidoc @@ -49,14 +49,6 @@ index : stopwords : [test1, test2, test3] -------------------------------------------------- -[[analyzers-stopwords]] -=== Stopwords - -The `stopwords` parameter can be used to provide a custom set of stopwords. As -certain analyzers use a default list of stopwords while others don't, please -check out the individual analyzer sections. In case you want the analyzer to -use no stopwords at all, simply provide `stopwords: _none_` - Below is a list of the built in analyzers. include::analyzers/standard-analyzer.asciidoc[] diff --git a/docs/reference/analysis/analyzers/lang-analyzer.asciidoc b/docs/reference/analysis/analyzers/lang-analyzer.asciidoc index d3505dd1d37..f963e4b0f1b 100644 --- a/docs/reference/analysis/analyzers/lang-analyzer.asciidoc +++ b/docs/reference/analysis/analyzers/lang-analyzer.asciidoc @@ -11,7 +11,8 @@ following types are supported: `arabic`, `armenian`, `basque`, All analyzers support setting custom `stopwords` either internally in the config, or by using an external stopwords file by setting -`stopwords_path`. +`stopwords_path`. Check <> for +more details. The following analyzers support setting custom `stem_exclusion` list: `arabic`, `armenian`, `basque`, `brazilian`, `bulgarian`, `catalan`, diff --git a/docs/reference/analysis/analyzers/pattern-analyzer.asciidoc b/docs/reference/analysis/analyzers/pattern-analyzer.asciidoc index 04f71bfc773..12f8799f8f9 100644 --- a/docs/reference/analysis/analyzers/pattern-analyzer.asciidoc +++ b/docs/reference/analysis/analyzers/pattern-analyzer.asciidoc @@ -15,7 +15,8 @@ type: |`flags` |The regular expression flags. |`stopwords` |A list of stopwords to initialize the stop filter with. Defaults to an 'empty' stopword list coming[1.0.0.RC1, Previously -defaulted to the English stopwords list] +defaulted to the English stopwords list]. Check +<> for more details. |=================================================================== *IMPORTANT*: The regular expression should match the *token separators*, diff --git a/docs/reference/analysis/analyzers/snowball-analyzer.asciidoc b/docs/reference/analysis/analyzers/snowball-analyzer.asciidoc index 234f41db155..64804fcb359 100644 --- a/docs/reference/analysis/analyzers/snowball-analyzer.asciidoc +++ b/docs/reference/analysis/analyzers/snowball-analyzer.asciidoc @@ -41,8 +41,9 @@ filter>> and defaults to `English`. Note that not all the language analyzers have a default set of stopwords provided. The `stopwords` parameter can be used to provide stopwords for the -languages that has no defaults, or to simply replace the default set -with your custom list. A default set of stopwords for many of these +languages that have no defaults, or to simply replace the default set +with your custom list. Check <> +for more details. A default set of stopwords for many of these languages is available from for instance https://github.com/apache/lucene-solr/tree/trunk/lucene/analysis/common/src/resources/org/apache/lucene/analysis/[here] and diff --git a/docs/reference/analysis/analyzers/standard-analyzer.asciidoc b/docs/reference/analysis/analyzers/standard-analyzer.asciidoc index 0b6faed7712..4aae94a69bb 100644 --- a/docs/reference/analysis/analyzers/standard-analyzer.asciidoc +++ b/docs/reference/analysis/analyzers/standard-analyzer.asciidoc @@ -19,7 +19,8 @@ type: |Setting |Description |`stopwords` |A list of stopwords to initialize the stop filter with. Defaults to an 'empty' stopword list added[1.0.0.Beta1, Previously -defaulted to the English stopwords list] +defaulted to the English stopwords list]. Check +<> for more details. |`max_token_length` |The maximum token length. If a token is seen that exceeds this length then it is discarded. Defaults to `255`. |======================================================================= diff --git a/docs/reference/analysis/analyzers/stop-analyzer.asciidoc b/docs/reference/analysis/analyzers/stop-analyzer.asciidoc index 2a1bfd73113..9a19772795f 100644 --- a/docs/reference/analysis/analyzers/stop-analyzer.asciidoc +++ b/docs/reference/analysis/analyzers/stop-analyzer.asciidoc @@ -14,8 +14,9 @@ The following are settings that can be set for a `stop` analyzer type: |Setting |Description |`stopwords` |A list of stopwords to initialize the stop filter with. Defaults to the english stop words. - |`stopwords_path` |A path (either relative to `config` location, or absolute) to a stopwords file configuration. |======================================================================= +Use `stopwords: _none_` to explicitly specify an 'empty' stopword list. +