cloudron-box/dashboard/TRANSLATIONS.md

## Translations

This documents the convention used for the text in the UI.

### Tale of Two Cases

**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.

### UI Conventions

| 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          |
| Checkbox       | Sentence Case          | Use CIFS encryption              |
| 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.         |
| Placeholders   | Sentence case          | Comma separated IPs or subnets   |

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

### Dialog Buttons

'Add' for addition
'Cancel' to cancel
'Save' for edit/update
'Remove' for non-destructive/less destructive things (app password remove)
'Delete' for destructive (user delete)

'Close' - Only for dialogs with the only button

### Dialog Text

When asking for confirmation simply ask 'Remove app password "xxx"' . Don't use "really"
or other emotional terms. Quote the password/domain name.

In general, we put just "Delete User" in Title and provide the username in the context.

Title = action (what you’re doing)
Description = context (to whom it applies)