Class enthought.​help.​help_plugin.​help_plugin.​HelpPlugin

Contents:
• Base classes
• Attributes
• Methods

Inherits from

• Plugin: enthought.envisage.plugin.Plugin

Attributes

• help_action_sets

  help_action_sets = List(contributes_to = WORKBENCH_ACTION_SETS)
  
  

• HELP_DEMOS

  HELP_DEMOS = (PKG + '.help_demos')
  
  

• help_demos

  help_demos = ExtensionPoint(List(IHelpCode), id = HELP_DEMOS, desc = """
          
          A help demo is a Python program that is run when it is selected from
          the Help>Demos submenu. It is defined by a preference node that 
          specifies a UI label and a filename for the demo entry point.
          
          Each contribution to this extension point must be an instance of a 
          class that implements IHelpCode. The easiest way to do this is to
          create an instance of  `enthought.help.help_plugin.api.HelpCode`.
          
          So, to contribute a help demo:
          
          1. Create a preferences file for your plugin if it doesn't already
             have one. (Be sure to contribute your preferences file to the
             `enthought.envisage.preferences` extension point.)
  
          2. Define a unique "node" (section heading) in your preferences file
             for each demo, and specify values for the 'label' and 'filename' 
             settings. (Note that the same preferences section can be used for
             a help demo and a help example.)
             
          3. For each demo, contribute a HelpDemo to this extension point,
             and specify its *preferences_path* as the corresponding node
             name from your preferences file.
          """)
  
  

• HELP_DOCS

  IDs of extension points this plugin offers.

  HELP_DOCS = (PKG + '.help_docs')
  
  

• help_docs

  help_docs = ExtensionPoint(List(IHelpDoc), id = HELP_DOCS, desc = """
          
          A help doc is defined by a preference node that specifies a UI label, 
          a filename for the document, and a (path to a) viewer for viewing the 
          document.
          
          Each contribution to this extension point must be an instance of a 
          class that implements IHelpDoc. The easiest way to do this is to
          create an instance of  `enthought.help.help_plugin.api.HelpDoc`.
          
          So, to contribute a help doc:
          
          1. Create a preferences file for your plugin if it doesn't already
             have one. (Be sure to contribute your preferences file to the
             `enthought.envisage.preferences` extension point.)
  
          2. Define a unique "node" (section heading) in your preferences file
             for each document, and specify values for the 'label', 'viewer',
             and 'filename' settings. (Use 'browser' as the value of 'viewer' if
             the document can be viewed in a web browser.)
             
          3. For each document, contribute a HelpDoc to this extension point,
             and specify its *preferences_path* as the corresponding node
             name from your preferences file.
          """)
  
  

• HELP_DOWNLOADS

  HELP_DOWNLOADS = (PKG + '.help_downloads')
  
  

• help_downloads

  help_downloads = ExtensionPoint(List(IHelpDoc), id = HELP_DOWNLOADS, desc = """
          
          A help download is a url that is opened in a browser for viewing when it
          is selected from the Help>Downloads submenu. It is defined by a 
          preference node that specifies a UI label and a url for the download.
          
          Each contribution to this extension point must be an instance of a 
          class that implements IHelpDoc, and has the url trait set to True. The 
          easiest way to do this is to create an instance of 
          `enthought.help.help_plugin.api.HelpDoc`.
          
          So, to contribute a help doc:
          
          1. Create a preferences file for your plugin if it doesn't already
             have one. (Be sure to contribute your preferences file to the
             `enthought.envisage.preferences` extension point.)
  
          2. Define a unique "node" (section heading) in your preferences file
             for each url, and specify values for the 'label' and 'filename' 
             settings. Also set 'url' to True.
             
          3. For each document, contribute a HelpDoc to this extension point,
             and specify its *preferences_path* as the corresponding node
             name from your preferences file.
          """)
  
  

• HELP_EXAMPLES

  HELP_EXAMPLES = (PKG + '.help_examples')
  
  

• help_examples

  help_examples = ExtensionPoint(List(IHelpCode), id = HELP_EXAMPLES, desc = """
          
          A help example is a Python file that is opened for viewing when it is
          selected from the Help>Examples submenu. It is defined by a preference
          node that specifies a UI label and a filename for the primary example
          file.
          
          Each contribution to this extension point must be an instance of a 
          class that implements IHelpCode. The easiest way to do this is to
          create an instance of `enthought.help.help_plugin.api.HelpCode`.
          
          So, to contribute a help example:
          
          1. Create a preferences file for your plugin if it doesn't already
             have one. (Be sure to contribute your preferences file to the
             `enthought.envisage.preferences` extension point.)
  
          2. Define a unique "node" (section heading) in your preferences file
             for each example, and specify values for the 'label' and 'filename'
             settings. (Note that the same preferences section can be used for
             a help demo and a help example.)
             
          3. For each example, contribute a HelpCode to this extension point,
             and specify its *preferences_path* as the corresponding node
             name from your preferences file.
          """)
  
  

• id

  The plugin's unique identifier.

  id = 'enthought.help.help_plugin'
  
  

• menus

  List of menu names added to the main toolbar by this plugin (These are placed before the 'Help' Menu).

  menus = List(Str)
  
  

• name

  The plugin's name (suitable for displaying to the user).

  name = 'Help Plugin'
  
  

• PREFERENCES

  PREFERENCES = 'enthought.envisage.preferences'
  
  

• preferences

  preferences = List(contributes_to = PREFERENCES)
  
  

• PREFERENCES_PAGES

  PREFERENCES_PAGES = 'enthought.envisage.ui.workbench.preferences_pages'
  
  

• preferences_pages

  preferences_pages = List(contributes_to = PREFERENCES_PAGES)
  
  

• WORKBENCH_ACTION_SETS

  IDs of extension points this plugin contributes to.

  WORKBENCH_ACTION_SETS = 'enthought.envisage.ui.workbench.action_sets'
  
  

Method summary