Using Markers to Specify Context Plug-ins in Eclipse Help

Designing Stationery » Customizing Eclipse Help » Using Markers to Specify Context Plug-ins in Eclipse Help

You can specify Eclipse Help context plug-ins by using Context Plugin markers in your source documents. Obtain the context plug-in IDs you need to specify for your source document groups from your development team. ePublisher places the context plug-ins you specify in your source documents in the plugin.xml file generated for each source document group you have in your project. The Eclipse developers use the context plug-ins defined in plugin.xml files to call your Eclipse Help system as appropriate from Eclipse plug-ins.

To enable specifying context plug-ins for Eclipse Help systems, you need to enable the Context Plugin marker. By default, ePublisher sets the Marker type option for a marker named Context Plugin to Context Plugin. You can create a marker with a different name and set the Marker type option for that marker to Context Plugin.

Then, writers can use this marker in the source documents to define context plug-in IDs for each of the source document groups in their project. Context plug-in IDs must follow these guidelines:

Must be unique

May specify only one context plug-in ID in each Context Plugin marker

May contain alphanumeric characters

Should not contain special characters or spaces, with the exception of underscore (_) characters

To assign context plug-in behavior to context plug-in markers

1. Open your Stationery design project.

2. On the View menu, click Style Designer.

3. In the Marker Styles, select the marker style you want to modify.

4. On the Options tab, set Marker type to Context Plugins.

Was this helpful?

Last modified date: 11/30/2021