Skip to content

Commit

Permalink
Minor updates
Browse files Browse the repository at this point in the history
- FileCreatedEventArgs was moved to the Sandcastle.Core assembly so that it is available to other build components.
- TransformingTopicEventArgs and TransformedTopicEventArgs where renamed to ApplyingChangesEventArgs and AppliedChangesEventArgs and were moved to the Sandcastle.Core assembly so that they are available to other build components and can be used for other tasks besides topic transformation.
-  Fixed a problem with the GID0009 circular reference warning for inherited documentation caused by an incorrectly selected MSBuild LogMessage overload.  Fixes #886.
- Added the Pre-transform Document Dump Component for future presentation style development.
  • Loading branch information
EWSoftware committed Jan 22, 2022
1 parent c0d3ca6 commit 28acfd6
Show file tree
Hide file tree
Showing 53 changed files with 697 additions and 359 deletions.
4 changes: 2 additions & 2 deletions 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.11.7.0" />
<tools version="2022.1.22.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. -->
Expand All @@ -13,7 +13,7 @@
<page type="Sandcastle.Installer.InstallerPages.WelcomePage" />

<page type="Sandcastle.Installer.InstallerPages.WhatsNewPage">
<whatsNew url="https://EWSoftware.github.io/SHFB/html/003c85ec-45ad-4123-a31d-fd63a695b1f3.htm"
<whatsNew url="https://EWSoftware.github.io/SHFB/html/5491f230-cc0d-4604-8710-c046584907bd.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" />
Expand Down
2 changes: 1 addition & 1 deletion Documentation/SandcastleBuilder/CommonTokens.tokens
Expand Up @@ -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.11.7.0</item>
<item id="SandcastleVersion">v2022.1.22.0</item>
<item id="VisualStudioMinVersion">Visual Studio 2017</item>
</content>
Expand Up @@ -117,7 +117,7 @@ files. These are installed as part of Visual Studio.</para>
<linkAlternateText>Visual Studio Spell Checker</linkAlternateText>
<linkUri>https://marketplace.visualstudio.com/items?itemName=EWoodruff.VisualStudioSpellCheckerVS2017andLater</linkUri>
<linkTarget>_blank</linkTarget>
</externalLink> extension can be downloaded and installed from the <Bold>Visual Studio Gallery</Bold>. It is an
</externalLink> extension can be downloaded and installed from the <legacyBold>Visual Studio Gallery</legacyBold>. It is an
editor extension that checks the spelling of comments, strings, and plain text as you type or interactively with
a tool window. Support is included for spell checking source code, XML files, and MAML topic files.</para>
</listItem>
Expand Down
18 changes: 9 additions & 9 deletions Documentation/SandcastleBuilder/Content/License.aml
Expand Up @@ -107,50 +107,50 @@ implied warranties of merchantability, fitness for a particular purpose and non-
<linkText>ICSharpCode.TextEditor</linkText>
<linkUri>https://github.com/icsharpcode</linkUri>
<linkTarget>_blank</linkTarget>
</externalLink> is Copyright &#169; 2000-2021, IC#Code, All Rights Reserved.</para>
</externalLink> is Copyright &#169; 2000-2022, IC#Code, All Rights Reserved.</para>

<para>The <externalLink>
<linkText>Weifen Luo DockPanel Suite</linkText>
<linkUri>https://sourceforge.net/projects/dockpanelsuite/</linkUri>
<linkTarget>_blank</linkTarget>
</externalLink> is Copyright &#169; 2007-2021, Weifen Luo, All Rights Reserved. </para>
</externalLink> is Copyright &#169; 2007-2022, Weifen Luo, All Rights Reserved. </para>

<para>The <externalLink>
<linkText>Managed ESENT Library</linkText>
<linkUri>https://github.com/microsoft/managedesent</linkUri>
<linkTarget>_blank</linkTarget>
</externalLink> is Copyright &#169; 2008-2021, Microsoft Corporation, All Rights Reserved.</para>
</externalLink> is Copyright &#169; 2008-2022, Microsoft Corporation, All Rights Reserved.</para>

<para>
<externalLink>
<linkText>AjaxDoc</linkText>
<linkUri>https://github.com/bleroy/ajaxdoc</linkUri>
<linkTarget>_blank</linkTarget>
</externalLink> is Copyright &#169; 2006-2021, Bertrand Le Roy, All Rights Reserved.</para>
</externalLink> is Copyright &#169; 2006-2022, Bertrand Le Roy, All Rights Reserved.</para>

<para>NHunSpell is Copyright &#169; 2009-2021 Maierhofer Software, All Rights Reserved</para>
<para>NHunSpell is Copyright &#169; 2009-2022 Maierhofer Software, All Rights Reserved</para>

<para>
<externalLink>
<linkText>Script#</linkText>
<linkUri>https://github.com/NikhilK/scriptsharp</linkUri>
<linkTarget>_blank</linkTarget>
</externalLink> is Copyright &#169; 2007-2021, Nikhil Kothari, All Rights Reserved.</para>
</externalLink> is Copyright &#169; 2007-2022, Nikhil Kothari, All Rights Reserved.</para>

<para>
<externalLink>
<linkText>SBAppLocale</linkText>
<linkUri>http://www.SteelBytes.com/?mid=45</linkUri>
<linkTarget>_blank</linkTarget>
</externalLink> is Copyright &#169; 2005-2021, Steel Bytes, All Rights Reserved.</para>
</externalLink> is Copyright &#169; 2005-2022, Steel Bytes, All Rights Reserved.</para>

<para>The <externalLink>
<linkText>code colorizer library</linkText>
<linkUri>https://www.codeproject.com/Articles/3767/Multiple-Language-Syntax-Highlighting-Part-2-C-Con</linkUri>
<linkTarget>_blank</linkTarget>
</externalLink> is Copyright &#169; 2003-2021, Jonathan de Halleux, All Rights Reserved.</para>
</externalLink> is Copyright &#169; 2003-2022, Jonathan de Halleux, All Rights Reserved.</para>

<para>All other code is Copyright &#169; 2006-2021, <externalLink>
<para>All other code is Copyright &#169; 2006-2022, <externalLink>
<linkText>Eric Woodruff</linkText>
<linkUri>https://github.com/EWSoftware/SHFB</linkUri>
<linkTarget>_blank</linkTarget>
Expand Down
Expand Up @@ -20,6 +20,11 @@ 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="5491f230-cc0d-4604-8710-c046584907bd" />
</para>
</listItem>
<listItem>
<para>
<link xlink:href="003c85ec-45ad-4123-a31d-fd63a695b1f3" />
Expand Down
@@ -0,0 +1,55 @@
<?xml version="1.0" encoding="utf-8"?>
<topic id="5491f230-cc0d-4604-8710-c046584907bd" 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 2022.1.22.0.</para>
</introduction>

<section>
<title>Changes in This Release</title>
<content>

<list class="bullet">
<listItem>
<para>Potential breaking changes:</para>
<list class="bullet">
<listItem>
<para><codeEntityReference qualifyHint="false">T:Sandcastle.Tools.BuildComponents.FileCreatedEventArgs</codeEntityReference>
was moved to the <localUri>Sandcastle.Core</localUri> assembly so that it is available to other build components.</para>
</listItem>
<listItem>
<para><codeInline>TransformingTopicEventArgs</codeInline> and <codeInline>TransformedTopicEventArgs</codeInline>
where renamed to <codeEntityReference qualifyHint="false">T:Sandcastle.Core.BuildAssembler.BuildComponent.ApplyingChangesEventArgs</codeEntityReference>
and <codeEntityReference qualifyHint="false">T:Sandcastle.Core.BuildAssembler.BuildComponent.AppliedChangesEventArgs</codeEntityReference>
and were moved to the <localUri>Sandcastle.Core</localUri> assembly so that they are available to other build
components and can be used for other tasks besides topic transformation.</para>
</listItem>
</list>
</listItem>

<listItem>
<para>Fixed an incorrect path issue on default empty place holder topics in help viewer output.</para>
</listItem>

<listItem>
<para>Fixed a problem with the GID0009 circular reference warning for inherited documentation.</para>
</listItem>

<listItem>
<para>Added the Pre-transform Document Dump Component. This is a presentation style development aid.
It saves the pre-transformed content of each document to a file in a <localUri>.\RawDocs</localUri> subfolder in
the project's working folder. These files can be used for testing presentation style transformations without
having to do a full project build. This is more for use with upcoming features and its functionality may change
as those plans are revised and implemented.</para>
</listItem>
</list>

</content>
</section>

<relatedTopics>

</relatedTopics>

</developerConceptualDocument>
</topic>
7 changes: 6 additions & 1 deletion Documentation/SandcastleBuilder/SandcastleBuilder.content
Expand Up @@ -1396,11 +1396,16 @@
<HelpKeyword index="K" term="support, donate" />
</HelpKeywords>
</Topic>
<Topic id="078cc1c7-7995-431e-bf9c-8813becbe8df" visible="True" isExpanded="true" isSelected="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="5491f230-cc0d-4604-8710-c046584907bd" visible="True" title="Version 2022.1.22.0">
<HelpKeywords>
<HelpKeyword index="K" term="versions, 2022.1.22.0" />
</HelpKeywords>
</Topic>
<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" />
Expand Down
5 changes: 3 additions & 2 deletions Documentation/SandcastleBuilder/SandcastleBuilder.shfbproj
Expand Up @@ -29,11 +29,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-2021, Eric Woodruff, All rights reserved</CopyrightText>
<CopyrightText>[v{%40HelpFileVersion}] Copyright \xA9 2006-2022, Eric Woodruff, All rights reserved</CopyrightText>
<FeedbackEMailAddress>Eric%40EWoodruff.us</FeedbackEMailAddress>
<PresentationStyle>VS2013</PresentationStyle>
<SyntaxFilters>Standard</SyntaxFilters>
<HelpFileVersion>2021.11.7.0</HelpFileVersion>
<HelpFileVersion>2022.1.22.0</HelpFileVersion>
<ComponentConfigurations>
</ComponentConfigurations>
<DocumentationSources>
Expand Down Expand Up @@ -389,6 +389,7 @@
<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.11.7.0.aml" />
<None Include="Content\VersionHistory\v2022.1.22.0.aml" />
<None Include="Content\VisualStudio\GoToDefinition.aml" />
<None Include="Content\VisualStudio\ItemFileTemplates.aml" />
<None Include="Content\VisualStudio\FeatureComparison.aml" />
Expand Down
91 changes: 45 additions & 46 deletions Documentation/SandcastleMAMLGuide/Content/BlockElements/table.aml
Expand Up @@ -66,69 +66,69 @@ which can be used to achieve a similar effect.</para>
<code language="xml" title=" ">
&lt;para&gt;This link takes you to &lt;link xlink:href="#Row3Cell1"&gt;Row 3, Cell 1&lt;/link&gt;
in the first table.&lt;/para&gt;

&lt;table&gt;
&lt;title&gt;A Simple Table with Title and Headers&lt;/title&gt;
&lt;tableHeader&gt;
&lt;row&gt;
&lt;entry&gt;&lt;para&gt;Header 1&lt;/para&gt;&lt;/entry&gt;
&lt;entry&gt;&lt;para&gt;Header 2&lt;/para&gt;&lt;/entry&gt;
&lt;entry&gt;&lt;para&gt;Header 3&lt;/para&gt;&lt;/entry&gt;
&lt;/row&gt;
&lt;row&gt;
&lt;entry&gt;&lt;para&gt;Header 1&lt;/para&gt;&lt;/entry&gt;
&lt;entry&gt;&lt;para&gt;Header 2&lt;/para&gt;&lt;/entry&gt;
&lt;entry&gt;&lt;para&gt;Header 3&lt;/para&gt;&lt;/entry&gt;
&lt;/row&gt;
&lt;/tableHeader&gt;
&lt;row&gt;
&lt;entry&gt;&lt;para&gt;Row 1, Cell 1&lt;/para&gt;&lt;/entry&gt;
&lt;entry&gt;&lt;para&gt;Row 1, Cell 2&lt;/para&gt;&lt;/entry&gt;
&lt;entry&gt;&lt;para&gt;Row 1, Cell 3&lt;/para&gt;&lt;/entry&gt;
&lt;entry&gt;&lt;para&gt;Row 1, Cell 1&lt;/para&gt;&lt;/entry&gt;
&lt;entry&gt;&lt;para&gt;Row 1, Cell 2&lt;/para&gt;&lt;/entry&gt;
&lt;entry&gt;&lt;para&gt;Row 1, Cell 3&lt;/para&gt;&lt;/entry&gt;
&lt;/row&gt;
&lt;row&gt;
&lt;entry&gt;&lt;para&gt;Row 2, Cell 1&lt;/para&gt;&lt;/entry&gt;
&lt;entry&gt;&lt;para&gt;Row 2, Cell 2&lt;/para&gt;&lt;/entry&gt;
&lt;entry&gt;&lt;para&gt;Row 2, Cell 3&lt;/para&gt;&lt;/entry&gt;
&lt;entry&gt;&lt;para&gt;Row 2, Cell 1&lt;/para&gt;&lt;/entry&gt;
&lt;entry&gt;&lt;para&gt;Row 2, Cell 2&lt;/para&gt;&lt;/entry&gt;
&lt;entry&gt;&lt;para&gt;Row 2, Cell 3&lt;/para&gt;&lt;/entry&gt;
&lt;/row&gt;
&lt;row&gt;
&lt;entry address="Row3Cell1"&gt;&lt;para&gt;This entry has an &lt;codeInline&gt;address&lt;/codeInline&gt;
&lt;entry address="Row3Cell1"&gt;&lt;para&gt;This entry has an &lt;codeInline&gt;address&lt;/codeInline&gt;
attribute that can be used as a link target.&lt;/para&gt;&lt;/entry&gt;
&lt;entry&gt;&lt;para&gt;Row 3, Cell 2&lt;/para&gt;&lt;/entry&gt;
&lt;entry&gt;&lt;para&gt;Row 3, Cell 3&lt;/para&gt;&lt;/entry&gt;
&lt;entry&gt;&lt;para&gt;Row 3, Cell 2&lt;/para&gt;&lt;/entry&gt;
&lt;entry&gt;&lt;para&gt;Row 3, Cell 3&lt;/para&gt;&lt;/entry&gt;
&lt;/row&gt;
&lt;/table&gt;

&lt;table&gt;
&lt;tableHeader&gt;
&lt;row&gt;
&lt;entry&gt;&lt;para&gt;&amp;#160;&lt;/para&gt;&lt;/entry&gt;
&lt;entry&gt;&lt;para&gt;A Nested Table Example&lt;/para&gt;&lt;/entry&gt;
&lt;/row&gt;
&lt;row&gt;
&lt;entry&gt;&lt;para&gt;&amp;#160;&lt;/para&gt;&lt;/entry&gt;
&lt;entry&gt;&lt;para&gt;A Nested Table Example&lt;/para&gt;&lt;/entry&gt;
&lt;/row&gt;
&lt;/tableHeader&gt;
&lt;row&gt;
&lt;entry&gt;&lt;mediaLink&gt;&lt;image
xlink:href="98a8a8b7-c374-40c7-902a-91c947bf107c"/&gt;
&lt;/mediaLink&gt;&lt;/entry&gt;
&lt;/mediaLink&gt;
&lt;/entry&gt;
&lt;entry&gt;
&lt;table&gt;
&lt;row&gt;
&lt;entry&gt;&lt;para&gt;Cell 1&lt;/para&gt;&lt;/entry&gt;
&lt;entry&gt;&lt;para&gt;Cell 2&lt;/para&gt;&lt;/entry&gt;
&lt;entry&gt;&lt;para&gt;Cell 3&lt;/para&gt;&lt;/entry&gt;
&lt;entry&gt;&lt;para&gt;Cell 4&lt;/para&gt;&lt;/entry&gt;
&lt;/row&gt;
&lt;row&gt;
&lt;entry&gt;&lt;para&gt;Cell 5&lt;/para&gt;&lt;/entry&gt;
&lt;entry&gt;&lt;para&gt;Cell 6&lt;/para&gt;&lt;/entry&gt;
&lt;entry&gt;&lt;para&gt;Cell 7&lt;/para&gt;&lt;/entry&gt;
&lt;entry&gt;&lt;para&gt;Cell 8&lt;/para&gt;&lt;/entry&gt;
&lt;/row&gt;
&lt;row&gt;
&lt;entry&gt;&lt;para&gt;Cell 9&lt;/para&gt;&lt;/entry&gt;
&lt;entry&gt;&lt;para&gt;Cell 10&lt;/para&gt;&lt;/entry&gt;
&lt;entry&gt;&lt;para&gt;Cell 11&lt;/para&gt;&lt;/entry&gt;
&lt;entry&gt;&lt;para&gt;Cell 12&lt;/para&gt;&lt;/entry&gt;
&lt;/row&gt;
&lt;/table&gt;

&lt;para&gt;The table above doesn't have a
&lt;codeInline&gt;tableHeader&lt;/codeInline&gt;.&lt;/para&gt;
&lt;table&gt;
&lt;row&gt;
&lt;entry&gt;&lt;para&gt;Cell 1&lt;/para&gt;&lt;/entry&gt;
&lt;entry&gt;&lt;para&gt;Cell 2&lt;/para&gt;&lt;/entry&gt;
&lt;entry&gt;&lt;para&gt;Cell 3&lt;/para&gt;&lt;/entry&gt;
&lt;entry&gt;&lt;para&gt;Cell 4&lt;/para&gt;&lt;/entry&gt;
&lt;/row&gt;
&lt;row&gt;
&lt;entry&gt;&lt;para&gt;Cell 5&lt;/para&gt;&lt;/entry&gt;
&lt;entry&gt;&lt;para&gt;Cell 6&lt;/para&gt;&lt;/entry&gt;
&lt;entry&gt;&lt;para&gt;Cell 7&lt;/para&gt;&lt;/entry&gt;
&lt;entry&gt;&lt;para&gt;Cell 8&lt;/para&gt;&lt;/entry&gt;
&lt;/row&gt;
&lt;row&gt;
&lt;entry&gt;&lt;para&gt;Cell 9&lt;/para&gt;&lt;/entry&gt;
&lt;entry&gt;&lt;para&gt;Cell 10&lt;/para&gt;&lt;/entry&gt;
&lt;entry&gt;&lt;para&gt;Cell 11&lt;/para&gt;&lt;/entry&gt;
&lt;entry&gt;&lt;para&gt;Cell 12&lt;/para&gt;&lt;/entry&gt;
&lt;/row&gt;
&lt;/table&gt;

&lt;para&gt;The table above doesn't have a &lt;codeInline&gt;tableHeader&lt;/codeInline&gt;.&lt;/para&gt;
&lt;/entry&gt;
&lt;/row&gt;
&lt;/table&gt;
Expand All @@ -141,7 +141,7 @@ attribute that can be used as a link target.&lt;/para&gt;&lt;/entry&gt;
<content>
<para>This link takes you to <link xlink:href="#Row3Cell1">Row 3, Cell 1</link>
in the first table.</para>

<table>
<title>A Simple Table with Title and Headers</title>
<tableHeader>
Expand Down Expand Up @@ -202,8 +202,7 @@ attribute that can be used as a link target.</para></entry>
</row>
</table>

<para>The table above doesn't have a
<codeInline>tableHeader</codeInline>.</para>
<para>The table above doesn't have a <codeInline>tableHeader</codeInline>.</para>
</entry>
</row>
</table>
Expand Down
18 changes: 9 additions & 9 deletions LICENSE
Expand Up @@ -63,28 +63,28 @@ purpose and non-infringement.

Copyright Notices
-----------------
The ICSharpCode.TextEditor is Copyright (c) 2000-2021 IC#Code, All Rights
The ICSharpCode.TextEditor is Copyright (c) 2000-2022 IC#Code, All Rights
Reserved.

The Weifen Luo DockPanel Suite is Copyright (c) 2007-2021 Weifen Luo and other
The Weifen Luo DockPanel Suite is Copyright (c) 2007-2022 Weifen Luo and other
contributors, All Rights Reserved.

The NHunspell library is Copyright (c) 2009-2021 Maierhofer Software, All
The NHunspell library is Copyright (c) 2009-2022 Maierhofer Software, All
Rights Reserved.

The Managed ESENT library is Copyright (c) 2008-2021 Microsoft Corporation, All
The Managed ESENT library is Copyright (c) 2008-2022 Microsoft Corporation, All
Rights Reserved.

AjaxDoc is Copyright (c) 2006-2021 Bertrand Le Roy, All Rights Reserved.
AjaxDoc is Copyright (c) 2006-2022 Bertrand Le Roy, All Rights Reserved.

Script# is Copyright (c) 2007-2021 Nikhil Kothari, All Rights Reserved.
Script# is Copyright (c) 2007-2022 Nikhil Kothari, All Rights Reserved.

SBAppLocale is Copyright 2005-2021 Steel Bytes, All Rights Reserved.
SBAppLocale is Copyright 2005-2022 Steel Bytes, All Rights Reserved.

The code colorizer library is Copyright (c) 2003-2021, Jonathan de Halleux,
The code colorizer library is Copyright (c) 2003-2022, Jonathan de Halleux,
All Rights Reserved.

All other code is Copyright (c) 2006-2021, Eric Woodruff, All Rights Reserved.
All other code is Copyright (c) 2006-2022, 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
Expand Down
2 changes: 1 addition & 1 deletion NuGet/SHFB.nuspec
Expand Up @@ -2,7 +2,7 @@
<package xmlns="http://schemas.microsoft.com/packaging/2011/08/nuspec.xsd">
<metadata>
<id>EWSoftware.SHFB</id>
<version>2021.11.7.0</version>
<version>2022.1.22.0</version>
<title>Sandcastle Help File Builder</title>
<authors>Eric Woodruff</authors>
<owners>Eric Woodruff</owners>
Expand Down
6 changes: 6 additions & 0 deletions SHFB/Source/.editorconfig
Expand Up @@ -131,3 +131,9 @@ dotnet_diagnostic.IDE0057.severity = none

# IDE0063: Use simple 'using' statement
dotnet_diagnostic.IDE0063.severity = none

# CA1845: Use span-based 'string.Concat'
dotnet_diagnostic.CA1845.severity = none

# CA1846: Prefer 'AsSpan' over 'Substring'
dotnet_diagnostic.CA1846.severity = none

0 comments on commit 28acfd6

Please sign in to comment.