diff --git a/images/ui/inline_help_text/inline_text_brackets_correct.png b/images/ui/inline_help_text/inline_text_brackets_correct.png index 43b58ad5a..893fd2f8f 100644 Binary files a/images/ui/inline_help_text/inline_text_brackets_correct.png and b/images/ui/inline_help_text/inline_text_brackets_correct.png differ diff --git a/images/ui/inline_help_text/inline_text_brackets_correct_dark.png b/images/ui/inline_help_text/inline_text_brackets_correct_dark.png index 4d31d487f..2d53102ac 100644 Binary files a/images/ui/inline_help_text/inline_text_brackets_correct_dark.png and b/images/ui/inline_help_text/inline_text_brackets_correct_dark.png differ diff --git a/images/ui/inline_help_text/inline_text_group.png b/images/ui/inline_help_text/inline_text_group.png index a337398b5..34ab71df3 100644 Binary files a/images/ui/inline_help_text/inline_text_group.png and b/images/ui/inline_help_text/inline_text_group.png differ diff --git a/images/ui/inline_help_text/inline_text_group_dark.png b/images/ui/inline_help_text/inline_text_group_dark.png index d24ef351f..6af12a893 100644 Binary files a/images/ui/inline_help_text/inline_text_group_dark.png and b/images/ui/inline_help_text/inline_text_group_dark.png differ diff --git a/images/ui/inline_help_text/inline_text_on_the_bottom_dark.png b/images/ui/inline_help_text/inline_text_on_the_bottom_dark.png index b6eb45804..bb47240ad 100644 Binary files a/images/ui/inline_help_text/inline_text_on_the_bottom_dark.png and b/images/ui/inline_help_text/inline_text_on_the_bottom_dark.png differ diff --git a/images/ui/inline_help_text/inline_text_on_the_bottom_master_detail.png b/images/ui/inline_help_text/inline_text_on_the_bottom_master_detail.png index f8b6f0bb1..bed721c84 100644 Binary files a/images/ui/inline_help_text/inline_text_on_the_bottom_master_detail.png and b/images/ui/inline_help_text/inline_text_on_the_bottom_master_detail.png differ diff --git a/images/ui/inline_help_text/inline_text_on_the_bottom_master_detail_dark.png b/images/ui/inline_help_text/inline_text_on_the_bottom_master_detail_dark.png index efdc9fa69..8914adfb0 100644 Binary files a/images/ui/inline_help_text/inline_text_on_the_bottom_master_detail_dark.png and b/images/ui/inline_help_text/inline_text_on_the_bottom_master_detail_dark.png differ diff --git a/images/ui/inline_help_text/inline_text_on_the_right_button_dark.png b/images/ui/inline_help_text/inline_text_on_the_right_button_dark.png index 8b7bb35b8..1b59ca896 100644 Binary files a/images/ui/inline_help_text/inline_text_on_the_right_button_dark.png and b/images/ui/inline_help_text/inline_text_on_the_right_button_dark.png differ diff --git a/images/ui/inline_help_text/inline_text_on_the_right_checkbox_dark.png b/images/ui/inline_help_text/inline_text_on_the_right_checkbox_dark.png index 7db2ba02b..4d9dfda1d 100644 Binary files a/images/ui/inline_help_text/inline_text_on_the_right_checkbox_dark.png and b/images/ui/inline_help_text/inline_text_on_the_right_checkbox_dark.png differ diff --git a/images/ui/inline_help_text/inline_text_on_the_right_input_field_dark.png b/images/ui/inline_help_text/inline_text_on_the_right_input_field_dark.png index 9216913fd..a355831d3 100644 Binary files a/images/ui/inline_help_text/inline_text_on_the_right_input_field_dark.png and b/images/ui/inline_help_text/inline_text_on_the_right_input_field_dark.png differ diff --git a/images/ui/inline_help_text/inline_text_on_the_right_tree_dark.png b/images/ui/inline_help_text/inline_text_on_the_right_tree_dark.png index 5d1e818f3..0bc47d90b 100644 Binary files a/images/ui/inline_help_text/inline_text_on_the_right_tree_dark.png and b/images/ui/inline_help_text/inline_text_on_the_right_tree_dark.png differ diff --git a/images/ui/inline_help_text/inline_text_under_table_dark.png b/images/ui/inline_help_text/inline_text_under_table_dark.png index 7159eb6e3..40f62cc84 100644 Binary files a/images/ui/inline_help_text/inline_text_under_table_dark.png and b/images/ui/inline_help_text/inline_text_under_table_dark.png differ diff --git a/images/ui/inline_help_text/tooltip_list.png b/images/ui/inline_help_text/tooltip_list.png index c61106a05..07f8b154c 100644 Binary files a/images/ui/inline_help_text/tooltip_list.png and b/images/ui/inline_help_text/tooltip_list.png differ diff --git a/images/ui/inline_help_text/tooltip_list_dark.png b/images/ui/inline_help_text/tooltip_list_dark.png index 03789a190..ac54d5723 100644 Binary files a/images/ui/inline_help_text/tooltip_list_dark.png and b/images/ui/inline_help_text/tooltip_list_dark.png differ diff --git a/topics/ui/controls/inline_help_text.md b/topics/ui/controls/inline_help_text.md index 07d1c10dd..b6f740d6f 100644 --- a/topics/ui/controls/inline_help_text.md +++ b/topics/ui/controls/inline_help_text.md @@ -13,6 +13,7 @@ Inline help texts provide useful information about settings: + Show no more than five lines of help text to not clutter the screen. Text width is limited to 70 characters. @@ -49,7 +50,8 @@ panel { -Provide a link to the corresponding help article or to a place in the IDE where the related settings can be found. + +Provide a [link](link.md) to the corresponding help article or to a place in the IDE where the related settings can be found. Place the link at the end of the text where possible so that it does not disrupt reading. @@ -68,7 +70,8 @@ Place the link at the end of the text where possible so that it does not disrupt -- Avoid text highlighting. Usually, the help text is short, and no highlighting in bold or italics is needed: + +Avoid text highlighting. Usually, the help text is short, and no highlighting in bold or italics is needed:
@@ -81,12 +84,14 @@ Place the link at the end of the text where possible so that it does not disrupt
+
[//]: # (* Use formatting for code, console commands, or parameters. Use HTML tags. Enclosing text in `` tags is not needed.) [//]: # ( ![](inline_text_parameter_styling.png){width=213}) -- Avoid using brackets in control labels and place this information in the inline text instead: + +Avoid using brackets in control labels and place this information in the inline text instead:
@@ -100,6 +105,7 @@ Place the link at the end of the text where possible so that it does not disrupt
+
@@ -130,10 +136,11 @@ Place the help text to the right of labeled inputs (fields, combo boxes, or text * The space to the right is empty. * The help text has 1–5 words, not counting articles and prepositions. * The control label has 1–5 words. - + + Input fields with inline texts on the right + - ```kotlin panel { row("Plugin update policy:") { @@ -147,12 +154,39 @@ panel { } ``` + -* In other cases, place the help text under the UI controls: + + +Checkboxes with inline texts on the right + + + +```kotlin +panel { + row { + checkBox("Build project automatically") + comment("Works while not running / debugging") + } + row { + checkBox("Compile independent modules in parallel") + comment("May require larger heap size") + } +} +``` + + + + + Button with inline texts on the right + + + +In other cases, place the help text under the UI controls: Input filed with inline text on the bottom - + ```kotlin panel { @@ -168,33 +202,10 @@ panel { If there is no space under the UI control, use the [help tooltip](tooltip.md#question-mark-icon-for-help-tooltips) with the question mark icon for labeled inputs, checkboxes, and radio buttons. For buttons, use the help tooltip without the icon. - - -Checkboxes with inline texts on the right - - -```kotlin -panel { - row { - checkBox("Build project automatically") - comment("Works while not running / debugging") - } - row { - checkBox("Compile independent modules in parallel") - comment("May require larger heap size") - } -} -``` - - - - - Button with inline texts on the right - - + If the help text applies to a whole list, tree, or table, place it below the control. Inline text under the table @@ -219,23 +230,26 @@ panel { } ``` - -If the help text applies to a single list, tree, or table item: - -* If the help text has 1–10 words, place it to the right of the item: + + +If the help text applies to a single list, tree, or table item, its location will depend on its length. + +Place short texts (1–10 words) to the right of the item: Inline text under the table + + -* If the text is longer than 10 words: - -For a list or tree in the master part, place the text into the detail part. +* Place longer texts (more than 10 words) into the detail part of master-detail layouts: Inline text on the bottom of the master detail layout -For other cases, use the [help tooltip](tooltip.md#question-mark-icon-for-help-tooltips) with the question mark icon: +* For other cases, use the [help tooltip](tooltip.md#question-mark-icon-for-help-tooltips) with the question mark icon: Inline text on the bottom of the master detail layout + + @@ -276,9 +290,10 @@ panel { } } ``` - - You can find more examples by invoking the **Tools | Internal Actions | UI | Kotlin UI DSL | UI DSL Showcase** action (available in [internal mode](enabling_internal.md) and clicking the **View source** links on specific pages. + + +