Grammar and Copy
This guide introduces the standards of grammar, pronounciation, naming and text messaging for applications using OCUI.
Parts of this Page Have Been Copied from Various Sources.
User Interface Text Guidelines
The topics in this section provide guidelines for the design of user interface text. Because of the limited amount of screen space available on most Windows Mobile devices, it's extremely important to minimize the amount of textual information displayed on the device. In addition, mobile professionals don't have a lot of time or desire to read large amounts of text to accomplish specific tasks. When writing user interface (UI) text for OCUI applications, consider the following questions:
- Is the user interface text clear, concise, and contextually relevant for the audience?
- Does the text consistently follow the style, terminology, and tone and voice specified for the product?
- Does the text follow localization and geopolitical guidelines?
User Interface Text Checklist
When writing UI text for OCUI applications, use the guidelines in the following checklist:
- Use clear terminology.
- Avoid technical jargon and colloquialisms.
- Use as few words as possible without losing the meaning.
- Use one term consistently for all concepts that have the same meaning.
- Avoid negative and politically sensitive terms.
- Write active sentences.
- When writing instructional text, present the result before the required action. For example, "To begin importing contacts, click Next."
- Allow for at least 30 percent text expansion for localization.
- Follow the OCUI capitalization and punctuation guidelines.
- Make sure UI command labels match labels for the UI they open.
- Write informative error messages.
- Ask an editor to review all UI text.
Capitalization and Punctuation Guidelines
The following table indicates the type of capitalization you should use for user interface (UI) controls.
Title capitalization specifies that all parts of speech are capitalized, with the exception of articles, coordinating conjunctions (and, but, for, not, or, so, and yet), and prepositions containing four or fewer letters. Sentence capitalization specifies that only the first word and any proper nouns are capitalized.
Title Capitalization
Button label
Header
Menu label
Menu command label
Option button label
Pop-up menu command
Split button label
Soft key or touchable tile labels
Tab label
Text header
Toolbar buttons
Screen tip
Tree view label
Window, dialog box, and error message titles
Sentence Capitalization
Check box label
Combo box label
Drop-down list items
Instructional text
List box label
Option button label
Error message text
Slider label
Progress bar label
Text box label
Drop-down list label
Text sub header
Time picker label
Geopolitical Ready and Localized Text-Guidelines
Apply the following geopolitical guidelines to the user interface text:
- Always use the term country/region instead of the word country.
- Always use the term capital/major city instead of the word capital.
- Be cautious when using an untranslated trademarked term from your country because it might be interpreted as an offensive or otherwise undesirable term in another language.
Apply the following localization guidelines to the user interface text:
- Use terminology, punctuation, acronyms, and capitalization consistently.
- Avoid idioms, jargon, colloquialisms, abbreviations, acronyms, and metaphors whenever possible.
- Avoid long compound sentences with multiple nouns because they are difficult to translate.
- Use descriptors wherever possible.
- When using punctuation, take into account that other languages have different rules.
- Localizing English text usually increases the length of the text, which may affect the layout of controls. As needed, use standard abbreviations and rephrase text to ensure that it fits on the screen.
- The following illustration shows the difference in text length when the same content is localized in three different languages.
English
German
Finnish
French
Russian
Это простой текст-заглушка.
Japanese
Error and Informational Message Guidelines
Follow these guidelines when you write error messages and informational text:
- Identify the problem, indicate the cause if helpful, and provide a solution if possible.
- Write phrases instead of complete sentences to conserve space. For example, write "Save using a different name" instead of "Save this document using a different file name."
- Use title caps in the title bar of the message box and sentence caps in the message body text.
- Title caps rules specify that all words are capitalized with the exception of articles, coordinating conjunctions (and, but, for, not, or, so, and yet), and prepositions containing four or fewer letters.
- Sentence caps rules specify that only the first word and any proper nouns are capitalized.
- Bold command names instead of using quotation marks.
- When there may be a consequence of a user's action, preface the error message with the word "Warning." For example, write "Warning: If you synchronize now, duplicate items may appear in your Inbox."
- Do not use exclamation points.
- Do not write content that implies that applications can think or feel.
- Avoid using the word please.
- Instead of abort, use the words End, quit or stop.
Glossary: Button Labels
This list includes all labels, which can be used for the UI of OpusCapita. The buttons can be used either as icon-only, text-only or as icon-text combination. This options should always be preferred, if there is enough space on the UI. Please note that a tooltip must be added if the button only includes an icon.
The following labels are approved to be used for the UI of the PIM product line:
English Label | German Label | Icon [Yes/No] | Icon Name | Comment | Example |
---|---|---|---|---|---|
Action | Aktion | No | For dropdown buttons containing multiple actions |
|
|
Add | Hinzufügen | Yes | fa fa-plus | ||
Apply | Übernehmen | No | |||
Approve | Genehmigen | Yes | fa-check | ||
Assign | Zuweisen | Yes | fa-retweet | ||
Bulk Update | Massenaktualisierung | No |
|
||
Cancel | Abbrechen | No | |||
Change | Ändern | No | Do not use "change" instead of "edit" | ||
Close | Schließen | No | |||
Compare | Vergleichen | No | |||
Convert | Konvertieren | No | |||
Copy | Kopieren | Yes | fa fa-files-o | Do not use "Duplicate" as label | |
Create | Erstellen | Yes | fa-plus | Do not mistake with "Add" | |
Delete | Löschen | Yes | glyphicon-trash | ||
Edit | Bearbeiten | Yes | fa-pencil | Do not use glyphicon-edit. Do not use glyphicon-pencil. Do not use fa-edit. |
|
Export | Exportieren | Yes | fa-download | ||
Finish | Beenden | Yes | fa-stop | ||
History | Verlauf | Yes | fa-history | ||
Import | Importieren | Yes | fa-upload | ||
Less | Weniger | No | Do not use dropdown caret |
|
|
Load | Laden | No | |||
Log In | Log In | No | Do not use "Login" as label | ||
More | Mehr | No |
|
||
Normalize | Normalisieren | No |
|
||
OK | OK | No | |||
Preview | Vorschau | Yes | glyphicon-eye-open | ||
Refresh | Aktualisieren | Yes | fa-sync | Do not use "Reload" as label | |
Reject | Ablehnen | Yes | fa-ban | ||
Remove | Entfernen | Yes | fa-times | ||
Reset | Zurücksetzen | Yes | fa fa-undo | Do not use "Restore" as label | |
Run | Ausführen | Yes | fa-play | Do not use "Execute" as label | |
Save | Speichern | No | |||
Save and New | Speichern und Neu | No | |||
Save and Next | Speichern und Nächstes | No | |||
Schedule | Planen | Yes | fa-clock | ||
Search | Suchen | Yes | fa-search | ||
Select | Auswählen | No | |||
Show | Zeige | No |
|
||
Start | Starten | Yes | fa-play | ||
Upload | Hochladen | No | |||
Usage | Verwendung | No |
Please contact Charleen Germakowsky, if none of the listed labels fit to your purpose.
Glossary: Status Labels
The following labels are approved to be used for the UI of the PIM product line:
English Label | German Label | Comment | Example |
---|---|---|---|
Active | Aktiv | Active | |
Approved | Genehmigt | Approved | |
Approval Required | Genehmigung notwendig | Approval Required | |
Canceled | Abgebrochen | Canceled | |
Changed | Geändert | Changed | |
Checked | Geprüft | Checked | |
Confirmed | Bestätigt | Confirmed | |
Converted | Konvertiert | Converted | |
Deleted | Gelöscht | Deleted | |
Disabled | Deaktiviert | Do not use "passive" instead | Disabled |
Editing | In Bearbeitung | Editing | |
Error | Fehler | Failed | |
Failed | Gescheitert | Failed | |
In Approval | In Genehmigung | In Approval | |
New | Neu | Do not use "Created" as label | New |
Open | Offen | Open | |
Ordered | Bestellt | Ordered | |
Rejected | Abgelehnt | Rejected | |
Submitted | Übermittelt | Do not use "transfered" | Submitted |
Unchanged | Ungeändert | Unchanged | |
Uploaded | Hochgeladen | Uploaded | |
Warning | Warnung | Warning |