Document! X and HelpStudio 2015.2 Released

August 6, 2015

We are delighted to announce the release of Document! X and HelpStudio 2015.2. This update includes Visual Studio and Team Foundation Server 2015 Support, Microsoft Help Viewer 2.2 Support, Compatibility with Windows 10, Community Integration (Disqus, Facebook etc.) amongst a range of other features and fixes.

If you have a current subscription license or purchased on or after 22nd June 2015, the upgrade to 2015.2 is free. If you don’t have an active subscription and purchased 2015.1 before 22nd June 2015, or you have a 2012, 2013 or 2014 license, a discounted upgrade is available at http://www.innovasys.com/store

You can find more information on how to upgrade to 2015.2 in the full release note:

Document! X 2015.2 Release Note:
http://www.innovasys.com/release/dx2015.2

HelpStudio 2015.2 Release Note:
http://www.innovasys.com/release/hs2015.2

Document! X and HelpStudio Bundle 2015.2 Release Note:
http://www.innovasys.com/release/ds2015.2

What’s New in 2015.2

Visual Studio 2015 Integration

Integration with Visual Studio 2015, including the Visual Comment Editor available for C#, VB and C++/CLI code files.

Microsoft Help Viewer 2.2 Support

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.

Team Foundation Server 2015 Support

Support for Microsoft Team Foundation Server 2015 for Source Control integration.

Windows 10 Support

Full support for use on the new Windows 10 operating system.

Integration with cloud based discussion/community services (Disqus/Facebook/Solidopinion/Livefyre)

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.

Enhanced shortened filename generation options

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).

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.

Custom Build Configuration Event Actions

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.

Document! X Placeholder for a specific item Table of Contents Node

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.

New filtering rule 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).

Some useful keyboard shortcuts

February 3, 2015

There are a wide range of keyboard shortcuts you can use throughout Document! X and HelpStudio. This movie demonstrates a few that you might find useful, including some really useful Ribbon and Style shortcuts that you might not be aware of.


(Click above to view the movie)

Including content managed in External Sources

January 16, 2015

In an ideal world, all of the content for your documentation or help system would be included directly within the Document! X or HelpStudio project in order to get maximum value from the built in Project Tools such as Find and Replace, Spell Check and Link Check.

However, in the real world we know that isn’t always practical. There is often some isolated content that is managed as part of an existing web site (perhaps a privacy policy or support information) or as part of some other authoring workflow.

There might also be users who own certain parts of the content who don’t want to use Document! X or HelpStudio, or to whom you don’t want to give access to the project using the Source Control Integration features (which would otherwise be a great solution for team working and multiple authors).

For those scenarios we have introduced new functionality for including content from External Sources in our 2015.1 release. Rather than manually trying to manually import content from a source external to the project (i.e. by downloading as HTML and importing), you are now able to add Topics to your project that automatically obtain the content as a seamless part of the build, or when previewing in the editor. You can also use the new external content Widgets to include external content directly within an existing Topic or in the Document! X Content File Editor.

In the initial release we support Web Pages (or rather any url that can be called to return HTML) and Quip Documents as external content sources. If you have content in other kinds of external sources that would like to see supported in a future update, please let us know.


(Click above to view a demonstration movie)

Using existing content from Web Pages

Including content from a Web Page rather than importing it is a good option when the content in the Web Page is managed outside of Document! X and HelpStudio and may be updated in future; the up to date content will be downloaded and included whenever you Preview a Topic or build the documentation.

Using a Web Page as the source for a Topic in your help system allows you to re-use existing content that is managed externally without having to re-import each time the external content is updated.

Using Quip Documents for collaborative editing

One of the external content sources we support is Quip; a simple web and mobile document editor. Because Quip is quick and easy to use and supports collaboration and change tracking it can be a great solution for users that only require very basic authoring functionality and won’t be hyperlinking to other parts of the project content or working on other project content.

Multiple users can collaborate, discuss and revise documents in Quip and the latest content will always be used whenever you Preview or Build the generated output.

Publishing to a web site, ftp server or network location

January 16, 2015

Our 2015.1 release of Document! X and HelpStudio includes new Publishing functionality that makes it really easy to automatically publish you generated documentation or help system to a web server, ftp server or local network location.

You can define one or more Publishing Targets in the Build Profile Editor and then either publish automatically as part of the build process, or manually at some point after building using the Publish command on the Ribbon.

Publishing is able to determine which files have changed since you last published, minimizing the amount of time and bandwidth required to publish your content.

If you are using Azure to host your content, you can download and directly import a publishsettings.xml file from Azure to automatically configure a Publishing Target. All of the publishing targets are quick and easy to create and can be configured in a Build Configuration for automatic publishing when building either in the UI or using the Command Line build.


(Click above to view demonstration movie)

Document! X and HelpStudio 2015.1 Released

January 16, 2015

We are delighted to announce the release of Document! X and HelpStudio 2015.1.

If you have a current subscription license or purchased on or after 14th November 2014, the upgrade to 2015.1 is free. If you don’t have an active subscription and purchased 2014.1 before 14th November 2014, or you have a 2012 or 2013 license, a discounted upgrade is available at http://www.innovasys.com/store

You can find more information on how to upgrade to 2015.1 in the full release note:

Document! X 2015.1 Release Note:
http://www.innovasys.com/release/dx2015.1

HelpStudio 2015.1 Release Note:
http://www.innovasys.com/release/hs2015.1

What’s New in 2015.1

Publishing (Network Path, ftp, IIS, Azure)

Publishing features help you to publish your generated output to a web site or network share. You can define one or more Publishing Targets in the Build Profile Editor and then either publish automatically as part of the build process, or manually at some point after building using the Publish command on the Ribbon. Publishing is able to determine which files have changed since you last published, minimizing the amount of time and bandwidth required to publish your content.

If you are using Azure to host your content, you can download and directly import a publishsettings.xml file from Azure to automatically configure a Publishing Target. All of the publishing targets are quick and easy to create and can be configured in a Build Configuration for automatic publishing when building either in the UI or using the Command Line build.

External Topic Content Sources (Web Page and Quip)

It is now possible to derive the content for a Topic from an external source (Web Page and Quip initially supported).

Using a Web Page as the source for a Topic in your help system allows you to re-use existing content that is managed externally without having to re-import each time the external content is updated. This is particularly useful for scenarios in which key portions of content must be managed external to Document! X or HelpStudio.

Using Quip Documents (Quip is a simple collaborative online content editor) as the source for some Topics in your help system allows you to have stakeholders directly contribute portions of content without having to install and use Document! X or HelpStudio. Multiple users can collaborate, discuss and revise simple documents in Quip and the latest content will always be used whenever you Preview or Build the generated output.

As well as being used as the entire Topic Content, you can use 2 new Widgets to include the external content within an existing regular Topic.

New Project Dialog Improvements

The New Project dialog has been re-organized to reduce confusion about what information is required to create a new project and to make is simpler to create new projects by only requiring a single value (Project Name) and defaulting values for the new project directory based on the provided Project Name and the default root directory defined in Options.

Enhanced "Backstage" Application Menu

Commands for creating and opening projects, as well as the Sample Browser and Movie list have been moved to the "Backstage" Application Menu (the page that shows when you click the Application Menu button at top left of the application window).

The Backstage menu provides more screen space to present the list of Project Types, Samples, Movies and Notifications and provides a consistent way to organize this application level functionality whilst freeing up Ribbon space for Project and Content functionality.

Javascript IE9 Load Context

In previous versions, Javascript documentation loaded the Javascript files being documented in an IE8 load context to maximize backward compatibility. Current versions of popular Javascript dependencies such as jQuery no longer support the IE8 javascript engine so this has now been changed so that Javascript is now loaded in an IE9 load context. Note that older Javascript and older dependency versions such as jQuery 1.x will still load in this newer context.

Introducing Project Search

July 30, 2013

Something that we constantly struggle with when designing new features or improvements to our products is discoverability. By discoverability I mean how easy or difficult it is for users to learn about the existence of a feature.

One of the ways we tried to improve discoverability in general was to introduce our Help Hub, which provides context sensitive help resources and also supports text searching throughout the help and our online knowledge base. We also added a Search Box in the title bar – this will search through all of the User Interface for text and is great for tracking down that elusive setting.

So when we decided to add the Project Search tool to HelpStudio and Document! X, we wanted to make sure that the powerful functionality it offers was as accessible and discoverable as possible. To that end, in the next update to Document! X and HelpStudio you will find “Where is this used?” commands on the context menu for Topics, Build Flags, Images and Other Files; invoking this command will create and open a Project Search pre-configured to search for places in which you have used that item in the current project.

Here is an example of a Build Flag usage search (created and run by selecting “Where is this used?” from the context menu for a Build Flag):

BuildFlagSearch
Example Build Flag Usage Search

Because the Project Search opened by the “Where is this used?” command is pre-configured you don’t have to get your hands dirty trying to create the search manually, but you do have an instant illustrated example of how Project Search works; so you can tinker, extend or save those searches if you wish. You can also create new empty Project Searches from the Tools ribon tab, and save them for later re-use (saved searches appear on the Project Explorer under a new Saved Searches node).

Powerful Rules Engine

Because Project Search uses the same Rules Engine as the Filters page in the Build Profile editor and AutoDoc in Document! X, it provides a considerable amount of power and flexibility. You can search for items using a range of Rules, including the Item Property Rule – which gives you access to all of the elements used in the generated output. You can also combine rules in logical AND / OR Rule Groups.

You don’t have to go too crazy at first of course – one of the most common searches will probably be on Item Name. Particularly in Document! X projects this provides a great way to quickly find items with a particular naming pattern throughout the project – e.g. a common member that requires some additional documentation.

ItemNameSearch
Sample Item Name search – looking for items with “Rss” in the name

Navigating Search Results

You can open up any of the items in the Project Search result list by double clicking it. Doing so will open up the Project Search Navigation Bar so you can then step through the results without having to return to the Project Search screen each time.

NavigationBar
Project Search Navigation Bar

You can also use the Ctrl+< and Ctrl+> hotkeys to navigate (tip: these hotkeys work for the Project Find and Replace, Project Spell Check and Project Link Check Navigation Bars too).

Availability

Project Search will be included in the next Document! X and HelpStudio update, available later this week (w/c 30th July 2013).

Document! X and HelpStudio 2013.1 Released

May 13, 2013

We are delighted to announce the release of Document! X and HelpStudio 2013.1.

If you have an active (on 13th May 2013) Document! X, HelpStudio or Document! X and HelpStudio bundle Subscription, or you purchased a license on or after 1st April 2013 you can upgrade free of charge here:
http://www.innovasys.com/support/upgrade/list.aspx

If you don’t hold an active subscription you can purchase an upgrade at signficant discount here:
http://www.innovasys.com/purchase/default.aspx

Once you have upgraded your license, you can download the 2013.1 setup from:
http://www.innovasys.com/download/updates.aspx

If you would like to take the 2013.1 evaluation version for a spin (it can be downloaded side by side with 2012.1), you can download that from:
http://www.innovasys.com/download/eval.aspx

What’s New in 2013?

Javascript Documentation

Document! X now includes comprehensive support for documenting Javascript libraries, including regular javascript, jQuery plugins and jQuery UI Widget libraries. A unique design for the Document! X Javascript parsing engine gives accurate documentation even where complex Javascript inheritance techniques are used.

Full support for JSDoc and Xml comments is included. Comment sections can be placed inside function blocks or directly before the item being documented.

Automatically generated Usage sections and a Browser Compatibility section minimize the amount of effort necessary to create first class Javascript documentation.

You can find samples of the Javascript documentation output here: http://www.innovasys.com/products/dx/SamplesJavascript.aspx

Web Service Documentation

Document! X 2013.1 also introduces comprehensive support for documenting Web Services (SOAP and REST). A variety of Web Service Definition kinds are supported (WSDL, WADL, Swagger, WCF REST Help Pages). For Web Services that do not publish a supported definition, you can define the structure manually (Resource Groups, Resources, Operations, Requests and Responses) using context menu commands on the project explorer.

For SOAP Web Services that include embedded XSD Schemas, the XSD Schemas are automatically extracted and included in the project so you can take full advantage of the existing XSD Schema documentation support alongside your Web Service documentation.

You can find samples of the Web Service documentation output here: http://www.innovasys.com/products/dx/SamplesWebService.aspx

User Interface Refresh

The entire User Interface has been refreshed, including crisp and clean icons and 2 new Themes – Metro Light and Metro White.

Full Release Note

You can find a full release note here:
http://www.innovasys.com/support/releasenotes/dx2013.1.aspx

Document! X and HelpStudio 2013.1 Preview

March 29, 2013

We are pleased to announce the availability of a 2013.1 preview release of Document! X and HelpStudio. The preview release can be downloaded and installed by anyone with a 2012 license, and supports installation side by side with 2012.

You can find a full release note for the 2013 Preview here: http://www.innovasys.com/support/releasenotes/dx2013.1.preview.aspx

What’s New in 2013?

Javascript Documentation

Comprehensive support for documenting Javascript libraries, including both regular javascript and jQuery plugin libraries. A unique design for the Document! X Javascript parsing engine gives accurate documentation even where complex Javascript inheritance techniques are used.

Full support for JSDoc and Xml comments is included. Comment sections can be placed inside function blocks or directly before the item being documented.

Automatically generated Usage sections and a Browser Compatibility section minimize the amount of effort necessary to create first class Javascript documentation.

Web Service Documentation

Comprehensive support for documenting Web Services (SOAP and REST). A variety of Web Service Definition kinds are supported (WSDL, WADL, Swagger, WCF REST Help Pages). For Web Services that do not publish a supported definition, you can define the structure manually (Resource Groups, Resources, Operations, Requests and Responses) using context menu commands on the project explorer.

For SOAP Web Services that include embedded XSD Schemas, the XSD Schemas are automatically extracted and included in the project so you can take full advantage of the existing XSD Schema documentation support alongside your Web Service documentation.

User Interface Refresh

The entire User Interface has been refreshed, including crisp and clean icons and 2 new Themes – Metro Light and Metro White.

Downloading the Preview

You can download the preview release directly from here:
http://www.innovasys.com/download/beta.aspx

Full Release Note

You can find a full release note here:
http://www.innovasys.com/support/releasenotes/dx2013.1.preview.aspx

Help and Support improvements in 2012.1.98

November 12, 2012

The latest update to Document! X & HelpStudio 2012.1 is focused on improving usability by making it quick and easy to find specific functionality in the User Interface and to get access to help and support resources.

Help Hub

The new Help Hub allows you to get contextual help based on what’s going on in the application at that exact moment. The Help Hub can be opened by hovering the mouse over the icon clip_image001 displayed top and center of each Window. Hovering your mouse will display a popup containing a set of links to relevant help topics, online movies & knowledge base articles.

You can also search the online knowledge base directly and submit a support request, all without leaving Document! X or HelpStudio.

HelpHub[7]

UI Search

The new UI search box allows you to search through the interface to track down some of the more hard to find options or features in Document! X / HelpStudio.

Performing a search is as simple as typing in what you are looking for in the search box; you will then be shown a list of matching results. Clicking on any result will open that part of the interface and highlight the matching interface element.

clip_image004

The UI Search also integrates with the new Help Hub functionality: if you don’t find what you are looking for with a UI search you can open the Help Hub directly from the results and search against all of the help resources tied to Document! X / HelpStudio.

Introducing Document! X and HelpStudio 2012

June 13, 2012

We are today making available a preview release of Document! X and HelpStudio 2012. The preview versions are fully functional, can be activated using your Document! X and HelpStudio 2011 license serial numbers and contains all the fixes from the recent 2011 update. The 2012 version will replace any installed 2011 version, so you may wish to try out the preview on a secondary or Virtual Machine. The project file format in the 2012 version is unchanged so projects are compatible between 2011 and 2012.

If you have a Document! X 2011 or HelpStudio 2011 license you can download the beta setup from http://www.innovasys.com/download/beta.aspx. If you purchase a Document! X 2011 or HelpStudio 2011 license with subscription now, or you have an existing active subscription when the final 2012 version is released you will be entitled to a free upgrade to the final 2012 version when released.

This is a preview release so please, as always, share with us any questions, issues, feedback or suggestions you have. Please also be sure to create a backup of your projects before editing them with this preview. The rest of this post provides a summary of the new features introduced in 2012.

Common Features

New 2012 Style Templates: A brand new set of templates with a modernized look and feel, that run under a HTML5 doctype in Standards Mode using modern browsers. The new templates include support for Microsoft Help Viewer 1.0 and 2.0 built in so you can use the same templates for your online, CHM and Microsoft Help Viewer outputs. The new templates use the template “master page” feature to minimize the amount of duplication and simplify making changes across a number of related page types.

Enhanced Template Editor: The template and page type editors have been enhanced in several ways including integrated support for working with “master page” page types and intellisense / autocomplete assistance when adding or editing DXMETADATA elements in the page layout editor or working with %%..%% elements in the scraps editor.

You can find a short movie demonstrating the new Page Type editor here:
http://www.innovasys.com/movies/viewmoviefeed.aspx?id=ed061691-8c79-4533-ad61-a05ef6c73eaf

Improved Rules Designer: The Rules Designer has been simplified and streamlined, making it easier to create new rules and rearrange existing rules using drag and drop.

Microsoft Help Viewer 2.0 Support: The new version of the Visual Studio Help System introduced in Visual Studio 2012 is now supported. Microsoft Help Viewer outputs generated with Document! X or HelpStudio 2012 are compatible with both Microsoft Help Viewer 1.0 and Microsoft Help Viewer 2.0.

Subversion 1.7 Support: The latest version of the popular source control provider is now supported.

64bit versions: Both Document! X and HelpStudio now come with 64bit versions (both the application and command line) for those *really* large projects.

Refreshed UI: The UI throughout has been given a refresh to improve usability and to deliver a crisper look and feel.

Document! X Features

AutoDoc: The headline feature in this version of Document! X, AutoDoc allows you to visually author rules driven content. This powerful new feature allows you to minimize content duplication and enable consistency by defining common content in an AutoDoc file, using rules to identify where the content will be applied. AutoDoc content is visible whilst you are working in the Content File editor (in a similar way to xml source comments) so you can see where common content is already defined and avoid content duplication.

You can view a short movie introducing AutoDoc here:
http://www.innovasys.com/movies/viewmoviefeed.aspx?id=b6316f77-4fb2-41be-b414-96e3aed9b0c1

Visual Studio 2012 Integration: Document! X integrates with the RC release of Visual Studio 2012 (including the Visual Comment Editor), whilst continuing to support Visual Studio 2005 through 2010.