From 7190297c66221f65d2a39f4c1187f4a3e0a94ee9 Mon Sep 17 00:00:00 2001 From: Karol Lewandowski Date: Wed, 8 Jan 2025 15:23:18 +0100 Subject: [PATCH] Always render {type="narrow"} for "Attributes" sections --- .../generate_descriptor_pages.main.kts | 3 ++- .../plugin_configuration_file.md | 23 ++++++++++++++++++- .../live_templates_configuration_file.md | 6 ++++- 3 files changed, 29 insertions(+), 3 deletions(-) diff --git a/.github/scripts/generate_descriptor_pages.main.kts b/.github/scripts/generate_descriptor_pages.main.kts index 3442ed806..ce5bdacaf 100755 --- a/.github/scripts/generate_descriptor_pages.main.kts +++ b/.github/scripts/generate_descriptor_pages.main.kts @@ -255,7 +255,8 @@ fun StringBuilder.appendDefaultValue(defaultValue: String?) { fun StringBuilder.appendAttributes(attributeWrappers: List) { val attributes = attributeWrappers.mapNotNull { it.attribute } if (attributes.isNotEmpty()) { - appendLine("\n\nAttributes") + appendLine("\n\n{type=\"narrow\"}") + appendLine("Attributes") appendLine(":") for ((index, attribute) in attributes.withIndex()) { appendAttribute(attribute, index == attributes.lastIndex) diff --git a/topics/basics/plugin_structure/plugin_configuration_file.md b/topics/basics/plugin_structure/plugin_configuration_file.md index 9eb9074a4..b949dfc88 100644 --- a/topics/basics/plugin_structure/plugin_configuration_file.md +++ b/topics/basics/plugin_structure/plugin_configuration_file.md @@ -1,4 +1,4 @@ - + # Plugin Configuration File @@ -95,6 +95,7 @@ Required : **yes** +{type="narrow"} Attributes : - `url` _(optional; ignored in an [additional config file](#additional-plugin-configuration-files))_
@@ -228,6 +229,7 @@ Required +{type="narrow"} Attributes : - `code` _(**required**)_
@@ -268,6 +270,7 @@ is enabled and configured. +{type="narrow"} Attributes : - `since-build` _(**required**)_
@@ -308,6 +311,7 @@ Required +{type="narrow"} Attributes : - `url` _(optional)_
@@ -434,6 +438,7 @@ module is needed +{type="narrow"} Attributes : - `optional` _(optional)_
@@ -521,6 +526,7 @@ Required : no +{type="narrow"} Attributes : - `defaultExtensionNs` _(optional)_
@@ -590,6 +596,7 @@ Required : no +{type="narrow"} Attributes : - `name` _(`name` or `qualifiedName` is **required**)_
@@ -645,6 +652,7 @@ Required : no +{type="narrow"} Attributes : - `tag` _(`tag` or `attribute` is **required**)_
@@ -728,6 +736,7 @@ Required : no +{type="narrow"} Attributes : - `resource-bundle` _(optional; available since 2020.1)_
@@ -770,6 +779,7 @@ Required : no +{type="narrow"} Attributes : - `id` _(**required**)_
@@ -835,6 +845,7 @@ Required : no +{type="narrow"} Attributes : - `group-id` _(**required**)_
@@ -873,6 +884,7 @@ Required : no +{type="narrow"} Attributes : - `keymap` _(**required**)_
@@ -929,6 +941,7 @@ Required : no +{type="narrow"} Attributes : - `keymap` _(**required**)_
@@ -990,6 +1003,7 @@ Required : no +{type="narrow"} Attributes : - `place` _(**required**)_
@@ -1042,6 +1056,7 @@ Required : no +{type="narrow"} Attributes : - `key` _(`key` or `text` is **required**)_
@@ -1070,6 +1085,7 @@ Required : no +{type="narrow"} Attributes : - `value` _(**required**)_
@@ -1101,6 +1117,7 @@ Required : no +{type="narrow"} Attributes : - `id` _(**required**)_
@@ -1187,6 +1204,7 @@ Required : no +{type="narrow"} Attributes : - `ref` _(**required**)_
@@ -1230,6 +1248,7 @@ Required : no +{type="narrow"} Attributes : - `text` _(optional)_
@@ -1316,6 +1335,7 @@ Required : no +{type="narrow"} Attributes : - `topic` _(**required**)_
@@ -1504,6 +1524,7 @@ Required : no +{type="narrow"} Attributes : - `name` _(**required**)_
diff --git a/topics/tutorials/live_templates/live_templates_configuration_file.md b/topics/tutorials/live_templates/live_templates_configuration_file.md index ae526bc13..50ad3a967 100644 --- a/topics/tutorials/live_templates/live_templates_configuration_file.md +++ b/topics/tutorials/live_templates/live_templates_configuration_file.md @@ -1,4 +1,4 @@ - + # Live Templates Configuration File @@ -38,6 +38,7 @@ Required : **yes** +{type="narrow"} Attributes : - `group` _(optional)_
@@ -62,6 +63,7 @@ Required : no +{type="narrow"} Attributes : - `id` _(optional)_
@@ -133,6 +135,7 @@ Required : no +{type="narrow"} Attributes : - `name` _(optional)_
@@ -222,6 +225,7 @@ Required : no +{type="narrow"} Attributes : - `name` _(**required**)_