Plexora

PluginHelp

Help shown by the ? button in a tool's card header. All of it is plain text, never HTML.

Generated from Plexora 0.0.55View source

Properties

summarystringrequired

What the tool does. A blank line starts a new paragraph.

notesstring[]

Bullet points.

shortcuts{keys: (string|string[]), label: string}[]

Keys the tool responds to. keys is a chord such as "mod+shift+z" (printed per platform) or a single key ("x" prints as X); an array prints several keys in one row.

docsstring

A page of the documentation site to link to, relative to its /docs/ root, e.g. "plugins/roi". Bundled plugins set it; the help dialog shows a "Read the documentation" link.