### 38.4 Assigning properties to PI marker types

You can define the behavior of a new PI marker type, or redefine the behavior of an existing PI marker type, by assigning one or more properties to the PI marker type:

[MarkerTypes]
; PI marker type name = properties
Marker = Property1 Property2 ...

Which properties you can assign depends on whether you are converting to HTML or to RTF. A few properties are common to both output types: Delete, Code, ALink, and Config. The rest are specific to either HTML or RTF output. Table 38-3 lists all the [MarkerTypes] properties, shows which output types apply, and describes the effect of each property.

Table 38-3 Effects of [MarkerTypes] properties

Output | Property | Effect
RTF or HTML | ALink | Content is treated as a list of names of categories that apply to the current topic. Category names should be single terms, separated by semicolons. Use spaces or other punctuation in the names at your own risk. Available for WinHelp, MS HTML Help, OmniHelp, and Oracle Help for Java.
Code | Any macros in the marker are expanded, and the content is surrounded by any code specified for the marker type in [MarkerTypeCodeBefore] and [MarkerTypeCodeAfter]; see §38.5 Inserting code with PI markers for more information. Cannot be combined with HTMLComment.
Config | Content is a configuration setting of the form [Section]Key=Value or [Section]=Value; see §42.2 Overriding settings with PI markers or macros.
Delete | The marker is removed entirely; DITA2Go applies this property last, after any other properties you specify. Must be specified last.
RTF only | RTFConfig | Content is a configuration setting of the form [Section]Key=Value or [Section]=Value; see §42.2 Overriding settings with PI markers or macros.
HTML only | ANSI | Specifies the Windows code page to use, default 1252; or 1250 for CE/EE, 1251 for Cyrillic, 1253 for Greek, 1254 for Turkish.
| Extr* | Each of these markers has the same effect as the corresponding [HTMLParaStyles]parafmt=Extr* property; see §27.4.1 Enabling and disabling extract processing. For ExtrDisable, ExtrEnable, ExtrEnd, and ExtrStart, any content is ignored, unless you also specify other properties that use the content, such as Code.
| ExtrBottom | Content becomes the last item in the extract <body>.
| ExtrDisable | Turns extract processing off.
| ExtrEnable | Turns extract processing on.
| ExtrEnd | Ends a file extract, but is not part of the extract.
| ExtrFinish | Ends a file extract, and is the last part of the extract.
| ExtrHead | Content is placed in the <head> of the extract, after the <title> element.
| ExtrReplace | Content replaces an extract in the parent file.
| ExtrStart | Begins an extract. Must be specified before FileName or Title.
| ExtrTop | Content becomes the first item in the extract <body>.
| FileName | Marker content names the current split or extracted file; dangerous (see §43.3.2 Using PI markers to name output files)
| HelpMerge | Marker content specifies another help file to be merged at the point of insertion
| HTMConfig | Content is a configuration setting of the form [Section]Key=Value or [Section]=Value; see §42.2 Overriding settings with PI markers or macros.
| HTMLComment | Marker content is treated as an HTML comment, and enclosed within HTML comment delimiters; or, if you specified XML as the output type, marker content is properly converted to an XML comment. Cannot be combined with Code.
| Split | Marks a split point in a DITA file; has the same effect as [HTMLParaStyles]parafmt=Split; see §27.3.1 Designating split points. Any content is ignored, unless you also specify other properties that use the content, such as Code. Must be specified before FileName or Title.
| Title | Marker content becomes the page title attribute of the current split or extract file.
| TopicStartCode | Same as the Code property, except macros are expanded at the start of the topic. Any output the macros create is available as predefined macro <$_TopicStartCode>, which can be used anywhere in the current topic.
| Window | HTML Help only. Marker content names a secondary window as the target for jumps from the paragraph containing the marker.

Previous Topic: 38.3 Adding attributes with PI markers

Next Topic: 38.5 Inserting code with PI markers

Parent Topic: 38. Working with processing instructions

Sibling Topics:

38.1 Understanding DITA2Go PI markers

38.2 Understanding effects of PI markers

38.3 Adding attributes with PI markers

38.5 Inserting code with PI markers

Table of Contents • Index