d8e83b57ea
* Add UI Guidelines to SDK docs * Add UI Guidelines to SDK docs * Fixing build errors * optimize PNGs * add UI guidelines landing page placeholder * IJ SDK Docs <-> UI guidelines crosslinks updated * split_button.md: remove reference to removed setting * use <ui-path> * use MD instead of <note> * use %gh-ic% links * drop_down.md: fix <control> * code samples: fix most obvious issues * remove obsolete `_defaults.md` * ijs.tree: UI cleanup * Delete "under construction" pages * Fix headers * Add link-summary * Remove invalid links * Delete unused files * Remove ''@2x' from image file names * Use Markdown syntax for some images and tables * Rename non-unique files to unique * Remove alpha in images where content is unreadable * align quotation marks * Controls: cleanup/fixes, add code links, edit * tooltip.md: fix HTML * misc fixes * typography.md: fix table contents * typography.md: fix table header * UI guidelines landing page + TOC fixes * remove unused icons_list.md * Normalize image paths * validation_errors.md: Fix broken tab * "correct"/"incorrect" labels styling * Resize images to 50% * button.topic: fixes * grammar, spelling, minor edits * remove ' ' * fix 99px * cleanup * UI_kit.md: minor * Fix "MRK058: Large image in paragraph rendered as a block element by default." * button.topic: Add img[alt] * mnemonics.md: Update "Contact Us" link to the IJSDK YouTrack * split_button.md: Use ui-path * UI landing: add feedback snippet * Improve code snippets formatting and naming * Fix code samples * Fix code samples * Add Kotlin variants for code samples * Add icons_list.md * crosslinks * Change external link to https://intellij-icons.jetbrains.design/ * icons list -> https://intellij-icons.jetbrains.design * Hide info about reducing split button to simple action button (now it is available through the registry only) * reformat * icons_style.md: Images in new line --------- Co-authored-by: marianna.kononenko <marianna.kononenko@jetbrains.com> Co-authored-by: Yann Cébron <yann.cebron@jetbrains.com>
4.8 KiB
Punctuation
Punctuation rules for labels and description texts.
Use the following rules for labels and description texts in IntelliJ user interfaces. For punctuation in numbers and times, see Data formats.
Ellipsis
End an action name with an ellipsis if it opens a dialog where input is required or possible. An ellipsis helps users understand if an action is immediate, or additional interaction is to follow.
This rule applies to actions in the following controls: button, link, menu item.
Examples:
|
Save All Build Project |
Happens immediately, no ellipsis |
|
Import Settings… Export to HTML… |
Opens dialogs that require input |
| Project Structure… | Opens a complex dialog where input is not required but possible |
|
Tip of the Day About IntelliJ IDEA |
Opens dialogs that just show information, no input is either required or possible |
Use an ellipsis at the end of a truncated text if there is no scrollbar and this is not a table column, see truncation in table columns. Provide a way to show the full text, for example, expand the control or show a tooltip on hover.
{width=399 style=block}
A notification can be expanded to show the full text.
Use an ellipsis with verbs describing an ongoing process, for example, Searching… See more examples in Progress text.
Use the ellipsis character … (U+2026 in Unicode). Do not use three separate "dot" characters.
Period
Do not put a period at the end of a single sentence, even if it is a complete sentence.
{width=385}
{width=396}
If a text consists of several sentences, put a period after each sentence.
{width=488}
Do not put a period at the end of an IDE action.
{width=385 style=block}
The empty text consists of two sentences, but the second one is an IDE action, so it should not have a period.
Note that links that are not IDE actions can have a period in the end.
{width=376}
Comma
Use a comma:
Before a conjunction in a list of three or more items (the Oxford or serial comma).
Border for a text field, combo box, or spinner
Between symbols in series.
Use the following characters: &, $, ., and *
Colon
Use a colon after labels for inputs and radio button / checkbox groups.
{width=153}
{width=213}
Do not use a colon if a label and text inside the input element make a phrase.
{width=247}
Contractions
Generally, do not use contractions.
Path can’t be found → Path cannot be found
Use contractions only if the action name has 4 and more words, and the contracted word does not affect the meaning significantly.
What’s New in IntelliJ IDEA
Don’t or Do not:
- Always contract in the phrase Don’t [some verb] again. The phrase is common, and the meaning is easily recognized.
{width=399} - In other cases, do not contract. The full form reduces chances that the relevant meaning might be missed.
Don’t send → Do not send
Do not save, forget passwords after restart
Quotation marks
Use single quotation marks by default.
Use a straight single quotation mark ' (
U+0027). Do not use opening and closing quotation marks ‘ ’ (U+2018/U+2019).
{style="note"}
Indexing library 'KotlinJavaRuntime'
Error parsing '.mvn/maven.config'
Add 'root=true' to the beginning of the file
Show 'Scratches and Consoles' in the Project view
Do not use quotation marks for keyboard key names.
Type an expression and press 'Enter' → press Enter
Do not use double quotation marks.
Question marks
Use only in alerts when asking for confirmation.
A file with this name already exists. Do you want to overwrite it?
Avoid in other cases.
Forgot password? → Remind password
Exclamation points
Do not use. Exclamation points can cause the sentence tone to be interpreted as aggressive, condescending, or overly informal.