-
Notifications
You must be signed in to change notification settings - Fork 367
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Added RequiresHtmlExtractBuildStep to the presentation style settings to allow a legacy presentation style to indicate that it still needs the HTML extract step for website output. - Updated documentation for publication.
- Loading branch information
1 parent
223f078
commit e273564
Showing
17 changed files
with
142 additions
and
52 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
74 changes: 74 additions & 0 deletions
74
Documentation/SandcastleBuilder/Content/VersionHistory/v2023.3.4.0.aml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| <?xml version="1.0" encoding="utf-8"?> | ||
| <topic id="ed81b95f-c8d2-4d9e-9397-b50494fc0cc5" 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 2023.3.4.0. See the prior version release notes for information on the | ||
| breaking changes made to the presentation styles implementation.</para> | ||
| </introduction> | ||
|
|
||
| <section> | ||
| <title>Build Tools</title> | ||
| <content> | ||
| <list class="bullet"> | ||
| <listItem> | ||
| <para>Updated the MSHC Component to add whitespace before and after the title element to work around | ||
| an apparent bug in the help viewer that causes it to render a blank TOC.</para> | ||
| </listItem> | ||
|
|
||
| <listItem> | ||
| <para>Updated the Resolve Reference Links component to issue a better warning describing the issue of | ||
| missing/empty <codeInline>cref</codeInline> attribute values.</para> | ||
| </listItem> | ||
|
|
||
| <listItem> | ||
| <para>Fixed some issues in MRefBuilder so that it handles some variations of the template argument | ||
| comparisons when trying to match inherited members.</para> | ||
| </listItem> | ||
| </list> | ||
|
|
||
| </content> | ||
| </section> | ||
|
|
||
| <section> | ||
| <title>Sandcastle Help File Builder</title> | ||
| <content> | ||
| <list class="bullet"> | ||
| <listItem> | ||
| <para>Removed wording about using the HTML website option if a local web server cannot be found to | ||
| view the output.</para> | ||
| </listItem> | ||
|
|
||
| <listItem> | ||
| <para>Fixed an odd case where selecting the wrong framework type to document assemblies caused | ||
| duplicate TOC entries.</para> | ||
| </listItem> | ||
| </list> | ||
| </content> | ||
| </section> | ||
|
|
||
| <section> | ||
| <title>Presentation Styles</title> | ||
| <content> | ||
| <list class="bullet"> | ||
| <listItem> | ||
| <para>Fixed handling of section elements without a title when building the auto-outline.</para> | ||
| </listItem> | ||
|
|
||
| <listItem> | ||
| <para>Added handling of empty types and enumerations.</para> | ||
| </listItem> | ||
|
|
||
| <listItem> | ||
| <para>Updated the presentation styles to handle missing or blank <codeInline>cref</codeInline> | ||
| attribute values.</para> | ||
| </listItem> | ||
| </list> | ||
| </content> | ||
| </section> | ||
|
|
||
| <relatedTopics> | ||
| <link xlink:href="078cc1c7-7995-431e-bf9c-8813becbe8df" /> | ||
| </relatedTopics> | ||
|
|
||
| </developerConceptualDocument> | ||
| </topic> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,8 +2,8 @@ | |
| // System : Sandcastle Tools Standard Presentation Styles | ||
| // File : VisualStudio2013PresentationStyle.cs | ||
| // Author : Eric Woodruff ([email protected]) | ||
| // Updated : 08/06/2022 | ||
| // Note : Copyright 2014-2022, Eric Woodruff, All rights reserved | ||
| // Updated : 03/03/2023 | ||
| // Note : Copyright 2014-2023, Eric Woodruff, All rights reserved | ||
| // | ||
| // This file contains the presentation style definition for the Visual Studio 2013 presentation style. | ||
| // | ||
|
|
@@ -20,7 +20,6 @@ | |
| using System; | ||
| using System.Collections.Generic; | ||
| using System.IO; | ||
| using System.Linq; | ||
| using System.Reflection; | ||
|
|
||
| using Sandcastle.Core; | ||
|
|
@@ -52,6 +51,9 @@ public VisualStudio2013PresentationStyle() | |
|
|
||
| this.SupportsNamespaceGrouping = this.SupportsCodeSnippetGrouping = true; | ||
|
|
||
| // This is the legacy format and requires the HTML extract build step for website output | ||
| this.RequiresHtmlExtractBuildStep = true; | ||
|
|
||
| this.DocumentModelApplicator = new StandardDocumentModel(); | ||
| this.ApiTableOfContentsGenerator = new StandardApiTocGenerator(); | ||
| this.TopicTransformation = new VisualStudio2013Transformation(this.SupportedFormats, this.ResolvePath); | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,9 @@ | ||
| //=============================================================================================================== | ||
| //=============================================================================================================== | ||
| // System : Sandcastle Help File Builder Utilities | ||
| // File : BuildProcess.cs | ||
| // Author : Eric Woodruff ([email protected]) | ||
| // Updated : 10/07/2022 | ||
| // Note : Copyright 2006-2022, Eric Woodruff, All rights reserved | ||
| // Updated : 03/03/2023 | ||
| // Note : Copyright 2006-2023, Eric Woodruff, All rights reserved | ||
| // | ||
| // This file contains the thread class that handles all aspects of the build process. | ||
| // | ||
|
|
@@ -1324,7 +1324,7 @@ public void Build() | |
| // to be ran for website output anymore. | ||
| if((project.HelpFileFormat & HelpFileFormats.HtmlHelp1) != 0 || | ||
| ((project.HelpFileFormat & HelpFileFormats.Website) != 0 && | ||
| presentationStyle.BasePath == "VS2013")) | ||
| presentationStyle.RequiresHtmlExtractBuildStep)) | ||
| { | ||
| this.ReportProgress(BuildStep.ExtractingHtmlInfo, | ||
| "Extracting HTML info for HTML Help 1 and/or website..."); | ||
|
|
@@ -1345,7 +1345,7 @@ public void Build() | |
|
|
||
| this.ExecutePlugIns(ExecutionBehaviors.After); | ||
|
|
||
| // Keep the HTML extract tool around until after the help file is build as plug-ins | ||
| // Keep the HTML extract tool around until after the help 1 file is built as plug-ins | ||
| // may rely on it for values such as the localized file folder. | ||
| } | ||
| } | ||
|
|
@@ -1622,8 +1622,7 @@ public void Build() | |
|
|
||
| this.ExecutePlugIns(ExecutionBehaviors.After); | ||
|
|
||
| if(componentContainer != null) | ||
| componentContainer.Dispose(); | ||
| componentContainer?.Dispose(); | ||
| } | ||
| catch(Exception ex) | ||
| { | ||
|
|
@@ -1642,8 +1641,7 @@ public void Build() | |
| if(this.CurrentBuildStep == BuildStep.Completed && !project.KeepLogFile) | ||
| File.Delete(this.LogFilename); | ||
|
|
||
| if(resolver != null) | ||
| resolver.Dispose(); | ||
| resolver?.Dispose(); | ||
| } | ||
| } | ||
| } | ||
|
|
@@ -1723,33 +1721,27 @@ protected void ReportProgress(BuildStep step, string message, params object[] ar | |
| "{0:00}:{1:00}:{2:00.0000}", Math.Floor(runtime.TotalSeconds / 3600), | ||
| Math.Floor((runtime.TotalSeconds % 3600) / 60), (runtime.TotalSeconds % 60))); | ||
|
|
||
| if(swLog != null) | ||
| swLog.WriteLine(pa.Message); | ||
| swLog?.WriteLine(pa.Message); | ||
|
|
||
| if(this.ProgressReportProvider != null) | ||
| this.ProgressReportProvider.Report(pa); | ||
| this.ProgressReportProvider?.Report(pa); | ||
| } | ||
|
|
||
| if(this.ProgressReportProvider != null) | ||
| this.ProgressReportProvider.Report(new BuildProgressEventArgs(this.CurrentBuildStep, false, | ||
| "-------------------------------")); | ||
| this.ProgressReportProvider?.Report(new BuildProgressEventArgs(this.CurrentBuildStep, false, | ||
| "-------------------------------")); | ||
|
|
||
| stepStart = DateTime.Now; | ||
| this.CurrentBuildStep = step; | ||
|
|
||
| if(swLog != null) | ||
| swLog.WriteLine("</buildStep>\r\n<buildStep step=\"{0}\">", step); | ||
| swLog?.WriteLine("</buildStep>\r\n<buildStep step=\"{0}\">", step); | ||
| } | ||
|
|
||
| pa = new BuildProgressEventArgs(this.CurrentBuildStep, stepChanged, | ||
| args == null || args.Length == 0 ? message : String.Format(CultureInfo.CurrentCulture, message, args)); | ||
|
|
||
| // Save the message to the log file | ||
| if(swLog != null) | ||
| swLog.WriteLine(HttpUtility.HtmlEncode(pa.Message)); | ||
| swLog?.WriteLine(HttpUtility.HtmlEncode(pa.Message)); | ||
|
|
||
| if(this.ProgressReportProvider != null) | ||
| this.ProgressReportProvider.Report(pa); | ||
| this.ProgressReportProvider?.Report(pa); | ||
| } | ||
| #endregion | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,8 +2,8 @@ | |
| // System : Sandcastle Help File Builder | ||
| // File : AssemblyInfoShared.cs | ||
| // Author : Eric Woodruff ([email protected]) | ||
| // Updated : 12/30/2022 | ||
| // Note : Copyright 2006-2022, Eric Woodruff, All rights reserved | ||
| // Updated : 03/04/2023 | ||
| // Note : Copyright 2006-2023, Eric Woodruff, All rights reserved | ||
| // | ||
| // Sandcastle Help File Builder common assembly attributes. | ||
| // | ||
|
|
@@ -90,14 +90,14 @@ 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 = "22.12.30.0"; | ||
| public const string FileVersion = "23.3.4.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 = "2022.12.30.0"; | ||
| public const string ProductVersion = "2023.3.4.0"; | ||
|
|
||
| // Assembly copyright information | ||
| public const string Copyright = "Copyright \xA9 2006-2022, Eric Woodruff, All Rights Reserved"; | ||
| public const string Copyright = "Copyright \xA9 2006-2023, Eric Woodruff, All Rights Reserved"; | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,8 +2,8 @@ | |
| // System : Sandcastle Tools - Sandcastle Tools Core Class Library | ||
| // File : PresentationStyleSettings.cs | ||
| // Author : Eric Woodruff ([email protected]) | ||
| // Updated : 11/11/2022 | ||
| // Note : Copyright 2012-2022, Eric Woodruff, All rights reserved | ||
| // Updated : 03/03/2023 | ||
| // Note : Copyright 2012-2023, Eric Woodruff, All rights reserved | ||
| // | ||
| // This file contains a class that is used to contain settings information for a specific presentation style | ||
| // | ||
|
|
@@ -87,6 +87,13 @@ public abstract class PresentationStyleSettings | |
| /// in the project.</remarks> | ||
| public bool SupportsCodeSnippetGrouping { get; protected set; } | ||
|
|
||
| /// <summary> | ||
| /// This is used to get or set whether or not the presentation style requires the HTML extract build step | ||
| /// for website output. | ||
| /// </summary> | ||
| /// <value>This is false by default and is currently only used by the legacy VS2013 presentation style</value> | ||
| public bool RequiresHtmlExtractBuildStep { get; protected set; } | ||
|
|
||
| /// <summary> | ||
| /// This read-only property returns the list of help content file locations | ||
| /// </summary> | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.