Setting Doc-To-Help Options

You can set Doc-To-Help project options for Startup, file locations, preferred HTML editors, updates, spelling, etc. using the Options dialog box.

 

To set Doc-To-Help Options

1.    Choose the File tab  > Tools > Options. The Options dialog box will open.  (Or, click the Doc-To-Help Options button at the bottom of the File tab menu.)

2.    Select the General, Files, Editors, Team, SharePoint, Updates, Spelling, or Eclipse Help button.

3.    Select the desired options.

4.    Click OK.

 

General button:

    Set Startup options for the Getting Started With Doc-To-Help wizard and automatic reloading of last project

    Change the color scheme for Doc-To-Help (Blue, Silver, or Black)

    Set various confirmation prompts. If these check boxes are selected, Doc-To-Help will display a message box when you perform these functions. These messages can also be turned off by selecting the "Don't show me this again" check box when the message box is displayed.

Confirm editing properties of multiple topics. If you select more than one topic in the Topics window, and then click the Properties button in the Topics ribbon, Doc-To-Help will remind you that you have selected more than one topic and will be editing the properties for all of them.

Confirm adding documents outside source document folders. If adding a document to your project using drag-and-drop, Doc-To-Help will inform you if the document is not stored in the correct folder. You should always copy documents to the correct folder before adding them so that the links don't break and the project is self-contained.

Confirm using Windows System colors. If you change the System background color for any JavaHelp or NetHelp Target (Help Targets dialog box > Color > System tab), Doc-To-Help will inform you that system colors are specific to Windows and explain how this will be handled for the Target.

Prompt installing Microsoft Help Viewer target after build. If you built a Microsoft Help Viewer target, Doc-To-Help will ask if you would like to install the target. If yes, it will open the Help Library Manager so you can add the project to the Microsoft Help Viewer and look at it.

Prompt viewing help target after build. After every build or rebuild, Doc-To-Help will ask if you would like to view the Help Target.

Confirm making a copy of a document with Save As.  If saving the currently open XML document under another name using File tab > Save As, Doc-To-Help will explain that the document will be stored in the same folder as the original document, but will not be automatically added to the project.

Confirm allowing local formatting. If you click the Local Formatting button in the Editor tab of the XHTML editor, Doc-To-Help will display additional information about local formatting. 

Confirm removing local formatting. If you have applied local formatting in the XHTML editor, and then click the Local Formatting button in the Editor tab, Doc-To-Help will inform you that all the local formatting applied will be removed.

Files button:

    Change the default location for Doc-To-Help projects and Doc-To-Help custom Themes (See Customizing Themes with the Theme Designer.)

 

HTML Editors button:

    Set the default HTML editor for editing your Doc-To-Help HTML documents. You can add and remove editors from the list.

 

Team button:

    Change the default “new project” colors for your Team Projects.

    Set Check Out and Compare and Merge options. Also choose your version of Microsoft Visual Studio Team Explorer. See Working on a Team for more information about team authoring support.

 

Please note that you must log into Doc-To-Help as an administrator to change your version of Microsoft Visual Studio Team Explorer if using Windows 7/8 or Vista. To log in as an administrator, right-click on any Doc-To-Help shortcut (from the Start menu or on your desktop) and choose Run as administrator from the menu. Doc-To-Help will open.

 

SharePoint button:

    Change the defaults for opening and synchronizing documents to a SharePoint Library. When the Check out Word documents when editing local copy check box is selected, Word documents will be checked out of the SharePoint Library automatically when you open them in Doc-To-Help. For more on sharing documents to a SharePoint Library, see Collaborating with SharePoint.

 

Updates button:

    Turn the Doc-To-Help Live Update feature on and off. See Using Live Update for more information.

 

Spelling button:

    Set the spell check options for the Doc-To-Help XHTML editor. (The Spelling button is on the Editor tab. See Editor tab for more information.)

 

Viewers button:

    Specify the location of the Eclipse executable file (eclipse.exe) on your machine. Doc-To-Help requires this information to view Eclipse Help.

    Specify the location of the EPUB reader executable on your machine. Doc-To-Help requires this information to view EPUBs.

    Specify the version of the Microsoft Help Viewer to use when viewing Microsoft Help Viewer Targets. (Options available depend on your Visual Studio installation.)