Table of Contents

Previous

Next


Defining the Processing of Markers and Field Codes

If you want to create your own field codes and markers, you can define the function of each field code and marker you create. ePublisher provides many default field codes and markers to provide various built-in features and capabilities. For more information about which output formats support each feature, see “Features Available in Each Output Format” on page 8.

Default Marker Name

Description

AbbreviationTitle

Specifies alt text for an abbreviation, such as SS#. This text is displayed when a user hovers over the abbreviation in the output.

AcronymTitle

Specifies alt text for an acronym, which is displayed when a user hovers over the acronym in the output.

Citation

Specifies a citation as alt text for a quote, which is displayed when a user hovers over the citation in the output.

DropDownEnd

Marks the end of an expand/collapse section. For more information, see “Defining Expand/Collapse Sections (Drop-Down Hotspots)” on page 162.

Filename

Specifies the name of an output file for a page or an image. For more information, see “Defining File Names” on page 159.

GraphicScale

Specifies a percentage to resize an image, such as 50 or 75 percent.

GraphicStyle

Specifies the name of a graphic style defined in the project to apply to an image. This marker is an internal marker name that is not displayed in Stationery Designer. You cannot create a marker with a different name and assign it this functionality. For more information, see “Defining the Appearance of Images” on page 138.

ImageAltText

Specifies alt text for an image. This text is added to the alt attribute of the img tag in the output.

ImageAreaAltText

Specifies alt text for clickable regions in an image map. This text is displayed when a user hovers over the region in the output.

ImageLongDescByRef

Specifies the path to the file that contains the long description for an image. This description is used when you create accessible content.

ImageLongDescNotReq

Specifies that a long description is not required for an image, which bypasses this accessibility check for that image.

ImageLongDescText

Specifies the long description for an image. This description is used when you create accessible content.

Keywords

Specifies the keywords to include in the META tag for the topic. This META tag improves searchability on the Web.

PageStyle

Specifies the name of a page style defined in the project to apply to a topic. This marker is an internal marker name that is not displayed in Stationery Designer. You cannot create a marker with a different name and assign it this functionality. For more information, see “Defining the Appearance of Pages” on page 146.

Popup

Specifies the start of the content to include in a popup window. The content is displayed in a popup window when you hover over the link. When you click the link in some output formats, the topic where the popup content is stored, such as the glossary, is displayed. For more information, see “Defining Popup Windows” on page 164.

PopupEnd

Marks the end of the content to include in a popup window.

PopupOnly

Specifies the start of the content to include in a popup window. The content is displayed in a popup window when you hover over or click the link.

RubiComposite

No longer supported.

SeeAlsoKeyword

Specifies an internal identifier for a topic. SeeAlsoLink markers in other topics can list this identifier to create a link to this topic. For more information, see “Defining See Also Links” on page 168.

SeeAlsoLink

Identifies an internal identifier from another topic to include in the list of see also links in this topic.

SeeAlsoLinkDisplayType

Specifies whether to display the target topics on a popup menu or in a window. By default, the links are displayed in the Topics Found window. To display a popup menu, set the value to menu. This marker is supported only in HTML Help.

SeeAlsoLinkWindowType

Specifies the name of the window defined in the hhp file, such as TriPane or Main, that the topic opens in when the user clicks the link. This marker is supported only in HTML Help.

TableStyle

Specifies the name of a table style defined in the project to apply to a table in versions of Microsoft Word that did not support table styles. This marker is an internal marker name that is not displayed in Stationery Designer. You cannot create a marker with a different name and assign it this functionality.

TableSummary

Specifies a summary for a table, which is used when you create accessible content.

TableSummaryNotReq

Specifies that a summary is not required for a table, which bypasses this accessibility check for that table.

TOCIconHTMLHelp

Identifies the image to use as the table of contents icon for this topic in the HTML Help output format.

TOCIconJavaHelp

Identifies the image to use as the table of contents icon for this topic in the Sun JavaHelp output format.

TOCIconOracleHelp

Identifies the image to use as the table of contents icon for this topic in the Oracle Help output format.

TOCIconWWHelp

Identifies the image to use as the table of contents icon for this topic in the WebWorks Help output format.

TopicAlias

Specifies an internal identifier for a topic that can be used to create a context-sensitive link to that topic. For more information, see “Defining Context-Sensitive Help Links” on page 161.

WhatIsThisID

Identifies a What’s This help internal identifier for creating context-sensitive What’s This field-level help in the HTML Help output format.

WindowType

Specifies the name of the window defined in the help project that the topic should be displayed in. In HTML Help, the window names are defined in the hhp file. This marker is supported in HTML Help and Oracle Help.

Context Plugin

Eclipse Help allows users to define that a given content plugin may be used for other Eclipse Help plugins. The Context Plugin marker behavior provides ePublsiher users the ability to associate the content of a given Group with one or more Eclipse Plugins.

To use this behavior, insert one or more of this type of marker into the content for a given Group and map the marker to the Context Plugin marker behavior. When output is generated using the Eclipse Help format, the plugin.xml file, which defines the extension points for the Eclipse Help content plugin, will include the IDs of the other Eclipse plugins to which this content plugin applies. For example, consider the following fragment from a Group's plugin.xml file:

This fragment indicates that the current content plugin provides help content which is used by the Eclipse Plugins: com.webworks.ecology.ui and com.webworks.eclipsehelp.ui.

Topic Description

Eclipse Help support for context-sensitive topics allows users to provide a description when defining a given context. The markup for context sensitive topics is listed below:

The Topic Description marker behavior allows a user to take advantage of this facility. To use this behavior, insert a marker after a topic marker in a paragraph. When the Eclipse Help format generates output, a check is made for a marker following the topic marker which has the Topic Description behavior. If one is found, the value of this marker is used for the description field of the context. If one is not found, the title of the page is used for the description field of the context.

ePublisher/2008.3/Help/Designing_Templates_and_Stationery/Designing_Stationery.3.89 (last edited 2008-10-21 15:56:33 by localhost)