21.7.1 Understanding how DITA2Go generates context links

DITA2Go recognizes EclipseContext PI markers as the targets of infopop calls. Each infopop provides a link to the topic where an EclipseContext marker is inserted. The <topic> elements included get their href and label attributes from the <topic> elements of the containing paragraphs. This provides the equivalent of the aliases used for CSH in other Help formats; see §16.10 Setting up Context Sensitive Help (CSH). For example:

In plugin.xml:

<extension point="org.eclipse.help.contexts">
  <contexts file="contexts.xml"/>
</extension>

Note:  Eclipse 3.1 and 3.2 require a name parameter for the <contexts> element in plugin.xml; Eclipse 3.3 requires a file parameter instead. See §21.2.2 Deciding where to locate configuration settings.

In contexts.xml:

<contexts>
  <context id="help_button">
    <description>Brief description of this control.</description>
    <topic href="file_name_link1.html" label="Link1 Topic Title"/>
    <topic href="file_name_link2.html" label="Link2 Topic Title"/>
  </context>
  . . .
</contexts>

DITA2Go creates contexts.xml afresh every time you run the conversion, unless you say not to; see §21.3.4.8 Specifying Eclipse Help CSH properties in plugin.xml.

Previous Topic:  21.7 Setting up CSH for Eclipse Help

Next Topic:  21.7.2 Naming context file and attribute for secondary plug-ins

Parent Topic:  21.7 Setting up CSH for Eclipse Help

Sibling Topics:

21.7.2 Naming context file and attribute for secondary plug-ins

21.7.3 Configuring context IDs and context anchors

21.7.4 Configuring context descriptions

21.7.5 Locating context information

Table of ContentsIndex