HelpTableCommandTemplate

Template for a custom command within a custom section of a help table. At least one of command, name, or note must be defined.

see: createHelpTable

Hierarchy

HelpTableCommandTemplate

Index

Properties

Optional abbreviation

abbreviation: string

An optional abbreviation that activates the command.

see: View.abbreviationMap

Optional clip

clip: Clip

An optional clip of math content that illustrates the command.

Optional command

command: string

Inserts help for the built-in command with the specified API name. If assigned a section name, the entire section is inserted. When present, any other properties except note are ignored.

Optional gesture

gesture: string

An optional key gesture that activates the command. If the string is a single code point, it represents a printable character. Otherwise it represents a Keystroke.

see: View.gestureMap

Optional name

name: string

The text to display as the name of the command. If this is not set, then the values of clip, gesture and abbreviation are ignored.

Optional note

note: string

Additional information that will be appended to the table just under this command. This can appear by itself, in which case the note is attached to the most recently added command.