Skip to content

Commit f71dd55

Browse files
offtherailzofftherailz
committed
Merge branch 'fouad-semaan-user-guide-1' into user_docs
2 parents 4d0695f + a5f384c commit f71dd55

214 files changed

Lines changed: 1141 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/user-guide/admin.md‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Managing Users and Groups
2+
***************************
3+
4+
From the *Home Page*:
5+
6+
* **Click** on the *Account* icon then **Log in** as administrator.
7+
8+
<img src="img/account.png" style="max-width:500px;" />
9+
10+
* **Click** on the *Manager Menu* then on *MANAGE ACCOUNTS*.
11+
12+
<img src="img/manager.png" style="max-width:600px;" />
13+
14+
You will be addressed to a new page that contains mainly a <span style="color:red">Manage Users</span> and a <span style="color:blue">Manage Groups</span> pages which allow you to create new or to modify already existing users and groups.
15+
16+
<img src="img/manager-page.png" style="" />
17+
18+
# Managing Users
19+
****************
20+
Creating New User
21+
-----------------
22+
From the *Users* page:
23+
24+
* **Click** on *New User* icon <img src="img/new-user.png" style="width:60px;height:20px" />. A pop up form will open.
25+
* **Fill** the first page of the form by assigning a *Username* and a *Password*.
26+
* **Select** from the list menu to assign a user or an admin role for the user.
27+
* Finally, **Check** the flag to enable the user.
28+
29+
<img src="img/popup-user.png" style="max-width:200px;" />
30+
31+
32+
!!! note
33+
Enabled users will have a green status icon under their profile otherwise will have a red status and will not be able to log in.
34+
35+
<p align = "center" > <img src="img/user-status.png" style="max-width:400px;" /></p>
36+
37+
38+
39+
* On the second page, **Compile** the page by providing further informations about the user.
40+
41+
<img src="img/info-user.png" style="max-width:200px;" />
42+
43+
* On the third page, **Select** the groups in which the user will be a part of then **Click** on *Create*.
44+
45+
<img src="img/user-group.png" style="max-width:200px;" />
46+
47+
<br>
48+
<br>
49+
50+
**Editing a User**
51+
----------------
52+
From the *Users* page:
53+
54+
* **Click** on the *Settings* icon in order to edit a user, you will be redirected to the pop up form where you can change the user details.
55+
56+
<img src="img/edit-user.png" style="max-width:500px;" />
57+
58+
* Or, **Click** simply on the <img src="img/delete-icon.png" style="width:20px;height:20px" /> icon to delete the user.
59+
60+
# Managing Groups
61+
*****************
62+
Creating New Group
63+
------------------
64+
From the *Groups* page:
65+
66+
* **Click** on *New Group* icon <img src="img/new-group.png" style="width:60px;height:20px" />. A pop up form will open, **Fill** the first page of the form by assigning a *Group Name* and a *Description*.
67+
68+
<img src="img/popup-group.png" style="max-width:200px;" />
69+
70+
* On the second page, you can add members to the group. **Type** the user name under *Add Member* to find it then **Click** on it to add it to the list.
71+
72+
<img src="img/add-user.png" style="max-width:500px;" />
73+
74+
Edit a Group
75+
------------
76+
As for users, you can use the edit icon <img src="img/edit-icon.png" style="width:20px;height:20px" /> to modify the group settings or the delete icon <img src="img/delete-icon.png" style="width:20px;height:20px" /> to delete the group.

‎docs/user-guide/annotations.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Adding Annotations
2+
********************
3+
4+
Starting from a new map or an already existing map:
5+
6+
* **Click** on the *Burger menu* button <img src="img/burger.png" style="max-width:25px;" /> from the main menu bar.
7+
* **Click** on the *Annotations* option from the list <img src="img/annotation-option.png" style="max-width:100px;"/>.
8+
9+
The annotation page will open.
10+
11+
<p align = "center" ><img src="img/annotation-page.png" style="max-width:500px;" /></p>
12+
13+
* **Click** on <img src="img/annotation-new.png" style="max-width:40px;" /> to add a new annotation.
14+
15+
You will be addressed to a new page where you can draw on the map and edit the annotation properties.
16+
17+
<p align = "center" ><img src="img/annotation-edit.png" style="max-width:500px;" /></p>
18+
19+
* **Click** on <img src="img/annotation-draw.png" style="max-width:25px;" /> to draw the annotation on the map.
20+
21+
* **Click** on the map to draw it. **Enter** a title and a description then click on save.
22+
23+
<p align = "center" ><img src="img/annotation-geosolutions.png" style="max-width:500px;" /></p>
24+
25+
The annotation will be added to the TOC and to the annotations list as in the figure below.
26+
27+
<img src="img/annotation-geosolutions-1.png" style="max-width:700px;" />
28+
29+
Editing an Annotation
30+
------------------
31+
32+
From the annotations list on the right:
33+
34+
* **Click** on the annotation you want to edit. You will be addressed to a new page.
35+
36+
<p align = "center" ><img src="img/annotation-geosolutions-edit.png" style="max-width:500px;" /></p>
37+
38+
* **Click** on *Edit*. You will be addressed to the main annotations page.
39+
40+
<p align = "center" ><img src="img/annotation-geosolutions.png" style="max-width:500px;" /></p>
41+
42+
* **Click** on <img src="img/annotation-geosolutions-edit-1.png" style="max-width:20px;" /> button to change the marker style.
43+
44+
45+
<p align = "center" ><img src="img/annotation-marker.png" style="max-width:500px;" /></p>
46+
47+
* **Save** the edits.
48+
49+
<p align = "center" ><img src="img/annotation-marker-1.png" style="max-width:500px;" /></p>

‎docs/user-guide/attributes-table.md‎

Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
1+
# Attribute Table
2+
*****************
3+
In GIS, the attribute table associated to a vector layer is a table that stores tabular informations related to the layer. The columns of the table are called fields and the rows are called records. Each record of the attribute table corrisponds to one feature geometry of the layer. This relation allows to find records in the table (informations) by selecting features on the map and viceversa.
4+
5+
In [MapStore 2](https://mapstore2.geo-solutions.it/mapstore/#/), accessing the attribute table of a vector layer allows you to edit the tabular data or directly the geometries on the map, to perform spatial queries and filters, and to create widgets from the data.
6+
7+
!!! note
8+
Creating widgets for a layer is accessible from the *TOC* and the *Attribute Table* by clicking on this icon <img src="img/widgets.png" style="max-width:20px;"/> and was already treated in the [Widgets](widgets.md) section.
9+
10+
* **Open** a new map.
11+
* **Add** a vector layer (e.g. USA Population).
12+
* **Select** the layer.
13+
* **Click** on the *Open Attribute Table* icon <img src="img/attributes-table.png" style="max-width:20px;"/>, you will note that the table has 49 items (rows).
14+
15+
The attribute table will open showing the data table and a set of functionalities.
16+
17+
<img src="img/attributes-table-1.png" style="max-width:600px;"/>
18+
19+
Editing
20+
-------
21+
22+
Nono lo so! Per ora la lascio.
23+
24+
25+
Advanced Filtering
26+
------------------
27+
28+
[MapStore 2](https://mapstore2.geo-solutions.it/mapstore/#/) allows you to filter and select the data by attribute or by region and to perform cross filtering between two present layers in the map.
29+
30+
* **Click** on the *Advanced Search* icon <img src="img/filter-icon.png" style="max-width:25px;" />.
31+
32+
The filtering page will open showing *Filters Types*.
33+
34+
<p align = "center" ><img src="img/filter-types.png" style="max-width:500px;"/></p>
35+
36+
### Filtering by Attributes
37+
38+
the *Attribute Filter* allows you to set conditions on the fields to perform **AND**/**OR** logic operations.
39+
40+
Since the following example is based on filtering the data with respect to the *Persons* and *Employed* filelds, let us first switch off the unnecessary fields for a better visualization. To do that:
41+
42+
* **Click** on the *Hide/Show columns* button <img src="img/hide-show.png" style="max-width:25px;" />.
43+
44+
* **Switch off** the fields leaving only the **STATE_NAME**, **PERSONS** and **EMPLOYED**.
45+
46+
<p align = "center" ><img src="img/hide-show-1.png" style="max-width:620px;"/></p>
47+
48+
Now, let us set some filters.
49+
50+
* **Click** on the <img src="img/++.png" style="max-width:20px;"/> button to add a condition.
51+
52+
<p align = "center" ><img src="img/attribute-filter-1.png" style="max-width:500px;"/></p>
53+
54+
* **Set** the following condition for example; **Persons >= 6 000 000**.
55+
56+
<p align = "center" ><img src="img/attribute-filter-5.png" style="max-width:620px;"/></p>
57+
58+
* **Click** on the loop icon to search <img src="img/loop.png" style="max-width:20px;"/>
59+
60+
The filtered records by persons will be shown in the attribute table.
61+
62+
<p align = "center" ><img src="img/attribute-filter-2.png" style="max-width:620px;"/></p>
63+
64+
!!!note
65+
We have got 13 items.
66+
67+
If you want to to see the filtered records also on the map.
68+
69+
* **Click** on the <img src="img/sync.png" style="max-width:20px;"/> icon to synchronize the map with the filter.
70+
71+
<p align = "center" ><img src="img/attribute-filter-3.png" style="max-width:620px;"/></p>
72+
73+
Now let us add other conditions.
74+
75+
* **Click** again on the *Advanced Search* icon <img src="img/filter-icon.png" style="max-width:25px;" />.
76+
77+
* **Click** on the <img src="img/++.png" style="max-width:20px;"/> button to add a second condition.
78+
79+
* **Set** the following condition, for example the employed persons between 2M and 5M; **Employed >< 2 000 000, 5 000 000**.
80+
81+
!!! note
82+
We are using *"Match any of the following conditions"* which is an **OR** logic operator.
83+
84+
<p align = "center" ><img src="img/attribute-filter-4.png" style="max-width:620px;"/></p>
85+
86+
* **Click** on the loop icon to search <img src="img/loop.png" style="max-width:20px;"/>.
87+
88+
The filter will return 20 records.
89+
90+
<p align = "center" ><img src="img/attribute-filter-6.png" style="max-width:620px;"/></p>
91+
92+
In order to switch to an **AND** operator.
93+
94+
* **Click** again on the *Advanced Search* icon <img src="img/filter-icon.png" style="max-width:25px;" />.
95+
96+
* **Select** form the droplist **all** instead of **any**.
97+
98+
<p align = "center" ><img src="img/attribute-filter-7.png" style="max-width:620px;"/></p>
99+
100+
* **Click** on the loop icon to search <img src="img/loop.png" style="max-width:20px;"/>.
101+
102+
The filter will return 7 records.
103+
104+
105+
<p align = "center" ><img src="img/attribute-filter-8.png" style="max-width:620px;"/></p>
106+
107+
### Filtering by Location
108+
109+
The second filter type called **Region of Interest** allows the user to filter the features overlaying drawn geometric shapes on the map.
110+
111+
<p align = "center" ><img src="img/geometry-filter.png" style="max-width:620px;"/></p>
112+
113+
* **Select** the *Filter Type*, e.g. Circle.
114+
* **Draw** the circle on the map; eventually you can change the position of the center and the radius by clicking on the icon <img src="img/edit-icon-1.png" style="max-width:30px;"/>.
115+
* **Set** the *Geomatric Operation*, e.g.Contains.
116+
117+
<p align = "center" ><img src="img/geometry-filter-1.png" style="max-width:700px;"/></p>
118+
119+
* **Click** on the loop icon to apply the filter <img src="img/loop.png" style="max-width:20px;"/>.
120+
121+
<p align = "center" ><img src="img/geometry-filter-2.png" style="max-width:600px;"/></p>
122+
123+
!!! note
124+
The *Geometric Operation* **Contains** will extract the features entirely contained in the drawn geometry while the *Geometric Operation* **Intersects** will extract the features that have a part intersecting the geometry.
125+
126+
### Layer Filtering
127+
128+
*Layer Filter* allows the user to filter the features of a vector layer with respect to another one. For example, which features of the first layer are contained in the second or intersect the second.
129+
130+
* **Open** a new map.
131+
* **Add** a vector layer (e.g. thematism_regioni).
132+
* **Add** a second vector layer (e.g. Unesco Items)
133+
134+
<p align = "center" ><img src="img/layer-filter-1.png" style="max-width:600px;"/></p>
135+
136+
Let us suppose that we want to get all the Unesco sites in Sicily. To do it:
137+
138+
139+
* **Select** the layer *Unseco Items*.
140+
* **Click** on the *Open Attribute Table* icon <img src="img/attributes-table.png" style="max-width:20px;"/>.
141+
* **Click** on the *Advanced Search* icon <img src="img/filter-icon.png" style="max-width:25px;" />.
142+
143+
In the *Layer filter* section:
144+
145+
* **Set** the *Target layer* choosing the layer *thematism_regioni* from the list.
146+
* **Choose** the appropriate *Operation*; in this case *Contains*.
147+
* **Add** a condition as the following: **cod_reg = 19** since the region code of Sicily is equal to 19.
148+
149+
<p align = "center" ><img src="img/layer-filter-2.png" style="max-width:600px;"/></p>
150+
151+
* **Click** on the loop icon to apply the filter <img src="img/loop.png" style="max-width:20px;"/>.
152+
153+
Apparently nothing is changed on the map but the filter returned 20 items in the attributes table.
154+
155+
* **Click** on the <img src="img/sync.png" style="max-width:20px;"/> icon to synchronize the map with the filter.
156+
157+
<p align = "center" ><img src="img/layer-filter-3.png" style="max-width:600px;"/></p>

‎docs/user-guide/basemap.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Basemap Switcher
2+
******************
3+
4+
The Basemap Switcher situated in the bottom left corner of the Data Frame allows you to change the world map background.
5+
6+
* **Click** on the map miniature on the bottom left corner.
7+
8+
<img src="img/basemap.png" style="max-width:600px;" />
9+
10+
* Several miniatures will be displayed that can be chosen in order to change the map background, such as Open Street Map, Google HYBRID, NASAGIBS, and OpenTopoMap. For example, **Choose** the OpenTopoMap basemap. The background of the map will change consequently.
11+
12+
<img src="img/topobasemap.png" style="max-width:600px;" />

‎docs/user-guide/catalog.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Catalog Services
2+
******************
3+
4+
The Catalog Service for the Web (CSW) is an OGC Standard to publish and search geospatial data and related metadata on the internet. It describes geospatial services such as Web Map Service (WMS) and Web Map Tile Service (WMTS).
5+
6+
In [MapStore 2](https://mapstore2.geo-solutions.it/mapstore/#/) the Catalog offers demo services that allow you to extract the data and add them to the map from GeoServer or to create connections to other Geoportal services.
7+
8+
Adding Layers from Demo Services
9+
--------------------------------
10+
11+
CSW, WMS and WMTS Demo Services are available by default allowing you to import layers from GeoServer and to add them to your map.
12+
13+
Starting from a new map or an already existing map:
14+
15+
* **Click** on the *Burger menu* button <img src="img/burger.png" style="max-width:25px;" /> from the main menu bar.
16+
* **Click** on the *Catalog* option from the list <img src="img/catalog-option.png" style="max-width:80px;" />.
17+
18+
The Catalog page will open showing a list of services, a search box to search the layers by name and a list of the retrieved layers ready to be added to the map.
19+
20+
<p align = "center" ><img src="img/catalog-page.png" style="max-width:500px;" /></p>
21+
22+
* **Select** from the list *Demo WMS Service* for example.
23+
24+
<p align = "center" ><img src="img/service-list.png" style="max-width:500px;" /></p>
25+
26+
* **Type** a text in the search box, e.g. black, then click on the search button.
27+
28+
<p align = "center" ><img src="img/catalog-search.png" style="max-width:500px;" /></p>
29+
30+
* **Add** the layer to the map clicking on <img src="img/add-to-map.png" style="max-width:80px;" />.
31+
32+
Adding and Editing a Service
33+
----------------------------
34+
35+
As mentioned before, [MapStore 2](https://mapstore2.geo-solutions.it/mapstore/#/) allows you to connect to remote services and to import the data from them.
36+
37+
* **Click** on the <img src="img/+.png" style="max-width:80px;" /> button to add a new service.
38+
39+
<p align = "center" ><img src="img/new-service.png" style="max-width:500px;" /></p>
40+
41+
* **Type** the URL name, e.g. http://tms.comune.fi.it/geowebcache/service/wms, and the Title.
42+
* **Select** the Type of the service.
43+
* **Save** the service created.
44+
45+
<p align = "center" ><img src="img/new-service-firenze.png" style="max-width:500px;" /></p>
46+
47+
A list of layers will be loaded from the portal ready to be added to your map.
48+
49+
<p align = "center" ><img src="img/catalog-firenze.png" style="max-width:500px;" /></p>
50+
51+
In order to edit a service, **Click** on the edit button <img src="img/edit-service.png" style="max-width:80px;" /> and apply your changes.

0 commit comments

Comments
 (0)