Class enthought.help.help_plugin_definition.HelpProject

API Reference for Enthought Tool Suite 3.0.1

A help project.

Can be an HTML Help (.chm) or WebHelp project. Note: There should be one HelpProject per help project per application. If a plug-in needs a help project for which there is already a HelpProject defined in another plug-in, the former should "require" the latter, rather than redefining the HelpProject.

Base classes
Attributes

Inherits from

ExtensionPoint: enthought.envisage.core.core_plugin_definition.ExtensionPoint

Attributes

custom_wnd

The name of the custom window used for context-sensitive topic. fixme?: Assumes that at most one custom window is used.
```
custom_wnd = Str
```
help_file

The file name of the project entry point. If a file extension is not specified, the plug-in will append '.chm' on MS Windows and '.htm' otherwise.
```
help_file = Str
```
map_file

The name of the .h file that maps topic IDs to map numbers.
```
map_file = Str
```
name

The text to use in the Help menu For now: help projects are responsible for adding themselves to the menu.
```
name = Str
```
proj_id

The project's unique identifier. Used in topic strings for context-sensitive help.
```
proj_id = Str
```

© Copyright 2002-2008 Enthought, Inc.