Skip to content

Commit 9d97889

Browse files
anneschaussrtroilo
anneschauss
and
rtroilo
authored
Help page andf FAQs (#539)
* Help page andf FAQs --------- Co-authored-by: Rafael Troilo <rafael.troilo@heigit.org>
1 parent 47e7f2a commit 9d97889

File tree

5 files changed

+68
-52
lines changed

5 files changed

+68
-52
lines changed

‎sketch_map_tool/static/assets/images/help/ohsome_dashboard_overview.webp‎

73.3 KB
Loading

‎sketch_map_tool/static/assets/images/help/ohsome_dashboard_report.webp‎

57.4 KB
Loading

‎sketch_map_tool/static/assets/images/help/quality_indicators.webp‎

38.5 KB
Loading

‎sketch_map_tool/static/assets/images/help/topic_selection.webp‎

10.3 KB
Loading

‎sketch_map_tool/templates/help.html‎

Lines changed: 68 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
{{ _('Our new <a
4242
href="https://giscience.github.io/gis-training-resource-center/content/Mobile_Data_collection/en_SMT_training.html"
4343
target="_blank">training platform</a>
44-
provides five distinct training exercises to further explore the Sketch Map Tool and sketch mapping in general.
44+
provides distinct training exercises to further explore the Sketch Map Tool and sketch mapping in general.
4545
These exercises are primarily designed for workshop settings, allowing for collaborative discussion of your
4646
experiences.') }}
4747

@@ -161,61 +161,88 @@ <h5>{{ _('Recommendations') }}</h5>
161161
</ul>
162162
</li>
163163
</ul>
164-
<p>
165-
{{ _('If you like to learn more about the challenges of map orientation and how to choose a good base map,
166-
take a look at <a
167-
href="https://giscience.github.io/gis-training-resource-center/content/Mobile_Data_collection/en_SMT_ex2_.html"
168-
target="_blank">Training Exercise 2</a>.') }}
169-
</p>
170-
164+
171165
</article>
172166

173167
</details>
174168
<details>
175169
<summary id="map-quality-check">1.2 {{ _('Map Quality Check') }}</summary>
176170
<article>
177171
<p>
178-
{{ _('When you choose <a href="https://osm.org/" target="_blank">OpenStreetMap (OSM)</a> as base map layer, you will be
179-
provided with a report on the map quality in your Area of Interest (AOI). The Map Quality Check gives an evaluation of
180-
the suitability of the local OSM data of your AOI for participatory mapping. The report is computed by the
181-
<a href="https://api.quality.ohsome.org/">ohsome quality API</a> of <a href="https://heigit.org/">HeiGIT</a>.
182-
The Map Quality Check can be downloaded as a PDF file by clicking on the blue button.') }}
172+
{{ _('When you choose <a href="https://osm.org/" target="_blank">OpenStreetMap (OSM)</a> as base map layer, you can
173+
analyze the base map data of your selected area of interest directly in the ohsome Dashboard <a href="https://dashboard.ohsome.org">.
174+
Making use of the <a href="https://api.quality.ohsome.org/">ohsome quality API</a> quality checks are performed and displayed in the
175+
dashboard and the report, as shown in the figure below.
176+
This provides important insights into the suitability of the base map data for field data collection.' ) }}
183177
</p>
184178

185-
<figure> <!-- figure needs to be changed. link to the figure-->
186-
<img src="{{ url_for("static", filename="assets/images/help/1_2_map_quality_report.webp" ) }}"
187-
alt="{{ _('Map Quality Report.') }}">
179+
<figure> <!-- Figure ohsome dashboard-->
180+
<img src="{{ url_for("static", filename="assets/images/help/ohsome_dashboard_overview.webp" ) }}"
181+
alt="{{ _('ohsome dashboard overview.') }}">
188182
<figcaption></figcaption>
189183
</figure>
184+
<p>
185+
{{ _('By clicking the <b>Get Quality Report</b> button, the dashboard is directly opened in a new tab.
186+
The area of interest selected in the Sketch Map Tool is automatically transferred to the dashboard,
187+
and an analysis of the <b>completeness</b> and <b>currency</b> of the <b>road data</b> in that area in the OSM data set is conducted.
188+
A marker in the top left corner of the report visually indicates how good the quality of the data is, using the familiar traffic light system.
189+
In the case of a <b>green marker</b> (in the figure <b>high currentness</b> and <b>high completeness</b>),
190+
the data foundation is sensibly usable given the examined quality aspect. In the case of a <b>red</b> output, this criterion should be examined more closely.') }}
191+
</p>
190192

191-
<h5>{{ _('Recommendations') }}</h5>
193+
<figure> <!-- Figure ohsome dashboard report-->
194+
<img src="{{ url_for("static", filename="assets/images/help/ohsome_dashboard_report.webp" ) }}"
195+
alt="{{ _('ohsome dashboard overview.') }}">
196+
<figcaption></figcaption>
197+
</figure>
198+
199+
<p>
200+
{{ _('Example: If the report shows a <b>red</b> output for completeness, it may be difficult to orient oneself due to the lack
201+
of data in the selected area in OSM. If the report shows such output for currentness, it means the existing data has not
202+
been updated or expanded for a long time, which indicates that the data in the selected area could be outdated.
203+
In both cases, it could be useful to improve the OSM data foundation through personal mapping in OpenStreetMap or
204+
with the help of the <a href="https://www.missingmaps.org/" target="_blank">Missing Maps project</a> and/or
205+
<a href="https://www.hotosm.org/" target="_blank">Humanitarian OpenStreetMap Team</a> Communities. Please feel free to get in touch if
206+
you would like to learn more, we are happy to support.') }}
207+
</p>
208+
209+
210+
<h5>{{ _('What is the benefit of this new ohsome dashboard integration? + Recommendations') }}</h5>
192211
<ul>
193212
<li>
194213
{{ _('Before you use these OSM-based Sketch Maps for participatory mapping in your area of interest,
195-
review the analysis provided by the Map Quality Check to ensure that participants can orient themselves
214+
you can review the analysis provided by the Map Quality Check to ensure that participants can orient themselves
196215
properly on the paper maps.') }}
197216
</li>
198217
<li>
199-
{{ _('The analyses focus on Point of Interest (POI) density, the last edit of amenities and streets, used
200-
sources, as well as the saturation of amenity and road network mapping.
201-
Detailed information about each indicator and the analysis is available in the generated PDF report.') }}
202-
</li>
203-
<li>
204-
{{ _('The report includes useful recommendations to ensure that the generated maps are suitable for
205-
participatory mapping.') }}
206-
</li>
207-
<li>
208-
{{ _('In case the OSM data in your area of interest is not sufficient for participatory mapping, consider
209-
the opportunity to improve the OSM data before printing the Sketch Maps, by organizing an OSM Mapathon.
210-
For more information and help on how to conduct a Mapathon please take a look at the
211-
<a href="https://www.missingmaps.org/" target="_blank">Missing Maps project</a>') }}.
212-
</li>
218+
{{ _('You are automatically provided with analyses in the ohsome dashboard directly. In contrast to having as before a static PDF report,
219+
this setup to enables you to also adapt and complement the automatically conducted analyses according to your needs.
220+
While road data is automatically checked for you can choose from a wide selection of topics in regard to OSM data:') }}
221+
222+
<figure> <!-- Figure Topic selection-->
223+
<img src="{{ url_for('static', filename='assets/images/help/topic_selection.webp' ) }}"
224+
alt="{{ _('Figure Topic selection.') }}">
225+
<figcaption>{{ _('Topic selection example') }}</figcaption>
226+
</figure>
227+
228+
</li>
229+
230+
<li>
231+
{{ _('Further, you can not only analyse the <b>completeness</b> and <b>currency</b> of the OSM data, but further conduct a <b>Road Comparison</b>
232+
with reference data and also check the <b>attribute completeness</b> in your OSM base data.:') }}
233+
234+
<figure> <!-- Figure Quality Indicators-->
235+
<img src="{{ url_for("static", filename="assets/images/help/quality_indicators.webp" ) }}"
236+
alt="{{ _('Figure Quality Indicators.') }}">
237+
<figcaption>{{ _('Quality indicators overview') }}</figcaption>
238+
</figure>
239+
</li>
240+
213241
<li>
214242
{{ _('Take a look at the map:') }}
215243
<ul>
216244
<li>{{ _('How well can you orient yourself on the map?') }}</li>
217-
<li>{{ _('Are important points of reference, such as hospitals, schools, landmarks, etc. visible on the
218-
map?') }}</li>
245+
<li>{{ _('Are important points of reference, such as hospitals, schools, landmarks, etc. visible on the map?') }}</li>
219246

220247
</ul>
221248
</li>
@@ -226,8 +253,7 @@ <h5>{{ _('Recommendations') }}</h5>
226253
<summary id="export-sketch-map-as-pdf">1.3 {{ _('Export Sketch Map as PDF') }}</summary>
227254
<article>
228255
<p>
229-
{{ _('The generated Sketch Map for your selected area of interest can be downloaded as a PDF file by clicking on
230-
the blue button.') }}
256+
{{ _('The generated Sketch Map for your selected area of interest can be downloaded as a PDF file by clicking on the blue button.') }}
231257
</p>
232258
<figure>
233259
<img src="{{ url_for("static", filename="assets/images/help/1_3_empty_sketch_map_osm.webp" ) }}"
@@ -897,29 +923,19 @@ <h1 id="faq">{{ _('FAQs') }}</h1>
897923
<article>
898924
{{ _('Based on the
899925
<a href="https://api.quality.ohsome.org/"
900-
target="_blank">HeiGIT ohsome quality API</a>, the OSM data used in the base map is classified with a traffic light system.
901-
Green stands for good suitability of the data, yellow for possible problems when carrying out a
902-
Sketch Map study with OSM-based Sketch Maps, and red for probable problems.
903-
Recommendations are also given on what to consider based on the results.') }}
904-
</article>
905-
</details>
906-
<details>
907-
<summary id="which-analyses-are-performed">{{ _('Which analyses are performed and why?') }}</summary>
908-
<article>
909-
{{ _('You can read more about the analyses included in the Sketch Map Tool <a
910-
href="https://www.mdpi.com/2220-9964/10/3/130" target="_blank">this
911-
paper</a>.') }}
926+
target="_blank">HeiGIT ohsome quality API</a>, the <b>roads</b> in the OSM base map data are analyzed automatically in regard to
927+
their <b>Mapping Saturation</b> and <b>Currentness</b>. Please check the chapter <b>1.2 Map Quality Check</b> for a detailed overview.') }}
912928
</article>
913929
</details>
930+
914931
<details>
915932
<summary id="for-which-reseach-questions-can-smt-be-used">{{ _('For which research questions can the Sketch Map Tool
916933
be used?') }}</summary>
917934
<article>
918-
{{ _('The Sketch Map Tool has been primarily developed for research questions related to flooding.
935+
{{ _('The Sketch Map Tool has been primarily developed for research questions related to flooding and disaster risk reduction. .
919936
Since then, it has been used world wide for a variety of topics like vulnerability and capacity mapping or risk
920-
mapping in general.
921-
You can use the Sketch Maps and the Map Quality Check to investigate all kinds of research questions, as long as
922-
you check that it fits your purpose.') }}
937+
mapping in general, city planning, mapping of cultural sites and many more.
938+
Check out our <b>Case Studies</b> to learn more.') }}
923939
</article>
924940
</details>
925941
<details>

0 commit comments

Comments
 (0)