Skip to content

Commit f88e8fe

Browse files
committed
Updates for publication
1 parent 57c11c9 commit f88e8fe

File tree

14 files changed

+161
-48
lines changed

14 files changed

+161
-48
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.2.18.0" />
4+
<tools version="2024.9.12.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/a4050331-ee69-42e2-8c84-2f3a9a890b13.htm"
16+
<whatsNew url="https://EWSoftware.github.io/SHFB/html/5d844018-a4b8-47ec-af4e-c087b758b868.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.2.18.0</item>
9+
<item id="SandcastleVersion">v2024.9.12.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="5d844018-a4b8-47ec-af4e-c087b758b868" />
26+
</para>
27+
</listItem>
28+
2329
<listItem>
2430
<para>
2531
<link xlink:href="a4050331-ee69-42e2-8c84-2f3a9a890b13" />
Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<topic id="5d844018-a4b8-47ec-af4e-c087b758b868" 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.9.12.0.</para>
6+
</introduction>
7+
8+
<section>
9+
<title>Build Tools</title>
10+
<content>
11+
<list class="bullet">
12+
<listItem>
13+
<para>Fixed an issue with the Open XML file generator caused by the version of
14+
<localUri>System.Drawing.Common</localUri> used by Visual Studio 2022.</para>
15+
</listItem>
16+
17+
<listItem>
18+
<para>Fixed the code block component so that it removes the trailing comment characters on F# regions.</para>
19+
</listItem>
20+
21+
<listItem>
22+
<para>Added support for NuGet central package management.</para>
23+
</listItem>
24+
25+
<listItem>
26+
<para>Fixed error reporting for namespace summary issues.</para>
27+
</listItem>
28+
29+
<listItem>
30+
<para>Fixed handling of reference assemblies in MRefBuilder. It now gives precedence to those
31+
specified in the project over those from the target platform to avoid conflicts when there is a matching assembly
32+
in both.</para>
33+
</listItem>
34+
35+
</list>
36+
37+
</content>
38+
</section>
39+
40+
<section>
41+
<title>Presentation Styles</title>
42+
<content>
43+
<list class="bullet">
44+
<listItem>
45+
<para>Fixed all presentation styles so that they correctly handle extension methods on the
46+
enumeration type member pages.</para>
47+
</listItem>
48+
49+
<listItem>
50+
<para>Changed the handling of the <codeInline>AlwaysShowTopLevelAutoOutline</codeInline> transform
51+
argument in the Default2022 presentation style to hide the In This Article section if set to true since there's
52+
no real need to have both visible.</para>
53+
</listItem>
54+
55+
<listItem>
56+
<para>Updated the full text index to allow numbers and words with digits. This allows searching for
57+
enumeration values and member names containing digits. The text indexed is now limited to the topic content to
58+
prevent including lots of unwanted index words from the page header and footer such as copyright and contact info
59+
that appears in every page.</para>
60+
</listItem>
61+
62+
<listItem>
63+
<para>Updated the web search in the Default2022 and VS2013 presentation styles to allow for numbers
64+
as keywords. Also added support for the new <codeInline>IncludeIntegerEnumSeparators</codeInline> transformation
65+
argument to all presentation styles that can be set to false to prevent integer enumeration values from being
66+
formatted with separators.</para>
67+
</listItem>
68+
</list>
69+
</content>
70+
</section>
71+
72+
<relatedTopics>
73+
<link xlink:href="078cc1c7-7995-431e-bf9c-8813becbe8df" />
74+
</relatedTopics>
75+
76+
</developerConceptualDocument>
77+
</topic>

Documentation/SandcastleBuilder/SandcastleBuilder.content

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1364,11 +1364,16 @@
13641364
<HelpKeyword index="K" term="support, donate" />
13651365
</HelpKeywords>
13661366
</Topic>
1367-
<Topic id="078cc1c7-7995-431e-bf9c-8813becbe8df" visible="True" isSelected="true" title="Version History">
1367+
<Topic id="078cc1c7-7995-431e-bf9c-8813becbe8df" visible="True" isExpanded="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">
1373+
<HelpKeywords>
1374+
<HelpKeyword index="K" term="versions, 2024.9.12.0" />
1375+
</HelpKeywords>
1376+
</Topic>
13721377
<Topic id="a4050331-ee69-42e2-8c84-2f3a9a890b13" visible="True" title="Version 2024.2.18.0">
13731378
<HelpKeywords>
13741379
<HelpKeyword index="K" term="versions, 2024.2.18.0" />

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.2.18.0</HelpFileVersion>
38+
<HelpFileVersion>2024.9.12.0</HelpFileVersion>
3939
<ComponentConfigurations>
4040
</ComponentConfigurations>
4141
<DocumentationSources>
@@ -407,6 +407,7 @@
407407
<None Include="Content\VersionHistory\v2023.3.4.0.aml" />
408408
<None Include="Content\VersionHistory\v2023.7.8.0.aml" />
409409
<None Include="Content\VersionHistory\v2024.2.18.0.aml" />
410+
<None Include="Content\VersionHistory\v2024.9.12.aml" />
410411
<None Include="Content\VisualStudio\GoToDefinition.aml" />
411412
<None Include="Content\VisualStudio\ItemFileTemplates.aml" />
412413
<None Include="Content\VisualStudio\FeatureComparison.aml" />

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.2.18.0</version>
5+
<version>2024.9.12.0</version>
66
<title>Sandcastle Help File Builder</title>
77
<authors>Eric Woodruff</authors>
88
<owners>Eric Woodruff</owners>

SHFB/Source/SandcastleBuilderUtils/GlobalSuppressions.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,6 @@
4444
[assembly: SuppressMessage("Globalization", "CA1308:Normalize strings to uppercase", Justification = "<Pending>", Scope = "member", Target = "~M:SandcastleBuilder.Utils.SandcastleProject.DefaultBuildAction(System.String)~SandcastleBuilder.Utils.BuildAction")]
4545
[assembly: SuppressMessage("Globalization", "CA1308:Normalize strings to uppercase", Justification = "<Pending>", Scope = "member", Target = "~M:SandcastleBuilder.Utils.SandcastleProject.ReplacementValueFor(System.String)~System.String")]
4646
[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")]
47-
[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}")]
4847
[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")]
4948
[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[])")]
5049
[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 @@
5655
[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[])")]
5756
[assembly: SuppressMessage("Style", "IDE0270:Use coalesce expression", Justification = "<Pending>", Scope = "member", Target = "~M:SandcastleBuilder.Utils.BuildEngine.BuildProcess.Build")]
5857
[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")]
58+
[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}")]

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 (Eric@EWoodruff.us)
5-
// Updated : 02/18/2024
5+
// Updated : 09/12/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.2.18.0";
93+
public const string FileVersion = "24.9.12.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.2.18.0";
99+
public const string ProductVersion = "2024.9.12.0";
100100

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

SHFB/Source/SandcastleCore/Properties/AssemblyInfoShared.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
//===============================================================================================================
22
// System : Sandcastle Tools
33
// File : AssemblyInfoShared.cs
4-
// Updated : 02/18/2024
4+
// Updated : 09/12/2024
55
// Note : Copyright 2006-2024, Microsoft Corporation, All rights reserved
66
//
77
// Sandcastle tools common assembly attributes.
@@ -73,13 +73,13 @@ internal static partial class AssemblyInfo
7373
//
7474
// This is used to set the assembly file version. This will change with each new release. MSIs only
7575
// support a Major value between 0 and 255 so we drop the century from the year on this one.
76-
public const string FileVersion = "24.2.18.0";
76+
public const string FileVersion = "24.9.12.0";
7777

7878
// Common product version
7979
//
8080
// This may contain additional text to indicate Alpha or Beta states. The version number will always match
8181
// the file version above but includes the century on the year.
82-
public const string ProductVersion = "2024.2.18.0";
82+
public const string ProductVersion = "2024.9.12.0";
8383

8484
// Assembly copyright information
8585
public const string Copyright = "Copyright \xA9 2006-2024, Microsoft Corporation, All Rights Reserved.\r\n" +

0 commit comments

Comments
 (0)