You are here: Object Model Reference > Condition Property

Condition Property

For a topic, defines a condition for including this topic in a help target.

For a character style, makes this style a conditional text style, places the specified condition on text formatted with this character style.

For a source document, defines a condition for including this document in a help target.

Type

Applies To

String

Topic
Character Style
Document

Remarks

Doc-To-Help provides a rich set of options to make certain text, whole topics, or entire documents appear only in certain help targets. You can specify conditions for inclusion in help targets on four levels:

Topic level: To include or exclude topics from certain help targets, specify this property for each topic you want to make conditional. By specifying a condition for a topic you include it in only those help targets that satisfy this condition. A condition can be a help target name, a platform (meaning all targets of the same kind) or an attribute (meaning help targets that have this attribute value defined).

Text level: You can make any text selection appear only in certain help targets by formatting that selection with a C1H Conditional style markup and assigning a condition to this particular text selection.

Style level: By assigning a condition to a character style you make all text formatted with that style appear only in help targets satisfying that condition. In that case you do not need to specify a condition every time you format a text with that style. D2HML includes two predefined character styles with conditions already defined: C1H Online for all online targets and C1H Manual for printed manual targets.

Document level: To include or exclude a document from certain help targets, specify this property for each document you want to make conditional. By specifying a condition for a document, you include it in only those help targets that satisfy this condition. A condition can be a help target name, a platform (meaning all targets of the same kind) or an attribute (meaning help targets that have this attribute value defined).

See the description of the Doc-To-Help conditional text features for details. See Conditional Text Hot Spot in the D2HML description for the exact syntax of the condition string.

Location (Topic)

      Click the Topics Icon.

      Select All Topics item from the left pane Tree View.

      The property is located under the Misc group in the Properties Pane.

Location (Character Style)

      Click the Project Icon.

      Select the Character Styles item from the left pane Tree View.

      The property is located under the Misc group in the Properties Pane.