Skip to content

Commit 00d6fea

Browse files
author
timlinux
committedMay 21, 2008
Moved text2tags sources into docs dir.
Made some minor updates to coding.t2t git-svn-id: http://svn.osgeo.org/qgis/trunk/qgis@8480 c8812cc2-4d05-0410-92ff-de0c093fc19c

File tree

2 files changed

+34
-14
lines changed

2 files changed

+34
-14
lines changed
 

‎CODING.t2t renamed to ‎doc/CODING.t2t

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
1-
%!encoding: iso-8859-1
1+
Quantum GIS (QGIS)
22

3+
Developers guide for QGIS
34

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
412
% These are comments and will not be generated in any output
513
% -------------------
614

@@ -9,14 +17,16 @@
917
%txt2tags home page for more details. Please insert manual line breaks in this
1018
%document as it makes diffing for changes much easier. To do this in vim
1119
%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
1321
%rather apply it selectively to paragraphs where needed.
1422

1523
% 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
1725
% 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+
%
2030
% End of comments
2131
% -------------------
2232

@@ -1075,20 +1085,23 @@ guidelines are followed in layout and design of GUIs.
10751085
+ Group related elements using group boxes:
10761086
Try to identify elements that can be grouped together and then use
10771087
group boxes with a label identify the topic of that group.
1088+
Avoid using group boxes with only a single widget / item inside.
10781089
+ Capitalise first letter only in group box labels:
10791090
Group box labels should be written as a phrase with leading capital letter,
10801091
and all remaing words written with lower case first letters
10811092
+ Do not end labels for widgets or group boxes with a colon:
10821093
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]
10841096
+ Keep harmful actions away from harmless ones:
10851097
If you have actions for 'delete', 'remove' etc, try to impose adequate
10861098
space between the harmful action and innocuous actions so that the users
10871099
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,
10901102
buttons is consistent with the operating system / locale / desktop
10911103
environment that the user is using.
1104+
10921105

10931106
= Authors =
10941107

‎INSTALL.t2t renamed to ‎doc/INSTALL.t2t

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
11
Quantum GIS (QGIS)
2-
Building QGIS from source - step by step
3-
4-
%!encoding: iso-8859-1
52

3+
Building QGIS from source - step by step
64

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
712
% These are comments and will not be generated in any output
813
% -------------------
914

@@ -16,9 +21,11 @@ Building QGIS from source - step by step
1621
%rather apply it selectively to paragraphs where needed.
1722

1823
% To generate teh text version of this document:
19-
% txt2tags -t txt --toc --enum-title -o INSTALL INSTALL.t2t
24+
% txt2tags -t txt -o INSTALL INSTALL.t2t
2025
% To generate the moinmoin version of this document
21-
% txt2tags -t moin --toc --enum-title -o INSTALL.moin INSTALL.t2t
26+
% txt2tags -t moin INSTALL.moin INSTALL.t2t
27+
% To generate the html version of this document
28+
% txt2tags -t html INSTALL.html INSTALL.t2t
2229

2330
% End of comments
2431
% -------------------
@@ -83,7 +90,7 @@ For complete information, see the wiki at:
8390
* Flex, Bison
8491

8592
'''Required runtime deps:'''
86-
* Qt >= 4.2.0
93+
* Qt >= 4.3.0
8794
* Proj >= ? (known to work with 4.4.x)
8895
* GEOS >= 2.2 (3.0 is supported, maybe 2.1.x works too)
8996
* Sqlite3 >= ? (probably 3.0.0)

0 commit comments

Comments
 (0)
Please sign in to comment.