Help topic syntax
The HelpTopic parameter describes a help topic and can be in one of the following
formats:
| Format | Description |
|---|---|
| "Topic" | Reference to a topic in the plugins help file. |
| ":Topic" | Reference to a topic from the main FAR Manager help file. |
| "<FullPath>Topic" | Reference to a topic in a help file located in a folder with full or
relative path of FullPath. An ending backslash must be added. The reference must not be split on mutiple lines. For example, the plugin Foo is located in folder 'D:\FAR\Plugins\Foo' and we need to show the topic 'FooInfo' from its help file: "<D:\FAR\Plugins\Foo\>FooInfo" |
| "<FullModuleName>Topic" | Reference to a topic in a help file located in the same folder as
the plugin with the relative or full path of FullModuleName. The reference must not be split on mutiple lines. For example, we need to show the help topic 'FooInfo' from the help file of the plugin Foo 'D:\FAR\Plugins\Foo\Foo.dll': "<D:\FAR\Plugins\Foo\Foo.dll>FooInfo" |
See also: