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

snippets.md -> snippets.topic

Browse Source
This commit is contained in:
Yann Cébron 2025-03-19 10:46:36 +01:00
parent 702c10012a
commit 7eac25dc2d
85 changed files with 335 additions and 261 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
reference_guide/api_changes_list.md
View File

@ -69,7 +69,7 @@ IntelliJ API may be occasionally changed between releases, leading to existing p
See [](verifying_plugin_compatibility.md) on how to use Plugin Verifier and IDE inspections to check such problems.
<include from="snippets.md" element-id="subscribeNews"/>
<include from="snippets.topic" element-id="subscribeNews"/>
## Known Breaking Changes

2
reference_guide/api_changes_list_2019.md
View File

@ -63,7 +63,7 @@ NOTE: Entries not starting with code quotes (`name`) can be added to document no
<link-summary>List of known Breaking API Changes in 2019.*</link-summary>
<include from="snippets.md" element-id="apiChangesHeader"/>
<include from="snippets.topic" element-id="apiChangesHeader"/>
## 2019.3

4
reference_guide/api_changes_list_2020.md
View File

@ -63,9 +63,9 @@ NOTE: Entries not starting with code quotes (`name`) can be added to document no
<link-summary>List of known Breaking API Changes in 2020.*</link-summary>
<include from="snippets.md" element-id="apiChangesHeader"/>
<include from="snippets.topic" element-id="apiChangesHeader"/>
<include from="snippets.md" element-id="apiChangesJavaVersion"/>
<include from="snippets.topic" element-id="apiChangesJavaVersion"/>
## 2020.3

4
reference_guide/api_changes_list_2021.md
View File

@ -63,9 +63,9 @@ NOTE: Entries not starting with code quotes (`name`) can be added to document no
<link-summary>List of known Breaking API Changes in 2021.*</link-summary>
<include from="snippets.md" element-id="apiChangesHeader"/>
<include from="snippets.topic" element-id="apiChangesHeader"/>
<include from="snippets.md" element-id="apiChangesJavaVersion"/>
<include from="snippets.topic" element-id="apiChangesJavaVersion"/>
## 2021.3

6
reference_guide/api_changes_list_2022.md
View File

@ -63,11 +63,11 @@ NOTE: Entries not starting with code quotes (`name`) can be added to document no
<link-summary>List of known Breaking API Changes in 2022.*</link-summary>
<include from="snippets.md" element-id="apiChangesHeader"/>
<include from="snippets.topic" element-id="apiChangesHeader"/>
<include from="snippets.md" element-id="apiChangesJavaVersion"/>
<include from="snippets.topic" element-id="apiChangesJavaVersion"/>
<include from="snippets.md" element-id="gradlePluginVersion"/>
<include from="snippets.topic" element-id="gradlePluginVersion"/>
## 2022.3

6
reference_guide/api_changes_list_2023.md
View File

@ -63,11 +63,11 @@ NOTE: Entries not starting with code quotes (`name`) can be added to document no
<link-summary>List of known Breaking API Changes in 2023.*</link-summary>
<include from="snippets.md" element-id="apiChangesHeader"/>
<include from="snippets.topic" element-id="apiChangesHeader"/>
<include from="snippets.md" element-id="apiChangesJavaVersion"/>
<include from="snippets.topic" element-id="apiChangesJavaVersion"/>
<include from="snippets.md" element-id="gradlePluginVersion"/>
<include from="snippets.topic" element-id="gradlePluginVersion"/>
## 2023.3

6
reference_guide/api_changes_list_2024.md
View File

@ -63,11 +63,11 @@ NOTE: Entries not starting with code quotes (`name`) can be added to document no
<link-summary>List of known Breaking API Changes in 2024.*</link-summary>
<include from="snippets.md" element-id="apiChangesHeader"/>
<include from="snippets.topic" element-id="apiChangesHeader"/>
<include from="snippets.md" element-id="apiChangesJavaVersion"/>
<include from="snippets.topic" element-id="apiChangesJavaVersion"/>
<include from="snippets.md" element-id="gradlePluginVersion"/>
<include from="snippets.topic" element-id="gradlePluginVersion"/>
## 2024.3

6
reference_guide/api_changes_list_2025.md
View File

@ -63,11 +63,11 @@ NOTE: Entries not starting with code quotes (`name`) can be added to document no
<link-summary>List of known Breaking API Changes in 2025.*</link-summary>
<include from="snippets.md" element-id="apiChangesHeader"/>
<include from="snippets.topic" element-id="apiChangesHeader"/>
<include from="snippets.md" element-id="apiChangesJavaVersion"/>
<include from="snippets.topic" element-id="apiChangesJavaVersion"/>
<include from="snippets.md" element-id="gradlePluginVersion"/>
<include from="snippets.topic" element-id="gradlePluginVersion"/>
## 2025.2

152
topics/_shared/snippets.md
View File

@ -1,152 +0,0 @@
<!-- Copyright 2000-2025 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
# Snippets
{is-library="true"}
<snippet id="missingContent">
> If a topic you are interested in is not covered in the above sections, let us know via the **Was this page helpful?** feedback form below or [other channels](getting_help.topic#problems-with-the-guide).
>
> Please be specific about the topics and reasons for adding them, and leave your email in case we need more details. Thanks for your feedback!
>
{title="Something missing?" style="note"}
</snippet>
<snippet id="subscribeNews">
> [Subscribe to Marketplace Developer News](https://jb.gg/mp-updates) to receive news and announcements.
> Also follow [@platform.jetbrains.com](https://bsky.app/profile/platform.jetbrains.com) on Bluesky
> (or [JBPlatform](https://x.com/JBPlatform) on X)
> and visit
> [JetBrains Platform Blog](https://blog.jetbrains.com/platform/) and
> [JetBrains Marketplace on LinkedIn](https://www.linkedin.com/showcase/jetbrains-marketplace/).
>
{title="Staying up to date"}
</snippet>
<snippet id="pluginDevKitAvailability">
_Plugin DevKit_ plugin is bundled with IntelliJ IDEA until 2023.2.
> When using IntelliJ IDEA 2023.3 or later, the _Plugin DevKit_ plugin must be installed from JetBrains Marketplace ([Plugin Homepage](https://plugins.jetbrains.com/plugin/22851-plugin-devkit))
> as it is no longer bundled with the IDE.
>
{title="Plugin DevKit Availability" style="warning"}
</snippet>
<snippet id="jetbrainsIDE_TLDR">
<tldr>
**IDE**: [Homepage](https://www.jetbrains.com/%productID%), [Versions](https://www.jetbrains.com/%productID%/download/other.html)
**Plugins**: [JetBrains Marketplace](https://plugins.jetbrains.com/%marketplaceProductID%)
</tldr>
</snippet>
<snippet id="apiChangesHeader">
Please see [](verifying_plugin_compatibility.md) on how to use Plugin Verifier and IDE inspections to check such problems.
_Early Access Program_ (EAP) releases of upcoming versions are available [here](https://eap.jetbrains.com).
> Changes from API marked with `@Deprecated(forRemoval=true)` or any of [`ApiStatus`](%gh-java-annotations%/common/src/main/java/org/jetbrains/annotations/ApiStatus.java) `@Experimental`, `@ScheduledForRemoval`, or `@Internal` are not listed here, as incompatible changes are to be expected.
>
> For API annotated with `@ApiStatus.Internal`/`@IntellijInternalApi`, see [](api_internal.md) for more details and replacements.
>
{title="Non-listed changes" style="note"}
</snippet>
<snippet id="apiChangesJavaVersion">
> Java version must be set depending on the target platform version.
>
> **2024.2+**: Java 21
>
> **2022.3+**: Java 17
>
> See [](build_number_ranges.md#platformVersions) for details.
>
{title="IDE and Java Versions" style="note"}
</snippet>
<snippet id="gradlePluginVersion">
> The Gradle plugin must be chosen depending on the target [platform version](build_number_ranges.md#platformVersions).
>
> 2024.2+
> : **Requires** [](tools_intellij_platform_gradle_plugin.md)
>
> 2022.3+
> :
> **Recommended** [](tools_intellij_platform_gradle_plugin.md),<br/>
> **Requires** [](tools_gradle_intellij_plugin.md) version 1.10.1+ (current: %gradle-intellij-plugin-version%)
>
{style="warning" title="Gradle Plugin"}
</snippet>
<snippet id="ep_list_legend">
## Legend
> See also [](explore_api.md) for more information and strategies.
### Listeners
**Topic** searches for usages inside existing implementations of open-source IntelliJ Platform plugins via [IntelliJ Platform Explorer](https://jb.gg/ipe).
**Listener** links corresponding listener to implement.
See [](plugin_listeners.md) on how to register listeners.
### Extension Points
**Extension Point** searches for usages inside existing implementations of open-source IntelliJ Platform plugins via [IntelliJ Platform Explorer](https://jb.gg/ipe).
**Implementation** is the related Extension Point class.
See [](plugin_extensions.md) on how to declare extensions in your plugin.
### Tags
See [](verifying_plugin_compatibility.md) for overview of API status.
| Icon | Description | Details |
|-----------------------------------------------------------------|-------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ![Deprecated][deprecated] | Deprecated API | See code documentation for replacement. |
| ![Removal][removal] | Scheduled for Removal API | See code documentation for replacement. |
| ![Obsolete][obsolete] | Obsolete API | Do not use in new code.<p>See code documentation for replacement ([](verifying_plugin_compatibility.md#obsolete-api)).</p> |
| ![Experimental API][experimental]&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Experimental API | Annotated with [`@ApiStatus.Experimental`](%gh-java-annotations%/common/src/main/java/org/jetbrains/annotations/ApiStatus.java).<p>API might be altered or removed without prior notice.</p> |
| ![Internal API][internal] | Internal API | Annotated with [`@ApiStatus.Internal`](%gh-java-annotations%/common/src/main/java/org/jetbrains/annotations/ApiStatus.java).<p>Must not be used by third party plugins, see [](api_internal.md).</p> |
| ![Project-Level][project-level] | Project-Level<p>Extension Point/Topic</p> | <p>Can have [`Project`](%gh-ic%/platform/core-api/src/com/intellij/openapi/project/Project.java) as constructor parameter.</p><p>- Extension Point: Declared with `area="IDEA_PROJECT"`</p><p>- Listener: registered in [`<projectListeners>`](plugin_configuration_file.md#idea-plugin__projectListeners)</p> |
| ![Non-Dynamic][non-dynamic] | Non-Dynamic<p>Extension Point</p> | Installation/update of plugin requires IDE restart ([](dynamic_plugins.md)). |
| ![DumbAware][dumb-aware] | `DumbAware`<p>Extension Point</p> | Implementations marked with [`DumbAware`](%gh-ic%/platform/core-api/src/com/intellij/openapi/project/DumbAware.java) will be processed during [dumb mode](indexing_and_psi_stubs.md#dumb-mode). |
[deprecated]: https://img.shields.io/badge/-Deprecated-lightgrey?style=flat-square
[removal]: https://img.shields.io/badge/-Removal-red?style=flat-square
[obsolete]: https://img.shields.io/badge/-Obsolete-grey?style=flat-square
[experimental]: https://img.shields.io/badge/-Experimental-violet?style=flat-square
[internal]: https://img.shields.io/badge/-Internal-darkred?style=flat-square
[project-level]: https://img.shields.io/badge/-Project--Level-blue?style=flat-square
[non-dynamic]: https://img.shields.io/badge/-Non--Dynamic-orange?style=flat-square
[dumb-aware]: https://img.shields.io/badge/-DumbAware-darkgreen?style=flat-square
</snippet>
<snippet id="descriptorDocumentationProviderNote">
> Elements described on this page are available in [quick documentation](https://www.jetbrains.com/help/idea/viewing-reference-information.html#inline-quick-documentation) since IntelliJ IDEA 2025.1.
>
> The [Plugin DevKit](https://plugins.jetbrains.com/plugin/22851-plugin-devkit) plugin must be installed and enabled.
>
{style="note"}
</snippet>

226
topics/_shared/snippets.topic Normal file
View File

@ -0,0 +1,226 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<!-- Copyright 2000-2025 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
id="snippets" title="Snippets" is-library="true">
<snippet id="missingContent">
<note title="Something missing?">
<p>If a topic you are interested in is not covered in the above sections, let us know via the
<control>Was this page helpful?</control>
feedback form below or <a href="getting_help.topic" anchor="problems-with-the-guide">other channels</a>.
</p>
<p>Please be specific about the topics and reasons for adding them, and leave your email in case we need
more details. Thanks for your feedback!</p>
</note>
</snippet>
<snippet id="subscribeNews">
<tip title="Staying up to date">
<p><a href="https://jb.gg/mp-updates">Subscribe to Marketplace Developer News</a> to receive news and
announcements.
Also follow <a href="https://bsky.app/profile/platform.jetbrains.com">@platform.jetbrains.com</a> on
Bluesky
(or <a href="https://x.com/JBPlatform">JBPlatform</a> on X)
and visit
<a href="https://blog.jetbrains.com/platform/">JetBrains Platform Blog</a> and
<a href="https://www.linkedin.com/showcase/jetbrains-marketplace/">JetBrains Marketplace on LinkedIn</a>.
</p>
</tip>
</snippet>
<snippet id="pluginDevKitAvailability">
<p>
<emphasis>Plugin DevKit</emphasis>
plugin is bundled with IntelliJ IDEA until 2023.2.
</p>
<warning title="Plugin DevKit Availability">
<p>When using IntelliJ IDEA 2023.3 or later, the
<emphasis>Plugin DevKit</emphasis>
plugin must be installed from JetBrains Marketplace (<a
href="https://plugins.jetbrains.com/plugin/22851-plugin-devkit">Plugin Homepage</a>)
as it is no longer bundled with the IDE.
</p>
</warning>
</snippet>
<snippet id="jetbrainsIDE_TLDR">
<tldr>
<p>
<control>IDE</control>
: <a href="https://www.jetbrains.com/%productID%">Homepage</a>, <a
href="https://www.jetbrains.com/%productID%/download/other.html">Versions</a></p>
<p>
<control>Plugins</control>
: <a href="https://plugins.jetbrains.com/%marketplaceProductID%">JetBrains Marketplace</a></p>
</tldr>
</snippet>
<snippet id="apiChangesHeader">
<p>Please see <a href="verifying_plugin_compatibility.md"/> on how to use Plugin Verifier and IDE inspections
to check such problems.</p>
<p>
<emphasis>Early Access Program</emphasis>
(EAP) releases of upcoming versions are available <a href="https://eap.jetbrains.com">here</a>.
</p>
<note title="Non-listed changes">
<p>Changes from API marked with <code>@Deprecated(forRemoval=true)</code> or any of <a
href="%gh-java-annotations%/common/src/main/java/org/jetbrains/annotations/ApiStatus.java"><code>ApiStatus</code></a>
<code>@Experimental</code>, <code>@ScheduledForRemoval</code>, or <code>@Internal</code> are not listed
here, as incompatible changes are to be expected.</p>
<p>For API annotated with <code>@ApiStatus.Internal</code>/<code>@IntellijInternalApi</code>, see <a
href="api_internal.md"/> for more details and replacements.</p>
</note>
</snippet>
<snippet id="apiChangesJavaVersion">
<note title="IDE and Java Versions">
<p>Java version must be set depending on the target platform version.</p>
<p>
<control>2024.2+</control>
: Java 21
</p>
<p>
<control>2022.3+</control>
: Java 17
</p>
<p>See <a href="build_number_ranges.md" anchor="platformVersions"/> for details.</p>
</note>
</snippet>
<snippet id="gradlePluginVersion">
<warning title="Gradle Plugin">
<p>The Gradle plugin must be chosen depending on the target <a href="build_number_ranges.md"
anchor="platformVersions">platform
version</a>.</p>
<deflist>
<def id="gradlePluginVersion_2024.2">
<title>2024.2+</title>
<p>
<control>Requires</control>
<a href="tools_intellij_platform_gradle_plugin.md"/></p>
</def>
<def id="gradlePluginVersion_2022.3">
<title>2022.3+</title>
<p>
<control>Recommended</control>
<a href="tools_intellij_platform_gradle_plugin.md"/>,<br/>
<control>Requires</control>
<a href="tools_gradle_intellij_plugin.md"/> version 1.10.1+ (current:
%gradle-intellij-plugin-version%)
</p>
</def>
</deflist>
</warning>
</snippet>
<snippet id="ep_list_legend">
<chapter title="Legend" id="legend">
<tip>
<p>See also <a href="explore_api.md"/> for more information and strategies.</p>
</tip>
<chapter title="Listeners" id="listeners">
<p>
<control>Topic</control>
searches for usages inside existing implementations of open-source IntelliJ Platform plugins via <a
href="https://jb.gg/ipe">IntelliJ Platform Explorer</a>.
</p>
<p>
<control>Listener</control>
links corresponding listener to implement.
</p>
<p>See <a href="plugin_listeners.md"/> on how to register listeners.</p>
</chapter>
<chapter title="Extension Points" id="extension-points">
<p>
<control>Extension Point</control>
searches for usages inside existing implementations of open-source IntelliJ Platform plugins via <a
href="https://jb.gg/ipe">IntelliJ Platform Explorer</a>.
</p>
<p>
<control>Implementation</control>
is the related Extension Point class.
</p>
<p>See <a href="plugin_extensions.md"/> on how to declare extensions in your plugin.</p>
</chapter>
<chapter title="Tags" id="tags">
<p>See <a href="verifying_plugin_compatibility.md"/> for overview of API status.</p>
<table>
<tr>
<td>Icon</td>
<td>Description</td>
<td>Details</td>
</tr>
<tr>
<td><img src="https://img.shields.io/badge/-Deprecated-lightgrey?style=flat-square"
alt="Deprecated"/></td>
<td>Deprecated API</td>
<td>See code documentation for replacement.</td>
</tr>
<tr>
<td><img src="https://img.shields.io/badge/-Removal-red?style=flat-square" alt="Removal"/></td>
<td>Scheduled for Removal API</td>
<td>See code documentation for replacement.</td>
</tr>
<tr>
<td><img src="https://img.shields.io/badge/-Obsolete-grey?style=flat-square" alt="Obsolete"/>
</td>
<td>Obsolete API</td>
<td>Do not use in new code.<p>See code documentation for replacement (<a
href="verifying_plugin_compatibility.md" anchor="obsolete-api"/>).</p></td>
</tr>
<tr>
<td><img src="https://img.shields.io/badge/-Experimental-violet?style=flat-square"
alt="Experimental API"/>     
</td>
<td>Experimental API</td>
<td>Annotated with <a
href="%gh-java-annotations%/common/src/main/java/org/jetbrains/annotations/ApiStatus.java"><code>@ApiStatus.Experimental</code></a>.
<p>API might be altered or removed without prior notice.</p></td>
</tr>
<tr>
<td><img src="https://img.shields.io/badge/-Internal-darkred?style=flat-square"
alt="Internal API"/></td>
<td>Internal API</td>
<td>Annotated with <a
href="%gh-java-annotations%/common/src/main/java/org/jetbrains/annotations/ApiStatus.java"><code>@ApiStatus.Internal</code></a>.
<p>Must not be used by third party plugins, see <a href="api_internal.md"/>.</p></td>
</tr>
<tr>
<td><img src="https://img.shields.io/badge/-Project--Level-blue?style=flat-square"
alt="Project-Level"/></td>
<td>Project-Level<p>Extension Point/Topic</p></td>
<td><p>Can have <a
href="%gh-ic%/platform/core-api/src/com/intellij/openapi/project/Project.java"><code>Project</code></a>
as constructor parameter.</p>
<p>- Extension Point: Declared with <code>area=&quot;IDEA_PROJECT&quot;</code></p>
<p>- Listener: registered in <a href="plugin_configuration_file.md"
anchor="idea-plugin__projectListeners"><code>&lt;projectListeners&gt;</code></a>
</p></td>
</tr>
<tr>
<td><img src="https://img.shields.io/badge/-Non--Dynamic-orange?style=flat-square"
alt="Non-Dynamic"/></td>
<td>Non-Dynamic<p>Extension Point</p></td>
<td>Installation/update of plugin requires IDE restart (<a href="dynamic_plugins.md"/>).</td>
</tr>
<tr>
<td><img src="https://img.shields.io/badge/-DumbAware-darkgreen?style=flat-square"
alt="DumbAware"/></td>
<td><code>DumbAware</code>
<p>Extension Point</p></td>
<td>Implementations marked with <a
href="%gh-ic%/platform/core-api/src/com/intellij/openapi/project/DumbAware.java"><code>DumbAware</code></a>
will be processed during <a href="indexing_and_psi_stubs.md" anchor="dumb-mode">dumb
mode</a>.
</td>
</tr>
</table>
</chapter>
</chapter>
</snippet>
<snippet id="descriptorDocumentationProviderNote">
<note>
<p>Elements described on this page are available in <a
href="https://www.jetbrains.com/help/idea/viewing-reference-information.html#inline-quick-documentation">quick
documentation</a> since IntelliJ IDEA 2025.1.</p>
<p>The <a href="https://plugins.jetbrains.com/plugin/22851-plugin-devkit">Plugin DevKit</a> plugin must be
installed and enabled.</p>
</note>
</snippet>
</topic>

2
topics/appendix/api_notable/api_notable.md
View File

@ -4,7 +4,7 @@
<link-summary>List of Notable API Changes by version</link-summary>
<include from="snippets.md" element-id="subscribeNews"/>
<include from="snippets.topic" element-id="subscribeNews"/>
## Notable API Changes

2
topics/appendix/api_notable/api_notable_list_2022.md
View File

@ -8,7 +8,7 @@ _Early Access Program_ (EAP) releases of upcoming versions are available [here](
## 2022.3
<include from="snippets.md" element-id="gradlePluginVersion"/>
<include from="snippets.topic" element-id="gradlePluginVersion"/>
### IntelliJ Platform 2022.3

2
topics/appendix/api_notable/api_notable_list_2023.md
View File

@ -6,7 +6,7 @@
_Early Access Program_ (EAP) releases of upcoming versions are available [here](https://eap.jetbrains.com).
<include from="snippets.md" element-id="gradlePluginVersion"/>
<include from="snippets.topic" element-id="gradlePluginVersion"/>
## 2023.3

2
topics/appendix/api_notable/api_notable_list_2024.md
View File

@ -6,7 +6,7 @@
_Early Access Program_ (EAP) releases of upcoming versions are available [here](https://eap.jetbrains.com).
<include from="snippets.md" element-id="gradlePluginVersion"/>
<include from="snippets.topic" element-id="gradlePluginVersion"/>
## 2024.3

2
topics/appendix/api_notable/api_notable_list_2025.md
View File

@ -6,7 +6,7 @@
_Early Access Program_ (EAP) releases of upcoming versions are available [here](https://eap.jetbrains.com).
<include from="snippets.md" element-id="gradlePluginVersion"/>
<include from="snippets.topic" element-id="gradlePluginVersion"/>
## 2025.2

2
topics/appendix/glossary.md
View File

@ -177,4 +177,4 @@ See [](coroutine_read_actions.topic#coroutine-read-actions-api) for details.
<br/>&rarr;&nbsp;_Suspending Context_
<br/>&rarr;&nbsp;_Coroutine_
<include from="snippets.md" element-id="missingContent"/>
<include from="snippets.topic" element-id="missingContent"/>

2
topics/appendix/resources/android_plugin_extension_point_list.md
View File

@ -14,7 +14,7 @@
100 Extension Points and 32 Listeners for Android Plugin
<include from="snippets.md" element-id="ep_list_legend"/>
<include from="snippets.topic" element-id="ep_list_legend"/>
## Android Plugin

2
topics/appendix/resources/appcode_extension_point_list.md
View File

@ -18,7 +18,7 @@ See [](intellij_platform_extension_point_list.md) for IntelliJ Platform.
<include from="app_code.md" element-id="appCodeSunset"/>
<include from="snippets.md" element-id="ep_list_legend"/>
<include from="snippets.topic" element-id="ep_list_legend"/>
## AppCode

2
topics/appendix/resources/clion_extension_point_list.md
View File

@ -16,7 +16,7 @@
See [](intellij_platform_extension_point_list.md) for IntelliJ Platform.
<include from="snippets.md" element-id="ep_list_legend"/>
<include from="snippets.topic" element-id="ep_list_legend"/>
## CLion

2
topics/appendix/resources/data_grip_extension_point_list.md
View File

@ -16,7 +16,7 @@
See [](intellij_platform_extension_point_list.md) for IntelliJ Platform.
<include from="snippets.md" element-id="ep_list_legend"/>
<include from="snippets.topic" element-id="ep_list_legend"/>
## DataGrip

2
topics/appendix/resources/goland_extension_point_list.md
View File

@ -16,7 +16,7 @@
See [](intellij_platform_extension_point_list.md) for IntelliJ Platform.
<include from="snippets.md" element-id="ep_list_legend"/>
<include from="snippets.topic" element-id="ep_list_legend"/>
## GoLand

2
topics/appendix/resources/intellij_community_plugins_extension_point_list.md
View File

@ -14,7 +14,7 @@ EP List Directory:
592 Extension Points and 65 Listeners for IntelliJ Community Plugins
<include from="snippets.md" element-id="ep_list_legend"/>
<include from="snippets.topic" element-id="ep_list_legend"/>
## IntelliJ Community Plugins

2
topics/appendix/resources/intellij_platform_extension_point_list.md
View File

@ -20,7 +20,7 @@ and add in intellij_community_plugins_extension_point_list.md.
1121 Extension Points and 213 Listeners for IntelliJ Platform %ijPlatform%
<include from="snippets.md" element-id="ep_list_legend"/>
<include from="snippets.topic" element-id="ep_list_legend"/>
## IntelliJ Platform

2
topics/appendix/resources/learning_resources.md
View File

@ -4,7 +4,7 @@
<link-summary>Links to articles and webinars about plugin development.</link-summary>
<include from="snippets.md" element-id="subscribeNews"/>
<include from="snippets.topic" element-id="subscribeNews"/>
## Articles

2
topics/appendix/resources/oss_plugins_extension_point_list.md
View File

@ -16,7 +16,7 @@ Overview of Extension Points and Listeners for open source plugins available in
65 Extension Points and 10 Listeners
<include from="snippets.md" element-id="ep_list_legend"/>
<include from="snippets.topic" element-id="ep_list_legend"/>
## IntelliJ Open Source Plugins

2
topics/appendix/resources/php_extension_point_list.md
View File

@ -16,7 +16,7 @@
See [](intellij_platform_extension_point_list.md) for IntelliJ Platform.
<include from="snippets.md" element-id="ep_list_legend"/>
<include from="snippets.topic" element-id="ep_list_legend"/>
## PhpStorm

2
topics/appendix/resources/rider_extension_point_list.md
View File

@ -16,7 +16,7 @@
See [](intellij_platform_extension_point_list.md) for IntelliJ Platform.
<include from="snippets.md" element-id="ep_list_legend"/>
<include from="snippets.topic" element-id="ep_list_legend"/>
## Rider

2
topics/appendix/resources/rubymine_extension_point_list.md
View File

@ -16,7 +16,7 @@
See [](intellij_platform_extension_point_list.md) for IntelliJ Platform.
<include from="snippets.md" element-id="ep_list_legend"/>
<include from="snippets.topic" element-id="ep_list_legend"/>
## RubyMine

2
topics/appendix/resources/spring_extension_point_list.md
View File

@ -20,7 +20,7 @@
55 Extension Points and 5 Listeners for Spring API
<include from="snippets.md" element-id="ep_list_legend"/>
<include from="snippets.topic" element-id="ep_list_legend"/>
## Spring

2
topics/appendix/resources/webstorm_extension_point_list.md
View File

@ -21,7 +21,7 @@
See [](intellij_platform_extension_point_list.md) for IntelliJ Platform and [](oss_plugins_extension_point_list.md) for additional plugins.
<include from="snippets.md" element-id="ep_list_legend"/>
<include from="snippets.topic" element-id="ep_list_legend"/>
## WebStorm

2
topics/appendix/tools/gradle_intellij_plugin/tools_gradle_intellij_plugin.md
View File

@ -41,7 +41,7 @@ The plugin provides functionalities like:
## Usage
<include from="snippets.md" element-id="gradlePluginVersion"/>
<include from="snippets.topic" element-id="gradlePluginVersion"/>
To enable this plugin in your Gradle-based project, register the plugin in the Gradle build script's `plugins` section:

4
topics/appendix/tools/gradle_intellij_plugin/tools_gradle_intellij_plugin_faq.md
View File

@ -9,7 +9,7 @@
### How to target 2022.3 platform?
<include from="snippets.md" element-id="gradlePluginVersion"/>
<include from="snippets.topic" element-id="gradlePluginVersion"/>
### How to modify JVM arguments of runIde task?
@ -314,5 +314,5 @@ It is also possible to refer to the sandbox directory of another Gradle project
Please upgrade to Kotlin 1.9.0. See the [](using_kotlin.md#incremental-compilation) section if using Kotlin 1.8.20.
<include from="snippets.md" element-id="missingContent"/>
<include from="snippets.topic" element-id="missingContent"/>

2
topics/appendix/tools/intellij_platform_gradle_plugin/tools_intellij_platform_gradle_plugin.md
View File

@ -573,4 +573,4 @@ plugins {
</tabs>
<include from="snippets.md" element-id="missingContent"/>
<include from="snippets.topic" element-id="missingContent"/>

2
topics/appendix/tools/intellij_platform_gradle_plugin/tools_intellij_platform_gradle_plugin_dependencies_extension.md
View File

@ -399,4 +399,4 @@ The `javaCompiler()` helper is applied by default and refers to the tool version
- [](tools_intellij_platform_gradle_plugin_tasks.md#instrumentCode)
<include from="snippets.md" element-id="missingContent"/>
<include from="snippets.topic" element-id="missingContent"/>

2
topics/appendix/tools/intellij_platform_gradle_plugin/tools_intellij_platform_gradle_plugin_extension.md
View File

@ -1467,4 +1467,4 @@ See also:
| `select(configure)` | Retrieves matching IDEs using custom [`ProductReleasesValueSource.FilterParameters`](tools_intellij_platform_gradle_plugin_types.md#ProductReleasesValueSource-FilterParameters) filter parameters. |
<include from="snippets.md" element-id="missingContent"/>
<include from="snippets.topic" element-id="missingContent"/>

2
topics/appendix/tools/intellij_platform_gradle_plugin/tools_intellij_platform_gradle_plugin_faq.md
View File

@ -534,4 +534,4 @@ dependencies {
}
```
<include from="snippets.md" element-id="missingContent"/>
<include from="snippets.topic" element-id="missingContent"/>

2
topics/appendix/tools/intellij_platform_gradle_plugin/tools_intellij_platform_gradle_plugin_repositories_extension.md
View File

@ -198,4 +198,4 @@ See also:
</snippet>
<include from="snippets.md" element-id="missingContent"/>
<include from="snippets.topic" element-id="missingContent"/>

2
topics/appendix/tools/intellij_platform_gradle_plugin/tools_intellij_platform_gradle_plugin_task_awares.md
View File

@ -662,4 +662,4 @@ Default value
Interface used to describe tasks used for running tests, such as [`testIdeUi`](tools_intellij_platform_gradle_plugin_tasks.md#testIdeUi), [`testIdePerformance`](tools_intellij_platform_gradle_plugin_tasks.md#testIdePerformance), or [`prepareTest`](tools_intellij_platform_gradle_plugin_tasks.md#prepareTest) used for configuring `test` and keeping it immutable.
<include from="snippets.md" element-id="missingContent"/>
<include from="snippets.topic" element-id="missingContent"/>

2
topics/appendix/tools/intellij_platform_gradle_plugin/tools_intellij_platform_gradle_plugin_tasks.md
View File

@ -2157,7 +2157,7 @@ Default value
<include from="snippets.md" element-id="missingContent"/>
<include from="snippets.topic" element-id="missingContent"/>
[gradle-default-task]: https://docs.gradle.org/current/dsl/org.gradle.api.DefaultTask.html
[gradle-jar-task]: https://docs.gradle.org/current/dsl/org.gradle.jvm.tasks.Jar.html

2
topics/appendix/tools/intellij_platform_gradle_plugin/tools_intellij_platform_gradle_plugin_testing_extension.md
View File

@ -183,4 +183,4 @@ intellijPlatformTesting.runIde {
| `localPlugin(path)` | Adds a dependency on a local IntelliJ Platform plugin. Accepts path or a dependency on another module. |
| `robotServerPlugin(version)` | Adds a dependency on a Robot Server Plugin. |
<include from="snippets.md" element-id="missingContent"/>
<include from="snippets.topic" element-id="missingContent"/>

2
topics/appendix/tools/intellij_platform_gradle_plugin/tools_intellij_platform_gradle_plugin_types.md
View File

@ -259,4 +259,4 @@ See also:
- [Tasks: `verifyPlugin.verificationReportsFormats`](tools_intellij_platform_gradle_plugin_tasks.md#verifyPlugin-verificationReportsFormats)
<include from="snippets.md" element-id="missingContent"/>
<include from="snippets.topic" element-id="missingContent"/>

2
topics/basics/analyzing.md
View File

@ -14,4 +14,4 @@
* Structural Search
* [](controlling_highlighting.md)
<include from="snippets.md" element-id="missingContent"/>
<include from="snippets.topic" element-id="missingContent"/>

2
topics/basics/architectural_overview/threading/background_processes.md
View File

@ -213,4 +213,4 @@ Action disabling throwing `ProcessCanceledException`.
</tab>
</tabs>
<include from="snippets.md" element-id="missingContent"/>
<include from="snippets.topic" element-id="missingContent"/>

2
topics/basics/architectural_overview/threading/coroutines/coroutine_dispatchers.md
View File

@ -133,4 +133,4 @@ The code is executed as follows:
>
{style="warning"}
<include from="snippets.md" element-id="missingContent"/>
<include from="snippets.topic" element-id="missingContent"/>

2
topics/basics/architectural_overview/threading/coroutines/coroutine_dumps.md
View File

@ -109,4 +109,4 @@ Notable context elements:
Same problems can be found in regular thread dumps and blocking code, but coroutines suspend instead of blocking a thread, so it’s only possible to observe the last seen frame, which is usually enough.
<include from="snippets.md" element-id="missingContent"/>
<include from="snippets.topic" element-id="missingContent"/>

2
topics/basics/architectural_overview/threading/coroutines/coroutine_edt_and_locks.md
View File

@ -189,4 +189,4 @@ Avoid using them in plugin code.
Use it only as a temporal solution if it is hard to quickly rewrite code which checks for write intent lock.
<include from="snippets.md" element-id="missingContent"/>
<include from="snippets.topic" element-id="missingContent"/>

2
topics/basics/architectural_overview/threading/coroutines/coroutine_read_actions.topic
View File

@ -249,6 +249,6 @@
</chapter>
</chapter>
<include from="snippets.md" element-id="missingContent"/>
<include from="snippets.topic" element-id="missingContent"/>
</topic>

2
topics/basics/architectural_overview/threading/coroutines/coroutine_scopes.md
View File

@ -182,4 +182,4 @@ gantt
PluginAService leak : crit, 5, 9
```
<include from="snippets.md" element-id="missingContent"/>
<include from="snippets.topic" element-id="missingContent"/>

2
topics/basics/architectural_overview/threading/coroutines/kotlin_coroutines.md
View File

@ -48,4 +48,4 @@ It will help understand coroutines and become fluent with available APIs:
- [Coroutines in Practice](https://www.youtube.com/watch?v=a3agLJQ6vt8)
- [Asynchronous Data Streams with Flow](https://www.youtube.com/watch?v=tYcqn48SMT8)
<include from="snippets.md" element-id="missingContent"/>
<include from="snippets.topic" element-id="missingContent"/>

2
topics/basics/architectural_overview/threading/coroutines/launching_coroutines.md
View File

@ -70,4 +70,4 @@ In a standard coroutine-based application, the bridge between the regular blocki
In the IntelliJ Platform, a similar purpose is achieved by the [`runBlockingCancellable`](%gh-ic%/platform/core-api/src/com/intellij/openapi/progress/coroutines.kt) function.
In addition to the same semantics as `runBlocking`, the action gets canceled when the current progress indicator or the current job is canceled.
<include from="snippets.md" element-id="missingContent"/>
<include from="snippets.topic" element-id="missingContent"/>

2
topics/basics/architectural_overview/threading/execution_contexts.topic
View File

@ -398,7 +398,7 @@
</tab>
</tabs>
<include from="snippets.md" element-id="missingContent"/>
<include from="snippets.topic" element-id="missingContent"/>
</chapter>
</chapter>

2
topics/basics/architectural_overview/threading/threading_model.md
View File

@ -636,4 +636,4 @@ This behavior wasn't enabled in production, and the planned locking mechanism ha
It is planned to allow for acquiring write lock from any thread, even without a write intent lock.
Write intent lock will be still available and will allow performing read sessions finished with data writing.
<include from="snippets.md" element-id="missingContent"/>
<include from="snippets.topic" element-id="missingContent"/>

2
topics/basics/getting_started/build_number_ranges.md
View File

@ -109,7 +109,7 @@ The IDE will automatically install only the corresponding compatible build.
Note that there is no `YY0`.
In the `YYYY.R` versioning scheme, the `R` part starts at 1.
<include from="snippets.md" element-id="gradlePluginVersion"/>
<include from="snippets.topic" element-id="gradlePluginVersion"/>
_Early Access Program_ (EAP) releases of upcoming versions are available [here](https://eap.jetbrains.com).

4
topics/basics/getting_started/plugin/developing_plugins.md
View File

@ -18,12 +18,12 @@ a dedicated Gradle plugin:
[](tools_intellij_platform_gradle_plugin.md) or
[](tools_gradle_intellij_plugin.md).
<include from="snippets.md" element-id="gradlePluginVersion"/>
<include from="snippets.topic" element-id="gradlePluginVersion"/>
The IntelliJ IDEA Ultimate and Community editions provide the necessary plugins to support Gradle-based plugin development: _Gradle_ and _Plugin DevKit_.
To verify these plugins are installed and enabled, see the help section about [Managing Plugins](https://www.jetbrains.com/help/idea/managing-plugins.html).
<include from="snippets.md" element-id="pluginDevKitAvailability"/>
<include from="snippets.topic" element-id="pluginDevKitAvailability"/>
The Gradle plugin manages the dependencies of a plugin project – both the base IDE and other [plugin dependencies](plugin_dependencies.md).
It provides tasks to run the IDE with your plugin and to package and [publish](publishing_plugin.md#publishing-plugin-with-gradle) your plugin to the [JetBrains Marketplace](https://plugins.jetbrains.com).

4
topics/basics/getting_started/theme/setting_up_theme_environment.md
View File

@ -6,7 +6,7 @@
<procedure title="Preliminary Steps">
<include from="snippets.md" element-id="pluginDevKitAvailability"/>
<include from="snippets.topic" element-id="pluginDevKitAvailability"/>
Use the following checklist to ensure that you are ready to develop your custom theme:
@ -42,7 +42,7 @@ If it is required to style components used only in a specific IDE like _IntelliJ
The first step of configuring a theme plugin SDK is adding the JDK.
<include from="snippets.md" element-id="apiChangesJavaVersion"/>
<include from="snippets.topic" element-id="apiChangesJavaVersion"/>
<procedure title="Add JDK" id="add-jdk">

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

@ -35,7 +35,7 @@ See also [](marketing.md) about widgets and badges.
Deprecated elements are omitted in the list below.
<include from="snippets.md" element-id="descriptorDocumentationProviderNote"/>
<include from="snippets.topic" element-id="descriptorDocumentationProviderNote"/>
[//]: # (GENERATED CONTENT START)
@ -589,7 +589,7 @@ Attributes
`order`.
<br/>
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"`.
- `order` _(optional)_<br/>
Allows for ordering the extension relative to other instances of the same extension point.
@ -613,7 +613,7 @@ Attributes
- `mac`
- `unix`
- `windows`
For example, `os="windows"` registers the extension on Windows only.
### `extensionPoints`
@ -691,12 +691,12 @@ Attributes
The scope in which the [extension](plugin_extensions.md) is
instantiated.
Allowed values:
- `IDEA_APPLICATION` _(default)_
- `IDEA_PROJECT`
- `IDEA_MODULE` (**deprecated**)
**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
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
of `com.example.ParentType`, and the type provided in a `someClass` element to be an instance
of `java.lang.Comparable`:
```xml
<extensionPoint
name="myExtension"
@ -752,18 +752,18 @@ Example
implements="java.lang.Comparable"/>
</extensionPoint>
```
When using the above extension point, an implementation could be registered as follows:
```xml
<myExtension ...
myClass="com.example.MyCustomType">
<someClass>com.example.MyComparable</someClass>
</myExtension>
```
where:
- `com.example.MyCustomType` must be a subtype of `com.example.ParentType`
- `com.example.MyComparable` must be a subtype of `java.lang.Comparable`
@ -1276,7 +1276,7 @@ Attributes
- `ref` _(**required**)_<br/>
The ID of the action to add to a group.
- `id` _(optional)_<br/>
**_Deprecated_**: Use `ref` instead.
**_Deprecated_**: Use `ref` instead.
The ID of the action to add to a group.

2
topics/basics/settings.md
View File

@ -20,4 +20,4 @@ Settings are but one application of the IntelliJ Platform [Persistence Model](pe
* [](settings_groups.md) for information about creating custom Settings groups and parent-child relationships.
* [](settings_tutorial.md) for step-by-step instructions for creating a simple set of custom Settings.
<include from="snippets.md" element-id="missingContent"/>
<include from="snippets.topic" element-id="missingContent"/>

2
topics/basics/testing_plugins/testing_faq.md
View File

@ -246,4 +246,4 @@ Indexing is now run asynchronously in a background thread.
Use [`IndexingTestUtil.waitUntilIndexesAreReady()/suspendUntilIndexesAreReady()`](%gh-ic%/platform/testFramework/src/com/intellij/testFramework/IndexingTestUtil.kt)
to wait for fully populated indexes.
<include from="snippets.md" element-id="missingContent"/>
<include from="snippets.topic" element-id="missingContent"/>

2
topics/basics/testing_plugins/testing_plugins.md
View File

@ -51,4 +51,4 @@ Check out [](integration_tests_intro.md) tutorial that guides through setup proc
* [](testing_highlighting.md)
* [](testing_faq.md)
<include from="snippets.md" element-id="missingContent"/>
<include from="snippets.topic" element-id="missingContent"/>

2
topics/intro/code_samples.md
View File

@ -21,7 +21,7 @@ Additionally, the [Working with Gradle in IntelliJ IDEA](https://youtu.be/6V6G3R
Make sure plugins _Git_, _Gradle_, and _Plugin DevKit_ are enabled.
<include from="snippets.md" element-id="pluginDevKitAvailability"/>
<include from="snippets.topic" element-id="pluginDevKitAvailability"/>
Clone the [intellij-sdk-code-samples](https://github.com/JetBrains/intellij-sdk-code-samples) GitHub repository via <control>Git | Clone...</control>.
After successful cloning, the IDE suggests opening the project.

2
topics/intro/content_updates.md
View File

@ -8,7 +8,7 @@ This page lists notable additions and updates to the SDK documentation and [](co
See [GitHub Changelog](https://github.com/JetBrains/intellij-sdk-docs/commits/main) ([RSS](https://github.com/JetBrains/intellij-sdk-docs/commits/main.atom)) for a detailed changelog.
<include from="snippets.md" element-id="subscribeNews"/>
<include from="snippets.topic" element-id="subscribeNews"/>
## 2025

2
topics/products/appcode/app_code.md
View File

@ -8,7 +8,7 @@
<var name="productID" value="objc"/>
<var name="marketplaceProductID" value="appcode"/>
<include from="snippets.md" element-id="jetbrainsIDE_TLDR"/>
<include from="snippets.topic" element-id="jetbrainsIDE_TLDR"/>
Plugin projects targeting [AppCode](https://www.jetbrains.com/objc/) can be developed using IntelliJ IDEA with the [](tools_gradle_intellij_plugin.md).

2
topics/products/clion/clion.md
View File

@ -6,7 +6,7 @@
<var name="productID" value="clion"/>
<var name="marketplaceProductID" value="clion"/>
<include from="snippets.md" element-id="jetbrainsIDE_TLDR"/>
<include from="snippets.topic" element-id="jetbrainsIDE_TLDR"/>
[CLion](https://www.jetbrains.com/clion/) is an IntelliJ Platform-based product.
Plugin projects for CLion can be developed using [IntelliJ IDEA](idea.md).

2
topics/products/datagrip/data_grip.md
View File

@ -6,7 +6,7 @@
<var name="productID" value="datagrip"/>
<var name="marketplaceProductID" value="dbe"/>
<include from="snippets.md" element-id="jetbrainsIDE_TLDR"/>
<include from="snippets.topic" element-id="jetbrainsIDE_TLDR"/>
[DataGrip](https://www.jetbrains.com/datagrip/) is an IntelliJ Platform-based product.
Plugin projects targeting DataGrip can be developed using [IntelliJ IDEA](idea.md).

2
topics/products/goland/goland.md
View File

@ -6,7 +6,7 @@
<var name="productID" value="go"/>
<var name="marketplaceProductID" value="go"/>
<include from="snippets.md" element-id="jetbrainsIDE_TLDR"/>
<include from="snippets.topic" element-id="jetbrainsIDE_TLDR"/>
[GoLand](https://www.jetbrains.com/go/) is an IntelliJ Platform-based product.
Plugin projects for GoLand can be developed using [IntelliJ IDEA](idea.md).

2
topics/products/idea/idea.md
View File

@ -6,7 +6,7 @@
<var name="productID" value="idea"/>
<var name="marketplaceProductID" value="idea_ce"/>
<include from="snippets.md" element-id="jetbrainsIDE_TLDR"/>
<include from="snippets.topic" element-id="jetbrainsIDE_TLDR"/>
[IntelliJ IDEA](https://www.jetbrains.com/idea/) is available in two editions: IntelliJ Community Edition and IntelliJ IDEA Ultimate.
<snippet id="idea_editions">

2
topics/products/idea/idea_ultimate.md
View File

@ -8,7 +8,7 @@
<var name="productID" value="idea"/>
<var name="marketplaceProductID" value="idea"/>
<include from="snippets.md" element-id="jetbrainsIDE_TLDR"/>
<include from="snippets.topic" element-id="jetbrainsIDE_TLDR"/>
IntelliJ IDEA Ultimate comes with a number of additional features and bundled plugins.
<include from="idea.md" element-id="idea_editions"/>

2
topics/products/phpstorm/phpstorm.md
View File

@ -6,7 +6,7 @@
<var name="productID" value="phpstorm"/>
<var name="marketplaceProductID" value="phpstorm"/>
<include from="snippets.md" element-id="jetbrainsIDE_TLDR"/>
<include from="snippets.topic" element-id="jetbrainsIDE_TLDR"/>
[PhpStorm](https://www.jetbrains.com/phpstorm/) is an IntelliJ Platform-based product.
Plugin projects targeting PhpStorm can be developed using [IntelliJ IDEA](idea.md).

2
topics/products/pycharm/pycharm.md
View File

@ -6,7 +6,7 @@
<var name="productID" value="pycharm"/>
<var name="marketplaceProductID" value="pycharm_ce"/>
<include from="snippets.md" element-id="jetbrainsIDE_TLDR"/>
<include from="snippets.topic" element-id="jetbrainsIDE_TLDR"/>
[PyCharm](https://www.jetbrains.com/pycharm/) is an IntelliJ Platform-based product.
Plugin projects for PyCharm can be developed using [IntelliJ IDEA](idea.md).

2
topics/products/rider/rider.md
View File

@ -6,7 +6,7 @@
<var name="productID" value="rider"/>
<var name="marketplaceProductID" value="rider"/>
<include from="snippets.md" element-id="jetbrainsIDE_TLDR"/>
<include from="snippets.topic" element-id="jetbrainsIDE_TLDR"/>
Rider plugins are generally used to expose the functionality of a [ReSharper](https://www.jetbrains.com/resharper/) plugin.
[Rider](https://www.jetbrains.com/rider/) uses the IntelliJ Platform somewhat [differently](intellij_platform.md#rider) than other Platform-based based IDEs.

2
topics/products/rubymine/rubymine.md
View File

@ -6,7 +6,7 @@
<var name="productID" value="ruby"/>
<var name="marketplaceProductID" value="ruby"/>
<include from="snippets.md" element-id="jetbrainsIDE_TLDR"/>
<include from="snippets.topic" element-id="jetbrainsIDE_TLDR"/>
[RubyMine](https://www.jetbrains.com/ruby/) is an IntelliJ Platform-based product.
Plugin projects for RubyMine can be developed using [IntelliJ IDEA](idea.md).

2
topics/products/webstorm/webstorm.md
View File

@ -6,7 +6,7 @@
<var name="productID" value="webstorm"/>
<var name="marketplaceProductID" value="webstorm"/>
<include from="snippets.md" element-id="jetbrainsIDE_TLDR"/>
<include from="snippets.topic" element-id="jetbrainsIDE_TLDR"/>
[WebStorm](https://www.jetbrains.com/webstorm/) is an IntelliJ Platform-based product.
Plugin projects for WebStorm can be developed using [IntelliJ IDEA](idea.md).

2
topics/reference_guide/custom_language_support.md
View File

@ -69,4 +69,4 @@ The webinar [How We Built Comma, the Raku IDE, on the IntelliJ Platform](https:/
See [](language_server_protocol.md) for supporting language servers.
<include from="snippets.md" element-id="missingContent"/>
<include from="snippets.topic" element-id="missingContent"/>

2
topics/reference_guide/custom_language_support/additional_minor_features.md
View File

@ -264,4 +264,4 @@ a variable declaration.
- [`DeclarationMover`](%gh-ic%/java/java-impl/src/com/intellij/codeInsight/editorActions/moveUpDown/DeclarationMover.java)
<include from="snippets.md" element-id="missingContent"/>
<include from="snippets.topic" element-id="missingContent"/>

2
topics/reference_guide/custom_language_support/language_server_protocol.md
View File

@ -288,4 +288,4 @@ The following open-source plugins make use of LSP:
Explore third-party plugins using LSP on [IntelliJ Platform Explorer](https://jb.gg/ipe?extensions=com.intellij.platform.lsp.serverSupportProvider).
<include from="snippets.md" element-id="missingContent"/>
<include from="snippets.topic" element-id="missingContent"/>

2
topics/reference_guide/embedded_browser_jcef.md
View File

@ -320,4 +320,4 @@ To open DevTools in a separate window, call `JBCefBrowser.openDevtools()`.
- [Excalidraw Integration](https://github.com/bric3/excalidraw-jetbrains-plugin) plugin
- [Creating IntelliJ plugin with WebView](https://medium.com/virtuslab/creating-intellij-plugin-with-webview-3b27c3f87aea) blog post
<include from="snippets.md" element-id="missingContent"/>
<include from="snippets.topic" element-id="missingContent"/>

2
topics/reference_guide/localization/internationalization.md
View File

@ -408,4 +408,4 @@ The IntelliJ Platform provides some utils to display them properly.
- [`Formats.formatFileSize()`](%gh-ic%/platform/util/base/src/com/intellij/openapi/util/text/Formats.java) (the units are not localized and the default JVM locale is used instead of the [IDE's locale](providing_translations.md#getting-the-current-locale-programmatically))
<include from="snippets.md" element-id="missingContent"/>
<include from="snippets.topic" element-id="missingContent"/>

2
topics/reference_guide/localization/providing_translations.md
View File

@ -172,4 +172,4 @@ To find an example <path>messages/MyBundle.properties</path> message bundle for
5. <path>messages/MyBundle_zh.properties</path> (language level)
6. <path>messages/MyBundle.properties</path> (default)
<include from="snippets.md" element-id="missingContent"/>
<include from="snippets.topic" element-id="missingContent"/>

2
topics/tutorials/build_system/configuring_plugin_project.md
View File

@ -9,7 +9,7 @@ For more advanced options, see the full [](tools_gradle_intellij_plugin.md) refe
<include from="creating_plugin_project.md" element-id="gradle1xOnly"/>
<include from="snippets.md" element-id="gradlePluginVersion"/>
<include from="snippets.topic" element-id="gradlePluginVersion"/>
## Keep Up To Date

6
topics/tutorials/build_system/creating_plugin_project.md
View File

@ -19,11 +19,11 @@ This documentation page describes a Gradle-based plugin project generated with t
## Creating a Plugin with New Project Wizard
<include from="snippets.md" element-id="gradlePluginVersion"/>
<include from="snippets.topic" element-id="gradlePluginVersion"/>
<procedure title="Create IDE Plugin" id="create-ide-plugin">
<include from="snippets.md" element-id="pluginDevKitAvailability"/>
<include from="snippets.topic" element-id="pluginDevKitAvailability"/>
Launch the <control>New Project</control> wizard via the <ui-path>File | New | Project...</ui-path> action and provide the following information:
1. Select the <control>IDE Plugin</control> generator type from the list on the left.
@ -49,7 +49,7 @@ Launch the <control>New Project</control> wizard via the <ui-path>File | New | P
7. Select <control>JDK</control> 17.
This JDK will be the default JRE used to run Gradle, and the JDK version used to compile the plugin sources.
<include from="snippets.md" element-id="apiChangesJavaVersion"/>
<include from="snippets.topic" element-id="apiChangesJavaVersion"/>
8. After providing all the information, click the <control>Create</control> button to generate the project.

2
topics/tutorials/custom_language_support/custom_language_support_tutorial.md
View File

@ -46,7 +46,7 @@ This is a step-by-step tutorial, and it requires completing each step, in order:
* [](find_usages_provider.md)
* {columns="2"}
<include from="snippets.md" element-id="missingContent"/>
<include from="snippets.topic" element-id="missingContent"/>
<seealso style="cards">
<category ref="related">

2
topics/tutorials/custom_language_support/prerequisites.md
View File

@ -22,7 +22,7 @@ Download the IntelliJ IDEA Community Edition source files as described in the In
Make sure that the _Plugin DevKit_ and _Gradle_ plugins are enabled.
<include from="snippets.md" element-id="pluginDevKitAvailability"/>
<include from="snippets.topic" element-id="pluginDevKitAvailability"/>
Install and enable [Grammar-Kit](https://plugins.jetbrains.com/plugin/6606-grammar-kit) and [PsiViewer](https://plugins.jetbrains.com/plugin/227-psiviewer) (optionally) plugins.

4
topics/tutorials/live_templates/live_templates_configuration_file.md
View File

@ -10,7 +10,7 @@ This page lists and describes all the elements and attributes used in live templ
## Configuration Structure Overview
<include from="snippets.md" element-id="descriptorDocumentationProviderNote"/>
<include from="snippets.topic" element-id="descriptorDocumentationProviderNote"/>
[//]: # (GENERATED CONTENT START)
@ -246,4 +246,4 @@ Attributes
[//]: # (GENERATED CONTENT END)
<include from="snippets.md" element-id="missingContent"/>
<include from="snippets.topic" element-id="missingContent"/>

2
topics/user_interface_components/ui_faq.md
View File

@ -80,4 +80,4 @@ If you use the insets elsewhere, you need to manually call `JBInsets.update()` i
Use [`IconUtil`](%gh-ic%/platform/core-ui/src/util/IconUtil.kt) to scale/colorize/darken/desaturate existing [icons](icons.md) as needed.
<include from="snippets.md" element-id="missingContent"/>
<include from="snippets.topic" element-id="missingContent"/>

2
topics/user_interface_components/user_interface_components.md
View File

@ -49,4 +49,4 @@ The following components are particularly noteworthy:
See also [](ui_faq.md).
<include from="snippets.md" element-id="missingContent"/>
<include from="snippets.topic" element-id="missingContent"/>