TextConventions
From KalypsoDev
Revision as of 20:19, 2 February 2015 by Nicoschrage (Talk | contribs)
Contents |
Text conventions
Within the GUI, the user needs to be informed and requested to interact. Thus, a collection of text snippet types needs to be defined.
(This list needs to be filled and updated from time to time!)
Following snippets should be distinguished:
Workflow
- Workflow Task: TODO
- engl:
- germ:
Generally
- Requests to interact with user, e.g. specification of a file from the file system
- engl: "Please" + imperative form + subject + exclamation mark, e.g.
- Please specify the flow resistance file!
- germ: "Bitte" + subject + infinitive form + exclamation mark, e.g.
- Bitte Fließwiderstandsdatei angeben!
Widgets
- Name of a widget:
- engl: imperative form (+ subject); all capital letters, no full stop! e.g. "Edit Roughness Zones", "Zoom In", "Measure Distances"
- germ: Infinitive, e.g. "Fließwiderstandszonen bearbeiten"
- sectionwise headers wihtin tools representation (complex widgets): TODO
- Tool Tip to describe functionality of a tool and further some consequence information
- engl: Repeat Tool Name in that convention; next line; Describe tool functionality in same manner as name with extended subject + full stop; Add additional information in full sentences; use complete punctuation; not all capitals, e.g.
- "Measure geometries of features in map panel.
- Line length, polyline length and areas can be examined. Take care of hints in map tool disrcription."
- germ: Repeat Tool Name; subject + infinitve form, e.g. "Fließwiderstandszonen bearbeiten"
Wizards
- Wizard window title and sub-title: TODO
- Wizard information due to the current Wizard data content: TODO