From a05adbdb05c6e3e90c3630347a835aaf36dd08b5 Mon Sep 17 00:00:00 2001 From: JohnHake Date: Tue, 9 Jul 2019 12:12:21 -0700 Subject: [PATCH] Added "since" attribute description --- reference_guide/ui_themes/themes_customize.md | 7 ++++++- reference_guide/ui_themes/themes_metadata.md | 6 +++++- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/reference_guide/ui_themes/themes_customize.md b/reference_guide/ui_themes/themes_customize.md index 8914efe1f..0b9595c5c 100644 --- a/reference_guide/ui_themes/themes_customize.md +++ b/reference_guide/ui_themes/themes_customize.md @@ -258,12 +258,17 @@ Some keys and strategies for applying them can be gleaned from the [UI Theme ref For a general search, here some suggested methods for locating UI control keys. ### Finding a UI Control Key Using Code Completion in the Editor -The preferred method of finding UI control keys is to use the code completion feature in the IntelliJ IDEA editor. +The preferred method of finding UI control keys is to use the [Code Completion](https://www.jetbrains.com/help/idea/auto-completing-code.html#Auto-Completing_Code.xml) feature in the IntelliJ IDEA editor. Note that some keys presented by the code completion feature may be deprecated. New entries in the `"ui": {}` section will invoke the code completion popup, as shown below: ![UI Control Key Code Completion](img/uit_control_complete.png) +Beginning with version 2019.2 of the IntelliJ Platform, the editor has added features for Code Completion and [Quick Documentation](https://www.jetbrains.com/help/idea/viewing-reference-information.html#inline-quick-documentation) to show the release in which a UI control key began to be supported. +It appears as the _Since_ attribute in editor popups. +In the Quick Documentation popup the format is e.g. _Since: 2019.2_. +The Code Completion popup is similar, but it the format is e.g. _[Since 2019.2]_. + ### Finding a UI Control Key using Laf Defaults UI Using the [Laf Defaults](/reference_guide/internal_actions/internal_ui_lafd.md) inspector, enter the `element` portion of the key. The Laf Defaults inspector will prompt with a list of UI Control keys and their default color. diff --git a/reference_guide/ui_themes/themes_metadata.md b/reference_guide/ui_themes/themes_metadata.md index 0fe145baa..4cbb8e109 100644 --- a/reference_guide/ui_themes/themes_metadata.md +++ b/reference_guide/ui_themes/themes_metadata.md @@ -58,7 +58,11 @@ The following minimal sample demonstrates all details required when exposing UI - `description` - Description to be shown to Theme authors editing `*.theme.json` files - `deprecated` - `true` when key is deprecated, please provide explanation and/or replacement in `description` if available - `source` - FQN of the underlying UI component implementation - + - `since` - The release number (e.g. `[2019.2]`) when this UI customization key was exposed. + A release number prior to 2019.2 is valid. + +> **Note** Support for the `since` attribute began with version 2019.2, so this attribute is only displayed in versions 2019.2 and later. + > **TIP** It is highly recommended to always provide a `description` entry, so Theme authors can understand usages. > **TIP** Do not remove existing keys, but deprecate them instead to help Theme authors upgrade their existing themes.