Keyboard Shortcut Plugin Module

Available:	JIRA 4.1 and later

Purpose of this Module Type

A keyboard shortcut plugin module defines a keyboard shortcut within JIRA. A JIRA keyboard shortcut allows you to perform potentially any action in JIRA using one or more keyboard strokes - for example, going to the Dashboard, browsing a project, moving your cursor to a field on a JIRA form, or creating, editing or commenting on an issue.

構成

The root element for the keyboard shortcut plugin module is keyboard-shortcut. It allows the following attributes and child elements for configuration:

属性

名前	説明	既定
鍵 (キー)	[Unable to render {include} The included page could not be found. ({include} をレンダリングできません。ページが見つかりませんでした)] を選択し、	N/A
i18n-name-key	[Unable to render {include} The included page could not be found. ({include} をレンダリングできません。ページが見つかりませんでした)] を選択し、
name	[Unable to render {include} The included page could not be found. ({include} をレンダリングできません。ページが見つかりませんでした)] を選択し、	The plugin key.
非表示	When `hidden='true'`, the keyboard shortcut will not appear in the Keyboard Shortcuts dialog box. Despite not appearing in the dialog box, hidden keyboard shortcuts can still be accessed via they keystrokes. This attribute is only available in JIRA 4.2 and later.	false

Elements

名前	必須	説明
order		A value that determines the order in which the shortcut appears on the Keyboard Shortcuts dialog box (with respect to other `keyboard-shortcut` plugin modules). This element is also used to override existing shortcuts displayed on the Keyboard Shortcuts dialog box (see below). For each `keyboard-shortcut` plugin module, we recommend using gaps in `order` values (for example, `10`, `20`, `30`, etc.) rather than consecutive values. This will allow you to 'insert' new keyboard shortcuts more easily into the keyboard shortcuts dialog box.
description		A human-readable description of this keyboard shortcut module. May be specified as the value of this element for plain text or with the `key` attribute to use the value of a key from the i18n system.
ショートカット		The sequence of keystrokes required to activate the keyboard shortcut's operation. These should be presented in the order that the keys are pressed on a keyboard. For example, `gb` represents a keyboard shortcut whose operation is activated after pressing '`g`', followed by '`b`' on the keyboard.
操作		A jQuery selector that specifies the target of the keyboard shortcut. The target is typically a component of the current page that performs an action. The `operation` element is accompanied by a `type` attribute that specifies the type of keyboard shortcut operation. For more information on the available types, please refer to the JIRA API documentation.
context		The section of the Keyboard Shortcuts dialog box on which the shortcut appears. If this element contains `global` or is omitted, the keyboard shortcut appears in the 'Global Shortcuts' section of this dialog box. If this element contains `issueaction`, the keyboard shortcut appears in the 'Issue Actions' section of the dialog box. If this element contains `issuenavigation`, the keyboard shortcut appears in the 'Navigating Issues' section of the dialog box.

Overriding Existing Keyboard Shortcuts

This feature is only available in JIRA 4.2 and later.

You can override an existing keyboard shortcut defined either within JIRA itself or in another plugin.

To do this create a keyboard-shortcut plugin module with exactly the same shortcut element's keystroke sequence as that of the keyboard shortcut you want to override. Then, ensure that an order element is added, whose value is greater than that defined in the keyboard shortcut being overridden.

While the order element may affect the position of your overriding keyboard shortcut on the Keyboard Shortcuts dialog box, it will also prevent the overridden keyboard shortcut from:

appearing in the dialog box and
being accessed via the keyboard.

国際化

It is possible to include an i18n resource in your atlassian-plugin.xml to translate keyboard shortcut descriptions (via their 'key' attributes) into multiple languages. For examples code on including i18n resources in your atlassian-plugin.xml file, please refer to Downloadable Plugin Resources.

例

These examples are taken from JIRA's pre-defined keyboard shortcuts for going to the Dashboard, commenting on an issue and moving to the next action item on an issue view.

...
    <keyboard-shortcut key="goto.dashboard" i18n-name="admin.keyboard.shortcut.goto.dashboard.name"
                       name="Goto Dashboard">
        <order>10</order>
        <description key="admin.keyboard.shortcut.goto.dashboard.desc">Go to Dashboard</description>
        <shortcut>gd</shortcut>
        <operation type="followLink">#home_link</operation>
    </keyboard-shortcut>
...

...
    <keyboard-shortcut key="comment.issue" i18n-name="admin.keyboard.shortcut.commentissue.name" name="Comment Issue"
                       state='enabled'>
        <order>80</order>
        <description key="admin.keyboard.shortcut.commentissue.desc">Scrolls to comment input and focuses it</description>
        <shortcut>m</shortcut>
        <operation type="click">#comment-issue</operation>
        <context>issueaction</context>
    </keyboard-shortcut>
...

...
    <keyboard-shortcut key="move.to.next.action.item" i18n-name="admin.keyboard.shortcut.movetonextactionitem.name" name="Move to next action item"
                       state='enabled'>
        <order>110</order>
        <description key="admin.keyboard.shortcut.movetonextactionitem.desc">Moves to the next action item on view issue page</description>
        <shortcut>n</shortcut>
        <operation type="moveToNextItem">.issue-data-block:visible</operation>
        <context>issueaction</context>
    </keyboard-shortcut>
...

Child pages

Keyboard Shortcut Plugin Module

Purpose of this Module Type

構成

属性

Elements

Overriding Existing Keyboard Shortcuts

国際化

例