Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update georeferencer.rst #9402

Merged
merged 2 commits into from
Nov 27, 2024
Merged

Update georeferencer.rst #9402

merged 2 commits into from
Nov 27, 2024

Conversation

crayfish66
Copy link
Contributor

Goal:
Three additions:

  1. adding "GCP" before "point" in 2 entries in a legend to the buttons, for consistency with the remaining legend entries (although I'm aware, that the final "P" in "GCP" abbreviation also mean "Point" - but this regards all the resp. entries);
  2. adding explanations, what "Link QGIS to Georeferencer" and "Link Georeferencer to QGIS" buttons actually do (it was not written anywhere and I had to look for this over the Net for a while)
  3. adding a tip, how to avoid switching between "Pan" and "Add" or "Move GCP Point" when moving from one location to the other (I also did not find it at once).

Ticket(s): #

  • Backport to LTR documentation is requested

Three additions:
1) adding "GCP" before "point" in 2 entries in a legend to the buttons, for consistency with the remaining legend entries (although I'm aware, that the final "P" in "GCP" abbreviation also mean "Point" - but this regards all resp. entries);
2) adding explanations, what "Link QGIS to Georeferencer" and "Link Georeferencer to QGIS" buttons actually do (it was not written anywhere and I had to look for this over the Net for a while)
3) adding a tip, how to avoid switching between "Pan" and "Add" or "Move GCP Point" when moving from one location to the other (I also did not find it at once).
Copy link
Collaborator

@DelazJ DelazJ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice addition @crayfish66.
What about putting these elements in the step by step instruction to "live" help people that are georeferencing?

@@ -146,6 +146,9 @@ manage the files.

.. _`georeferencer_transformation`:

Tip: to avoid constant switching between a "hand" (Pan) and "Add / Move GCP point" buttons, you may use the keyboard arrow keys for moving and the mouse wheel for scaling the georeferenced map conveniently.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's use the dedicated tool for tips, providing the corresponding formatting

Suggested change
Tip: to avoid constant switching between a "hand" (Pan) and "Add / Move GCP point" buttons, you may use the keyboard arrow keys for moving and the mouse wheel for scaling the georeferenced map conveniently.
.. tip::
To avoid constant switching between a "hand" (Pan) and "Add / Move GCP point" buttons,
you may use the keyboard arrow keys for moving and the mouse wheel for scaling the georeferenced map conveniently.

BUT there shouldn't be text between an anchor (.. _sometext:) and its title. And since we provide a step-by-step instruction in the section above, how about moving that tip, e.g, somewhere around step 3 or 4 above?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm rather new to the QGIS (at least to using it hands-on) so I'm not aware, that some other type of the manual exists (the one I made the additions to also seem a 'step-by-step' type). Where the alternative version is to be found?
And, generally, feel free to place these additions where you know they would be most useful - as a newbie I might not find the really best place (these were where I was looking for them). Best,
WP

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK @crayfish66. There is no other place we describe this tool. By step-by-step, I meant the section under "Entering ground control points (GCPs)". Anyway, I pushed the suggested changes as you asked.
Thanks.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah... I didn't mention but let me know if you are OK with these changes.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems OK, thank you, @DelazJ !

docs/user_manual/working_with_raster/georeferencer.rst Outdated Show resolved Hide resolved
@@ -34,7 +34,7 @@ you can accurately determine coordinates.
+--------------------------------+------------------------------+-------------------------------+----------------------------+
| |saveGCPPointsAs| | Save GCP Points As | |transformSettings| | Transformation settings |
+--------------------------------+------------------------------+-------------------------------+----------------------------+
| |addGCPPoint| | Add Point | |deleteGCPPoint| | Delete Point |
| |addGCPPoint| | Add GCP Point | |deleteGCPPoint| | Delete GCP Point |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For consistency with QGIS interface, would you want to fix these also in the software? The place to start the update is https://github.com/qgis/QGIS/blob/master/src/ui/georeferencer/qgsgeorefpluginguibase.ui#L240. Thanks

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've never worked with the software itself, so I'm afraid to make some mess. For the time being I've no time to get familiar with the procedures, so either it would have to wait some time or I'll have to ask for your help in this. Cheers.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No problem @crayfish66. Done at qgis/QGIS#59598

@DelazJ DelazJ added the backport release_3.40 On merge create a backported pull request to 3.40 label Nov 26, 2024
@DelazJ DelazJ merged commit 024477c into qgis:master Nov 27, 2024
3 of 4 checks passed
DelazJ added a commit that referenced this pull request Nov 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport release_3.40 On merge create a backported pull request to 3.40
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants