34f04828c5
dashboard/README.md has information of the casing style
1.9 KiB
1.9 KiB
Translations
This documents the convention used for the text in the UI.
Title Case
All words are capitalized.
In title case, articles (a/an/the) ,conjunctions (and/but/or/...) and prepositions (on/at/...) inside a phrase are not capitalized.
Everything else is capitalized - noun, pronoun, verb, adverb.
Examples:
- "Sign In to Your Account"
- "Terms and Conditions"
- "Getting Started with GraphQL"
- "Between You and Me"
Sentence case
Only first word is capitalized.
Convention
| Element | Recommended Style | Example |
|---|---|---|
| Headings | Title Case | Manage Account |
| Sub heading | Title Case | Create Admin Account |
| Form Labels | Title Case | Email Address |
| Buttons | Sentence Case | Save changes |
| Radio Buttons | Sentence Case | Option one / Option two |
| Menu action | Sentence Case | Select all |
| Switches | Sentence Case | Allow users to edit email |
| Descriptions | Sentence case | Enter your password to continue. |
| Tooltips | Sentence case | Click to edit. |
| Error Messages | Sentence case | Password is too short |
| Notifications | Sentence case | Settings saved successfully. |
| Legend (graph) | Sentence case | Docker volume, Box data. |
Hints in brackets are small case. Like "(comma separated)".
Full stops
Sentence fragments like form hints and tooltips (which are always visible) do not need a full stop. All other full sentences do.
description has a full stop unless it's a hint/phrase.
Checkbox labels do not have a full stop at the end