From 6c67124f0d1cc8b92be8925b59bed8176e33c69e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Yann=20C=C3=A9bron?= <yann.cebron@jetbrains.com>
Date: Mon, 17 Jun 2024 11:34:16 +0200
Subject: [PATCH] plugin_configuration_file.md: extract references to tldr
 block

---
 .../plugin_configuration_file.md              | 131 +++++++++++++-----
 1 file changed, 100 insertions(+), 31 deletions(-)

diff --git a/topics/basics/plugin_structure/plugin_configuration_file.md b/topics/basics/plugin_structure/plugin_configuration_file.md
index cdc3a75f1..ca9d0ca5f 100644
--- a/topics/basics/plugin_structure/plugin_configuration_file.md
+++ b/topics/basics/plugin_structure/plugin_configuration_file.md
@@ -152,10 +152,14 @@ Example
 ### `name`
 {#idea-plugin__name}
 
-The user-visible plugin display name (Title Case).
+<tldr>
 
 **Reference:** [JetBrains Marketplace: Plugin Name](https://plugins.jetbrains.com/docs/marketplace/plugin-overview-page.html#plugin-name)
 
+</tldr>
+
+The user-visible plugin display name (Title Case).
+
 {style="narrow"}
 Required
 : **yes**; ignored in [additional config file](#additional-plugin-configuration-files)
@@ -169,11 +173,15 @@ Example
 ### `version`
 {#idea-plugin__version}
 
-The plugin version displayed in the <control>Plugins</control> settings dialog and in the JetBrains Marketplace plugin page.
-Plugins uploaded to the JetBrains Marketplace must follow semantic versioning.
+<tldr>
 
 **Reference:** [JetBrains Marketplace: Semantic Versioning](https://plugins.jetbrains.com/docs/marketplace/semver.html)
 
+</tldr>
+
+The plugin version displayed in the <control>Plugins</control> settings dialog and in the JetBrains Marketplace plugin page.
+Plugins uploaded to the JetBrains Marketplace must follow semantic versioning.
+
 {style="narrow"}
 Required
 : **yes**; ignored in [additional config file](#additional-plugin-configuration-files)<br/>
@@ -188,10 +196,14 @@ Example
 ### `product-descriptor`
 {#idea-plugin__product-descriptor}
 
-[Paid](https://plugins.jetbrains.com/build-and-market) or [Freemium](https://plugins.jetbrains.com/docs/marketplace/freemium.html) plugin descriptor.
+<tldr>
 
 **Reference:** [JetBrains Marketplace: How to add required parameters for paid plugins](https://plugins.jetbrains.com/docs/marketplace/add-required-parameters.html)
 
+</tldr>
+
+[Paid](https://plugins.jetbrains.com/build-and-market) or [Freemium](https://plugins.jetbrains.com/docs/marketplace/freemium.html) plugin descriptor.
+
 {style="narrow"}
 Required
 : only for paid or freemium plugins; ignored in [additional config file](#additional-plugin-configuration-files)<br/>
@@ -213,10 +225,14 @@ Attributes
 ### `idea-version`
 {#idea-plugin__idea-version}
 
-The plugin's range of compatible IntelliJ-based IDE versions.
+<tldr>
 
 **Reference:** [](build_number_ranges.md)
 
+</tldr>
+
+The plugin's range of compatible IntelliJ-based IDE versions.
+
 {style="narrow"}
 Required
 : **yes**; ignored in [additional config file](#additional-plugin-configuration-files)<br/>
@@ -245,10 +261,13 @@ Examples
 ### `vendor`
 {#idea-plugin__vendor}
 
-The vendor name or organization ID (if created) in the <control>Plugins</control> settings dialog and in the JetBrains Marketplace plugin page.
+<tldr>
 
-**Reference:** [JetBrains Marketplace: Contacts and Resources
-](https://plugins.jetbrains.com/docs/marketplace/plugin-overview-page.html#contacts-and-resources)
+**Reference:** [JetBrains Marketplace: Contacts and Resources](https://plugins.jetbrains.com/docs/marketplace/plugin-overview-page.html#contacts-and-resources)
+
+</tldr>
+
+The vendor name or organization ID (if created) in the <control>Plugins</control> settings dialog and in the JetBrains Marketplace plugin page.
 
 {style="narrow"}
 Required
@@ -279,12 +298,16 @@ Examples
 ### `description`
 {#idea-plugin__description}
 
+<tldr>
+
+**Reference:** [JetBrains Marketplace: Plugin Description](https://plugins.jetbrains.com/docs/marketplace/plugin-overview-page.html#plugin-description)
+
+</tldr>
+
 The plugin description displayed on the JetBrains Marketplace plugin page and in the <control>Plugins</control> settings dialog.
 
 Simple HTML elements, like text formatting, paragraphs, lists, etc., are allowed and must be wrapped into `<![CDATA[` ... `]]>` section.
 
-**Reference:** [JetBrains Marketplace: Plugin Description](https://plugins.jetbrains.com/docs/marketplace/plugin-overview-page.html#plugin-description)
-
 {style="narrow"}
 Required
 : **yes**; ignored in [additional config file](#additional-plugin-configuration-files)<br/>
@@ -308,13 +331,17 @@ Example
 ### `change-notes`
 {#idea-plugin__change-notes}
 
+<tldr>
+
+**Reference:** [JetBrains Marketplace: Change Notes](https://plugins.jetbrains.com/docs/marketplace/plugin-overview-page.html#change-notes)
+
+</tldr>
+
 A short summary of new features, bugfixes, and changes provided with the latest plugin version.
 Change notes are displayed on the JetBrains Marketplace plugin page and in the <control>Plugins</control> settings dialog.
 
 Simple HTML elements, like text formatting, paragraphs, lists, etc., are allowed and must be wrapped into `<![CDATA[` ... `]]>` section.
 
-**Reference:** [JetBrains Marketplace: Change Notes](https://plugins.jetbrains.com/docs/marketplace/plugin-overview-page.html#change-notes)
-
 {style="narrow"}
 Required
 : no; ignored in [additional config file](#additional-plugin-configuration-files)<br/>
@@ -341,13 +368,15 @@ Example
 ### `depends`
 {#idea-plugin__depends}
 
+<tldr>
+
+**Reference:** [](plugin_dependencies.md), [](plugin_compatibility.md#modules-specific-to-functionality)
+
+</tldr>
+
 Specifies a dependency on another plugin or a module of an IntelliJ Platform-based product.
 A single [`<idea-plugin>`](#idea-plugin) element can contain multiple `<depends>` elements.
 
-**References:**
-- [](plugin_dependencies.md)
-- [](plugin_compatibility.md#modules-specific-to-functionality)
-
 {style="narrow"}
 Required
 : no; in most cases dependency on the [platform](plugin_compatibility.md#modules-available-in-all-products) module is needed
@@ -399,10 +428,14 @@ Examples
 
 <primary-label ref="2020.2"/>
 
-Declares incompatibility with a provided module.
+<tldr>
 
 **Reference:** [](plugin_compatibility.md#declaring-incompatibility-with-module)
 
+</tldr>
+
+Declares incompatibility with a provided module.
+
 {style="narrow"}
 Required
 : no; ignored in [additional config file](#additional-plugin-configuration-files)
@@ -434,10 +467,14 @@ Example
 ### `applicationListeners`
 {#idea-plugin__applicationListeners}
 
-Defines the application-level listeners.
+<tldr>
 
 **Reference:** [](plugin_listeners.md#defining-application-level-listeners)
 
+</tldr>
+
+Defines the application-level listeners.
+
 {style="narrow"}
 Required
 : no
@@ -448,9 +485,13 @@ Children
 ### `projectListeners`
 {#idea-plugin__projectListeners}
 
-Defines the project-level listeners.
+<tldr>
 
-**Reference:** [](plugin_listeners.md#defining-project-level-listeners)
+**Reference:** [](plugin_listeners.md#defining-application-level-listeners)
+
+</tldr>
+
+Defines the project-level listeners.
 
 {style="narrow"}
 Required
@@ -462,11 +503,15 @@ Children
 #### `listener`
 {#idea-plugin__listeners__listener}
 
-Defines a single application or project-level listener.
-A single [`<applicationListeners>`](#idea-plugin__applicationListeners) or [`<projectListeners>`](#idea-plugin__projectListeners) can contain multiple `<listener>` elements.
+<tldr>
 
 **Reference:** [](plugin_listeners.md)
 
+</tldr>
+
+Defines a single application or project-level listener.
+A single [`<applicationListeners>`](#idea-plugin__applicationListeners) or [`<projectListeners>`](#idea-plugin__projectListeners) can contain multiple `<listener>` elements.
+
 {style="narrow"}
 Required
 : no
@@ -505,10 +550,14 @@ Example
 ### `actions`
 {#idea-plugin__actions}
 
-Defines the plugin actions.
+<tldr>
 
 **Reference:** [](basic_action_system.md)
 
+</tldr>
+
+Defines the plugin actions.
+
 {style="narrow"}
 Required
 : no
@@ -539,11 +588,15 @@ Example
 #### `action`
 {#idea-plugin__actions__action}
 
-A single action entry of the [`<actions>`](#idea-plugin__actions) implemented by the plugin.
-A single [`<actions>`](#idea-plugin__actions) element can contain multiple `<action>` elements.
+<tldr>
 
 **Reference:** [](basic_action_system.md#registering-actions-in-pluginxml)
 
+</tldr>
+
+A single action entry of the [`<actions>`](#idea-plugin__actions) implemented by the plugin.
+A single [`<actions>`](#idea-plugin__actions) element can contain multiple `<action>` elements.
+
 {style="narrow"}
 Required
 : no
@@ -821,12 +874,16 @@ Example
 #### `group`
 {#idea-plugin__actions__group}
 
+<tldr>
+
+**Reference:** [](basic_action_system.md#grouping-actions)
+
+</tldr>
+
 Defines an action group.
 The `<action>`, `<group>` and `<separator>` elements defined inside the group are automatically included in it.
 The `<group>` elements can be nested.
 
-**Reference:** [](basic_action_system.md#grouping-actions)
-
 {style="narrow"}
 Required
 : no
@@ -986,10 +1043,14 @@ Examples
 ### `extensions`
 {#idea-plugin__extensions}
 
-Defines the plugin extensions.
+<tldr>
 
 **Reference:** [](plugin_extensions.md)
 
+</tldr>
+
+Defines the plugin extensions.
+
 {style="narrow"}
 Required
 : no
@@ -1023,10 +1084,14 @@ Example
 ### `extensionPoints`
 {#idea-plugin__extensionPoints}
 
-Extension points defined by the plugin.
+<tldr>
 
 **Reference:** [](plugin_extension_points.md)
 
+</tldr>
+
+Extension points defined by the plugin.
+
 {style="narrow"}
 Required
 : no
@@ -1037,11 +1102,15 @@ Children
 #### `extensionPoint`
 {#idea-plugin__extensionPoints__extensionPoint}
 
-A single extension point entry of the [`<extensionPoints>`](#idea-plugin__extensionPoints) defined by the plugin.
-A single [`<extensionPoints>`](#idea-plugin__extensionPoints) element can contain multiple `<extensionPoint>` elements.
+<tldr>
 
 **Reference:** [](plugin_extension_points.md#declaring-extension-points)
 
+</tldr>
+
+A single extension point entry of the [`<extensionPoints>`](#idea-plugin__extensionPoints) defined by the plugin.
+A single [`<extensionPoints>`](#idea-plugin__extensionPoints) element can contain multiple `<extensionPoint>` elements.
+
 {style="narrow"}
 Required
 : no