help.adoc

Help plugin

The help plugin adds a button and/or menu item that opens a dialog showing four tabs:

Tab display name	Tab configuration name	Purpose
Handy shortcuts	shortcuts	Presents keyboard shortcuts available in the {productname} editor.
Keyboard Navigation	keyboardnav	Documents the keyboard-based options for navigating and controlling the entire {productname} editor.
Plugins	plugins	Lists the installed plugins for the {productname} instance, with links to the relevant {productname} documentation. Also presents a list of available {productname} Premium plugins.
Version	versions	Displays the {productname} version.

The {productname} Help dialog can also be shown by pressing a keyboard shortcut.

Action	Windows or Linux	macOS
Open the {productname} Help dialog	Alt+0	⌥+0

As of {productname} 6.7, the keyboard shortcut that opens the {productname} Help dialog displays, by default, in the {productname} status bar.

Basic setup

tinymce.init({
  selector: 'textarea',  // change this value according to your HTML
  plugins: 'help',
  toolbar: 'help'
});

partial$misc/bundling-guide-link.adoc

Options

partial$configuration/help_accessibility.adoc

partial$configuration/help_tabs.adoc

API

Name	Arguments	Description
addTab	tabSpec: TabPanel	Register a tab for the Help dialog

Example: using the addTab API

tinymce.activeEditor.plugins.help.addTab({
  name: 'custom',
  title: 'My Custom Tab',
  items: [
    {
      type: 'htmlpanel',
      html: '<p>This is a custom tab</p>',
    }
  ]
});

Exposing metadata for the help plugin

For information on how to expose metadata from you custom plugin to add it to the Installed plugins list in the Help plugin, see the Creating a Plugin page.

partial$misc/plugin-toolbar-button-id-boilerplate.adoc

partial$misc/plugin-menu-item-id-boilerplate.adoc

Commands

The Help plugin provides the following {productname} command.

partial$commands/help-cmds.adoc