The Topic Properties hot spot allows you to set a variety of properties for your topics. Most of these properties can also be found in the Doc-To-Help Project Editor by clicking the Topics icon and selecting a topic. By using the Topic Properties hot spot, you do not need to set the property in the Project Editor.
The Behavior property of this hot spot type is set to Topic Properties. The following predefined styles have this Behavior, and the corresponding HTML tag or Word Style can be used when formatting without the D2HML Styles toolbar:
D2HML Style |
Corresponding HTML Tag |
Corresponding Word Style |
C1H Topic Properties (Hidden=True) |
<span class="C1HTopicProperties"></span> |
C1H Topic Properties |
To create a Topic Properties hot spot, select the link text and secondary part, if it exists, and press Topic Properties on the D2HML Styles toolbar. Use the Topic Properties dialog box to specify the properties of the topic.
Topic Properties Dialog Box
If you are not using the toolbar, place the link text and secondary part in the corresponding HTML <Span> tag to format it with the D2HML style.
The following properties are supported by the Topic Properties hot spot, and they can be found in the D2H Project Editor as well as in the Topic Properties dialog box tab specified below:
Property |
Description |
Tab |
AsciiName |
This is the value of the Topic.AsciiName property. It specifies the ASCII-only string used to identify the topic in situations where non-ASCII characters are not allowed. The characteristics of this property are: String |
General |
ButtonLabel |
This is the value of the Topic.ButtonLabel property. It overrides the Help target ButtonLabel text on a topic by topic basis. The characteristics of this property are: Case-sensitive String |
Appearance |
Comments |
This is the value of the Topic.Comments property. When activated, this property provides an editable textbox to be used for comments by the help author. These comments are not accessible by the end user. The characteristics of this property are: Case-sensitive String |
General |
ContentsTitle |
This is the value of the Topic.ContentsTitle property. This property allows for modification of a topic title in the help window contents area without changing the actual topic title in the source document. The characteristics of this property are: Case-sensitive String |
Appearance |
DisplayTitle |
The value of the Topic.DisplayTitle property. This property allows for modification of a topic title with respect to help file searches without changing the actual topic title in the source document. The characteristics of this property are: Case-sensitive String |
Appearance |
SearchEnabled |
This is the value of the Topic.SearchEnabled property. It controls whether ComponentOne Natural Search is enabled for a Help target, document, or topic. The characteristics of this property are: Boolean value True or False |
Appearance |
URL |
This is the value of the Topic.URL property. It specifies the name of the generated .htm file for a topic. The characteristics of this property are: String |
General |
Default |
If this value is set to True, the topic becomes the default topic in all Help targets. The characteristics of this property are: Boolean value True or False |
General |
Attribute |
A list of attributes in Name:Value format. The topic is included in the target if these attribute values are included in that targets Attributes collection. The characteristics of this property are: String Collection |
Condition - use the Add button to open the Condition window and select one of the attributes. |
Platform |
This is a list of platforms in which the topic is included. The characteristics of this property are: Supported values: Manual Online HTMLAny NetHelp HTMLHelp MSHelp JavaHelp WinHelp |
Condition use the Add button to open the Condition window and select one of the platform options. |
Target |
This is a list of targets in which the topic is included. The characteristics of this property are: String Collection |
Condition use the Add button to open the Condition window and select one of the help target options. |
The following table gives you some examples of using the Topic Properties hot spot:
Hot Spot in Word and HTML Editor |
HTML Code |
Description |
|Platform=Manual |
<span class="C1HTopicProperties"> |Platform=Manual</span> |
The topic containing this hot spot appears in the manual help target only. |
|default=true |
<span class="C1HTopicProperties"> |default=true</span> |
The topic containing this hot spot becomes the default topic in all help targets. |
|buttonlabel=Next |
<span class="C1HTopicProperties"> |buttonlabel=Next</span> |
The word Next precedes the subtopic buttons under the topic containing this hot spot. |
Here is an example of the Topic Properties hot spot:
|Platform=HTMLHelp;asciiname=mytopic;buttonlabel=SeeAlso;Comments=none;contentstitle=My Topic;default=true;displaytitle=Found my topic; searchenabled=false;url=myurl.htm;
A topic with this hot spot has the following properties:
This topic is included in HTML Help targets only.
Topic.AsciiName = mytopic
Topic.ButtonLabel = See Also
Topic.Comment = none
Topic.ContentsTitle = My Topic
This topic becomes the default topic for all targets.
Topic.DisplayTitle = Found My Topic
This topic is excluded from Natural Search.
Topic.URL = myurl.htm