mirror of
https://github.com/JetBrains/intellij-sdk-code-samples.git
synced 2025-07-27 16:57:49 +08:00
Update generated descriptor pages (#1456)
Co-authored-by: karollewandowski <1154140+karollewandowski@users.noreply.github.com>
This commit is contained in:
parent
9e2fe1956d
commit
9310369f6a
@ -87,6 +87,8 @@ Deprecated elements are omitted in the list below.
|
|||||||
- [`<listener>`](#idea-plugin__applicationListeners__listener)
|
- [`<listener>`](#idea-plugin__applicationListeners__listener)
|
||||||
- [`<projectListeners>`](#idea-plugin__projectListeners)
|
- [`<projectListeners>`](#idea-plugin__projectListeners)
|
||||||
- [`<listener>`](#idea-plugin__applicationListeners__listener)
|
- [`<listener>`](#idea-plugin__applicationListeners__listener)
|
||||||
|
- [`<xi:include>`](#idea-plugin__xi:include)
|
||||||
|
- [`<xi:fallback>`](#idea-plugin__xi:include__xi:fallback)
|
||||||
|
|
||||||
## `idea-plugin`
|
## `idea-plugin`
|
||||||
{#idea-plugin}
|
{#idea-plugin}
|
||||||
@ -128,6 +130,7 @@ Children
|
|||||||
- [`<resource-bundle>`](#idea-plugin__resource-bundle)
|
- [`<resource-bundle>`](#idea-plugin__resource-bundle)
|
||||||
- [`<vendor>`](#idea-plugin__vendor)
|
- [`<vendor>`](#idea-plugin__vendor)
|
||||||
- [`<version>`](#idea-plugin__version)
|
- [`<version>`](#idea-plugin__version)
|
||||||
|
- [`<xi:include>`](#idea-plugin__xi:include)
|
||||||
- [`<application-components>`](#idea-plugin__application-components) ![Deprecated][deprecated]
|
- [`<application-components>`](#idea-plugin__application-components) ![Deprecated][deprecated]
|
||||||
- [`<module-components>`](#idea-plugin__module-components) ![Deprecated][deprecated]
|
- [`<module-components>`](#idea-plugin__module-components) ![Deprecated][deprecated]
|
||||||
- [`<project-components>`](#idea-plugin__project-components) ![Deprecated][deprecated]
|
- [`<project-components>`](#idea-plugin__project-components) ![Deprecated][deprecated]
|
||||||
@ -1455,6 +1458,101 @@ Children
|
|||||||
:
|
:
|
||||||
- [`<listener>`](#idea-plugin__applicationListeners__listener)
|
- [`<listener>`](#idea-plugin__applicationListeners__listener)
|
||||||
|
|
||||||
|
### `xi:include`
|
||||||
|
{#idea-plugin__xi:include}
|
||||||
|
|
||||||
|
Allows including content of another plugin descriptor in this descriptor with
|
||||||
|
[XInclude](http://www.w3.org/2001/XInclude) standard.
|
||||||
|
|
||||||
|
{type="narrow"}
|
||||||
|
Namespace
|
||||||
|
:
|
||||||
|
`xi="http://www.w3.org/2001/XInclude"`
|
||||||
|
|
||||||
|
{type="narrow"}
|
||||||
|
Required
|
||||||
|
: no
|
||||||
|
|
||||||
|
|
||||||
|
{type="narrow"}
|
||||||
|
Attributes
|
||||||
|
:
|
||||||
|
- `href` _(optional)_<br/>
|
||||||
|
Path of the plugin descriptor file to include.
|
||||||
|
- `xpointer` _(optional)_<br/>
|
||||||
|
**_Deprecated since 2021.2_**: The `xpointer` attribute must be `xpointer(/idea-plugin/*)` or not defined.
|
||||||
|
|
||||||
|
Elements pointer to include.<br/>
|
||||||
|
Default value: `xpointer(/idea-plugin/*)`.
|
||||||
|
|
||||||
|
Children
|
||||||
|
:
|
||||||
|
- [`<xi:fallback>`](#idea-plugin__xi:include__xi:fallback)
|
||||||
|
|
||||||
|
Example
|
||||||
|
:
|
||||||
|
Given a plugin descriptor:
|
||||||
|
|
||||||
|
```xml
|
||||||
|
<idea-plugin xmlns:xi="http://www.w3.org/2001/XInclude">
|
||||||
|
<id>com.example.myplugin</id>
|
||||||
|
<name>Example</name>
|
||||||
|
<xi:include href="/META-INF/another-plugin.xml"/>
|
||||||
|
...
|
||||||
|
</idea-plugin>
|
||||||
|
```
|
||||||
|
|
||||||
|
and <path>/META-INF/another-plugin.xml</path>:
|
||||||
|
|
||||||
|
```xml
|
||||||
|
<idea-plugin>
|
||||||
|
<extensions>...</extensions>
|
||||||
|
<actions>...</actions>
|
||||||
|
</idea-plugin>
|
||||||
|
```
|
||||||
|
|
||||||
|
The effective plugin descriptor loaded to memory will contain the following elements:
|
||||||
|
|
||||||
|
```xml
|
||||||
|
<idea-plugin xmlns:xi="http://www.w3.org/2001/XInclude">
|
||||||
|
<id>com.example.myplugin</id>
|
||||||
|
<name>Example</name>
|
||||||
|
<extensions>...</extensions>
|
||||||
|
<actions>...</actions>
|
||||||
|
...
|
||||||
|
</idea-plugin>
|
||||||
|
```
|
||||||
|
|
||||||
|
#### `xi:fallback`
|
||||||
|
{#idea-plugin__xi:include__xi:fallback}
|
||||||
|
|
||||||
|
Indicates that including the specified file is optional.
|
||||||
|
|
||||||
|
If the file referenced in `href` is not found and the `xi:fallback`
|
||||||
|
element
|
||||||
|
is missing, the plugin will fail to load.
|
||||||
|
|
||||||
|
{type="narrow"}
|
||||||
|
Namespace
|
||||||
|
:
|
||||||
|
`xi="http://www.w3.org/2001/XInclude"`
|
||||||
|
|
||||||
|
{type="narrow"}
|
||||||
|
Required
|
||||||
|
: no
|
||||||
|
|
||||||
|
Example
|
||||||
|
:
|
||||||
|
```xml
|
||||||
|
<idea-plugin xmlns:xi="http://www.w3.org/2001/XInclude">
|
||||||
|
...
|
||||||
|
<xi:include href="/META-INF/optional-plugin.xml">
|
||||||
|
<xi:fallback/>
|
||||||
|
</xi:include>
|
||||||
|
...
|
||||||
|
</idea-plugin>
|
||||||
|
```
|
||||||
|
|
||||||
### `application-components`
|
### `application-components`
|
||||||
{#idea-plugin__application-components collapsible="true" initial-collapse-state="collapsed"}
|
{#idea-plugin__application-components collapsible="true" initial-collapse-state="collapsed"}
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user