mirror of
https://github.com/JetBrains/intellij-sdk-code-samples.git
synced 2025-07-30 18:27:49 +08:00
Plugin configuration file rework (#858)
This commit is contained in:
parent
093008288e
commit
17d2d115b3
@ -763,7 +763,7 @@ Default value
|
||||
### pluginDescription
|
||||
{id="patchpluginxml-task-plugindescription"}
|
||||
|
||||
The description of the plugin used in the `<description>` tag.
|
||||
The description of the plugin used in the [`<description>`](plugin_configuration_file.md#idea-plugin__description) tag.
|
||||
|
||||
{style="narrow"}
|
||||
Type
|
||||
@ -776,7 +776,7 @@ Default value
|
||||
### sinceBuild
|
||||
{id="patchpluginxml-task-sincebuild"}
|
||||
|
||||
The lower bound of the version range to be patched used in the `since-build` attribute of the `<idea-version>` tag.
|
||||
The lower bound of the version range to be patched used in the `since-build` attribute of the [`<idea-version>`](plugin_configuration_file.md#idea-plugin__idea-version) tag.
|
||||
|
||||
{style="narrow"}
|
||||
Type
|
||||
@ -789,7 +789,7 @@ Default value
|
||||
### untilBuild
|
||||
{id="patchpluginxml-task-untilbuild"}
|
||||
|
||||
The upper bound of the version range to be patched used in the `until-build` attribute of the `<idea-version>` tag.
|
||||
The upper bound of the version range to be patched used in the `until-build` attribute of the [`<idea-version>`](plugin_configuration_file.md#idea-plugin__idea-version) tag.
|
||||
|
||||
{style="narrow"}
|
||||
Type
|
||||
@ -802,7 +802,7 @@ Default value
|
||||
### version
|
||||
{id="patchpluginxml-task-version"}
|
||||
|
||||
The version of the plugin used in the `<version>` tag.
|
||||
The version of the plugin used in the [`<version>`](plugin_configuration_file.md#idea-plugin__version) tag.
|
||||
|
||||
{style="narrow"}
|
||||
Type
|
||||
@ -815,7 +815,7 @@ Default value
|
||||
### changeNotes
|
||||
{id="patchpluginxml-task-changenotes"}
|
||||
|
||||
The change notes of the plugin used in the `<change-notes>` tag.
|
||||
The change notes of the plugin used in the [`<change-notes>`](plugin_configuration_file.md#idea-plugin__change-notes) tag.
|
||||
|
||||
{style="narrow"}
|
||||
Type
|
||||
@ -828,7 +828,7 @@ Default value
|
||||
### pluginId
|
||||
{id="patchpluginxml-task-pluginid"}
|
||||
|
||||
The ID of the plugin used in the `<id>` tag.
|
||||
The ID of the plugin used in the [`<id>`](plugin_configuration_file.md#idea-plugin__id) tag.
|
||||
|
||||
{style="narrow"}
|
||||
Type
|
||||
|
@ -265,24 +265,13 @@ This, and additional information can also be found by using the [Code Completion
|
||||
>
|
||||
{type="tip"}
|
||||
|
||||
> See the [`<actions>`](plugin_configuration_file.md#idea-plugin__actions) element and its children documentation for details.
|
||||
>
|
||||
{type="note"}
|
||||
|
||||
```xml
|
||||
<actions>
|
||||
|
||||
<!--
|
||||
The <action> element defines an action to register. Attributes:
|
||||
- "id" (required) - specifies a unique identifier for the action
|
||||
- "class" (required) - specifies the FQN of the class implementing
|
||||
the action
|
||||
- "text" (required) - specifies the default long-version text to be
|
||||
displayed for the action (tooltip for toolbar button or text for
|
||||
menu item)
|
||||
- "use-shortcut-of" (optional) - specifies the ID of the action
|
||||
whose keyboard shortcut this action will use
|
||||
- "description" (optional) - specifies the text which is displayed
|
||||
in the status bar when the action is focused
|
||||
- "icon" (optional) - specifies the icon which is displayed on
|
||||
the toolbar button or next to the menu item
|
||||
-->
|
||||
<action
|
||||
id="VssIntegration.GarbageCollection"
|
||||
class="com.example.impl.CollectGarbage"
|
||||
@ -291,17 +280,10 @@ This, and additional information can also be found by using the [Code Completion
|
||||
icon="icons/garbage.png">
|
||||
|
||||
<!--
|
||||
The <override-text> element defines an alternate version of the text
|
||||
for the menu action. Attributes:
|
||||
- "text" (required) - defines the text to be displayed for the action
|
||||
- "place" (required) - declares where the alternate text should
|
||||
be used. In this example, any time the action is displayed in
|
||||
the IDE main menu (and submenus), the override-text version should
|
||||
be used.
|
||||
The second <override-text> element uses the alternate attribute
|
||||
"use-text-of-place" to define a location (EditorPopup) to use the same
|
||||
text as is used in MainMenu. It is a way to specify the use of
|
||||
an alternate menu text in multiple discrete menu groups.
|
||||
"use-text-of-place" to define a location (EditorPopup) to use the
|
||||
same text as is used in MainMenu. It is a way to specify the use
|
||||
of an alternate menu text in multiple discrete menu groups.
|
||||
-->
|
||||
<override-text place="MainMenu" text="Collect _Garbage"/>
|
||||
<override-text place="EditorPopup" use-text-of-place="MainMenu"/>
|
||||
@ -309,42 +291,11 @@ This, and additional information can also be found by using the [Code Completion
|
||||
<!-- Provide alternative names for searching action by name -->
|
||||
<synonym text="GC"/>
|
||||
|
||||
<!--
|
||||
The <add-to-group> node specifies that the action should be added to an
|
||||
existing group. An action can be added to several groups. Attributes:
|
||||
- "group-id" (required) - specifies the ID of the group to which the
|
||||
action is added. The group must be an implementation of the
|
||||
DefaultActionGroup class.
|
||||
- "anchor" (required) - specifies the position of the action in
|
||||
the relative to other actions. Allowed values: "first", "last",
|
||||
"before", and "after".
|
||||
- "relative-to-action" (mandatory if "anchor" is "before" or "after") -
|
||||
specifies the action before or after which the current action is
|
||||
inserted.
|
||||
-->
|
||||
<add-to-group
|
||||
group-id="ToolsMenu"
|
||||
relative-to-action="GenerateJavadoc"
|
||||
anchor="after"/>
|
||||
|
||||
<!--
|
||||
The <keyboard-shortcut> node specifies the keyboard shortcut for
|
||||
the action. An action can have several keyboard shortcuts. Attributes:
|
||||
- "first-keystroke" (required) - specifies the first keystroke of
|
||||
the action. The keystrokes are specified according to the regular
|
||||
Swing rules.
|
||||
- "second-keystroke" (optional) - specifies the second keystroke of
|
||||
the action.
|
||||
- "keymap" (required) - specifies the keymap for which the action
|
||||
is active. IDs of the standard keymaps are defined as constants
|
||||
in the com.intellij.openapi.keymap.KeymapManager class.
|
||||
- "remove" (optional) - shortcut should be removed from the specified
|
||||
action. See the second <keyboard-shortcut> example element below.
|
||||
- "replace-all" (optional) - removes all keyboard and mouse shortcuts
|
||||
from the specified action before adding the specified shortcut.
|
||||
See the third <keyboard-shortcut> example element below.
|
||||
-->
|
||||
|
||||
<!-- Add the first and second keystrokes to all keymaps... -->
|
||||
<keyboard-shortcut
|
||||
keymap="$default"
|
||||
@ -358,66 +309,30 @@ This, and additional information can also be found by using the [Code Completion
|
||||
second-keystroke="C"
|
||||
remove="true"/>
|
||||
|
||||
<!-- The "Mac OS X 10.5+" keymap and its children will have only this
|
||||
keyboard shortcut for this action. -->
|
||||
<!-- The "Mac OS X 10.5+" keymap and its children will have only
|
||||
this keyboard shortcut for this action. -->
|
||||
<keyboard-shortcut
|
||||
keymap="Mac OS X 10.5+"
|
||||
first-keystroke="control alt G"
|
||||
second-keystroke="C"
|
||||
replace-all="true"/>
|
||||
|
||||
<!--
|
||||
The <mouse-shortcut> node specifies the mouse shortcut for the action.
|
||||
An action can have several mouse shortcuts. Attributes:
|
||||
- "keystroke" (required) - specifies the clicks and modifiers for
|
||||
the action. It is defined as a sequence of words separated by spaces:
|
||||
* mouse buttons: "button1", "button2", "button3"
|
||||
* modifier keys: "shift", "control", "meta", "alt", "altGraph"
|
||||
* button double-click: "doubleClick"
|
||||
- "keymap" (required) - specifies the keymap for which the action is
|
||||
active. IDs of the standard keymaps are defined as constants in
|
||||
the com.intellij.openapi.keymap.KeymapManager class.
|
||||
The <mouse-shortcut> element can also specify "remove" and "replace-all"
|
||||
attributes. See <keyboard-shortcut> description above for details.
|
||||
-->
|
||||
<mouse-shortcut
|
||||
keymap="$default"
|
||||
keystroke="control button3 doubleClick"/>
|
||||
</action>
|
||||
|
||||
<!--
|
||||
This action declares neither a text nor a description attribute. If it
|
||||
has a resource bundle declared, the text and descriptions will be
|
||||
retrieved based on the action-id incorporated in the key for a translated
|
||||
string.
|
||||
This action declares neither a text nor a description attribute.
|
||||
If it has a resource bundle declared, the text and descriptions
|
||||
will be retrieved based on the action-id incorporated in the key
|
||||
for a translated string.
|
||||
-->
|
||||
<action
|
||||
id="sdk.action.PopupDialogAction"
|
||||
class="sdk.action.PopupDialogAction"
|
||||
icon="SdkIcons.Sdk_default_icon"/>
|
||||
|
||||
<!--
|
||||
The <group> element defines an action group. The <action>, <group>
|
||||
and <separator> elements defined within it are automatically included
|
||||
in the group. Attributes:
|
||||
- "id" (required) - specifies a unique identifier for the group.
|
||||
- "class" (optional) - specifies the FQN of the class implementing
|
||||
the group. If not specified,
|
||||
com.intellij.openapi.actionSystem.DefaultActionGroup is used.
|
||||
- "text" (optional) - specifies the text of the group (text for the menu
|
||||
item showing the submenu).
|
||||
- "description" (optional) specifies the text which is displayed in the
|
||||
status bar when the group has focus.
|
||||
- "icon" (optional) - specifies the icon which is displayed on
|
||||
the toolbar button or next to the menu group.
|
||||
- "popup" (optional) - specifies how the group is presented in the menu.
|
||||
* "true" - group actions are placed in a submenu
|
||||
* "false" - actions are displayed as a section of the same menu
|
||||
delimited by separators.
|
||||
- "compact" (optional) - specifies whether an action within that group
|
||||
is visible when disabled. Setting compact="true" specifies an action
|
||||
in the group isn't visible unless the action is enabled.
|
||||
-->
|
||||
<group
|
||||
class="com.example.impl.MyActionGroup"
|
||||
id="TestActionGroup"
|
||||
|
File diff suppressed because it is too large
Load Diff
Loading…
x
Reference in New Issue
Block a user