Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

4.8.0-beta00018 Documentation Changes #1043

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Welcome to Apache Lucene.NET
# Welcome to Apache Lucene.NET

[![Nuget](https://img.shields.io/nuget/dt/Lucene.Net)](https://www.nuget.org/packages/Lucene.Net)
[![Azure DevOps builds (master)](https://img.shields.io/azure-devops/build/lucene-net/6ba240c9-9598-47e7-a793-0ed8a4ba2f8b/3/master)](https://dev.azure.com/lucene-net/Lucene.NET/_build?definitionId=3&_a=summary)
Expand All @@ -25,7 +25,6 @@ The Apache Lucene.NET website is at:
### Lucene.NET 4.8.0

- [.NET 8.0](https://dotnet.microsoft.com/download/dotnet/8.0)
- [.NET 6.0](https://dotnet.microsoft.com/download/dotnet/6.0)
- [.NET Standard 2.1](https://docs.microsoft.com/en-us/dotnet/standard/net-standard)
- [.NET Standard 2.0](https://docs.microsoft.com/en-us/dotnet/standard/net-standard)
- .NET Framework 4.6.2
Expand All @@ -38,8 +37,8 @@ Working toward Lucene.NET 4.8.0 (currently in BETA)

* The beta version is extremely stable
* Has more than 7800+ passing unit tests
* Integrates well with .NET 8.0 and .NET 6.0 (as well as other unsupported versions)
* Supports .NET Standard 2.1 and .NET Standard 2.0
* Integrates well with .NET 8.0 (as well as other unsupported versions)
* Supports .NET Standard 2.1 and .NET Standard 2.0
* Supports .NET Framework 4.6.2+
* Some developers already use it in production environments

Expand Down Expand Up @@ -74,7 +73,7 @@ PM> Install-Package Lucene.Net -Pre

##### All Packages

<!--- TO BE ADDED WHEN RELEASED
<!--- TO BE ADDED WHEN RELEASED

- [Lucene.Net.Analysis.Nori](https://www.nuget.org/packages/Lucene.Net.Analysis.Nori/) - Korean Morphological Analyzer

Expand Down
2 changes: 1 addition & 1 deletion src/dotnet/tools/lucene-cli/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The Lucene.NET command line interface (CLI) is a new cross-platform toolchain wi

## Prerequisites

- [.NET 6.0 Runtime or Higher](https://dotnet.microsoft.com/en-us/download/dotnet) (.NET 8.0 recommended)
- [.NET 8.0 Runtime or Higher](https://dotnet.microsoft.com/en-us/download/dotnet)

## Installation

Expand Down
12 changes: 6 additions & 6 deletions websites/apidocs/apiSpec/core/Lucene_Net_Codecs.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,15 @@ Codecs API: API for customization of the encoding and structure of the index.
* FieldInfos - see <xref:Lucene.Net.Codecs.FieldInfosFormat>
* SegmentInfo - see <xref:Lucene.Net.Codecs.SegmentInfoFormat>
* Norms - see <xref:Lucene.Net.Codecs.NormsFormat>
* Live documents - see <xref:Lucene.Net.Codecs.LiveDocsFormat>
* Live documents - see <xref:Lucene.Net.Codecs.LiveDocsFormat>

For some concrete implementations beyond Lucene's official index format, see the [Codecs module](../codecs/overview.html).

Codecs are identified by name through the <xref:Lucene.Net.Codecs.ICodecFactory> implementation, which by default is the <xref:Lucene.Net.Codecs.DefaultCodecFactory>. To create your own codec, extend <xref:Lucene.Net.Codecs.Codec>. By default, the name of the class (minus the suffix "Codec") will be used as the codec's name.

```cs
// By default, the name will be "My" because the "Codec" suffix is removed
public class MyCodec : Codec
public class MyCodec : Codec
{
}
```
Expand All @@ -49,7 +49,7 @@ public class MyCodec : Codec

To override the default codec name, decorate the custom codec with the <xref:Lucene.Net.Codecs.CodecNameAttribute>.

The <xref:Lucene.Net.Codecs.CodecNameAttribute> can be used to set the name to that of a built-in codec to override its registration in the <xref:Lucene.Net.Codecs.DefaultCodecFactory>.
The <xref:Lucene.Net.Codecs.CodecNameAttribute> can be used to set the name to that of a built-in codec to override its registration in the <xref:Lucene.Net.Codecs.DefaultCodecFactory>.

```cs
[CodecName("MyCodec")] // Sets the codec name explicitly
Expand Down Expand Up @@ -110,7 +110,7 @@ Codec.SetCodecFactory(services.GetService<ICodecFactory>());
If your application is not using dependency injection, you can register a custom codec by adding your codec at start up.

```cs
Codec.SetCodecFactory(new DefaultCodecFactory {
Codec.SetCodecFactory(new DefaultCodecFactory {
CustomCodecTypes = new Type[] { typeof(MyCodec) }
});
```
Expand Down Expand Up @@ -178,7 +178,7 @@ The <xref:Lucene.Net.TestFramework> library contains specialized classes to mini
> See [Unit testing C# with NUnit and .NET Core](https://docs.microsoft.com/en-us/dotnet/core/testing/unit-testing-with-nunit) for detailed instructions on how to set up a class library to use with NUnit.

> [!NOTE]
> .NET Standard is not an executable target. Tests will not run unless you target a framework such as `net6.0` or `net48`.
> .NET Standard is not an executable target. Tests will not run unless you target a framework such as `net8.0` or `net48`.

Here is an example project file for .NET 8 for testing a project named `MyCodecs.csproj`.

Expand Down Expand Up @@ -242,7 +242,7 @@ namespace ExampleLuceneNetTestFramework
}
```

The <xref:Lucene.Net.Index.BasePostingsFormatTestCase> class includes a barrage of 8 tests that can now be run using your favorite test runner, such as Visual Studio Test Explorer.
The <xref:Lucene.Net.Index.BasePostingsFormatTestCase> class includes a barrage of 8 tests that can now be run using your favorite test runner, such as Visual Studio Test Explorer.

- TestDocsAndFreqs
- TestDocsAndFreqsAndPositions
Expand Down
Loading