Doc-To-Help Outputs and Deliverables

Manual

Can be online (pdf), hard-copy, or both.

Hardcopy:

Familiar format and navigation.

Online:

Same familiar format, but no printing cost.

Can create links to websites, video/audio files, etc.

Searchable

Hardcopy:

Can become obsolete quickly.

Printing and delivery costs.

Customers may not work in an environment where they can access manual.

.doc and/or .pdf

By default, the Manual folder of your project.

NetHelp (Browser-based Help)

This release of Doc-To-Help includes “Classic” NetHelp and the new “NetHelp 2.0”

Uncompiled HTML; deliverable is multiple html files.

NetHelp can be Section 508 compliant, see Creating Section 508 Compliant Help.

Can be delivered on the Web, installed locally, or both. See Installing NetHelp for more information.

Delivering on the Web makes a continuous publishing model possible.

The user’s web browser is the Help window.

Number of files to distribute is daunting to some.

Security issues can cause NetHelp installed locally to display an ActiveX warning, which may be solved by using the "Mark of the Web." See NetHelp Local Installation.

Multiple .htm/.html files. Default home page is default.htm. (You can change the default page name in the Help Targets dialog box)

By default the NetHelp folder of your project.

The entire contents (including subfolders) of this folder must be included with your software application or posted on your server.

Server side search may be enabled for NetHelp, see Search Options for NetHelp and Mobile Help.

Notes on NetHelp

Local NetHelp may not display correctly initially because Windows XP SP2 and higher automatically disables active content (JavaScript).

To disable this security block for all local content, in Internet Explorer, go to Tools > Internet Options > Advanced > Security. Select the Allow active content to run in files on My Computer check box. Users can also disable the block within the browser.

If you open or install NetHelp locally, it will not display in Chrome or Opera because of  limitations with those browsers, but it will display in other browsers. NetHelp deployed on a web server will open in Chrome and Opera.

HTML Help

Compiled HTML; deliverable is .chm file.

One file; tri-pane interface is easy to use.

Format is 10+ years old.

Locally installed HTML Help files (those installed on the end user’s client machine, not their server), work without issues. If you plan to install HTML Help on a server, there are security issues, see http://support.microsoft.com/kb/902225

.chm

By default, the HTML Help folder of your project.

Mobile Help

Browser-based output designed especially for mobile devices.

Mobile Help can be Section 508 compliant, see Creating Section 508 Compliant Help.

It uses two Web technologies — jQuery and jQuery Mobile — that make it browser- and device-independent.

Secondary windows are not supported in Mobile Help, however, you can set links to open in a new browser window.

Multiple .htm/.html files. Default home page is default.htm. (You can change the default page name in the Help Targets dialog box)

By default, the MobileHelp folder of your project.

Mobile Help is supported on all popular devices and browsers. See http://jquerymobile.com/gbs/ for a list of platforms supported by jQuery.

Server side search may be enabled for Mobile Help, see Search Options for NetHelp and Mobile Help.

Eclipse Help

Help Target for the Eclipse development environment. Eclipse was released by IBM in the early 2000s.

An Eclipse Help system is a plug-in for Eclipse. This plug-in supports a table of contents, index, search, and context-sensitive help.

Eclipse Help is compatible with all browsers, but the Eclipse SDK must be installed on the same server as the Help system.

Eclipse Help does not support opening topic links in secondary windows.

Multiple files; see http://help.eclipse.org/indigo/index.jsp (search on “User Assistance Support”).

By default, the Eclipse folder of your project.

To view Eclipse Help, you must have the Java Runtime Environment (JRE) and Eclipse installed. Eclipse is available for download from http://eclipse.org/downloads/.

After installation, the location of the eclipse.exe file should be set in the Doc-To-Help Options dialog box.

EPUB

EPUB stands for “electronic publication” and is standard of the International Digital Publishing Forum (IDPF).

EPUBs are readable on a variety of devices, including Nooks. The content display adjusts for the device, as well as the device settings.

You can create interactive, portable books that can be read on multiple devices.

Doc-To-Help supports the latest specification, EPUB 3.0, as well as 2.0.1.

Dynamic content is not supported, but the content will be displayed. See Notes on EPUB (below) for complete information.

.epub

By default, the EPUB folder of your project.

You must add your EPUB to your reader (such as Calibre) in order to view it.

To set the default EPUB reader in Doc-To-Help, go to File tab  > Tools > Options. In the  Options dialog box, select the Viewers button and choose the EPUB viewer executable.

Notes on EPUB

Please note that many devices don't support Cascading Style Sheets or only support them partially, so your EPUB display can vary depending on the device.

Doc-To-Help’s EPUB target was tested with the following readers:

•      Calibre E-book management (http://calibre-ebook.com/)

•      Sony Reader for PC (http://ebookstore.sony.com/download/ )

•      NOOK for PC (http://www.barnesandnoble.com/u/free-nook-apps/379002321/ )

•      Adobe Digital Editions (http://www.adobe.com/products/digitaleditions/)

Dynamic content is not supported in EPUBs, but the content will be displayed as follows:

•      Popups and Glossary Terms will be opened in the current window.

•      All content in Collapsible Sections (created with the Collapsible Section button) will be displayed (just as it would in Manual Targets).

•      Topic links that were specified to open in secondary windows will open in the current window instead.

•      Keywords with multiple entries and Groups don’t open in a popup when clicked, but instead link to the Index, where those Keywords and Groups are displayed, along with the list of topics included in each. (The Index can be renamed in the Theme Designer.)

Expanding Text and Dropdown Text (both created with the Inline Text button) may be displayed or hidden in EPUBs. The option you prefer can be set in the Help Targets dialog box using the Show expanding text and Show dropdown text check boxes. The hidden portion of inline text will always remain hidden.

JavaHelp

Java Help 1.1.3 is supported, as well as JavaHelp 2.0

JavaHelp software was developed to provide a standard Help solution for pure Java applications.

JavaHelp software was released in April 1999, and is currently in release 2.0.

While there is no “standard” viewer, JavaHelp uses components from the HotJava browser for its display.

Multiple files; deliver the entire JavaHelp folder (its default name) in your project directory.

By Default, the JavaHelp folder of your project.

To view a JavaHelp HelpSet, you must have the necessary files installed on your machine. See Notes on JavaHelp below.

Notes on JavaHelp

To build and view JavaHelp, you must first install the necessary files from Oracle.

Do the following:

1.   Install the Java Developer Kit (JDK).

The JDK6 for Windows x86 and Windows x64 are available at:
http://www.oracle.com/technetwork/java/javase/downloads/jdk-6u26-download-400750.html   

2.   Download and unzip the JavaHelp files from http://download.java.net/javadesktop/javahelp/javahelp2_0_05.zip

3.   Update your Environment Variables to tell your machine where to find the Java files.

Go to Control Panel > System > Advanced Settings. The System Properties dialog box will open.

On the Advanced tab click the Environment Variables button. These variables need to be added or changed under System variables:

•    JAVA_HOME
Value: C:\Program Files [or Program Files (x86)]\Java\jdk1.6.0 (use the location of your JDK installation)

•    JAVAHELP_HOME
Value: C:\Program Files [or Program Files (x86)]\Java\jh2.0 (use the location of your jh2.0 directory)

•    JHHOME
Value: C:\Program Files [or Program Files (x86)]\Java\jh2.0 (use the location of your jh2.0 directory)

•    Path
This one will already exist, so edit it and append ;C:\Program Files [or Program Files (x86)]\Java\jdk1.6.0\bin (use the location of your JRE\bin directory)
(Note: semicolons separate multiple paths)

As noted above, the exact file paths will vary based on Java version numbers and where you have JavaHelp and the JDK installed on your machine.

WinHelp

Compiled RTF files; deliverable is .hlp and .cnt file.

None. If your product is a legacy one with no plans to change Help format, you will be able to continue producing it.

Original Help format. Look and navigation not as user-friendly as newer formats.

The WinHelp viewer is not included with Windows 7/8 and Vista, but those users can download the WinHelp viewer, see http://support.microsoft.com/kb/917607

WinHelp will not build on 64- bit machines.

.hlp and .cnt

By default, the Help folder of your project.

Microsoft Help Viewer

Help Target for those developing Help for Visual Studio 2010 and above only.

Deliverable can be the reference documentation only, or Doc-To-Help can be used to add narrative text. Microsoft Sandcastle is used to generate reference documentation.

Resembles Microsoft MSDN collection and uses some of the same underlying technology

Format can only be included in Help for Visual Studio 2010 and above.

HelpContentSetup.msha and <target base name>.mshc

The MSHC is a zip file containing all of the Help content.

By default, the MSHelpViewer folder of your project.

To specify the version of the Microsoft Help Viewer to use when viewing Microsoft Help Viewer Targets, in Doc-To-Help, go to File tab  > Tools > Options. In the  Options dialog box, select the Viewers button and choose the correct version of the viewer. (Options available depend on your Visual Studio installation.)

Notes on Microsoft Help Viewer

In order to create and view Microsoft Help Viewer files you must install Visual Studio 2010. Other properties are set in the Doc-To-Help Help Targets dialog box.

For more on Microsoft Help Viewer, see http://helpware.net/mshelp3/intro.htm.

Microsoft Help 2.0

Help Target for those developing Help for Visual Studio 2002 - 2008 only.

Deliverable can be the reference documentation only, or Doc-To-Help can be used to add narrative text. Microsoft Sandcastle is used to generate reference documentation.

Resembles Microsoft MSDN collection and uses some of the same underlying technology

Format can only be included in Help for Visual Studio 2002 - 2008.

Programmers who distribute .NET components can integrate Help 2.0, because the .NET tools include the run-time components necessary to view Help 2.0 Help systems.

.HxS (topic files), .HxC (project file), .HxF (include file), .HxT (table of contents). .HxA (attributes), .HxK (index)Your deliverables may vary based on your application.

For more on Microsoft Help 2.0 redistributables, see http://msdn.microsoft.com/en-us/library/bb165722(VS.80).aspx   

By default, the MSHelp folder of your project.

Notes on Microsoft Help 2.0

In order to create and view .HxS, or Microsoft Help 2.0, files, you must install Visual Studio.NET and VSHIK (Visual Studio Help Integration Kit).

The Namespace and Parent Namespace are set in the Help Targets dialog box. See Help 2.0 Target for more information.

To build Help 2.0, Doc-To-Help also needs to know the locations of the Help 2.0 executable files. By default, Doc-To-Help assumes the following locations:

C:\Program Files\Microsoft Help 2.0 SDK\HxComp.exe

C:\Program Files\Microsoft Help 2.0 SDK\HxReg.exe

C:\Program Files\Common Files\Microsoft Shared\Help\dexplore.exe