IntenseWebs/pgadmin4
3
0
Fork 0
mirror of https://github.com/pgadmin-org/pgadmin4.git synced 2025-02-25 18:55:31 -06:00
Code Issues Packages Projects Releases Wiki Activity

Fixed documentation review comments for Macro support.

Browse Source 
refs #5857
This commit is contained in:
Nidhi Bhammar 2020-10-12 16:13:34 +05:30 committed by Akshay Joshi
parent 33e9b74388
commit b11a0d50e6
5 changed files with 16 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/en_US/images/query_tool_macros_clear_all.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 125 KiB

BIN
docs/en_US/images/query_tool_macros_clear_row.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 96 KiB

After

Width:  |  Height:  |  Size: 96 KiB

BIN
docs/en_US/images/query_tool_manage_macros.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 52 KiB

20
docs/en_US/query_tool.rst
View File

@ -325,27 +325,37 @@ User can connect to another server or database from existing open session of que
Macros
******
Query Tool Macros enable you to execute pre-defined SQL queries with single key press. Pre-defined queries can contain the placeholder $SELECTION$. Upon macro execution, the placeholder will be replaced with the currently selected text in the Query Editor pane of the Query Tool.
Query Tool Macros enable you to execute pre-defined SQL queries with a single key press. Pre-defined queries can contain the placeholder $SELECTION$. Upon macro execution, the placeholder will be replaced with the currently selected text in the Query Editor pane of the Query Tool.
To create a macro, select the *Manage Macros* option from the *Macros* menu on the *Query Tool*. Select the key you wish to use, enter the name of the macro, and the query, optionally including the selection placeholder, and then click the Save button to store the macro.
.. image:: images/query_tool_manage_macros.png
:alt: Query Tool Manage macros
:align: center
To create a macro, select the *Manage Macros* option from the *Macros* menu on the *Query Tool*. Select the key you wish to use, enter the name of the macro, and the query, optionally including the selection placeholder, and then click the *Save* button to store the macro.
.. image:: images/query_tool_manage_macros_dialog.png
:alt: Query Tool Manage Macros dialogue
:align: center
To clear a macro, select the macro on the Manage Macros dialogue, and then click the Clear button.
To clear a macro, select the macro on the *Manage Macros* dialogue, and then click the *Clear* button.
.. image:: images/query_tool_macros_clear_row.png
:alt: Query Tool Manage Macros clear the row
:align: center
It asks for the confirmation to clear a macro.
The server will prompt you for confirmation to clear the macro.
.. image:: images/query_tool_macros_clear_confirmation.png
:alt: Query Tool Manage Macros Clear row confirmation
:align: center
To execute a macro, simply press the appropriate shortcut keys, or select it from the Macros menu.
To clear all macros, click on the *Clear* button on left side of the key. The server will prompt you for confirmation to clear all the rows.
.. image:: images/query_tool_macros_clear_all.png
:alt: Query Tool Macros Clear All
:align: center
To execute a macro, simply select the appropriate shortcut keys, or select it from the *Macros* menu.
.. image:: images/query_tool_macros_execution.png
:alt: Query Tool Macros Execution

2
docs/en_US/query_tool_toolbar.rst
View File

@ -185,5 +185,5 @@ Query Execution
| | dialogue. | |
+----------------------+---------------------------------------------------------------------------------------------------+----------------+
| *Macros* | Click the *Macros* icon to manage the macros. You can create, edit or clear the macros through | |
| | *Manage Macros* option. | |
| | the *Manage Macros* option. | |
+----------------------+---------------------------------------------------------------------------------------------------+----------------+