Doc-To-Help Markup Language

Doc-To-Help Markup Language (D2HML) is a set of predefined styles that you can use to mark up your source documents when performing tasks, such as creating topic links, keywords, groups, and conditional text, as well as inserting variables. You don’t need to learn any special language. Styles are applied with a single click.

When editing Word source documents, you can use the Doc-To-Help ribbon to apply D2HML styles:

When you apply a D2HML style to text, a hot spot is created.

D2HML Buttons

Function	Word Style	Notes
Creating Links Create a hotspot link to a topic (jump or popup). Create a hotspot link to topics containing the selected keywords, to a group of topics, to a bookmark in a document, or to a link tag.	C1HJump C1HPopup C1HKeywordLink C1HGroupLink	The topic list opened by a keyword or group link can be displayed in a dialog or popup menu. Index entries and groups can also be created in the Index and Groups view of the Doc-To-Help Project ribbon. Link tags are created with the Link Tag button. See Adding Link Tags.
Creating Expanded, Drop-Down, or Popup Text Create a hotspot that will display additional text on the same line, in a dropdown, or in a popup.	Hotspot: C1HInlineExpand C1HInlineDropdown C1HInlinePopup Expanding Text: C1HExpandText C1HDropdownText C1HPopupText	The hotspot will be tagged with the "hotspot" style. The text that will be displayed by the hotspot is tagged with the "expanding text" style. The inline/expanding/drop-down text is invisible by default. See Showing Hidden Hotspots.
Creating Index Keywords in a Source Document Designates a hotspot as an index keyword.	C1HIndex C1HIndexInvisible	The hotspot can be visible or invisible. Use the "Invisible" style to make the hotspot invisible. (The "Visible" check box in the Keyword dialog controls visibility.) See Showing Hidden Hotspots.
Adding a Topic to a Group Designates a hotspot as a member of a group.	C1HGroup C1HGroupInvisible	If invisible, the hotspot does not appear in the output. See Showing Hidden Hotspots.
Adding Link Tags Designates a hotspot as a link target.	C1HLinkTag C1HLinkTagInvisible	If invisible, the hotspot does not appear in the output. See Showing Hidden Hotspots.
Setting D2HML Topic Properties Sets a subset of the topic properties.	C1HTopicProperties	All topic properties can be controlled using the Topic Properties dialog in Doc-To-Help. The Topic Properties are invisible by default. See Showing Hidden Hotspots.
Marking Text as Conditional Used to mark text as conditional by platform, target, attribute, or any combination of all three.	C1HConditional	Conditional text will also be tagged with platform, target, and/or attribute information (platform=, target=, attribute=).
Inserting a Variable Creates a hotspot to a text or rich content variable.	C1HVariable	The hotspot chosen is replaced by the variable.
Creating Expanding/Collapsing Sections Creates a section that is either collapsed or expanded by default.	C1H Section Collapsed C1H Section Expanded	The section header will have either the C1H Section Collapsed or C1H Section Expanded style applied. The text underneath the header will retain its original style.

Button

Function

Word Style

Notes

Creating Links

Create a hotspot link to a topic (jump or popup).

Create a hotspot link to topics containing the selected keywords, to a group of topics, to a bookmark in a document, or to a link tag.

C1HJump

C1HPopup

C1HKeywordLink

C1HGroupLink

The topic list opened by a keyword or group link can be displayed in a dialog or popup menu.

Index entries and groups can also be created in the Index and Groups view of the Doc-To-Help Project ribbon.

Link tags are created with the Link Tag button. See Adding Link Tags.

Creating Expanded, Drop-Down, or Popup Text

Create a hotspot that will display additional text on the same line, in a dropdown, or in a popup.

Hotspot:

C1HInlineExpand

C1HInlineDropdown

C1HInlinePopup

Expanding Text:

C1HExpandText

C1HDropdownText

C1HPopupText

The hotspot will be tagged with the "hotspot" style. The text that will be displayed by the hotspot is tagged with the "expanding text" style.

The inline/expanding/drop-down text is invisible by default. See Showing Hidden Hotspots.

Creating Index Keywords in a Source Document

Designates a hotspot as an index keyword.

C1HIndex

C1HIndexInvisible

The hotspot can be visible or invisible. Use the "Invisible" style to make the hotspot invisible. (The "Visible" check box in the Keyword dialog controls visibility.)

See Showing Hidden Hotspots.

Adding a Topic to a Group

Designates a hotspot as a member of a group.

C1HGroup

C1HGroupInvisible

If invisible, the hotspot does not appear in the output.

See Showing Hidden Hotspots.

Adding Link Tags

Designates a hotspot as a link target.

C1HLinkTag

C1HLinkTagInvisible

If invisible, the hotspot does not appear in the output.

See Showing Hidden Hotspots.

Setting D2HML Topic Properties

Sets a subset of the topic properties.

C1HTopicProperties

All topic properties can be controlled using the Topic Properties dialog in Doc-To-Help.

The Topic Properties are invisible by default. See Showing Hidden Hotspots.

Marking Text as Conditional

Used to mark text as conditional by platform, target, attribute, or any combination of all three.

C1HConditional

Conditional text will also be tagged with platform, target, and/or attribute information (platform=, target=, attribute=).

Inserting a Variable

Creates a hotspot to a text or rich content variable.

C1HVariable

The hotspot chosen is replaced by the variable.

Creating Expanding/Collapsing Sections

Creates a section that is either collapsed or expanded by default.

C1H Section Collapsed

C1H Section Expanded

The section header will have either the C1H Section Collapsed or C1H Section Expanded style applied. The text underneath the header will retain its original style.