Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Jul 22, 2024
1 parent be0f3b2 commit dec93de
Show file tree
Hide file tree
Showing 1,411 changed files with 3,234 additions and 2,298 deletions.
Binary file modified docs/Documentation.chm
Binary file not shown.
52 changes: 26 additions & 26 deletions docs/LastBuild.log
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<shfbBuild product="Sandcastle Help File Builder and Tools" version="2023.3.4.0" projectFile="D:\a\NanoXLSX\NanoXLSX\Documentation\CodeDocumentation.shfbproj" started="7/22/2024 8:38:31 PM">
<shfbBuild product="Sandcastle Help File Builder and Tools" version="2023.3.4.0" projectFile="D:\a\NanoXLSX\NanoXLSX\Documentation\CodeDocumentation.shfbproj" started="7/22/2024 8:56:42 PM">
<buildStep step="Initializing">
The Sandcastle tools are located in &#39;C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder&#39;
Locating components in the following folder(s):
Expand Down Expand Up @@ -29,18 +29,18 @@ Copying XML comments files
<buildStep step="GenerateSharedContent">
Generating shared content files (en-US, English (United States))...
<plugIn name="Lightweight Website Style" behavior="After" priority="1000">
</plugIn> Last step completed in 00:00:00.4541
</plugIn> Last step completed in 00:00:00.2969
</buildStep>
<buildStep step="GenerateApiFilter">
Generating API filter for MRefBuilder...
Last step completed in 00:00:00.3281
Last step completed in 00:00:00.1875
</buildStep>
<buildStep step="GenerateReflectionInfo">
Generating reflection information...
[C:\Program Files\Microsoft Visual Studio\2022\Enterprise\MSBuild\Current\Bin\MSBuild.exe - GenerateRefInfo-b4455b3c-7b92-4040-a0ed-35723e0f6857.proj]
Build started 7/22/2024 8:38:54 PM.
[C:\Program Files\Microsoft Visual Studio\2022\Enterprise\MSBuild\Current\Bin\MSBuild.exe - GenerateRefInfo-a135de11-55ee-4230-92af-4762457252cb.proj]
Build started 7/22/2024 8:56:54 PM.

Project &quot;D:\a\NanoXLSX\NanoXLSX\docs\Working\GenerateRefInfo-b4455b3c-7b92-4040-a0ed-35723e0f6857.proj&quot; on node 1 (default targets).
Project &quot;D:\a\NanoXLSX\NanoXLSX\docs\Working\GenerateRefInfo-a135de11-55ee-4230-92af-4762457252cb.proj&quot; on node 1 (default targets).
PrepareForBuild:
Creating directory &quot;obj\Debug\&quot;.
GenerateRefInfo:
Expand All @@ -51,12 +51,12 @@ GenerateRefInfo:
Wrote information on 4 namespaces, 68 types, and 970 members
Merging duplicate type and member information
Merged 0 duplicate type(s) and 0 duplicate member(s)
Done Building Project &quot;D:\a\NanoXLSX\NanoXLSX\docs\Working\GenerateRefInfo-b4455b3c-7b92-4040-a0ed-35723e0f6857.proj&quot; (default targets).
Last step completed in 00:00:09.6035
Done Building Project &quot;D:\a\NanoXLSX\NanoXLSX\docs\Working\GenerateRefInfo-a135de11-55ee-4230-92af-4762457252cb.proj&quot; (default targets).
Last step completed in 00:00:06.6132
</buildStep>
<buildStep step="ApplyDocumentModel">
Applying document model to reflection output...
Last step completed in 00:00:01.1722
Last step completed in 00:00:00.6882
</buildStep>
<buildStep step="AddNamespaceGroups">
Adding namespace group entries...
Expand All @@ -65,23 +65,23 @@ Added 0 namespace group entries
</buildStep>
<buildStep step="AddApiTopicFilenames">
Adding topic filenames to API members...
Last step completed in 00:00:00.0469
Last step completed in 00:00:00.0625
</buildStep>
<buildStep step="GenerateApiTopicManifest">
Generating API topic manifest...
Last step completed in 00:00:00.0312
</buildStep>
<buildStep step="GenerateNamespaceSummaries">
Generating namespace summary information...
Last step completed in 00:00:00.4847
Last step completed in 00:00:00.2656
</buildStep>
<buildStep step="CopyAdditionalContent">
Copying additional content files...
D:\a\NanoXLSX\NanoXLSX\Documentation\icons\NanoXLSX.png -&gt; D:\a\NanoXLSX\NanoXLSX\docs\Working\Output\HtmlHelp1\icons\NanoXLSX.png
D:\a\NanoXLSX\NanoXLSX\Documentation\icons\NanoXLSX.png -&gt; D:\a\NanoXLSX\NanoXLSX\docs\Working\Output\Website\icons\NanoXLSX.png
D:\a\NanoXLSX\NanoXLSX\Documentation\icons\favicon.ico -&gt; D:\a\NanoXLSX\NanoXLSX\docs\Working\Output\HtmlHelp1\icons\favicon.ico
D:\a\NanoXLSX\NanoXLSX\Documentation\icons\favicon.ico -&gt; D:\a\NanoXLSX\NanoXLSX\docs\Working\Output\Website\icons\favicon.ico
Last step completed in 00:00:00.0469
Last step completed in 00:00:00.0313
</buildStep>
<buildStep step="MergeTablesOfContents">
Merging conceptual and additional tables of contents...
Expand All @@ -90,15 +90,15 @@ Merging conceptual and additional tables of contents...
<buildStep step="GenerateIntermediateTableOfContents">
Generating intermediate table of contents file for API content...
Generating conceptual content intermediate TOC file...
Last step completed in 00:00:00.3567
Last step completed in 00:00:00.2500
</buildStep>
<buildStep step="CreateBuildAssemblerConfigs">
Creating Sandcastle configuration files...
Last step completed in 00:00:01.3206
Last step completed in 00:00:01.3916
</buildStep>
<buildStep step="CombiningIntermediateTocFiles">
Combining conceptual and API intermediate TOC files...
Last step completed in 00:00:00.0161
Last step completed in 00:00:00.0312
</buildStep>
<buildStep step="MergeCustomConfigs">
Merging custom build component configurations
Expand Down Expand Up @@ -179,7 +179,7 @@ Processed 1265 topic(s)
58 warning(s)
CopyFromIndexComponent: &quot;reflection&quot; in-memory cache entries used: 10 of 15.
CopyFromIndexComponent: &quot;comments&quot; in-memory cache entries used: 2 of 30.
Last step completed in 00:00:51.7094
Last step completed in 00:00:38.5959
</buildStep>
<buildStep step="ExtractingHtmlInfo">
Extracting HTML info for HTML Help 1 and/or website...
Expand All @@ -191,7 +191,7 @@ Saving HTML Help 1 table of contents to D:\a\NanoXLSX\NanoXLSX\docs\Working\Outp
Processing website files in D:\a\NanoXLSX\NanoXLSX\docs\Working\Output\Website
Processed 1265 HTML files. Sorting keywords and generating See Also indices.
Saving website table of contents to D:\a\NanoXLSX\NanoXLSX\docs\Working\\WebTOC.xml
Last step completed in 00:00:00.3906
Last step completed in 00:00:00.4065
</buildStep>
<buildStep step="CopyStandardHelpContent">
Copying standard help content...
Expand Down Expand Up @@ -327,11 +327,11 @@ C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\Components\VS2013
C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\Components\VS2013\Web\scripts\branding-Website.js -&gt; D:\a\NanoXLSX\NanoXLSX\docs\Working\Output\Website\scripts\branding-Website.js
C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\Components\VS2013\Web\scripts\clipboard.min.js -&gt; D:\a\NanoXLSX\NanoXLSX\docs\Working\Output\Website\scripts\clipboard.min.js
C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\Components\VS2013\Web\scripts\jquery-3.5.1.min.js -&gt; D:\a\NanoXLSX\NanoXLSX\docs\Working\Output\Website\scripts\jquery-3.5.1.min.js
Last step completed in 00:00:00.2661
Last step completed in 00:00:00.2813
</buildStep>
<buildStep step="GenerateHelpProject">
Generating HTML Help 1 project file...
Last step completed in 00:00:00.0630
Last step completed in 00:00:00.0313
</buildStep>
<buildStep step="CompilingHelpFile">
Compiling HTML Help 1 file...
Expand Down Expand Up @@ -361,18 +361,18 @@ Compiling HTML Help 1 file...



Created d:\a\NanoXLSX\NanoXLSX\docs\Working\Output\HtmlHelp1\Documentation.chm, 1,360,742 bytes
Created d:\a\NanoXLSX\NanoXLSX\docs\Working\Output\HtmlHelp1\Documentation.chm, 1,360,744 bytes

Compression decreased file by 6,925,645 bytes.
Compression decreased file by 6,925,643 bytes.

Last step completed in 00:00:05.4094
Last step completed in 00:00:04.6750
</buildStep>
<buildStep step="GenerateFullTextIndex">
Generating full-text index for the website...

<plugIn name="Lightweight Website Style" behavior="After" priority="1000">
Adding lightweight search and TOC elements to each topic...
</plugIn> Last step completed in 00:00:03.1264
</plugIn> Last step completed in 00:00:02.0658
</buildStep>
<buildStep step="CopyingWebsiteFiles">
Copying website files to output folder...
Expand All @@ -381,15 +381,15 @@ Copied 500 files
Copied 1000 files
Copied 1500 files
Copied 1621 files for the website content
Last step completed in 00:00:00.3439
Last step completed in 00:00:00.3595
</buildStep>
<buildStep step="CleanIntermediates">
Removing intermediate files...
Last step completed in 00:00:00.1472
Last step completed in 00:00:00.1719
</buildStep>
<buildStep step="Completed">

Build completed successfully at 7/22/2024 8:40:09 PM. Total time: 00:01:37.2190
Build completed successfully at 7/22/2024 8:57:49 PM. Total time: 00:01:07.7228

</buildStep>
</shfbBuild>
36 changes: 19 additions & 17 deletions docs/SearchHelp.aspx
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,14 @@
// System : Sandcastle Help File Builder
// File : SearchHelp.aspx
// Author : Eric Woodruff (Eric@EWoodruff.us)
// Updated : 05/15/2014
// Note : Copyright 2007-2015, Eric Woodruff, All rights reserved
// Compiler: Microsoft C#
// Updated : 08/13/2022
// Note : Copyright 2007-2022, Eric Woodruff, All rights reserved
//
// This file contains the code used to search for keywords within the help topics using the full-text index
// files created by the help file builder.
//
// This code is published under the Microsoft Public License (Ms-PL). A copy of the license should be
// distributed with the code. It can also be found at the project website: https://GitHub.com/EWSoftware/SHFB. This
// distributed with the code and can be found at the project website: https://GitHub.com/EWSoftware/SHFB. This
// notice, the author's name, and all copyright notices must remain intact in all applications, documentation,
// and source files.
//
Expand Down Expand Up @@ -120,7 +119,7 @@ private List<string> ParseKeywords(string keywords)
{
checkWord = word.ToLower(CultureInfo.InvariantCulture);
if(checkWord.Length > 2 && !Char.IsDigit(checkWord[0]) && !keywordList.Contains(checkWord))
if(checkWord.Length >= 2 && !Char.IsDigit(checkWord[0]) && !keywordList.Contains(checkWord))
keywordList.Add(checkWord);
}
Expand All @@ -141,7 +140,8 @@ private string Search(List<string> keywords, List<string> fileInfo,
StringBuilder sb = new StringBuilder(10240);
Dictionary<string, List<long>> matches = new Dictionary<string, List<long>>();
List<long> occurrences;
List<int> matchingFileIndices = new List<int>(), occurrenceIndices = new List<int>();
HashSet<int> matchingFileIndices = new HashSet<int>();
List<int> occurrenceIndices = new List<int>();
List<Ranking> rankings = new List<Ranking>();
string filename, title;
Expand All @@ -151,7 +151,13 @@ private string Search(List<string> keywords, List<string> fileInfo,
foreach(string word in keywords)
{
if(!wordDictionary.TryGetValue(word, out occurrences))
occurrences = new List<long>();
foreach(KeyValuePair<string, List<long>> kv in wordDictionary)
if(kv.Key.Contains(word))
occurrences.AddRange(kv.Value);
if(occurrences.Count == 0)
return "<strong>Nothing found</strong>";
matches.Add(word, occurrences);
Expand All @@ -164,18 +170,14 @@ private string Search(List<string> keywords, List<string> fileInfo,
if(isFirst)
{
isFirst = false;
matchingFileIndices.AddRange(occurrenceIndices);
matchingFileIndices.UnionWith(occurrenceIndices);
}
else
{
// After the first match, remove files that do not appear for
// all found keywords.
for(idx = 0; idx < matchingFileIndices.Count; idx++)
if(!occurrenceIndices.Contains(matchingFileIndices[idx]))
{
matchingFileIndices.RemoveAt(idx);
idx--;
}
// After the first match, remove files that do not appear for all found keywords
foreach(int i in matchingFileIndices.ToArray())
if(!occurrenceIndices.Contains(i))
matchingFileIndices.Remove(i);
}
}
Expand Down Expand Up @@ -218,7 +220,7 @@ private string Search(List<string> keywords, List<string> fileInfo,
});
// Format the file list and return the results
sb.Append("<ol>");
sb.Append("<ol>");
foreach(Ranking r in rankings)
sb.AppendFormat("<li><a href=\"{0}\" target=\"_blank\">{1}</a></li>", r.Filename, r.PageTitle);
Expand Down
2 changes: 1 addition & 1 deletion docs/SearchHelp.inc.php
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ function ParseKeywords($keywords)
{
$checkWord = strtolower($word);
$first = substr($checkWord, 0, 1);
if(strlen($checkWord) > 2 && !ctype_digit($first) && !in_array($checkWord, $keywordList))
if(strlen($checkWord) >= 2 && !ctype_digit($first) && !in_array($checkWord, $keywordList))
{
array_push($keywordList, $checkWord);
}
Expand Down
1 change: 1 addition & 0 deletions docs/Web.Config
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
<add namespace="System.Collections.Generic"/>
<add namespace="System.Globalization"/>
<add namespace="System.IO"/>
<add namespace="System.Linq"/>
<add namespace="System.Text"/>
<add namespace="System.Text.RegularExpressions"/>
<add namespace="System.Web"/>
Expand Down
2 changes: 1 addition & 1 deletion docs/fti/FTI_100.json

Large diffs are not rendered by default.

Loading

0 comments on commit dec93de

Please sign in to comment.