Documentation updated.

Author: RuedigerLunde

aimax-osm/README.txt

@@ -6,7 +6,9 @@ This project provides a framework for building intelligent Open Street Map
 (OSM) data applications. It was originally designed to validate and test agent
 and search concepts from the AIMA library in an interesting, non-trivial
 application area. Meanwhile, it provides a framework for building small
-navigation systems.
+navigation systems. Two GUIs are provided:
+One based on JavaFX (package <code>aimax.osm.gui.fx</code>) and the other based on
+Swing (package <code>aimax.osm.gui.swing</code>).
 
 The framework provides interfaces for central parts of the system and additionally
 example implementations. In the current version, the fundamental data structures
@@ -17,7 +19,7 @@ demonstrates how to plug the components together and provides means to integrate
 own versions of the needed components.
 
 Central part of the project is an OSM viewer implementation. It is designed
-as an efficient general purpose viewer which is highly configurable and extendible.
+as an efficient general purpose viewer which is highly configurable and extendable.
 
 The internal default map representation is chosen as close as possible to the
 original OSM XML file format. A kd-tree is used to improve rendering efficiency.
@@ -26,7 +28,7 @@ visual appearance within the drawn map are controlled by declarative
 rendering rules. They can be replaced or configured at runtime.
 New personal map styles can be created quite easily. See classes
 <code>aimax.osm.viewer.MapStyleFactory</code> and
-<code>aimax.osm.application.OsmViewerPlusApp</code> for ideas how that
+<code>aimax.osm.gui.swing.applications.OsmViewerPlusApp</code> for ideas how that
 can be achieved.
 
 Routing functionality is based on the AIMA-CORE library.
@@ -42,11 +44,12 @@ cities like Berlin can be loaded and displayed without any problem if enough
 heap space is provided (VM argument -Xmx500M).
 
 Getting started: Run one of the applications in the
+<code>aimax.osm.gui.fx.applications</code> or
 <code>aimax.osm.gui.swing.applications</code> package. If no map is displayed
 by default, make sure that the main/resource folder is included 
 in the build path of your project, recompile and start again.
-Then, place the mouse inside the map viewer pane. Try mouse-left, mouse-right,
-mouse-drag, ctrl-mouse-left, plus button, minus button, shift-plus, shift-minus,
+Then, place the mouse inside the map viewer pane. Try mouse-left, mouse-middle,
+mouse-right, mouse-drag, ctrl-mouse-left, plus button, minus button, shift-plus, shift-minus,
 alt-plus, alt-minus, space, ctrl-space, arrow buttons, and also the mouse-wheel
 for navigation, mark setting, and track definition. For routing, at least two
 markers must be set.

aimax-osm/src/main/javadoc/overview.html

@@ -5,14 +5,14 @@
     One based on JavaFX (package <code>aimax.osm.gui.fx</code>) and the other based on
     Swing (package <code>aimax.osm.gui.swing</code>).
     The viewer is designed as an efficient general purpose viewer which is highly configurable and
-    extendible. The internal map representation is chosen as close as possible to the
+    extendable. The internal map representation is chosen as close as possible to the
     original OSM XML file format. A kd-tree is used to improve rendering efficiency.
     Classification and abstraction of map entities as well as their
     visual appearance within the drawn map are controlled by declarative
     rendering rules. They can be replaced or configured at runtime.
     New personal map styles can be created quite easily. See classes
     <code>aimax.osm.viewer.MapStyleFactory</code> and
-    <code>aimax.osm.gui.swing.application.OsmViewerPlusApp</code> for ideas how that can be
+    <code>aimax.osm.gui.swing.applications.OsmViewerPlusApp</code> for ideas how that can be
     achieved.
 
 <p>Routing functionality is based on the AIMA-JAVA core library.
@@ -30,7 +30,7 @@
     in the <code>aimax.osm.gui.fx.applications</code> package. If no map is displayed
     by default, make sure that the main/resource folder is included in
     the build path of your project, recompile and start again.
-    Then place the mouse inside the map viewer pane. Try mouse-left, mouse-right,
+    Then place the mouse inside the map viewer pane. Try mouse-left, mouse-middle, mouse-right,
     mouse-drag, ctrl-mouse-left, plus button, minus button, ctrl-plus, ctrl-minus,
     space, ctrl-space, arrow buttons, and also the mouse-wheel for navigation,
     mark setting, and track definition. Before routing, at least two markers