☰ Menu

Document! X and HelpStudio Bundle 2015.2 Release Note

Update 15.2.71

Released on 7/7/2016 11:23:49 PM

This update contains fixes for issues resolved since update 15.2.68.

Responsive output sometime shows blank until page refreshes on Android and Chrome browsers
Resharper DotTrace causes exception when using Document! X in Visual Studio
A conflicting dependency was being incorrectly resolved by Visual Studio to the Resharper installation folder instead of the Document! X installation folder.
Exception when building a project containing a nested Enum in a generic type

Update 15.2.68

Released on 4/13/2016 7:05:33 PM

This update contains a revised digital signature to prevent SmartScreen errors when installing

Update 15.2.63

Released on 1/7/2016 8:55:09 PM

This update contains fixes for issues resolved since update 15.2.51.

Image Capture includes additional area (drop shadows) when capturing on Windows 8 and Windows 10
\"Content from Web Page\" topics and widgets now support relative paths (relative to the project directory)
Project Find and Replace, Link Check and Spell Check will now show a warning box if opened with a Locale different to the current Locale
As these tools use the Locale that is active when they are opened it was previously possible to inadvertently run these tools in a different Locale to the current one (i.e. Open Find and Replace when the Locale was set to the Primary Locale, change to a secondary Locale and then come back and run Find and Replace). The warning box identifies that the Locale the tool will use is different from the currently active locale.
Document! X has now completed the Microsoft tests for Windows 10 Certification
NamespaceDoc and AssemblyDoc Namespace and Assembly documentation placeholders are now supported in .NET xml comments
.NET Xml comments do not natively support content for Namespaces and Assemblies. In order to work around this limitation, Document! X will now look for a summary Xml comment in a \"NamespaceDoc\" class (which can be marked with the CompilerGenerated attribute) for the Namespace summary and in an \"AssemblyDoc\" class (in any assembly) for the Assembly summary.
A new \"Include Numeric Values in Enumeration Member Lists\" option has been added to the \".NET Settings\" page in the Build Profile Editor
This new option will enable you to automatically include numeric values in the Member Lists for Enumerations. Direct use of enumeration numeric values is discouraged in .NET but there are scenarios in which this information is required (i.e. for .NET interop with other systems and languages).
Exception when right clicking on a missing image in the Topic Editor
When capturing the Active Window using Image Capture, the title bar and border are always included even if the \"Do not include the window title bar and border\" option is ticked
Image reported as unused by the \"Find Unused Images\" tool when used only in a Content Snippet
Exception when creating a new project if the target project could not be created in the selected path
Intermittent exception during import
Find Unused Images tool was previously only checking the current Build Profile. All Profiles are now checked.
Intermittent exception during import when running in 64bit version
See Also link to a website does not show the link caption in Web Service, Database and XSD Documentation projects
Excluded types are included in namespace hierarchy if they inherit from an included type
Crash when opening the topic editor in a project containing a .NET assembly with a large interface inheritance hierarchy

Update 15.2.51

Released on 10/29/2015 12:48:19 PM

This update contains fixes for issues resolved since update 15.2.49.

Exception when using Source Control with a Content File Editor window open

Update 15.2.49

Released on 10/16/2015 1:02:10 PM

This update contains fixes for issues resolved since update 15.2.33.

Search results in web output are now always visible if highlight search results option ticked, even if contained in a Drop Down section or Collapsible Heading Widget
Automatically constrain the size of the dynamic image widget overlay to the available window size
Will now prompt for a custom caption when creating a new Toc Heading node
Exceptions reported from the Build Results window (or other \"Report Error\" buttons) will no longer cause the application to terminate
Database documentation now supports multi line TSQL source comments
Comments can appear in the same or separate multi line comment blocks. Example:\r\n/* ##SUMMARY Summary content\r\n ##REMARKS Comments can flow \r\n onto separate lines\r\n*/\r\n/* ##RETURNS Multiple multi line comment blocks can be used, \r\n or all comments can be included in a single block\r\n*/
Added an "Edit Content File" context menu item to child documentable items on the Project Explorer to easily open the Content File Editor and navigate to that item
Exceptions reported from the Build Results window (or other "Report Error" buttons) will no longer cause the application to terminate
Ability to document Azure Sql Databases, including the latest v12 version
Source Control Errors when deleting and then immediately adding back images from the same location
Exception when choosing a character from the extended character sets on the Insert Symbol dialog
Property value used in Booklet Title not expanded (in Adobe Reader title bar) in generated PDF booklet
After dragging and dropping Table of Contents nodes, the order of the dropped nodes is sometimes reversed
Images are not refreshed in an open Topic or Content File editor when updated or replaced on disk
"Remove Unused Images" tool identifies images used in a Content File with localization disabled and primary locale excluded
Nested Content Snippet are not shown when the nested snippet is already present elsewhere on the page
CHM prompts to download first script file if an invalid (removed or excluded) Default Topic is defined in the Build Profile
WidgetContentFromFile topic in the online help contained a typo
Heading numbers duplicated when there are child topics and numbered headings for a given Topic in a PDF Booklet
Exception when answering No to Source Control checkout prompt when creating a new Content Snippet
Additional elements inserted into page content when indenting / outdenting certain bullet or numbered list items
Link Designer dialog does not show topic bookmarks with just the id attribute set
"Collapse All" and "Expand All" missing translations in Italian phrase table
Build exception if a Topic contains an Include Topic widget with a missing source property
Exception when using "Where is this used" functionality in a project that generates very long filenames
Help 2.x heading ToC nodes not imported (i.e. nodes that don't reference a url)
When building a CHM output, the Html Help Compiler fails if Topic or reference documentation items contain non ASCII characters
The Microsoft Html Help Compiler used to create CHM outputs does not support unicode and throws an error if a content filename contains non ASCII characters (such as umlauts). This change attempts to work around this limitation by substituting such characters in the output filenames.
New Topics don't get added to the Topic Category that is selected on the Project Explorer
Custom port value for an FTP publishing target is not saved
Exception when publishing web help if the build output directory is set to the \\build project sub-directory root
Exception when importing from a Help 2.x project with pages containing unclosed MSHelp attributes in the Xml island
Error 500 - Fail on Install when registering a Microsoft Help Viewer output
Search term not highlighted when using full text search in web output on local drive rather than web server
Exception when importing from a Help 2.x project with a malformed Xml island
Build error when building a PDF Booklet in a project containing ToC nodes that point to word or excel documents (or other file types) added as Other Files
Source Control Get Latest or Checkouts performed externally whilst a project was open could result in subsequent changes being overwritten
Broken links after importing from a Help 2.x project (.HxC file)
A newly created bookmark is not available as the target for a new table of contents node, hyperlink or See Also link
Added a more useful error message if the Microsoft Help Viewer signing process fails (usually caused by lack of internet connectivity)
Removed non functional Twitter widgets in the Internet Feed Widget Pack and replaced with a new Twitter Widget
Changes in the Twitter API rendered the previous Twitter Search Feed and Twitter User Feed Widgets non functional. They have now been removed and replaced with a single Twitter Widget in the main Widget list that uses the new Twitter Widget mechanism which is fully supported by Twitter.
Exception when generating Microsoft Help Viewer .NET documentation if the the option to generate a .NET xml comment file is enabled and content contains links to .NET framework members
.NET Xml comment files are not automatically reloaded when they change on disk, so comments shown in the Content File Editor can sometimes be out of date
Error dialog when adding a new Web Service to a project if an incorrect web service definition type is specified
The advisory message on the error dialog has been improved to suggest double checking that the correct Web Service Definition Type and location have been specified when a load error is encountered.
When creating a new project from Visual Studio, VC++ assemblies may not found if the output path contains the $(Configuration) placeholder
See Also link category for reference documentation items is not always a consistent default
See Also links created in Topics to reference items, and See Also links to Topics created directly from the New button embedded in the Content File editor create See Also links with a blank category. This change sets the category to \"Link Target\" - i.e. for reference links in Topics the default category will be \"Reference\" and for Topic links created in reference topics the target Topic's Category will be used.
Shortcut link / cref generated by Comment Editor for C++ source uses \".\" instead of \"::\"
Exception switching to a secondary locale in a project with multiple custom Document! X Placeholder Table of Contents Nodes
Javascript "Include Private Members" setting in Build Profile Editor reset each time the project is saved
Load error when a @namespace comment is associated with a conditional assignment
Order of buttons on the Content File Editor toolbar incorrect for .NET - private and friend are first, rest further over
Exception when trying to add a Web Service using a WADL definition
Exception when creating a new project based on a Javascript sample if UAC is enabled
Exception when trying to document a Sql Database hosted on Azure
XSDs disappearing in a project containing both WSDL Web Services and manually added XSDs
Data Type column in SOAP Web Service parameter table is \"(undefined)\" for references to inline elements
Missing Summary content item type in toolbar / Menu Strip for COM Project
Editing a database column summary in a content file (database column) does not always immediately mark the content file as dirty (save button disabled)
Build error when building a project with a widget property containing an empty name property

Update 15.2.33

Released on 9/4/2015 2:55:11 PM

This update contains fixes for issues resolved since update 15.2.28.

PDF Booklet output only part of the page if Windows DPI set to > 100% on Windows 8 or higher
Search box in Ribbon title bar is not finding results in Project Settings and Project Profile Editors
Images not automatically imported when importing from external sources (Html Help, Word, Html Files)

Update 15.2.28

Released on 8/12/2015 4:01:09 PM

This update contains fixes for issues resolved since update 15.2.27.

'Find Orphaned Content' tool doesn't identify orphaned content against parameters
Javascript nested namespaces not correctly identified
In Javascript docs, @enum not documenting members and showing as namespaces as well as enums
In Javascript documentation, class marked with @class comment not documented as a class
Find Orphaned Content - Parameter cannot be assigned to another parameter
Event parameters not showing in the Content File editor for COM Documentation and consequently cannot be edited in XHTML mode

Update 15.2.27

Released on 8/6/2015 12:19:14 PM

This update contains fixes for issues resolved since initial release.

Initial release version

Released on 8/5/2015 6:00:11 PM

Initial release version

Microsoft Team Foundation Server 2015 Support
Support for Team Foundation Support and connecting to Team Foundation Server 2012-2015 from a machine with only Visual Studio 2015 installed.
Execute external programs/scripts or show messages when building a saved Build Configuration
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.
Added 2 new Table of Contents node types that automatically populate the ToC based on Topic Category/Topics
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.
Integration with cloud based discussion/community services (Disqus/Facebook/Solidopinion/Livefyre)
It is now possible to enable 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.
The name of the browser help root page (default webframe.html) can now be customized in the Build Profile Editor
Updated docs to include deployment information for Microsoft Help Viewer
Added information to the online help on how to link to locally installed Microsoft Help Viewer content in Visual Studio 2012 and 2013
Added Sort command to Project Explorer context menu for the Topics node to sort Topic Categories
The command is visible if the project or selected Topic Category contains > 1 Topic Category. This command makes it easier to keep large Topic Category lists organized.
New Option to automatically include a link to view Browser Help content with navigation tools when a content page is opened directly
A new 'Include a View with Navigation Tools link if a content page is opened without Browser Help Navigation Tools' option has been added to the 'Browser Help' page in the Build Profile editor. This new option will cause generated content pages to automatically show a link in the page header that will navigate to the same page but with full navigation tools (i.e. webframe.html#pagename.html) if the content page is opened directly. This is particularly useful for public content that is indexed by search engines - as users will often navigate from search results to the content page without the navigation tools.
Enhanced short filename generation options including saving mappings between builds, prefix replace and regex find and replace
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).
Document! X and HelpStudio now support Windows 10 (32bit and 64bit) as an installation platform
Added a checkbox to COM Components and Assemblies in the Project Explorer to exclude/include all child items
Added a new 'Document! X Placeholder (for specific item)' ToC node type to include generated nodes only for a specific item
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.
Visual Studio 2015 and Microsoft Help Viewer 2.2 Support
Integration with Visual Studio 2015, including the Visual Comment Editor for C#, VB and C++/CLI. Support for the new Microsoft Help Viewer 2.2 that ships with Visual Studio 2015 including deployment help information and generated batch files to illustrate how to deploy help for integration with Microsoft Help Viewer 2.2 in Visual Studio 2015.
It is now possible to check / uncheck multiple selected items on the Project Explorer
With multiple checkable items selected (using Ctrl+Click or Shift+Click), pressing the spacebar will check / uncheck all of the selected items.
Added context menu items to the Assembly root node, assembly and namespace nodes on the Project Explorer to deselect non public types
These new commands make it easier to ensure that all non public types are excluded on the Project Explorer. Note that there are also existing options on the .NET Filtering page in the Build Profile Editor to never include non public types in generated output.
Added Sort command to the Project Explorer Assemblies, XSD Schemas, Web Services and Databases nodes
The command is visible if the project contains > 1 Assembly/Xsd Schema/Web Service/Database. This command makes it easier to keep the Project Explorer organized for very large projects.
A prompt to automatically reload the project will be shown after a referenced file is changed
This change makes it easier to ensure you are always documenting from the latest version of an Assembly, Web Service file, Xsd Schema or COM Component. If your project includes one or more of those items, Document! X will automatically prompt you if the file has changed (i.e. a new version is copied over or you rebuild the component/assembly from Visual Studio). If you answer Yes to the reload prompt, Document! X will automatically reload the project (or restart the application and reload the project for .NET assemblies) in order to pick up the latest version. You will be prompted to save changes before the project is reloaded.
Added Sort command to the Project Explorer Content Files Context Menu
The command is visible if a project contains > 1 Content File. This command makes it easier to keep large Content File lists organized.
Added a new rule kind to allow filter of all items belonging to a particular documentation type
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).
Images that are only used in a secondary locale were being reported as unused by the \"Remove Unused Images\" tool
Import from HHP / CHM fails if the HHC or HHK contains invalid Html (unencoded quotes)
Importing interlinked html files from a sub-directory of the project directory results in broken links in the imported Topics
Updated docs to include deployment information for Microsoft Help Viewer