From f88e8feb48b2a27566a0bd36ff97bf09d9252b3b Mon Sep 17 00:00:00 2001 From: EWSoftware Date: Thu, 12 Sep 2024 11:04:31 -0700 Subject: [PATCH] Updates for publication --- Deployment/InstallerConfiguration.xml | 4 +- .../SandcastleBuilder/CommonTokens.tokens | 2 +- .../Content/VersionHistory/VersionHistory.aml | 6 ++ .../Content/VersionHistory/v2024.9.12.aml | 77 +++++++++++++++++ .../SandcastleBuilder.content | 7 +- .../SandcastleBuilder.shfbproj | 3 +- NuGet/SHFB.nuspec | 2 +- .../GlobalSuppressions.cs | 2 +- .../Properties/AssemblyInfoShared.cs | 6 +- .../Properties/AssemblyInfoShared.cs | 6 +- .../InstallerConfiguration.xml | 4 +- SHFB/Source/Setup/DeploymentFiles.wxs | 86 ++++++++++++------- .../VSIX_VS2017/source.extension.vsixmanifest | 2 +- .../VSIX_VS2022/source.extension.vsixmanifest | 2 +- 14 files changed, 161 insertions(+), 48 deletions(-) create mode 100644 Documentation/SandcastleBuilder/Content/VersionHistory/v2024.9.12.aml diff --git a/Deployment/InstallerConfiguration.xml b/Deployment/InstallerConfiguration.xml index 7f1859f3..3df2bb35 100644 --- a/Deployment/InstallerConfiguration.xml +++ b/Deployment/InstallerConfiguration.xml @@ -1,7 +1,7 @@  - + @@ -13,7 +13,7 @@ - diff --git a/Documentation/SandcastleBuilder/CommonTokens.tokens b/Documentation/SandcastleBuilder/CommonTokens.tokens index 9175c05d..7eef97c7 100644 --- a/Documentation/SandcastleBuilder/CommonTokens.tokens +++ b/Documentation/SandcastleBuilder/CommonTokens.tokens @@ -6,6 +6,6 @@ https://GitHub.com/EWSoftware/SHFB _blank - v2024.2.18.0 + v2024.9.12.0 Visual Studio 2017 \ No newline at end of file diff --git a/Documentation/SandcastleBuilder/Content/VersionHistory/VersionHistory.aml b/Documentation/SandcastleBuilder/Content/VersionHistory/VersionHistory.aml index 0011a297..ec51ad46 100644 --- 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. + + + + + + diff --git a/Documentation/SandcastleBuilder/Content/VersionHistory/v2024.9.12.aml b/Documentation/SandcastleBuilder/Content/VersionHistory/v2024.9.12.aml new file mode 100644 index 00000000..4eb4d312 --- /dev/null +++ b/Documentation/SandcastleBuilder/Content/VersionHistory/v2024.9.12.aml @@ -0,0 +1,77 @@ + + + + + Release notes for version 2024.9.12.0. + + +
+ Build Tools + + + + Fixed an issue with the Open XML file generator caused by the version of +System.Drawing.Common used by Visual Studio 2022. + + + + Fixed the code block component so that it removes the trailing comment characters on F# regions. + + + + Added support for NuGet central package management. + + + + Fixed error reporting for namespace summary issues. + + + + 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. + + + + + +
+ +
+ Presentation Styles + + + + Fixed all presentation styles so that they correctly handle extension methods on the +enumeration type member pages. + + + + Changed the handling of the AlwaysShowTopLevelAutoOutline 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. + + + + 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. + + + + Updated the web search in the Default2022 and VS2013 presentation styles to allow for numbers +as keywords. Also added support for the new IncludeIntegerEnumSeparators transformation +argument to all presentation styles that can be set to false to prevent integer enumeration values from being +formatted with separators. + + + +
+ + + + + + + diff --git a/Documentation/SandcastleBuilder/SandcastleBuilder.content b/Documentation/SandcastleBuilder/SandcastleBuilder.content index c6f55c00..ad49d9d9 100644 --- a/Documentation/SandcastleBuilder/SandcastleBuilder.content +++ b/Documentation/SandcastleBuilder/SandcastleBuilder.content @@ -1364,11 +1364,16 @@ - + + + + + + diff --git a/Documentation/SandcastleBuilder/SandcastleBuilder.shfbproj b/Documentation/SandcastleBuilder/SandcastleBuilder.shfbproj index 5dac0dd7..b3d58f8b 100644 --- a/Documentation/SandcastleBuilder/SandcastleBuilder.shfbproj +++ b/Documentation/SandcastleBuilder/SandcastleBuilder.shfbproj @@ -35,7 +35,7 @@ Eric%40EWoodruff.us Default2022 Standard - 2024.2.18.0 + 2024.9.12.0 @@ -407,6 +407,7 @@ + diff --git a/NuGet/SHFB.nuspec b/NuGet/SHFB.nuspec index 08292c84..8496dc38 100644 --- a/NuGet/SHFB.nuspec +++ b/NuGet/SHFB.nuspec @@ -2,7 +2,7 @@ EWSoftware.SHFB - 2024.2.18.0 + 2024.9.12.0 Sandcastle Help File Builder Eric Woodruff Eric Woodruff diff --git a/SHFB/Source/SandcastleBuilderUtils/GlobalSuppressions.cs b/SHFB/Source/SandcastleBuilderUtils/GlobalSuppressions.cs index e0e2f807..bcf4cd4b 100644 --- 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 = "", Scope = "member", Target = "~M:SandcastleBuilder.Utils.SandcastleProject.DefaultBuildAction(System.String)~SandcastleBuilder.Utils.BuildAction")] [assembly: SuppressMessage("Globalization", "CA1308:Normalize strings to uppercase", Justification = "", Scope = "member", Target = "~M:SandcastleBuilder.Utils.SandcastleProject.ReplacementValueFor(System.String)~System.String")] [assembly: SuppressMessage("Design", "CA1031:Do not catch general exception types", Justification = "", 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 = "", 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 = "", 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 = "", Scope = "member", Target = "~M:SandcastleBuilder.Utils.BuildEngine.BuildProcess.ReportWarning(System.String,System.String,System.Object[])")] [assembly: SuppressMessage("Globalization", "CA1308:Normalize strings to uppercase", Justification = "", 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 = "", 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 = "", Scope = "member", Target = "~M:SandcastleBuilder.Utils.BuildEngine.BuildProcess.Build")] [assembly: SuppressMessage("Performance", "CA1859:Use concrete types when possible for improved performance", Justification = "", 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 = "", 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 index 2c0b8857..d02d2ff7 100644 --- 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 (Eric@EWoodruff.us) -// 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 index 41be25a2..4fb9f2a9 100644 --- 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 index 7e84f6b2..e8f180ec 100644 --- a/SHFB/Source/SandcastleInstaller/InstallerConfiguration.xml +++ b/SHFB/Source/SandcastleInstaller/InstallerConfiguration.xml @@ -4,7 +4,7 @@ - + @@ -16,7 +16,7 @@ - diff --git a/SHFB/Source/Setup/DeploymentFiles.wxs b/SHFB/Source/Setup/DeploymentFiles.wxs index 52cc60e2..fbdfbc43 100644 --- a/SHFB/Source/Setup/DeploymentFiles.wxs +++ b/SHFB/Source/Setup/DeploymentFiles.wxs @@ -75,7 +75,10 @@ - + + + + @@ -90,7 +93,10 @@ - + + + + @@ -3576,7 +3582,10 @@ - + + + + @@ -3585,10 +3594,7 @@ - - - - + @@ -3609,7 +3615,10 @@ - + + + + @@ -3635,7 +3644,10 @@ - + + + + @@ -3674,7 +3686,10 @@ - + + + + @@ -3695,7 +3710,10 @@ - + + + + @@ -3717,11 +3735,6 @@ - - - - - @@ -3730,6 +3743,9 @@ + + + @@ -3747,14 +3763,6 @@ - - - - - - - - @@ -3997,10 +4005,16 @@ - + + + + - + + + + @@ -4012,7 +4026,10 @@ - + + + + @@ -4166,11 +4183,13 @@ + + @@ -5303,10 +5322,10 @@ + - @@ -5314,6 +5333,7 @@ + @@ -5322,6 +5342,7 @@ + @@ -5335,6 +5356,7 @@ + @@ -5342,19 +5364,18 @@ + - + - - @@ -5422,11 +5443,14 @@ + + + diff --git a/SHFB/Source/VSIX_VS2017/source.extension.vsixmanifest b/SHFB/Source/VSIX_VS2017/source.extension.vsixmanifest index aca90e0a..d2321107 100644 --- a/SHFB/Source/VSIX_VS2017/source.extension.vsixmanifest +++ b/SHFB/Source/VSIX_VS2017/source.extension.vsixmanifest @@ -1,7 +1,7 @@  - + SHFB (VS2017 and VS2019) Visual Studio integration for the Sandcastle Help File Builder. https://ewsoftware.github.io/SHFB/html/bd1ddb51-1c4f-434f-bb1a-ce2135d3a909.htm diff --git a/SHFB/Source/VSIX_VS2022/source.extension.vsixmanifest b/SHFB/Source/VSIX_VS2022/source.extension.vsixmanifest index aebc1012..c413b8ad 100644 --- a/SHFB/Source/VSIX_VS2022/source.extension.vsixmanifest +++ b/SHFB/Source/VSIX_VS2022/source.extension.vsixmanifest @@ -1,7 +1,7 @@  - + SHFB (VS2022 and Later) Visual Studio integration for the Sandcastle Help File Builder. https://ewsoftware.github.io/SHFB/html/bd1ddb51-1c4f-434f-bb1a-ce2135d3a909.htm