Skip to content

Commit 32c2f44

Browse files
EWSoftwareEWSoftware
committed
Updates for release
- Updated the VSIX page in the Sandcastle Installer to ignore the build tools versions. Fixes #1091. - Updated the HTML extract task to handle logging warnings properly. Fixes #1087. - Made updates for new release.
1 parent e3db51f commit 32c2f44

File tree

18 files changed

+227
-55
lines changed

18 files changed

+227
-55
lines changed

‎Deployment/InstallerConfiguration.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<?xml version="1.0" encoding="utf-8" ?>
22
<configuration>
33
<!-- This indicates the tools version with which this installer is associated.-->
4-
<tools version="2024.9.12.0" />
4+
<tools version="2024.12.15.0" />
55

66
<!-- Define the installer pages. Third-party build tool and component providers can add new pages that
77
they have created to install their own products as well. -->
@@ -13,7 +13,7 @@
1313
<page type="Sandcastle.Installer.InstallerPages.WelcomePage" />
1414

1515
<page type="Sandcastle.Installer.InstallerPages.WhatsNewPage">
16-
<whatsNew url="https://EWSoftware.github.io/SHFB/html/5d844018-a4b8-47ec-af4e-c087b758b868.htm"
16+
<whatsNew url="https://EWSoftware.github.io/SHFB/html/430ecc56-ffcb-4470-aa5c-23b125965164.htm"
1717
description="Current Version Release Notes" />
1818
<whatsNew url="https://EWSoftware.github.io/SHFB/html/bc933f8f-e792-45bf-afec-62aa2c46aa3b.htm"
1919
description="Third-Party Component Migration Support" />

‎Documentation/SandcastleBuilder/CommonTokens.tokens‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@
66
<ddue:linkUri>https://GitHub.com/EWSoftware/SHFB</ddue:linkUri>
77
<ddue:linkTarget>_blank</ddue:linkTarget>
88
</ddue:externalLink></item>
9-
<item id="SandcastleVersion">v2024.9.12.0</item>
9+
<item id="SandcastleVersion">v2024.12.15.0</item>
1010
<item id="VisualStudioMinVersion">Visual Studio 2017</item>
1111
</content>

‎Documentation/SandcastleBuilder/Content/VersionHistory/VersionHistory.aml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,12 @@ updating third-party components, plug-ins, presentation styles, and syntax gener
2020
version of the help file builder.</para>
2121

2222
<list class="bullet">
23+
<listItem>
24+
<para>
25+
<link xlink:href="430ecc56-ffcb-4470-aa5c-23b125965164" />
26+
</para>
27+
</listItem>
28+
2329
<listItem>
2430
<para>
2531
<link xlink:href="5d844018-a4b8-47ec-af4e-c087b758b868" />

‎Documentation/SandcastleBuilder/Content/VersionHistory/v2024.12.15.0.aml‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<topic id="430ecc56-ffcb-4470-aa5c-23b125965164" revisionNumber="1">
3+
<developerConceptualDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
4+
<introduction>
5+
<para>Release notes for version 2024.12.15.0.</para>
6+
</introduction>
7+
8+
<section>
9+
<title>Build Tools</title>
10+
<content>
11+
<list class="bullet">
12+
<listItem>
13+
<para>The <localUri>dotnet build</localUri> version of the tools have been upgraded from the obsolete
14+
.NET Core 3.1 to .NET 8.0.</para>
15+
</listItem>
16+
17+
<listItem>
18+
<para>Moved the generate inherited documentation tool code into the build engine and removed the
19+
separate tool project and configuration file.</para>
20+
</listItem>
21+
22+
<listItem>
23+
<para>Fixed a crash in MRefBuilder when using a <codeInline>public static ref readonly</codeInline>
24+
property.</para>
25+
</listItem>
26+
27+
<listItem>
28+
<para>Updated the HTML extract task to handle logging warnings properly when processing the files in
29+
parallel.</para>
30+
</listItem>
31+
32+
<listItem>
33+
<para>Updated the .NET reflection data set with the .NET 9.0 assemblies.</para>
34+
</listItem>
35+
36+
</list>
37+
38+
</content>
39+
</section>
40+
41+
<section>
42+
<title>Presentation Styles</title>
43+
<content>
44+
<list class="bullet">
45+
<listItem>
46+
<para>Fixed the presentation styles so that they do not incorrectly mark <codeInline>ref struct</codeInline>
47+
types as obsolete unless specifically marked by the user as such (it ignores the compiler added attribute for
48+
versions that don't support them).</para>
49+
</listItem>
50+
51+
</list>
52+
</content>
53+
</section>
54+
55+
56+
<relatedTopics>
57+
<link xlink:href="078cc1c7-7995-431e-bf9c-8813becbe8df" />
58+
</relatedTopics>
59+
60+
</developerConceptualDocument>
61+
</topic>

‎Documentation/SandcastleBuilder/SandcastleBuilder.content‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1364,12 +1364,17 @@
13641364
<HelpKeyword index="K" term="support, donate" />
13651365
</HelpKeywords>
13661366
</Topic>
1367-
<Topic id="078cc1c7-7995-431e-bf9c-8813becbe8df" visible="True" isExpanded="true" title="Version History">
1367+
<Topic id="078cc1c7-7995-431e-bf9c-8813becbe8df" visible="True" isSelected="true" title="Version History">
13681368
<HelpKeywords>
13691369
<HelpKeyword index="K" term="History" />
13701370
<HelpKeyword index="K" term="Version History" />
13711371
</HelpKeywords>
1372-
<Topic id="5d844018-a4b8-47ec-af4e-c087b758b868" visible="True" isSelected="true" title="Version 2024.9.12.0">
1372+
<Topic id="430ecc56-ffcb-4470-aa5c-23b125965164" visible="True" title="Version 2024.12.15.0">
1373+
<HelpKeywords>
1374+
<HelpKeyword index="K" term="versions, 2024.12.15.0" />
1375+
</HelpKeywords>
1376+
</Topic>
1377+
<Topic id="5d844018-a4b8-47ec-af4e-c087b758b868" visible="True" title="Version 2024.9.12.0">
13731378
<HelpKeywords>
13741379
<HelpKeyword index="K" term="versions, 2024.9.12.0" />
13751380
</HelpKeywords>

‎Documentation/SandcastleBuilder/SandcastleBuilder.shfbproj‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
<FeedbackEMailAddress>Eric%40EWoodruff.us</FeedbackEMailAddress>
3636
<PresentationStyle>Default2022</PresentationStyle>
3737
<SyntaxFilters>Standard</SyntaxFilters>
38-
<HelpFileVersion>2024.9.12.0</HelpFileVersion>
38+
<HelpFileVersion>2024.12.15.0</HelpFileVersion>
3939
<ComponentConfigurations>
4040
</ComponentConfigurations>
4141
<DocumentationSources>
@@ -406,6 +406,7 @@
406406
<None Include="Content\VersionHistory\v2022.8.14.0.aml" />
407407
<None Include="Content\VersionHistory\v2023.3.4.0.aml" />
408408
<None Include="Content\VersionHistory\v2023.7.8.0.aml" />
409+
<None Include="Content\VersionHistory\v2024.12.15.0.aml" />
409410
<None Include="Content\VersionHistory\v2024.2.18.0.aml" />
410411
<None Include="Content\VersionHistory\v2024.9.12.aml" />
411412
<None Include="Content\VisualStudio\GoToDefinition.aml" />

‎NuGet/SHFB.NET.nuspec‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<package xmlns="http://schemas.microsoft.com/packaging/2011/08/nuspec.xsd">
33
<metadata>
44
<id>EWSoftware.SHFB.NET</id>
5-
<version>8.0.0.0</version>
5+
<version>9.0.0.0</version>
66
<title>Sandcastle Help File Builder .NET Core/.NET Standard/.NET 5.0+ Reflection Data Set</title>
77
<authors>Eric Woodruff</authors>
88
<owners>Eric Woodruff</owners>

‎NuGet/SHFB.nuspec‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<package xmlns="http://schemas.microsoft.com/packaging/2011/08/nuspec.xsd">
33
<metadata>
44
<id>EWSoftware.SHFB</id>
5-
<version>2024.9.12.0</version>
5+
<version>2024.12.15.0</version>
66
<title>Sandcastle Help File Builder</title>
77
<authors>Eric Woodruff</authors>
88
<owners>Eric Woodruff</owners>

‎SHFB/Source/SandcastleBuilderUtils/BuildEngine/TitleAndKeywordHtmlExtract.cs‎

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
// System : Sandcastle Help File Builder Utilities
33
// File : TitleAndKeywordHtmlExtract.cs
44
// Author : Eric Woodruff ([email protected])
5-
// Updated : 03/31/2022
6-
// Note : Copyright 2008-2022, Eric Woodruff, All rights reserved
5+
// Updated : 12/14/2024
6+
// Note : Copyright 2008-2024, Eric Woodruff, All rights reserved
77
//
88
// This file contains the class used to extract title and keyword information from HTML files for use in creating
99
// the Help 1 (CHM) table of contents and keyword index files. It can also optionally convert the
@@ -108,6 +108,9 @@ private struct KeywordInfo
108108
//=====================================================================
109109

110110
private readonly BuildProcess currentBuild;
111+
private readonly object lockObject = new Object();
112+
private static readonly char[] trimChars = new char[] { ' ' };
113+
private static readonly char[] dirSepChars = new[] { '/', '\\' };
111114

112115
// Options
113116
private string encodingName;
@@ -467,8 +470,11 @@ private void ProcessFile(string basePath, string sourceFile, string localizedOut
467470
if(!titles.TryAdd(key, new TitleInfo(WebUtility.HtmlDecode(topicTitle),
468471
WebUtility.HtmlDecode(tocTitle), sourceFile)))
469472
{
470-
currentBuild.ReportWarning("SHE0004", "The key '{0}' used for '{1}' is already in use by " +
471-
"'{2}'. '{1}' will be ignored.", key, sourceFile, titles[key].File);
473+
lock(lockObject)
474+
{
475+
currentBuild.ReportWarning("SHE0004", "The key '{0}' used for '{1}' is already in use by " +
476+
"'{2}'. '{1}' will be ignored.", key, sourceFile, titles[key].File);
477+
}
472478
}
473479

474480
// Extract K index keywords
@@ -489,7 +495,7 @@ private void ProcessFile(string basePath, string sourceFile, string localizedOut
489495
if(match.Success)
490496
{
491497
keyword.MainEntry = term.Substring(0, match.Index);
492-
keyword.SubEntry = term.Substring(match.Index + 1).TrimStart(new char[] { ' ' });
498+
keyword.SubEntry = term.Substring(match.Index + 1).TrimStart(trimChars);
493499
}
494500
else
495501
keyword.MainEntry = term;
@@ -568,15 +574,15 @@ private void WriteHelp1xTableOfContents()
568574
// Remove any sub-folder if present as the titles are keyed on the name alone
569575
if(!String.IsNullOrWhiteSpace(key))
570576
{
571-
int dirSep = key.IndexOfAny(new[] { '/', '\\' });
577+
int dirSep = key.IndexOfAny(dirSepChars);
572578

573579
if(dirSep != -1)
574580
key = key.Substring(dirSep + 1);
575581
}
576582

577-
if(!String.IsNullOrWhiteSpace(key) && titles.ContainsKey(key))
583+
if(!String.IsNullOrWhiteSpace(key) && titles.TryGetValue(key, out TitleInfo value))
578584
{
579-
titleInfo = titles[key];
585+
titleInfo = value;
580586
title = titleInfo.TocTitle;
581587
htmlFile = titleInfo.File.Substring(baseFolderLength);
582588
}
@@ -636,7 +642,7 @@ private void WriteHelp1xTableOfContents()
636642
/// <param name="writer">The writer to which the line is saved</param>
637643
/// <param name="indentCount">The amount of indent to use</param>
638644
/// <param name="value">The value to write</param>
639-
private static void WriteContentLine(TextWriter writer, int indentCount, string value)
645+
private static void WriteContentLine(StreamWriter writer, int indentCount, string value)
640646
{
641647
writer.WriteLine();
642648

@@ -792,15 +798,15 @@ private void WriteWebsiteTableOfContents()
792798
// Remove any sub-folder if present as the titles are keyed on the name alone
793799
if(!String.IsNullOrWhiteSpace(key))
794800
{
795-
int dirSep = key.IndexOfAny(new[] { '/', '\\' });
801+
int dirSep = key.IndexOfAny(dirSepChars);
796802

797803
if(dirSep != -1)
798804
key = key.Substring(dirSep + 1);
799805
}
800806

801-
if(!String.IsNullOrWhiteSpace(key) && titles.ContainsKey(key))
807+
if(!String.IsNullOrWhiteSpace(key) && titles.TryGetValue(key, out TitleInfo value))
802808
{
803-
titleInfo = titles[key];
809+
titleInfo = value;
804810
title = titleInfo.TocTitle;
805811
htmlFile = titleInfo.File.Substring(baseFolderLength).Replace('\\', '/');
806812
}

‎SHFB/Source/SandcastleBuilderUtils/Properties/AssemblyInfoShared.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// System : Sandcastle Help File Builder
33
// File : AssemblyInfoShared.cs
44
// Author : Eric Woodruff ([email protected])
5-
// Updated : 09/12/2024
5+
// Updated : 12/15/2024
66
// Note : Copyright 2006-2024, Eric Woodruff, All rights reserved
77
//
88
// Sandcastle Help File Builder common assembly attributes.
@@ -90,13 +90,13 @@ internal static partial class AssemblyInfo
9090
//
9191
// This is used to set the assembly file version. This will change with each new release. MSIs only
9292
// support a Major value between 0 and 255 so we drop the century from the year on this one.
93-
public const string FileVersion = "24.9.12.0";
93+
public const string FileVersion = "24.12.15.0";
9494

9595
// Common product version
9696
//
9797
// This may contain additional text to indicate Alpha or Beta states. The version number will always match
9898
// the file version above but includes the century on the year.
99-
public const string ProductVersion = "2024.9.12.0";
99+
public const string ProductVersion = "2024.12.15.0";
100100

101101
// Assembly copyright information
102102
public const string Copyright = "Copyright \xA9 2006-2024, Eric Woodruff, All Rights Reserved";

0 commit comments

Comments
 (0)