Minor fix to HTML extract tool (#876)

EWSoftware · Nov 7, 2021 · 6bf123d · 6bf123d
1 parent 64ecc94
commit 6bf123d
Show file tree

Hide file tree

Showing 12 changed files with 43 additions and 33 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="2021.10.23.0" />
+	<tools version="2021.11.7.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. -->

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">v2021.10.23.0</item>
+  <item id="SandcastleVersion">v2021.11.7.0</item>
   <item id="VisualStudioMinVersion">Visual Studio 2017</item>
 </content>
diff --git a/.../Content/VersionHistory/v2021.10.23.0.aml → ...r/Content/VersionHistory/v2021.11.7.0.aml b/.../Content/VersionHistory/v2021.10.23.0.aml → ...r/Content/VersionHistory/v2021.11.7.0.aml
@@ -15,8 +15,11 @@ topic for more information.</para>
 
 				<para>See the <link xlink:href="21c2a363-6c94-440b-8985-6b224d275463" /> topic for known issues with
 .NET Core builds.</para>
+
 			</alert>
 
+			<para>This release is a minor update to version 2021.10.23.0 which originally contained these changes.</para>
+
 			<autoOutline excludeRelatedTopics="true" lead="none" />
 		</introduction>
 

diff --git a/Documentation/SandcastleBuilder/SandcastleBuilder.content b/Documentation/SandcastleBuilder/SandcastleBuilder.content
@@ -1401,9 +1401,10 @@
       <HelpKeyword index="K" term="History" />
       <HelpKeyword index="K" term="Version History" />
     </HelpKeywords>
-    <Topic id="003c85ec-45ad-4123-a31d-fd63a695b1f3" visible="True" title="Version 2021.10.23.0">
+    <Topic id="003c85ec-45ad-4123-a31d-fd63a695b1f3" visible="True" title="Version 2021.11.7.0">
       <HelpKeywords>
         <HelpKeyword index="K" term="versions, 2021.10.23.0" />
+        <HelpKeyword index="K" term="versions, 2021.11.7.0" />
       </HelpKeywords>
     </Topic>
     <Topic id="bc933f8f-e792-45bf-afec-62aa2c46aa3b" visible="True" title="Component Migration Support">

diff --git a/Documentation/SandcastleBuilder/SandcastleBuilder.shfbproj b/Documentation/SandcastleBuilder/SandcastleBuilder.shfbproj
@@ -33,7 +33,7 @@
     <FeedbackEMailAddress>Eric%40EWoodruff.us</FeedbackEMailAddress>
     <PresentationStyle>VS2013</PresentationStyle>
     <SyntaxFilters>Standard</SyntaxFilters>
-    <HelpFileVersion>2021.10.23.0</HelpFileVersion>
+    <HelpFileVersion>2021.11.7.0</HelpFileVersion>
     <ComponentConfigurations>
     </ComponentConfigurations>
     <DocumentationSources>
@@ -388,7 +388,7 @@
     <None Include="Content\VersionHistory\v2015.7.26.0tov2021.4.9.0\v2020.3.6.0.aml" />
     <None Include="Content\VersionHistory\v2015.7.26.0tov2021.4.9.0\v2021.3.29.0.aml" />
     <None Include="Content\VersionHistory\v2015.7.26.0tov2021.4.9.0\v2021.4.9.0.aml" />
-    <None Include="Content\VersionHistory\v2021.10.23.0.aml" />
+    <None Include="Content\VersionHistory\v2021.11.7.0.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>2021.10.23.0</version>
+		<version>2021.11.7.0</version>
 		<title>Sandcastle Help File Builder</title>
 		<authors>Eric Woodruff</authors>
 		<owners>Eric Woodruff</owners>

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  (Eric@EWoodruff.us)
-// Updated : 10/23/2021
+// Updated : 11/07/2021
 // Note    : Copyright 2006-2021, 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 = "21.10.23.0";
+    public const string FileVersion = "21.11.7.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 = "2021.10.23.0";
+    public const string ProductVersion = "2021.11.7.0";
 
     // Assembly copyright information
     public const string Copyright = "Copyright \xA9 2006-2021, 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 : 10/23/2021
+// Updated : 11/07/2021
 // Note    : Copyright 2006-2021, 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 = "21.10.23.0";
+    public const string FileVersion = "21.11.7.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 = "2021.10.23.0";
+    public const string ProductVersion = "2021.11.7.0";
 
     // Assembly copyright information
     public const string Copyright = "Copyright \xA9 2006-2021, Microsoft Corporation, All Rights Reserved.\r\n" +

diff --git a/SHFB/Source/SandcastleHtmlExtract/SandcastleHtmlExtract.cs b/SHFB/Source/SandcastleHtmlExtract/SandcastleHtmlExtract.cs
@@ -2,7 +2,7 @@
 // System  : Sandcastle Help File Builder
 // File    : SandcastleHtmlExtract.cs
 // Author  : Eric Woodruff  (Eric@EWoodruff.us)
-// Updated : 07/07/2021
+// Updated : 11/01/2021
 // Note    : Copyright 2008-2021, Eric Woodruff, All rights reserved
 //
 // This file contains the console mode application used to extract title and keyword information from HTML files
@@ -591,9 +591,9 @@ private void ProcessFile(string basePath, string sourceFile, string localizedOut
                 writer.Write(content);
             }
         }
-#endregion
+        #endregion
 
-#region Write out the HTML Help 1 table of contents
+        #region Write out the HTML Help 1 table of contents
         //=====================================================================
 
         /// <summary>
@@ -634,12 +634,15 @@ private void WriteHelp1xTableOfContents()
                                     key = reader.GetAttribute("file");
 
                                     // Remove any sub-folder if present as the titles are keyed on the name alone
-                                    int dirSep = key.IndexOfAny(new[] { '/', '\\' });
+                                    if(!String.IsNullOrWhiteSpace(key))
+                                    {
+                                        int dirSep = key.IndexOfAny(new[] { '/', '\\' });
 
-                                    if(dirSep != -1)
-                                        key = key.Substring(dirSep + 1);
+                                        if(dirSep != -1)
+                                            key = key.Substring(dirSep + 1);
+                                    }
 
-                                    if(!String.IsNullOrEmpty(key) && titles.ContainsKey(key))
+                                    if(!String.IsNullOrWhiteSpace(key) && titles.ContainsKey(key))
                                     {
                                         titleInfo = titles[key];
                                         title = titleInfo.TocTitle;
@@ -707,9 +710,9 @@ private static void WriteContentLine(TextWriter writer, int indentCount, string
 
             writer.Write(value);
         }
-#endregion
+        #endregion
 
-#region Write out the HTML Help 1 keyword index
+        #region Write out the HTML Help 1 keyword index
         //=====================================================================
 
         /// <summary>
@@ -797,9 +800,9 @@ private static void WriteHelp1IndexEntry(string title, string file, StreamWriter
 
             WriteContentLine(writer, indent, "</OBJECT></LI>");
         }
-#endregion
+        #endregion
 
-#region Write out the website table of contents
+        #region Write out the website table of contents
         //=====================================================================
 
         /// <summary>
@@ -839,12 +842,15 @@ private void WriteWebsiteTableOfContents()
                                     key = reader.GetAttribute("file");
 
                                     // Remove any sub-folder if present as the titles are keyed on the name alone
-                                    int dirSep = key.IndexOfAny(new[] { '/', '\\' });
+                                    if(!String.IsNullOrWhiteSpace(key))
+                                    {
+                                        int dirSep = key.IndexOfAny(new[] { '/', '\\' });
 
-                                    if(dirSep != -1)
-                                        key = key.Substring(dirSep + 1);
+                                        if(dirSep != -1)
+                                            key = key.Substring(dirSep + 1);
+                                    }
 
-                                    if(!String.IsNullOrEmpty(key) && titles.ContainsKey(key))
+                                    if(!String.IsNullOrWhiteSpace(key) && titles.ContainsKey(key))
                                     {
                                         titleInfo = titles[key];
                                         title = titleInfo.TocTitle;
@@ -897,9 +903,9 @@ private void WriteWebsiteTableOfContents()
                 }
             }
         }
-#endregion
+        #endregion
 
-#region Write out the website keyword index
+        #region Write out the website keyword index
         //=====================================================================
 
         /// <summary>
@@ -959,6 +965,6 @@ private void WriteWebsiteKeywordIndex()
                 writer.WriteLine("</HelpKI>");
             }
         }
-#endregion
+        #endregion
     }
 }
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="2021.10.23.0" />
+	<tools version="2021.11.7.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. -->

diff --git a/SHFB/Source/VSIX_VS2017/source.extension.vsixmanifest b/SHFB/Source/VSIX_VS2017/source.extension.vsixmanifest
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <PackageManifest Version="2.0.0" xmlns="http://schemas.microsoft.com/developer/vsx-schema/2011" xmlns:d="http://schemas.microsoft.com/developer/vsx-schema-design/2011">
 	<Metadata>
-		<Identity Id="c997d569-ee8e-4947-a46f-9a0717ce39a0" Version="2021.10.23.0" Language="en-US" Publisher="EWSoftware" />
+		<Identity Id="c997d569-ee8e-4947-a46f-9a0717ce39a0" Version="2021.11.7.0" Language="en-US" Publisher="EWSoftware" />
 		<DisplayName>SHFB</DisplayName>
 		<Description xml:space="preserve">Visual Studio integration for the Sandcastle Help File Builder.</Description>
 		<MoreInfo>https://ewsoftware.github.io/SHFB/html/bd1ddb51-1c4f-434f-bb1a-ce2135d3a909.htm</MoreInfo>

diff --git a/SHFB/Source/VSIX_VS2022/source.extension.vsixmanifest b/SHFB/Source/VSIX_VS2022/source.extension.vsixmanifest
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <PackageManifest Version="2.0.0" xmlns="http://schemas.microsoft.com/developer/vsx-schema/2011" xmlns:d="http://schemas.microsoft.com/developer/vsx-schema-design/2011">
 	<Metadata>
-		<Identity Id="SHFB.A8C96335-DAF7-4D30-89E2-B004400E4525" Version="2021.10.23.0" Language="en-US" Publisher="EWSoftware" />
+		<Identity Id="SHFB.A8C96335-DAF7-4D30-89E2-B004400E4525" Version="2021.11.7.0" Language="en-US" Publisher="EWSoftware" />
 		<DisplayName>SHFB</DisplayName>
 		<Description xml:space="preserve">Visual Studio integration for the Sandcastle Help File Builder.</Description>
 		<MoreInfo>https://ewsoftware.github.io/SHFB/html/bd1ddb51-1c4f-434f-bb1a-ce2135d3a909.htm</MoreInfo>