Version 2019.8.24.0

Release notes for version 2019.8.24.0.

• Breaking Changes
• Sandcastle Tools
• Sandcastle Help File Builder
• Presentation Styles

The MTPS content service and the links generated by it to the old MSDN website are becoming more unreliable and their continued existence is growing questionable. As such, this release replaces the content service with the Microsoft Docs cross reference service and all links to online framework member content now go to the new Docs.Microsoft.com website. This resulted in some breaking changes as described below.

• The reference link resolver components now cache full URLs to the topics rather than just the content ID. The old MSDN content ID cache file is now obsolete and will no longer be used. A new URL cache will be created and populated so the first builds done with this release will be slower than usual. Once the cache is populated with the common URLs for members referenced by your code, subsequent builds will be faster.

• If you have created custom presentation styles, you will need to update the BuildAssembler.config files with changes to the configuration of the Resolve Reference Links Component. Specifically, replace all of the MSDN content ID cache lines with ones for the new member ID URL cache:

   Copy

  <msdnContentIdCache path="{@LocalDataFolder}Cache\MsdnContentId.cache" />
  
  Changes to:
  
  <memberIdUrlCache path="{@LocalDataFolder}Cache\MemberIdUrl.cache" />

  In addition, all of the hard-coded URLs to the old MSDN website were replaced with links to the new site. You should compare the content files and merge those changes into your custom presentation styles as well.

• If you use the ESent Resolve Reference Links Component or the SQL Resolve Reference Links Component you will need to delete them from the Build Components category in your help file builder projects, add them back, and reconfigure them. This includes recreating the database and tables that they use. This is necessary as the database format has changed to support the new member ID URL resolver.

• Fixed the API filter in MRefBuilder so that it compares the template name to determine whether types derived from them are exposed.

• Removed the MTPS content web service reference and the MSDN resolver from the BuildAssembler components.

• Added the new Microsoft Docs cross reference service resolver to the BuildAssembler components.

• Updated the reference link resolver build components to use the new cross reference service.

• Replaced all references to MSDN with general references to online links/content.

• Updated the BuildAssembler.config files with changes to the Resolve Reference Links component configuration.

• Replaced all hard-coded URLs to MSDN content with links to the equivalent Docs.Microsoft.com content.

Other Resources