Debian Codegraph @

t/expected/padre_translationstyle_noclass_noid_nospan.html

raw
1 <h1>Translation manual of style</h1>
2 <p>
3 These are all real shortcomings found around <a href="/changeset/6000">r6000</a> (July 2009).
4 </p>
5 <p>
6 Also see:
7 * <a href="http://msdn.microsoft.com/en-us/library/aa511440.aspx">http://msdn.microsoft.com/en-us/library/aa511440.aspx</a>
8 * <a href="http://developer.kde.org/documentation/design/ui/">http://developer.kde.org/documentation/design/ui/</a>
9 * <a href="http://developer.gnome.org/projects/gup/hig/">http://developer.gnome.org/projects/gup/hig/</a>
10 * <a href="http://wiki.openusability.org/guidelines/">http://wiki.openusability.org/guidelines/</a>
11 * <a href="http://developer.apple.com/documentation/UserExperience/Conceptual/AppleHIGuidelines/">http://developer.apple.com/documentation/UserExperience/Conceptual/AppleHIGuidelines/</a>
12 </p>
13 <hr />
14 <p>
15 Bad:
16 <tt>
17 </p>
18 <blockquote>
19 <p>
20 We found several new plugins.
21 In order to configure and enable them go to
22 Plugins -&gt; Plugin Manager
23 </p>
24 </blockquote>
25 <blockquote>
26 <p>
27 List of new plugins:
28 </p>
29 </blockquote>
30 <p>
31 <tt>
32 </p>
33 <ul><ul><li>Avoid the words 'we' or 'I' in dialog. Do not attempt to speak on behalf of the program or computer. State the situation as a matter of fact.
34 </li><li>Do not make the user remember a navigation path. Offer a direct shortcut to the referenced dialog.
35 </li><li>Avoid primitive ASCII approximate representation of symbols. Use proper characters: →
36 </li><li>Remove superfluous words. It is obvious to the user that this is a list.</li></ul></li></ul>
37 <p>
38 Better:
39 <tt>
40 </p>
41 <blockquote>
42 <p>
43 New plugins were found.
44 <sup>
45 [Plugin B #]
46 [Plugin C #]
47 [Plugin D #]
48 [Plugin E v]
49 [Configure...]
50 </p>
51 </blockquote>
52 <p>
53 <tt>
54 </p>
55 <hr />
56 <p>
57 Bad:
58 <tt>
59 </p>
60 <blockquote>
61 <p>
62 $plugin-&gt;errstr( Wx::gettext(&quot;Error when calling menu for plugin&quot;) . &quot;'$name': $@&quot; );
63 Plugin:%s - Not compatible with Padre::Plugin API. Need to be subclass of Padre::Plugin
64 </p>
65 </blockquote>
66 <p>
67 <tt>
68 </p>
69 <ul><ul><li>Do not concatenate strings in code. Use sprintf-style gettext templates.
70 </li><li>Do not write messages in newspaper headline style. Write full sentences in proper English.</li></ul></li></ul>
71 <p>
72 Better:
73 <tt>
74 </p>
75 <blockquote>
76 <p>
77 &quot;An error occured when calling the menu for the plugin %s: %s&quot;, $name, $@
78 The plugin %s is not compatible with the Padre::Plugin API. It needs to be a subclass of Padre::Plugin.
79 </p>
80 </blockquote>
81 <p>
82 <tt>
83 </p>
84 <hr />
85 <p>
86 Bad:
87 <tt>
88 </p>
89 <blockquote>
90 <p>
91 <a href="/wiki/GoTo">GoTo</a> Bookmark
92 <a href="/wiki/GoTo">GoTo</a> Element
93 </p>
94 </blockquote>
95 <p>
96 <tt>
97 </p>
98 <ul><ul><li>EnglishIsNotWrittenLikeThat</li></ul></li></ul>
99 <p>
100 Better:
101 <tt>
102 </p>
103 <blockquote>
104 <p>
105 Go to Bookmark
106 Go to Element
107 </p>
108 </blockquote>
109 <p>
110 <tt>
111 </p>
112 <hr />
113 <p>
114 Bad:
115 <tt>
116 </p>
117 <blockquote>
118 <p>
119 &amp;Close\tCtrl+W
120 Select all\tCtrl-A
121 </p>
122 </blockquote>
123 <p>
124 <tt>
125 </p>
126 <ul><ul><li>Do not invent a different notation for key combinations. Use consistently the symbol + to join keys.</li></ul></li></ul>
127 <p>
128 Better:
129 <tt>
130 </p>
131 <blockquote>
132 <p>
133 &amp;Close\tCtrl+W
134 Select all\tCtrl+A
135 </p>
136 </blockquote>
137 <p>
138 <tt>
139 </p>
140 <hr />
141 <p>
142 Bad:
143 <tt>
144 </p>
145 <blockquote>
146 <p>
147 Could not locate project dir
148 Cannot build regex for '%s'
149 Chars without spaces: %s
150 Convert EOL
151 </p>
152 </blockquote>
153 <p>
154 <tt>
155 </p>
156 <ul><ul><li>Do not use abbreviations. Use consistently the formal wording.</li></ul></li></ul>
157 <p>
158 Better:
159 <tt>
160 </p>
161 <blockquote>
162 <p>
163 Could not locate project directory
164 Cannot build regular expression for '%s'
165 Characters without spaces: %s
166 Convert line endings
167 </p>
168 </blockquote>
169 <p>
170 <tt>
171 </p>
172 <hr />
173 <p>
174 Bad:
175 <tt>
176 </p>
177 <blockquote>
178 <p>
179 The bookmark '%s' no longer exists
180 %s occurences were replaced
181 </p>
182 </blockquote>
183 <p>
184 <tt>
185 </p>
186 <ul><ul><li>Do not omit punctuation. Complete sentences with a full stop.</li></ul></li></ul>
187 <p>
188 Better:
189 <tt>
190 </p>
191 <blockquote>
192 <p>
193 The bookmark '%s' no longer exists.
194 %s occurences were replaced.
195 </p>
196 </blockquote>
197 <p>
198 <tt>
199 </p>
200 <hr />
201 <p>
202 Bad:
203 <tt>
204 </p>
205 <blockquote>
206 <p>
207 No diagnostics available for this error!
208 </p>
209 </blockquote>
210 <p>
211 <tt>
212 </p>
213 <ul><ul><li>Avoid excitement or shouting. Whereever possible, use mere statements of fact.</li></ul></li></ul>
214 <p>
215 Better:
216 <tt>
217 </p>
218 <blockquote>
219 <p>
220 No diagnostics are available for this error.
221 </p>
222 </blockquote>
223 <p>
224 <tt>
225 </p>
226 <hr />
227 <p>
228 Bad:
229 <tt>
230 </p>
231 <blockquote>
232 <p>
233 First character of selection does not seem to point at a token.
234 Selection not part of a Perl statement?
235 All braces appear to be matched
236 %s apparantly created. Do you want to open it now?
237 </p>
238 </blockquote>
239 <p>
240 <tt>
241 </p>
242 <ul><ul><li>Avoid vagueness. If the computer is not sure, the user certainly can't be, either. Whereever possible, use mere statements of fact. If you really cannot be sure, give the user more context or partial results so he can make an informed decision.</li></ul></li></ul>
243 <p>
244 Better:
245 <tt>
246 </p>
247 <blockquote>
248 <p>
249 The first character of the selection does not point at a token.
250 The selection is not part of a Perl statement.
251 All braces are matched.
252 %s was created. Do you want to open it now?
253 </p>
254 </blockquote>
255 <p>
256 <tt>
257 </p>
258 <hr />
259 <p>
260 Bad:
261 <tt>
262 </p>
263 <blockquote>
264 <p>
265 No declaration could be found for the specified (lexical?) variable
266 </p>
267 </blockquote>
268 <p>
269 <tt>
270 </p>
271 <ul><ul><li>Avoid overloading several circumstances into a single message. Split them off into several messages and match them according to the relevant situation.</li></ul></li></ul>
272 <p>
273 Better:
274 <tt>
275 </p>
276 <blockquote>
277 <p>
278 No declaration could be found for the specified package variable.
279 No declaration could be found for the specified lexical variable.
280 </p>
281 </blockquote>
282 <p>
283 <tt>
284 </p>
285 <hr />
286 <p>
287 Bad:
288 <tt>
289 </p>
290 <blockquote>
291 <p>
292 File changed on disk since last saved. Do you want to overwrite it?
293 </p>
294 </blockquote>
295 <p>
296 <tt>
297 </p>
298 <ul><ul><li>Avoid being overly specific in technical details. In this instance, there might not be a disk involved.</li></ul></li></ul>
299 <p>
300 Better:
301 <tt>
302 </p>
303 <blockquote>
304 <p>
305 The file has changed since the last save. Do you want to overwrite it?
306 </p>
307 </blockquote>
308 <p>
309 <tt>
310 </p>
311 <hr />
312 <p>
313 Bad:
314 <tt>
315 </p>
316 <blockquote>
317 <p>
318 Install Remote Distribution
319 </p>
320 </blockquote>
321 <p>
322 <tt>
323 </p>
324 <ul><ul><li>Avoid using words that have multiple similar meanings. Clarify with more or different wording.</li></ul></li></ul>
325 <p>
326 Better:
327 <tt>
328 </p>
329 <blockquote>
330 <p>
331 Install Distribution from the Web
332 </p>
333 </blockquote>
334 <p>
335 <tt>
336 </p>
337 <hr />
338 <p>
339 Bad:
340 <tt>
341 </p>
342 <blockquote>
343 <p>
344 TAB display size (in spaces):
345 Next File\tCtrl-TAB
346 Encode document to utf-8
347 </p>
348 </blockquote>
349 <p>
350 <tt>
351 </p>
352 <ul><ul><li>Use proper capitalisation. Be aware of what is an acronym and what is not.</li></ul></li></ul>
353 <p>
354 Better:
355 <tt>
356 </p>
357 <blockquote>
358 <p>
359 Tabulator display size (in spaces):
360 Next File\tCtrl+Tab
361 Encode document to UTF-8
362 </p>
363 </blockquote>
364 <p>
365 <tt>
366 </p>
367 <hr />
368 <p>
369 Bad:
370 <tt>
371 </p>
372 <blockquote>
373 <p>
374 &amp;Open\tCtrl+O
375 </p>
376 </blockquote>
377 <p>
378 <tt>
379 </p>
380 <ul><ul><li>Menu items and buttons that open a dialog or require further user action end in an ellipsis… Menu items and buttons that result in immediate action do not end in an ellipsis.</li></ul></li></ul>
381 <p>
382 Better:
383 <tt>
384 </p>
385 <blockquote>
386 <p>
387 &amp;Open…\tCtrl+O
388 </p>
389 </blockquote>
390 <p>
391 <tt>
392 </p>