Skip to content

Commit 66c04b9

Browse files
committed
Documentation: Add HIG document about writing UI text
This first cut only deals with capitalization.
1 parent 508fb7e commit 66c04b9

File tree

1 file changed

+54
-0
lines changed
  • Documentation/HumanInterfaceGuidelines

1 file changed

+54
-0
lines changed
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Guidelines for user interface text in SerenityOS
2+
3+
## Capitalization
4+
5+
SerenityOS employs two capitalization styles:
6+
7+
- Book title capitalization
8+
- Sentence-style capitalization
9+
10+
### Book title capitalization
11+
12+
In this style, we capitalize the first letter of the first and last word,
13+
as well as all words in between, *except* articles (a, an, the);
14+
the seven coordinating conjunctions (for, and, nor, but, or, yet, so);
15+
and prepositions with up to four letters (at, by, for, with, into, ...)
16+
17+
#### Examples:
18+
- Create New Layer
19+
- Copy URL
20+
- Move to Front
21+
- Save and Exit
22+
- Sort by Name
23+
24+
#### Used for:
25+
26+
- Button text
27+
- Icon labels
28+
- Menu names
29+
- Menu items
30+
- Tab titles
31+
- Window titles
32+
- Tooltips
33+
34+
### Sentence-style capitalization
35+
36+
This style follows basic English sentence capitalization.
37+
We capitalize the first letter of the first word, along with the first letter
38+
of proper names, weekdays, etc.
39+
40+
#### Examples:
41+
- An error occurred
42+
- Use system defaults
43+
- Copy the selected text
44+
- Enable Linux compatibility hacks
45+
46+
#### Used for:
47+
48+
- Check box labels
49+
- Group box labels
50+
- List items
51+
- Messages (as in message boxes)
52+
- Radio button labels
53+
- Status bar text
54+
- Text box labels

0 commit comments

Comments
 (0)