diff --git a/topics/appendix/resources/custom_plugin_repository.md b/topics/appendix/resources/custom_plugin_repository.md index 123007ab3..57e237869 100644 --- a/topics/appendix/resources/custom_plugin_repository.md +++ b/topics/appendix/resources/custom_plugin_repository.md @@ -96,9 +96,70 @@ It is recommended to avoid adding unnecessary elements as they will have to be s The additional candidate elements: -| Element | Effects & Requirements | -|:--------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| ``
My Plugin Name
`
` | By default the name of the plugin JAR/ZIP file is displayed before installation.
Using the `` element displays the name of the plugin.
Contents should match the [``](plugin_configuration_file.md#idea-plugin__name) element contents in the plugin's plugin.xml file to avoid confusion. | -| ``
My plugin is awesome
`
` | By default no description for the plugin is displayed before installation.
Using the `` element will cause a description to be displayed before installation.
Contents should match the [``](plugin_configuration_file.md#idea-plugin__description) element contents in the plugin's plugin.xml file to avoid confusion.
Optionally, an enclosing `` element can be used if the description needs to contain HTML tags. | -| ``
Added cool feature
`
` | By default no change notes for the plugin are displayed before installation.
Using the `` element will cause a description of changes to be displayed before installation.
Contents should match the [``](plugin_configuration_file.md#idea-plugin__change-notes) element contents in the plugin's plugin.xml file to avoid confusion.
Optionally, an enclosing `` element can be used if the change notes need to contain HTML tags. | -| ``
dependency.plugin.id
`
` | Adding a plugin dependency in the `` element will cause asking a user about enabling the dependency plugin, if it is installed and disabled in the IDE. A plugin can specify multiple `` elements.
A plugin entry should include only the dependencies on other plugins that are defined by the [``](plugin_configuration_file.md#idea-plugin__depends) elements in the plugin's plugin.xml file. The `optional` and `config-file` attributes are ignored and shouldn't be specified. | + + + + + + + + + + + + + + + + + + + + + +
+ Element + + Effects & Requirements +
+ + <name> + My Plugin Name + </name> + + +

By default, the name of the plugin JAR/ZIP file is displayed before installation.

+

Using the <name> element displays the name of the plugin.

+

Contents should match the <name> element contents in the plugin's plugin.xml file to avoid confusion.

+
+ + <description> + My plugin is awesome + </description> + + +

By default, no description for the plugin is displayed before installation.

+

Using the <description> element will cause a description to be displayed before installation.

+

Contents should match the <description> element contents in the plugin's plugin.xml file to avoid confusion.

+

Optionally, an enclosing <![CDATA[ ]]> element can be used if the description needs to contain HTML tags.

+
+ + <change-notes> + Added cool feature + </change-notes> + + +

By default, no change notes for the plugin are displayed before installation.

+

Using the <change-notes> element will cause a description of changes to be displayed before installation.

+

Contents should match the <change-notes> element contents in the plugin's plugin.xml file to avoid confusion.

+

Optionally, an enclosing <![CDATA[ ]]> element can be used if the change notes need to contain HTML tags.

+
+ + <depends> + dependency.plugin.id + </depends> + + +

Adding a plugin dependency in the <depends> element will cause asking a user about enabling the dependency plugin, if it is installed and disabled in the IDE. A plugin can specify multiple <depends> elements.

+

A plugin entry should include only the dependencies on other plugins that are defined by the <depends> elements in the plugin's plugin.xml file. The optional and config-file attributes are ignored and shouldn't be specified.

+