Kentico.Xperience.Lucene 3.0.0-v28preview-3

Prefix Reserved
.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher.
This is a prerelease version of Kentico.Xperience.Lucene.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Kentico.Xperience.Lucene --version 3.0.0-v28preview-3                

                    
                

            
NuGet\Install-Package Kentico.Xperience.Lucene -Version 3.0.0-v28preview-3
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Kentico.Xperience.Lucene" Version="3.0.0-v28preview-3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Kentico.Xperience.Lucene --version 3.0.0-v28preview-3                

                    
                

            
#r "nuget: Kentico.Xperience.Lucene, 3.0.0-v28preview-3"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install Kentico.Xperience.Lucene as a Cake Addin
#addin nuget:?package=Kentico.Xperience.Lucene&version=3.0.0-v28preview-3&prerelease

// Install Kentico.Xperience.Lucene as a Cake Tool
#tool nuget:?package=Kentico.Xperience.Lucene&version=3.0.0-v28preview-3&prerelease

Xperience by Kentico Lucene

7-day bug-fix policy CI: Build and Test NuGet Package

Description

Xperience by Kentico search integration with the latest 4.8 beta version of Lucene.NET, enabling auto-indexing of content in Xperience based on application-local, code-defined search indexes and search results retrieval.

Library Version Matrix

Xperience Version Library Version
>= 28.0.0 3.x
>= 26.2.0, < 27.0.0 2.x

Dependencies

Package Installation

Add the package to your application using the .NET CLI

dotnet add package Kentico.Xperience.Lucene

Quick Start

  1. Define a custom DefaultLuceneIndexingStrategy implementation to customize how content pages/content items are processed for the index.

  2. Add this library to the application services, registering your custom DefaultLuceneIndexingStrategy and Lucene

    // Program.cs

// Registers all services and uses default indexing behavior (no data is indexed)
services.AddLucene();

// or

// Registers all services and enables custom indexing behavior
services.AddLucene(builder =>
   builder
      .RegisterStrategy<GlobalSearchIndexingStrategy>("DefaultStrategy")
      .RegisterStrategy<ArticlesSearchIndexingStrategy>("ArticlesStrategy"));

  3. Create an index in Xperience's Administration within the Search application added by this library.

  4. Rebuild the index in Xperience's Administration within the Search application added by this library.

  5. Use the ILuceneSearchService (via DI) to retrieve the index populated by your custom ILuceneIndexingStrategy.

  6. Execute a search with a customized Lucene Query (like the MatchAllDocsQuery) using the ILuceneSearchService.

  7. Display the results on your site with a Razor View 👍.

Full Instructions

View the Usage Guide for more detailed instructions.

Projects

Project Description
src/Kentico.Xperience.Lucene Xperience by Kentico Lucene integration library
examples/DancingGoat Example project to showcase basic search functionality

Contributing

To see the guidelines for Contributing to Kentico open source software, please see Kentico's CONTRIBUTING.md for more information and follow the Kentico's CODE_OF_CONDUCT.

Instructions and technical details for contributing to this project can be found in Contributing Setup.

License

Distributed under the MIT License. See LICENSE.md for more information.

Support

7-day bug-fix policy

This project has Full support by 7-day bug-fix policy.

See SUPPORT.md for more information.

Security

For any security issues see Kentico's SECURITY.md.

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
10.0.0 617 10/29/2024
9.0.1 801 10/9/2024
9.0.0 1,007 9/4/2024
8.1.0 443 8/20/2024
8.0.0 310 8/14/2024
7.0.2 541 7/12/2024
7.0.1 812 6/4/2024
7.0.0 603 5/6/2024
6.1.0 1,287 4/22/2024
6.0.0 139 4/19/2024
6.0.0-prerelease-1 87 4/18/2024
5.0.0 350 4/10/2024
5.0.0-prerelease-1 85 4/10/2024
4.2.0 280 3/25/2024
4.1.0 870 2/1/2024
4.1.0-prerelease-4 99 1/31/2024
4.1.0-prerelease-3 87 1/31/2024
4.1.0-prerelease-2 79 1/31/2024
4.1.0-prerelease-1 85 1/31/2024
4.0.0 186 1/17/2024
3.0.0 148 1/12/2024
3.0.0-v28preview-3 87 1/12/2024
3.0.0-v28preview-2 92 1/12/2024
3.0.0-v28preview 110 12/21/2023
2.0.1 236 9/22/2023
2.0.0 195 9/12/2023
1.0.0 177 8/15/2023
1.0.0-prerelease-1 166 8/2/2023

https://github.com/Kentico/xperience-by-kentico-lucene/releases