Updates for publication

EWSoftware · Sep 12, 2024 · f88e8fe · f88e8fe
1 parent 57c11c9
commit f88e8fe
Show file tree

Hide file tree

Showing 14 changed files with 161 additions and 48 deletions.
diff --git a/Deployment/InstallerConfiguration.xml b/Deployment/InstallerConfiguration.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8" ?>
 <configuration>
 	<!-- This indicates the tools version with which this installer is associated.-->
-	<tools version="2024.2.18.0" />
+	<tools version="2024.9.12.0" />
 
 	<!-- Define the installer pages.  Third-party build tool and component providers can add new pages that
 			 they have created to install their own products as well. -->
@@ -13,7 +13,7 @@
 		<page type="Sandcastle.Installer.InstallerPages.WelcomePage" />
 
 		<page type="Sandcastle.Installer.InstallerPages.WhatsNewPage">
-			<whatsNew url="https://EWSoftware.github.io/SHFB/html/a4050331-ee69-42e2-8c84-2f3a9a890b13.htm"
+			<whatsNew url="https://EWSoftware.github.io/SHFB/html/5d844018-a4b8-47ec-af4e-c087b758b868.htm"
 				description="Current Version Release Notes" />
 			<whatsNew url="https://EWSoftware.github.io/SHFB/html/bc933f8f-e792-45bf-afec-62aa2c46aa3b.htm"
 				description="Third-Party Component Migration Support" />

diff --git a/Documentation/SandcastleBuilder/CommonTokens.tokens b/Documentation/SandcastleBuilder/CommonTokens.tokens
@@ -6,6 +6,6 @@
     <ddue:linkUri>https://GitHub.com/EWSoftware/SHFB</ddue:linkUri>
     <ddue:linkTarget>_blank</ddue:linkTarget>
 </ddue:externalLink></item>
-  <item id="SandcastleVersion">v2024.2.18.0</item>
+  <item id="SandcastleVersion">v2024.9.12.0</item>
   <item id="VisualStudioMinVersion">Visual Studio 2017</item>
 </content>
diff --git a/Documentation/SandcastleBuilder/Content/VersionHistory/VersionHistory.aml b/Documentation/SandcastleBuilder/Content/VersionHistory/VersionHistory.aml
@@ -20,6 +20,12 @@ updating third-party components, plug-ins, presentation styles, and syntax gener
 version of the help file builder.</para>
 
 				<list class="bullet">
+					<listItem>
+						<para>
+							<link xlink:href="5d844018-a4b8-47ec-af4e-c087b758b868" />
+						</para>
+					</listItem>
+
 					<listItem>
 						<para>
 							<link xlink:href="a4050331-ee69-42e2-8c84-2f3a9a890b13" />

diff --git a/Documentation/SandcastleBuilder/Content/VersionHistory/v2024.9.12.aml b/Documentation/SandcastleBuilder/Content/VersionHistory/v2024.9.12.aml
@@ -0,0 +1,77 @@
+<?xml version="1.0" encoding="utf-8"?>
+<topic id="5d844018-a4b8-47ec-af4e-c087b758b868" revisionNumber="1">
+	<developerConceptualDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
+		<introduction>
+			<para>Release notes for version 2024.9.12.0.</para>
+		</introduction>
+
+		<section>
+			<title>Build Tools</title>
+			<content>
+				<list class="bullet">
+					<listItem>
+						<para>Fixed an issue with the Open XML file generator caused by the version of
+<localUri>System.Drawing.Common</localUri> used by Visual Studio 2022.</para>
+					</listItem>
+
+					<listItem>
+						<para>Fixed the code block component so that it removes the trailing comment characters on F# regions.</para>
+					</listItem>
+
+					<listItem>
+						<para>Added support for NuGet central package management.</para>
+					</listItem>
+
+					<listItem>
+						<para>Fixed error reporting for namespace summary issues.</para>
+					</listItem>
+
+					<listItem>
+						<para>Fixed handling of reference assemblies in MRefBuilder.  It now gives precedence to those
+specified in the project over those from the target platform to avoid conflicts when there is a matching assembly
+in both.</para>
+					</listItem>
+
+				</list>
+
+			</content>
+		</section>
+
+		<section>
+			<title>Presentation Styles</title>
+			<content>
+				<list class="bullet">
+					<listItem>
+						<para>Fixed all presentation styles so that they correctly handle extension methods on the
+enumeration type member pages.</para>
+					</listItem>
+
+					<listItem>
+						<para>Changed the handling of the <codeInline>AlwaysShowTopLevelAutoOutline</codeInline> transform
+argument in the Default2022 presentation style to hide the In This Article section if set to true since there's
+no real need to have both visible.</para>
+					</listItem>
+
+					<listItem>
+						<para>Updated the full text index to allow numbers and words with digits.  This allows searching for
+enumeration values and member names containing digits.  The text indexed is now limited to the topic content to
+prevent including lots of unwanted index words from the page header and footer such as copyright and contact info
+that appears in every page.</para>
+					</listItem>
+
+					<listItem>
+						<para>Updated the web search in the Default2022 and VS2013 presentation styles to allow for numbers
+as keywords.  Also added support for the new <codeInline>IncludeIntegerEnumSeparators</codeInline> transformation
+argument to all presentation styles that can be set to false to prevent integer enumeration values from being
+formatted with separators.</para>
+					</listItem>
+				</list>
+			</content>
+		</section>
+
+		<relatedTopics>
+			<link xlink:href="078cc1c7-7995-431e-bf9c-8813becbe8df" />
+		</relatedTopics>
+
+	</developerConceptualDocument>
+</topic>
diff --git a/Documentation/SandcastleBuilder/SandcastleBuilder.content b/Documentation/SandcastleBuilder/SandcastleBuilder.content
@@ -1364,11 +1364,16 @@
       <HelpKeyword index="K" term="support, donate" />
     </HelpKeywords>
   </Topic>
-  <Topic id="078cc1c7-7995-431e-bf9c-8813becbe8df" visible="True" isSelected="true" title="Version History">
+  <Topic id="078cc1c7-7995-431e-bf9c-8813becbe8df" visible="True" isExpanded="true" title="Version History">
     <HelpKeywords>
       <HelpKeyword index="K" term="History" />
       <HelpKeyword index="K" term="Version History" />
     </HelpKeywords>
+    <Topic id="5d844018-a4b8-47ec-af4e-c087b758b868" visible="True" isSelected="true" title="Version 2024.9.12.0">
+      <HelpKeywords>
+        <HelpKeyword index="K" term="versions, 2024.9.12.0" />
+      </HelpKeywords>
+    </Topic>
     <Topic id="a4050331-ee69-42e2-8c84-2f3a9a890b13" visible="True" title="Version 2024.2.18.0">
       <HelpKeywords>
         <HelpKeyword index="K" term="versions, 2024.2.18.0" />

diff --git a/Documentation/SandcastleBuilder/SandcastleBuilder.shfbproj b/Documentation/SandcastleBuilder/SandcastleBuilder.shfbproj
@@ -35,7 +35,7 @@
     <FeedbackEMailAddress>Eric%40EWoodruff.us</FeedbackEMailAddress>
     <PresentationStyle>Default2022</PresentationStyle>
     <SyntaxFilters>Standard</SyntaxFilters>
-    <HelpFileVersion>2024.2.18.0</HelpFileVersion>
+    <HelpFileVersion>2024.9.12.0</HelpFileVersion>
     <ComponentConfigurations>
     </ComponentConfigurations>
     <DocumentationSources>
@@ -407,6 +407,7 @@
     <None Include="Content\VersionHistory\v2023.3.4.0.aml" />
     <None Include="Content\VersionHistory\v2023.7.8.0.aml" />
     <None Include="Content\VersionHistory\v2024.2.18.0.aml" />
+    <None Include="Content\VersionHistory\v2024.9.12.aml" />
     <None Include="Content\VisualStudio\GoToDefinition.aml" />
     <None Include="Content\VisualStudio\ItemFileTemplates.aml" />
     <None Include="Content\VisualStudio\FeatureComparison.aml" />

diff --git a/NuGet/SHFB.nuspec b/NuGet/SHFB.nuspec
@@ -2,7 +2,7 @@
 <package xmlns="http://schemas.microsoft.com/packaging/2011/08/nuspec.xsd">
 	<metadata>
 		<id>EWSoftware.SHFB</id>
-		<version>2024.2.18.0</version>
+		<version>2024.9.12.0</version>
 		<title>Sandcastle Help File Builder</title>
 		<authors>Eric Woodruff</authors>
 		<owners>Eric Woodruff</owners>

diff --git a/SHFB/Source/SandcastleBuilderUtils/GlobalSuppressions.cs b/SHFB/Source/SandcastleBuilderUtils/GlobalSuppressions.cs
@@ -44,7 +44,6 @@
 [assembly: SuppressMessage("Globalization", "CA1308:Normalize strings to uppercase", Justification = "<Pending>", Scope = "member", Target = "~M:SandcastleBuilder.Utils.SandcastleProject.DefaultBuildAction(System.String)~SandcastleBuilder.Utils.BuildAction")]
 [assembly: SuppressMessage("Globalization", "CA1308:Normalize strings to uppercase", Justification = "<Pending>", Scope = "member", Target = "~M:SandcastleBuilder.Utils.SandcastleProject.ReplacementValueFor(System.String)~System.String")]
 [assembly: SuppressMessage("Design", "CA1031:Do not catch general exception types", Justification = "<Pending>", Scope = "member", Target = "~M:SandcastleBuilder.Utils.MSBuild.PackageReferenceResolver.LoadPackageReferenceInfo(Microsoft.Build.Evaluation.Project,System.String)~System.Boolean")]
-[assembly: SuppressMessage("Design", "CA1031:Do not catch general exception types", Justification = "<Pending>", Scope = "member", Target = "~M:SandcastleBuilder.Utils.MSBuild.PackageReferenceResolver.ResolvePackageReferencesInternal(System.Collections.Generic.IEnumerable{System.String})~System.Collections.Generic.IEnumerable{System.String}")]
 [assembly: SuppressMessage("Design", "CA1031:Do not catch general exception types", Justification = "<Pending>", Scope = "member", Target = "~M:SandcastleBuilder.Utils.BuildEngine.BuildAssemblerInternal.LoadComponent(System.Xml.XPath.XPathNavigator)~Sandcastle.Core.BuildAssembler.BuildComponent.BuildComponentCore")]
 [assembly: SuppressMessage("Design", "CA1062:Validate arguments of public methods", Justification = "<Pending>", Scope = "member", Target = "~M:SandcastleBuilder.Utils.BuildEngine.BuildProcess.ReportWarning(System.String,System.String,System.Object[])")]
 [assembly: SuppressMessage("Globalization", "CA1308:Normalize strings to uppercase", Justification = "<Pending>", Scope = "member", Target = "~M:SandcastleBuilder.Utils.BuildEngine.TitleAndKeywordHtmlExtract.ParseFiles(System.String,System.String)")]
@@ -56,3 +55,4 @@
 [assembly: SuppressMessage("Maintainability", "CA1508:Avoid dead conditional code", Justification = "<Pending>", Scope = "member", Target = "~M:SandcastleBuilder.Utils.BuildEngine.BuildProcess.ReportProgress(SandcastleBuilder.Utils.BuildEngine.BuildStep,System.String,System.Object[])")]
 [assembly: SuppressMessage("Style", "IDE0270:Use coalesce expression", Justification = "<Pending>", Scope = "member", Target = "~M:SandcastleBuilder.Utils.BuildEngine.BuildProcess.Build")]
 [assembly: SuppressMessage("Performance", "CA1859:Use concrete types when possible for improved performance", Justification = "<Pending>", Scope = "member", Target = "~M:SandcastleBuilder.Utils.BuildEngine.OpenXmlFileGenerator.ReorderChildren(System.Xml.Linq.XElement,System.Collections.Generic.IList{System.String})~System.Xml.Linq.XElement")]
+[assembly: SuppressMessage("Design", "CA1031:Do not catch general exception types", Justification = "<Pending>", Scope = "member", Target = "~M:SandcastleBuilder.Utils.MSBuild.PackageReferenceResolver.ResolvePackageReferencesInternal(System.Collections.Generic.IEnumerable{System.String})~System.Collections.Generic.HashSet{System.String}")]
diff --git a/SHFB/Source/SandcastleBuilderUtils/Properties/AssemblyInfoShared.cs b/SHFB/Source/SandcastleBuilderUtils/Properties/AssemblyInfoShared.cs
@@ -2,7 +2,7 @@
 // System  : Sandcastle Help File Builder
 // File    : AssemblyInfoShared.cs
 // Author  : Eric Woodruff  ([email protected])
-// Updated : 02/18/2024
+// Updated : 09/12/2024
 // Note    : Copyright 2006-2024, Eric Woodruff, All rights reserved
 //
 // Sandcastle Help File Builder common assembly attributes.
@@ -90,13 +90,13 @@ internal static partial class AssemblyInfo
     //
     // This is used to set the assembly file version.  This will change with each new release.  MSIs only
     // support a Major value between 0 and 255 so we drop the century from the year on this one.
-    public const string FileVersion = "24.2.18.0";
+    public const string FileVersion = "24.9.12.0";
 
     // Common product version
     //
     // This may contain additional text to indicate Alpha or Beta states.  The version number will always match
     // the file version above but includes the century on the year.
-    public const string ProductVersion = "2024.2.18.0";
+    public const string ProductVersion = "2024.9.12.0";
 
     // Assembly copyright information
     public const string Copyright = "Copyright \xA9 2006-2024, Eric Woodruff, All Rights Reserved";

diff --git a/SHFB/Source/SandcastleCore/Properties/AssemblyInfoShared.cs b/SHFB/Source/SandcastleCore/Properties/AssemblyInfoShared.cs
@@ -1,7 +1,7 @@
 //===============================================================================================================
 // System  : Sandcastle Tools
 // File    : AssemblyInfoShared.cs
-// Updated : 02/18/2024
+// Updated : 09/12/2024
 // Note    : Copyright 2006-2024, Microsoft Corporation, All rights reserved
 //
 // Sandcastle tools common assembly attributes.
@@ -73,13 +73,13 @@ internal static partial class AssemblyInfo
     //
     // This is used to set the assembly file version.  This will change with each new release.  MSIs only
     // support a Major value between 0 and 255 so we drop the century from the year on this one.
-    public const string FileVersion = "24.2.18.0";
+    public const string FileVersion = "24.9.12.0";
 
     // Common product version
     //
     // This may contain additional text to indicate Alpha or Beta states.  The version number will always match
     // the file version above but includes the century on the year.
-    public const string ProductVersion = "2024.2.18.0";
+    public const string ProductVersion = "2024.9.12.0";
 
     // Assembly copyright information
     public const string Copyright = "Copyright \xA9 2006-2024, Microsoft Corporation, All Rights Reserved.\r\n" +

diff --git a/SHFB/Source/SandcastleInstaller/InstallerConfiguration.xml b/SHFB/Source/SandcastleInstaller/InstallerConfiguration.xml
@@ -4,7 +4,7 @@
 	<pathOffset location="..\..\..\..\..\Deployment" />
 
 	<!-- This indicates the tools version with which this installer is associated.-->
-	<tools version="2024.2.18.0" />
+	<tools version="2024.9.12.0" />
 
 	<!-- Define the installer pages.  Third-party build tool and component providers can add new pages that
 			 they have created to install their own products as well. -->
@@ -16,7 +16,7 @@
 		<page type="Sandcastle.Installer.InstallerPages.WelcomePage" />
 
 		<page type="Sandcastle.Installer.InstallerPages.WhatsNewPage">
-			<whatsNew url="https://EWSoftware.github.io/SHFB/html/a4050331-ee69-42e2-8c84-2f3a9a890b13.htm"
+			<whatsNew url="https://EWSoftware.github.io/SHFB/html/5d844018-a4b8-47ec-af4e-c087b758b868.htm"
 				description="Current Version Release Notes" />
 			<whatsNew url="https://EWSoftware.github.io/SHFB/html/bc933f8f-e792-45bf-afec-62aa2c46aa3b.htm"
 				description="Third-Party Component Migration Support" />