Doc/manual/thuban-manual.xml

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE book
        PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!-- $Revision$ -->
<book>
  <bookinfo>
    <title>Thuban Manual</title>
    <author>
      <firstname>Jonathan</firstname><surname>Coles</surname>
    </author>
    <author>
      <firstname>Jan-Oliver</firstname><surname>Wagner</surname>
    </author>
    <copyright>
      <year>2003</year>
      <holder>Intevation GmbH</holder>
    </copyright>
  </bookinfo>

  <chapter><title>Introduction</title>
    <para>
    Thuban is a Free Software Geographic Information Systems (GIS) viewer.
    It is being developed because there is currently no simple interactive
    viewer for geographic information available as Free Software. Thuban is 
    written in Python and C++ and uses the wxWindows library allowing it to 
    run on many different platforms, including GNU/Linux and Windows.
    </para>
    <para>
    GIS viewers are a necessary tool as they allow one to get a visual 
    impression of the positional relationship of the information that may not
    be apparent from simple inspection of the data values themselves. 
    Thuban allows the user to create a session that displays
    geographic data and then explore that data through navigation and
    manipulation of how it is drawn. The results can then be saved or printed.
    </para>
    <para>
    Thuban arranges a session in a hierarchy. A session contains a map which
    consists of layers. Each layer represents one kind of data set. For 
    instance, there may be a layer for roads and another layer for buildings. 
    These layers can either be vector shapes or images.
    </para>

        <section><title>Installation</title>
        <para>
        Thuban is actively supported under Debian Testing (sarge), RedHat 7.2, 
        and Windows 2000. All the necessary files can be found on the 
        <ulink url="http://thuban.intevation.org/download.html">
        Thuban Download site
        </ulink>.
        </para>
        </section>

        <section><title>The Main Window</title>
        <para>
        <screenshot>
        <screeninfo>The Main Window</screeninfo>
        <mediaobject>
        <imageobject><imagedata fileref="../mainwindow.png" format="PNG"/></imageobject>
        <textobject><phrase>The Main Window</phrase></textobject>
        <caption><para>The Main Window</para></caption>
        </mediaobject>
        </screenshot>
        </para>

        <para>
        The map window (1) shows the current state of the map and is where
        the user can interact with the map using the tools. 
        </para>

        <para>
        The legend on
        the left (2) displays a list of the current layers and any visible
        classification groups. In the example, each shape layer has a default
        classification which specifies how the shapes in each layer are 
        drawn. Layers that are higher in the list appear ``closer'' to the
        user. The legend can be closed by clicking on the small X in the
        upper right-hand region of the legend. To open it again, use
        <menuchoice>
        <guimenu>Map</guimenu>
        <guimenuitem>Legend</guimenuitem>
        </menuchoice>.
        The legend is also dockable, which means that it can be detached 
        from the main window by clicking on the small button next to the 
        close button. It can be attached again by clicking the same button
        again.
        </para>
        <para>
        The status bar (3) displays different information depending on the
        current context. If the user is selecting an item from the menu
        then the status bar will display a short help message indicating
        what each menu item is for. If the user has a tool selected then
        the position of the cursor on the map is displayed.
        </para>
        <para>
        The tool bar (4) provides quick access to the commonly needed tools.
        By hovering over each button the user can see a short messages
        describing what the tool does. The tools provided are Zoom In, Zoom
        Out, Pan, Full Extent, Full Layer Extent, Full Shape Extent, Indentify,
        and Label. Each of the tools will be explained in further detail later
        in the manual.
        </para>
        </section>

  </chapter>

  <chapter><title>Session Management</title>

        <section><title>Starting a New Session</title>
        <para>
        A new session can be started from 
        <menuchoice>
        <guimenu>File</guimenu>
        <guimenuitem>New Session</guimenuitem>
        </menuchoice>.

        If a session is already loaded and has been modified without
        being saved a prompt will ask if the current session should
        be saved.

        </para>
        </section>

        <section><title>Opening a Session</title>
        <para>
        A session can be opened from 
        <menuchoice>
        <guimenu>File</guimenu>
        <guimenuitem>Open Session</guimenuitem>
        </menuchoice>.

        If a session is already loaded and has been modified without
        being saved a prompt will ask if the current session should
        be saved.
        </para>
        </section>

        <section><title>Saving a Session</title>
        <para>
        A session can be saved from 
        <menuchoice>
        <guimenu>File</guimenu>
        <guimenuitem>Save Session</guimenuitem>
        </menuchoice>.

        </para>
        </section>

        <section><title>The Session Info-Tree</title>
        <para>
                (primarily for developers)
        </para>
        </section>
  </chapter>

  <chapter><title>Map Management</title>
    <para>
    </para>

        <section><title>Adding and Removing Layers</title>
        <para>
        </para>
        </section>

        <section><title>Navigation</title>
        <para>
        </para>
        </section>

        <section><title>Object Identification</title>
        <para>
        </para>
        </section>

        <section><title>Object Labelling</title>
        <para>
        </para>
        </section>

        <section><title>The Legend</title>
        <para>
        </para>
        </section>

        <section><title>Printing</title>
        <para>
        </para>
        </section>
  </chapter>

  <chapter><title>Layer Management</title>
    <para>
    </para>

        <section><title>Types of Layers</title>
        <para>
        </para>
        </section>

        <section><title>Visibility</title>
        <para>
        </para>
        </section>

        <section><title>Sequence</title>
        <para>
        </para>
        </section>

        <section><title>Duplication</title>
        <para>
        </para>
        </section>

        <section><title>Properties</title>
        <para>
        </para>
        </section>
  </chapter>

  <chapter><title>Layer Classifications</title>
    <para>
    </para>

        <section><title>Adding and Removing Classes</title>
        <para>
        </para>
        </section>

        <section><title>Symbols</title>
        <para>
        </para>
        </section>

        <section><title>Generating Classes</title>
        <para>
        </para>
        </section>
  </chapter>

  <chapter><title>Projection Management</title>
    <para>
    </para>
  </chapter>

  <chapter><title>Table Management</title>
    <para>
    </para>
  </chapter>

  <chapter><title>Trouble Shooting</title>
    <para>
    </para>
  </chapter>

  <appendix><title>Supported Data Sources</title>
    <para>
    </para>
  </appendix>

  <appendix><title>Supported Projections</title>
    <para>
    </para>
  </appendix>

</book>
1	bh	1367	<?xml version="1.0" encoding="ISO-8859-1"?>
2			<!DOCTYPE book
3			PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
4			"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
5	bh	1369	<!-- $Revision$ -->
6	bh	1367	<book>
7			<bookinfo>
8			<title>Thuban Manual</title>
9			<author>
10	jan	1423	<firstname>Jonathan</firstname><surname>Coles</surname>
11	bh	1367	</author>
12	jan	1423	<author>
13			<firstname>Jan-Oliver</firstname><surname>Wagner</surname>
14			</author>
15	bh	1367	<copyright>
16			<year>2003</year>
17			<holder>Intevation GmbH</holder>
18			</copyright>
19			</bookinfo>
20
21			<chapter><title>Introduction</title>
22			<para>
23	jonathan	1446	Thuban is a Free Software Geographic Information Systems (GIS) viewer.
24			It is being developed because there is currently no simple interactive
25			viewer for geographic information available as Free Software. Thuban is
26			written in Python and C++ and uses the wxWindows library allowing it to
27			run on many different platforms, including GNU/Linux and Windows.
28	bh	1367	</para>
29	jonathan	1446	<para>
30			GIS viewers are a necessary tool as they allow one to get a visual
31			impression of the positional relationship of the information that may not
32			be apparent from simple inspection of the data values themselves.
33			Thuban allows the user to create a session that displays
34			geographic data and then explore that data through navigation and
35			manipulation of how it is drawn. The results can then be saved or printed.
36			</para>
37			<para>
38			Thuban arranges a session in a hierarchy. A session contains a map which
39			consists of layers. Each layer represents one kind of data set. For
40			instance, there may be a layer for roads and another layer for buildings.
41			These layers can either be vector shapes or images.
42			</para>
43	jan	1423
44			<section><title>Installation</title>
45	jonathan	1446	<para>
46			Thuban is actively supported under Debian Testing (sarge), RedHat 7.2,
47			and Windows 2000. All the necessary files can be found on the
48			<ulink url="http://thuban.intevation.org/download.html">
49			Thuban Download site
50			</ulink>.
51			</para>
52	jan	1423	</section>
53
54	jonathan	1446	<section><title>The Main Window</title>
55	jan	1423	<para>
56	jonathan	1446	<screenshot>
57			<screeninfo>The Main Window</screeninfo>
58			<mediaobject>
59			<imageobject><imagedata fileref="../mainwindow.png" format="PNG"/></imageobject>
60			<textobject><phrase>The Main Window</phrase></textobject>
61			<caption><para>The Main Window</para></caption>
62			</mediaobject>
63			</screenshot>
64			</para>
65
66			<para>
67			The map window (1) shows the current state of the map and is where
68			the user can interact with the map using the tools.
69			</para>
70
71			<para>
72			The legend on
73			the left (2) displays a list of the current layers and any visible
74			classification groups. In the example, each shape layer has a default
75			classification which specifies how the shapes in each layer are
76			drawn. Layers that are higher in the list appear ``closer'' to the
77			user. The legend can be closed by clicking on the small X in the
78			upper right-hand region of the legend. To open it again, use
79			<menuchoice>
80			<guimenu>Map</guimenu>
81			<guimenuitem>Legend</guimenuitem>
82			</menuchoice>.
83			The legend is also dockable, which means that it can be detached
84			from the main window by clicking on the small button next to the
85			close button. It can be attached again by clicking the same button
86			again.
87			</para>
88			<para>
89			The status bar (3) displays different information depending on the
90			current context. If the user is selecting an item from the menu
91			then the status bar will display a short help message indicating
92			what each menu item is for. If the user has a tool selected then
93			the position of the cursor on the map is displayed.
94			</para>
95			<para>
96			The tool bar (4) provides quick access to the commonly needed tools.
97			By hovering over each button the user can see a short messages
98			describing what the tool does. The tools provided are Zoom In, Zoom
99			Out, Pan, Full Extent, Full Layer Extent, Full Shape Extent, Indentify,
100			and Label. Each of the tools will be explained in further detail later
101			in the manual.
102			</para>
103	jan	1423	</section>
104
105	bh	1367	</chapter>
106	jan	1423
107			<chapter><title>Session Management</title>
108
109	jonathan	1446	<section><title>Starting a New Session</title>
110	jan	1423	<para>
111	jonathan	1446	A new session can be started from
112			<menuchoice>
113			<guimenu>File</guimenu>
114			<guimenuitem>New Session</guimenuitem>
115			</menuchoice>.
116
117			If a session is already loaded and has been modified without
118			being saved a prompt will ask if the current session should
119			be saved.
120
121	jan	1423	</para>
122			</section>
123
124	jonathan	1446	<section><title>Opening a Session</title>
125	jan	1423	<para>
126	jonathan	1446	A session can be opened from
127			<menuchoice>
128			<guimenu>File</guimenu>
129			<guimenuitem>Open Session</guimenuitem>
130			</menuchoice>.
131
132			If a session is already loaded and has been modified without
133			being saved a prompt will ask if the current session should
134			be saved.
135	jan	1423	</para>
136			</section>
137
138	jonathan	1446	<section><title>Saving a Session</title>
139	jan	1423	<para>
140	jonathan	1446	A session can be saved from
141			<menuchoice>
142			<guimenu>File</guimenu>
143			<guimenuitem>Save Session</guimenuitem>
144			</menuchoice>.
145
146	jan	1423	</para>
147			</section>
148
149	jonathan	1446	<section><title>The Session Info-Tree</title>
150	jan	1423	<para>
151			(primarily for developers)
152			</para>
153			</section>
154			</chapter>
155
156			<chapter><title>Map Management</title>
157			<para>
158			</para>
159
160	jonathan	1446	<section><title>Adding and Removing Layers</title>
161	jan	1423	<para>
162			</para>
163			</section>
164
165			<section><title>Navigation</title>
166			<para>
167			</para>
168			</section>
169
170	jonathan	1446	<section><title>Object Identification</title>
171	jan	1423	<para>
172			</para>
173			</section>
174
175	jonathan	1446	<section><title>Object Labelling</title>
176	jan	1423	<para>
177			</para>
178			</section>
179
180	jonathan	1446	<section><title>The Legend</title>
181	jan	1423	<para>
182			</para>
183			</section>
184
185			<section><title>Printing</title>
186			<para>
187			</para>
188			</section>
189			</chapter>
190
191			<chapter><title>Layer Management</title>
192			<para>
193			</para>
194
195	jonathan	1446	<section><title>Types of Layers</title>
196	jan	1423	<para>
197			</para>
198			</section>
199
200			<section><title>Visibility</title>
201			<para>
202			</para>
203			</section>
204
205			<section><title>Sequence</title>
206			<para>
207			</para>
208			</section>
209
210			<section><title>Duplication</title>
211			<para>
212			</para>
213			</section>
214
215			<section><title>Properties</title>
216			<para>
217			</para>
218			</section>
219			</chapter>
220
221			<chapter><title>Layer Classifications</title>
222			<para>
223			</para>
224
225	jonathan	1446	<section><title>Adding and Removing Classes</title>
226	jan	1423	<para>
227			</para>
228			</section>
229
230	jonathan	1446	<section><title>Symbols</title>
231	jan	1423	<para>
232			</para>
233			</section>
234
235	jonathan	1446	<section><title>Generating Classes</title>
236	jan	1423	<para>
237			</para>
238			</section>
239			</chapter>
240
241			<chapter><title>Projection Management</title>
242			<para>
243			</para>
244			</chapter>
245
246			<chapter><title>Table Management</title>
247			<para>
248			</para>
249			</chapter>
250
251			<chapter><title>Trouble Shooting</title>
252			<para>
253			</para>
254			</chapter>
255
256			<appendix><title>Supported Data Sources</title>
257			<para>
258			</para>
259			</appendix>
260
261			<appendix><title>Supported Projections</title>
262			<para>
263			</para>
264			</appendix>
265
266	bh	1367	</book>
Name	Value
svn:eol-style	native
svn:keywords	Author Date Id Revision