Skip to content

Commit 7763ef7

Browse files
timlinuxtimlinux
committed
More fixes for merge of install and coding docs. Added generated pdfs to git
1 parent c9c530f commit 7763ef7

File tree

7 files changed

+75
-167
lines changed

7 files changed

+75
-167
lines changed

‎CODING.pdf

348 KB
Binary file not shown.

‎INSTALL

Lines changed: 5 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
Quantum GIS (QGIS)
22
Building QGIS from source - step by step
3+
Thursday May 26, 2011
34

45

5-
Last update: 20110526
6-
Last change: 20110526
6+
Last Updated: Thursday May 26, 2011
7+
Last Change : Thursday May 26, 2011
78

89

910
1. Introduction
@@ -29,10 +30,7 @@ Last change: 20110526
2930
5.4. QGIS source
3031
5.5. Configure the build
3132
5.6. Building
32-
6. git
33-
6.1. Installation
34-
6.2. Get QGIS from git
35-
7. Authors and Acknowledgments
33+
6. Authors and Acknowledgments
3634

3735

3836
1. Introduction
@@ -1583,68 +1581,7 @@ or, for an /Applications build:
15831581
sudo make install
15841582

15851583

1586-
6. git
1587-
======
1588-
1589-
1590-
6.1. Installation
1591-
=================
1592-
1593-
Optional. If you want to try different branches and/or easily update the source when changes are made, install git and clone the source. For random just-want-to-see-what's-going-on-in-development builds, download a tarbal from github.
1594-
1595-
1596-
6.1.1. Install git for GNU/Linux
1597-
================================
1598-
1599-
1600-
6.1.2. install git for Windows
1601-
==============================
1602-
1603-
1604-
6.1.3. Install git for OSX
1605-
==========================
1606-
1607-
The git (http://git-scm.com/) project has a downloadable build of git.
1608-
Make sure to get the package matching your processor (x86_64 most likely, only the first Intel Macs need the i386 package).
1609-
1610-
Once downloaded open the disk image and run the installer.
1611-
1612-
PPC/source note
1613-
1614-
The git site does not offer PPC builds. If you need a PPC build, or you just want
1615-
a little more control over the installation, you need to compile it yourself.
1616-
1617-
Download the source from http://git-scm.com/. Unzip it, and in a Terminal cd to the source folder, then:
1618-
1619-
make prefix=/usr/local
1620-
sudo make prefix=/usr/local install
1621-
1622-
If you don't need any of the extras, Perl, Python or TclTk (GUI), you can disable them before running make with:
1623-
1624-
export NO_PERL=
1625-
export NO_TCLTK=
1626-
export NO_PYTHON=
1627-
1628-
1629-
6.2. Get QGIS from git
1630-
======================
1631-
1632-
You can download a development tarball (no git installation needed) from:
1633-
1634-
http://github.com/qgis/Quantum-GIS
1635-
1636-
This defaults to the current master, but you can select any other branch or tag as desired.
1637-
1638-
Or for more long-term testing of development sources: clone the sources with git (in an appropriate location on your computer):
1639-
1640-
git clone git://github.com/qgis/Quantum-GIS.git
1641-
1642-
This automatically activates the master. To switch to another branch:
1643-
1644-
git checkout [branchname]
1645-
1646-
1647-
7. Authors and Acknowledgments
1584+
6. Authors and Acknowledgments
16481585
==============================
16491586

16501587
The following people have contributed to this document:

‎INSTALL.pdf

442 KB
Binary file not shown.

‎doc/CODING.t2t

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,37 @@ Developers guide for QGIS
1212
%! PostProc(txt): '(?i)(\t)' ' '
1313
%! encoding: iso-8859-1
1414

15+
%
16+
% Tex processing
17+
%
18+
% Make sure this is first
19+
%! PostProc(tex): '\\includegraphics' '\\includegraphics[width=100mm]'
20+
% scartcl is from the koma script document class (apt-get install texlive-latex-recommended ttf-komatuna)
21+
% setlength parindent suppresses first line of paragraph idents
22+
% parskip puts blank space between paragraphs
23+
% title pic stuff used to put a logo on the front page
24+
%! PostProc(tex): '\\documentclass{article}' '\\documentclass{scrartcl}\n\\setlength{\\parindent}{0pt}\n\\setlength{\\parskip}{2ex}'
25+
% use the color table and table packages so we can pimp the tables a little
26+
%! PostProc(tex): '\\usepackage{style.css} % user defined' '\\usepackage{fancyvrb}\n\\usepackage{colortbl} \n\\usepackage [table]{xcolor}\n\\definecolor{tableShade}{HTML}{cecece}\n\\definecolor{qgis-green}{HTML}{0E7300}\n\\usepackage{wallpaper}\n\\LRCornerWallPaper{1}{WALLPAPER-IMAGE}\n\\usepackage{hyperref}\n\\hypersetup{linkcolor=qgis-green,urlcolor=qgis-green}\\renewcommand\\thesection{\\color{qgis-green}\\thechapter\\arabic{section}}'
27+
% Make the header row of tables have a dark background. light text
28+
%! PostProc(tex): '\\hline \\textbf' '\\hline \\rowcolor[rgb]{0,0,0} \\color{white} \\textbf'
29+
%! PostProc(tex): '& \\textbf' '& \\color{white} \\textbf'
30+
% Make verbatim text a little smaller and use fancyvrb package to draw it in a box
31+
% Note Verbatim with capital V for fancyvrb to work
32+
%! PostProc(tex): '\\begin{verbatim}' '{\\scriptsize\\begin{Verbatim}[frame=single,rulecolor=\\color{qgis-green}, framesep=4mm, label=\\fbox{\\small\\emph{Listing}}]'
33+
%! PostProc(tex): '\\end{verbatim}' '\\end{Verbatim}\n}'
34+
%! PostProc(tex): '\\section' '\\newpage\\section'
35+
%! PostProc(tex): 'section{' 'section{\\color{qgis-green}'
36+
%! PostProc(tex): NEWPAGE '\\newpage'
37+
% Give alternating table rows different colours and use a smaller font in tables (\tiny)
38+
%! PostProc(tex): '\\begin{tabular}' '\\rowcolors{2}{tableShade}{white} \n\\tiny\\begin{tabular}'
39+
%! encoding: iso-8859-1
1540

41+
%! PostProc(tex): WALLPAPER-IMAGE 'qgis-footer.png'
1642
% These are comments and will not be generated in any output
1743
% -------------------
1844

19-
%This document is in text2tags format. You can generate html, plain text and
45+
%This document is in txt2tags format. You can generate html, plain text and
2046
%moinmoin formatted documentation by running txt2tags on this document. See the
2147
%txt2tags home page for more details. Please insert manual line breaks in this
2248
%document as it makes diffing for changes much easier. To do this in vim
@@ -26,12 +52,13 @@ Developers guide for QGIS
2652

2753
% To generate the text version of this document:
2854
% txt2tags -t txt -o CODING CODING.t2t
29-
% To generate the moinmoin version of this document:
30-
% txt2tags -t moin -o CODING.moin CODING.t2t
55+
% To generate the mediawiki version of this document:
56+
% txt2tags -t wiki --no-enum-title -o CODING.wiki CODING.t2t
3157
% To generate the html version of this document:
3258
% txt2tags -t html -o CODING.html CODING.t2t
3359
% To generate the LaTeX version of this document:
34-
% txt2tags -t tex -o CODING.tex CODING.t2t
60+
% txt2tags -t tex -o CODING.tex CODING.t2t; pdflatex CODING.tex
61+
3562
%
3663
% End of comments
3764
% -------------------
@@ -389,6 +416,7 @@ sudo apt-get install git
389416
Windows users can obtain [msys git http://code.google.com/p/msysgit/].
390417

391418

419+
392420
== Accessing the Repository ==
393421

394422
To clone QGIS master:

‎doc/INSTALL.html

Lines changed: 7 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -44,13 +44,14 @@
4444

4545
<DIV CLASS="header" ID="header">
4646
<H1>Quantum GIS (QGIS)</H1>
47-
<H3>Building QGIS from source - step by step</H3>
47+
<H2>Building QGIS from source - step by step</H2>
48+
<H3>Thursday May 26, 2011</H3>
4849
</DIV>
4950

5051
<DIV CLASS="body" ID="body">
5152
<P>
52-
Last update: 20110526
53-
Last change: 20110526
53+
Last Updated: Thursday May 26, 2011
54+
Last Change : Thursday May 26, 2011
5455
</P>
5556
<DIV CLASS="toc">
5657

@@ -84,12 +85,7 @@ <H3>Building QGIS from source - step by step</H3>
8485
<LI><A HREF="#toc22">5.5. Configure the build</A>
8586
<LI><A HREF="#toc23">5.6. Building</A>
8687
</UL>
87-
<LI><A HREF="#git">git</A>
88-
<UL>
89-
<LI><A HREF="#toc25">6.1. Installation</A>
90-
<LI><A HREF="#toc26">6.2. Get QGIS from git</A>
91-
</UL>
92-
<LI><A HREF="#toc27">Authors and Acknowledgments</A>
88+
<LI><A HREF="#toc24">Authors and Acknowledgments</A>
9389
</OL>
9490

9591
</DIV>
@@ -2217,85 +2213,8 @@ <H2>5.6. Building</H2>
22172213
sudo make install
22182214
</PRE></div>
22192215

2220-
<A NAME="git"></A>
2221-
<H1>6. git</H1>
2222-
2223-
<A NAME="toc25"></A>
2224-
<H2>6.1. Installation</H2>
2225-
2226-
<P>
2227-
Optional. If you want to try different branches and/or easily update the source when changes are made, install git and clone the source. For random just-want-to-see-what's-going-on-in-development builds, download a tarbal from github.
2228-
</P>
2229-
2230-
<H3>6.1.1. Install git for GNU/Linux</H3>
2231-
2232-
<H3>6.1.2. install git for Windows</H3>
2233-
2234-
<H3>6.1.3. Install git for OSX</H3>
2235-
2236-
<P>
2237-
The <A HREF="http://git-scm.com/">git</A> project has a downloadable build of git.
2238-
Make sure to get the package matching your processor (x86_64 most likely, only the first Intel Macs need the i386 package).
2239-
</P>
2240-
<P>
2241-
Once downloaded open the disk image and run the installer.
2242-
</P>
2243-
<P>
2244-
<U>PPC/source note</U>
2245-
</P>
2246-
<P>
2247-
The git site does not offer PPC builds. If you need a PPC build, or you just want
2248-
a little more control over the installation, you need to compile it yourself.
2249-
</P>
2250-
<P>
2251-
Download the source from <A HREF="http://git-scm.com/">http://git-scm.com/</A>. Unzip it, and in a Terminal cd to the source folder, then:
2252-
</P>
2253-
2254-
<div class="code"><PRE>
2255-
make prefix=/usr/local
2256-
sudo make prefix=/usr/local install
2257-
</PRE></div>
2258-
2259-
<P>
2260-
If you don't need any of the extras, Perl, Python or TclTk (GUI), you can disable them before running make with:
2261-
</P>
2262-
2263-
<div class="code"><PRE>
2264-
export NO_PERL=
2265-
export NO_TCLTK=
2266-
export NO_PYTHON=
2267-
</PRE></div>
2268-
2269-
<A NAME="toc26"></A>
2270-
<H2>6.2. Get QGIS from git</H2>
2271-
2272-
<P>
2273-
You can download a development tarball (no git installation needed) from:
2274-
</P>
2275-
<P>
2276-
<A HREF="http://github.com/qgis/Quantum-GIS">http://github.com/qgis/Quantum-GIS</A>
2277-
</P>
2278-
<P>
2279-
This defaults to the current master, but you can select any other branch or tag as desired.
2280-
</P>
2281-
<P>
2282-
Or for more long-term testing of development sources: clone the sources with git (in an appropriate location on your computer):
2283-
</P>
2284-
2285-
<div class="code"><PRE>
2286-
git clone git://github.com/qgis/Quantum-GIS.git
2287-
</PRE></div>
2288-
2289-
<P>
2290-
This automatically activates the master. To switch to another branch:
2291-
</P>
2292-
2293-
<div class="code"><PRE>
2294-
git checkout [branchname]
2295-
</PRE></div>
2296-
2297-
<A NAME="toc27"></A>
2298-
<H1>7. Authors and Acknowledgments</H1>
2216+
<A NAME="toc24"></A>
2217+
<H1>6. Authors and Acknowledgments</H1>
22992218

23002219
<P>
23012220
The following people have contributed to this document:

‎doc/INSTALL.t2t

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
Quantum GIS (QGIS)
2-
32
Building QGIS from source - step by step
4-
3+
%%date(%A %B %d, %Y)
54

65
%! target : html
76
%! style : style.css
@@ -12,6 +11,33 @@ Building QGIS from source - step by step
1211
% Next line will replace tabs with 2 spaces in txt generated outputs
1312
%! PostProc(txt): '(?i)(\t)' ' '
1413
%! encoding: iso-8859-1
14+
%
15+
% Tex processing
16+
%
17+
% Make sure this is first
18+
%! PostProc(tex): '\\includegraphics' '\\includegraphics[width=100mm]'
19+
% scartcl is from the koma script document class (apt-get install texlive-latex-recommended ttf-komatuna)
20+
% setlength parindent suppresses first line of paragraph idents
21+
% parskip puts blank space between paragraphs
22+
% title pic stuff used to put a logo on the front page
23+
%! PostProc(tex): '\\documentclass{article}' '\\documentclass{scrartcl}\n\\setlength{\\parindent}{0pt}\n\\setlength{\\parskip}{2ex}'
24+
% use the color table and table packages so we can pimp the tables a little
25+
%! PostProc(tex): '\\usepackage{style.css} % user defined' '\\usepackage{fancyvrb}\n\\usepackage{colortbl} \n\\usepackage [table]{xcolor}\n\\definecolor{tableShade}{HTML}{cecece}\n\\definecolor{qgis-green}{HTML}{0E7300}\n\\usepackage{wallpaper}\n\\LRCornerWallPaper{1}{WALLPAPER-IMAGE}\n\\usepackage{hyperref}\n\\hypersetup{linkcolor=qgis-green,urlcolor=qgis-green}\\renewcommand\\thesection{\\color{qgis-green}\\thechapter\\arabic{section}}'
26+
% Make the header row of tables have a dark background. light text
27+
%! PostProc(tex): '\\hline \\textbf' '\\hline \\rowcolor[rgb]{0,0,0} \\color{white} \\textbf'
28+
%! PostProc(tex): '& \\textbf' '& \\color{white} \\textbf'
29+
% Make verbatim text a little smaller and use fancyvrb package to draw it in a box
30+
% Note Verbatim with capital V for fancyvrb to work
31+
%! PostProc(tex): '\\begin{verbatim}' '{\\scriptsize\\begin{Verbatim}[frame=single,rulecolor=\\color{qgis-green}, framesep=4mm, label=\\fbox{\\small\\emph{Listing}}]'
32+
%! PostProc(tex): '\\end{verbatim}' '\\end{Verbatim}\n}'
33+
%! PostProc(tex): '\\section' '\\newpage\\section'
34+
%! PostProc(tex): 'section{' 'section{\\color{qgis-green}'
35+
%! PostProc(tex): NEWPAGE '\\newpage'
36+
% Give alternating table rows different colours and use a smaller font in tables (\tiny)
37+
%! PostProc(tex): '\\begin{tabular}' '\\rowcolors{2}{tableShade}{white} \n\\tiny\\begin{tabular}'
38+
%! encoding: iso-8859-1
39+
40+
%! PostProc(tex): WALLPAPER-IMAGE 'qgis-footer.png'
1541
% These are comments and will not be generated in any output
1642
% -------------------
1743

@@ -30,13 +56,13 @@ Building QGIS from source - step by step
3056
% To generate the html version of this document:
3157
% txt2tags -t html -o INSTALL.html INSTALL.t2t
3258
% To generate the LaTeX version of this document:
33-
% txt2tags -t tex -o INSTALL.tex INSTALL.t2t
59+
% txt2tags -t tex -o INSTALL.tex INSTALL.t2t; pdflatex INSTALL.tex
3460

3561
% End of comments
3662
% -------------------
3763

38-
Last update: %%date
39-
Last change: %%mtime
64+
Last Updated: %%date(%A %B %d, %Y)
65+
Last Change : %%mtime(%A %B %d, %Y)
4066

4167
%%toc
4268

@@ -86,6 +112,4 @@ source directory.
86112

87113
%!include: osx.t2t
88114

89-
%!include: git.t2t
90-
91115
%!include: iauthors.t2t

‎doc/qgis-footer.png

109 KB
Loading

0 commit comments

Comments
 (0)