hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-27 16:57:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

plugin_configuration_file.md: Fix a link

Browse Source
This commit is contained in:
Karol Lewandowski 2025-03-10 15:46:17 +01:00
parent 41d90d84be
commit 5a16be640c
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
topics/basics/plugin_structure/plugin_configuration_file.md
View File

@ -589,7 +589,7 @@ Attributes
`order`. `order`.
<br/> <br/>
To not clash with other plugins defining extensions with the same identifier, To not clash with other plugins defining extensions with the same identifier,
consider prepending the identifier with a prefix related to the plugin [`<id>`](#idea-plugin__id) or consider prepending the identifier with a prefix related to the plugin [`<id>`](#idea-plugin__id) or
[`<name>`](#idea-plugin__name), for example, `id="com.example.myplugin.myExtension"`. [`<name>`](#idea-plugin__name), for example, `id="com.example.myplugin.myExtension"`.
- `order` _(optional)_<br/> - `order` _(optional)_<br/>
Allows for ordering the extension relative to other instances of the same extension point. Allows for ordering the extension relative to other instances of the same extension point.
@ -613,7 +613,7 @@ Attributes
- `mac` - `mac`
- `unix` - `unix`
- `windows` - `windows`
For example, `os="windows"` registers the extension on Windows only. For example, `os="windows"` registers the extension on Windows only.
### `extensionPoints` ### `extensionPoints`
@ -691,12 +691,12 @@ Attributes
The scope in which the [extension](plugin_extensions.md) is The scope in which the [extension](plugin_extensions.md) is
instantiated. instantiated.
Allowed values: Allowed values:
- `IDEA_APPLICATION` _(default)_ - `IDEA_APPLICATION` _(default)_
- `IDEA_PROJECT` - `IDEA_PROJECT`
- `IDEA_MODULE` (**deprecated**) - `IDEA_MODULE` (**deprecated**)
**It is strongly recommended not to introduce new project- and module-level extension points.** **It is strongly recommended not to introduce new project- and module-level extension points.**
If an extension point needs to operate on a `Project` or `Module` instance, declare an application-level extension If an extension point needs to operate on a `Project` or `Module` instance, declare an application-level extension
point and pass the instance as a method parameter. point and pass the instance as a method parameter.
@ -739,7 +739,7 @@ Example
An extension point which restricts the type provided in a `myClass` attribute to be an instance An extension point which restricts the type provided in a `myClass` attribute to be an instance
of `com.example.ParentType`, and the type provided in a `someClass` element to be an instance of `com.example.ParentType`, and the type provided in a `someClass` element to be an instance
of `java.lang.Comparable`: of `java.lang.Comparable`:
```xml ```xml
<extensionPoint <extensionPoint
name="myExtension" name="myExtension"
@ -752,18 +752,18 @@ Example
implements="java.lang.Comparable"/> implements="java.lang.Comparable"/>
</extensionPoint> </extensionPoint>
``` ```
When using the above extension point, an implementation could be registered as follows: When using the above extension point, an implementation could be registered as follows:
```xml ```xml
<myExtension ... <myExtension ...
myClass="com.example.MyCustomType"> myClass="com.example.MyCustomType">
<someClass>com.example.MyComparable</someClass> <someClass>com.example.MyComparable</someClass>
</myExtension> </myExtension>
``` ```
where: where:
- `com.example.MyCustomType` must be a subtype of `com.example.ParentType` - `com.example.MyCustomType` must be a subtype of `com.example.ParentType`
- `com.example.MyComparable` must be a subtype of `java.lang.Comparable` - `com.example.MyComparable` must be a subtype of `java.lang.Comparable`
@ -1276,7 +1276,7 @@ Attributes
- `ref` _(**required**)_<br/> - `ref` _(**required**)_<br/>
The ID of the action to add to a group. The ID of the action to add to a group.
- `id` _(optional)_<br/> - `id` _(optional)_<br/>
**_Deprecated_**: Use `ref` instead. **_Deprecated_**: Use `ref` instead.
The ID of the action to add to a group. The ID of the action to add to a group.
@ -1322,7 +1322,7 @@ Attributes
Separator text is displayed only in specific contexts such as popup menus, toolbars, etc. Separator text is displayed only in specific contexts such as popup menus, toolbars, etc.
- `key` _(optional)_<br/> - `key` _(optional)_<br/>
The [message key]([message key](https://plugins.jetbrains.com/docs/intellij/basic-action-system.html#localizing-actions-and-groups)) for the separator text. The [message key](action_system.md#localizing-actions-and-groups) for the separator text.
The message bundle for use should be registered via the `resource-bundle` attribute of The message bundle for use should be registered via the `resource-bundle` attribute of
the [`<actions>`](#idea-plugin__actions) element. the [`<actions>`](#idea-plugin__actions) element.
The attribute is ignored if the `text` attribute is specified. The attribute is ignored if the `text` attribute is specified.