- | [](xref:Lucene.Net.Analysis.TokenAttributes.KeywordAttribute) |
+ |
Keyword-aware TokenStreams/-Filters skip modification of tokens that
return true from this attribute's isKeyword() method.
@@ -343,48 +348,48 @@ The code fragment of the [analysis workflow
protocol](#analysis-workflow) above shows a token stream being obtained, used, and then
left for garbage. However, that does not mean that the components of
that token stream will, in fact, be discarded. The default is just the
-opposite. [](xref:Lucene.Net.Analysis.Analyzer) applies a reuse
+opposite. applies a reuse
strategy to the tokenizer and the token filters. It will reuse
-them. For each new input, it calls [](xref:Lucene.Net.Analysis.Tokenizer.SetReader(java.Io.Reader))
+them. For each new input, it calls [#setReader(java.io.Reader)](xref:Lucene.Net.Analysis.Tokenizer)
to set the input. Your components must be prepared for this scenario,
as described below.
#### Tokenizer
-* You should create your tokenizer class by extending [](xref:Lucene.Net.Analysis.Tokenizer).
+* You should create your tokenizer class by extending .
* Your tokenizer must **never** make direct use of the
{@link java.io.Reader} supplied to its constructor(s). (A future
release of Apache Lucene may remove the reader parameters from the
Tokenizer constructors.)
- [](xref:Lucene.Net.Analysis.Tokenizer) wraps the reader in an
+ wraps the reader in an
object that helps enforce that applications comply with the [analysis workflow](#analysis-workflow). Thus, your class
should only reference the input via the protected 'input' field
of Tokenizer.
-* Your tokenizer **must** override [](xref:Lucene.Net.Analysis.TokenStream.End()).
+* Your tokenizer **must** override [#end()](xref:Lucene.Net.Analysis.TokenStream).
Your implementation **must** call
`super.end()`. It must set a correct final offset into
the offset attribute, and finish up and other attributes to reflect
the end of the stream.
-* If your tokenizer overrides [](xref:Lucene.Net.Analysis.TokenStream.Reset())
- or [](xref:Lucene.Net.Analysis.TokenStream.Close()), it
+* If your tokenizer overrides [#reset()](xref:Lucene.Net.Analysis.TokenStream)
+ or [#close()](xref:Lucene.Net.Analysis.TokenStream), it
**must** call the corresponding superclass method.
#### Token Filter
- You should create your token filter class by extending [](xref:Lucene.Net.Analysis.TokenFilter).
- If your token filter overrides [](xref:Lucene.Net.Analysis.TokenStream.Reset()),
- [](xref:Lucene.Net.Analysis.TokenStream.End())
- or [](xref:Lucene.Net.Analysis.TokenStream.Close()), it
+ You should create your token filter class by extending .
+ If your token filter overrides [#reset()](xref:Lucene.Net.Analysis.TokenStream),
+ [#end()](xref:Lucene.Net.Analysis.TokenStream)
+ or [#close()](xref:Lucene.Net.Analysis.TokenStream), it
**must** call the corresponding superclass method.
#### Creating delegates
- Forwarding classes (those which extend [](xref:Lucene.Net.Analysis.Tokenizer) but delegate
+ Forwarding classes (those which extend but delegate
selected logic to another tokenizer) must also set the reader to the delegate in the overridden
- [](xref:Lucene.Net.Analysis.Tokenizer.Reset()) method, e.g.:
+ [#reset()](xref:Lucene.Net.Analysis.Tokenizer) method, e.g.:
public class ForwardingTokenizer extends Tokenizer {
private Tokenizer delegate;
@@ -609,9 +614,9 @@ Now we're going to implement our own custom Attribute for part-of-speech tagging
Now we also need to write the implementing class. The name of that class is important here: By default, Lucene checks if there is a class with the name of the Attribute with the suffix 'Impl'. In this example, we would consequently call the implementing class `PartOfSpeechAttributeImpl`.
- This should be the usual behavior. However, there is also an expert-API that allows changing these naming conventions: [](xref:Lucene.Net.Util.AttributeSource.AttributeFactory). The factory accepts an Attribute interface as argument and returns an actual instance. You can implement your own factory if you need to change the default behavior.
+ This should be the usual behavior. However, there is also an expert-API that allows changing these naming conventions: . The factory accepts an Attribute interface as argument and returns an actual instance. You can implement your own factory if you need to change the default behavior.
- Now here is the actual class that implements our new Attribute. Notice that the class has to extend [](xref:Lucene.Net.Util.AttributeImpl):
+ Now here is the actual class that implements our new Attribute. Notice that the class has to extend :
public final class PartOfSpeechAttributeImpl extends AttributeImpl
implements PartOfSpeechAttribute {
@@ -759,7 +764,7 @@ Analyzers take Java {@link java.io.Reader}s as input. Of course you can wrap you
to manipulate content, but this would have the big disadvantage that character offsets might be inconsistent with your original
text.
-[](xref:Lucene.Net.Analysis.CharFilter) is designed to allow you to pre-process input like a FilterReader would, but also
+ is designed to allow you to pre-process input like a FilterReader would, but also
preserve the original offsets associated with those characters. This way mechanisms like highlighting still work correctly.
CharFilters can be chained.
diff --git a/src/Lucene.Net/Codecs/Compressing/CompressingStoredFieldsFormat.cs b/src/Lucene.Net/Codecs/Compressing/CompressingStoredFieldsFormat.cs
index c88d8e7dfa..7dcda784b5 100644
--- a/src/Lucene.Net/Codecs/Compressing/CompressingStoredFieldsFormat.cs
+++ b/src/Lucene.Net/Codecs/Compressing/CompressingStoredFieldsFormat.cs
@@ -48,7 +48,7 @@ public class CompressingStoredFieldsFormat : StoredFieldsFormat
/// Create a new with an empty segment
/// suffix.
///
- ///
+ ///
public CompressingStoredFieldsFormat(string formatName, CompressionMode compressionMode, int chunkSize)
: this(formatName, "", compressionMode, chunkSize)
{
@@ -83,6 +83,7 @@ public CompressingStoredFieldsFormat(string formatName, CompressionMode compress
/// to the size of your index).
///
/// The name of the .
+ ///
/// The to use.
/// The minimum number of bytes of a single chunk of stored documents.
///
diff --git a/src/Lucene.Net/Codecs/Compressing/package.md b/src/Lucene.Net/Codecs/Compressing/package.md
index 021601362a..9b50655906 100644
--- a/src/Lucene.Net/Codecs/Compressing/package.md
+++ b/src/Lucene.Net/Codecs/Compressing/package.md
@@ -1,4 +1,9 @@
-
+---
+uid: Lucene.Net.Codecs.Compressing
+summary: *content
+---
+
+
-The logical representation of a [](xref:Lucene.Net.Documents.Document) for indexing and searching.
+The logical representation of a for indexing and searching.
-The document package provides the user level logical representation of content to be indexed and searched. The package also provides utilities for working with [](xref:Lucene.Net.Documents.Document)s and [](xref:Lucene.Net.Index.IndexableField)s.
+The document package provides the user level logical representation of content to be indexed and searched. The package also provides utilities for working with s and s.
## Document and IndexableField
-A [](xref:Lucene.Net.Documents.Document) is a collection of [](xref:Lucene.Net.Index.IndexableField)s. A [](xref:Lucene.Net.Index.IndexableField) is a logical representation of a user's content that needs to be indexed or stored. [](xref:Lucene.Net.Index.IndexableField)s have a number of properties that tell Lucene how to treat the content (like indexed, tokenized, stored, etc.) See the [](xref:Lucene.Net.Documents.Field) implementation of [](xref:Lucene.Net.Index.IndexableField) for specifics on these properties.
+A is a collection of s. A is a logical representation of a user's content that needs to be indexed or stored. s have a number of properties that tell Lucene how to treat the content (like indexed, tokenized, stored, etc.) See the implementation of for specifics on these properties.
-Note: it is common to refer to [](xref:Lucene.Net.Documents.Document)s having [](xref:Lucene.Net.Documents.Field)s, even though technically they have [](xref:Lucene.Net.Index.IndexableField)s.
+Note: it is common to refer to s having s, even though technically they have s.
## Working with Documents
-First and foremost, a [](xref:Lucene.Net.Documents.Document) is something created by the user application. It is your job to create Documents based on the content of the files you are working with in your application (Word, txt, PDF, Excel or any other format.) How this is done is completely up to you. That being said, there are many tools available in other projects that can make the process of taking a file and converting it into a Lucene [](xref:Lucene.Net.Documents.Document).
+First and foremost, a is something created by the user application. It is your job to create Documents based on the content of the files you are working with in your application (Word, txt, PDF, Excel or any other format.) How this is done is completely up to you. That being said, there are many tools available in other projects that can make the process of taking a file and converting it into a Lucene .
-The [](xref:Lucene.Net.Documents.DateTools) is a utility class to make dates and times searchable (remember, Lucene only searches text). [](xref:Lucene.Net.Documents.IntField), [](xref:Lucene.Net.Documents.LongField), [](xref:Lucene.Net.Documents.FloatField) and [](xref:Lucene.Net.Documents.DoubleField) are a special helper class to simplify indexing of numeric values (and also dates) for fast range range queries with [](xref:Lucene.Net.Search.NumericRangeQuery) (using a special sortable string representation of numeric values).
\ No newline at end of file
+The is a utility class to make dates and times searchable (remember, Lucene only searches text). , , and are a special helper class to simplify indexing of numeric values (and also dates) for fast range range queries with (using a special sortable string representation of numeric values).
\ No newline at end of file
diff --git a/src/Lucene.Net/Index/package.md b/src/Lucene.Net/Index/package.md
index a1f0996261..9d299c3aa8 100644
--- a/src/Lucene.Net/Index/package.md
+++ b/src/Lucene.Net/Index/package.md
@@ -1,4 +1,9 @@
-
+---
+uid: Lucene.Net.Index
+summary: *content
+---
+
+
-
- org.apache.lucene.search.payloads
-
-
+
+
The payloads package provides Query mechanisms for finding and using payloads.
- The following Query implementations are provided: 1. [](xref:Lucene.Net.Search.Payloads.PayloadTermQuery PayloadTermQuery) -- Boost a term's score based on the value of the payload located at that term. 2. [](xref:Lucene.Net.Search.Payloads.PayloadNearQuery PayloadNearQuery) -- A [](xref:Lucene.Net.Search.Spans.SpanNearQuery SpanNearQuery) that factors in the value of the payloads located at each of the positions where the spans occur.
+ The following Query implementations are provided: 1. [PayloadTermQuery](xref:Lucene.Net.Search.Payloads.PayloadTermQuery) -- Boost a term's score based on the value of the payload located at that term. 2. [PayloadNearQuery](xref:Lucene.Net.Search.Payloads.PayloadNearQuery) -- A [SpanNearQuery](xref:Lucene.Net.Search.Spans.SpanNearQuery) that factors in the value of the payloads located at each of the positions where the spans occur.
+
-
- |