Karol Lewandowski d8e83b57ea
UI Guidelines (#1308)
* 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 '&nbsp;'

* 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>
2024-05-16 13:51:56 +02:00

2.3 KiB

Capitalization

UI guidelines for using title and sentence capitalization in various contexts.

Title

The current Windows guidelines use sentence capitalization for actions. Some Microsoft products still title-capitalize actions according to the previous guidelines. macOS also title-capitalizes actions. Since IntelliJ IDEs are cross-platform, we use title capitalization as well.

{style="note"}

Use for:

  • Actions in buttons, menus and tooltips
  • Headers in tables, popups, message boxes and dialogs
  • Headers of UI control groups

Do not use for:

  • Actions in links
  • Actions in the popup on Alt+Enter: quick-fixes, intention actions, and others
  • Headers in notifications

Rules

Always capitalize the first and the last words.

Capitalize the words in-between except:

  • articles: a, an, the,
  • coordinating conjunctions: and, or, but,
  • prepositions of four and fewer letters which are not a part of a phrasal verb: in, with.

In hyphenated phrases, capitalize all nouns, adjectives and adverbs: Auto-Indent, Command-Line Launcher. Do not capitalize articles, prepositions and conjunctions: Side-by-Side, Drag-and-Drop.

Examples

Compare With… — the short preposition with is capitalized as the last word.

Compare with Latest Repository Versionwith is not capitalized when in the middle.

Check Out from Version Controlout is a part of the phrasal verb check out and is capitalized.

Sentence

Use for:

  • Labels of UI controls: text boxes, checkboxes, radio buttons, combo boxes, etc.
  • Items in combo boxes, lists, trees and tables
  • Links
  • Actions in the popup on Alt+Enter
  • Header and body text in notifications
  • Body text in error messages, tooltips, status descriptions and any kind of instructions

Rules

Capitalize the first word in a sentence, proper nouns and adjectives, and abbreviations.

Examples

Control+Shift+F — keyboard button names are considered proper nouns.

Accept the terms of the License Agreement — License Agreement is a proper noun.

Side-by-side layout — only the first word of a hyphenated phase is capitalized.