You are here: Using Styles in Doc-To-Help > Using Paragraph Styles > Paragraph Style Properties

Paragraph Style Properties

You can edit the Paragraph Style properties by accessing property pane for the specific Paragraph Style. For more information, see Editing Paragraph Style Properties.

Display Properties

ContentsOnly

When True, omits topics defined with this paragraph style from the Help target, but uses them as book titles in the Help contents. This property is duplicated in the Topic Types.

Hidden

When True, omits text formatted with this style from the help target.

Nonscrolling

When the NonScrolling property of a paragraph style is set to True, any topic headings formatted with that paragraph style appear in the non-scrolling region of the Help window. This property is duplicated in the Topic Types.

OnlineOnly

When True, omits paragraphs formatted with this style from the printed manual target only.

Popup

When the Popup property of a paragraph style is set to True, any topic formatted with that paragraph style appear in a pop-up window on top of the Help window. This property is duplicated in the Topic Types.

Replacement

Sets or returns a string that overrides the default text generated by Doc-To-Help. For a paragraph style with AutoNext set to True, the Replacement string is used instead of the topic title next to the generated button. This property is duplicated in the Topic Types.

SuppressEmptyTopics

If set to True, omits topics defined with this paragraph style or topic type that have no text except heading from online help except in TOC.

Untitled

When True, the topic title is not displayed in the Help window. This property is duplicated in the Topic Types.

Window

Shows the name of the window in which topics formatted in this style are displayed. This property is duplicated in the Topic Types.

Indexing Properties

AutoGlossaryLinks

When True, Doc-To-Help examines the project documents for text that matches glossary entries in the glossary document during compilation, converting these matches into hyperlinks. Whenever the user clicks on one of the hyperlinks, a DHTML pop-up opens containing the corresponding glossary entry description.

Indexing Properties

AutoKeyword

When True, this property automatically creates index keywords from topic titles formatted with that paragraph style and associates them with the appropriate topic. This property is duplicated in the Topic Types.

Miscellaneous Properties

AutoContextID

When True, automatically creates Context IDs for all topics using this paragraph style. This property is duplicated in the Topic Types.

HTMLName

Defines the name to be used to identify the style as a cascading style sheet style in HTML source documents.

Name

Returns a string containing the name of a specified object (read-only). This property is duplicated in the Topic Types.

Script

Displays the script to be run during compilation whenever text formatted with this style is encountered. This property is duplicated in the Topic Types.

TopicType

Specifies a named set of display, navigation, and indexing characteristics to be associated with an object (such as what window the Help topic appears in, how the Help topic is accessed, and whether it gets a map number).

Type

Determines the help authoring behavior associated with a style at compile time.

 

Value

Description

 

Body Text

Topic body.

 

Heading Text

Topic with no outline level.

 

Level 1

Topic at outline level 1.

 

Level 2

Topic at outline level 2.

 

Level 3

Topic at outline level 3.

 

Level 4

Topic at outline level 4.

 

Level 5

Topic at outline level 5.

 

Level 6

Topic at outline level 6.

 

Level 7

Topic at outline level 7.

 

Level 8

Topic at outline level 8.

 

Level 9

Topic at outline level 9.

Navigation Properties

AutoButtons

When True, displays subtopic buttons for paragraph styles with numeric outline levels greater than the parent level. This property is duplicated in the Topic Types.

AutoLink

Creates unique link tags for topics formatted with the paragraph style by enabling the auto link tag feature. This property is duplicated in the Topic Types.

AutoNavigate

Determines which paragraph styles are included in the navigation sequence. This property is duplicated in the Topic Types.

AutoNext

Enables the next topic button for any active paragraph style. This property is duplicated in the Topic Types.

ExplicitAccess

When True, defines a specific paragraph style as accessible only through a hyperlink. Paragraph styles defined as explicit are not accessible from the Help contents, the index list, or the text search. This property is duplicated in the Topic Types.

MidTopic

Defines a paragraph style as an “in topic” jump location similar to an HTML anchor. By defining a paragraph style as MidTopic and defining a character style as a jump, end users have jump functionality within a lengthy topic. This property is duplicated in the Topic Types.