Version 2014.4.22.0

Release notes for version 2014.4.22.0.

Help File Builder

  • Fixed the referenced namespace extraction code so that it finds referenced types regardless of where they appear in the reflection data.

  • Fixed the component search so that it ignores security exceptions such as being denied access to certain subfolders.

  • Fixed HelpLibraryManagerLauncher so that it correctly detects the default locale for Help Viewer 1.0 and 2.x when multiple help languages are present on the system.

  • Fixed the TOC Exclusion plug-in so that it runs in the correct build steps.

  • Fixed up some issues with non-GUID topic IDs that needed encoding in the intermediate TOC files.

  • Changed the build engine to throw an exception with a message indicating that the component/plug-in configurations need to be updated if the old {@SandcastlePath} replacement tag is encountered.

  • Enabled PreBuildEvent, PostBuildEvent, and RunPostBuildEvent property support in the help file builder targets file. A property page was added to allow editing the properties in the standalone GUI and the Visual Studio Package.

  • Merged the C# IntelliSense extension code from Sam Harwell into the Visual Studio package to provide support for the extended XML comments elements from Sandcastle. Note that other languages do not support the extensions. Visual Basic does not provide any context to extend the XML comments easily and other languages like F# and C++ don't appear to provide XML comments IntelliSense at all.

  • Added support for the new Open XML help file format and presentation style.

      Important

    The Open XML format has some specific requirements. See the Open XML Document Help File Format topic for details and information on troubleshooting problems with the resulting output.

  • Added support for the new VS2013 presentation style. This is currently a clone of the VS2010 style with some changes to get rid of the background images, alter the syntax and code block tabs styles, and add collapsible sections. A future release will make further changes to bring it closer to the online Visual Studio content style.

Sandcastle Tools

  • Fixed a bug in MRefBuilder in TypeNode.GetMatchingMethod() reported by Sam Harwell. Type parameter counts are compared as well in order to get a correct match on overloaded methods in cases where one has and one does not have generic parameters.

  • Added more code to ParametersMatch() in MRefBuilder to try and get a proper match when comparing parameters lists with generic types.

  • Fixed MRefBuilder so that it does not fail when parsing .NET Micro Framework assemblies.

  • Added code to default to looking up target IDs starting with "System." or "Microsoft." using the MSDN web service if not found in the project reflection data sources rather than reporting them as unknown reference links. This should help add links to MSDN content for Microsoft SDKs without having to add additional reference link data to the help project. If not found on MSDN, they will be reported as unresolved reference links.

  • Updated the AddNamespaceGroups tool to merge sub-groups into the parent if they are the only child of the parent group

  • Removed leading blank lines and trailing whitespace to get rid of excess whitespace in the resulting code sections produced by the ExampleComponent.

  • In ShowMissingComponent, self-closing conceptualLink, see, paramref, and typeparamref elements will also satisfy the documentation check. For example: <returns> <see cref="String"/> </returns>).

  • Added support for an outputMethod attribute on the BuildAssembler SaveComponent to allow defining how the content is written out (i.e. HTML rules rather than XML rules). However, the default will remain XML and the existing presentation styles will continue to use XML rules since they work fine with them. Note that using HTML rules can introduce unintended side-effects to the generated output such as non-XHTML compliant formatting, self-closing elements getting converted to full opening/closing element pairs etc. Also, there are alternatives that make it unnecessary such as using an "<xsl:comment/>" or "<xsl:text> </xsl:text>" element to enforce non-self-closing output of an element.

  • Added support for the .NET Micro Framework versions 4.2 and 4.3.

Presentation Styles

  • Added a new Open XML presentation style that can be used to produce Open XML documents. These are convertible to other proprietary formats such as PDF.

  • Fixed up some minor issues in the Hana, Prototype, VS2005, and VS2010 presentation styles such as incorrect style names, extraneous elements, and obsolete resource items found while creating the Open XML presentation style.

  • Added support to the codeEntityReference MAML element for a linkText attribute that can be added to override the default member ID link text with link text of your choosing.

  • Modified the TOCTitle metadata attribute for namespaces so that it only outputs the namespace name to match the online MSDN content.

  • Fixed ApplyVSDocModel.xsl so that it correctly includes the type element for member list pages.

  • Cleaned up the VS2010 presentation style by removing a lot of unused elements. Also removed all the unused branding templates and moved most of the processing back into the presentation style as a first step to getting rid of branding completely.

  • Fixed up a number of minor issues in all presentation styles found while removing the branding transformations.

  • Added a VS2013 presentation style. This is currently a clone of the VS2010 style with some changes to get rid of the background images, alter the syntax and code block tabs styles, and add collapsible sections. A future release will make further changes to bring it closer to the online Visual Studio content style.

See Also

Other Resources