Module 6.1, updated images and text. #5580

milechin · 2020-05-29T17:49:34Z

Updated the example snippets to reflect the GUI of QGIS 3.10. Updated the text accordingly and added some additional text to described other relevant items, such as looking at the Attribute Table after creating a new feature and describing how to access the Vertex Editor pane.

Goal:

Ticket(s): #

Backport to LTR documentation is required

Updated the example snippets to reflect the GUI of QGIS 3.10. Updated the text accordingly and added some additional text to described other relevant items, such as looking at the Attribute Table after creating a new feature and describing how to access the Vertex Editor pane.

havatv

Thanks! I have some suggestions. And I guess that @DelazJ would like you to use numbering instead of plain bullets when describing procedures in a stepwise way.

docs/training_manual/create_vector_data/create_new_vector.rst

Co-authored-by: Håvard Tveite <havard.tveite@nmbu.no>

DelazJ · 2020-05-30T14:31:30Z

And I guess that @DelazJ would like you to use numbering instead of plain bullets when describing procedures in a stepwise way

😃 and I'd have added that we should move away from :kbd: being used for things other than keyboard shortcuts.

DelazJ

@milechin Thanks for the update.
I only reviewed the diff as exposed by github. I have some suggestions and questions.
And moving to numbered list would be nice 👍

DelazJ · 2020-05-30T14:34:07Z

docs/training_manual/create_vector_data/create_new_vector.rst

@@ -92,69 +95,71 @@ or aerial photography.
 For our example, you'll be using the digitizing approach. Sample raster datasets
 are provided, so you'll need to import them as necessary.

-* Click on the :guilabel:`Add Raster Layer` button: |addRasterLayer|
-
+* Click on Data Source Manager button |dataSourceManager| .


I think we better use this type of instructions style

Suggested change

* Click on Data Source Manager button |dataSourceManager| .

* Click on |dataSourceManager| :sup:`Data Source Manager` button.

DelazJ · 2020-05-30T14:37:06Z

docs/training_manual/create_vector_data/create_new_vector.rst

-  sure that the correct layer is selected, otherwise you'll edit the wrong
-  layer!)
-* Click on the :guilabel:`Toggle Editing` button: |edit|
+* Click on the :kbd:'school_property' layer in the :guilabel:`Layer list` to select it.


caution: there's use of ' instead of ` here. (but there's use of kbd anyways)

docs/training_manual/create_vector_data/create_new_vector.rst

DelazJ · 2020-05-30T14:39:32Z

docs/training_manual/create_vector_data/create_new_vector.rst

-Four other relevant buttons are still inactive, but will become active when we
-start interacting with our new data:
+  - |capturePolygon|: Add a new feature.
+  - |vertexToolActiveLayer|: move only one part of a feature.


Suggested change

- |vertexToolActiveLayer|: move only one part of a feature.

- |vertexToolActiveLayer|: move vertice(s) of a feature.

would be clearer imho

docs/training_manual/create_vector_data/create_new_vector.rst

DelazJ · 2020-05-30T15:23:00Z

docs/training_manual/create_vector_data/create_new_vector.rst

+
+Another way to edited the feature is by manually entering the coordinates for each vertex.  
+
+* Make sure the Vertex Editor tool |vertexToolActiveLayer| is still active.


Suggested change

* Make sure the Vertex Editor tool |vertexToolActiveLayer| is still active.

* Make sure the |vertexToolActiveLayer| :sup:`Vertex Tool` is still active.

DelazJ · 2020-05-30T15:27:42Z

docs/training_manual/create_vector_data/create_new_vector.rst

-   :align: center
+.. figure:: img/select_vertex.png
+	:align: center
+.. figure:: img/moved_vertext.png


It does not hurt as long as they are inline but maybe worth fixing this typo in file name ?

Suggested change

.. figure:: img/moved_vertext.png

.. figure:: img/moved_vertex.png

DelazJ · 2020-05-30T15:28:32Z

docs/training_manual/create_vector_data/create_new_vector.rst

+* Double *left-click* in the table on the x or y coordinate you want to edit and enter the
+  updated value. 
+
+.. figure:: img/edit_vertext_in_vertex_editor.png


Same file name "typo"

Suggested change

.. figure:: img/edit_vertext_in_vertex_editor.png

.. figure:: img/edit_vertex_in_vertex_editor.png

DelazJ · 2020-05-30T15:30:29Z

docs/training_manual/create_vector_data/create_new_vector.rst

+
+To enable the remaining feature editing tools, one needs to select the feature.
+
+* Click on the Select Rectange button |selectRectangle| in the Attributes Toolbar.


Suggested change

* Click on the Select Rectange button |selectRectangle| in the Attributes Toolbar.

* Click on the |selectRectangle| :sup:`Select Features` button in the Attributes Toolbar.

DelazJ · 2020-05-30T15:37:43Z

docs/training_manual/create_vector_data/create_new_vector.rst


-.. figure:: img/single_feature_select.png
-   :align: center
+.. figure:: img/select_vertex.png


any reason of the margin left at the top in the image?

DelazJ · 2020-05-30T15:50:24Z

Ouch! looks like the version I was reviewing changed in the meantime...

DelazJ

A quick note. there are some indentation issues (I commented few) it'd be nice to address. Thanks.
you can see them either in previewing the changes in github or the html build (if you made it)

DelazJ · 2020-05-30T15:54:51Z

docs/training_manual/create_vector_data/create_new_vector.rst


-You'll be presented with the following dialog:
+	.. figure:: img/create_vector_layer.png


rst is picky with indentation so you should align things as long as they belong to the same level. If you check the html build you'll notice a not nice vertical bar here. Should align the "Navigate".

Suggested change

.. figure:: img/create_vector_layer.png

.. figure:: img/create_vector_layer.png

DelazJ · 2020-05-30T15:55:13Z

docs/training_manual/create_vector_data/create_new_vector.rst


-You'll be presented with the following dialog:
+	.. figure:: img/create_vector_layer.png
+		:align: center


Suggested change

:align: center

:align: center

DelazJ · 2020-05-30T15:55:46Z

docs/training_manual/create_vector_data/create_new_vector.rst

-It's important to decide which kind of dataset you want at this stage. Each
-different vector layer type is "built differently" in the background, so once
-you've created the layer, you can't change its type.
+	It's important to decide which kind of dataset you want at this stage. Each


Indentation. all these should align with... euh... probably moved as information in the next step?

havatv

Some more suggestions and comments. Mostly indentation. Not all indentation issues have been commented, so everything should be checked for indentation mistakes.

havatv · 2020-05-30T16:47:33Z

docs/training_manual/create_vector_data/create_new_vector.rst

@@ -18,58 +18,57 @@ existing dataset. Therefore, you'll need to define your own new dataset first.
 You'll need to open a :guilabel:`Create Layer` dialog that will allow you
 to define a new layer.

-* Navigate to and click on the menu entry :menuselection:`Layer --> Create Layer --> New
-  Shapefile Layer`.
+#. Navigate to and click on the menu entry :menuselection:`Layer --> Create Layer --> New Shapefile Layer`. You'll be presented with the following dialog.


Suggested change

#. Navigate to and click on the menu entry :menuselection:`Layer --> Create Layer --> New Shapefile Layer`. You'll be presented with the following dialog.

#. Navigate to and click on the menu entry

:menuselection:`Layer --> Create Layer --> New Shapefile Layer`.

You'll be presented with the following dialog.

havatv · 2020-05-30T16:55:41Z

docs/training_manual/create_vector_data/create_new_vector.rst


-.. figure:: img/polygon_selected.png
-   :align: center
+	.. figure:: img/polygon_selected.png


Suggested change

.. figure:: img/polygon_selected.png

.. figure:: img/polygon_selected.png

Align with the "F" in "For Geometry Type" above.

havatv · 2020-05-30T16:56:03Z

docs/training_manual/create_vector_data/create_new_vector.rst

-.. figure:: img/polygon_selected.png
-   :align: center
+	.. figure:: img/polygon_selected.png
+		:align: center


Suggested change

:align: center

:align: center

Better avoid tabs

havatv · 2020-05-30T16:57:29Z

docs/training_manual/create_vector_data/create_new_vector.rst


-This has no impact on the rest of the dialog, but it will cause the correct
-type of geometry to be used when the vector dataset is created.
+	This has no impact on the rest of the dialog, but it will cause the correct


Identation has to be fixed for the complete "paragraph". Three spaces.

havatv · 2020-05-30T16:58:41Z

docs/training_manual/create_vector_data/create_new_vector.rst

-If you can't find this button, check that the :guilabel:`Digitizing` toolbar is
-enabled. There should be a check mark next to the :menuselection:`View -->
-Toolbars --> Digitizing` menu entry.
+	If you can't find this button, check that the :guilabel:`Digitizing` toolbar is


Indentation...

milechin · 2020-06-03T14:55:11Z

I think I fixed the indentations, but let me know if it still needs work.

I still need to go through your other suggestions when I have time.

Best,

Dennis

havatv

Just suggesting.

havatv · 2020-06-03T19:19:39Z

docs/training_manual/create_vector_data/create_new_vector.rst

-One at a time, digitize the path and the track on the :guilabel:`routes` layer.
-Try to follow the routes as accurately as possible, using points (left-click) at
-any corners or turns.
+#. Create a new line feature called ``routes.shp`` with attributes ``id`` and ``type``. (Use the approach above to guide you.)


Suggested change

#. Create a new line feature called ``routes.shp`` with attributes ``id`` and ``type``. (Use the approach above to guide you.)

#. Create a new ESRI Shapefile line dataset called ``routes.shp``, with attributes ``id`` and

``type`` (Use the approach above to guide you.)

DelazJ · 2020-06-04T08:28:13Z

I think I fixed the indentations, but let me know if it still needs work

Nice! Thanks

DelazJ · 2020-06-04T08:31:41Z

docs/training_manual/create_vector_data/create_new_vector.rst


-For the next exercise, we're going to be creating new features which describe
-areas. For such features, you'll need to create a polygon dataset.
+   For the next exercise, we're going to be creating new features which describe


Suggested change

For the next exercise, we're going to be creating new features which describe

For the next exercise, we're going to create new features which describe

milechin · 2020-06-05T16:10:46Z

I think I have incorporated all of the suggestions and corrections. Let me know if you have any other ones.

havatv

Looks fine to me. I have some suggestions I hope you will consider.

docs/training_manual/create_vector_data/create_new_vector.rst

Co-authored-by: Håvard Tveite <havard.tveite@nmbu.no>

DelazJ

Sorry I did not reply earlier @milechin. But you seem to get all I had in mind.
This is a pretty good update. Thanks.

DelazJ · 2020-06-06T06:21:03Z

docs/training_manual/create_vector_data/create_new_vector.rst

@@ -92,165 +96,255 @@ or aerial photography.
 For our example, you'll be using the digitizing approach. Sample raster datasets
 are provided, so you'll need to import them as necessary.

-* Click on the :guilabel:`Add Raster Layer` button: |addRasterLayer|
+#. Click on Data Source Manager button |dataSourceManager| :sup:`Data Source Manager` button.


Suggested change

#. Click on Data Source Manager button |dataSourceManager| :sup:`Data Source Manager` button.

#. Click on |dataSourceManager| :sup:`Data Source Manager` button.

?

DelazJ · 2020-06-06T06:22:45Z

docs/training_manual/create_vector_data/create_new_vector.rst

-areas. For such features, you'll need to create a polygon dataset.
+#. Click :guilabel:`...` for the :guilabel:`File name` field.
+   A save dialog will appear.
+#. Navigate to the ``exercise_data`` directory.


Suggested change

#. Navigate to the ``exercise_data`` directory.

#. Navigate to the :file:`exercise_data` directory.

DelazJ · 2020-06-06T06:30:38Z

docs/training_manual/create_vector_data/create_new_vector.rst

@@ -92,165 +96,255 @@ or aerial photography.
 For our example, you'll be using the digitizing approach. Sample raster datasets
 are provided, so you'll need to import them as necessary.

-* Click on the :guilabel:`Add Raster Layer` button: |addRasterLayer|
+#. Click on Data Source Manager button |dataSourceManager| :sup:`Data Source Manager` button.
+#. Select :guilabel:`Raster` on the left side.


Suggested change

#. Select :guilabel:`Raster` on the left side.

#. Select |raster| :guilabel:`Raster` on the left side.

You can ignore this one if you want.
If you don't, don't forget the substitution

.. |raster| image:: /static/common/mIconRaster.png :width: 1.5em

DelazJ · 2020-06-06T06:37:58Z

docs/training_manual/create_vector_data/create_new_vector.rst

-To enter edit mode for the :guilabel:`school_property` layer:
+To enter edit mode for the ``school_property`` layer:
+
+#. Click on the ``school_property`` layer in the :guilabel:`Layer list` to select it.


Suggested change

#. Click on the ``school_property`` layer in the :guilabel:`Layer list` to select it.

#. Click on the ``school_property`` layer in the :guilabel:`Layers` panel to select it.

If we want to conform to the GUI label

DelazJ · 2020-06-06T07:06:41Z

docs/training_manual/create_vector_data/create_new_vector.rst

+   .. figure:: img/vertex_selected.png
+     :align: center
+
+#. To update the a coordinate, double left click on a cell in the table


Suggested change

#. To update the a coordinate, double left click on a cell in the table

#. To update a coordinate, double left click on the cell in the table

DelazJ · 2020-06-06T07:09:49Z

docs/training_manual/create_vector_data/create_new_vector.rst

+#. One at a time, digitize the path and the track on the ``routes`` layer.
+   Try to follow the routes as accurately as possible, adding additional points along
+   corners or turns.
+#. Set the ``type`` attribute value to ``path`` or ``track``.\


Suggested change

#. Set the ``type`` attribute value to ``path`` or ``track``.\

#. Set the ``type`` attribute value to ``path`` or ``track``.

Or is it on purpose?

docs/training_manual/create_vector_data/create_new_vector.rst

havatv

Looks fine. Some lines on the longer side...

docs/training_manual/create_vector_data/create_new_vector.rst

Co-authored-by: Håvard Tveite <havard.tveite@nmbu.no>

DelazJ · 2020-06-08T19:17:37Z

Thanks @milechin for the hard work and your patience

(cherry picked from commit 441aa09)

milechin · 2020-06-08T20:22:33Z

Sure, thank you for the feedback as well. If time allows, I will see if I can work on section 6.2 next. I am interested in having some of these sections updated so that I can use them for QGIS tutorials I periodically will be teaching.

DelazJ · 2020-06-09T05:10:45Z

If time allows, I will see if I can work on section 6.2 next.

Let's then hope that time allows 🙏
One thing: even if you use the 3.10 version to update the docs, better pull request the master branch; we have tools to automatically backport to 3.10 while 3.10 to master needs to be done manually (not that it takes long but... it will also put you in the docs history and avoid me stealing your work as I just realized I did - sorry I thought cherry-pick preserved authorship)

milechin · 2020-06-09T13:12:31Z

No problem. Thank you for the clarification on the best practice for updating.

havatv reviewed May 29, 2020

View reviewed changes

Apply suggestions from code review

92e9209

Co-authored-by: Håvard Tveite <havard.tveite@nmbu.no>

Updated formatting, added numbering to steps, removed :kdb:

3ec5a2b

DelazJ reviewed May 30, 2020

View reviewed changes

havatv reviewed May 30, 2020

View reviewed changes

Fixed indentations

0280d92

havatv reviewed Jun 3, 2020

View reviewed changes

DelazJ reviewed Jun 4, 2020

View reviewed changes

milechin added 6 commits June 4, 2020 16:29

Updated button instruction style

bc01408

Added intermediate section, Using Vertex Editor Table

83df014

Incoporated suggestions and misc. edits.

805c893

Added link to user manual

b86b2bf

Added step for user to create new project

9a3a803

Merge remote-tracking branch 'upstream/release_3.10' into tutorialUpdate

f95cf46

havatv approved these changes Jun 5, 2020

View reviewed changes

Apply suggestions from code review

6498d4d

Co-authored-by: Håvard Tveite <havard.tveite@nmbu.no>

DelazJ approved these changes Jun 6, 2020

View reviewed changes

Incorporated latest suggestions

14fda6b

havatv approved these changes Jun 8, 2020

View reviewed changes

docs/training_manual/create_vector_data/create_new_vector.rst Outdated Show resolved Hide resolved

docs/training_manual/create_vector_data/create_new_vector.rst Outdated Show resolved Hide resolved

docs/training_manual/create_vector_data/create_new_vector.rst Outdated Show resolved Hide resolved

Apply suggestions from review

741dae7

Co-authored-by: Håvard Tveite <havard.tveite@nmbu.no>

DelazJ merged commit 441aa09 into qgis:release_3.10 Jun 8, 2020

DelazJ added a commit to DelazJ/QGIS-Documentation that referenced this pull request Jun 8, 2020

Module 6.1, updated images and text (qgis#5580)

1917c64

(cherry picked from commit 441aa09)

DelazJ mentioned this pull request Jun 8, 2020

Module 6.1, updated images and text #5670

Merged

milechin deleted the tutorialUpdate branch June 8, 2020 20:22

DelazJ mentioned this pull request Jun 14, 2020

Create and update QGIS screenshots #2441

Open

41 tasks

	* Click on Data Source Manager button \|dataSourceManager\| .
	* Click on \|dataSourceManager\| :sup:`Data Source Manager` button.

	- \|vertexToolActiveLayer\|: move only one part of a feature.
	- \|vertexToolActiveLayer\|: move vertice(s) of a feature.


		Another way to edited the feature is by manually entering the coordinates for each vertex.

		* Make sure the Vertex Editor tool \|vertexToolActiveLayer\| is still active.

	* Make sure the Vertex Editor tool \|vertexToolActiveLayer\| is still active.
	* Make sure the \|vertexToolActiveLayer\| :sup:`Vertex Tool` is still active.

	.. figure:: img/moved_vertext.png
	.. figure:: img/moved_vertex.png

	.. figure:: img/edit_vertext_in_vertex_editor.png
	.. figure:: img/edit_vertex_in_vertex_editor.png


		To enable the remaining feature editing tools, one needs to select the feature.

		* Click on the Select Rectange button \|selectRectangle\| in the Attributes Toolbar.

	* Click on the Select Rectange button \|selectRectangle\| in the Attributes Toolbar.
	* Click on the \|selectRectangle\| :sup:`Select Features` button in the Attributes Toolbar.


		You'll be presented with the following dialog:
		.. figure:: img/create_vector_layer.png

	.. figure:: img/polygon_selected.png
	.. figure:: img/polygon_selected.png

	#. Create a new line feature called ``routes.shp`` with attributes ``id`` and ``type``. (Use the approach above to guide you.)
	#. Create a new ESRI Shapefile line dataset called ``routes.shp``, with attributes ``id`` and
	``type`` (Use the approach above to guide you.)

	For the next exercise, we're going to be creating new features which describe
	For the next exercise, we're going to create new features which describe

	#. Click on Data Source Manager button \|dataSourceManager\| :sup:`Data Source Manager` button.
	#. Click on \|dataSourceManager\| :sup:`Data Source Manager` button.

	#. Navigate to the ``exercise_data`` directory.
	#. Navigate to the :file:`exercise_data` directory.

	#. Select :guilabel:`Raster` on the left side.
	#. Select \|raster\| :guilabel:`Raster` on the left side.

	#. Click on the ``school_property`` layer in the :guilabel:`Layer list` to select it.
	#. Click on the ``school_property`` layer in the :guilabel:`Layers` panel to select it.

	#. To update the a coordinate, double left click on a cell in the table
	#. To update a coordinate, double left click on the cell in the table

	#. Set the ``type`` attribute value to ``path`` or ``track``.\
	#. Set the ``type`` attribute value to ``path`` or ``track``.

Module 6.1, updated images and text. #5580

Module 6.1, updated images and text. #5580

Conversation

milechin commented May 29, 2020

havatv left a comment

Choose a reason for hiding this comment

DelazJ commented May 30, 2020

DelazJ left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DelazJ commented May 30, 2020

DelazJ left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

havatv left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

milechin commented Jun 3, 2020

havatv left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DelazJ commented Jun 4, 2020

Choose a reason for hiding this comment

milechin commented Jun 5, 2020

havatv left a comment

Choose a reason for hiding this comment

DelazJ left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

havatv left a comment

Choose a reason for hiding this comment

DelazJ commented Jun 8, 2020

milechin commented Jun 8, 2020

DelazJ commented Jun 9, 2020

milechin commented Jun 9, 2020

havatv left a comment •

edited