/[thuban]/branches/WIP-pyshapelib-bramz/Doc/manual/thuban-manual.xml
ViewVC logotype

Annotation of /branches/WIP-pyshapelib-bramz/Doc/manual/thuban-manual.xml

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2447 - (hide annotations)
Mon Dec 13 11:53:15 2004 UTC (20 years, 2 months ago) by frank
Original Path: trunk/thuban/Doc/manual/thuban-manual.xml
File MIME type: text/xml
File size: 86955 byte(s)
Added documentation of Alternative Path feature

1 bh 1367 <?xml version="1.0" encoding="ISO-8859-1"?>
2     <!DOCTYPE book
3     PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
4 jonathan 1490 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
5 frank 2023 [<!ENTITY imgscale "60">]>
6 bh 1369 <!-- $Revision$ -->
7 bh 1367 <book>
8     <bookinfo>
9 jan 1570 <title>User's Manual for Thuban 1.0</title>
10     <authorgroup>
11     <author>
12     <firstname>Jonathan</firstname><surname>Coles</surname>
13     </author>
14     <author>
15     <firstname>Jan-Oliver</firstname><surname>Wagner</surname>
16     </author>
17     <author>
18     <firstname>Frank</firstname><surname>Koormann</surname>
19     </author>
20     </authorgroup>
21 bh 1367 <copyright>
22 frank 2052 <year>2003, 2004</year>
23 bh 1367 <holder>Intevation GmbH</holder>
24     </copyright>
25 jan 1570 <revhistory>
26 jan 1624 <!-- comment this first revision out when releasing a real version -->
27 jan 1570 <revision>
28 jan 1689 <revnumber>CVS version $Id$</revnumber>
29     <date></date>
30 jan 1624 <revremark>Under development.</revremark>
31     </revision>
32     <revision>
33 frank 2052 <revnumber>1.0.0</revnumber>
34     <date>22-Jan-2004</date>
35     <revremark>
36     Corresponds to Thuban 1.0.0.
37     New: Installation instructions for Win32.
38     </revremark>
39     </revision>
40     <revision>
41 frank 2023 <revnumber>1.0pre3</revnumber>
42     <date>04-Dec-2003</date>
43     <revremark>
44 frank 2052 Corresponds to Thuban 1.0rc1.
45 frank 2023 New: I18n, right button legend menu, EPSG projectons,
46     PostGIS support.
47     </revremark>
48     </revision>
49     <revision>
50 jan 1689 <revnumber>1.0pre2</revnumber>
51     <date>29-Aug-2003</date>
52     <revremark>
53     Corresponds to Thuban development release 0.8.1.
54     New: chapter on extensions.
55     </revremark>
56     </revision>
57     <revision>
58 jan 1570 <revnumber>1.0pre1</revnumber>
59     <date>08-Aug-2003</date>
60 jan 1689 <revremark>Corresponds to Thuban development release 0.8.1.</revremark>
61 jan 1570 </revision>
62     </revhistory>
63    
64 bh 1367 </bookinfo>
65    
66     <chapter><title>Introduction</title>
67     <para>
68 jan 1544 Thuban is an interactive geographic data viewer.
69 jan 2311 Its development had been started because there was no simple interactive
70 jonathan 1446 viewer for geographic information available as Free Software. Thuban is
71 jan 2311 written mainly in Python and uses the wxWidgets (former wxWindows)
72     library allowing it to
73 jonathan 1446 run on many different platforms, including GNU/Linux and Windows.
74 bh 1367 </para>
75 jonathan 1446 <para>
76 jan 1544 Geographic data viewers are a necessary tool as they allow one to
77     get a visual
78 jonathan 1446 impression of the positional relationship of the information that may not
79     be apparent from simple inspection of the data values themselves.
80     Thuban allows the user to create a session that displays
81     geographic data and then explore that data through navigation and
82     manipulation of how it is drawn. The results can then be saved or printed.
83     </para>
84     <para>
85     Thuban arranges a session in a hierarchy. A session contains a map which
86 jan 2311 consists of layers. Each layer represents a data set. For
87 jonathan 1446 instance, there may be a layer for roads and another layer for buildings.
88     These layers can either be vector shapes or images.
89     </para>
90 jan 1423
91     <section><title>Installation</title>
92 jonathan 1446 <para>
93     Thuban is actively supported under Debian Testing (sarge), RedHat 7.2,
94 jonathan 1533 and Windows 2000. Thuban depends on the following packages. These
95     packages can also be found on the
96 jonathan 1446 <ulink url="http://thuban.intevation.org/download.html">
97     Thuban Download site
98     </ulink>.
99 frank 2023 </para>
100     <para>
101     Required:
102 frank 1532 <itemizedlist>
103 frank 2052 <listitem><para>Python 2.2.1
104     (<literal>http://www.python.org</literal>)
105     </para></listitem>
106     <listitem><para>wxWindows 2.4
107     (<literal>http://www.wxwindows.org</literal>)
108     </para></listitem>
109     <listitem><para>wxPython 2.4
110     (<literal>http://www.wxpython.org</literal>)
111     </para></listitem>
112     <listitem><para>proj 4.4.5 Projection Library
113     (<literal>http://www.remotesensing.org/proj/</literal>)
114     </para></listitem>
115     <listitem><para>SQLite 2.8.3
116     <literal>http://www.hwaci.com/sw/sqlite/</literal>)
117     </para></listitem>
118     <listitem><para>PySQLite 0.4.3
119     (<literal>http://pysqlite.sourceforge.net</literal>)
120     </para></listitem>
121 frank 2023 </itemizedlist>
122     </para>
123     <para>
124     Optional:
125     <itemizedlist>
126 frank 2052 <listitem><para>GDAL 1.1.8
127     (<literal>http://www.remotesensing.org/gdal/</literal>)
128     </para></listitem>
129     <listitem><para>psycopg 1.0.8
130     (<literal>http://initd.org/software/psycopg</literal>)
131     </para></listitem>
132 jonathan 1533 </itemizedlist>
133 jonathan 1446 </para>
134 jan 1544 <para>
135 frank 2052 Along with the source codes, the download page also offers full
136     installation packages for Debian, Windows and RPM-based systems
137 jan 1544 (Mandrake, RedHat, SuSE, etc).
138     </para>
139 jan 1719 <section><title>RPM-based GNU/Linux Systems</title>
140     <section><title>Installing Binary Packages</title>
141     <para>
142 frank 2052 The most wide-spread RPM-based GNU/Linux
143     Systems are RedHat, Mandrake and SuSE.
144     The documentation of these distributions
145     should contain information about how to
146     install third-party RPM packages.
147     Nonetheless, a short summary is provided here.
148 jan 1719 </para>
149     <para>
150 frank 2052 RPM packages can be installed applying several
151     tools. The most basic one is the command line
152     program "rpm". The hardware architecture is
153     identified in the name of RPM packages, eg.
154     'i386' for most Intel/AMD architectures.
155     If you have a different hardware architecture,
156     where no binary RPM packages are provided,
157     you must rebuild binary packages from the
158     RPM source packages first (see below).
159 jan 1719 Typical rpm commands look like:
160    
161     <programlisting>
162     rpm --install Thuban-0.9.0-1.i386.rpm
163     </programlisting>
164    
165 frank 2052 Depending on what you already have installed
166     on your system, you are informed that some
167     packages are required, but not installed.
168     You need to install them first. Either they
169     are provided by your GNU/Linux distributor
170     or available somewhere on the Internet.
171     The more essential and special ones are
172     provided together with the Thuban package.
173 jan 1719 </para>
174    
175     <para>
176     For rpm exist some graphical user interfaces, notably
177     kpackage, GnoRPM and xrpm.
178     </para>
179    
180     <para>
181     Make yourself familiar with one of the tools and apply it
182     to install the packages.
183     Note, that you need to be administrator (root) for the system
184     to do that.
185     </para>
186     </section>
187     <section><title>Build Binaries from Source Packages</title>
188     <para>
189     This section describes howto build RPM install-packages
190     from RPM source-packages.
191     This adapts and optimizes an install-package specifically
192     to your system.
193     This is especially helpful to resolve version conflicts of
194     dependent packages. Furthermore, install-packages for other
195     platforms (e.g. PowerPC) can be created.
196     </para>
197    
198     <para>
199     Note: rpm must be at least version 4. Execute
200     <literal>rpm --version</literal> to find out about the version.
201     </para>
202    
203     <para>
204     You need to do the following preparations to be able to
205     build the packages as a regular user. You should now
206     perform the package buling as root since this
207     might cause damage to your system.
208     <itemizedlist>
209     <listitem>
210     <para>
211     Create RPM directory structure:
212     Choose a directory (e.g. $HOME/myrpm) and create the
213     subdirectories BUILD, RPM, SOURCES, SPECS and SRPMS.
214     A possible command sequence for this is:
215     <programlisting>
216     mkdir $HOME/freegisrpm
217     cd $HOME/freegisrpm
218     mkdir BUILD RPMS SOURCES SPECS SRPMS
219     </programlisting>
220     </para>
221     </listitem>
222     <listitem>
223     <para>
224     Set environment variable RPM_DIR:
225     <programlisting>
226     export RPM_DIR=$HOME/freegisrpm
227     </programlisting>
228     </para>
229     </listitem>
230     <listitem>
231     <para>
232     Create $HOME/.rpmmacros:
233     This file sets general preferences and some
234     specific settings for signing packages.
235     If you don't have a GnuPG-key, you can skip
236     the signature settings i.e. drop the last 4 lines.
237     A signature becomes important when you want to
238     give away packages to third parties.
239     <programlisting>
240     <![CDATA[
241     %packager Name Lastname <[email protected]>
242    
243     %_topdir /home/mylogin/myrpm
244    
245     %_signature gpg
246     %_gpg_name Name Lastname
247     %_pgp_path ~/.gnupg
248     %_pgpbin /usr/bin/gpg
249     ]]>
250     </programlisting>
251     </para>
252     </listitem>
253     </itemizedlist>
254    
255     Now you can install any RPM source-package.
256     It's components are installed into the corresponding
257     subdirectories of your rpm-directory.
258     Essentially these are the sources (into directory SOURCES)
259     and the so-called spec-file which contains all build
260     instructions. The spec-file will go into the SPEC directory.
261     Example:
262     <literal>rpm --install Thuban-0.9.0-1.src.rpm</literal>
263     </para>
264    
265     <para>
266     Create install-package:
267     Go to the directory with the spec-files and rebuild the
268     package:
269     <programlisting>
270     cd $HOME/mypm/SPECS
271     rpm -bb thuban.spec
272     </programlisting>
273     Next, you will find the newly created package in
274     $HOME/myrpm/RPMS/i386.
275     If you build the package for another architecture than
276     i386, then the name of the directory has a corresponding name.
277     </para>
278     <para>
279     For documentation of RPM, either type
280     <literal>man rpm</literal> or <literal>rpm --help</literal>.
281     This will provide you with information on the various command
282     line options of RPM.
283     For more information see the
284     <ulink url="http://www.rpm.org/">homepage of RPM</ulink>.
285     </para>
286     </section>
287 frank 2052 </section> <!-- Intro - Installation - RPM-->
288    
289     <section><title>Win32 Systems</title>
290     <para>
291     A common installation package of Thuban for Win32
292     systems is available from the Thuban website download
293     section. This installation package is configured for
294     displaying file based vector data (Shapefiles). For the
295     display of raster data or the connection to spatial
296     databases additional steps are needed.
297     </para>
298     <para>
299     The required Python packages are listed and linked on
300     the download page as well. If you don't have Python
301     installed already, download the packages for Python,
302     wxPython for Python and the SQLite Python Libraries as
303     well as the Thuban package. Install all four packages
304     in the order: Python, wxPython, SQLite, Thuban. Follow
305     the installation instructions provided by the seperate
306     setups. The Thuban installation package will add an
307     entry in the menu folder you configured.
308     </para>
309     <section><title>Raster Data: Installation of GDAL</title>
310     <para>
311     Enabling the raster data features of Thuban is
312     straight forward. For the examples we assume that
313     Thuban has been installed under
314     <literal>C:\Thuban</literal>:
315     <itemizedlist>
316     <listitem>
317     <para>
318     Download the zip-archive <ulink
319     url="ftp://intevation.de/thuban/win2k/gdal-win2k.zip"
320     >gdal-win2k</ulink>.
321     </para></listitem>
322     <listitem><para>Extract the archive (e.g. with
323     <ulink
324     url="http://www.info-zip.org/pub/infozip/WiZ.html"
325     >WiZ (InfoZip)</ulink>) into the
326     <literal>C:\Thuban\Lib</literal>
327     directory of your Thuban installation.
328     </para>
329     </listitem>
330     <listitem>
331     <para>
332     Extent the <varname>PYTHONPATH</varname>
333     environment variable (in your Windows Control Panel)
334     to make the new libraries available for Thuban.
335     <programlisting>
336     %PYTHONPATH%;C:\Thuban\Lib\gdal;C:\Thuban\Lib\gdal\pymod
337     </programlisting>
338     </para>
339     </listitem>
340     <listitem>
341     <para>
342     Extent also the <varname>PATH</varname>
343     environment variable accordingly:
344     <programlisting>
345     %PATH%;C:\Thuban\Lib\gdal
346     </programlisting>
347     </para>
348     </listitem>
349     </itemizedlist>
350     After this installation steps Thuban is ready to
351     display raster data (e.g. the
352     <literal>island.tif</literal> from the Iceland Demo
353     data set.
354     </para>
355     </section> <!-- Win32: GDAL-->
356    
357     <section><title>Working with PostGIS: Installation of PsycoPG</title>
358     <para>
359     To access PostgreSQL/PostGIS spatial databases with
360     Thuban you have to install the PsycoPG package for
361     Windows:
362     <itemizedlist>
363     <listitem>
364     <para>
365     Download the zip-archive
366     <ulink
367     url="http://stickpeople.com/projects/python/win-psycopg/win-psycopg22.zip"
368     >win-psycopg22.zip</ulink>.
369     </para>
370     </listitem>
371     <listitem>
372     <para>
373     Extract the zip-archive into a directory either already
374     in your <varname>PYTHONPATH</varname> or extent your
375     <varname>PYTHONPATH</varname> variable to the directory
376     you have extracted the archive to.
377     </para>
378     </listitem>
379     </itemizedlist>
380     For installation and maintenance of spatial databases
381     we refer to the <ulink
382     url="http://postgis.refractions.net"
383     >PostGIS Homepage</ulink>.
384     </para>
385     </section> <!-- Win32: PsycoPG-->
386    
387     </section> <!-- Intro - Installation - Win32 -->
388 jan 1423 </section>
389    
390 frank 2023 <section><title>Internationalization</title>
391     <para>
392     Thuban is implemented with internationalization support. So far Thuban
393     is translated by volunteers to the following languages (apart from its
394     main language: English):
395     <itemizedlist>
396     <listitem><para>French</para></listitem>
397     <listitem><para>German</para></listitem>
398     <listitem><para>Italian</para></listitem>
399 jan 2311 <listitem><para>Portuguese (Brazilian)</para></listitem>
400 frank 2023 <listitem><para>Russian</para></listitem>
401     <listitem><para>Spanish</para></listitem>
402     </itemizedlist>
403     </para>
404    
405     <para>
406     To use internationalization under POSIX systems (like GNU/Linux)
407     you have to set the environment variable LC_ALL accordingly (e.g.
408     LC_ALL=fr_FR for the french language support). Please check your
409     systems documentation for details and supported settings.
410     Specifiying LC_ALL on the command line while launching thuban
411 jan 2311 allows appication specific language settings:
412 frank 2023 </para>
413 jan 2311 <programlisting>
414     LC_ALL=fr_FR thuban.py
415     </programlisting>
416 frank 2023
417     <para>
418     MS Windows users have to specify the language to be used via the control
419     bar (which effects all applications).
420     </para>
421     </section>
422    
423 jonathan 1446 <section><title>The Main Window</title>
424 jan 1423 <para>
425 frank 1532 <figure>
426     <title>The Main Window</title>
427 jonathan 1446 <mediaobject>
428 jonathan 1490 <imageobject> <imagedata fileref="../images/1_2_mainwindow.png" format="PNG" scale="&imgscale;"/> </imageobject>
429     <imageobject> <imagedata fileref="./images/1_2_mainwindow.ps" format="EPS" scale="&imgscale;"/> </imageobject>
430 jonathan 1446 </mediaobject>
431 frank 1532 </figure>
432 jonathan 1446 </para>
433    
434     <para>
435 jonathan 1466 The map window shows the current state of the map and is where
436 jonathan 1446 the user can interact with the map using the tools.
437     </para>
438    
439     <para>
440 jonathan 1466 The legend on the left displays a list of the current layers and
441     any visible classification groups. In the example, each shape layer
442     has a default classification which specifies how the shapes in each
443     layer are drawn. Layers that are higher in the list appear
444     ``closer'' to the user. The legend can be closed by clicking on the
445     small X in the upper right-hand region of the legend.
446     To open it again, use
447 jonathan 1446 <menuchoice>
448     <guimenu>Map</guimenu>
449     <guimenuitem>Legend</guimenuitem>
450     </menuchoice>.
451     The legend is also dockable, which means that it can be detached
452     from the main window by clicking on the small button next to the
453 jonathan 1466 close button. It can be attached by clicking the same button
454 jonathan 1446 again.
455     </para>
456     <para>
457 jonathan 1466 The status bar displays different information depending on the
458 jonathan 1446 current context. If the user is selecting an item from the menu
459     then the status bar will display a short help message indicating
460     what each menu item is for. If the user has a tool selected then
461     the position of the cursor on the map is displayed.
462     </para>
463     <para>
464 jonathan 1466 The tool bar provides quick access to the commonly needed tools.
465 jonathan 1446 By hovering over each button the user can see a short messages
466     describing what the tool does. The tools provided are Zoom In, Zoom
467 frank 1496 Out, Pan, Full Extent, Full Layer Extent, Full Shape Extent, Identify,
468 jonathan 1446 and Label. Each of the tools will be explained in further detail later
469     in the manual.
470     </para>
471 jan 1423 </section>
472    
473 bh 1367 </chapter>
474 jan 1423
475     <chapter><title>Session Management</title>
476    
477 jonathan 1446 <section><title>Starting a New Session</title>
478 jan 1423 <para>
479 jonathan 1446 A new session can be started from
480     <menuchoice>
481     <guimenu>File</guimenu>
482     <guimenuitem>New Session</guimenuitem>
483 jonathan 1490 </menuchoice>.
484 jonathan 1446 If a session is already loaded and has been modified without
485     being saved a prompt will ask if the current session should
486 jonathan 1490 be saved. A new session consists of an empty map with no
487 jan 2314 layers, no tables and no projection.
488 jan 1423 </para>
489     </section>
490    
491 jonathan 1446 <section><title>Opening a Session</title>
492 jan 1423 <para>
493 jonathan 1446 A session can be opened from
494     <menuchoice>
495     <guimenu>File</guimenu>
496     <guimenuitem>Open Session</guimenuitem>
497 jonathan 1490 </menuchoice>. A dialog box will open allowing the user to browse
498     for a Thuban Session file. Thuban session files end with
499     <varname>.thuban</varname>. Selecting a file a clicking
500     <guibutton>OK</guibutton> will load the session into Thuban.
501 frank 2447 </para>
502 jonathan 1446
503 frank 2447 <para>
504 jonathan 1446 If a session is already loaded and has been modified without
505     being saved a prompt will ask if the current session should
506     be saved.
507 jan 1423 </para>
508 frank 2447
509     <para>
510     Thuban provides a path recovery feature: If a (shape) file referenced
511     in a Thuban session cannot be found at the specified location, the user
512     is prompted a file dialog. Here a new location can be selected for the
513     currents layer data source. Cancelling the dialog removes the layer
514     from the session. If a new location has been selected, Thuban checks
515     this again, if further layers data sources are missing. The user is
516     informed about this and can accept or cancel the suggestion.
517     </para>
518 jan 1423 </section>
519    
520 jonathan 1446 <section><title>Saving a Session</title>
521 jan 1423 <para>
522 jonathan 1446 A session can be saved from
523     <menuchoice>
524     <guimenu>File</guimenu>
525     <guimenuitem>Save Session</guimenuitem>
526 jan 2314 </menuchoice>.
527     In the case the session is not a new and unsaved one,
528     the corresponding file is updated with the current session
529     data.
530     In the case the current session is a new one and yet unsaved
531     a dialog box will open allowing the user to browse
532 frank 1496 the file system and select a place to save the session. Thuban
533 jonathan 1490 sessions should be saved under a name ending in
534     <varname>.thuban</varname>. If the file already exists the user
535     will be prompted to save under a different name or overwrite the
536     existing file.
537 jan 1423 </para>
538     </section>
539    
540 jonathan 1446 <section><title>The Session Info-Tree</title>
541 jonathan 1490 <para>
542 frank 1532 <figure>
543     <title>Session Info Tree</title>
544 jonathan 1490 <mediaobject>
545     <imageobject><imagedata fileref="../images/2_4_session_tree.png" format="PNG" scale="&imgscale;"/></imageobject>
546     <imageobject><imagedata fileref="./images/2_4_session_tree.eps" format="EPS" scale="&imgscale;"/></imageobject>
547     </mediaobject>
548 frank 1532 </figure>
549 jonathan 1490 </para>
550 jan 1423 <para>
551 jonathan 1490 The session info-tree is primarily intended for developers working
552     with Thuban. It displays many of the internal values for the session,
553     map, and layers. It can be opened from
554     <menuchoice>
555     <guimenu>File</guimenu>
556     <guimenuitem>Session Tree</guimenuitem>
557     </menuchoice>.
558 jan 1423 </para>
559     </section>
560     </chapter>
561    
562     <chapter><title>Map Management</title>
563     <para>
564 jonathan 1466 The map consists of a number of layers where each layer represents a
565     different type of data set. By interacting with the map the user can
566     visually explore the data.
567 jan 1423 </para>
568 jonathan 1490 <para>
569     The map can have a name that will appear in the Thuban title bar.
570     The map name can be changed using
571     <menuchoice>
572     <guimenu>Map</guimenu>
573     <guimenuitem>Rename</guimenuitem>
574     </menuchoice>.
575     </para>
576     <para>
577     <inlinemediaobject>
578     <imageobject>
579     <imagedata fileref="../images/3_rename_map.png" format="PNG" scale="&imgscale;"/>
580     </imageobject>
581     <imageobject>
582     <imagedata fileref="./images/3_rename_map.eps" format="EPS" scale="&imgscale;"/>
583     </imageobject>
584     <textobject> <phrase>Rename Map</phrase> </textobject>
585     </inlinemediaobject>
586     </para>
587 jan 1423
588 jonathan 1446 <section><title>Adding and Removing Layers</title>
589 jan 1423 <para>
590 frank 2023 There are three types of layers that can be added to a map:
591     Shape layers, database layers
592 jonathan 1466 and image layers. Shape layers are stored in Shapefile format, a
593 jan 1624 widely used file format for storing geographic objects. These
594 jonathan 1466 files have the extension ``.shp''. Associated with
595 jonathan 1491 the shape file is a database file which stores attributes for
596 jan 1624 each shape in the Shape file. This file, in dBase format,
597 jonathan 1491 has the extension ``.dbf''. Both files must have the same base name.
598     For example, if there is a shape file named roads.shp there must
599 jonathan 1466 also be a file roads.dbf.
600 jan 1423 </para>
601 frank 2023 <itemizedlist>
602     <listitem>
603     <para>
604 jonathan 1466 Shape layers can be added to the map with
605     <menuchoice>
606     <guimenu>Map</guimenu>
607     <guimenuitem>Add Layer</guimenuitem>
608     </menuchoice>.
609 jan 1624 Initially, only the ``.shp'' files are shown which is enough for the
610     selection. However, if you switch to display all files and select one
611     of the associated files (e.g. ``.dbf''), Thuban will recognize the base
612     name and load the corresponding Shape file.
613 jonathan 1466 </para>
614 jan 1624 <para>
615     The file dialog for Shape files allows to select multiple files.
616     Use the shift-button together with the left mouse button to extend
617     the selection.
618     </para>
619 frank 2023 </listitem>
620 jonathan 1466
621 frank 2023 <listitem>
622     <para>Database layers can be added to the map with
623     <menuchoice>
624     <guimenu>Map</guimenu>
625     <guimenuitem>Add Database Layer</guimenuitem>
626     </menuchoice>.
627     A dialog with two is list is opened. The left list displays all
628     database connections currently open for the session. You can retrieve
629     a list of available layers from the selected database which is
630     displayed on the right hand. From this list one layer can be selected,
631     the dialog is closed afterwards.
632     </para>
633     <para>
634     See appendix ``Working with PostGIS'' for details.
635     </para>
636     </listitem>
637    
638     <listitem>
639 jonathan 1466 <para>
640     Image layers can be added to the map with
641     <menuchoice>
642     <guimenu>Map</guimenu>
643     <guimenuitem>Add Image Layer</guimenuitem>
644     </menuchoice>.
645     It is important to select a valid image file that has geographic
646 jonathan 1491 data associated with it. The data can be embedded in the file itself,
647 jonathan 1466 or in another file. If geographic information cannot be found, Thuban
648     will report an error.
649     </para>
650 frank 2023 </listitem>
651     </itemizedlist>
652 jan 1423 </section>
653    
654     <section><title>Navigation</title>
655     <para>
656 jonathan 1466 The map can be explored by using the navigation tools available on
657 jonathan 1491 the tool bar or from the
658 jonathan 1466 <menuchoice><guimenu>Map</guimenu></menuchoice> menu.
659 jan 1423 </para>
660 frank 1532 <itemizedlist>
661     <listitem>
662 jonathan 1466 <para>
663     The ZoomIn tool
664     <inlinemediaobject>
665     <imageobject>
666 jonathan 1490 <imagedata fileref="../images/3_2_zoomin.png" format="PNG" scale="&imgscale;"/>
667 jonathan 1473 </imageobject>
668     <imageobject>
669 jonathan 1490 <imagedata fileref="./images/3_2_zoomin.eps" format="EPS" scale="&imgscale;"/>
670 jonathan 1466 </imageobject>
671     <textobject> <phrase>ZoomIn Tool</phrase> </textobject>
672     </inlinemediaobject>
673 jonathan 1491 enlarges a region of the map. Clicking once on the map
674 jonathan 1466 will double the magnification and center the map on the point that
675 jonathan 1510 was clicked. Clicking and dragging selects a region that will be
676 jonathan 1491 enlarged to fit the window.
677 jonathan 1466 </para>
678 frank 1532 </listitem>
679     <listitem>
680 jonathan 1466 <para>
681     The ZoomOut tool
682     <inlinemediaobject>
683     <imageobject>
684 jonathan 1490 <imagedata fileref="../images/3_2_zoomout.png" format="PNG" scale="&imgscale;"/>
685 jonathan 1473 </imageobject>
686     <imageobject>
687 jonathan 1490 <imagedata fileref="./images/3_2_zoomout.eps" format="EPS" scale="&imgscale;"/>
688 jonathan 1466 </imageobject>
689     <textobject> <phrase>ZoomOut Tool</phrase> </textobject>
690     </inlinemediaobject>
691     shrinks the map so that a larger region is visible. A single click
692     reduces the magnification by a factor of two. Clicking and dragging
693     selects a box such that the current contents of the window will be
694     scaled to fit into that box.
695     </para>
696 frank 1532 </listitem>
697     <listitem>
698 jonathan 1466 <para>
699     The Pan tool
700     <inlinemediaobject>
701     <imageobject>
702 jonathan 1490 <imagedata fileref="../images/3_2_pan.png" format="PNG" scale="&imgscale;"/>
703 jonathan 1473 </imageobject>
704     <imageobject>
705 jonathan 1490 <imagedata fileref="./images/3_2_pan.eps" format="EPS" scale="&imgscale;"/>
706 jonathan 1466 </imageobject>
707     <textobject> <phrase>Pan Tool</phrase> </textobject>
708     </inlinemediaobject>
709     allows the user to move the map around by clicking and dragging.
710     </para>
711 frank 1532 </listitem>
712     <listitem>
713 jonathan 1466 <para>
714     The Full Extent tool
715     <inlinemediaobject>
716     <imageobject>
717 jonathan 1490 <imagedata fileref="../images/3_2_fullextent.png" format="PNG" scale="&imgscale;"/>
718 jonathan 1473 </imageobject>
719     <imageobject>
720 jonathan 1490 <imagedata fileref="./images/3_2_fullextent.eps" format="EPS" scale="&imgscale;"/>
721 jonathan 1466 </imageobject>
722     <textobject> <phrase>Full Extent Tool</phrase> </textobject>
723     </inlinemediaobject>
724     rescales the viewable region so that the entire map is visible.
725     </para>
726 frank 1532 </listitem>
727     <listitem>
728 jonathan 1466 <para>
729     The Full Layer Extent tool
730     <inlinemediaobject>
731     <imageobject>
732 jonathan 1490 <imagedata fileref="../images/3_2_fulllayerextent.png" format="PNG" scale="&imgscale;"/>
733 jonathan 1473 </imageobject>
734     <imageobject>
735 jonathan 1490 <imagedata fileref="./images/3_2_fulllayerextent.eps" format="EPS" scale="&imgscale;"/>
736 jonathan 1466 </imageobject>
737     <textobject> <phrase>Full Layer Extent Tool</phrase> </textobject>
738     </inlinemediaobject>
739     rescales the viewable region so that the currently selected
740     layer fits within the window. If no layer is selected this button
741     will be disabled.
742     </para>
743 frank 1532 </listitem>
744     <listitem>
745 jonathan 1466 <para>
746     The Full Shape Extent tool
747     <inlinemediaobject>
748     <imageobject>
749 jonathan 1490 <imagedata fileref="../images/3_2_fullshapeextent.png" format="PNG" scale="&imgscale;"/>
750 jonathan 1473 </imageobject>
751     <imageobject>
752 jonathan 1490 <imagedata fileref="./images/3_2_fullshapeextent.eps" format="EPS" scale="&imgscale;"/>
753 jonathan 1466 </imageobject>
754     <textobject> <phrase>Full Shape Extent Tool</phrase> </textobject>
755     </inlinemediaobject>
756     rescales the viewable region so that the currently selected
757     shape fits within the window. If the shape is a point, it is
758     centered and the map is zoomed all the way in. If no shape is
759 jonathan 1510 selected this button will be disabled. This feature is especially
760     helpful when identifying an object related to a selected record
761     in a tableview (see below).
762    
763 jonathan 1466 </para>
764 frank 1532 </listitem>
765     </itemizedlist>
766 jan 1423 </section>
767    
768 jonathan 1446 <section><title>Object Identification</title>
769 jan 1423 <para>
770 jonathan 1466 Objects on the map can be identified using the Identify tool
771     <inlinemediaobject>
772     <imageobject>
773 jonathan 1490 <imagedata fileref="../images/3_3_identify.png" format="PNG" scale="&imgscale;"/>
774 jonathan 1473 </imageobject>
775     <imageobject>
776 jonathan 1490 <imagedata fileref="./images/3_3_identify.eps" format="EPS" scale="&imgscale;"/>
777 jonathan 1466 </imageobject>
778     <textobject> <phrase>Identify Tool</phrase> </textobject>
779     </inlinemediaobject>.
780     Clicking on an object selects that object and opens a dialog which
781     shows all the table attributes for that object. Any current selection
782 jonathan 1510 is lost. Objects on the map are typically shapes and this document
783     will often refer to objects as shapes.
784 jan 1423 </para>
785     </section>
786    
787 frank 1496 <section><title>Object Labeling</title>
788 jan 1423 <para>
789 frank 1496 Objects can be labeled using the Label tool
790 jonathan 1466 <inlinemediaobject>
791     <imageobject>
792 jonathan 1490 <imagedata fileref="../images/3_3_label.png" format="PNG" scale="&imgscale;"/>
793 jonathan 1473 </imageobject>
794     <imageobject>
795 jonathan 1490 <imagedata fileref="./images/3_3_label.eps" format="EPS" scale="&imgscale;"/>
796 jonathan 1466 </imageobject>
797     <textobject> <phrase>Label Tool</phrase> </textobject>
798     </inlinemediaobject>.
799     Clicking on an object selects that object and opens a dialog which
800     displays the table attributes for that object. An attribute can
801 jonathan 1491 be selected to be the label on the map. The label will be placed
802     at the center of the shape. Clicking on an object that already has
803     a label will remove the label.
804 jan 1423 </para>
805     </section>
806    
807 jonathan 1446 <section><title>The Legend</title>
808 jonathan 1490 <para>
809     <inlinemediaobject>
810     <imageobject>
811     <imagedata fileref="../images/3_5_legend.png" format="PNG" scale="&imgscale;"/>
812     </imageobject>
813     <imageobject>
814     <imagedata fileref="./images/3_5_legend.eps" format="EPS" scale="&imgscale;"/>
815     </imageobject>
816     <textobject> <phrase>Legend</phrase> </textobject>
817     </inlinemediaobject>
818     </para>
819 jan 1423 <para>
820 jonathan 1466 The Legend provides an overview of the layers in the map. Layers
821     that appear higher in the legend will appear ``closer'' to the user.
822     If a layer supports classification (currently, only shape layers
823     have this feature) then the classification groups will be shown
824     below each layer. The properties for each group are also displayed
825     with a small graphic. Polygon layers appear as rectangles, lines
826     appear as curved lines, and points appear as circles.
827     </para>
828     <para>
829     Along the top of the legend is a toolbar which allows quick access
830     to some of the layer manipulation options under
831 jonathan 1491 <menuchoice><guimenu>Map</guimenu></menuchoice>.
832     </para>
833 jonathan 1466
834 frank 1532 <itemizedlist>
835     <listitem>
836 jonathan 1491 <para>
837     The Move Layer to Top tool
838     <inlinemediaobject>
839     <imageobject>
840     <imagedata fileref="../images/3_5_totop.png" format="PNG" scale="&imgscale;"/>
841     </imageobject>
842     <imageobject>
843     <imagedata fileref="./images/3_5_totop.eps" format="EPS" scale="&imgscale;"/>
844     </imageobject>
845     <textobject> <phrase>Move Layer to Top</phrase> </textobject>
846     </inlinemediaobject> raises the selected layer to the top of the map.
847     </para>
848 frank 1532 </listitem>
849     <listitem>
850 jonathan 1491
851     <para>
852     The Move Layer Up tool
853     <inlinemediaobject>
854     <imageobject>
855     <imagedata fileref="../images/3_5_moveup.png" format="PNG" scale="&imgscale;"/>
856     </imageobject>
857     <imageobject>
858     <imagedata fileref="./images/3_5_moveup.eps" format="EPS" scale="&imgscale;"/>
859     </imageobject>
860     <textobject> <phrase>Move Layer Up</phrase> </textobject>
861     </inlinemediaobject> raises the selected layer one level.
862     </para>
863 frank 1532 </listitem>
864     <listitem>
865 jonathan 1491
866     <para>
867     The Move Layer Down tool
868     <inlinemediaobject>
869     <imageobject>
870     <imagedata fileref="../images/3_5_movedown.png" format="PNG" scale="&imgscale;"/>
871     </imageobject>
872     <imageobject>
873     <imagedata fileref="./images/3_5_movedown.eps" format="EPS" scale="&imgscale;"/>
874     </imageobject>
875     <textobject> <phrase>Move Layer Down</phrase> </textobject>
876     </inlinemediaobject> lowers the selected layer one level.
877     </para>
878    
879 frank 1532 </listitem>
880     <listitem>
881 jonathan 1491 <para>
882     The Move Layer to Bottom tool
883     <inlinemediaobject>
884     <imageobject>
885     <imagedata fileref="../images/3_5_tobottom.png" format="PNG" scale="&imgscale;"/>
886     </imageobject>
887     <imageobject>
888     <imagedata fileref="./images/3_5_tobottom.eps" format="EPS" scale="&imgscale;"/>
889     </imageobject>
890     <textobject> <phrase>Move Layer to Bottom</phrase> </textobject>
891     </inlinemediaobject> lowers the selected layer to the bottom of the map.
892     </para>
893    
894 frank 1532 </listitem>
895     <listitem>
896 jonathan 1491 <para>
897     The Visible tool
898     <inlinemediaobject>
899     <imageobject>
900     <imagedata fileref="../images/3_5_visible.png" format="PNG" scale="&imgscale;"/>
901     </imageobject>
902     <imageobject>
903     <imagedata fileref="./images/3_5_visible.eps" format="EPS" scale="&imgscale;"/>
904     </imageobject>
905     <textobject> <phrase>Visible</phrase> </textobject>
906     </inlinemediaobject> shows the selected layer in the map if it was
907     hidden.
908     </para>
909    
910 frank 1532 </listitem>
911     <listitem>
912 jonathan 1491 <para>
913     The Invisible tool
914     <inlinemediaobject>
915     <imageobject>
916     <imagedata fileref="../images/3_5_invisible.png" format="PNG" scale="&imgscale;"/>
917     </imageobject>
918     <imageobject>
919     <imagedata fileref="./images/3_5_invisible.eps" format="EPS" scale="&imgscale;"/>
920     </imageobject>
921     <textobject> <phrase>Invisible</phrase> </textobject>
922     </inlinemediaobject> hides the selected layer in the map.
923     </para>
924    
925 frank 1532 </listitem>
926     <listitem>
927 jonathan 1491 <para>
928     The Properties tool
929     <inlinemediaobject>
930     <imageobject>
931     <imagedata fileref="../images/3_5_props.png" format="PNG" scale="&imgscale;"/>
932     </imageobject>
933     <imageobject>
934     <imagedata fileref="./images/3_5_props.eps" format="EPS" scale="&imgscale;"/>
935     </imageobject>
936     <textobject> <phrase>Properties</phrase> </textobject>
937     </inlinemediaobject> opens the layer's properties dialog box.
938 jonathan 1466 Double-clicking on a layer or a group of a layer will open the
939     properties dialog for that layer.
940 jan 1423 </para>
941 frank 1532 </listitem>
942     </itemizedlist>
943 frank 2023
944     <para>
945     The most used layer related actions are also available from a
946     popup menu. It is raised when a layer is clicked with the right mouse
947     button.
948     </para>
949    
950     <para>
951     <figure>
952     <title>Layer Popup Menu</title>
953     <mediaobject>
954     <imageobject><imagedata fileref="../images/3_5_popup_menu.png" format="PNG" scale="&imgscale;"/></imageobject>
955     <imageobject><imagedata fileref="./images/3_5_popup_menu.eps" format="EPS" scale="&imgscale;"/></imageobject>
956     </mediaobject>
957     </figure>
958     </para>
959    
960 jonathan 1510 <para>
961     Along the bottom of the legend is the scalebar. The scalebar
962     will be available if there are any layers and the map has a
963     projection set.
964     </para>
965 jan 1423 </section>
966    
967 jonathan 1490 <section><title>Exporting</title>
968     <para>
969     Under Windows, maps can be exported in Enhanced Metafile format
970     (<varname>.wmf</varname>)
971     from
972     <menuchoice>
973     <guimenu>Map</guimenu>
974     <guimenuitem>Export</guimenuitem>
975 jonathan 1510 </menuchoice> for use in reports, presentations, or further
976     modification. The current map view, legend, and, if available,
977     scalebar are exported. Under other platforms this option is not
978     available. Clicking this menu item open a file selection dialog
979     that lets the user select a location to export the map.
980 jonathan 1490 </para>
981     </section>
982    
983 jan 1423 <section><title>Printing</title>
984     <para>
985 jonathan 1466 The map can be printed using
986     <menuchoice>
987     <guimenu>Map</guimenu>
988     <guimenuitem>Print</guimenuitem>
989 jonathan 1510 </menuchoice>. The current map view, legend, and, if available,
990     scalebar are printed. A standard printing dialog will open allowing
991     the user to configure the printer. This dialog will differ depending
992 jonathan 1490 on which platform Thuban is running.
993 jan 1423 </para>
994     </section>
995 jonathan 1490
996 jan 1423 </chapter>
997    
998     <chapter><title>Layer Management</title>
999     <para>
1000     </para>
1001    
1002 jonathan 1446 <section><title>Types of Layers</title>
1003 jan 1423 <para>
1004 frank 2023 There are three types of layers supported by Thuban: shape layers,
1005     database layers and
1006 jonathan 1466 image layers. Shape layers consist of vector based shapes with
1007     geo-referenced coordinates. There are three types of supported
1008 frank 2023 shapes: polygons, lines (arc), and points. Database layers are similar
1009     to shape layers but loaded from a database instead of the file system.
1010     Image layers can be any image
1011 frank 1496 file format supported by the Geo-spatial Data Abstraction Library
1012 jonathan 1491 (GDAL). The images must have geographic
1013 frank 1496 coordinate data either embedded within the file or in a separate
1014 jonathan 1473 file that is in the same directory as the image file. GeoTIFF files
1015     work very well with Thuban and were designed specifically to be image
1016     layers in GIS programs.
1017 jan 1423 </para>
1018 jonathan 1510 <para>
1019     All actions in the
1020     <menuchoice>
1021     <guimenu>Layer</guimenu>
1022     </menuchoice> menu act on the currently selected layer in the legend.
1023     </para>
1024 jan 1423 </section>
1025    
1026 jonathan 1466 <section><title>Properties</title>
1027     <para>
1028 jonathan 1490 To view the properties for a layer it must first be selected in the
1029     legend. The menu option
1030     <menuchoice>
1031     <guimenu>Layer</guimenu>
1032     <guimenuitem>Properties</guimenuitem>
1033     </menuchoice> opens a dialog that displays a layer's properties.
1034 jonathan 1510 All layers have a title which can be modified in the text field
1035 jonathan 1491 provided. The type of layer is also shows. If the type is a type
1036 jonathan 1490 of shape (polygon, arc, point) the classification table will be
1037     shown. Image layers have no other properties other than title
1038     and type.
1039 jonathan 1466 </para>
1040 jonathan 1490 <para>
1041 frank 1532 <figure>
1042     <title>Properties Window</title>
1043 jonathan 1490 <mediaobject>
1044     <imageobject><imagedata fileref="../images/4_2_layer_properties.png" format="PNG" scale="&imgscale;"/></imageobject>
1045     <imageobject><imagedata fileref="./images/4_2_layer_properties.eps" format="EPS" scale="&imgscale;"/></imageobject>
1046     </mediaobject>
1047 frank 1532 </figure>
1048 jonathan 1490 </para>
1049     <para>
1050 frank 1532 <figure>
1051     <title>Properties Window</title>
1052 jonathan 1490 <mediaobject>
1053     <imageobject><imagedata fileref="../images/4_2_raster_layer_properties.png" format="PNG" scale="&imgscale;"/></imageobject>
1054     <imageobject><imagedata fileref="./images/4_2_raster_layer_properties.eps" format="EPS" scale="&imgscale;"/></imageobject>
1055     </mediaobject>
1056 frank 1532 </figure>
1057 jonathan 1490 </para>
1058 jonathan 1466 </section>
1059    
1060 jan 1423 <section><title>Visibility</title>
1061     <para>
1062 jonathan 1466 Sometimes it is not desirable to view all layers at the same time.
1063     Some layers may take a long time to draw and so while navigating
1064     around the map the user may not want to wait for the map to redraw
1065 jonathan 1491 all the layers each time the map is changed. Each layer can be
1066     independently turned on or off using the
1067 jonathan 1466 <menuchoice>
1068     <guimenu>Layer</guimenu>
1069     <guimenuitem>Show</guimenuitem>
1070     </menuchoice>
1071     or
1072     <menuchoice>
1073     <guimenu>Layer</guimenu>
1074     <guimenuitem>Hide</guimenuitem>
1075     </menuchoice> options respectively.
1076 jan 1423 </para>
1077     </section>
1078    
1079     <section><title>Duplication</title>
1080     <para>
1081 jonathan 1466 Layers and all their properties, including classifications, can
1082     be duplicated using
1083     <menuchoice>
1084     <guimenu>Layer</guimenu>
1085     <guimenuitem>Duplicate</guimenuitem>
1086     </menuchoice>. Duplicating a layer is useful if the user wishes
1087     to model a layer in several different ways. Even though the layers
1088 jonathan 1491 overlap, by carefully selecting the shape properties it is possible
1089 jonathan 1466 to display several pieces of information at once. For example, one
1090     copy of a roads layer may be classified on a length property and
1091 jonathan 1491 another copy may be classified on a type property. If the length
1092 jonathan 1466 property was expressed with color and the type property expressed
1093     with line thickness then it would be possible to view both
1094     classifications by placing the type property copy over the
1095     length property copy.
1096 jan 1423 </para>
1097     </section>
1098    
1099     </chapter>
1100    
1101     <chapter><title>Layer Classifications</title>
1102     <para>
1103 jonathan 1473 A layer classification is a way of assigning drawing properties to
1104     groups of shapes based on attributes stored in the layer's table.
1105     Only layer's with shapes can have a classification; image layers
1106     cannot be classified.
1107 jan 1423 </para>
1108 jonathan 1473 <para>
1109 jonathan 1491 A classification consists of a number of groups, each group
1110 jonathan 1473 having a value or range of values to match against, and symbol
1111     properties which control how a shape is drawn on the map. The user
1112     selects which field in the table is used by the classification and
1113     when the map is drawn the value for that field for each shape is
1114     compared with each group's value. The properties of the first group
1115     to match are used to draw the shape. This allows the user to get a
1116     visual impression of not only how the data is laid out but also what
1117     kind of data lies where.
1118     </para>
1119     <para>
1120     A layer always has a classification. When a new layer is added to the
1121     map, a default classification is created with the DEFAULT group. This
1122 jonathan 1510 group cannot be removed but can be hidden (see below). Every shape in the
1123     layer, regardless of its attributes, will match this group if no other
1124     group matches.
1125 jonathan 1473 </para>
1126 jan 1423
1127 jonathan 1473 <section><title>Editing Classifications</title>
1128 jan 1423 <para>
1129 jonathan 1473 A layer's classification can be modified under the properties dialog
1130     (<menuchoice>
1131     <guimenu>Layer</guimenu>
1132     <guimenuitem>Properties</guimenuitem>
1133     </menuchoice>). The layer's classification field can be set to None,
1134     which simply assigns a DEFAULT group to the classification. No new
1135     groups can be added to the classification if the field is None.
1136     The user must first select a field to classify on. New groups can
1137     be added to the classification with the <guibutton>Add</guibutton>
1138     button.
1139     </para>
1140     <para>
1141 jonathan 1510 To apply the changes to the map the user can click
1142     either <guibutton>Try</guibutton> or <guibutton>OK</guibutton>.
1143     <guibutton>Try</guibutton> will not close the dialog box, allowing
1144     the user to see how the classification changes the map.
1145     <guibutton>Revert</guibutton> will undo the last classification applied
1146     to the map. <guibutton>OK</guibutton> will commit the changes and
1147     close the dialog. The user will be unable to undo the changes.
1148     <guibutton>Close</guibutton> simply closes the dialog box. If any
1149     changes have not been applied with <guibutton>Try</guibutton> the
1150     changes will not be applied to the map.
1151     </para>
1152     <para>
1153 frank 1532 <figure>
1154     <title>Properties Window</title>
1155 jonathan 1490 <mediaobject>
1156     <imageobject><imagedata fileref="../images/5_classification.png" format="PNG" scale="&imgscale;"/></imageobject>
1157     <imageobject><imagedata fileref="./images/5_classification.eps" format="EPS" scale="&imgscale;"/></imageobject>
1158     </mediaobject>
1159 frank 1532 </figure>
1160 jonathan 1490 </para>
1161     <para>
1162 jonathan 1473 The order of the groups in the classification is significant
1163     except for the DEFAULT group, which remains at the top. When shapes
1164     are matched against groups the matching begins at the first group
1165 jonathan 1491 after the DEFAULT group so that groups higher in the list will
1166 jonathan 1473 be checked first. Matching for a
1167     given shape will stop at the first group that matches. The user can
1168     use <guibutton>Move Up</guibutton> and <guibutton>Move Down</guibutton>
1169     to change the order of the groups. The DEFAULT group will always
1170     match a shape that hasn't matched another group.
1171 jan 1423 </para>
1172 jonathan 1491 <section><title>Visible</title>
1173     <para>
1174 frank 1496 The Visible column has check-boxes that determine whether a
1175 jonathan 1491 classification group will be displayed in the legend. This is
1176     useful if the user knows that the groups completely cover
1177     the data set and don't want the DEFAULT group to be displayed
1178     in the legend and on a printout.
1179     </para>
1180     </section>
1181     <section><title>Symbols</title>
1182     <para>
1183     Each type of shape has its own type of symbol. Thuban supports three
1184     types of shapes: polygons, lines, and points. Polygons and points
1185     have outline and fill color, while lines have only line color. Each
1186     group has associated symbol properties. To edit the symbol
1187     properties for a group the user can double click on the Symbol
1188     column or select a group and click the
1189     <guibutton>Edit Symbol</guibutton> button.
1190     </para>
1191     </section>
1192     <section><title>Value</title>
1193     <para>
1194     The Value column of the classification table is the value that will
1195     be matched when the map is being drawn. The type of data that can
1196     entered into this field depends on the type of data of the
1197     classification field.
1198     </para>
1199     <para>
1200     If the field is of type Text, anything entered
1201     into the field is valid. The text will be compared literally to the
1202     value of the shape attribute, including case sensitivity.
1203     If the type is Integer, then any valid integer may be entered. In
1204     addition, with special syntax, a range of values can be entered.
1205     A range from <varname>start</varname> to <varname>end</varname>
1206 frank 1496 inclusive is specified like this: <literal>[start;end]</literal>.
1207 jonathan 1491 The exclusive range is specified like this:
1208     <literal>]start;end[</literal>. Ranges can include infinity like
1209     this: <literal>[-oo;oo]</literal>. Field types can also be of type
1210     Decimal. They represent any rational number and can be used in
1211     ranges as well.
1212     </para>
1213     </section>
1214     <section><title>Label</title>
1215     <para>
1216     By default, the text that is displayed for a group in the legend
1217     is the value for that group. The label can substitute a more
1218     descriptive term in the legend.
1219     </para>
1220     </section>
1221 jan 1423 </section>
1222    
1223 jonathan 1446 <section><title>Generating Classes</title>
1224 jan 1423 <para>
1225 frank 1532 <figure>
1226     <title>Generate Class</title>
1227 jonathan 1490 <mediaobject>
1228     <imageobject><imagedata fileref="../images/5_3_genclass.png" format="PNG" scale="&imgscale;"/></imageobject>
1229     <imageobject><imagedata fileref="./images/5_3_genclass.eps" format="EPS" scale="&imgscale;"/></imageobject>
1230     </mediaobject>
1231 frank 1532 </figure>
1232 jonathan 1490 </para>
1233     <para>
1234 jonathan 1473 Creating a classification by hand can be tedious.
1235     Thuban, therefore, provides a means of generating an entire
1236     classification at once while still giving the user control over
1237     how it appears. Clicking <guibutton>Generate Class</guibutton>
1238     opens the <varname>Generate Classification</varname> dialog.
1239 frank 1496 Under the <varname>Generate</varname> pull down there are at most
1240 jonathan 1473 three different ways to generate classifications:
1241 jonathan 1510 Unique Values, Uniform Distribution, and Quantiles. Some options
1242 jonathan 1491 may not be available if the data type for the field does not
1243 jonathan 1510 support them. For instance, <varname>Uniform Distribution</varname>
1244 jonathan 1473 doesn't make sense for a Text field.
1245 jan 1423 </para>
1246 jonathan 1473 <para>
1247     For every way of generating a classification, a color scheme must
1248     be selected. Thuban provides several different color schemes that
1249     affect how the group properties change over the classification.
1250 jonathan 1530 It may be desirable that only certain properties change over the
1251     classification. If the shape type is a polygon or a point then
1252     the <guibutton>Fix Border Color</guibutton> option will be available.
1253     This allows the user to select a border color for all classification
1254     groups.
1255 jonathan 1473 It is also possible to create a custom color scheme. Selecting
1256     this option will display two symbols: the one of the left has the
1257     properties of the first group and the one on the right has the
1258     properties of the last group. Thuban will interpolate between these
1259     two properties to generate the other groups.
1260 frank 1532 <figure>
1261     <title>Custom Color Scheme</title>
1262 jonathan 1510 <mediaobject>
1263     <imageobject><imagedata fileref="../images/5_2_custom_ramp.png" format="PNG" scale="&imgscale;"/></imageobject>
1264     <imageobject><imagedata fileref="./images/5_2_custom_ramp.eps" format="EPS" scale="&imgscale;"/></imageobject>
1265     </mediaobject>
1266 frank 1532 </figure>
1267 jonathan 1473 </para>
1268     <para>
1269     The Unique Values option lets the user select specific values that
1270     appear in the table. Clicking <guibutton>Retrieve From Table</guibutton>
1271     searches the table for all unique values and displays them in the
1272     list on the left. Items can be selected and moved to the list on the
1273     right. Each list can be sorted or reversed for easier searching.
1274     The classification that is generated will be in the same order as
1275     the list on the right.
1276 frank 1532 <figure>
1277     <title>Unique Values</title>
1278 jonathan 1510 <mediaobject>
1279     <imageobject><imagedata fileref="../images/5_2_unique_values.png" format="PNG" scale="&imgscale;"/></imageobject>
1280     <imageobject><imagedata fileref="./images/5_2_unique_values.eps" format="EPS" scale="&imgscale;"/></imageobject>
1281     </mediaobject>
1282 frank 1532 </figure>
1283 jonathan 1473 </para>
1284     <para>
1285 jonathan 1510 The Uniform Distribution option creates a user specified number of
1286 jonathan 1473 groups of ranges such that each range covers equal intervals. The
1287     minimum and maximum values can automatically be retrieved from the
1288     table by clicking <guibutton>Retrieve From Table</guibutton>. The
1289     stepping is how large each interval is. Adjusting this value will
1290     automatically recalculate how many groups is appropriate.
1291 frank 1532 <figure>
1292     <title>Uniform Distribution</title>
1293 jonathan 1510 <mediaobject>
1294     <imageobject><imagedata fileref="../images/5_2_uniform_dist.png" format="PNG" scale="&imgscale;"/></imageobject>
1295     <imageobject><imagedata fileref="./images/5_2_uniform_dist.eps" format="EPS" scale="&imgscale;"/></imageobject>
1296     </mediaobject>
1297 frank 1532 </figure>
1298 jonathan 1473 </para>
1299     <para>
1300 jonathan 1491 The Quantiles option generates ranges based on the number of items
1301 jonathan 1510 in the table. For example, by specifying five groups Thuban will
1302 jonathan 1491 generate five groups with appropriate ranges such that 20% of the table
1303 jonathan 1473 data is in each group. If it is impossible to generate exact
1304 jonathan 1491 groupings, Thuban will issue a warning but allow the user to continue.
1305 frank 1532 <figure>
1306     <title>Quantiles</title>
1307 jonathan 1510 <mediaobject>
1308     <imageobject><imagedata fileref="../images/5_2_quantiles.png" format="PNG" scale="&imgscale;"/></imageobject>
1309     <imageobject><imagedata fileref="./images/5_2_quantiles.eps" format="EPS" scale="&imgscale;"/></imageobject>
1310     </mediaobject>
1311 frank 1532 </figure>
1312 jonathan 1473 </para>
1313 jan 1423 </section>
1314     </chapter>
1315    
1316     <chapter><title>Projection Management</title>
1317     <para>
1318 jonathan 1475 Projections control how the geographic data is displayed on the screen.
1319     If multiple layers are loaded into Thuban where the geographic data
1320 jonathan 1491 is in a different projection system, then the user must specify a
1321     projection for each layer. The user must also tell Thuban which
1322 jonathan 1475 projection the map is in. This can be the same as the layers or a different
1323     projection in which case the layers are reprojected into that space.
1324     The map projection can be set using
1325     <menuchoice>
1326     <guimenu>Map</guimenu>
1327     <guimenuitem>Projection</guimenuitem>
1328     </menuchoice> and the layer projection can be set using
1329     <menuchoice>
1330     <guimenu>Layer</guimenu>
1331     <guimenuitem>Projection</guimenuitem>
1332     </menuchoice>.
1333 frank 1532 <figure>
1334     <title>Projection Window</title>
1335 jonathan 1490 <mediaobject>
1336     <imageobject><imagedata fileref="../images/6_projection.png" format="PNG" scale="&imgscale;"/></imageobject>
1337     <imageobject><imagedata fileref="./images/6_projection.eps" format="EPS" scale="&imgscale;"/></imageobject>
1338     </mediaobject>
1339 frank 1532 </figure>
1340 jan 1423 </para>
1341 jonathan 1475 <para>
1342 frank 2023 Thuban is distributed with a sample collection of projections and the
1343     set of coordinate systems as used by the EPSG
1344     (European Petroleum Survey Group). This quite large set is only displayed
1345     if activated by the according checkbox. The set falls into two parts:
1346     deprecated lists all projections which are no longer part of the
1347     EPSG data base.
1348     </para>
1349     <para>
1350     The
1351 jonathan 1475 user can create new projections and make them available to all
1352     future Thuban sessions. They may also be exported and imported so
1353 jonathan 1491 that custom projections can be distributed.
1354 jonathan 1475 </para>
1355     <section><title>Selecting a Projection</title>
1356     <para>
1357     The available projections are listed on the left. If the layer
1358 jonathan 1491 or map already has a projection it will initially be highlighted
1359 jonathan 1475 and will end with <varname>(current)</varname>. Selecting
1360 jonathan 1490 <varname>&lt;None&gt;</varname> will cause Thuban to use the data as
1361 jonathan 1475 it appears in the source file and will not use a projection.
1362     </para>
1363     </section>
1364     <section><title>Editing a Projection</title>
1365     <para>
1366     Whenever a projection is selected from the list its properties
1367     are displayed on the right. These properties can be changed
1368     and the changes saved to the selected projection using
1369 jonathan 1491 <guibutton>Update</guibutton>. Only a projection that comes
1370 jonathan 1475 from a file can be updated, so if the current layer's projection
1371 jonathan 1491 is selected, <guibutton>Update</guibutton> will be disabled.
1372     <guibutton>Add to List</guibutton> adds the projection to the
1373     list of available projections as a new entry, and thus makes it
1374 jonathan 1475 available to future Thuban sessions. Clicking <guibutton>New</guibutton>
1375     will create an entirely new, empty projection. The
1376 frank 1496 <guibutton>Remove</guibutton> button will permanently remove a
1377 jonathan 1475 projection from the list of available projections.
1378     </para>
1379 jonathan 1510 <para>
1380     To apply the selected projection to the map the user can click
1381     either <guibutton>Try</guibutton> or <guibutton>OK</guibutton>.
1382     <guibutton>Try</guibutton> will not close the dialog box, allowing
1383     the user to see how the projeciton changes the map.
1384     <guibutton>Revert</guibutton> will undo the last projection applied
1385     to the map. <guibutton>OK</guibutton> will commit the changes and
1386     close the dialog. The user will be unable to undo the changes.
1387     <guibutton>Close</guibutton> simply closes the dialog box. If no
1388     selection has been applied with <guibutton>Try</guibutton> the
1389     selection will not be applied to the map.
1390     </para>
1391 jonathan 1475 </section>
1392     <section><title>Importing/Exporting Projections</title>
1393     <para>
1394     The projections that appear in the list of available projections
1395     can be exported to another file that the user chooses. By selecting
1396     one or more projections and clicking <guibutton>Export</guibutton>
1397 jonathan 1491 the user will be able to select a file in which to store those
1398     projections.
1399 jonathan 1475 The file can then be distributed to other Thuban users. To import
1400     a projection file the user can click <guibutton>Import</guibutton>.
1401     The imported projections are added to the list and are then available
1402 jonathan 1491 to the current session and any future Thuban sessions.
1403 jonathan 1475 </para>
1404     </section>
1405 jan 1423 </chapter>
1406    
1407     <chapter><title>Table Management</title>
1408     <para>
1409 jonathan 1490 Thuban distinguishes two different types of tables: Attribute tables
1410 jonathan 1491 (which belong to a layer) and normal data tables. Both provide
1411     the same general functionality with the difference that actions on an
1412 jonathan 1490 attribute table might also effect the map display.
1413 jan 1423 </para>
1414 frank 1478
1415     <section><title>Table View</title>
1416 jonathan 1490 <para>
1417 frank 1532 <figure>
1418     <title>Table View</title>
1419 jonathan 1490 <mediaobject>
1420     <imageobject><imagedata fileref="../images/7_1_table_view.png" format="PNG" scale="&imgscale;"/></imageobject>
1421     <imageobject><imagedata fileref="./images/7_1_table_view.eps" format="EPS" scale="&imgscale;"/></imageobject>
1422     </mediaobject>
1423 frank 1532 </figure>
1424 jonathan 1490 </para>
1425     <para>
1426 frank 1478 Thuban provides a standard dialog to display table contents, the
1427 jonathan 1510 Table View. The view has five sections: The title, selections,
1428 jonathan 1491 the table grid, export functions, and the status bar.
1429 jonathan 1490 </para>
1430     <para>
1431 jonathan 1491 The title bar identifies the table with its name.
1432 jonathan 1490 </para>
1433     <para>
1434 jonathan 1491 The selections box let the user perform simple analysis on the data
1435     based on comparisons: The first choice must be a field identifier of
1436     the table, the second choice determines the type of comparison. The
1437     third choice can be either a specific value (interpreted as numerical
1438 frank 1478 or string depending on the type of the first field) or a second field
1439     identifier. Thus you can perform analysis like selecting all
1440 jonathan 1510 records where <literal>population > 10000</literal> or
1441     <literal>cars_per_inhabitant < bikes_per_inhabitant</literal>
1442     (note that the field names are only explanatory, the dBase files
1443     allow only 11 character field names).
1444 jonathan 1490
1445 jonathan 1491 Selections can be combined either by applying a selection only on
1446 frank 1478 a previously selected set of records or by adding the results of a
1447     selection to a previous set. The default is that a selection replaces
1448     earlier results.
1449 jonathan 1490 </para>
1450     <para>
1451 jonathan 1510 The table grid shows the contents of the table (one record per row),
1452 frank 1478 with highlighted selection results. Columns and rows can be resized.
1453 jonathan 1490 </para>
1454     <para>
1455 frank 1496 The contents of a table can be exported into a file, either dBase
1456     format (DBF) or comma separated values (CSV). The
1457 jonathan 1490 <guibutton>Export</guibutton> button
1458 frank 1478 raises a file dialog to specify a path and file name, the export type
1459     is determined by the file extension (either .dbf or .csv).
1460    
1461 jonathan 1490 The <guibutton>Export Selection</guibutton> button works similarly
1462     but exports only the selected records.
1463 frank 1478
1464 jonathan 1490 The <guibutton>Close</guibutton> button closes the table view window.
1465     This is different from the menu item
1466     <menuchoice>
1467     <guimenu>Table</guimenu>
1468     <guimenuitem>Close</guimenuitem>
1469     </menuchoice> which unloads the table from Thuban.
1470     </para>
1471     <para>
1472 frank 1478 The status bar displays some statistics about the table and optional
1473     selection results.
1474 jonathan 1490 </para>
1475 frank 1478 </section>
1476    
1477     <section><title>General Functionality (Menu Table)</title>
1478 jonathan 1490 <para>
1479 frank 1478 The general functions affect all tables open in Thuban. Attribute
1480 jonathan 1491 tables are considered here as normal data tables (with the exception
1481 frank 1478 that they cannot be closed).
1482     </para>
1483 jonathan 1490 <section><title>Open</title>
1484     <para>
1485     The
1486     <menuchoice>
1487     <guimenu>Table</guimenu>
1488     <guimenuitem>Open</guimenuitem>
1489     </menuchoice>
1490     item raises a file dialog to let you select a
1491 frank 1496 dBase file from the file system to be loaded into Thuban read-only.
1492 jonathan 1491 On <guibutton>OK</guibutton> the selected file is loaded and a
1493     table view is opened.
1494 jonathan 1490 </para>
1495     </section>
1496 frank 1478
1497 jonathan 1490 <section><title>Close</title>
1498     <para>
1499     The
1500     <menuchoice>
1501     <guimenu>Table</guimenu>
1502     <guimenuitem>Close</guimenuitem>
1503     </menuchoice>
1504     item raises a dialog listing the currently open
1505     data tables
1506     (loaded via
1507     <menuchoice>
1508     <guimenu>Table</guimenu>
1509     <guimenuitem>Open</guimenuitem>
1510     </menuchoice>). Selected tables are dereferenced on confirmation.
1511     Since tables are opened read-only the contents of the tables are
1512     not affected.
1513 frank 1478
1514 jonathan 1491 Any open views of the tables are closed as well.
1515 frank 1478
1516 jonathan 1490 Tables used in a join cannot be closed.
1517     </para>
1518     </section>
1519 frank 1478
1520 jonathan 1490 <section><title>Rename</title>
1521     <para>
1522     <menuchoice>
1523     <guimenu>Table</guimenu>
1524     <guimenuitem>Rename</guimenuitem>
1525     </menuchoice> changes the table title.
1526     </para>
1527     </section>
1528 frank 1478
1529 jonathan 1490 <section><title>Show</title>
1530     <para>
1531     The
1532     <menuchoice>
1533     <guimenu>Table</guimenu>
1534     <guimenuitem>Show</guimenuitem>
1535     </menuchoice>
1536     item raises a list of available tables (explicitly
1537     loaded, attribute tables, results of a join). Selected tables are
1538 jonathan 1491 show in tables views on <guibutton>OK</guibutton>.
1539 jonathan 1490 </para>
1540     </section>
1541 frank 1478
1542 jonathan 1490 <section><title>Join</title>
1543     <para>
1544 frank 1532 <figure>
1545     <title>Join Tables</title>
1546 jonathan 1490 <mediaobject>
1547     <imageobject><imagedata fileref="../images/7_2_5_join.png" format="PNG" scale="&imgscale;"/></imageobject>
1548     <imageobject><imagedata fileref="./images/7_2_5_join.eps" format="EPS" scale="&imgscale;"/></imageobject>
1549     </mediaobject>
1550 frank 1532 </figure>
1551 jonathan 1490 </para>
1552     <para>
1553     The
1554     <menuchoice>
1555     <guimenu>Table</guimenu>
1556     <guimenuitem>Join</guimenuitem>
1557     </menuchoice>
1558     item raises a dialog to specify the two tables to be
1559     joined. The join results in a new table named 'Join of "left table"
1560     and "right table"'.
1561 frank 1478
1562 jonathan 1491 The dialog lets you select the two tables to be joined and the two
1563     fields the join has to be performed on. By default, the new
1564     table contains only those records which are matched by the join.
1565 frank 1478
1566 jonathan 1490 If you want to preserve the records of the left table you can
1567     perform an outer join. The fields from the right table for records
1568     not matched by the join are filled with <varname>None</varname> in
1569     this case.
1570     </para>
1571     </section>
1572 frank 1478
1573     </section>
1574     <section><title>Attribute Tables</title>
1575     <para>
1576 jonathan 1510 To clearly separate between both types of tables (data and
1577     attribute), Thuban provides functionality regarding the attribute
1578     tables under the <menuchoice><guimenu>Layer</guimenu></menuchoice> menu.
1579 frank 1478 </para>
1580    
1581 jonathan 1490 <section><title>Show Table</title>
1582     <para>
1583     <menuchoice>
1584     <guimenu>Layer</guimenu>
1585     <guimenuitem>Show Table</guimenuitem>
1586     </menuchoice>
1587     opens the attribute table of the currently active layer in a table
1588     view.
1589    
1590     In addition to the functionality described above selections
1591     affect also the map display: objects related to selected records
1592     are highlighted.
1593     </para>
1594     </section>
1595    
1596     <section><title>Join Table</title>
1597     <para>
1598 jonathan 1491 Unlike the join described above, the join does not result in a
1599 frank 1478 new table. The attribute table of the currently active layer is the
1600 jonathan 1490 left table and other tables are joined to this table. The results of
1601 jonathan 1491 the join are available for classification.
1602 frank 1478
1603 jonathan 1490 As a consequence, the join cannot result in fewer
1604     records than the source attribute table. The user is warned if the
1605     right table does not fulfill this constraint. An outer join must be
1606     used in such cases.
1607     </para>
1608     </section>
1609 frank 1478
1610 jonathan 1490 <section><title>Unjoin Table</title>
1611     <para>
1612     As said above, a normal table cannot be closed while it is still
1613     used in a join. While the joined table resulting from a join of
1614     normal tables can be simply closed (and thereby dereferencing
1615     the source tables), this is not possible for attribute tables.
1616 frank 1478
1617 frank 1496 Hence joins on attribute tables must be solved explicitly. This is
1618 jonathan 1490 what the
1619     <menuchoice>
1620     <guimenu>Layer</guimenu>
1621     <guimenuitem>Unjoin Table</guimenuitem>
1622     </menuchoice>
1623     item is used for: The last join for the currently
1624 frank 1478 active layer is solved.
1625 jonathan 1490 </para>
1626     </section>
1627 frank 1478 </section>
1628 jan 1423 </chapter>
1629    
1630 jan 1624 <chapter><title>Extensions</title>
1631     <para>
1632     Thuban is designed to be extensible. The term Extension is used as a
1633     general term for anything that extends Thuban.
1634     This chapter introduces into some oppportunities how to add and
1635     handle extra functionality developed by your own or third parties.
1636     </para>
1637    
1638     <section><title>Add personal extensions via thubanstart.py</title>
1639     <para>
1640     After Thuban has been started for the first time, a directory
1641     .thuban is created within your home directory.
1642     There you can add a file thubanstart.py which will be imported
1643     by Thuban at start-up. It is recommended to add only import-statements
1644     to this file to keep the actual code of extensions separate.
1645     </para>
1646     <para>
1647 jan 1719 The modules to import must either be found through the environment
1648 jan 1624 variable PYTHONPATH or directly be placed into the .thuban-directory.
1649     </para>
1650     <para>
1651     As an example, copy the file examples/simple_extensions/hello_world.py
1652     of the Thuban source code into the .thuban-directory of your home
1653     directory. Now add add the statement import hello_world to the
1654     file thubanstart.py and run Thuban. You will notice an additional
1655     menu <menuchoice><guimenu>Extensions</guimenu></menuchoice> where
1656     the new item for the Hello-World extension is placed - select it
1657     to see the Hello-World message.
1658     </para>
1659     </section>
1660    
1661 jan 1744 <section><title>Extensions included in Thuban package</title>
1662     <para>
1663     The extensions described in this section are part of the
1664     Thuban package, but not activated by default.
1665     You will find them in the Thuban installation directory
1666     under <literal>Extensions/</literal>. Activate them as personal
1667     extensions via PYTHONPATH as described in the previous section.
1668     Stable extensions will appear under the menu
1669     <menuchoice><guimenu>Extensions</guimenu></menuchoice> and
1670     extensions which are in experimental state and therefore
1671     not fully functional under
1672     <menuchoice><guimenu>Experimental</guimenu></menuchoice>.
1673     </para>
1674    
1675     <section><title>Stable extensions</title>
1676     <para>
1677     These extensions provide extra-functionality to Thuban
1678     that has not (yet) been integrated in the main application.
1679     They are considered to be free of bugs, but may be
1680     further polished with helpful user interactions.
1681     </para>
1682     <section><title>gns2shp</title>
1683     <para>
1684     This tool converts data of the Geospatial Names Server
1685     (GNS, see <ulink url="http://www.nima.mil/gns"/>)
1686     into Shapefile format.
1687     The above web-site offer to download named places
1688     information grouped by countries for all of the world
1689     except USA for which other data are provided.
1690     </para>
1691     <para>
1692     If you download and unpack a package, you will have
1693     a text-file with suffix .txt.
1694     Selecting such a file via gns2shp will create the
1695     corresponding Shapefile with the same basename and
1696     place it in the same direcory. Afterwards it
1697     is automatically loaded into Thuban.
1698     The Shapefile will not automatically be delete afterwards.
1699     </para>
1700     <para>
1701     The gns2shp.py module can also be executed on the
1702     command line for batch processing purposes.
1703     </para>
1704     <para>
1705     A sample (<literal>ls.txt</literal> for Liechtenstein)
1706     is included in the directory
1707     <literal>Extensions/gns2shp/test</literal>.
1708     </para>
1709     </section>
1710     </section>
1711     <section><title>Experimental extensions</title>
1712     <para>
1713     All all of these functions have to be handled with care,
1714     since they are neither complete nor well tested.
1715     They are to be seen as a proof-of-concept and may
1716     additionally in some cases of practical help.
1717     </para>
1718     <para>
1719     Any interest on further improvement of these extensions
1720     should be communicated towards the developer and user
1721     community.
1722     </para>
1723    
1724     <section><title>importAPR</title>
1725     <para>
1726     This command offer to load an ESRI® ArcView® project
1727     file (suffix .apr) and convert it for use within Thuban.
1728     After selecting a apr-file to load, a list
1729     will be presented that offers to select one of the views
1730     of the apr-file, provided there is more than one.
1731     Furthermore, the Session Info-Tree is extended with
1732     a complete representation of the parsed apr-file.
1733     </para>
1734     <para>
1735     The legend of Thuban does not yet cover all of the elements as
1736     supported by the legend of ArcView®. Therefore, the Thuban
1737     map will look different. Furthermore, the apr-format is
1738     a proprietary format, not openly documented.
1739     Therefore, the interpretation is
1740     partly based on reverse engeneering and good guessing.
1741     </para>
1742     <para>
1743     The file-paths within the apr-file may not fit and potentially
1744     are subject to fix in the apr-file. You can do this
1745     applying any text editor. The paths are either absolute
1746     or relative from where Thuban has been started.
1747     </para>
1748     <para>
1749     A sample for the Iceland data is included as
1750     <literal>Extensions/importAPR/samples/iceland.apr</literal>.
1751     The file-paths are relative from the Thuban main directory.
1752     </para>
1753     </section>
1754     </section>
1755     </section>
1756    
1757 jan 1624 <section><title>Writing simple extensions</title>
1758     <para>
1759     Writing an extension for Thuban basically means to
1760     implement the extra functionality in Python with all of the
1761     Thuban classes, methods and variables available.
1762     </para>
1763     <para>
1764     All classes and their methods are documented in the source code
1765     (see their doc-strings). Here is an example from
1766     Thuban/Model/layer.py that describes some of the methods
1767     of a Layer object:
1768     </para>
1769     <programlisting>
1770     <![CDATA[
1771     class BaseLayer(TitledObject, Modifiable):
1772    
1773     """Base class for the layers."""
1774    
1775     def __init__(self, title, visible = True, projection = None):
1776     """Initialize the layer.
1777    
1778     title -- the title
1779     visible -- boolean. If true the layer is visible.
1780     """
1781     TitledObject.__init__(self, title)
1782     Modifiable.__init__(self)
1783     self.visible = visible
1784     self.projection = projection
1785    
1786     def Visible(self):
1787     """Return true if layer is visible"""
1788     return self.visible
1789    
1790     def SetVisible(self, visible):
1791     """Set the layer's visibility."""
1792     self.visible = visible
1793     self.issue(LAYER_VISIBILITY_CHANGED, self)
1794    
1795     def HasClassification(self):
1796     """Determine if this layer support classifications."""
1797     ...
1798     ]]>
1799     </programlisting>
1800     <para>
1801     This example intends to give you an impression of the
1802     source-code-level documentation.
1803     You have to make yourself familiar with
1804     the Python programming language to understand some special
1805     code elements.
1806     </para>
1807     <section><title>hello_world.py</title>
1808     <para>
1809     Traditionally, the first example should welcome the world.
1810     Most of the code handles the frame for integrating a menu
1811     item into Thuban while the actual raising of a message
1812     is done in a single line.
1813     </para>
1814     <programlisting>
1815     <![CDATA[
1816     # Copyright (C) 2003 by Intevation GmbH
1817     # Authors:
1818     # Jan-Oliver Wagner <[email protected]>
1819     #
1820     # This program is free software under the GPL (>=v2)
1821     # Read the file COPYING coming with Thuban for details.
1822    
1823     """
1824     Extend Thuban with a sample Hello World to demonstrate simple
1825     extensions.
1826     """
1827    
1828     __version__ = '$Revision$'
1829    
1830     # use _() already now for all strings that may later be translated
1831     from Thuban import _
1832    
1833     # Thuban has named commands which can be registered in the central
1834     # instance registry.
1835     from Thuban.UI.command import registry, Command
1836    
1837     # The instance of the main menu of the Thuban application
1838     # See Thuban/UI/menu.py for the API of the Menu class
1839     from Thuban.UI.mainwindow import main_menu
1840    
1841     def hello_world_dialog(context):
1842     """Just raise a simple dialog to greet the world.
1843    
1844     context -- The Thuban context.
1845     """
1846     context.mainwindow.RunMessageBox(_('Hello World'), _('Hello World!'))
1847    
1848    
1849     # create a new command and register it
1850     registry.Add(Command('hello_world', _('Hello World'), hello_world_dialog,
1851     helptext = _('Welcome everyone on this planet')))
1852    
1853     # find the extensions menu (create it anew if not found)
1854 jan 2209 extensions_menu = main_menu.FindOrInsertMenu('extensions', _('E&xtensions'))
1855 jan 1624
1856     # finally bind the new command with an entry in the extensions menu
1857     extensions_menu.InsertItem('hello_world')
1858     ]]>
1859     </programlisting>
1860     </section>
1861     <section><title>Registering a Command</title>
1862     <para>
1863     Mainly, our new function has to be registered to the Thuban
1864     framework in order to connect it to the menu. A registered
1865     command can also be connected to e.g. a toolbar button.
1866     </para>
1867     <para>
1868     The instances and classes for this are imported at the beginning.
1869     Any code not inside a method or class is directly executed when
1870     the source-code module is imported. Therefore, the second
1871     part of this example consist of the plain statements to create a new
1872     Command and to add it to the menu.
1873     </para>
1874     <para>
1875     By convention, it looks for a menu registered as ``extensions'' to
1876     insert the new command. If it does not exist yet, it gets created.
1877     It is advisable to copy this code for any of your extensions.
1878     </para>
1879     </section>
1880     <section><title>The Thuban context</title>
1881     <para>
1882     A registered command that is called, always receives the
1883     Thuban context. This instance provides our method with
1884     hook references to all important components of the Thuban
1885     application.
1886     </para>
1887     <para>
1888     In the example hello_world.py, our function uses the
1889     mainwindow component which offers a method to raise a
1890     message dialog. In total there are three hooks:
1891     <itemizedlist>
1892     <listitem>
1893     <para>application:
1894     This object is the instance of the Thuban Application class.
1895     Except maybe for loading or savinf sessions, you will not
1896     need this object for a simple extension.
1897     See Thuban/UI/application.py for the API.
1898     </para>
1899     </listitem>
1900     <listitem>
1901     <para>session:
1902     The instance of the current session. It manages the sessions'
1903     map and tables. You can set and remove the map or tables.
1904     In may also get the map object. However, you should know that
1905     internally it is already prepared to handle many maps.
1906     Therfore, currently you would always receive a list with exactlty
1907     one element. In the future, if there are more than one map,
1908     you will not know which one is the currently display one and
1909     therefore you should use the mainwindow as hook to find
1910     the currently displayed map.
1911     See Thuban/Model/session.py for the API.
1912     </para>
1913     </listitem>
1914     <listitem>
1915     <para>
1916     mainwindow: The mainwindow object is central to manage various
1917     GUI things such as the Legend sub-window. Most notably,
1918     you get access to the canvas which is the window part where
1919     the map is drawn. The canvas knows, which map it currently
1920     draws and therefore you get the current map via
1921     context.mainwindow.canvas.Map().
1922     See Thuban/UI/mainwindow.py for the API.
1923     </para>
1924     </listitem>
1925     </itemizedlist>
1926     </para>
1927     </section>
1928     </section>
1929     </chapter>
1930    
1931 jan 1423 <chapter><title>Trouble Shooting</title>
1932     <para>
1933 jonathan 1510 Here are a few problems that users have encountered when first using Thuban.
1934 jan 1423 </para>
1935 jonathan 1510 <para>
1936 jonathan 1490
1937 frank 1532 <itemizedlist>
1938 jonathan 1490 <listitem>
1939 frank 1532 <para>After adding two or more layers nothing is drawn in the map window.
1940     </para>
1941 jonathan 1490 <para>
1942     This is probably because the layers have different projections. Projections
1943 jonathan 1510 must be set on all layers and on the map itself if the layers' projections
1944 jonathan 1490 are different.
1945     </para>
1946     </listitem>
1947    
1948 frank 1532 <listitem>
1949     <para>Thuban crashes on startup with the error
1950 jonathan 1490 <literal>NameError: global name 'False' is not defined</literal>.
1951 frank 1532 </para>
1952 jonathan 1490 <para>
1953     <varname>True</varname> and <varname>False</varname> were only introduced
1954     in Python 2.2.1. Thuban depends on at least Python 2.2.1.
1955     </para>
1956     </listitem>
1957    
1958 frank 1532 <listitem>
1959     <para>After compiling Thuban, Thuban crashes with an error similar to
1960 jonathan 1490 <literal>
1961     ImportError: /usr/local//lib/thuban/Thuban/../Lib/wxproj.so: undefined symbol: __gxx_personality_v0
1962     </literal>
1963 frank 1532 </para>
1964 jonathan 1490 <para>
1965     Thuban depends on the wxWindows library. If Thuban is compiled with an
1966 jonathan 1491 incompatible version of the compiler than wxWindows was compiled with
1967 jonathan 1490 this error may occur. Try compiling with a different version of the
1968 jonathan 1491 compiler.
1969 jonathan 1490 </para>
1970     </listitem>
1971 frank 1532 </itemizedlist>
1972 jonathan 1510 </para>
1973     <para>
1974     If an error occurs Thuban will display a dialog indicating the error
1975     before closing. The text should be copied and reported to the
1976     <ulink url="http://thuban.intevation.org/bugtracker.html">
1977     Intevation bugtracker
1978     </ulink>.
1979     More information about the system is available from
1980     <menuchoice><guimenu>Help</guimenu><guimenuitem>About</guimenuitem></menuchoice> box.
1981     This should also be included in the bug report.
1982 frank 1532 <figure>
1983     <title>Error Dialog</title>
1984 jonathan 1510 <mediaobject>
1985     <imageobject><imagedata fileref="../images/8_int_error.png" format="PNG" scale="&imgscale;"/></imageobject>
1986     <imageobject><imagedata fileref="./images/8_int_error.eps" format="EPS" scale="&imgscale;"/></imageobject>
1987     </mediaobject>
1988 frank 1532 </figure>
1989 jonathan 1510 </para>
1990 jonathan 1490
1991 jan 1423 </chapter>
1992    
1993     <appendix><title>Supported Data Sources</title>
1994     <para>
1995     </para>
1996 jonathan 1475 <variablelist>
1997     <varlistentry>
1998     <term>Shapefile</term>
1999 jonathan 1490 <listitem>
2000     <para>
2001     The Shapefile format has become a standard format for saving
2002     geographic vector information. It supports polygons, lines, and
2003     points.
2004    
2005     <ulink url="http://www.esri.com/library/whitepapers/pdfs/shapefile.pdf">
2006     Technical Specification.
2007     </ulink>
2008     </para>
2009     </listitem>
2010 jonathan 1475 </varlistentry>
2011    
2012     <varlistentry>
2013 frank 1496 <term>dBase file</term>
2014 jonathan 1490 <listitem>
2015     <para>
2016 frank 1496 dBase files are used to store the attributes for each layer. This
2017 jonathan 1490 is closely associated with the Shapefile format. For detailed
2018 frank 1496 specifications on the correct format of a dBase file used with
2019 jonathan 1490 Thuban please see the Technical Specification for the Shapefile
2020     format above.
2021     </para>
2022     </listitem>
2023 jonathan 1475 </varlistentry>
2024    
2025 frank 1532 <varlistentry>
2026 frank 2023 <term>PostGIS</term>
2027     <listitem>
2028     <para>
2029     PostGIS adds support for geographic objects to the PostgreSQL
2030     object-relational database. Different layer types (as for Shapefiles)
2031     are supported. <ulink url="http://postgis.refractions.net">PostGIS
2032     Homepage</ulink>
2033     </para>
2034     </listitem>
2035     </varlistentry>
2036    
2037     <varlistentry>
2038 frank 1532 <term>Raster files</term>
2039     <listitem>
2040     <para>
2041     Binding the GDAL library Thuban supports numerous raster file formats,
2042     see <ulink url="http://www.remotesensing.org/gdal/formats_list.html">
2043     GDAL format list</ulink> for details.</para>
2044    
2045     <para>Most commonly used is the <emphasis>TIFF/GeoTIFF</emphasis>
2046     format: Raster maps are provided as TIFF images, with an additional
2047     "world file" storing the geographic reference (usually with an
2048 jan 1544 extension ".tfw").
2049 frank 1532 </para>
2050     </listitem>
2051     </varlistentry>
2052    
2053 jonathan 1475 </variablelist>
2054 jan 1423 </appendix>
2055    
2056 frank 2023 <appendix><title>Working with PostGIS</title>
2057     <para>
2058     This section focusses on the use of PostGIS in the Thuban framework. For
2059     installation and maintenance of spatial databases we refer to the
2060     <ulink url="http://postgis.refractions.net">PostGIS Homepage</ulink>.
2061     The Thuban PostGIS support requires the
2062     <ulink url="http://initd.org/software/psycopg">psycopg module</ulink>.
2063     </para>
2064    
2065     <para>
2066     Working with PostGIS Databases is seperated into two steps:
2067     <itemizedlist>
2068     <listitem><para>Opening a Database Connection</para></listitem>
2069     <listitem><para>Loading a Data Layer</para></listitem>
2070     </itemizedlist>
2071     </para>
2072     <section><title>Opening a Database Connection</title>
2073     <para>
2074     Before a data layer can be loaded from a PostGIS database a
2075     connection with the database has to be established.
2076     <menuchoice>
2077     <guimenu>Session</guimenu>
2078     <guimenuitem>Database Connections ...</guimenuitem>
2079     </menuchoice> opens a dialog for database connection
2080     management. In the dialog new connections can be added
2081     and existing ones can be removed. Removing a database
2082     connection is not possible if the map still displays a
2083     layer provided by this database connection.
2084     </para>
2085     <figure>
2086     <title>Database Management Dialog</title>
2087     <mediaobject>
2088 frank 2052 <imageobject><imagedata fileref="../images/app_postgis_db_management.png" format="PNG" scale="&imgscale;"/></imageobject>
2089 frank 2023 <imageobject><imagedata fileref="./images/app_postgis_db_management.eps" format="EPS" scale="&imgscale;"/></imageobject>
2090     </mediaobject>
2091     </figure>
2092    
2093     <para>
2094     To add a new database connection to the session a dialog is
2095     opened to specify the relevant connection data. Enter all
2096     data relevant for your connection. If the connection fails
2097     the dialog remains open and provides some hints on the failure.
2098     </para>
2099     <figure>
2100     <title>Add Database Dialog</title>
2101     <mediaobject>
2102 frank 2052 <imageobject><imagedata fileref="../images/app_postgis_db_add.png" format="PNG" scale="&imgscale;"/></imageobject>
2103 frank 2023 <imageobject><imagedata fileref="./images/app_postgis_db_add.eps" format="EPS" scale="&imgscale;"/></imageobject>
2104     </mediaobject>
2105     </figure>
2106    
2107     <para>
2108     It is important to note that information on database connections are
2109     also stored with the session. Passwords are NOT stored. If you load a
2110     session with database connections you are asked to enter these
2111     passwords again where required.
2112     </para>
2113    
2114     </section>
2115    
2116     <section><title>Loading a Data Layer</title>
2117     <para>
2118     Data layers as part of a map are loaded with the
2119     <menuchoice>
2120     <guimenu>Map</guimenu>
2121     <guimenuitem>Add Database Layer ...</guimenuitem>
2122     </menuchoice> menu item. A dialog is raised displaying two choice
2123     lists. In the left list all connected databases are shown.
2124     Highlighting
2125     one of these and issuing a retrieval results in a list of available
2126     layer tables from that database. After selection of a
2127     layer the dialog is closed.
2128     </para>
2129     <figure>
2130     <title>Add Database Dialog</title>
2131     <mediaobject>
2132 frank 2052 <imageobject><imagedata fileref="../images/app_postgis_add_layer.png" format="PNG" scale="&imgscale;"/></imageobject>
2133 frank 2023 <imageobject><imagedata fileref="./images/app_postgis_add_layer.eps" format="EPS" scale="&imgscale;"/></imageobject>
2134     </mediaobject>
2135     </figure>
2136    
2137     </section>
2138    
2139     </appendix>
2140    
2141 jan 1423 <appendix><title>Supported Projections</title>
2142     <para>
2143 jonathan 1490 The following types of projections are directly support by
2144     Thuban. The specific values for each are provided by the user
2145     to create custom projections. Thuban comes with predefined
2146 frank 1507 projections which are available through the Projections dialog.
2147 jan 1423 </para>
2148 frank 1532 <itemizedlist>
2149     <listitem>
2150     <para>Geographic</para>
2151     <itemizedlist>
2152     <listitem><para><literal>Ellipsoid</literal></para></listitem>
2153     <listitem><para>
2154     <literal>Source Data</literal>: either Degrees or Radians
2155 frank 1507 </para></listitem>
2156 frank 1532 </itemizedlist>
2157     </listitem>
2158     <listitem>
2159     <para>Lambert Conic Conformal</para>
2160     <itemizedlist>
2161     <listitem><para><literal>Ellipsoid</literal></para></listitem>
2162     <listitem><para><literal>Latitude of 1st standard parallel</literal></para></listitem>
2163     <listitem><para><literal>Latitude of 2nd standard parallel</literal></para></listitem>
2164     <listitem><para><literal>Central Meridian</literal></para></listitem>
2165     <listitem><para><literal>Latitude of Origin</literal></para></listitem>
2166     <listitem><para><literal>False Easting</literal> (meters)</para></listitem>
2167     <listitem><para><literal>False Northing</literal> (meters)</para></listitem>
2168     </itemizedlist>
2169     </listitem>
2170     <listitem>
2171     <para>Transverse Mercator</para>
2172     <itemizedlist>
2173     <listitem><para><literal>Ellipsoid</literal></para></listitem>
2174     <listitem><para><literal>Latitude</literal>of origin</para></listitem>
2175     <listitem><para><literal>Longitude</literal>at central meridian</para></listitem>
2176     <listitem><para><literal>Scale Factor</literal>at central meridian</para></listitem>
2177     <listitem><para><literal>False Easting</literal> (meters)</para></listitem>
2178     <listitem><para><literal>False Northing</literal> (meters)</para></listitem>
2179     </itemizedlist>
2180     </listitem>
2181     <listitem>
2182     <para>Universal Transverse Mercator</para>
2183     <itemizedlist>
2184     <listitem><para><literal>Ellipsoid</literal></para></listitem>
2185     <listitem><para><literal>Zone</literal>
2186     (can be guessed appling the Propose button)</para></listitem>
2187     <listitem><para><literal>Southern Hemisphere</literal> flag</para></listitem>
2188     </itemizedlist>
2189     </listitem>
2190     </itemizedlist>
2191 frank 1507
2192     <para>
2193     Thuban comes with a sample set of map projections for various
2194     European countries. Apart from the basic projection they differ
2195     especially in their parameterization:
2196     </para>
2197 frank 1532 <itemizedlist>
2198     <listitem><para>Belgium Datum 1972 (Lambert Conic Conformal)</para>
2199     </listitem>
2200 frank 1507
2201 frank 1532 <listitem><para>Gauss-Boaga Zone 1 (Italy, Transverse Mercartor)</para>
2202     </listitem>
2203 frank 1507
2204 frank 1532 <listitem><para>Gauss-Krueger Zone 2 (Germany, Transverse Mercartor)
2205     </para>
2206     </listitem>
2207 frank 1507
2208 frank 1532 <listitem><para>Reseau Geodesique Francaise
2209     (France, Lambert Conic Conformal)</para>
2210     </listitem>
2211 frank 1507
2212 frank 1532 <listitem><para>UK National Grid (United Kingdom, Transverse Mercartor)
2213     </para>
2214     </listitem>
2215     </itemizedlist>
2216 frank 1507
2217     <para>
2218     Thuban uses the comprehensive PROJ library for projections. PROJ provides
2219     more than the four commonly used projections described above. If needed
2220     Thuban can be easily extended to a new projection covered by PROJ.
2221     </para>
2222 jan 1423 </appendix>
2223    
2224 bh 1367 </book>
2225 frank 1496

Properties

Name Value
svn:eol-style native
svn:keywords Author Date Id Revision

[email protected]
ViewVC Help
Powered by ViewVC 1.1.26