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 9.

 

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.

Context Plugin

Specifies context plug-ins for Eclipse help systems. Other Eclipse plug-ins can use the context plug-in IDs to call the Eclipse help system. For more information, see “Using Markers to Specify Context Plug-ins in Eclipse Help” on page 237.

DropDownEnd

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

Filename

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

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 148.

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 156.

PassThrough

Specifies that ePublisher place the contents of the marker directly into the generated output without processing the content in any way. For example, you could use a PassThrough marker if you wanted to embed HTML code within your generated output.

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 179.

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 183.

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 175.

TopicDescription

Specifies a topic description for a context-sensitive help topic in Eclipse help systems. For more information, see “Using Markers to Specify Topic Descriptions for Context-Sensitive Help Topics in Eclipse Help” on page 237.

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.

WikiCategory

Specifies the category or label you want to assign to a topic when generating Wiki output. For more information, see “Defining Wiki Categories or Labels” on page 238.

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.

ePublisher/2009.2/Help/02.Designing_Templates_and_Stationery/3.091.Designing_Stationery (last edited 2009-08-03 19:10:03 by TonyMcDow)