The Help Explorer
The Help Explorer gives you access to the documentation built into each installed plugin. You can browse and search all endpoint commands across every plugin, then open a focused help page for any of them.
Opening the Help Explorer
The Help Explorer is a dockable panel. Open it from View → Help Explorer in the menu bar. It occupies a tab alongside other panels in whichever region you assign it.
Browsing endpoints
The Help Explorer displays a searchable table with one row per endpoint across all installed plugins. Columns:
| Column | Description |
|---|---|
| Actions | Row-level action buttons (see below) |
| Exe Name | The plugin that provides this endpoint |
| Version | Plugin version |
| Endpoint | The endpoint ID used in .oce files |
| Description | A one-line summary from the plugin’s help data |
Use the Latest only toggle in the toolbar to hide older versions of the same endpoint when multiple versions of a plugin are installed.
Searching
The search bar in the toolbar filters rows by endpoint ID, plugin name, and description text. Results update as you type or on Enter. Click × to clear the filter.
Row actions
Each row has five action buttons:
| Button | What it does |
|---|---|
| View help (eye icon) | Opens a full Endpoint Help Page for this endpoint |
| Copy call (terminal icon) | Copies a minimal .oce task header to the clipboard |
| Copy template (clipboard icon) | Copies the endpoint’s default task template to the clipboard |
| Save template (floppy icon) | Saves the template as a snippet in the Snippets panel |
| Insert template (arrow-down icon) | Appends the template as a new task block in the active editor |
Endpoint Help Page
Clicking View help opens an Endpoint Help Page as a new panel tab. Each Endpoint Help Page shows:
- The endpoint’s title and one-line summary
- A usage note (if provided by the plugin)
- A parameter reference table:
| Column | Description |
|---|---|
| Name | The parameter key as it appears in the .oce file |
| Type | string, number, boolean, array, or object |
| Required | Whether the parameter must be present |
| Default | Value used when the parameter is omitted (if any) |
| Description | What the parameter controls |
- Example task files you can copy or insert directly
If you open the same endpoint’s help twice, the existing tab is reused rather than opening a duplicate.
Opening help from the editor
Press F1 in the editor while the cursor is on an endpoint header line to open that endpoint’s Help Page directly. The same action is available from the editor toolbar.
When documentation is missing
Help content is cached at install time from the plugin binary. If an endpoint has no documentation, the plugin may not have implemented the help endpoint, or the install cache may be stale.
To refresh the cache, uninstall and reinstall the plugin. If documentation is still absent after reinstallation, contact the plugin publisher.