|
1 |
| -%!encoding: iso-8859-1 |
| 1 | +Quantum GIS (QGIS) |
2 | 2 |
|
| 3 | +Developers guide for QGIS |
3 | 4 |
|
| 5 | +%! target : html |
| 6 | +%! style : style.css |
| 7 | +%! Options : --toc --toc-level 3 --enum-title --css-sugar --css-inside |
| 8 | +%! preproc : TUT_URL https://qgis.org |
| 9 | +%! PostProc(html): '(?i)(<pre>)' '<div class="code">\1' |
| 10 | +%! PostProc(html): '(?i)(</pre>)' '\1</div>' |
| 11 | +%! encoding: iso-8859-1 |
4 | 12 | % These are comments and will not be generated in any output
|
5 | 13 | % -------------------
|
6 | 14 |
|
|
9 | 17 | %txt2tags home page for more details. Please insert manual line breaks in this
|
10 | 18 | %document as it makes diffing for changes much easier. To do this in vim
|
11 | 19 | %automatically, select a section then issue (gq) command. Please dont
|
12 |
| -%apply vim formatting to the whole document as it screws up some formatting |
| 20 | +%apply vim formatting to the whol document as it screws up some formatting |
13 | 21 | %rather apply it selectively to paragraphs where needed.
|
14 | 22 |
|
15 | 23 | % To generate the text version of this document:
|
16 |
| -% txt2tags -t txt --toc --enum-title -o CODING CODING.t2t |
| 24 | +% txt2tags -t txt -o CODING CODING.t2t |
17 | 25 | % To generate the moinmoin version of this document
|
18 |
| -% txt2tags -t moin --toc --enum-title -o CODING.moin CODING.t2t |
19 |
| - |
| 26 | +% txt2tags -t moin CODING.moin CODING.t2t |
| 27 | +% To generate the html version of this document |
| 28 | +% txt2tags -t html CODING.html CODING.t2t |
| 29 | +% |
20 | 30 | % End of comments
|
21 | 31 | % -------------------
|
22 | 32 |
|
@@ -1075,20 +1085,23 @@ guidelines are followed in layout and design of GUIs.
|
1075 | 1085 | + Group related elements using group boxes:
|
1076 | 1086 | Try to identify elements that can be grouped together and then use
|
1077 | 1087 | group boxes with a label identify the topic of that group.
|
| 1088 | + Avoid using group boxes with only a single widget / item inside. |
1078 | 1089 | + Capitalise first letter only in group box labels:
|
1079 | 1090 | Group box labels should be written as a phrase with leading capital letter,
|
1080 | 1091 | and all remaing words written with lower case first letters
|
1081 | 1092 | + Do not end labels for widgets or group boxes with a colon:
|
1082 | 1093 | Adding a colon causes visual noise and does not impart additional meaning,
|
1083 |
| - so dont use them. |
| 1094 | + so dont use them. An exception to this rule is when you have two labels |
| 1095 | + next to each other e.g.: Label1 [Plugin Path:] Label2 [/path/to/plugins] |
1084 | 1096 | + Keep harmful actions away from harmless ones:
|
1085 | 1097 | If you have actions for 'delete', 'remove' etc, try to impose adequate
|
1086 | 1098 | space between the harmful action and innocuous actions so that the users
|
1087 | 1099 | is less likely to inadvertantly click on the harmful action.
|
1088 |
| - + Always use a QButtonBox for 'Ok', 'Cancel' etc buttons: |
1089 |
| - Using a button box will ensure that the order of 'Ok' and 'Cancel' etc, |
| 1100 | + + Always use a QButtonBox for 'OK', 'Cancel' etc buttons: |
| 1101 | + Using a button box will ensure that the order of 'OK' and 'Cancel' etc, |
1090 | 1102 | buttons is consistent with the operating system / locale / desktop
|
1091 | 1103 | environment that the user is using.
|
| 1104 | + |
1092 | 1105 |
|
1093 | 1106 | = Authors =
|
1094 | 1107 |
|
|
0 commit comments