Difference between revisions of "TextConventions"

Revision as of 18:31, 9 February 2015

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

• Command to user to do something

engl: "Please" + imperative form + subject + exclamation mark, e.g.

Please specify 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: (Subject +) Infinitive form,

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

A wizard contains several components: A Name/Title, a descriptive header, a work description

• Wizard Name/Title: Should be named as the tool button that calls the wizard! It should be named as follows:

engl: imperative form; all capital letters, no full stop! e.g. "Import Flow Resistance Zones" or "Edit Simulation Settings"

germ: Infinitive, e.g. "Fließwiderstandszonen importieren" or "Simulationseinstellungen editieren"

• Wizard descriptive header: Should extend the name/title of the wizard

engl: imperative form; not all capital letters, additional descriptive words, full stop! e.g. "Edit Simulation Settings for 'RMA Kalypso' Simulation"

germ: Infinitive form + additional descriptive words, full stop!, e.g."Simulationseinstellungen für eine 'RMA·Kalypso'-Simulation editieren"

• Wizard work description: Should consist of a

engl: imperative form; not all capital letters, additional descriptive words, full stop! e.g. "Edit Simulation Settings for 'RMA Kalypso' Simulation"

germ: Infinitive form + additional descriptive words, full stop!, e.g."Simulationseinstellungen für eine 'RMA·Kalypso'-Simulation editieren"

• Wizard information due to the current Wizard data content: TODO