diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json new file mode 100644 index 0000000000..9fd034a4e1 --- /dev/null +++ b/.config/dotnet-tools.json @@ -0,0 +1,13 @@ +{ + "version": 1, + "isRoot": true, + "tools": { + "docfx": { + "version": "2.77.0", + "commands": [ + "docfx" + ], + "rollForward": false + } + } +} \ No newline at end of file diff --git a/.github/workflows/Lucene-Net-Documentation.yml b/.github/workflows/Lucene-Net-Documentation.yml index 2b8ad9feac..8097356521 100644 --- a/.github/workflows/Lucene-Net-Documentation.yml +++ b/.github/workflows/Lucene-Net-Documentation.yml @@ -121,7 +121,12 @@ jobs: - name: Setup .NET 6 SDK uses: actions/setup-dotnet@v3 with: - dotnet-version: '6.0.101' + dotnet-version: '6.0.x' + + - name: Setup .NET 8 SDK + uses: actions/setup-dotnet@v3 + with: + dotnet-version: '8.0.x' - name: Build docs run: ./main-repo/websites/apidocs/docs.ps1 -Clean -LuceneNetVersion ${{ env.RELEASE_VERSION }} diff --git a/.vscode/settings.json b/.vscode/settings.json index d47dddebf3..4f7d121a28 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,7 +1,6 @@ { "files.exclude": { - "**/.git": true, - "**/docs": true + "**/.git": true }, "dotnet-test-explorer.testProjectPath": "src/**/*.Tests.*.csproj" -} \ No newline at end of file +} diff --git a/Lucene.Net.sln b/Lucene.Net.sln index 3c51015dc7..a7a55a7b3d 100644 --- a/Lucene.Net.sln +++ b/Lucene.Net.sln @@ -7,9 +7,9 @@ Microsoft Visual Studio Solution File, Format Version 12.00 # to you under the Apache License, Version 2.0 (the # "License"); you may not use this file except in compliance # with the License. You may obtain a copy of the License at -# +# # http://www.apache.org/licenses/LICENSE-2.0 -# +# # Unless required by applicable law or agreed to in writing, # software distributed under the License is distributed on an # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY @@ -282,6 +282,10 @@ Project("{E24C65DC-7377-472B-9ABA-BC803B73C61A}") = "websites", "websites\", "{8 SlnRelativePath = "websites\" EndProjectSection EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{42599646-275F-4970-BC60-A3349F6498CC}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "LuceneDocsPlugins", "src\docs\LuceneDocsPlugins\LuceneDocsPlugins.csproj", "{FED4A824-1F32-4948-8D37-2B7610804DB5}" +EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU @@ -554,6 +558,10 @@ Global {9880B87D-8D14-476B-B093-9C3AA0DA8B24}.Release|Any CPU.Build.0 = Release|Any CPU {8988CDA4-8420-4BEE-869A-66825055EED2}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {8988CDA4-8420-4BEE-869A-66825055EED2}.Release|Any CPU.ActiveCfg = Debug|Any CPU + {FED4A824-1F32-4948-8D37-2B7610804DB5}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {FED4A824-1F32-4948-8D37-2B7610804DB5}.Debug|Any CPU.Build.0 = Debug|Any CPU + {FED4A824-1F32-4948-8D37-2B7610804DB5}.Release|Any CPU.ActiveCfg = Release|Any CPU + {FED4A824-1F32-4948-8D37-2B7610804DB5}.Release|Any CPU.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE @@ -574,6 +582,7 @@ Global {5CD4D4E8-6132-4384-98FC-6AB1C97E0B80} = {8CA61D33-3590-4024-A304-7B1F75B50653} {E5E8C5DC-7048-4818-B884-FB2D037D2EF2} = {8CA61D33-3590-4024-A304-7B1F75B50653} {4D0ED7D9-ABEE-4890-B06C-477E3A32B9A0} = {E5E8C5DC-7048-4818-B884-FB2D037D2EF2} + {FED4A824-1F32-4948-8D37-2B7610804DB5} = {42599646-275F-4970-BC60-A3349F6498CC} EndGlobalSection GlobalSection(ExtensibilityGlobals) = postSolution SolutionGuid = {9F2179CC-CFD2-4419-AB74-D72856931F36} diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Util/CharArrayMap.cs b/src/Lucene.Net.Analysis.Common/Analysis/Util/CharArrayMap.cs index 4a390badb1..d5c6d9a655 100644 --- a/src/Lucene.Net.Analysis.Common/Analysis/Util/CharArrayMap.cs +++ b/src/Lucene.Net.Analysis.Common/Analysis/Util/CharArrayMap.cs @@ -162,7 +162,7 @@ public CharArrayDictionary(LuceneVersion matchVersion, int capacity, bool ignore /// /// compatibility match version see for details. /// - /// a dictionary () whose mappings to be copied. + /// a dictionary () whose mappings to be copied. /// /// false if and only if the set should be case sensitive; /// otherwise true. @@ -191,7 +191,7 @@ public CharArrayDictionary(LuceneVersion matchVersion, IDictionary /// compatibility match version see for details. /// - /// a dictionary () whose mappings to be copied. + /// a dictionary () whose mappings to be copied. /// /// false if and only if the set should be case sensitive; /// otherwise true. @@ -220,7 +220,7 @@ public CharArrayDictionary(LuceneVersion matchVersion, IDictionary /// compatibility match version see for details. /// - /// a dictionary () whose mappings to be copied. + /// a dictionary () whose mappings to be copied. /// /// false if and only if the set should be case sensitive; /// otherwise true. @@ -1754,7 +1754,7 @@ private bool Equals(string text1, char[] text2) /// LUCENENET Specific - test for value equality similar to how it is done in Java /// /// Another dictionary to test the values of - /// true if the given object is an that contains + /// true if the given object is an that contains /// the same text value pairs as the current dictionary public override bool Equals(object? obj) { diff --git a/src/Lucene.Net.Analysis.OpenNLP/overview.md b/src/Lucene.Net.Analysis.OpenNLP/overview.md index 1667c7f52e..05aa4ca15c 100644 --- a/src/Lucene.Net.Analysis.OpenNLP/overview.md +++ b/src/Lucene.Net.Analysis.OpenNLP/overview.md @@ -27,7 +27,7 @@ This module exposes functionality from Apache OpenNLP to Apache Lucene.NET. The For an introduction to Lucene's analysis API, see the [Lucene.Net.Analysis](../core/Lucene.Net.Analysis.html) namespace documentation. -The OpenNLP Tokenizer behavior is similar to the but is smart about inter-word punctuation. The term stream looks very much like the way you parse words and punctuation while reading. The major difference between this tokenizer and most other tokenizers shipped with Lucene is that punctuation is tokenized. This is required for the following taggers to operate properly. +The OpenNLP Tokenizer behavior is similar to the but is smart about inter-word punctuation. The term stream looks very much like the way you parse words and punctuation while reading. The major difference between this tokenizer and most other tokenizers shipped with Lucene is that punctuation is tokenized. This is required for the following taggers to operate properly. The OpenNLP taggers annotate terms using the . @@ -46,7 +46,8 @@ When a `` is included for this NuGet package in your SDK-style The `` item group operates similar to a dependency in Maven. All transitive dependencies are collected and resolved, and then the final output is produced. However, unlike `PackageReference`s, `MavenReference`s are collected by the final output project, and reassessed. That is, each dependent Project within your .NET SDK-style solution contributes its `MavenReference`s to project(s) which include it, and each project makes its own dependency graph. Projects do not contribute their final built assemblies up. They only contribute their dependencies. Allowing each project in a complicated solution to make its own local conflict resolution attempt. -> **NOTE** `` is only supported on SDK-style MSBuild projects. +> [!NOTE] +> `` is only supported on SDK-style MSBuild projects. ## MavenReference Example diff --git a/src/Lucene.Net.Highlighter/Highlight/WeightedSpanTermExtractor.cs b/src/Lucene.Net.Highlighter/Highlight/WeightedSpanTermExtractor.cs index 8499a2c762..d1989a337c 100644 --- a/src/Lucene.Net.Highlighter/Highlight/WeightedSpanTermExtractor.cs +++ b/src/Lucene.Net.Highlighter/Highlight/WeightedSpanTermExtractor.cs @@ -58,7 +58,7 @@ public WeightedSpanTermExtractor(string defaultField) } /// - /// Fills a with s using the terms from the supplied . + /// Fills a with s using the terms from the supplied . /// /// to extract Terms from /// Map to place created s in @@ -237,9 +237,9 @@ protected virtual void ExtractUnknownQuery(Query query, } /// - /// Fills a with s using the terms from the supplied . + /// Fills a with s using the terms from the supplied . /// - /// to place created s in + /// to place created s in /// to extract Terms from /// If there is a low-level I/O error protected virtual void ExtractWeightedSpanTerms(IDictionary terms, SpanQuery spanQuery) @@ -336,10 +336,10 @@ protected virtual void ExtractWeightedSpanTerms(IDictionary - /// Fills a with s using the terms from + /// Fills a with s using the terms from /// the supplied . /// - /// to place created s in + /// to place created s in /// to extract Terms from /// If there is a low-level I/O error protected virtual void ExtractWeightedTerms(IDictionary terms, Query query) @@ -448,7 +448,7 @@ public override IBits GetDocsWithField(string field) } /// - /// Creates an from the given and . + /// Creates an from the given and . /// /// that caused hit /// of text to be highlighted @@ -461,7 +461,7 @@ public virtual IDictionary GetWeightedSpanTerms(Query /// - /// Creates an from the given and . + /// Creates an from the given and . /// /// that caused hit /// of text to be highlighted @@ -495,7 +495,7 @@ public virtual IDictionary GetWeightedSpanTerms(Query } /// - /// Creates an from the given and . Uses a supplied + /// Creates an from the given and . Uses a supplied /// to properly Weight terms (for gradient highlighting). /// /// that caused hit diff --git a/src/Lucene.Net.Highlighter/PostingsHighlight/PostingsHighlighter.cs b/src/Lucene.Net.Highlighter/PostingsHighlight/PostingsHighlighter.cs index d7f661da72..da517f697c 100644 --- a/src/Lucene.Net.Highlighter/PostingsHighlight/PostingsHighlighter.cs +++ b/src/Lucene.Net.Highlighter/PostingsHighlight/PostingsHighlighter.cs @@ -245,7 +245,7 @@ public virtual string[] Highlight(string field, Query query, IndexSearcher searc /// searcher that was previously used to execute the query. /// TopDocs containing the summary result documents to highlight. /// - /// keyed on field name, containing the array of formatted snippets + /// keyed on field name, containing the array of formatted snippets /// corresponding to the documents in . /// If no highlights were found for a document, the /// first sentence from the field will be returned. @@ -278,7 +278,7 @@ public virtual IDictionary HighlightFields(string[] fields, Qu /// TopDocs containing the summary result documents to highlight. /// The maximum number of top-N ranked passages per-field used to form the highlighted snippets. /// - /// keyed on field name, containing the array of formatted snippets + /// keyed on field name, containing the array of formatted snippets /// corresponding to the documents in . /// If no highlights were found for a document, the /// first sentences from the @@ -308,7 +308,7 @@ public virtual IDictionary HighlightFields(string[] fields, Qu /// containing the document IDs to highlight. /// The maximum number of top-N ranked passages per-field used to form the highlighted snippets. /// - /// keyed on field name, containing the array of formatted snippets + /// keyed on field name, containing the array of formatted snippets /// corresponding to the documents in . /// If no highlights were found for a document, the /// first maxPassages from the field will @@ -375,7 +375,7 @@ protected override int Compare(int i, int j) /// containing the document IDs to highlight. /// The maximum number of top-N ranked passages per-field used to form the highlighted snippets. /// - /// keyed on field name, containing the array of formatted snippets + /// keyed on field name, containing the array of formatted snippets /// corresponding to the documents in . /// If no highlights were found for a document, the /// first from the field will diff --git a/src/Lucene.Net.Replicator/package.md b/src/Lucene.Net.Replicator/package.md index 6db5ab5019..2b7399a147 100644 --- a/src/Lucene.Net.Replicator/package.md +++ b/src/Lucene.Net.Replicator/package.md @@ -25,7 +25,7 @@ application should publish an [IndexAndTaxonomyRevision](xref:Lucene.Net.Replica When the replication client detects that there is a newer revision available, it copies the files of the revision and then invokes the handler to complete the operation (e.g. copy the files to the index directory, sync them, reopen an index reader etc.). By default, only files that do not exist in the handler's -[current revision files](xref:Lucene.Net.Replicator.IReplicationHandler.html#Lucene_Net_Replicator_IReplicationHandler_CurrentRevisionFiles) are copied, +[current revision files](xref:Lucene.Net.Replicator.IReplicationHandler#Lucene_Net_Replicator_IReplicationHandler_CurrentRevisionFiles) are copied, however this can be overridden by extending the client. false - - - - - - - - - - - - - - - - - - - + + + - \ No newline at end of file + diff --git a/src/docs/LuceneDocsPlugins/LuceneNoteBlockRule.cs b/src/docs/LuceneDocsPlugins/LuceneNoteBlockRule.cs deleted file mode 100644 index 938ef3f16a..0000000000 --- a/src/docs/LuceneDocsPlugins/LuceneNoteBlockRule.cs +++ /dev/null @@ -1,46 +0,0 @@ -using System.Text.RegularExpressions; -using Microsoft.DocAsCode.MarkdownLite; - -namespace LuceneDocsPlugins -{ - /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - - /// - /// The regex rule to parse out the custom Lucene tokens - /// - public class LuceneNoteBlockRule : IMarkdownRule - { - // TODO: I think there's an issue with this regex and multi-line or something, for example see: DrillDownQuery class - // since this isn't matching it's experimental tag (there's lots of others too) - public virtual Regex LabelRegex { get; } = new Regex("^@lucene\\.(?(experimental|internal))", RegexOptions.Compiled); - - public virtual IMarkdownToken TryMatch(IMarkdownParser parser, IMarkdownParsingContext context) - { - - var match = LabelRegex.Match(context.CurrentMarkdown); - if (match.Length == 0) - { - return null; - } - var sourceInfo = context.Consume(match.Length); - return new LuceneNoteBlockToken(this, parser.Context, match.Groups[1].Value, sourceInfo); - } - - public virtual string Name => "LuceneNote"; - } -} \ No newline at end of file diff --git a/src/docs/LuceneDocsPlugins/LuceneNoteBlockToken.cs b/src/docs/LuceneDocsPlugins/LuceneNoteBlockToken.cs deleted file mode 100644 index d8dd4f6d0c..0000000000 --- a/src/docs/LuceneDocsPlugins/LuceneNoteBlockToken.cs +++ /dev/null @@ -1,44 +0,0 @@ -using Microsoft.DocAsCode.MarkdownLite; - -namespace LuceneDocsPlugins -{ - /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - - /// - /// A custom token class representing our custom Lucene tokens - /// - public class LuceneNoteBlockToken : IMarkdownToken - { - public LuceneNoteBlockToken(IMarkdownRule rule, IMarkdownContext context, string label, SourceInfo sourceInfo) - { - Rule = rule; - Context = context; - Label = label; - SourceInfo = sourceInfo; - } - - public IMarkdownRule Rule { get; } - - public IMarkdownContext Context { get; } - - public string Label { get; } - - public SourceInfo SourceInfo { get; } - } - -} \ No newline at end of file diff --git a/src/docs/LuceneDocsPlugins/LuceneNoteProcessor.cs b/src/docs/LuceneDocsPlugins/LuceneNoteProcessor.cs new file mode 100644 index 0000000000..a5afc08961 --- /dev/null +++ b/src/docs/LuceneDocsPlugins/LuceneNoteProcessor.cs @@ -0,0 +1,118 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +using Docfx.Common; +using Docfx.Plugins; +using System; +using System.Collections.Immutable; +using System.IO; +using System.Linq; +using System.Text; +using System.Text.RegularExpressions; + +namespace LuceneDocsPlugins; + +public partial class LuceneNoteProcessor : IPostProcessor +{ + private const string ExperimentalMessage = + "This API is experimental and might change in incompatible ways in the next release."; + + private const string InternalMessage = + "This API is for internal purposes only and might change in incompatible ways in the next release."; + + [GeneratedRegex("@lucene\\.(?(experimental|internal))")] + private static partial Regex LuceneNoteRegex(); + + public ImmutableDictionary PrepareMetadata(ImmutableDictionary metadata) + { + return metadata; + } + + public Manifest Process(Manifest manifest, string outputFolder) + { + foreach (var manifestItem in manifest.Files) + { + foreach (var manifestItemOutputFile in manifestItem.Output) + { + var outputPath = Path.Combine(outputFolder, manifestItemOutputFile.Value.RelativePath); + + var content = File.ReadAllText(outputPath); + + Logger.LogInfo($"Replacing @lucene notes in {outputPath}"); + + var newContent = ReplaceLuceneNotes(content); + + if (content == newContent) + { + continue; + } + + Logger.LogInfo($"Writing new content to {outputPath}"); + + File.WriteAllText(outputPath, newContent); + } + } + + return manifest; + } + + private static string ReplaceLuceneNotes(string sourceText) + { + var matches = LuceneNoteRegex().Matches(sourceText); + + if (matches.Count > 0) + { + var sb = new StringBuilder(sourceText.Length); + + int lastMatchEnd = 0; + + foreach (Match match in matches) + { + var noteType = match.Groups["notetype"].Value; + + // Append the prefix that didn't match the regex (or text since last match) + sb.Append(sourceText.AsSpan(lastMatchEnd, match.Index - lastMatchEnd)); + + // Do the replacement of the regex match + string noteValue = GetLuceneNoteValue(noteType); + sb.Append(noteValue); + + Logger.LogInfo($"Replaced @lucene note '{noteType}'"); + lastMatchEnd = match.Index + match.Length; + } + + // Append the suffix that didn't match the regex + sb.Append(sourceText.AsSpan(lastMatchEnd)); + + return sb.ToString(); + } + + return sourceText; + } + + private static string GetLuceneNoteValue(string noteType) + { + string message = noteType == "internal" ? InternalMessage : ExperimentalMessage; + + var builder = new StringBuilder(); + builder.AppendLine("
"); + builder.AppendLine("
Note
"); + builder.Append("

").Append(message).AppendLine("

"); + builder.AppendLine("
"); + return builder.ToString(); + } +} diff --git a/src/docs/LuceneDocsPlugins/LuceneNoteTokenRendererPart.cs b/src/docs/LuceneDocsPlugins/LuceneNoteTokenRendererPart.cs deleted file mode 100644 index 8782ae16a5..0000000000 --- a/src/docs/LuceneDocsPlugins/LuceneNoteTokenRendererPart.cs +++ /dev/null @@ -1,52 +0,0 @@ -using Microsoft.DocAsCode.Dfm; -using Microsoft.DocAsCode.MarkdownLite; -using System.Text; - -namespace LuceneDocsPlugins -{ - /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - - /// - /// Used to replace custom Lucene tokens with custom HTML markup - /// - public sealed class LuceneNoteTokenRendererPart : DfmCustomizedRendererPartBase - { - private const string ExperimentalMessage = "This API is experimental and might change in incompatible ways in the next release."; - private const string InternalMessage = "This API is for internal purposes only and might change in incompatible ways in the next release."; - - private readonly StringBuilder builder = new StringBuilder(); - - public override string Name => "LuceneTokenRendererPart"; - - public override bool Match(IMarkdownRenderer renderer, LuceneNoteBlockToken token, MarkdownBlockContext context) - => true; - - public override StringBuffer Render(IMarkdownRenderer renderer, LuceneNoteBlockToken token, MarkdownBlockContext context) - { - string message = token.Label.ToUpperInvariant() == "INTERNAL" ? InternalMessage : ExperimentalMessage; - - builder.Clear(); // Reuse string builder - builder.AppendLine("
"); - builder.AppendLine("
Note
"); - builder.Append("

").Append(message).AppendLine("

"); - builder.AppendLine("
"); - return builder.ToString(); - //return "
" + string.Format(Message, token.Label.ToUpper()) + "
"; - } - } -} \ No newline at end of file diff --git a/src/docs/LuceneDocsPlugins/RendererPartProvider.cs b/src/docs/LuceneDocsPlugins/RendererPartProvider.cs deleted file mode 100644 index 58ddda35ac..0000000000 --- a/src/docs/LuceneDocsPlugins/RendererPartProvider.cs +++ /dev/null @@ -1,40 +0,0 @@ -using System.Collections.Generic; -using System.Composition; -using Microsoft.DocAsCode.Dfm; - -namespace LuceneDocsPlugins -{ - /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - - /// - /// Exports our custom renderer via MEF to DocFx - /// - [Export(typeof(IDfmCustomizedRendererPartProvider))] - public class RendererPartProvider : IDfmCustomizedRendererPartProvider - { - private readonly LuceneNoteTokenRendererPart luceneNoteTokenRendererPart = new LuceneNoteTokenRendererPart(); - - public IEnumerable CreateParts(IReadOnlyDictionary parameters) - { - yield return luceneNoteTokenRendererPart; - //yield return new EnvironmentVariableRendererPart(); - //yield return new EnvironmentVariableBlockRendererPart(); - } - } - -} \ No newline at end of file diff --git a/src/docs/LuceneDocsPlugins/app.config b/src/docs/LuceneDocsPlugins/app.config deleted file mode 100644 index c10b554820..0000000000 --- a/src/docs/LuceneDocsPlugins/app.config +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - - - - - - - - - diff --git a/src/dotnet/tools/lucene-cli/docs/index.md b/src/dotnet/tools/lucene-cli/docs/index.md index 8cf65c05f3..d7c6a1572f 100644 --- a/src/dotnet/tools/lucene-cli/docs/index.md +++ b/src/dotnet/tools/lucene-cli/docs/index.md @@ -8,14 +8,31 @@ The Lucene.NET command line interface (CLI) is a new cross-platform toolchain wi ## Installation -Perform a one-time install of the lucene-cli tool using the following dotnet CLI command: +Perform a one-time install of the lucene-cli tool using the [dotnet tool install](https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-tool-install) command, +which will install the specified version: ```console dotnet tool install lucene-cli -g --version 4.8.0-beta00016 ``` + + > [!NOTE] > The version of the CLI you install should match the version of Lucene.NET you use. +> The version can be specified using the [`--version` option](https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-tool-install#options) +> of the [`dotnet tool install`](https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-tool-install) command. +> For a list of available versions, see the [versions tab of the lucene-cli NuGet package](https://www.nuget.org/packages/lucene-cli#versions-body-tab) +> or run the [dotnet tool list](https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-tool-list) +> command using the package id `lucene-cli`. You may then use the lucene-cli tool to analyze and update Lucene.NET indexes and use its demos. diff --git a/websites/apidocs/Templates/DefaultTemplateNoAssets/partials/_head.liquid b/websites/apidocs/Templates/DefaultTemplateNoAssets/partials/_head.liquid index 2af71a645e..644653ba17 100644 --- a/websites/apidocs/Templates/DefaultTemplateNoAssets/partials/_head.liquid +++ b/websites/apidocs/Templates/DefaultTemplateNoAssets/partials/_head.liquid @@ -17,20 +17,20 @@ {%- endif -%} {%- if _appFaviconPath -%} - + {%- else -%} - + {%- endif -%} - - - + + + {%- if _noindex -%} {%- endif -%} {%- if _enableSearch -%} - + {%- endif -%} {%- if _enableNewTab -%} diff --git a/websites/apidocs/Templates/DefaultTemplateNoAssets/partials/_logo.liquid b/websites/apidocs/Templates/DefaultTemplateNoAssets/partials/_logo.liquid index 7bc65a65b8..b9b4c51f09 100644 --- a/websites/apidocs/Templates/DefaultTemplateNoAssets/partials/_logo.liquid +++ b/websites/apidocs/Templates/DefaultTemplateNoAssets/partials/_logo.liquid @@ -1,8 +1,8 @@ {% comment -%}Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.{% endcomment -%} - + {%- if _appLogoPath -%} - + {%- else -%} - + {%- endif -%} diff --git a/websites/apidocs/Templates/DefaultTemplateNoAssets/partials/_scripts.liquid b/websites/apidocs/Templates/DefaultTemplateNoAssets/partials/_scripts.liquid index 6640a85cdf..1b6c74ddc4 100644 --- a/websites/apidocs/Templates/DefaultTemplateNoAssets/partials/_scripts.liquid +++ b/websites/apidocs/Templates/DefaultTemplateNoAssets/partials/_scripts.liquid @@ -1,4 +1,4 @@ {% comment -%}Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.{% endcomment -%} - - - + + + diff --git a/websites/apidocs/Templates/DefaultTemplateNoAssets/partials/head.tmpl.partial b/websites/apidocs/Templates/DefaultTemplateNoAssets/partials/head.tmpl.partial index 4e8cd7918b..74a29d04e9 100644 --- a/websites/apidocs/Templates/DefaultTemplateNoAssets/partials/head.tmpl.partial +++ b/websites/apidocs/Templates/DefaultTemplateNoAssets/partials/head.tmpl.partial @@ -8,13 +8,13 @@ {{#_description}}{{/_description}} - - - - + + + + {{#_noindex}}{{/_noindex}} - {{#_enableSearch}}{{/_enableSearch}} + {{#_enableSearch}}{{/_enableSearch}} {{#_enableNewTab}}{{/_enableNewTab}} diff --git a/websites/apidocs/Templates/DefaultTemplateNoAssets/partials/logo.tmpl.partial b/websites/apidocs/Templates/DefaultTemplateNoAssets/partials/logo.tmpl.partial index 8209615a35..ff19fdc116 100644 --- a/websites/apidocs/Templates/DefaultTemplateNoAssets/partials/logo.tmpl.partial +++ b/websites/apidocs/Templates/DefaultTemplateNoAssets/partials/logo.tmpl.partial @@ -1,5 +1,5 @@ {{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} - - + + diff --git a/websites/apidocs/Templates/DefaultTemplateNoAssets/partials/scripts.tmpl.partial b/websites/apidocs/Templates/DefaultTemplateNoAssets/partials/scripts.tmpl.partial index ab3204ecb9..99d3fe9af2 100644 --- a/websites/apidocs/Templates/DefaultTemplateNoAssets/partials/scripts.tmpl.partial +++ b/websites/apidocs/Templates/DefaultTemplateNoAssets/partials/scripts.tmpl.partial @@ -1,5 +1,5 @@ {{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} - - - + + + diff --git a/websites/apidocs/Templates/LuceneTemplate/partials/logo.tmpl.partial b/websites/apidocs/Templates/LuceneTemplate/partials/logo.tmpl.partial index f2b652b42d..38c3a82ad3 100644 --- a/websites/apidocs/Templates/LuceneTemplate/partials/logo.tmpl.partial +++ b/websites/apidocs/Templates/LuceneTemplate/partials/logo.tmpl.partial @@ -1,5 +1,5 @@ {{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} - + diff --git a/websites/apidocs/Templates/LuceneTemplateAssets/styles/main.css b/websites/apidocs/Templates/LuceneTemplateAssets/styles/main.css index 595f3443df..0f40e06fd1 100644 --- a/websites/apidocs/Templates/LuceneTemplateAssets/styles/main.css +++ b/websites/apidocs/Templates/LuceneTemplateAssets/styles/main.css @@ -41,15 +41,19 @@ } button, a { - color: #1764aa; - /* #0095eb */ + color: #0098ff; } button:hover, button:focus, a:hover, a:focus { - color: #143653; - text-decoration: none; + color: #0098ff; +} +a:hover { + text-decoration: underline; +} +.expand-stub + a { + font-weight: normal; } nav.navbar { background-color: white; diff --git a/websites/apidocs/docfx.analysis-common.json b/websites/apidocs/docfx.analysis-common.json index 674f5a3b48..e73cf49330 100644 --- a/websites/apidocs/docfx.analysis-common.json +++ b/websites/apidocs/docfx.analysis-common.json @@ -15,7 +15,7 @@ ], "dest": "obj/docfx/api/analysis-common", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } } ], @@ -32,8 +32,11 @@ "**.yml", "**.md" ], + "exclude": [ + "toc.yml" + ], "src": "obj/docfx/api/analysis-common" - }, + }, { "files": [ "toc.yml", @@ -41,7 +44,7 @@ ], "src": "toc" } - ], + ], "overwrite": [ { "files": [ @@ -72,11 +75,13 @@ "Templates/LuceneTemplate", "Templates/LuceneApiDocs" ], - "postProcessors": [], + "postProcessors": [ + "AggregatePostProcessor" + ], "markdownEngineName": "dfm", "noLangKeyword": false, "keepFileLink": false, "cleanupCacheHistory": false, "disableGitFeatures": false } -} \ No newline at end of file +} diff --git a/websites/apidocs/docfx.analysis-kuromoji.json b/websites/apidocs/docfx.analysis-kuromoji.json index 027496033a..65d82b8687 100644 --- a/websites/apidocs/docfx.analysis-kuromoji.json +++ b/websites/apidocs/docfx.analysis-kuromoji.json @@ -15,19 +15,22 @@ ], "dest": "obj/docfx/api/analysis-kuromoji", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } } ], "build": { - "content": [ + "content": [ { "files": [ "**.yml", "**.md" ], + "exclude": [ + "toc.yml" + ], "src": "obj/docfx/api/analysis-kuromoji" - }, + }, { "files": [ "toc.yml", @@ -35,7 +38,7 @@ ], "src": "toc" } - ], + ], "overwrite": [ { "files": [ @@ -66,11 +69,13 @@ "Templates/LuceneTemplate", "Templates/LuceneApiDocs" ], - "postProcessors": [], + "postProcessors": [ + "AggregatePostProcessor" + ], "markdownEngineName": "dfm", "noLangKeyword": false, "keepFileLink": false, "cleanupCacheHistory": false, "disableGitFeatures": false } -} \ No newline at end of file +} diff --git a/websites/apidocs/docfx.analysis-morfologik.json b/websites/apidocs/docfx.analysis-morfologik.json index 8a34b5f633..aa9aab796e 100644 --- a/websites/apidocs/docfx.analysis-morfologik.json +++ b/websites/apidocs/docfx.analysis-morfologik.json @@ -15,19 +15,22 @@ ], "dest": "obj/docfx/api/analysis-morfologik", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } } ], "build": { - "content": [ + "content": [ { "files": [ "**.yml", "**.md" ], + "exclude": [ + "toc.yml" + ], "src": "obj/docfx/api/analysis-morfologik" - }, + }, { "files": [ "toc.yml", @@ -35,8 +38,8 @@ ], "src": "toc" } - ], - "overwrite": [ + ], + "overwrite": [ { "files": [ "**/package.md", @@ -66,11 +69,13 @@ "Templates/LuceneTemplate", "Templates/LuceneApiDocs" ], - "postProcessors": [], + "postProcessors": [ + "AggregatePostProcessor" + ], "markdownEngineName": "dfm", "noLangKeyword": false, "keepFileLink": false, "cleanupCacheHistory": false, "disableGitFeatures": false } -} \ No newline at end of file +} diff --git a/websites/apidocs/docfx.analysis-opennlp.json b/websites/apidocs/docfx.analysis-opennlp.json index b266a1cbd1..7b9b1f285e 100644 --- a/websites/apidocs/docfx.analysis-opennlp.json +++ b/websites/apidocs/docfx.analysis-opennlp.json @@ -15,19 +15,22 @@ ], "dest": "obj/docfx/api/analysis-opennlp", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } } ], "build": { - "content": [ + "content": [ { "files": [ "**.yml", "**.md" ], + "exclude": [ + "toc.yml" + ], "src": "obj/docfx/api/analysis-opennlp" - }, + }, { "files": [ "toc.yml", @@ -35,7 +38,7 @@ ], "src": "toc" } - ], + ], "overwrite": [ { "files": [ @@ -54,7 +57,8 @@ } ], "xref": [ - "_site/api/core/xrefmap.yml" + "_site/api/core/xrefmap.yml", + "_site/api/analysis-common/xrefmap.yml" ], "dest": "_site/api/analysis-opennlp", "globalMetadataFiles": [ @@ -66,11 +70,13 @@ "Templates/LuceneTemplate", "Templates/LuceneApiDocs" ], - "postProcessors": [], + "postProcessors": [ + "AggregatePostProcessor" + ], "markdownEngineName": "dfm", "noLangKeyword": false, "keepFileLink": false, "cleanupCacheHistory": false, "disableGitFeatures": false } -} \ No newline at end of file +} diff --git a/websites/apidocs/docfx.analysis-phonetic.json b/websites/apidocs/docfx.analysis-phonetic.json index 7957aa9bfc..8ba70561be 100644 --- a/websites/apidocs/docfx.analysis-phonetic.json +++ b/websites/apidocs/docfx.analysis-phonetic.json @@ -15,19 +15,22 @@ ], "dest": "obj/docfx/api/analysis-phonetic", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } } ], "build": { - "content": [ + "content": [ { "files": [ "**.yml", "**.md" ], + "exclude": [ + "toc.yml" + ], "src": "obj/docfx/api/analysis-phonetic" - }, + }, { "files": [ "toc.yml", @@ -35,7 +38,7 @@ ], "src": "toc" } - ], + ], "overwrite": [ { "files": [ @@ -46,7 +49,7 @@ "exclude": [ "package.md" ] - }, + }, { "files": [ "apiSpec/analysis-phonetic/**/*.md" @@ -66,11 +69,13 @@ "Templates/LuceneTemplate", "Templates/LuceneApiDocs" ], - "postProcessors": [], + "postProcessors": [ + "AggregatePostProcessor" + ], "markdownEngineName": "dfm", "noLangKeyword": false, "keepFileLink": false, "cleanupCacheHistory": false, "disableGitFeatures": false } -} \ No newline at end of file +} diff --git a/websites/apidocs/docfx.analysis-smartcn.json b/websites/apidocs/docfx.analysis-smartcn.json index c1a900a3c2..8845b22c18 100644 --- a/websites/apidocs/docfx.analysis-smartcn.json +++ b/websites/apidocs/docfx.analysis-smartcn.json @@ -15,19 +15,22 @@ ], "dest": "obj/docfx/api/analysis-smartcn", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } } ], "build": { - "content": [ + "content": [ { "files": [ "**.yml", "**.md" ], + "exclude": [ + "toc.yml" + ], "src": "obj/docfx/api/analysis-smartcn" - }, + }, { "files": [ "toc.yml", @@ -35,7 +38,7 @@ ], "src": "toc" } - ], + ], "overwrite": [ { "files": [ @@ -46,7 +49,7 @@ "exclude": [ "overview.md" ] - }, + }, { "files": [ "apiSpec/analysis-smartcn/**/*.md" @@ -54,7 +57,8 @@ } ], "xref": [ - "_site/api/core/xrefmap.yml" + "_site/api/core/xrefmap.yml", + "_site/api/analysis-common/xrefmap.yml" ], "dest": "_site/api/analysis-smartcn", "globalMetadataFiles": [ @@ -66,11 +70,13 @@ "Templates/LuceneTemplate", "Templates/LuceneApiDocs" ], - "postProcessors": [], + "postProcessors": [ + "AggregatePostProcessor" + ], "markdownEngineName": "dfm", "noLangKeyword": false, "keepFileLink": false, "cleanupCacheHistory": false, "disableGitFeatures": false } -} \ No newline at end of file +} diff --git a/websites/apidocs/docfx.analysis-stempel.json b/websites/apidocs/docfx.analysis-stempel.json index 62e723df6a..53b019c202 100644 --- a/websites/apidocs/docfx.analysis-stempel.json +++ b/websites/apidocs/docfx.analysis-stempel.json @@ -15,19 +15,22 @@ ], "dest": "obj/docfx/api/analysis-stempel", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } } ], "build": { - "content": [ + "content": [ { "files": [ "**.yml", "**.md" ], + "exclude": [ + "toc.yml" + ], "src": "obj/docfx/api/analysis-stempel" - }, + }, { "files": [ "toc.yml", @@ -35,7 +38,7 @@ ], "src": "toc" } - ], + ], "overwrite": [ { "files": [ @@ -46,7 +49,7 @@ "exclude": [ "package.md" ] - }, + }, { "files": [ "apiSpec/analysis-stempel/**/*.md" @@ -66,11 +69,13 @@ "Templates/LuceneTemplate", "Templates/LuceneApiDocs" ], - "postProcessors": [], + "postProcessors": [ + "AggregatePostProcessor" + ], "markdownEngineName": "dfm", "noLangKeyword": false, "keepFileLink": false, "cleanupCacheHistory": false, "disableGitFeatures": false } -} \ No newline at end of file +} diff --git a/websites/apidocs/docfx.benchmark.json b/websites/apidocs/docfx.benchmark.json index c201e9d82f..9ab3ab5c52 100644 --- a/websites/apidocs/docfx.benchmark.json +++ b/websites/apidocs/docfx.benchmark.json @@ -15,19 +15,22 @@ ], "dest": "obj/docfx/api/benchmark", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } } ], "build": { - "content": [ + "content": [ { "files": [ "**.yml", "**.md" ], + "exclude": [ + "toc.yml" + ], "src": "obj/docfx/api/benchmark" - }, + }, { "files": [ "toc.yml", @@ -35,7 +38,7 @@ ], "src": "toc" } - ], + ], "overwrite": [ { "files": [ @@ -46,7 +49,7 @@ "exclude": [ "overview.md" ] - }, + }, { "files": [ "apiSpec/benchmark/**/*.md" @@ -66,11 +69,13 @@ "Templates/LuceneTemplate", "Templates/LuceneApiDocs" ], - "postProcessors": [], + "postProcessors": [ + "AggregatePostProcessor" + ], "markdownEngineName": "dfm", "noLangKeyword": false, "keepFileLink": false, "cleanupCacheHistory": false, "disableGitFeatures": false } -} \ No newline at end of file +} diff --git a/websites/apidocs/docfx.classification.json b/websites/apidocs/docfx.classification.json index 0494da0927..9e7e94f897 100644 --- a/websites/apidocs/docfx.classification.json +++ b/websites/apidocs/docfx.classification.json @@ -15,19 +15,22 @@ ], "dest": "obj/docfx/api/classification", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } } ], "build": { - "content": [ + "content": [ { "files": [ "**.yml", "**.md" ], + "exclude": [ + "toc.yml" + ], "src": "obj/docfx/api/classification" - }, + }, { "files": [ "toc.yml", @@ -35,7 +38,7 @@ ], "src": "toc" } - ], + ], "overwrite": [ { "files": [ @@ -46,7 +49,7 @@ "exclude": [ "overview.md" ] - }, + }, { "files": [ "apiSpec/classification/**/*.md" @@ -66,11 +69,13 @@ "Templates/LuceneTemplate", "Templates/LuceneApiDocs" ], - "postProcessors": [], + "postProcessors": [ + "AggregatePostProcessor" + ], "markdownEngineName": "dfm", "noLangKeyword": false, "keepFileLink": false, "cleanupCacheHistory": false, "disableGitFeatures": false } -} \ No newline at end of file +} diff --git a/websites/apidocs/docfx.codecs.json b/websites/apidocs/docfx.codecs.json index 3c530bb97c..e7de71f605 100644 --- a/websites/apidocs/docfx.codecs.json +++ b/websites/apidocs/docfx.codecs.json @@ -15,25 +15,28 @@ ], "dest": "obj/docfx/api/codecs", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } } ], "build": { - "content": [ + "content": [ { "files": [ "overview.md" ], "src": "../../src/Lucene.Net.Codecs" - }, + }, { "files": [ "**.yml", "**.md" ], + "exclude": [ + "toc.yml" + ], "src": "obj/docfx/api/codecs" - }, + }, { "files": [ "toc.yml", @@ -41,7 +44,7 @@ ], "src": "toc" } - ], + ], "overwrite": [ { "files": [ @@ -52,7 +55,7 @@ "exclude": [ "overview.md" ] - }, + }, { "files": [ "apiSpec/codecs/**/*.md" @@ -72,11 +75,13 @@ "Templates/LuceneTemplate", "Templates/LuceneApiDocs" ], - "postProcessors": [], + "postProcessors": [ + "AggregatePostProcessor" + ], "markdownEngineName": "dfm", "noLangKeyword": false, "keepFileLink": false, "cleanupCacheHistory": false, "disableGitFeatures": false } -} \ No newline at end of file +} diff --git a/websites/apidocs/docfx.core.json b/websites/apidocs/docfx.core.json index 17f090ee81..e1ba623ed5 100644 --- a/websites/apidocs/docfx.core.json +++ b/websites/apidocs/docfx.core.json @@ -15,7 +15,7 @@ ], "dest": "obj/docfx/api/core", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } } ], @@ -33,6 +33,9 @@ "**.yml", "**.md" ], + "exclude": [ + "toc.yml" + ], "src": "obj/docfx/api/core" }, { @@ -48,8 +51,8 @@ ], "src": "../../src/dotnet/docs" } - ], - "overwrite": [ + ], + "overwrite": [ { "files": [ "**/package.md", @@ -59,7 +62,7 @@ "exclude": [ "overview.md" ] - }, + }, { "files": [ "apiSpec/core/**/*.md" @@ -67,7 +70,9 @@ } ], "xref": [ - "_site/api/codecs/xrefmap.yml" + "_site/api/codecs/xrefmap.yml", + "_site/api/analysis-common/xrefmap.yml", + "https://learn.microsoft.com/en-us/dotnet/.xrefmap.json" ], "dest": "_site/api/core", "globalMetadataFiles": [ @@ -79,11 +84,13 @@ "Templates/LuceneTemplate", "Templates/LuceneApiDocs" ], - "postProcessors": [], + "postProcessors": [ + "AggregatePostProcessor" + ], "markdownEngineName": "dfm", "noLangKeyword": false, "keepFileLink": false, "cleanupCacheHistory": false, "disableGitFeatures": false } -} \ No newline at end of file +} diff --git a/websites/apidocs/docfx.demo.json b/websites/apidocs/docfx.demo.json index 9387b01993..bf69b3daa9 100644 --- a/websites/apidocs/docfx.demo.json +++ b/websites/apidocs/docfx.demo.json @@ -15,19 +15,22 @@ ], "dest": "obj/docfx/api/demo", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } } ], "build": { - "content": [ + "content": [ { "files": [ "**.yml", "**.md" ], + "exclude": [ + "toc.yml" + ], "src": "obj/docfx/api/demo" - }, + }, { "files": [ "toc.yml", @@ -35,8 +38,8 @@ ], "src": "toc" } - ], - "overwrite": [ + ], + "overwrite": [ { "files": [ "**/package.md", @@ -46,7 +49,7 @@ "exclude": [ "package.md" ] - }, + }, { "files": [ "apiSpec/demo/**/*.md" @@ -54,7 +57,9 @@ } ], "xref": [ - "_site/api/core/xrefmap.yml" + "_site/api/core/xrefmap.yml", + "_site/api/queryparser/xrefmap.yml", + "_site/api/analysis-common/xrefmap.yml" ], "dest": "_site/api/demo", "globalMetadataFiles": [ @@ -66,11 +71,13 @@ "Templates/LuceneTemplate", "Templates/LuceneApiDocs" ], - "postProcessors": [], + "postProcessors": [ + "AggregatePostProcessor" + ], "markdownEngineName": "dfm", "noLangKeyword": false, "keepFileLink": false, "cleanupCacheHistory": false, "disableGitFeatures": false } -} \ No newline at end of file +} diff --git a/websites/apidocs/docfx.expressions.json b/websites/apidocs/docfx.expressions.json index a505676a4a..da28b2222c 100644 --- a/websites/apidocs/docfx.expressions.json +++ b/websites/apidocs/docfx.expressions.json @@ -15,25 +15,28 @@ ], "dest": "obj/docfx/api/expressions", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } } ], "build": { - "content": [ + "content": [ { "files": [ "overview.md" ], "src": "../../src/Lucene.Net.Expressions" - }, + }, { "files": [ "**.yml", "**.md" ], + "exclude": [ + "toc.yml" + ], "src": "obj/docfx/api/expressions" - }, + }, { "files": [ "toc.yml", @@ -41,8 +44,8 @@ ], "src": "toc" } - ], - "overwrite": [ + ], + "overwrite": [ { "files": [ "**/package.md", @@ -52,7 +55,7 @@ "exclude": [ "overview.md" ] - }, + }, { "files": [ "apiSpec/expressions/**/*.md" @@ -72,11 +75,13 @@ "Templates/LuceneTemplate", "Templates/LuceneApiDocs" ], - "postProcessors": [], + "postProcessors": [ + "AggregatePostProcessor" + ], "markdownEngineName": "dfm", "noLangKeyword": false, "keepFileLink": false, "cleanupCacheHistory": false, "disableGitFeatures": false } -} \ No newline at end of file +} diff --git a/websites/apidocs/docfx.facet.json b/websites/apidocs/docfx.facet.json index 401c9521cf..26dee3514e 100644 --- a/websites/apidocs/docfx.facet.json +++ b/websites/apidocs/docfx.facet.json @@ -15,25 +15,28 @@ ], "dest": "obj/docfx/api/facet", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } } ], "build": { - "content": [ + "content": [ { "files": [ "package.md" ], "src": "../../src/Lucene.Net.Facet" - }, + }, { "files": [ "**.yml", "**.md" ], + "exclude": [ + "toc.yml" + ], "src": "obj/docfx/api/facet" - }, + }, { "files": [ "toc.yml", @@ -41,8 +44,8 @@ ], "src": "toc" } - ], - "overwrite": [ + ], + "overwrite": [ { "files": [ "**/package.md", @@ -52,7 +55,7 @@ "exclude": [ "package.md" ] - }, + }, { "files": [ "apiSpec/facet/**/*.md" @@ -72,11 +75,13 @@ "Templates/LuceneTemplate", "Templates/LuceneApiDocs" ], - "postProcessors": [], + "postProcessors": [ + "AggregatePostProcessor" + ], "markdownEngineName": "dfm", "noLangKeyword": false, "keepFileLink": false, "cleanupCacheHistory": false, "disableGitFeatures": false } -} \ No newline at end of file +} diff --git a/websites/apidocs/docfx.global.json b/websites/apidocs/docfx.global.json index b46149ea1b..d27732fdab 100644 --- a/websites/apidocs/docfx.global.json +++ b/websites/apidocs/docfx.global.json @@ -1,15 +1,10 @@ { - "_appTitle": "Apache Lucene.NET 4.8.0-beta00016 Documentation", - "_disableContribution": false, - "_appFaviconPath": "logo/favicon.ico", - "_enableSearch": true, - "_appLogoPath": "logo/lucene-net-color.png", - "_appFooter": "Copyright \u0026copy; 2022 The Apache Software Foundation, Licensed under the \u003ca href=\u0027http://www.apache.org/licenses/LICENSE-2.0\u0027 target=\u0027_blank\u0027\u003eApache License, Version 2.0\u003c/a\u003e\u003cbr/\u003e \u003csmall\u003eApache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation. \u003cbr/\u003eAll other marks mentioned may be trademarks or registered trademarks of their respective owners.\u003c/small\u003e", - "_gitContribute": { - "repo": "https://github.com/apache/lucenenet", - "branch": "docs/4.8.0-beta00016", - "apiSpecFolder": "websites/apidocs/apiSpec", - "tag": "Lucene.Net_4_8_0_beta00016" - }, - "_gitSource": "https://github.com/apache/lucenenet.git" + "_appTitle": "Apache Lucene.NET 4.8.0-ci Documentation", + "_disableContribution": false, + "_appFaviconPath": "logo/favicon.ico", + "_enableSearch": true, + "_appLogoPath": "logo/lucene-net-color.png", + "_appFooter": "Copyright © 2024 The Apache Software Foundation, Licensed under the Apache License, Version 2.0
Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation.
All other marks mentioned may be trademarks or registered trademarks of their respective owners.", + "_gitSource": "https://github.com/apache/lucenenet.git", + "_luceneNetRel": "http://localhost:8080/" } diff --git a/websites/apidocs/docfx.global.subsite.json b/websites/apidocs/docfx.global.subsite.json index 6cf6b985f1..89299bfa08 100644 --- a/websites/apidocs/docfx.global.subsite.json +++ b/websites/apidocs/docfx.global.subsite.json @@ -1,4 +1,4 @@ { - "_rel": "https://lucenenet.apache.org/docs/4.8.0-beta00009/", - "_api": "https://lucenenet.apache.org/docs/4.8.0-beta00016/" + "_api": "https://lucenenet.apache.org/docs/4.8.0-ci/" } + diff --git a/websites/apidocs/docfx.grouping.json b/websites/apidocs/docfx.grouping.json index 9c7fa00341..f3b7f0f607 100644 --- a/websites/apidocs/docfx.grouping.json +++ b/websites/apidocs/docfx.grouping.json @@ -15,25 +15,28 @@ ], "dest": "obj/docfx/api/grouping", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } } ], "build": { - "content": [ + "content": [ { "files": [ "package.md" ], "src": "../../src/Lucene.Net.Grouping" - }, + }, { "files": [ "**.yml", "**.md" ], + "exclude": [ + "toc.yml" + ], "src": "obj/docfx/api/grouping" - }, + }, { "files": [ "toc.yml", @@ -41,8 +44,8 @@ ], "src": "toc" } - ], - "overwrite": [ + ], + "overwrite": [ { "files": [ "**/package.md", @@ -52,7 +55,7 @@ "exclude": [ "package.md" ] - }, + }, { "files": [ "apiSpec/grouping/**/*.md" @@ -72,11 +75,13 @@ "Templates/LuceneTemplate", "Templates/LuceneApiDocs" ], - "postProcessors": [], + "postProcessors": [ + "AggregatePostProcessor" + ], "markdownEngineName": "dfm", "noLangKeyword": false, "keepFileLink": false, "cleanupCacheHistory": false, "disableGitFeatures": false } -} \ No newline at end of file +} diff --git a/websites/apidocs/docfx.highlighter.json b/websites/apidocs/docfx.highlighter.json index a1911531ff..86956b4382 100644 --- a/websites/apidocs/docfx.highlighter.json +++ b/websites/apidocs/docfx.highlighter.json @@ -15,12 +15,12 @@ ], "dest": "obj/docfx/api/highlighter", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } } ], "build": { - "content": [ + "content": [ { "files": [ "overview.md" @@ -32,8 +32,11 @@ "**.yml", "**.md" ], + "exclude": [ + "toc.yml" + ], "src": "obj/docfx/api/highlighter" - }, + }, { "files": [ "toc.yml", @@ -41,8 +44,8 @@ ], "src": "toc" } - ], - "overwrite": [ + ], + "overwrite": [ { "files": [ "**/package.md", @@ -52,7 +55,7 @@ "exclude": [ "overview.md" ] - }, + }, { "files": [ "apiSpec/highlighter/**/*.md" @@ -60,7 +63,8 @@ } ], "xref": [ - "_site/api/core/xrefmap.yml" + "_site/api/core/xrefmap.yml", + "_site/api/icu/xrefmap.yml" ], "dest": "_site/api/highlighter", "globalMetadataFiles": [ @@ -72,11 +76,13 @@ "Templates/LuceneTemplate", "Templates/LuceneApiDocs" ], - "postProcessors": [], + "postProcessors": [ + "AggregatePostProcessor" + ], "markdownEngineName": "dfm", "noLangKeyword": false, "keepFileLink": false, "cleanupCacheHistory": false, "disableGitFeatures": false } -} \ No newline at end of file +} diff --git a/websites/apidocs/docfx.icu.json b/websites/apidocs/docfx.icu.json index 2049a534c3..22426c15f0 100644 --- a/websites/apidocs/docfx.icu.json +++ b/websites/apidocs/docfx.icu.json @@ -15,7 +15,7 @@ ], "dest": "obj/docfx/api/icu", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } } ], @@ -32,8 +32,11 @@ "**.yml", "**.md" ], + "exclude": [ + "toc.yml" + ], "src": "obj/docfx/api/icu" - }, + }, { "files": [ "toc.yml", @@ -41,7 +44,7 @@ ], "src": "toc" } - ], + ], "overwrite": [ { "files": [ @@ -52,7 +55,7 @@ "exclude": [ "package.md" ] - }, + }, { "files": [ "apiSpec/icu/**/*.md" @@ -60,7 +63,8 @@ } ], "xref": [ - "_site/api/core/xrefmap.yml" + "_site/api/core/xrefmap.yml", + "_site/api/analysis-common/xrefmap.yml" ], "dest": "_site/api/icu", "globalMetadataFiles": [ @@ -72,11 +76,13 @@ "Templates/LuceneTemplate", "Templates/LuceneApiDocs" ], - "postProcessors": [], + "postProcessors": [ + "AggregatePostProcessor" + ], "markdownEngineName": "dfm", "noLangKeyword": false, "keepFileLink": false, "cleanupCacheHistory": false, "disableGitFeatures": false } -} \ No newline at end of file +} diff --git a/websites/apidocs/docfx.join.json b/websites/apidocs/docfx.join.json index 8ce0f4a746..81b4b55a14 100644 --- a/websites/apidocs/docfx.join.json +++ b/websites/apidocs/docfx.join.json @@ -15,7 +15,7 @@ ], "dest": "obj/docfx/api/join", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } } ], @@ -26,14 +26,17 @@ "package.md" ], "src": "../../src/Lucene.Net.Join" - }, + }, { "files": [ "**.yml", "**.md" ], + "exclude": [ + "toc.yml" + ], "src": "obj/docfx/api/join" - }, + }, { "files": [ "toc.yml", @@ -41,8 +44,8 @@ ], "src": "toc" } - ], - "overwrite": [ + ], + "overwrite": [ { "files": [ "**/package.md", @@ -52,7 +55,7 @@ "exclude": [ "package.md" ] - }, + }, { "files": [ "apiSpec/join/**/*.md" @@ -72,11 +75,13 @@ "Templates/LuceneTemplate", "Templates/LuceneApiDocs" ], - "postProcessors": [], + "postProcessors": [ + "AggregatePostProcessor" + ], "markdownEngineName": "dfm", "noLangKeyword": false, "keepFileLink": false, "cleanupCacheHistory": false, "disableGitFeatures": false } -} \ No newline at end of file +} diff --git a/websites/apidocs/docfx.json b/websites/apidocs/docfx.json index 3a2bad07fc..dc6c94c254 100644 --- a/websites/apidocs/docfx.json +++ b/websites/apidocs/docfx.json @@ -16,7 +16,7 @@ ], "dest": "obj/docfx/api/Lucene.Net", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } }, { @@ -35,7 +35,7 @@ ], "dest": "obj/docfx/api/Lucene.Net.Analysis.Common", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } }, { @@ -54,7 +54,7 @@ ], "dest": "obj/docfx/api/Lucene.Net.Analysis.Kuromoji", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } }, { @@ -73,7 +73,7 @@ ], "dest": "obj/docfx/api/Lucene.Net.Analysis.Morfologik", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } }, { @@ -92,7 +92,7 @@ ], "dest": "obj/docfx/api/Lucene.Net.Analysis.OpenNLP", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } }, { @@ -111,7 +111,7 @@ ], "dest": "obj/docfx/api/Lucene.Net.Analysis.Phonetic", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } }, { @@ -130,7 +130,7 @@ ], "dest": "obj/docfx/api/Lucene.Net.Analysis.SmartCn", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } }, { @@ -149,7 +149,7 @@ ], "dest": "obj/docfx/api/Lucene.Net.Analysis.Stempel", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } }, { @@ -168,7 +168,7 @@ ], "dest": "obj/docfx/api/Lucene.Net.Benchmarks", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } }, { @@ -187,7 +187,7 @@ ], "dest": "obj/docfx/api/Lucene.Net.Classification", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } }, { @@ -206,7 +206,7 @@ ], "dest": "obj/docfx/api/Lucene.Net.Codecs", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } }, { @@ -225,7 +225,7 @@ ], "dest": "obj/docfx/api/Lucene.Net.Expressions", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } }, { @@ -244,7 +244,7 @@ ], "dest": "obj/docfx/api/Lucene.Net.Facet", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } }, { @@ -263,7 +263,7 @@ ], "dest": "obj/docfx/api/Lucene.Net.Grouping", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } }, { @@ -282,7 +282,7 @@ ], "dest": "obj/docfx/api/Lucene.Net.Highlighter", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } }, { @@ -301,7 +301,7 @@ ], "dest": "obj/docfx/api/Lucene.Net.ICU", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } }, { @@ -320,7 +320,7 @@ ], "dest": "obj/docfx/api/Lucene.Net.Join", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } }, { @@ -339,7 +339,7 @@ ], "dest": "obj/docfx/api/Lucene.Net.Memory", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } }, { @@ -358,7 +358,7 @@ ], "dest": "obj/docfx/api/Lucene.Net.Misc", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } }, { @@ -377,7 +377,7 @@ ], "dest": "obj/docfx/api/Lucene.Net.Queries", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } }, { @@ -396,7 +396,7 @@ ], "dest": "obj/docfx/api/Lucene.Net.QueryParser", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } }, { @@ -415,7 +415,7 @@ ], "dest": "obj/docfx/api/Lucene.Net.Replicator", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } }, { @@ -434,7 +434,7 @@ ], "dest": "obj/docfx/api/Lucene.Net.Sandbox", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } }, { @@ -453,7 +453,7 @@ ], "dest": "obj/docfx/api/Lucene.Net.Spatial", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } }, { @@ -472,7 +472,7 @@ ], "dest": "obj/docfx/api/Lucene.Net.Suggest", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } }, { @@ -490,7 +490,7 @@ ], "dest": "obj/docfx/api/Lucene.Net.TestFramework", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } }, { @@ -509,7 +509,7 @@ ], "dest": "obj/docfx/api/Lucene.Net.Demo", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } } ], @@ -582,12 +582,7 @@ "_appFaviconPath": "logo/favicon.ico", "_enableSearch": true, "_appLogoPath": "logo/lucene-net-color.png", - "_appFooter": "Copyright © 2020 The Apache Software Foundation, Licensed under the Apache License, Version 2.0
Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation.
All other marks mentioned may be trademarks or registered trademarks of their respective owners.", - "_gitContribute": { - "repo": "https://github.com/apache/lucenenet", - "branch": "docs/4.8.0-beta00008", - "apiSpecFolder": "websites/apidocs/apiSpec" - } + "_appFooter": "Copyright © 2020 The Apache Software Foundation, Licensed under the Apache License, Version 2.0
Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation.
All other marks mentioned may be trademarks or registered trademarks of their respective owners." }, "overwrite": [ { @@ -624,9 +619,9 @@ "fileMetadataFiles": [], "template": [ "default", - "LuceneTemplate" + "LuceneTemplate" ], - "postProcessors": [], + "postProcessors": ["AggregatePostProcessor"], "markdownEngineName": "dfm", "noLangKeyword": false, "keepFileLink": false, diff --git a/websites/apidocs/docfx.memory.json b/websites/apidocs/docfx.memory.json index 07908a8dd5..48ca268e52 100644 --- a/websites/apidocs/docfx.memory.json +++ b/websites/apidocs/docfx.memory.json @@ -15,19 +15,22 @@ ], "dest": "obj/docfx/api/memory", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } } ], "build": { - "content": [ + "content": [ { "files": [ "**.yml", "**.md" ], + "exclude": [ + "toc.yml" + ], "src": "obj/docfx/api/memory" - }, + }, { "files": [ "toc.yml", @@ -35,8 +38,8 @@ ], "src": "toc" } - ], - "overwrite": [ + ], + "overwrite": [ { "files": [ "**/package.md", @@ -46,7 +49,7 @@ "exclude": [ "overview.md" ] - }, + }, { "files": [ "apiSpec/memory/**/*.md" @@ -66,11 +69,13 @@ "Templates/LuceneTemplate", "Templates/LuceneApiDocs" ], - "postProcessors": [], + "postProcessors": [ + "AggregatePostProcessor" + ], "markdownEngineName": "dfm", "noLangKeyword": false, "keepFileLink": false, "cleanupCacheHistory": false, "disableGitFeatures": false } -} \ No newline at end of file +} diff --git a/websites/apidocs/docfx.misc.json b/websites/apidocs/docfx.misc.json index 09165167e1..f7cd8bd07b 100644 --- a/websites/apidocs/docfx.misc.json +++ b/websites/apidocs/docfx.misc.json @@ -15,19 +15,22 @@ ], "dest": "obj/docfx/api/misc", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } } ], "build": { - "content": [ + "content": [ { "files": [ "**.yml", "**.md" ], + "exclude": [ + "toc.yml" + ], "src": "obj/docfx/api/misc" - }, + }, { "files": [ "toc.yml", @@ -35,8 +38,8 @@ ], "src": "toc" } - ], - "overwrite": [ + ], + "overwrite": [ { "files": [ "**/package.md", @@ -46,7 +49,7 @@ "exclude": [ "package.md" ] - }, + }, { "files": [ "apiSpec/misc/**/*.md" @@ -66,11 +69,13 @@ "Templates/LuceneTemplate", "Templates/LuceneApiDocs" ], - "postProcessors": [], + "postProcessors": [ + "AggregatePostProcessor" + ], "markdownEngineName": "dfm", "noLangKeyword": false, "keepFileLink": false, "cleanupCacheHistory": false, "disableGitFeatures": false } -} \ No newline at end of file +} diff --git a/websites/apidocs/docfx.queries.json b/websites/apidocs/docfx.queries.json index 4566e4f787..3194fb1ee4 100644 --- a/websites/apidocs/docfx.queries.json +++ b/websites/apidocs/docfx.queries.json @@ -15,19 +15,22 @@ ], "dest": "obj/docfx/api/queries", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } } ], "build": { - "content": [ + "content": [ { "files": [ "**.yml", "**.md" ], + "exclude": [ + "toc.yml" + ], "src": "obj/docfx/api/queries" - }, + }, { "files": [ "toc.yml", @@ -35,8 +38,8 @@ ], "src": "toc" } - ], - "overwrite": [ + ], + "overwrite": [ { "files": [ "**/package.md", @@ -46,7 +49,7 @@ "exclude": [ "overview.md" ] - }, + }, { "files": [ "apiSpec/queries/**/*.md" @@ -66,11 +69,13 @@ "Templates/LuceneTemplate", "Templates/LuceneApiDocs" ], - "postProcessors": [], + "postProcessors": [ + "AggregatePostProcessor" + ], "markdownEngineName": "dfm", "noLangKeyword": false, "keepFileLink": false, "cleanupCacheHistory": false, "disableGitFeatures": false } -} \ No newline at end of file +} diff --git a/websites/apidocs/docfx.queryparser.json b/websites/apidocs/docfx.queryparser.json index 76096622a0..063ad735fd 100644 --- a/websites/apidocs/docfx.queryparser.json +++ b/websites/apidocs/docfx.queryparser.json @@ -15,25 +15,28 @@ ], "dest": "obj/docfx/api/queryparser", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } } ], "build": { - "content": [ + "content": [ { "files": [ "overview.md" ], "src": "../../src/Lucene.Net.QueryParser" - }, + }, { "files": [ "**.yml", "**.md" ], + "exclude": [ + "toc.yml" + ], "src": "obj/docfx/api/queryparser" - }, + }, { "files": [ "toc.yml", @@ -41,8 +44,8 @@ ], "src": "toc" } - ], - "overwrite": [ + ], + "overwrite": [ { "files": [ "**/package.md", @@ -52,7 +55,7 @@ "exclude": [ "overview.md" ] - }, + }, { "files": [ "apiSpec/queryparser/**/*.md" @@ -72,11 +75,13 @@ "Templates/LuceneTemplate", "Templates/LuceneApiDocs" ], - "postProcessors": [], + "postProcessors": [ + "AggregatePostProcessor" + ], "markdownEngineName": "dfm", "noLangKeyword": false, "keepFileLink": false, "cleanupCacheHistory": false, "disableGitFeatures": false } -} \ No newline at end of file +} diff --git a/websites/apidocs/docfx.replicator.json b/websites/apidocs/docfx.replicator.json index 1be897ae24..3d66dcb543 100644 --- a/websites/apidocs/docfx.replicator.json +++ b/websites/apidocs/docfx.replicator.json @@ -15,19 +15,22 @@ ], "dest": "obj/docfx/api/replicator", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } } ], "build": { - "content": [ + "content": [ { "files": [ "**.yml", "**.md" ], + "exclude": [ + "toc.yml" + ], "src": "obj/docfx/api/replicator" - }, + }, { "files": [ "toc.yml", @@ -35,8 +38,8 @@ ], "src": "toc" } - ], - "overwrite": [ + ], + "overwrite": [ { "files": [ "**/package.md", @@ -46,7 +49,7 @@ "exclude": [ "overview.md" ] - }, + }, { "files": [ "apiSpec/replicator/**/*.md" @@ -66,11 +69,13 @@ "Templates/LuceneTemplate", "Templates/LuceneApiDocs" ], - "postProcessors": [], + "postProcessors": [ + "AggregatePostProcessor" + ], "markdownEngineName": "dfm", "noLangKeyword": false, "keepFileLink": false, "cleanupCacheHistory": false, "disableGitFeatures": false } -} \ No newline at end of file +} diff --git a/websites/apidocs/docfx.sandbox.json b/websites/apidocs/docfx.sandbox.json index c6ce693dd5..ba4cc607e5 100644 --- a/websites/apidocs/docfx.sandbox.json +++ b/websites/apidocs/docfx.sandbox.json @@ -15,25 +15,28 @@ ], "dest": "obj/docfx/api/sandbox", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } } ], "build": { - "content": [ + "content": [ { "files": [ "overview.md" ], "src": "../../src/Lucene.Net.Sandbox" - }, + }, { "files": [ "**.yml", "**.md" ], + "exclude": [ + "toc.yml" + ], "src": "obj/docfx/api/sandbox" - }, + }, { "files": [ "toc.yml", @@ -41,8 +44,8 @@ ], "src": "toc" } - ], - "overwrite": [ + ], + "overwrite": [ { "files": [ "**/package.md", @@ -52,7 +55,7 @@ "exclude": [ "overview.md" ] - }, + }, { "files": [ "apiSpec/sandbox/**/*.md" @@ -72,11 +75,13 @@ "Templates/LuceneTemplate", "Templates/LuceneApiDocs" ], - "postProcessors": [], + "postProcessors": [ + "AggregatePostProcessor" + ], "markdownEngineName": "dfm", "noLangKeyword": false, "keepFileLink": false, "cleanupCacheHistory": false, "disableGitFeatures": false } -} \ No newline at end of file +} diff --git a/websites/apidocs/docfx.site.json b/websites/apidocs/docfx.site.json index 384446c6fb..aea6662448 100644 --- a/websites/apidocs/docfx.site.json +++ b/websites/apidocs/docfx.site.json @@ -1,4 +1,4 @@ -{ +{ "build": { "content": [ { @@ -44,7 +44,7 @@ "_site/api/grouping/xrefmap.yml", "_site/api/highlighter/xrefmap.yml", "_site/api/icu/xrefmap.yml", - "_site/api/join/xrefmap.yml", + "_site/api/join/xrefmap.yml", "_site/api/memory/xrefmap.yml", "_site/api/misc/xrefmap.yml", "_site/api/queries/xrefmap.yml", @@ -52,22 +52,25 @@ "_site/api/replicator/xrefmap.yml", "_site/api/sandbox/xrefmap.yml", "_site/api/spatial/xrefmap.yml", - "_site/api/suggest/xrefmap.yml", - "_site/api/test-framework/xrefmap.yml", + "_site/api/suggest/xrefmap.yml", "_site/api/demo/xrefmap.yml" ], "dest": "_site", - "globalMetadataFiles": ["docfx.global.json"], + "globalMetadataFiles": [ + "docfx.global.json" + ], "template": [ "default", "Templates/LuceneTemplate", "Templates/LuceneTemplateAssets" ], - "postProcessors": [], - "markdownEngineName": "dfm", + "postProcessors": [ + "ExtractSearchIndex", + "AggregatePostProcessor" + ], "noLangKeyword": false, "keepFileLink": false, "cleanupCacheHistory": false, "disableGitFeatures": false } -} \ No newline at end of file +} diff --git a/websites/apidocs/docfx.spatial.json b/websites/apidocs/docfx.spatial.json index 995bd9657c..db537f3a87 100644 --- a/websites/apidocs/docfx.spatial.json +++ b/websites/apidocs/docfx.spatial.json @@ -15,19 +15,22 @@ ], "dest": "obj/docfx/api/spatial", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } } ], "build": { - "content": [ + "content": [ { "files": [ "**.yml", "**.md" ], + "exclude": [ + "toc.yml" + ], "src": "obj/docfx/api/spatial" - }, + }, { "files": [ "toc.yml", @@ -35,8 +38,8 @@ ], "src": "toc" } - ], - "overwrite": [ + ], + "overwrite": [ { "files": [ "**/package.md", @@ -46,7 +49,7 @@ "exclude": [ "package.md" ] - }, + }, { "files": [ "apiSpec/spatial/**/*.md" @@ -66,11 +69,13 @@ "Templates/LuceneTemplate", "Templates/LuceneApiDocs" ], - "postProcessors": [], + "postProcessors": [ + "AggregatePostProcessor" + ], "markdownEngineName": "dfm", "noLangKeyword": false, "keepFileLink": false, "cleanupCacheHistory": false, "disableGitFeatures": false } -} \ No newline at end of file +} diff --git a/websites/apidocs/docfx.suggest.json b/websites/apidocs/docfx.suggest.json index 036cf7646c..7877d67cfc 100644 --- a/websites/apidocs/docfx.suggest.json +++ b/websites/apidocs/docfx.suggest.json @@ -15,25 +15,28 @@ ], "dest": "obj/docfx/api/suggest", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } } ], "build": { - "content": [ + "content": [ { "files": [ "overview.md" ], "src": "../../src/Lucene.Net.Suggest" - }, + }, { "files": [ "**.yml", "**.md" ], + "exclude": [ + "toc.yml" + ], "src": "obj/docfx/api/suggest" - }, + }, { "files": [ "toc.yml", @@ -41,8 +44,8 @@ ], "src": "toc" } - ], - "overwrite": [ + ], + "overwrite": [ { "files": [ "**/package.md", @@ -52,7 +55,7 @@ "exclude": [ "overview.md" ] - }, + }, { "files": [ "apiSpec/suggest/**/*.md" @@ -72,11 +75,13 @@ "Templates/LuceneTemplate", "Templates/LuceneApiDocs" ], - "postProcessors": [], + "postProcessors": [ + "AggregatePostProcessor" + ], "markdownEngineName": "dfm", "noLangKeyword": false, "keepFileLink": false, "cleanupCacheHistory": false, "disableGitFeatures": false } -} \ No newline at end of file +} diff --git a/websites/apidocs/docfx.test-framework.json b/websites/apidocs/docfx.test-framework.json index 2ad8e81072..02288bb7c8 100644 --- a/websites/apidocs/docfx.test-framework.json +++ b/websites/apidocs/docfx.test-framework.json @@ -14,8 +14,9 @@ } ], "dest": "obj/docfx/api/test-framework", + "filter": "filterConfig.yml", "properties": { - "TargetFramework": "netstandard2.0" + "TargetFramework": "net6.0" } } ], @@ -32,6 +33,9 @@ "**.yml", "**.md" ], + "exclude": [ + "toc.yml" + ], "src": "obj/docfx/api/test-framework" }, { @@ -41,8 +45,8 @@ ], "src": "toc" } - ], - "overwrite": [ + ], + "overwrite": [ { "files": [ "apiSpec/test-framework/**/*.md" @@ -59,11 +63,13 @@ "Templates/LuceneTemplate", "Templates/LuceneApiDocs" ], - "postProcessors": [], + "postProcessors": [ + "AggregatePostProcessor" + ], "markdownEngineName": "dfm", "noLangKeyword": false, "keepFileLink": false, "cleanupCacheHistory": false, "disableGitFeatures": false } -} \ No newline at end of file +} diff --git a/websites/apidocs/docs.ps1 b/websites/apidocs/docs.ps1 index 38728b50ab..9a3d094366 100644 --- a/websites/apidocs/docs.ps1 +++ b/websites/apidocs/docs.ps1 @@ -34,7 +34,7 @@ param ( [Parameter(Mandatory = $false)] [int] $StagingPort = 8080 ) -$MinimumSdkVersion = "3.1.100" # Minimum Required .NET SDK (must not be a pre-release) +$MinimumSdkVersion = "8.0.100" # Minimum Required .NET SDK (must not be a pre-release) $ErrorActionPreference = "Stop" @@ -57,35 +57,17 @@ $env:LuceneNetReleaseTag = $VCSLabel $PSScriptFilePath = (Get-Item $MyInvocation.MyCommand.Path).FullName $RepoRoot = (get-item $PSScriptFilePath).Directory.Parent.Parent.FullName; $ApiDocsFolder = Join-Path -Path $RepoRoot -ChildPath "websites\apidocs"; -$ToolsFolder = Join-Path -Path $ApiDocsFolder -ChildPath "tools"; $CliIndexPath = Join-Path -Path $RepoRoot -ChildPath "src\dotnet\tools\lucene-cli\docs\index.md"; $TocPath1 = Join-Path -Path $ApiDocsFolder -ChildPath "toc.yml" $TocPath2 = Join-Path -Path $ApiDocsFolder -ChildPath "toc\toc.yml" $BreadcrumbPath = Join-Path -Path $ApiDocsFolder -ChildPath "docfx.global.subsite.json" -#ensure the /build/tools folder -New-Item $ToolsFolder -type directory -force - -if ($Clean) { - Write-Host "Cleaning tools..." - Remove-Item (Join-Path -Path $ToolsFolder "\*") -recurse -force -ErrorAction SilentlyContinue -} - -New-Item "$ToolsFolder\tmp" -type directory -force - -# Go get docfx.exe if we don't have it -New-Item "$ToolsFolder\docfx" -type directory -force -$DocFxExe = "$ToolsFolder\docfx\docfx.exe" -if (-not (test-path $DocFxExe)) { - Write-Host "Retrieving docfx..." - $DocFxZip = "$ToolsFolder\tmp\docfx.zip" - Invoke-WebRequest "https://github.com/dotnet/docfx/releases/download/v2.58/docfx.zip" -OutFile $DocFxZip -TimeoutSec 60 - - #unzip - Expand-Archive $DocFxZip -DestinationPath (Join-Path -Path $ToolsFolder -ChildPath "docfx") -} - -Remove-Item -Recurse -Force "$ToolsFolder\tmp" +# install docfx tool +Write-Host "Restoring docfx tool..." +$PreviousLocation = Get-Location +Set-Location $RepoRoot +dotnet tool restore +Set-Location $PreviousLocation # delete anything that already exists if ($Clean) { @@ -124,11 +106,12 @@ $DocFxGlobalJson = Join-Path -Path $ApiDocsFolder "docfx.global.json" $DocFxJsonContent = Get-Content $DocFxGlobalJson | ConvertFrom-Json $DocFxJsonContent._appFooter = "Copyright © $((Get-Date).Year) The Apache Software Foundation, Licensed under the Apache License, Version 2.0
Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation.
All other marks mentioned may be trademarks or registered trademarks of their respective owners." $DocFxJsonContent._appTitle = "Apache Lucene.NET $LuceneNetVersion Documentation" -$DocFxJsonContent._gitContribute.branch = "docs/$LuceneNetVersion" -$DocFxJsonContent._gitContribute.tag = "$VCSLabel" +$DocFxJsonContent._luceneNetRel = $BaseUrl + "/" $DocFxJsonContent | ConvertTo-Json -depth 100 | Set-Content $DocFxGlobalJson # NOTE: The order of these depends on if one of the projects requries the xref map of another, normally all require the core xref map +# Some might also be duplicated; this is intentional - do not remove duplicates! +# This is because of circular dependencies between projects' xref maps. $DocFxJsonMeta = @( "docfx.codecs.json", "docfx.core.json", @@ -144,8 +127,8 @@ $DocFxJsonMeta = @( "docfx.expressions.json", "docfx.facet.json", "docfx.grouping.json", - "docfx.highlighter.json", "docfx.icu.json", + "docfx.highlighter.json", "docfx.join.json", "docfx.memory.json", "docfx.misc.json", @@ -156,7 +139,10 @@ $DocFxJsonMeta = @( "docfx.spatial.json", "docfx.suggest.json", "docfx.test-framework.json", - "docfx.demo.json" + "docfx.demo.json", + # intentional duplicates + "docfx.codecs.json", + "docfx.core.json" ) $DocFxJsonSite = Join-Path -Path $ApiDocsFolder "docfx.site.json" @@ -168,19 +154,15 @@ if ($? -and $DisableMetaData -eq $false) { # build the output Write-Host "Building api metadata for $projFile..." - - if ($Clean) { - & $DocFxExe metadata $projFile --log "$DocFxLog" --loglevel $LogLevel --force - } - else { - & $DocFxExe metadata $projFile --log "$DocFxLog" --loglevel $LogLevel - } + & dotnet tool run docfx metadata $projFile --log "$DocFxLog" --logLevel $LogLevel } } if ($? -and $DisableBuild -eq $false) { - # HACK: DocFx doesn't seem to work with fenced code blocks, so we update the lucene-cli index file manually. - # Note it works better this way anyway because we can store a real version number in the file in the repo. + # Update the lucene-cli docs `--version` argument to match the current version. + # This is to strike a balance between having the file have a real version number in source control + # and not having to remember to update the version in that file every time we release. + # Do not commit this change to the file unless you are doing a real version release. (Get-Content -Path $CliIndexPath -Raw) -Replace '(?<=--version\s)\d+?\.\d+?\.\d+?(?:\.\d+?)?(?:-\w+)?', $LuceneNetVersion | Set-Content -Path $CliIndexPath # Update our TOC to the latest LuceneNetVersion @@ -196,23 +178,11 @@ if ($? -and $DisableBuild -eq $false) { $DocFxLog = Join-Path -Path $ApiDocsFolder "obj\${proj}.build.log" + Start-Sleep -Seconds 1 + # build the output Write-Host "Building site output for $projFile..." - - # Specifying --force, --forcePostProcess and --cleanupCacheHistory - # seems to be required in order for all xref links to resolve consistently across - # all of the docfx builds (see https://dotnet.github.io/docfx/RELEASENOTE.html?tabs=csharp). - # Previously we used to do this: - # Remove-Item (Join-Path -Path $ApiDocsFolder "obj\.cache") -recurse -force -ErrorAction SilentlyContinue - # to force remove the cache else the xref's wouldn't work correctly. So far with these new parameters - # it seems much happier. - - if ($Clean) { - & $DocFxExe build $projFile --log "$DocFxLog" --loglevel $LogLevel --force --debug --cleanupCacheHistory --force --forcePostProcess - } - else { - & $DocFxExe build $projFile --log "$DocFxLog" --loglevel $LogLevel --debug --cleanupCacheHistory --force --forcePostProcess - } + & dotnet tool run docfx build $projFile --log "$DocFxLog" --logLevel $LogLevel --debug --maxParallelism 1 # Add the baseUrl to the output xrefmap, see https://github.com/dotnet/docfx/issues/2346#issuecomment-356054027 $projFileJson = Get-Content $projFile | ConvertFrom-Json @@ -228,29 +198,18 @@ if ($? -and $DisableBuild -eq $false) { } if ($?) { - - # Before we build the site we have to clear the frickin docfx cache! - # else the xref links don't work on the home page. That is crazy. - Remove-Item (Join-Path -Path $ApiDocsFolder "obj\.cache") -recurse -force -ErrorAction SilentlyContinue - $DocFxLog = Join-Path -Path $ApiDocsFolder "obj\docfx.site.json.log" if ($ServeDocs -eq $false) { # build the output Write-Host "Building docs..." - - if ($Clean) { - & $DocFxExe $DocFxJsonSite --log "$DocFxLog" --loglevel $LogLevel --force --debug - } - else { - & $DocFxExe $DocFxJsonSite --log "$DocFxLog" --loglevel $LogLevel --debug - } + & dotnet tool run docfx $DocFxJsonSite --log "$DocFxLog" --logLevel $LogLevel --debug --maxParallelism 1 } else { # build + serve (for testing) Write-Host "starting website..." - & $DocFxExe $DocFxJsonSite --log "$DocFxLog" --loglevel $LogLevel --serve --port $StagingPort --debug + & dotnet tool run docfx $DocFxJsonSite --log "$DocFxLog" --logLevel $LogLevel --serve --port $StagingPort --debug --maxParallelism 1 } } @@ -258,4 +217,4 @@ if ($?) { # and then many of these params can be excluded from the json file # .\docfx.exe ..\..\docfx.core.json --globalMetadataFiles docfx.global.json --output _TEST --serve --force --loglevel Warning -# docfx.exe --output TARGET --globalMetadataFiles docfx.global.json Warning \ No newline at end of file +# docfx.exe --output TARGET --globalMetadataFiles docfx.global.json Warning diff --git a/websites/apidocs/filterConfig.yml b/websites/apidocs/filterConfig.yml index 4a7b065758..02b8657ab1 100644 --- a/websites/apidocs/filterConfig.yml +++ b/websites/apidocs/filterConfig.yml @@ -4,4 +4,4 @@ apiRules: type: Field - exclude: uidRegex: ^Lucene\.Net\.Test$ - type: Namespace \ No newline at end of file + type: Namespace diff --git a/websites/apidocs/index.md b/websites/apidocs/index.md index d0ebe9e52d..0bf649c3f9 100644 --- a/websites/apidocs/index.md +++ b/websites/apidocs/index.md @@ -3,16 +3,16 @@ title: Lucene.Net Docs - The documentation website for Lucene.NET description: The documentation website for Lucene.NET --- -Apache Lucene.Net Documentation +Apache Lucene.Net EnvVar:LuceneNetVersion Documentation =============== --------------- -Lucene.NET is a _.NET full-text search engine_. Lucene.NET is not a complete application, +Lucene.NET is a _.NET full-text search engine_. Lucene.NET is not a complete application, but rather a code library and API that can easily be used to add search capabilities to applications. -This is the official API documentation for __Apache Lucene.NET __. +This is the official API documentation for __Apache Lucene.NET EnvVar:LuceneNetVersion__. ## Getting Started @@ -29,8 +29,8 @@ on some of the conceptual or inner details of Lucene: ## Reference Documents -- [Changes](https://github.com/apache/lucenenet/releases/tag/[EnvVar:LuceneNetReleaseTag]): List of changes in this release. +- [Changes](https://github.com/apache/lucenenet/releases/tag/EnvVar:LuceneNetReleaseTag): List of changes in this release. - [Migration Guide](xref:Lucene.Net.Migration.Guide): What changed in Lucene 4; how to migrate code from Lucene 3.x. - [Source Stepping](xref:source-stepping): How to use the Visual Studio debugger to step into Lucene.NET source code. - [File Formats](xref:Lucene.Net.Codecs.Lucene46): Guide to the supported index format used by Lucene. This can be customized by using [an alternate codec](xref:Lucene.Net.Codecs). @@ -40,6 +40,9 @@ on some of the conceptual or inner details of Lucene: ## Libraries + + - - Core library - - Analyzers for indexing content in different languages and domains - [Lucene.Net.Analysis.Kuromoji](xref:Lucene.Net.Analysis.Ja) - Japanese Morphological Analyzer @@ -65,7 +68,7 @@ on some of the conceptual or inner details of Lucene: - - Various third party contributions and new ideas - [Lucene.Net.Spatial](xref:Lucene.Net.Spatial) - Geospatial search - - Auto-suggest and Spell-checking support -- - Framework for testing Lucene-based applications +- [Lucene.Net.TestFramework](api/test-framework/overview.html) - Framework for testing Lucene-based applications ### Tools diff --git a/websites/apidocs/toc.yml b/websites/apidocs/toc.yml index 446bef5a3d..557f9860db 100644 --- a/websites/apidocs/toc.yml +++ b/websites/apidocs/toc.yml @@ -1,7 +1,9 @@ -- name: Lucene.Net API - topicHref: https://lucenenet.apache.org/docs/4.8.0-beta00016/ +items: +- name: Lucene.Net API + topicHref: https://lucenenet.apache.org/docs/4.8.0-ci/ - name: Lucene.Net CLI href: ../../src/dotnet/tools/lucene-cli/docs/ topicHref: ../../src/dotnet/tools/lucene-cli/docs/index.md - name: Lucene.Net Website href: https://lucenenet.apache.org/ + diff --git a/websites/apidocs/toc/toc.yml b/websites/apidocs/toc/toc.yml index f4c7b8d969..62a5be11fd 100644 --- a/websites/apidocs/toc/toc.yml +++ b/websites/apidocs/toc/toc.yml @@ -1,6 +1,8 @@ -- name: Lucene.Net API - topicHref: https://lucenenet.apache.org/docs/4.8.0-beta00016 +items: +- name: Lucene.Net API + topicHref: https://lucenenet.apache.org/docs/4.8.0-ci - name: Lucene.Net CLI - topicHref: https://lucenenet.apache.org/docs/4.8.0-beta00016/cli/index.html + topicHref: https://lucenenet.apache.org/docs/4.8.0-ci/cli/index.html - name: Lucene.Net Website topicHref: https://lucenenet.apache.org/ + diff --git a/websites/site/docfx.json b/websites/site/docfx.json index 2fe7086826..6338c8d5a4 100644 --- a/websites/site/docfx.json +++ b/websites/site/docfx.json @@ -53,10 +53,9 @@ "lucenetemplate" ], "postProcessors": [], - "markdownEngineName": "markdig", "noLangKeyword": false, "keepFileLink": false, "cleanupCacheHistory": false, "disableGitFeatures": false } -} \ No newline at end of file +} diff --git a/websites/site/lucenetemplate/partials/head-content.tmpl.partial b/websites/site/lucenetemplate/partials/head-content.tmpl.partial index e95c2d62bd..e63c0b4817 100644 --- a/websites/site/lucenetemplate/partials/head-content.tmpl.partial +++ b/websites/site/lucenetemplate/partials/head-content.tmpl.partial @@ -9,7 +9,7 @@ {{#_description}}{{/_description}} - + @@ -17,11 +17,11 @@ {{#_noindex}}{{/_noindex}} {{#_enableSearch}}{{/_enableSearch}} {{#_enableNewTab}}{{/_enableNewTab}} - + - + - \ No newline at end of file + diff --git a/websites/site/lucenetemplate/partials/head.tmpl.partial b/websites/site/lucenetemplate/partials/head.tmpl.partial index 2a02a275dc..dfe3e4e724 100644 --- a/websites/site/lucenetemplate/partials/head.tmpl.partial +++ b/websites/site/lucenetemplate/partials/head.tmpl.partial @@ -9,7 +9,7 @@ {{#_description}}{{/_description}} - + diff --git a/websites/site/site.ps1 b/websites/site/site.ps1 index 241ebbb029..749d5c53c8 100644 --- a/websites/site/site.ps1 +++ b/websites/site/site.ps1 @@ -43,21 +43,11 @@ if ($Clean) { Remove-Item (Join-Path -Path $ToolsFolder "\*") -recurse -force -ErrorAction SilentlyContinue } -New-Item "$ToolsFolder\tmp" -type directory -force - -# Go get docfx.exe if we don't have it -New-Item "$ToolsFolder\docfx" -type directory -force -$DocFxExe = "$ToolsFolder\docfx\docfx.exe" -if (-not (test-path $DocFxExe)) -{ - Write-Host "Retrieving docfx..." - $DocFxZip = "$ToolsFolder\tmp\docfx.zip" - Invoke-WebRequest "https://github.com/dotnet/docfx/releases/download/v2.58/docfx.zip" -OutFile $DocFxZip -TimeoutSec 60 - #unzip - Expand-Archive $DocFxZip -DestinationPath (Join-Path -Path $ToolsFolder -ChildPath "docfx") -} - - Remove-Item -Recurse -Force "$ToolsFolder\tmp" +# install docfx tool +$PreviousLocation = Get-Location +Set-Location $RepoRoot +dotnet tool restore +Set-Location $PreviousLocation # delete anything that already exists if ($Clean) { @@ -75,11 +65,11 @@ if($?) { if ($ServeDocs -eq $false) { # build the output Write-Host "Building docs..." - & $DocFxExe build $DocFxJson -l "$DocFxLog" --loglevel $LogLevel + & dotnet tool run docfx build $DocFxJson -l "$DocFxLog" --logLevel $LogLevel } else { # build + serve (for testing) Write-Host "starting website..." - & $DocFxExe $DocFxJson --serve --port $StagingPort + & dotnet tool run docfx $DocFxJson --serve --port $StagingPort } -} \ No newline at end of file +}