Skip to content

Commit

Permalink
Remove training manual dedicated substitutions
Browse files Browse the repository at this point in the history 
Replace the level icons/substitutions with tooltiped and translatable string
Replace other text substitutions with their actual strings
  • Loading branch information
@DelazJ
DelazJ committed Mar 28, 2024
1 parent e6ba2b3 commit dc1c413
Show file tree
Hide file tree
Showing 79 changed files with 478 additions and 1,162 deletions.
41 changes: 12 additions & 29 deletions docs/training_manual/appendix/contribute.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ The module-level index file will look like this:
::

*******************************************************************************
|MOD| Module Name
Module: Module Name
*******************************************************************************

Short paragraph describing the module.
Expand Down Expand Up @@ -104,7 +104,7 @@ To add a lesson to a new or existing module:
.. note:: For editing purposes, a :kbd:`.rst` file works exactly like a normal
text file (:kbd:`.txt`).

* To begin writing the lesson, write the markup phrase :kbd:`|LS|`, followed by
* To begin writing the lesson, write the markup phrase ``Lesson:``, followed by
the lesson name.
* In the next line, write a line of 80 equal signs (:kbd:`=`).
* Leave a line open after this.
Expand Down Expand Up @@ -137,14 +137,14 @@ There are two types of sections: "follow along" and "try yourself".
assignment, and will show the expected outcome if possible.

Every section comes with a difficulty level. An easy section is denoted by
:kbd:`|basic|`, moderate by :kbd:`|moderate|`, and advanced by :kbd:`|hard|`.
``★☆☆``, moderate by ``★★☆``, and advanced by ``★★★``.

Adding a "follow along" section
-------------------------------------------------------------------------------

* To start this section, write the markup phrase of the intended difficulty
level (as shown above).
* Leave a space and then write :kbd:`|FA|` (for "follow along").
* Leave a space and then write ``Follow Along:``.
* Leave another space and write the name of the section (use only an initial
capital letter, as well as capitals for proper nouns).
* In the next line, write a line of 80 minuses/dashes (:kbd:`-`). Ensure that
Expand All @@ -162,8 +162,8 @@ Adding a "try yourself" section

* To start this section, write the markup phrase of the intended difficulty
level (as shown above).
* Leave a space and then write :kbd:`|TY|` (for "try yourself").
* In the next line, write a line of 80 minuses/dashes (:kbd:`-`). Ensure that
* Leave a space and then write ``Try Yourself:``.
* In the next line, write a line of 80 minuses/dashes (``-``). Ensure that
your text editor does not replace the default minus/dash character with a
long dash or other character.
* Explain the exercise that you want the reader to complete. Refer to previous
Expand Down Expand Up @@ -212,23 +212,23 @@ below it, otherwise it could cause errors while creating the document.
Add a Conclusion
===============================================================================

* To end a lesson, write the phrase :kbd:`|IC|` for "in conclusion", followed
by a new line of 80 minuses/dashes (:kbd:`-`). Write a conclusion for the
* To end a lesson, write the phrase ``In Conclusion``, followed
by a new line of 80 minuses/dashes (``-``). Write a conclusion for the
lesson, explaining which concepts have been covered in the lesson.

Add a Further Reading Section
===============================================================================

* This section is optional.
* Write the phrase :kbd:`FR` for "further reading", followed by a new line of
80 minuses/dashes (:kbd:`-`).
* Write the phrase ``Further Reading``, followed by a new line of
80 minuses/dashes (``-``).
* Include links to appropriate external websites.

Add a What's Next Section
===============================================================================

* Write the phrase :kbd:`|WN|` for "what's next", followed by a new line of 80
minuses/dashes (:kbd:`-`).
* Write the phrase ``What's Next?`` for "what's next", followed by a new line of 80
minuses/dashes (``-``).
* Explain how this lesson has prepared students for the next lesson or module.
* Remember to change the "what's next" section of the previous lesson if
necessary, so that it refers to your new lesson. This will be necessary if
Expand Down Expand Up @@ -366,20 +366,3 @@ Thank You!

Thank you for contributing to this project! By so doing, you are making QGIS
more accessible to users and adding value to the QGIS project as a whole.


.. Substitutions definitions - AVOID EDITING PAST THIS LINE
This will be automatically updated by the find_set_subst.py script.
If you need to create a new substitution manually,
please add it also to the substitutions.txt file in the
source folder.
.. |FA| replace:: Follow Along:
.. |IC| replace:: In Conclusion
.. |LS| replace:: Lesson:
.. |MOD| replace:: Module:
.. |TY| replace:: Try Yourself
.. |WN| replace:: What's Next?
.. |basic| image:: /static/common/basic.png
.. |hard| image:: /static/common/hard.png
.. |moderate| image:: /static/common/moderate.png
11 changes: 4 additions & 7 deletions docs/training_manual/appendix/preparing_data.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ more complex data sources which may or may not be available for your region.
.. note:: These instructions assume you have a good knowledge of QGIS and are
not intended to be used as teaching material.

|hard| |TY| Create OSM based vector files
:abbr:`★★★ (Advanced level)` Try Yourself: Create OSM based vector files
--------------------------------------------------------------------------------

If you wish to replace the default data set with localised data for your course,
Expand Down Expand Up @@ -175,7 +175,7 @@ are added to the map):
The important thing is that you have 7 vector layers matching those
shown above and that all those layers have some data.

|hard| |TY| Create SRTM DEM tiff files
:abbr:`★★★ (Advanced level)` Try Yourself: Create SRTM DEM tiff files
--------------------------------------------------------------------------------

For modules :ref:`tm_create_vector_data` and :ref:`tm_rasters`, you'll also need
Expand All @@ -195,7 +195,7 @@ Keep the :file:`GeoTiff` format. Once the form is filled, click on the
Once you have downloaded the required file(s), they should be saved in the
:file:`exercise_data` directory, under :file:`raster/SRTM` subfolders.

|hard| |TY| Create imagery tiff files
:abbr:`★★★ (Advanced level)` Try Yourself: Create imagery tiff files
--------------------------------------------------------------------------------


Expand All @@ -212,7 +212,7 @@ For reference, the image in the example data is:
:align: center


|basic| |TY| Replace tokens
:abbr:`★☆☆ (Basic level)` Try Yourself: Replace tokens
--------------------------------------------------------------------------------

Having created your localized dataset, the final step is to replace the tokens
Expand All @@ -239,11 +239,8 @@ The tokens you need to replace are as follows:
please add it also to the substitutions.txt file in the
source folder.
.. |TY| replace:: Try Yourself
.. |basic| image:: /static/common/basic.png
.. |extents| image:: /static/common/extents.png
:width: 1.5em
.. |hard| image:: /static/common/hard.png
.. |indicatorMemory| image:: /static/common/mIndicatorMemory.png
:width: 1.5em
.. |majorUrbanName| replace:: Swellendam
Expand Down
38 changes: 13 additions & 25 deletions docs/training_manual/assessment/index.rst
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
*******************************************************************************
|MOD| Assessment
Module: Assessment
*******************************************************************************

Use your own data for this section. You will need:
Expand All @@ -24,7 +24,7 @@ Add the point layer
* Add in the point layer. Based on the level that you're doing the course at,
do only what is listed in the appropriate section below:

|basic|
:abbr:`★☆☆ (Basic level)`
...............................................................................

* Label the points according to a unique attribute, such as place names. Use a
Expand All @@ -34,17 +34,17 @@ Add the point layer
For example, categories could include "tourist destination", "police
station", and "town center".

|moderate|
:abbr:`★★☆ (Moderate level)`
...............................................................................

* Do the same as the |basic| section.
* Do the same as the :abbr:`★☆☆ (Basic level)` section.
* Classify the point size by importance: the more significant a feature, the
larger its point. However, don't exceed the point size of :kbd:`2.00`.
* For features that aren't located at a single point (for example,
provincial/regional names, or town names at a large scale), don't assign any
point at all.

|hard|
:abbr:`★★★ (Advanced level)`
...............................................................................

* Don't use point symbols to symbolize the layer at all. Instead, use labels
Expand All @@ -61,13 +61,13 @@ Add the line layer

* Add the road layer and then change its symbology. Don't label the roads.

|basic|
:abbr:`★☆☆ (Basic level)`
...............................................................................

* Change the road symbology to a light color with a broad line. Make it
somewhat transparent as well.

|moderate|
:abbr:`★★☆ (Moderate level)`
...............................................................................

* Create a symbol with multiple symbol layers. The resulting symbol should look
Expand All @@ -81,10 +81,10 @@ Add the line layer
* All symbols should have multiple symbol layers. Use symbols to make them
display correctly.

|hard|
:abbr:`★★★ (Advanced level)`
...............................................................................

* Do the same as in the |moderate| section above.
* Do the same as in the :abbr:`★★☆ (Moderate level)` section above.
* In addition, roads should be classified. When using realistic road-like
symbols, each type of road should have an appropriate symbol; for example, a
highway should appear to have two lanes in either direction.
Expand All @@ -94,19 +94,19 @@ Add the polygon layer

* Add the land use layer and change its symbology.

|basic|
:abbr:`★☆☆ (Basic level)`
...............................................................................

* Classify the layer according to land use. Use solid colors.

|moderate|
:abbr:`★★☆ (Moderate level)`
...............................................................................

* Classify the layer according to land use. Where appropriate, incorporate
symbol layers, different symbol types, etc. Keep the results looking subdued
and uniform, however. Keep in mind that this will be part of a backdrop!

|hard|
:abbr:`★★★ (Advanced level)`
...............................................................................

* Use rule-based classification to classify the land use into general
Expand Down Expand Up @@ -138,7 +138,7 @@ Analyze the data
* it should be within a given distance from some category of points, like a
hospital for example

|moderate| / |hard|
:abbr:`★★☆ (Moderate level)` / :abbr:`★★★ (Advanced level)`
-------------------------------------------------------------------------------

* Include raster analysis in your results. Consider at least one derived
Expand All @@ -153,15 +153,3 @@ Final Map
map has become too visually busy due to the added layer(s), deselect the
layers which you feel are the least necessary.
* Your map must include a title and a legend.


.. Substitutions definitions - AVOID EDITING PAST THIS LINE
This will be automatically updated by the find_set_subst.py script.
If you need to create a new substitution manually,
please add it also to the substitutions.txt file in the
source folder.
.. |MOD| replace:: Module:
.. |basic| image:: /static/common/basic.png
.. |hard| image:: /static/common/hard.png
.. |moderate| image:: /static/common/moderate.png
11 changes: 1 addition & 10 deletions docs/training_manual/basic_map/index.rst
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
*******************************************************************************
|MOD| Creating and Exploring a Basic Map
Module: Creating and Exploring a Basic Map
*******************************************************************************

In this module, you will create a basic map which will be used later as a basis
Expand All @@ -12,12 +12,3 @@ for further demonstrations of QGIS functionality.
preparation
mapviewnavigation
symbology


.. Substitutions definitions - AVOID EDITING PAST THIS LINE
This will be automatically updated by the find_set_subst.py script.
If you need to create a new substitution manually,
please add it also to the substitutions.txt file in the
source folder.
.. |MOD| replace:: Module:
10 changes: 3 additions & 7 deletions docs/training_manual/basic_map/mapviewnavigation.rst
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
|LS| Navigating the Map Canvas
Lesson: Navigating the Map Canvas
===============================================================================
This section will focus on basic QGIS navigation tools used to navigate within
the Map Canvas. These tools will allow you to visually explore the layers at
Expand All @@ -7,7 +7,7 @@ different scales.
**The goal for this lesson:** Learn how to use Pan and Zoom tools within QGIS
and learn about map scale.

|basic| |FA| Basic Navigation Tools
:abbr:`★☆☆ (Basic level)` Follow Along: Basic Navigation Tools
-------------------------------------------------------------------------------

Before learning how to navigate within the Map Canvas, let's add some
Expand Down Expand Up @@ -98,7 +98,7 @@ Now you know the basics of navigating the Map Canvas. Check out the User Manual
:ref:`Zooming and Panning<zoom_pan>` to learn about alternative ways of navigating
the Map Canvas.

|IC|
In Conclusion
-------------------------------------------------------------------------------

Knowing how to navigate the Map Canvas is important, as it allows one to explore
Expand All @@ -111,10 +111,6 @@ or to validate output of a spatial analysis.
please add it also to the substitutions.txt file in the
source folder.
.. |FA| replace:: Follow Along:
.. |IC| replace:: In Conclusion
.. |LS| replace:: Lesson:
.. |basic| image:: /static/common/basic.png
.. |pan| image:: /static/common/mActionPan.png
:width: 1.5em
.. |zoomFullExtent| image:: /static/common/mActionZoomFullExtent.png
Expand Down
Loading

0 comments on commit dc1c413

Please sign in to comment.