Updates for publication

EWSoftware · Feb 19, 2024 · c0bd2d5 · c0bd2d5
1 parent 66a8edf
commit c0bd2d5
Show file tree

Hide file tree

Showing 27 changed files with 242 additions and 151 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="2023.7.8.0" />
+	<tools version="2024.2.18.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/238d9fb1-5eb0-4e0e-a9bc-80fa0c1422d6.htm"
+			<whatsNew url="https://EWSoftware.github.io/SHFB/html/a4050331-ee69-42e2-8c84-2f3a9a890b13.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">v2023.7.8.0</item>
+  <item id="SandcastleVersion">v2024.2.18.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="a4050331-ee69-42e2-8c84-2f3a9a890b13" />
+						</para>
+					</listItem>
+
 					<listItem>
 						<para>
 							<link xlink:href="238d9fb1-5eb0-4e0e-a9bc-80fa0c1422d6" />

diff --git a/Documentation/SandcastleBuilder/Content/VersionHistory/v2024.2.18.0.aml b/Documentation/SandcastleBuilder/Content/VersionHistory/v2024.2.18.0.aml
@@ -0,0 +1,125 @@
+<?xml version="1.0" encoding="utf-8"?>
+<topic id="a4050331-ee69-42e2-8c84-2f3a9a890b13" 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.2.18.0.  See the prior version release notes for information on the
+breaking changes made to the presentation styles implementation.</para>
+		</introduction>
+
+		<section address="BreakingChanges">
+			<title>Breaking Changes in This Release</title>
+			<content>
+				<alert class="important">
+					<para>If you have created custom build components, syntax generators, plug-ins, or presentation styles,
+you will need to rebuild them against the latest release of the help file builder NuGet packages.</para>
+				</alert>
+
+				<list class="bullet">
+					<listItem>
+						<para>The Microsoft Learn cross-reference resolver service used to generate links to the online .NET
+Framework API topics is being shut down.  As such, this release replaces the resolver service with a code-based
+implementation that no longer requires an external service nor a persistent cache to store previously resolved
+URLs to online topics.  The removal of the persistent cache also allows it to work with more recent versions of
+the <localUri>dotnet build</localUri> tool that use a version of .NET that disables binary serialization.</para>
+					</listItem>
+
+					<listItem>
+						<para>Added <codeInline>HasFooterContent</codeInline> and <codeInline>HasWebsiteAdContent</codeInline>
+properties to <codeInline>TopicTransformationCore</codeInline> to allow Build Assembler to indicate whether or
+not the current project contains those items.  If not, the transformation is free to remove any related elements
+to preserve page formatting and layout.</para>
+					</listItem>
+
+					<listItem>
+						<para>A couple of new transformation arguments were added as noted below.</para>
+					</listItem>
+
+				</list>
+
+			</content>
+		</section>
+
+		<section>
+			<title>Build Tools</title>
+			<content>
+				<list class="bullet">
+					<listItem>
+						<para>Fixed an issue with the MRefBuilder name matching.</para>
+					</listItem>
+
+					<listItem>
+						<para>Added support for .NET 7 static interface members.</para>
+					</listItem>
+
+					<listItem>
+						<para>Fixed the syntax for finalizers in the C# and managed C++ syntax generators.</para>
+					</listItem>
+
+					<listItem>
+						<para>Private protected nested types are now excluded unless including internals.</para>
+					</listItem>
+				</list>
+
+			</content>
+		</section>
+
+		<section>
+			<title>Sandcastle Help File Builder</title>
+			<content>
+				<list class="bullet">
+					<listItem>
+						<para>Regenerated the .NET reflection data set to include .NET 8.0 members.  Also regenerated the
+.NET Framework data set to correct a few minor issues with implemented member information.</para>
+					</listItem>
+
+					<listItem>
+						<para>Made BE0060 an error instead of a warning since the vast majority of the time the problem does
+cause invalid Help 1 (CHM) file output even if the build succeeds.</para>
+					</listItem>
+
+					<listItem>
+						<para>Disabled Go To Definition on <codeInline>name</codeInline> attribute values.</para>
+					</listItem>
+				</list>
+			</content>
+		</section>
+
+		<section>
+			<title>Presentation Styles</title>
+			<content>
+				<list class="bullet">
+					<listItem>
+						<para>Added a <codeInline>ShowParametersOnAllMethods</codeInline> transformation argument to all
+presentation styles to allow showing parameters on all methods, not just overloads, on member list pages.</para>
+					</listItem>
+
+					<listItem>
+						<para>Added an <codeInline>AlwaysShowTopLevelAutoOutline</codeInline> transformation argument to the
+Default 2022 presentation style to allow always showing the top-level auto-outlines regardless of the display
+size.</para>
+					</listItem>
+
+					<listItem>
+						<para>Fixed all presentation styles so that they render a syntax section even if all syntax
+generators are disabled so that parameters, returns, and implements info is included in the topic.</para>
+					</listItem>
+
+					<listItem>
+						<para>Added '+' to the list of version number separators so that Git commit IDs can be removed from
+<codeInline>AssemblyInformationalVersion</codeInline> attribute values by specifying a fixed number of version
+number parts to include.</para>
+					</listItem>
+
+					<listItem>
+						<para>Fixed the auto-outline element so that it hides the default lead-in text as well.</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,12 +1364,17 @@
       <HelpKeyword index="K" term="support, donate" />
     </HelpKeywords>
   </Topic>
-  <Topic id="078cc1c7-7995-431e-bf9c-8813becbe8df" visible="True" isExpanded="true" title="Version History">
+  <Topic id="078cc1c7-7995-431e-bf9c-8813becbe8df" visible="True" isSelected="true" title="Version History">
     <HelpKeywords>
       <HelpKeyword index="K" term="History" />
       <HelpKeyword index="K" term="Version History" />
     </HelpKeywords>
-    <Topic id="238d9fb1-5eb0-4e0e-a9bc-80fa0c1422d6" visible="True" isSelected="true" title="Version 2023.7.8.0">
+    <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" />
+      </HelpKeywords>
+    </Topic>
+    <Topic id="238d9fb1-5eb0-4e0e-a9bc-80fa0c1422d6" visible="True" title="Version 2023.7.8.0">
       <HelpKeywords>
         <HelpKeyword index="K" term="versions, 2023.7.8.0" />
       </HelpKeywords>

diff --git a/Documentation/SandcastleBuilder/SandcastleBuilder.shfbproj b/Documentation/SandcastleBuilder/SandcastleBuilder.shfbproj
@@ -31,11 +31,11 @@
     <FrameworkVersion>.NET Core/.NET Standard/.NET 5.0+</FrameworkVersion>
     <HelpTitle>Sandcastle Help File Builder Documentation</HelpTitle>
     <CopyrightHref>https://GitHub.com/EWSoftware/SHFB</CopyrightHref>
-    <CopyrightText>[v{%40HelpFileVersion}] Copyright \xA9 2006-2023, Eric Woodruff, All rights reserved</CopyrightText>
+    <CopyrightText>[v{%40HelpFileVersion}] Copyright \xA9 2006-2024, Eric Woodruff, All rights reserved</CopyrightText>
     <FeedbackEMailAddress>Eric%40EWoodruff.us</FeedbackEMailAddress>
     <PresentationStyle>Default2022</PresentationStyle>
     <SyntaxFilters>Standard</SyntaxFilters>
-    <HelpFileVersion>2023.7.8.0</HelpFileVersion>
+    <HelpFileVersion>2024.2.18.0</HelpFileVersion>
     <ComponentConfigurations>
     </ComponentConfigurations>
     <DocumentationSources>
@@ -406,6 +406,7 @@
     <None Include="Content\VersionHistory\v2022.8.14.0.aml" />
     <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\VisualStudio\GoToDefinition.aml" />
     <None Include="Content\VisualStudio\ItemFileTemplates.aml" />
     <None Include="Content\VisualStudio\FeatureComparison.aml" />

diff --git a/LICENSE b/LICENSE
@@ -63,31 +63,31 @@ purpose and non-infringement.
 
 Copyright Notices
 -----------------
-Bulma is Copyright (c) 2022 Jeremy Thomas, All Rights Reserved.  Code released
+Bulma is Copyright (c) 2022-2024 Jeremy Thomas, All Rights Reserved.  Code released
 under the MIT license (https://github.com/jgthms/bulma).
 
 Font Awesome Free - License - https://fontawesome.com/license/free
 (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License)
-Copyright (c) 2022 Fonticons, Inc., All Rights Reserved.
+Copyright (c) 2022-2024 Fonticons, Inc., All Rights Reserved.
 
-Highlight.js is Copyright (c) 2006-2022 Ivan Sagalaev and other contributors
+Highlight.js is Copyright (c) 2006-2024 Ivan Sagalaev and other contributors
 (https://highlightjs.org/) License: BSD-3-Clause
 
-The ICSharpCode.TextEditor is Copyright (c) 2000-2022 IC#Code, All Rights
+The ICSharpCode.TextEditor is Copyright (c) 2000-2024 IC#Code, All Rights
 Reserved.
 
-The Weifen Luo DockPanel Suite is Copyright (c) 2007-2022 Weifen Luo and other
+The Weifen Luo DockPanel Suite is Copyright (c) 2007-2024 Weifen Luo and other
 contributors, All Rights Reserved.
 
-The NHunspell library is Copyright (c) 2009-2022 Maierhofer Software, All
+The NHunspell library is Copyright (c) 2009-2024 Maierhofer Software, All
 Rights Reserved.
 
-SBAppLocale is Copyright 2005-2022 Steel Bytes, All Rights Reserved.
+SBAppLocale is Copyright 2005-2024 Steel Bytes, All Rights Reserved.
 
-The code colorizer library is Copyright (c) 2003-2022, Jonathan de Halleux,
+The code colorizer library is Copyright (c) 2003-2024, Jonathan de Halleux,
 All Rights Reserved.
 
-All other code is Copyright (c) 2006-2022, Eric Woodruff, All Rights Reserved.
+All other code is Copyright (c) 2006-2024, Eric Woodruff, All Rights Reserved.
 
 The English US dictionary is based on a subset of the original English wordlist
 created by Kevin Atkinson for Pspell and Aspell and thus is covered by his

diff --git a/NuGet/SHFB.NET.nuspec b/NuGet/SHFB.NET.nuspec
@@ -13,7 +13,7 @@
 		<projectUrl>https://github.com/EWSoftware/SHFB</projectUrl>
 		<iconUrl>https://raw.githubusercontent.com/EWSoftware/SHFB/master/NuGet/SHFB.png</iconUrl>
 		<description>This package contains the reflection data set for .NET Core, .NET Standard, and .NET 5.0 or later for use with the EWSoftware.SHFB package (version 2021.3.29 or later only).</description>
-		<copyright>Eric Woodruff (c) 2021</copyright>
+		<copyright>Eric Woodruff (c) 2021-2024</copyright>
 		<tags>SHFB sandcastle reflection information data set</tags>
 		<!-- A dependency on the EWSoftware.SHFB package would be good to have but unfortunately, adding one
 				 renders the package uninstallable because its "not compatible with any projects in the solution".

diff --git a/NuGet/SHFB.NETFramework.nuspec b/NuGet/SHFB.NETFramework.nuspec
@@ -2,7 +2,7 @@
 <package xmlns="http://schemas.microsoft.com/packaging/2011/08/nuspec.xsd">
 	<metadata>
 		<id>EWSoftware.SHFB.NETFramework</id>
-		<version>4.8.0.1</version>
+		<version>4.8.0.3</version>
 		<title>Sandcastle Help File Builder .NET Framework Reflection Data Set</title>
 		<authors>Eric Woodruff</authors>
 		<owners>Eric Woodruff</owners>
@@ -13,7 +13,7 @@
 		<projectUrl>https://github.com/EWSoftware/SHFB</projectUrl>
 		<iconUrl>https://raw.githubusercontent.com/EWSoftware/SHFB/master/NuGet/SHFB.png</iconUrl>
 		<description>This package contains the .NET Framework reflection information data set for use with the EWSoftware.SHFB package.</description>
-		<copyright>Eric Woodruff (c) 2006-2021</copyright>
+		<copyright>Eric Woodruff (c) 2006-2024</copyright>
 		<tags>SHFB sandcastle reflection information data set</tags>
 		<!-- A dependency on the EWSoftware.SHFB package would be good to have but unfortunately, adding one
 				 renders the package uninstallable because its "not compatible with any projects in the solution".

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>2023.7.8.0</version>
+		<version>2024.2.18.0</version>
 		<title>Sandcastle Help File Builder</title>
 		<authors>Eric Woodruff</authors>
 		<owners>Eric Woodruff</owners>
@@ -13,7 +13,7 @@
 		<iconUrl>https://raw.githubusercontent.com/EWSoftware/SHFB/master/NuGet/SHFB.png</iconUrl>
 		<requireLicenseAcceptance>false</requireLicenseAcceptance>
 		<description>This package allows you to deploy the Sandcastle Help File Builder tools inside of a project to build help files without installing the tools manually such as on a build server.  Some limitations apply.  You will also need to install the reflection data set packages that you need for your projects.</description>
-		<copyright>Eric Woodruff (c) 2006-2023</copyright>
+		<copyright>Eric Woodruff (c) 2006-2024</copyright>
 		<tags>SHFB documentation sandcastle help XML comments</tags>
 		<!-- Note that we do not add dependencies on the reflection data set packages.  The idea here is that you
 				 only need to install the packages that you actually need. -->