Documentation: Add HIG document about writing UI text

This first cut only deals with capitalization.
This commit is contained in:
Andreas Kling 2023-03-03 21:37:23 +01:00
parent 508fb7e1e9
commit 66c04b98f1

View file

@ -0,0 +1,54 @@
# Guidelines for user interface text in SerenityOS
## Capitalization
SerenityOS employs two capitalization styles:
- Book title capitalization
- Sentence-style capitalization
### Book title capitalization
In this style, we capitalize the first letter of the first and last word,
as well as all words in between, *except* articles (a, an, the);
the seven coordinating conjunctions (for, and, nor, but, or, yet, so);
and prepositions with up to four letters (at, by, for, with, into, ...)
#### Examples:
- Create New Layer
- Copy URL
- Move to Front
- Save and Exit
- Sort by Name
#### Used for:
- Button text
- Icon labels
- Menu names
- Menu items
- Tab titles
- Window titles
- Tooltips
### Sentence-style capitalization
This style follows basic English sentence capitalization.
We capitalize the first letter of the first word, along with the first letter
of proper names, weekdays, etc.
#### Examples:
- An error occurred
- Use system defaults
- Copy the selected text
- Enable Linux compatibility hacks
#### Used for:
- Check box labels
- Group box labels
- List items
- Messages (as in message boxes)
- Radio button labels
- Status bar text
- Text box labels