Differential D10583 Diff 27349 source/style/writing/labels.rst

Changeset View

Standalone View

source/style/writing/labels.rst

This file was added.

1		Lables
2		======
3
4		Purpose
5		-------
6
7		Common controls should behave ‘common’ and look like everyday controls.
8		Therefore, it is much recommended to use standard font. Bold or italic
9		font should not be applied to control labels.
10
11		Guidelines
12		----------
13
14		- Keep labels short; be aware that :doc:`translated <localization>` English text can
15		expand up to 30% in some languages.
	romanggUnsubmitted Not Done Is this "translated_" supposed to be emphasized? romangg: Is this "translated_" supposed to be emphasized?
16		- Do not shorten your labels to the point of losing meaning. However, a
17		three-word label that provides clear information is better than a
18		one-word label that is ambiguous or vague. Try to find the fewest
19		possible words to satisfactorily convey the meaning of your label.
20		- When the label is associated with another control, like a line edit,
21		be sure to set the the line edit as the
22		`buddy <https://doc.qt.io/qt-5/qlabel.html#setBuddy>`_ of
23		the label.
	romanggUnsubmitted Not Done Transform link and set it to http://doc.qt.io/qt-5/qlabel.html#setBuddy romangg: Transform link and set it to http://doc.qt.io/qt-5/qlabel.html#setBuddy
24
25		Dialogs
26		~~~~~~~
27
28		- If a dialog is user-initiated, identify it using the command or
29		feature name.
30		- If it is application- or system-initiated (and therefore out of
31		context), label it using the program or feature name to provide
32		context.
33		- Do not use the title to explain what to do in the dialog – that's the
34		purpose of the main instruction.
35
36		Menus
37		~~~~~
38
39		- Prefer verb-based names; Avoid generic, unhelpful verbs, such as
40		Change or Manage.
41		- Use singular nouns for commands that apply to a single object,
42		otherwise use plural nouns.
43		- For pairs of complementary commands, choose clearly complementary
44		names. Examples: Add/Remove, Show/Hide, or Insert/Delete.
45		- Choose menu item names based on user goals and tasks, not on
46		technology.
47		- Assign access keys to all menu items (Alt+Letter).
48
49		Buttons
50		~~~~~~~
51
52		- Label command buttons with an imperative verb.
53		- Do not use ending punctuation for labels.
54		- Describe the action that the button performs in a tooltip.
55		- End the label with an ellipsis if the command requires additional
56		information to execute.
57		- Assign access keys to all buttons (Alt+Letter).
58
59		Links
60		~~~~~
61
62		- Choose a concise, self-explanatory label that clearly communicates
63		and differentiates what the command link does.
64		- Do not use ellipses.
65
66		Tabs
67		~~~~
68
69		- Label tabs based on their pattern. Use nouns rather than verbs,
70		without ending punctuation.
71		- Do not assign an access key. Tabs are accessible through their
72		shortcut keys (Ctrl+Tab, Ctrl+Shift+Tab).
73
74		Check boxes and Radio buttons
75		~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
76
77		- Label every check box or radio button. Do not leave check boxes or
78		radio buttons unlabeled.
79		- Assign a unique access key to each label.
80		- Labels must start with an active verb clearly defining the state to
81		be enabled or disabled.
82		- For a group, use parallel phrasing and try to keep the length about
83		the same for all labels.
84		- For a group, focus the label text on the differences among the
85		options.
86		- Use affirmative phrases. Do not use negative phrases such as "Don't
87		enable wifi". Use rather "Enable wifi".
88		- Describe just the option with the label. Keep labels brief so it's
89		easy to refer to them in messages and documentation.
90
91		Group box
92		~~~~~~~~~
93
94		- Use group labels to explain the purpose of the group, not how to make
95		the selection.
96		- End each label with a colon to show a relationship.
97		- Do not assign an access key to the label.
98		- For a selection of one or more dependent choices, explain the
99		requirement on the label.
100
101		Using Ellipses in Labels
102		~~~~~~~~~~~~~~~~~~~~~~~~
103
104		- Use an ellipsis (...) after menu items and button labels which
105		require user’s input before completing their action.
106		- Do not use an ellipsis if no further user input is required to
107		complete the action
108		- Do not use an ellipsis for selections which result in actions (such
109		as Save or Print Preview) or do not require user input (such as
110		configuration dialogs).
111		- Do not use an ellipsis for an action which may require confirmation
112		before it is completed (such as a Deletion confirmation), but no
113		other input.
114		- Use an ellipsis for the following menu items and buttons:
115
116		- Find...
117		- Find and Replace...
118		- Open...
119		- Print...
120		- Replace...
121		- Save As...
122		- Send To...
123
124		- Do not use an ellipsis for the following menu items and buttons:
125
126		- About
127		- Advanced Options
128		- Check Spelling
129		- Close or Quit
130		- Configure [something]
131		- Delete or Remove
132		- Help
133		- Preferences
134		- Print Preview
135		- Properties
136		- Toolboxes