Skip to content

Commit

Permalink
Rewording and additional explanations
Browse files Browse the repository at this point in the history
  • Loading branch information
selmaVH1 authored and github-actions[bot] committed Dec 28, 2024
1 parent a07dcaa commit 956d8b9
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 5 deletions.
Binary file modified docs/user_manual/processing/img/toolbox_search.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 15 additions & 5 deletions docs/user_manual/processing/toolbox.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,19 @@ You can enter any word or phrase on the text box. Notice that, as you type, the
number of algorithms, models or scripts in the toolbox is reduced to just those
that contain the text you have entered in their names or keywords.

.. note:: The top of the algorithm list shows the most recently used tools,
making it convenient to reexecute them. Additionally, you can manually
add or remove Processing algorithms to/from your :guilabel:`Favorites` list. Unlike
the :guilabel:`Recently Used` list, the :guilabel:`Favorites` list remains static and is not
affected by which algorithms were executed.
The top of the algorithm list shows the most |processingHistory| :sup:`Recently Used` tools and the |favorites| :sup:`Favorites` tools,
making it convenient to reexecute them. The |processingHistory| :sup:`Recently Used` list is there by default, showing the algorithms you have recently executed.
The |favorites| :sup:`Favorites` list is created when you manually add an algorithm to it.

You can right-click on any algorithm in the toolbox and choose from the contextual menu to:

* :guilabel:`Execute...` to run the algorithm.
* :guilabel:`Execute as Batch Process...` to run the algorithm in batch mode.
* :guilabel:`Edit Rendering Styles for Outputs...` to customize the rendering styles for the algorithm's outputs.
* :guilabel:`Add to Favorites` to add the algorithm to the Favorites list.
* :guilabel:`Remove from Favorites` to remove the algorithm from the Favorites list.

Unlike the Recently Used list, the Favorites list remains static and is not affected by which algorithms were executed.

.. _figure_toolbox_search:

Expand Down Expand Up @@ -485,6 +493,8 @@ to a temporary file and deleted once you exit QGIS).
:width: 1.5em
.. |editPaste| image:: /static/common/mActionEditPaste.png
:width: 1.5em
.. |favorites| image:: /static/common/mIconFavorites.png
:width: 1.5em
.. |fileSave| image:: /static/common/mActionFileSave.png
:width: 1.5em
.. |iterate| image:: /static/common/mIconIterate.png
Expand Down
Binary file added static/common/mIconFavorites.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions substitutions.txt
Original file line number Diff line number Diff line change
Expand Up @@ -405,6 +405,8 @@
:width: 1.5em
.. |extractVertices| image:: /static/common/mAlgorithmExtractVertices.png
:width: 1.5em
.. |favorites| image:: /static/common/mIconFavorites.png
:width: 1.5em
.. |favourites| image:: /static/common/mIconFavourites.png
:width: 1.5em
.. |fieldFloat| image:: /static/common/mIconFieldFloat.png
Expand Down

0 comments on commit 956d8b9

Please sign in to comment.