A new set of templates have been introduced inspired by the latest Microsoft Documentation style. These new templates introduce a simplified and fresh layout and typography featuring a frameless design with in-page Table of Contents navigation, a right hand action bar with automatic "In this Topic" support and a page layout that is responsive to the available screen width.
The new Templates are available for every supported documentation type.
It is now possible to move and rename Other Files directly on the Project Explorer. References to the moved and renamed Other Files (e.g. images, Widgets and links) are automatically updated. To round off this new functionality, it is now also possible to create new Other Files folders from the Project Explorer. Source Control integrated projects are fully supported.
Integration with the release version of Visual Studio 2017 (all versions), including the Visual Comment Editor for authoring C#, Visual Basic and C++/CLI code xml comments.
Support for Microsoft Help Viewer 2.3, the updated version of Microsoft Help Viewer included with Visual Studio 2017. Output that targets Microsoft Help Viewer will now automatically register with Microsoft Help Viewer 2.3 if it is installed locally, a link to view the generated output will be included in the Build Results and batch files will be generated with the commands necessary to deploy help to Microsoft Help Viewer 2.3 on other machines.
The support for Copy to Clipboard in Colorized Example Code widgets has been improved and removes the dependency on Adobe Flash. Copying to clipboard now results in a subtle notification that appears beside the "Copy Code" button when clicked.
For the end user using the content you generate, the Classic Templates are functionally and visually identical to the old 2012 Style templates. Any projects that currently use the 2012 Style Templates will be automatically migrated to the Classic Templates the first time the project is opened. Migration includes automatic updates to any existing stylesheets that reference the old 2012 Style CSS Class Names and Ids.
A new set of Templates have been introduced inspired by the Google "Material" design style. The templates feature a clean and crisp serif font and bold header coloring that helps frame the main content area of each page. These new Templates make subtle changes to layout and typography in response to the available display width, as well as including full responsive support on touch enabled devices.
The Material Templates are available for every supported documentation type. The new Material Browser Help Template features styling to match the content Templates and includes vector icons for the Table of Contents that scale without loss of quality on high resolution displays.
The Style Picker has been significantly enhanced. It is now possible to apply and remove multiple Style Rules to selected content by simply ticking and unticking available Rules. Style Rules can be created in specific Project or Template Stylesheets directly from the Style Picker. Style Rules can be edited and deleted directly from buttons next to each Rule in the Style Picker.
If you are making use of a custom Template, the Style Picker now includes the ability to save custom Style Rules in a Template Stylesheet, so that rules can be shared across multiple projects.
2016.1 introduces functionality that makes it quick and easy to override the default styles applied to various page elements, directly from the context menu in the Content Editor or from a new "Template Style Rule Overrides" section in the Style Picker. As an example, simply right click on the page title in the Topic Editor and choose "Override Template Style\Page Title" from the context menu in order to create a custom Style Rule that will apply to the Page Title in each generated page.
As with other regular Style Rules, Template Style Rule Overrides can be edited and deleted directly from the Style Picker.
The Templates page in the Build Profile Editor has been simplified and enhanced to make it quick and easy to changes the Templates used. The new Templates page allows you to create or open for edit a custom Template directly.
Browser Help Full Text Search has been comprehensively improved. Specific improvements include searching for words chained with "+" or "." characters (e.g. MyNamespace.MyType), searching in Example and Syntax content (all page content is now included in the search), searching for numbers, wildcard (* or ?) search, phrase search (multiple words surrounded with quotes), improved ranking of search results and a fix for secondary page titles in search results (e.g. Members pages).
The script code automatically generated by Document! X and HelpStudio if the Google Analytics integration option is enabled in the Build Profile Editor has been updated to the latest Google Universal Analytics, in preparation for the eventual deprecation of the earlier ga.js based script. No action is necessary to take advantage of this update.
Initial support has been introduced to support documenting assemblies targeting the current WinRT version as well as Universal Windows Platform assemblies.
Experimental integration with Visual Studio 2017 RC, including the Visual Comment Editor available for C#, VB and C++/CLI files.
Support for Microsoft Help Viewer 2.3 RC, the updated version of Microsoft Help Viewer included with Visual Studio 2017 RC. Output that targets Microsoft Help Viewer will now automatically register with Microsoft Help Viewer 2.3 RC if it is installed locally, a link to view the generated output will be included in the Build Results and batch files will be generated with the commands necessary to deploy help to Microsoft Help Viewer 2.3 RC on other machines.
Support for Team Foundation Server 2017 RC and the latest version of Visual Studio Team Services for Source Control Integration.
Integration with Visual Studio 2015, including the Visual Comment Editor available for C#, VB and C++/CLI code files.
Support for Microsoft Help Viewer 2.2, the updated version of Microsoft Help Viewer included with Visual Studio 2015. Output that targets Microsoft Help Viewer will now automatically register with Microsoft Help Viewer 2.2 if it is installed locally, a link to view the generated output will be included in the Build Results and batch files will be generated with the commands necessary to deploy help to Microsoft Help Viewer 2.2 on other machines.
Support for Microsoft Team Foundation Server 2015 for Source Control integration.
Full support for use on the new Windows 10 operating system.
It is now possible to enable Discussion/Community Features in the generated output using one of several third party cloud based Community/Discussion services. Community Features allow you to create a community around the content that you author with Document! X and HelpStudio by allowing your end users to post feedback and threaded comments. Integrating with the established best of breed Community/Discussion services in this way enables you to choose the service that makes the most sense for your particular scenario. Community Features are enabled using the Community Features page in the Project Profile Editor, are supported throughout the standard templates and are visible when you are authoring.
Additional Short filename generation options have been added to Project Settings to enhance this important area of functionality. It is now possible to save the generated filenames between builds so that the same filename will always be generated for a given item. There are also additional options to shorten / transform the default generated filenames using a regular expression find and replace, or by removing a common file prefix. Shortening can now also be restricted to those filenames that would otherwise exceed a particular length (e.g. the windows path and filename length limitation of 260).
Although a fully automatic Table of Contents containing nodes for all of the items in your documentation project is a huge time saver for reference documentation items, there are times where you might want to divide up the ToC in a more specific way. For example, you might want to include the nodes for a specific assembly or namespace under the a part of the ToC that contains the conceptual topics (introductions, tutorials) that relate to it. This new ToC node type allows you to do that - the portion of the ToC generated for a specific item can thereby be placed anywhere on the ToC. The nodes that are automatically generated for the item can also be customized if required, in the same way as the regular Document! X placeholder node.
This new rule kind makes it easy to create filters in a Build Profile to include/exclude all items from specific documentation types. For example, in a project that contained .NET, COM and Database documentation items you could create a Build Profile that outputs everything apart from .NET documentation, or a Build Profile that only outputs database documentation. This rule kind can also be useful to create a "Topics only" Build Profile (by adding a rule to exclude all reference documentation types) in order to quickly build only conceptual Topic output (e.g. for review).
The new "All Topics Categories" Table of Contents node will automatically generate a Table of Contents structure at build time based on the Topic Category / Topic structure on the Project Explorer. A new "Topic Category" node type will do the same but just for a specific Topic Category. These new node types will save time and effort in arranging the Table of Contents if your Project Explorer already reflects the structure you would like to see on the Table of Contents.
Build Configuration Event Actions allow you to define actions you want to perform when building a particular saved Build Configuration. Actions can be executed before or after the Build or Publishing operations. Actions can invoke an external program or script, or show/log a custom build message.
It is now possible to derive the content for a Topic from an external source (Quip Documents and Web Pages are initially supported) rather than have it stored within the project. The scenario this new feature addresses is where you have existing content that it is not possible or practical to manage directly within the HelpStudio project; this new functionality allows you to easily leverage and keep up to date such external content.
Widgets for supported external content sources are also available in order to support embedding of external content within an existing Topic or Content File.
This major new feature allows you to automatically publish your generated outputs to a web site or directory path (local or network). Azure, IIS Web Deploy, Ftp and File System Directory Publishing Targets are supported and can be configured on the new Publishing page in the Build Profile Editor.
Publishing can take place as part of the build, or can be run at any point thereafter. Publishing is able to track which files have changed since you last built and published, reducing to a minimum the time and bandwidth it takes to publish your generated outputs.
Support for Microsoft Help Viewer 2.1, the updated version of Microsoft Help Viewer included with Visual Studio 2013. Output that targets Microsoft Help Viewer will now automatically register with Microsoft Help Viewer 2.1 if it is installed locally, a link to view the generated output will be included in the Build Results and batch files will be generated with the commands necessary to deploy help to Microsoft Help Viewer 2.1 on other machines.
Integration with Visual Studio 2013, including the Visual Comment Editor available for C#, VB and C++/CLI code files.
Support for Microsoft Team Foundation Server 2013 for Source Control integration.
Support for Subversion 1.8 for Source Control integration.
Support for installing and running on Windows 8.1 or other Windows versions with IE11 installed.