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

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

Parent Directory | Revision Log | View Patch Patch

-revision 1507 by frank,
Tue Jul 29 14:30:19 2003 UTC
+revision 1530 by jonathan,
Thu Jul 31 09:57:25 2003 UTC
 Line 48
          <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
+         and Windows 2000. The following list of files that Thuban requires
+         can be found on the
          <ulink url="http://thuban.intevation.org/download.html">
          Thuban Download site
          </ulink>.
+         <variablelist>
+         <varlistentry>
+         <term>Debian Testing (sarge)</term>
+         <listitem>
+             <para>Thuban-0.8.1-1-debian.i386.rpm</para>
+             <para>GTK 1.2.3</para>
+             <para>Python 2.2.1</para>
+             <para>Python 2.2 XML Base Tools</para>
+             <para>wxWindows 2.4</para>
+             <para>wxWindows 2.4 Python Bindings</para>
+             <para>proj 4.4.5 Projection Library</para>
+             <para>SQLite Python Bindings 0.4.3</para>
+             <para>GDAL 1.1.8</para>
+         </listitem>
+         </varlistentry>
+         <varlistentry>
+         <term>RedHat 7.2</term>
+         <listitem>
+             <para>Thuban-0.8.1-1.i386.rpm</para>
+             <para>Python 2.2.1</para>
+             <para>wxPython 2.4 for Python 2.2 with wxGTK</para>
+             <para>proj 4.4.5 Projection Library</para>
+             <para>SQLite 2.8.3</para>
+             <para>PySQLite 0.4.3</para>
+             <para>GDAL 1.1.8</para>
+         </listitem>
+         </varlistentry>
+         <varlistentry>
+         <term>Windows 2000</term>
+         <listitem>
+             <para>Thuban-0.8.1-0.exe</para>
+             <para>Python 2.2.1</para>
+             <para>wxWindows 2.4 for Python 2.2</para>
+             <para>SQLite Python Libraries</para>
+             <para>GDAL for Thuban</para>
+         </listitem>
+         </varlistentry>
+         </variablelist>
          </para>
          </section>
-Line 209
+Line 248
          <section><title>Adding and Removing Layers</title>
          <para>
-         There are two types of layers that can use added to a map: shape layers
+         There are two types of layers that can be added to a map: shape layers
          and image layers. Shape layers are stored in Shapefile format, a
          standard file format for storing geographic objects. These
          files have the extension ``.shp''. Associated with
-Line 261
+Line 300
          </inlinemediaobject>
          enlarges a region of the map. Clicking once on the map
          will double the magnification and center the map on the point that
-         was clicked. Clicking and dragging selects a region that will
+         was clicked. Clicking and dragging selects a region that will be
          enlarged to fit the window.
          </para>
          <para>
-Line 335
+Line 374
          rescales the viewable region so that the currently selected
          shape fits within the window. If the shape is a point, it is
          centered and the map is zoomed all the way in. If no shape is
-         selected this button will be disabled.
+         selected this button will be disabled. This feature is especially
+         helpful when identifying an object related to a selected record
+         in a tableview (see below).
          </para>
          </section>
-Line 353
+Line 395
          </inlinemediaobject>.
          Clicking on an object selects that object and opens a dialog which
          shows all the table attributes for that object. Any current selection
-         is lost.
+         is lost. Objects on the map are typically shapes and this document
+         will often refer to objects as shapes.
          </para>
          </section>
-Line 497
+Line 540
          Double-clicking on a layer or a group of a layer will open the
          properties dialog for that layer.
          </para>
+         <para>
+         Along the bottom of the legend is the scalebar. The scalebar
+         will be available if there are any layers and the  map has a
+         projection set.
+         </para>
          </section>
          <section><title>Exporting</title>
-Line 507
+Line 556
          <menuchoice>
          <guimenu>Map</guimenu>
          <guimenuitem>Export</guimenuitem>
-         </menuchoice>. Under other platforms this option is not available.
+         </menuchoice> for use in reports, presentations, or further
-         Clicking this menu item open a file selection dialog that lets the
+         modification. The current map view, legend, and, if available,
-         user select a location to export the map.
+         scalebar are exported. Under other platforms this option is not
+         available. Clicking this menu item open a file selection dialog
+         that lets the user select a location to export the map.
          </para>
          </section>
-Line 519
+Line 570
          <menuchoice>
          <guimenu>Map</guimenu>
          <guimenuitem>Print</guimenuitem>
-         </menuchoice>. A standard printing dialog will open allowing the
+         </menuchoice>. The current map view, legend, and, if available,
-         user to configure the printer. This dialog will differ depending
+         scalebar are printed. A standard printing dialog will open allowing
+         the user to configure the printer. This dialog will differ depending
          on which platform Thuban is running.
          </para>
          </section>
-Line 536
+Line 588
          There are two types of layers supported by Thuban: shape layers and
          image layers. Shape layers consist of vector based shapes with
          geo-referenced coordinates. There are three types of supported
-         shapes: polygons, lines, and points. Image layers can be any image
+         shapes: polygons, lines (arc), and points. Image layers can be any image
          file format supported by the Geo-spatial Data Abstraction Library
          (GDAL). The images must have geographic
          coordinate data either embedded within the file or in a separate
-Line 544
+Line 596
          work very well with Thuban and were designed specifically to be image
          layers in GIS programs.
          </para>
+         <para>
+         All actions in the
+         <menuchoice>
+         <guimenu>Layer</guimenu>
+         </menuchoice> menu act on the currently selected layer in the legend.
+         </para>
          </section>
          <section><title>Properties</title>
-Line 554
+Line 612
          <guimenu>Layer</guimenu>
          <guimenuitem>Properties</guimenuitem>
          </menuchoice> opens a dialog that displays a layer's properties.
-         All layers have a title and it can be modified in the text field
+         All layers have a title which can be modified in the text field
          provided. The type of layer is also shows. If the type is a type
          of shape (polygon, arc, point) the classification table will be
          shown. Image layers have no other properties other than title
-Line 646
+Line 704
      <para>
      A layer always has a classification. When a new layer is added to the
      map, a default classification is created with the DEFAULT group. This
-     group cannot be removed. Every shape in the layer, regardless of its
+     group cannot be removed but can be hidden (see below). Every shape in the
-     attributes, will match this group if no other group matches.
+     layer, regardless of its attributes, will match this group if no other
+     group matches.
      </para>
          <section><title>Editing Classifications</title>
-Line 664
+Line 723
          button.
          </para>
          <para>
+         To apply the changes to the map the user can click
+         either <guibutton>Try</guibutton> or <guibutton>OK</guibutton>.
+         <guibutton>Try</guibutton> will not close the dialog box, allowing
+         the user to see how the classification changes the map.
+         <guibutton>Revert</guibutton> will undo the last classification applied
+         to the map. <guibutton>OK</guibutton> will commit the changes and
+         close the dialog. The user will be unable to undo the changes.
+         <guibutton>Close</guibutton> simply closes the dialog box. If any
+         changes have not been applied with <guibutton>Try</guibutton> the
+         changes will not be applied to the map.
+         </para>
+         <para>
          <screenshot>
          <screeninfo>Properties Window</screeninfo>
          <mediaobject>
-Line 756
+Line 827
          opens the <varname>Generate Classification</varname> dialog.
          Under the <varname>Generate</varname> pull down there are at most
          three different ways to generate classifications:
-         Unique Values, Unique Distribution, and Quantiles. Some options
+         Unique Values, Uniform Distribution, and Quantiles. Some options
          may not be available if the data type for the field does not
-         support them. For instance, <varname>Unique Distribution</varname>
+         support them. For instance, <varname>Uniform Distribution</varname>
          doesn't make sense for a Text field.
          </para>
          <para>
          For every way of generating a classification, a color scheme must
          be selected. Thuban provides several different color schemes that
          affect how the group properties change over the classification.
+         It may be desirable that only certain properties change over the
+         classification. If the shape type is a polygon or a point then
+         the <guibutton>Fix Border Color</guibutton> option will be available.
+         This allows the user to select a border color for all classification
+         groups.
          It is also possible to create a custom color scheme. Selecting
          this option will display two symbols: the one of the left has the
          properties of the first group and the one on the right has the
          properties of the last group. Thuban will interpolate between these
          two properties to generate the other groups.
+         <screenshot>
+         <screeninfo>Custom Color Scheme</screeninfo>
+         <mediaobject>
+         <imageobject><imagedata fileref="../images/5_2_custom_ramp.png" format="PNG" scale="&imgscale;"/></imageobject>
+         <imageobject><imagedata fileref="./images/5_2_custom_ramp.eps" format="EPS" scale="&imgscale;"/></imageobject>
+         <textobject><phrase>Custom Color Scheme</phrase></textobject>
+         <caption><para>Custom Color Scheme</para></caption>
+         </mediaobject>
+         </screenshot>
          </para>
          <para>
          The Unique Values option lets the user select specific values that
-Line 779
+Line 864
          right. Each list can be sorted or reversed for easier searching.
          The classification that is generated will be in the same order as
          the list on the right.
+         <screenshot>
+         <screeninfo>Unique Values</screeninfo>
+         <mediaobject>
+         <imageobject><imagedata fileref="../images/5_2_unique_values.png" format="PNG" scale="&imgscale;"/></imageobject>
+         <imageobject><imagedata fileref="./images/5_2_unique_values.eps" format="EPS" scale="&imgscale;"/></imageobject>
+         <textobject><phrase>Unique Values</phrase></textobject>
+         <caption><para>Unique Values Classification</para></caption>
+         </mediaobject>
+         </screenshot>
          </para>
          <para>
-         The Unique Distribution option creates a user specified number of
+         The Uniform Distribution option creates a user specified number of
          groups of ranges such that each range covers equal intervals. The
          minimum and maximum values can automatically be retrieved from the
          table by clicking <guibutton>Retrieve From Table</guibutton>. The
          stepping is how large each interval is. Adjusting this value will
          automatically recalculate how many groups is appropriate.
+         <screenshot>
+         <screeninfo>Uniform Distribution</screeninfo>
+         <mediaobject>
+         <imageobject><imagedata fileref="../images/5_2_uniform_dist.png" format="PNG" scale="&imgscale;"/></imageobject>
+         <imageobject><imagedata fileref="./images/5_2_uniform_dist.eps" format="EPS" scale="&imgscale;"/></imageobject>
+         <textobject><phrase>Uniform Distribution</phrase></textobject>
+         <caption><para>Uniform Distribution Classification</para></caption>
+         </mediaobject>
+         </screenshot>
          </para>
          <para>
          The Quantiles option generates ranges based on the number of items
-         in the input set. For example, by specifying five groups Thuban will
+         in the table. For example, by specifying five groups Thuban will
          generate five groups with appropriate ranges such that 20% of the table
          data is in each group. If it is impossible to generate exact
          groupings, Thuban will issue a warning but allow the user to continue.
+         <screenshot>
+         <screeninfo>Quantiles</screeninfo>
+         <mediaobject>
+         <imageobject><imagedata fileref="../images/5_2_quantiles.png" format="PNG" scale="&imgscale;"/></imageobject>
+         <imageobject><imagedata fileref="./images/5_2_quantiles.eps" format="EPS" scale="&imgscale;"/></imageobject>
+         <textobject><phrase>Quantiles</phrase></textobject>
+         <caption><para>Quantiles Classification</para></caption>
+         </mediaobject>
+         </screenshot>
          </para>
          </section>
    </chapter>
-Line 855
+Line 967
          <guibutton>Remove</guibutton> button will permanently remove a
          projection from the list of available projections.
          </para>
+         <para>
+         To apply the selected projection to the map the user can click
+         either <guibutton>Try</guibutton> or <guibutton>OK</guibutton>.
+         <guibutton>Try</guibutton> will not close the dialog box, allowing
+         the user to see how the projeciton changes the map.
+         <guibutton>Revert</guibutton> will undo the last projection applied
+         to the map. <guibutton>OK</guibutton> will commit the changes and
+         close the dialog. The user will be unable to undo the changes.
+         <guibutton>Close</guibutton> simply closes the dialog box. If no
+         selection has been applied with <guibutton>Try</guibutton> the
+         selection will not be applied to the map.
+         </para>
      </section>
          <section><title>Importing/Exporting Projections</title>
          <para>
-Line 893
+Line 1017
          </para>
          <para>
          Thuban provides a standard dialog to display table contents, the
-         Table View. The view falls has five sections: The title, selections,
+         Table View. The view has five sections: The title, selections,
          the table grid, export functions, and the status bar.
          </para>
          <para>
-Line 906
+Line 1030
          third choice can be either a specific value (interpreted as numerical
          or string depending on the type of the first field) or a second field
          identifier. Thus you can perform analysis like selecting all
-         records where "population > 10000" or
+         records where <literal>population > 10000</literal> or
-         "cars_per_inhabitant <  bikes_per_inhabitant" (note that the field names
+         <literal>cars_per_inhabitant < bikes_per_inhabitant</literal>
-         are only explanatory, the dBase files allow only
+         (note that the field names are only explanatory, the dBase files
-character field names).
+         allow only 11 character field names).
          Selections can be combined either by applying a selection only on
          a previously selected set of records or by adding the results of a
-Line 917
+Line 1041
          earlier results.
          </para>
          <para>
-         The table grid shows the contents of the table (a record per column),
+         The table grid shows the contents of the table (one record per row),
          with highlighted selection results. Columns and rows can be resized.
          </para>
          <para>
-Line 1044
+Line 1168
      </section>
      <section><title>Attribute Tables</title>
          <para>
-             To clearly separate between both types, Thuban provides
+             To clearly separate between both types of tables (data and
-         functionality regarding the attribute tables under the Layer menu.
+         attribute), Thuban provides functionality regarding the attribute
+         tables under the <menuchoice><guimenu>Layer</guimenu></menuchoice> menu.
          </para>
          <section><title>Show Table</title>
-Line 1099
+Line 1224
    <chapter><title>Trouble Shooting</title>
      <para>
+     Here are a few problems that users have encountered when first using Thuban.
      </para>
+     <para>
      <variablelist>
      <varlistentry>
-     <term>After adding two or more layers nothing is being drawn in the
+     <term>After adding two or more layers nothing is drawn in the map window.
-     map window.
      </term>
      <listitem>
      <para>
      This is probably because the layers have different projections. Projections
-     must be set on all layers and on the map itself if the layer's projections
+     must be set on all layers and on the map itself if the layers' projections
      are different.
      </para>
      </listitem>
-Line 1143
+Line 1269
      </listitem>
      </varlistentry>
      </variablelist>
+     </para>
+     <para>
+     If an error occurs Thuban will display a dialog indicating the error
+     before closing. The text should be copied and reported to the
+     <ulink url="http://thuban.intevation.org/bugtracker.html">
+     Intevation bugtracker
+     </ulink>.
+     More information about the system is available from
+     <menuchoice><guimenu>Help</guimenu><guimenuitem>About</guimenuitem></menuchoice> box.
+     This should also be included in the bug report.
+     <screenshot>
+     <screeninfo>Error Dialog</screeninfo>
+     <mediaobject>
+     <imageobject><imagedata fileref="../images/8_int_error.png" format="PNG" scale="&imgscale;"/></imageobject>
+     <imageobject><imagedata fileref="./images/8_int_error.eps" format="EPS" scale="&imgscale;"/></imageobject>
+     <textobject><phrase>Error Dialog</phrase></textobject>
+     <caption><para>Error Dialog</para></caption>
+     </mediaobject>
+     </screenshot>
+     </para>
    </chapter>

 Legend:



Removed from v.1507
 


changed lines


 
Added in v.1530
 Legend:



Removed from v.1507
 


changed lines


 
Added in v.1530
-Removed from v.1507
+Added in v.1530

[email protected]	ViewVC Help
Powered by ViewVC 1.1.26