finish UI section draft

gisquick · Jul 13, 2017 · 1ea2d1b · 1ea2d1b
1 parent 0194810
commit 1ea2d1b
Show file tree

Hide file tree

Showing 21 changed files with 80,901 additions and 45 deletions.
diff --git a/docs/img/about-window.png b/docs/img/about-window.png
diff --git a/docs/img/map-attribution.png b/docs/img/map-attribution.png
diff --git a/docs/img/map-attribution.svg b/docs/img/map-attribution.svg
diff --git a/docs/img/measure-area.png b/docs/img/measure-area.png
diff --git a/docs/img/measure-area.svg b/docs/img/measure-area.svg
diff --git a/docs/img/measure-distance.png b/docs/img/measure-distance.png
diff --git a/docs/img/measure-distance.svg b/docs/img/measure-distance.svg
diff --git a/docs/img/measure-location.png b/docs/img/measure-location.png
diff --git a/docs/img/measure-location.svg b/docs/img/measure-location.svg
diff --git a/docs/img/ui-area-menu.png b/docs/img/ui-area-menu.png
diff --git a/docs/img/ui-distance-menu.png b/docs/img/ui-distance-menu.png
diff --git a/docs/img/ui-identify.png b/docs/img/ui-identify.png
diff --git a/docs/img/ui-location-menu.png b/docs/img/ui-location-menu.png
diff --git a/docs/img/ui-measure-tools.png b/docs/img/ui-measure-tools.png
diff --git a/docs/img/ui-measure.png b/docs/img/ui-measure.png
diff --git a/docs/img/ui-print.png b/docs/img/ui-print.png
diff --git a/docs/img/ui-user-menu.png b/docs/img/ui-user-menu.png
diff --git a/docs/index.rst b/docs/index.rst
@@ -14,8 +14,8 @@ and overlay layers, attribute table data filtering, measuring
 coordinates, length or area, and handy project printing from
 ready-to-use web application.
 
-An integral part of publishing mechanism is a **Gisquick QGIS
-plugin**. Following subsections give a detailed insight into whole
+An integral part of publishing mechanism is a *Gisquick QGIS
+plugin*. Following subsections give a detailed insight into whole
 technology.
 
 .. toctree::

diff --git a/docs/other.rst b/docs/other.rst
@@ -5,17 +5,11 @@ Other
 .. _technologies-web:
 
 ------------
-Promo videos
+Video tutorials
 ------------
 
-To get the better idea what Gisquick is, see video below.
-
-.. raw:: html
-
-   <center><iframe width="560" height="315"
-   src="https://www.youtube.com/embed/7vBM1X5QuqE" frameborder="0"
-   allowfullscreen></iframe></center> <p>
-
+Gisquick video tutorials are available from `Youtube channel
+<https://www.youtube.com/channel/UCHXyhq_wrEBnGYTRJovxrCg/videos>`__.
 
 ------------
 Technologies

diff --git a/docs/project-publishing.rst b/docs/project-publishing.rst
@@ -76,6 +76,8 @@ cached by QGIS server and re-used when possible.
 
 .. figure:: ./img/project-publishing-2.png
 
+.. _publication-metadata:
+
 The last ``Project`` subpage allows defining basic project metadata
 like title, extent, min/max scales, info message, access constraints,
 etc.
@@ -191,6 +193,8 @@ As the final step, open web browser and launch published project in
 Gisquick interface by entering URL, in our case
 eg. https://localhost:8000?PROJECT=vagrant/prague/prague.qgs.
 
+.. _guest-session:
+
 You will see welcome screen with possibility to enter credential
 (*vagrant/vagrant* or other used user account) but for now, you can
 just ``Continue as guest``.

diff --git a/docs/user-interface.rst b/docs/user-interface.rst
@@ -13,15 +13,15 @@
 .. |zoom-extent| image:: ./img/ui-zoom-tools-extent.png
    :width: 2.5em
 .. |identify| image:: ./img/ui-identify.png
-   :width: 2.5em
+   :width: 2.2em
 .. |measure| image:: ./img/ui-measure.png
-   :width: 2.5em
+   :width: 2.2em
 .. |print| image:: ./img/ui-print.png
-   :width: 2.5em
+   :width: 2.2em
 
-==============
-User Interface
-==============
+================
+ User Interface
+================
 
 The Gisquick clients User Interface (UI) are designed with a goal to
 put together minimal set of functions for useful generic responsive
@@ -42,9 +42,8 @@ scale, projection and map coordinates of the cursor (``8``).
 
 .. _content-menu:
 
-------------------
 Content management
-------------------
+==================
 
 Basic project metadata - project description - is accessible by
 questionmark, see figure below.
@@ -60,7 +59,7 @@ Content management widget is split into three major tabs:
 * Legend
 
 .. figure:: ./img/content-tabs.png
-   :width: 200px
+   :width: 250px
 
    Content tabs.
 
@@ -69,7 +68,7 @@ list of base layers is defined by publication process as described in
 :ref:`Project publishing <publication-base-layers>` section.
 
 .. figure:: ./img/ui-base-layers.png
-   :width: 200px
+   :width: 250px
 
    Switching between base layers.
 
@@ -78,19 +77,19 @@ see :ref:`Project publishing <publication-topics>` section, or
 controlling overlay layers one by one.
 
 .. figure:: ./img/ui-overlay-layers.png
-   :width: 200px
+   :width: 250px
 
    Topics or map layers switcher.
 
 .. figure:: ./img/ui-topics.png
-   :width: 200px
+   :width: 250px
 
    Switching between topics.
 
 In ``Layers`` mode the overlay layers can be switch on/off one by one.
 
 .. figure:: ./img/ui-map-layers.png
-   :width: 200px
+   :width: 250px
 
    Switch on/off overlayer layers.
 
@@ -135,9 +134,8 @@ example below.
 
 .. _zoom-menu:
 
-----------
 Zoom tools
-----------
+==========
 
 Zoom tools enables controling map view.
 
@@ -153,18 +151,16 @@ Zoom tools enables controling map view.
 
 .. _tool-menu:
 
------
 Tools
------
+=====
 
 Two basic tools are available:
 
 * Identify |identify|, and
 * Measurement |measure|
 
-~~~~~~~~
 Identify
-~~~~~~~~
+--------
 
 By default, features are identified in all visible layers (in the
 example below in Schools and District layers).
@@ -176,35 +172,114 @@ example below in Schools and District layers).
 This settings can be changed in ``Identification`` combobox.
 
 .. figure:: ./img/identification-layers.png
-   :width: 200px
+   :width: 250px
 
    Change layer priority for identification.
 
-~~~~~~~~~~~~
-Measurements
-~~~~~~~~~~~~
+Measurement
+-----------
+
+Three measurement modes are available:
+
+* Location (point coordinates)
+* Distance
+* Area
+
+.. figure:: ./img/ui-measure-tools.png
+   :width: 250px
+
+   Measurement tools.
+
+.. figure:: ./img/measure-location.svg
+
+   Location measurement example. Menu highlighted in red box.
+
+Location menu allows:
+
+* Zoom to location
+* Change spatial reference system. By default two system are
+  supported: QGIS project system and WGS-84 (EPSG:4326) known as "GPS
+  coordinates".
+
+.. figure:: ./img/ui-location-menu.png
+   :width: 250px
+
+   Location menu.
+
+.. figure:: ./img/measure-distance.svg
+
+   Distance measurement example. Menu highlighted in red box.
+
+Distance menu allows:
+
+* Zoom to distance
+* Change units. Currently two systems are supported: international
+  (EU) and imperial (UK, US)
+
+.. figure:: ./img/ui-distance-menu.png
+   :width: 250px
+
+   Distance menu.
+
+.. figure:: ./img/measure-area.svg
+
+   Area measurement example. Menu highlighted in red box.
+
+Area menu allows:
+
+* Zoom to distance
+* Change units. Currently two systems are supported: international
+  (EU) and imperial (UK, US)
+
+.. figure:: ./img/ui-area-menu.png
+   :width: 250px
+
+   Area menu.
+
+.. note:: Currently **no snapping** to features is supported by
+          measurement tools.
 
 .. _print-tool:
 
-~~~~~~~~~~
 Print tool
-~~~~~~~~~~
+----------
 
-|print| The main idea is, that once print is activated in Gisquick,
-it will download raw print output from QGIS Server using GetPrint
-request and will allow interactive visualization of map content
-directly in this template.  One can zoom, pan and rotate map and see
-exactly how the result will look like.  To get the better idea, see
-video below.
+|print| The main idea is, that once print is activated in Gisquick, it
+means that before :doc:`project publication <project-publishing>` is
+defined map composer in QGIS Desktop, it will download raw print
+output from QGIS Server using GetPrint request and will allow
+interactive visualization of map content directly in this template.
+One can zoom, pan and rotate map and see exactly how the result will
+look like.  To get the better idea, see video below.
 
 .. raw:: html
 
    <center><iframe width="560" height="315" src="https://www.youtube.com/embed/1g0YduhPwpk" frameborder="0" allowfullscreen></iframe></center>
    <p>
 
-.. todo:: |todo| Web layout atď. ...
+.. important:: |imp| Print tool in Gisquick is not accessible in
+   :ref:`Guest session <guest-session>`, only log in users can use
+   this tool.
 
----------
 User menu
----------
+=========
 
+User menu allows to:
+
+* Log out current user
+* Enter/Leave Full Screen mode
+* Display attributions
+* Show Help (this document)
+* Show Project About (see :ref:`Project publishing
+  <publication-metadata>` section)
+
+.. figure:: ./img/map-attribution.svg
+
+   Map attributions displayed.
+
+.. figure:: ./img/about-window.png
+   :width: 300px
+
+   About window showing information about Project and Gisquick itself.
+
+.. todo:: Explain User Profile.