net.sf.okapi.common

## Interface IHelp

-     public interface IHelp

  Common way of calling the help topics, regardless of the underlying system (for example: eclipse application or simple Java application).

- - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `showTopic(java.lang.Object object, java.lang.String filename)` Shows the help for a given topic.
    `void` | `showTopic(java.lang.Object object, java.lang.String filename, java.lang.String query)` Shows the help for a given topic.
    `void` | `showWiki(java.lang.String topic)` Shows a given topic of the Okapi Wiki.

- - ### Method Detail

    - #### showWiki

          void showWiki(java.lang.String topic)

      Shows a given topic of the Okapi Wiki.
      Parameters:
        `topic` - the name of the topic. Any space will be replaced automatically by '_'.

    - #### showTopic

          void showTopic(java.lang.Object object,
                       java.lang.String filename,
                       java.lang.String query)

      Shows the help for a given topic.
      Parameters:
        `object` - the object for which the help is to be displayed. The package name of this parameter is used to compute the location of the help file.
        `filename` - the filename of the topic to call. The location is computed for the package path of the object parameter.
        `query` - an option query string, or null.

    - #### showTopic

          void showTopic(java.lang.Object object,
                       java.lang.String filename)

      Shows the help for a given topic.
      Parameters:
        `object` - the object for which the help is to be displayed. The package name of this parameter is used to compute the location of the help file.
        `filename` - the filename of the topic to call. The location is computed for the package path of the object parameter.