|
|
|
Understanding Custom Marker Types in FrameMaker
ePublisher projects use the custom marker types to implement online features when generating output. Before you begin using custom marker types, talk to the Stationery designer and verify which online features your Stationery supports. Your Stationery only recognizes the custom marker types defined by the Stationery designer in your Stationery. If you try to implement online features using custom marker types not supported in your Stationery, ePublisher does not recognize these items when generating output. ePublisher correctly converts all standard Adobe FrameMaker marker types. In addition, ePublisher also supports several custom marker types you can use to implement online features in your generated output.
When the Stationery designer creates the Stationery, the Stationery designer can use the default name for a custom marker type or the Stationery designer can use a different name for the customer marker type. The following table lists the default names of custom marker types used to implement online features. Always verify with the Stationery designer the names of the custom marker types you should use when implementing online features before you use these items in your source documents.
Marker Type |
Description |
AbbreviationTitle marker type |
Specifies abbreviation alternate text for browsers to display for abbreviations such as SS# when a user hovers over the abbreviation in output. Screen readers also can read the abbreviation alternate text. Used in combination with the Abbreviation character format. For more information, see “Assigning Alternate Text to Abbreviations in FrameMaker” on page 168 |
AcronymTitle marker type |
Specifies acronym alternate text for browsers to display for acronyms such as HTML when a user hovers over the acronym in output. Screen readers can also read the acronym alternate text. Used in combination with the Acronym character format. For more information, see “Assigning Alternate Text to Acronyms in FrameMaker” on page 170. |
Citation marker type |
Specifies the source of a quote using a fully qualified Uniform Resource Identifier (URI) when a user hovers over the quote in output. Screen readers can also read the URI for the quote. Used in combination with the Citation character format. For more information, see “Providing Citations for Quotes in FrameMaker” on page 171. |
DropDownEnd marker type |
Marks the end of an expand/collapse section. Used in conjunction with an Expand/Collapse paragraph format. For more information, see “Creating Expand/Collapse Sections (Drop-Down Hotspots) in FrameMaker” on page 132. |
Filename marker type |
Specifies the name of an output file for a page or an image. For more information, see “Specifying Output File Names in FrameMaker” on page 118. |
GraphicScale marker type |
Specifies a percentage to use to resize an image, such as 50 or 75 percent, in generated output. For more information, see “Assigning Image Scales in FrameMaker” on page 103. |
GraphicStyle marker type |
Specifies the name of a image style defined in a project to apply to an image. This marker type is an internal marker type that is not displayed in Stationery Designer. You cannot create a marker type with a different name and assign it this functionality. For more information, see “Assigning Image Styles in FrameMaker” on page 105. |
Hypertext marker type |
Specifies a link using the newlink and gotolink commands in Adobe FrameMaker. This marker type is a default Adobe FrameMaker marker type ePublisher automatically maps. |
ImageAltText marker type |
Specifies alternate text for an image.This text is added to the alt attribute of the img tag in the output. Screen readers use this text when you create accessible content. For more information, see “Assigning Alternate Text to Images in FrameMaker” on page 155. |
ImageAreaAltText marker type |
Specifies alternate text for clickable regions in an image map. This text is added to the alt attribute of the img tag in the output. Screen readers use this text when you create accessible content. For more information, see “Assigning Alternate Text to Image Maps in FrameMaker” on page 156. |
ImageLongDescByRef marker type |
Specifies the path to the file that contains the long description for an image. This text is added to the longdesc attribute of the img tag in the output. Screen readers read this description when you create accessible content. For more information, see “Using Text in External Files to Assign Long Descriptions to Images in FrameMaker” on page 162. |
ImageLongDescNotReq marker type |
Specifies that a long description is not required for an image, which bypasses this accessibility check for the image when you create accessible content. For more information, see “Excluding Images from Accessibility Report Checks in FrameMaker” on page 164. |
ImageLongDescText marker type |
Specifies the long description for an image. This text is added to the longdesc attribute of the img tag in the output. Screen readers read this description when you create accessible content. For more information, see “Assigning Long Descriptions to Images in FrameMaker” on page 157. |
Keywords marker type |
Specifies the keywords to include in the meta tag for the topic. The meta tag improves searchability on the Web. For more information, see “Creating Meta Tag Keywords in FrameMaker” on page 141. |
PageStyle marker type |
Specifies the name of a page style defined in the project to apply to a topic. This marker type is an internal marker type that is not displayed in Stationery Designer. You cannot create a marker type with a different name and assign it this functionality. For more information, see “Assigning Custom Page Styles in FrameMaker” on page 142. |
Popup marker type |
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 text is stored, such as the glossary, is displayed. For more information, see “Using Markers to Create Popup Windows in FrameMaker” on page 130. |
PopupEnd marker type |
Marks the end of the content to include in a popup window. For more information, see “Using Markers to Create Popup Windows in FrameMaker” on page 130. |
PopupOnly marker type |
Specifies the start of the content to include in only a popup window. Browsers display the content in a popup window when you hover over or click the link. For more information, see “Using Markers to Create Popup Windows in FrameMaker” on page 130. |
RubiComposite marker type |
No longer supported. |
SeeAlsoKeyword marker type |
Specifies an internal identifier for a topic. SeeAlsoLink markers in other topics can list this identifier to create a link to this topic. Used in conjunction with a See Also paragraph format or character format. For more information, see “Creating See Also Links in FrameMaker” on page 137. |
SeeAlsoLink marker type |
Identifies an internal identifier from another topic to include in the list of See Also links in this topic. Used in conjunction with a See Also paragraph format or character format. For more information, see “Creating See Also Links in FrameMaker” on page 137. |
SeeAlsoLinkDisplayType marker type |
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 type is supported only in HTML Help. For more information, see “Creating See Also Links in FrameMaker” on page 137. |
SeeAlsoLinkWindowType marker type |
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 type is supported only in HTML Help. For more information, see “Creating See Also Links in FrameMaker” on page 137. |
TableStyle marker type |
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 type is an internal marker type that is not displayed in Stationery Designer. This marker type is supported only for Microsoft Word documents. You cannot create a marker type with a different name and assign it this functionality. For more information, see “Applying Table Styles in Word” on page 187 |
TableSummary marker type |
Specifies an alternate text summary for a table, which is used when you create accessible content. This text is added to the summary attribute of the table tag in the output. Screen readers read this description when you create accessible content. For more information, see “Assigning Alternate Text (Summaries) to Tables in FrameMaker” on page 166. |
TableSummaryNotReq marker type |
Specifies that a summary is not required for a table, which bypasses this accessibility check for that table. For more information, see “Excluding Tables from Accessibility Report Checks in FrameMaker” on page 167. |
TOCIconHTMLHelp marker type |
Identifies the image to use as the table of contents icon for a topic in the HTML Help output format. For more information, see “Customizing Table of Contents Icons in FrameMaker” on page 147. |
TOCIconJavaHelp marker type |
Identifies the image to use as the table of contents icon for a topic in the Sun JavaHelp output format. For more information, see “Customizing Table of Contents Icons in FrameMaker” on page 147. |
TOCIconOracleHelp marker type |
Identifies the image to use as the table of contents icon for a topic in the Oracle Help output format. For more information, see “Customizing Table of Contents Icons in FrameMaker” on page 147. |
TOCIconWWHelp marker type |
Identifies the image to use as the table of contents icon for a topic in the WebWorks Help output format. For more information, see “Customizing Table of Contents Icons in FrameMaker” on page 147. |
TopicAlias marker type |
Specifies an internal identifier for a topic that can be used to create a context-sensitive link to that topic. For more information, see “Creating Context-Sensitive Help in FrameMaker” on page 121. |
WhatIsThisID marker type |
Identifies a What’s This help internal identifier for creating context-sensitive What’s This field-level help for Microsoft HTML Help. For more information, see “Creating What’s This (Field-Level) Help in FrameMaker” on page 144. |
WindowType marker type |
Specifies the name of the window defined in the Help project that the topic should be displayed in. In Microsoft HTML Help, the window names are defined in the .hhp file. This marker type is supported in Microsoft HTML Help and Oracle Help. For more information, see “Opening Topics in Custom Windows in FrameMaker” on page 146. |