Microsoft Help Viewer Targets

 

Use the following options to configure your Microsoft Help Viewer output. Please note that this output is only used for developing help for Microsoft Visual Studio 2010 and above.

 

For more information on Targets and how to distribute them, see Doc-To-Help Outputs and Deliverables.

 

MHV resources:

      MSHelpWiki.com: http://www.mshelpwiki.com/wiki/tiki-index.php?page=Help3

      MSDN Forum: http://social.msdn.microsoft.com/Forums/en-US/devdocs/threads

      Yahoo! Group: http://tech.groups.yahoo.com/group/MSHelpViewer/

 

Basic

 

Name: The name of the target, which will also appear in the list on the left of the dialog box. This name is also used when you select a target using the Select Target button in the Target ribbon group.

 

Base name: If you would like your Target output to have a different name than the project name, enter it here.

 

Self-branded: If selected, allows you to use your own CSS and scripts for the Microsoft Help Viewer 1.x target,

otherwise the target would use the default Microsoft Help Viewer 1.x CSS and scripts. Doc-To-Help supports only self-branded targets.

 

Style sheet: The cascading style sheet used to format the target. This style-sheet controls the formatting of the target for HTML source documents. Target CSS styles will override any matching styles in the Source CSS. See the Guide to Templates and Styles. (The style sheet can also be changed using the Target CSS button in the Target Design ribbon group.)

 

Template: The Word template used to format the target. This template controls the formatting of the Target for Word source documents. Target template styles will override any matching styles in the Source Template. See the Guide to Templates and Styles. (The template can also be changed using the Target Template button in the Target Design ribbon group.)

 

Theme: The theme or “skin” used for the target. Themes are created/edited in the Theme Designer. (The theme can also be changed using the Theme button in the Target Design ribbon group.)

 

Attributes: The Attributes or Expression this target includes in the final build. For more information, see Defining Attributes.

 

Folder: The folder where the target output will be stored in your Doc-To-Help project. If you change the name of the folder after generating this target, you should delete the original folder to avoid confusion.

 

Localization

 

Locale: Specifies the language in the target files. Each target has its own way of specifying language. For example, HTML Help has a Language option in the [OPTIONS] section of the project file (.hhp). Some common values for this property are as follows:

         English (U.S.) — 1033

         English (U.K.) — 2057

         French — 1036

         German — 1031

         Italian — 1040

         Spanish — 1034

 

Deployment

 

Product vendor: The vendor name, used for installing and uninstalling the target in the Microsoft Help Viewer 1.x. The target's base name will be used if this field is left empty.

 

Product name: The target name, used for installing, uninstalling, and identifying the target in the Microsoft Help Viewer 1.x. The target's base name will be used if this field is left empty.

 

Product book:  The target book, used for installing, uninstalling, and organizing the target in the Microsoft Help Viewer 1.x. The target's base name will be used if this field is left empty.

 

Topic version: The target topic's version. It is used to determine differences between version one and subsequent versions of the installed topic. It is 100 by default.

 

Doc-To-Help allows you to install a target and later reinstall newer versions into the local Microsoft Help Viewer 1.x. However, if the Target properties "Product vendor," "Product name," or "Product book" are changed between builds the old target version won't be uninstalled from the Microsoft Help Viewer 1.x.

 

Users will be able to uninstall or install targets manually using the Microsoft Help Library Manager. Doc-To-Help produces two install files: HelpContentSetup.msha and <target base name>.mshc.

 

Parent in Contents

 

Topic ID: The ID of the parent topic in Microsoft Help Viewer 1.x, which will be the parent for all root entries in the target table of contents.

 

Topic version: Version of the parent topic in Microsoft Help Viewer 1.x, which will be the parent for all root entries in the target table of contents (100 by default).

 

Background

 

Color: Displays the current color setting for the target help window. To change the color, click the adjacent button to select or define a color.

 

Image file: Displays the image file to be used as a background in the target help window. To insert a background image, click the adjacent button to open the selection dialog.

 

Repeat image: Specifies how the background image is arranged in the target help window. Options are Tiled, Horizontal, or Vertical.

 

Advanced

 

Color Reduction: Determines the color threshold for images embedded in Word source documents. This setting has no impact on images used in HTML source documents.

         Keep original color format — Images are not converted.

         Reduce to 16 Colors  — Images with more than 16 colors are reduced to 16.

       Reduce to 256 Colors — Images with more than 256 colors are reduced to 256.

 

Image format: Determines the storage format in the Help target of the images used in Word source documents. This setting has no impact on images used in HTML source documents.

         Original format — All graphics are stored in the original format without conversion.

         JPG always— All graphics are stored in JPG files.

         JPG if transformed—Graphics are converted to JPG if they undergo any transformation when the help target is built.

         PNG always— All graphics are stored in PNG files.

         PNG if transformed — Graphics are converted to PNG if they undergo any transformation when the help target is built.

 

Graphics scaling: Determines the scaling applied to the graphics in Word source documents. This setting has no impact on images used in HTML source documents.

 

For graphics embedded within Word documents, Scale in target and Scale in build options are equivalent, the size of the picture is the same as it is displayed in Word. For linked graphics, options Scale in target and Scale in build also produce pictures of the same size, the size it is displayed in Word. The only difference between them is that quality of scaling (resampling) can differ for some images. With Scale in build option, Doc-To-Help is responsible for resampling the image, and with Scale in target option that task is left to the browser that displays the online help target. Choose whichever produces best results. For WinHelp targets, Scale in target and Scale in build options are equivalent for all graphics, the resampling is performed by Doc-To-Help.

         Do not scale graphics — Graphics are displayed at their original size. If graphics are rescaled in the source Word document, they are reset.

         Scale in target — Graphics stay the same size as they are displayed in Word (where they may be scaled). Linked graphics are scaled by the viewer (browser) displaying the online help target. Linked image files remain at their original size; scaling is delegated to the browser by setting the IMG tag dimensions.

         Scale in build — Graphics stay the same size as they are displayed in Word (where they may be scaled). Linked graphics are scaled by Doc-To-Help when the help target is built; the linked image file is resampled to the required size.

 

XML transformation: This property allows you to insert boilerplate content or code into every Help topic, for example: headers, footers, or code that automates analytics. Custom XHTML code can be added inside the <head> element, above the topic title, or at the end of topic text. Click the Wizard button to open the Transformation Wizard dialog box and enter your custom code. Existing configuration files can be selected by clicking the ellipsis button.

 

Graphics scale with fonts: When selected, all graphics in Word source documents are resized proportionally when the system font size is changed (for example, changing the Text Size in your browser). This setting has no impact on images used in HTML source documents.

 

Overwrite CSS: If selected, the existing cascading style sheet will be overwritten when building the Help target. This check box should be selected by default.

 

Related Links

 

Label: Specifies the text that precedes the subtopic links. If you clear this field, there will be no text above the links. If you would like to change the label text for a specific topic, change it in the Topic Properties dialog box.

 

Label Style: The name of the style used to format the label that precedes the subtopic links.

 

Links Style: The name of the style used to format the automatically generated subtopic links.

 

Add separator between topic text and subtopic links: If selected, a dividing line will separate the topic text from the subtopic links.

 

Strings

 

Breadcrumbs label: For HMTL Help targets, specifies the text that precedes topic breadcrumbs (for example, “You are here:”). The breadcrumbs label is set with this field; to make additional changes or disable breadcrumbs, see Customizing with the Theme Designer.  

 

Previous: The text displayed on the Previous button in your Help project. This field is editable.

 

Next: The text displayed on the Next button in your Help project. This field is editable.

 

Warnings about Limitations

 

Warn about Popup link: If selected, will write a warning to the build log about popup links usage in topics. Only self-branded targets support popup links, so warnings will be ignored for those.

 

Warn about Group link: If selected, will write a warning to the build log about group links usage in topics. Only self-branded targets support group links, so warnings will be ignored for those.

 

Warn about Keyword link: If selected, will write a warning to the build log about keyword links usage in topics. Only self-branded targets support keyword links, so warnings will be ignored for those.

 

Warn about Bookmark link: If selected, will write a warning to the build log about links to bookmarks in topics. This target type doesn't support links to bookmarks that are located in another topic, so those links will be ignored.

 

Warn about Mid Topic link:  If selected, will write a warning to the build log about links to mid topics in topics. This target type doesn't support links to mid topics that are located in another topic, so those links will be ignored.

 

Warn about Contents title: If selected, will write a warning to the build log about the use of a custom contents title for a topic. This target type doesn't support topic contents title customization. Values of this property will be ignored.

 

Warn about Display title: If selected, will write a warning to the build log about the use of a custom display title for a topic. This target type doesn't support topic display title customization. Values of this property will be ignored.

 

Warn about Keyword level depth: If selected, will write a warning to the build log about the use of keywords higher than the second level. This target type supports only first and second level keywords. Keywords higher than the second level will be ignored.

 

Warn about 'Contents only' styles: If selected, will write a warning to the build log about the use of topics whose styles have been set to the "Contents only" property. This target type doesn't support topics with this style; all table of contents entries must be a topic, not just an empty book. The style "Contents only" property will be ignored.

 

Warn about 'Suppress empty topic' property: If selected, will write a warning to the build log about the use of topics whose styles have been set to the "Suppress empty topic" property. This target type doesn't support with this style, all table of contents entries must be topic, not just an empty book. The style "'Suppress empty topic" property  will be ignored.