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

Tidy up table formatting in the docs. Thanks to Susan Douglas for the tips!

Browse Source
This commit is contained in:
Dave Page
2019-03-21 11:38:34 +00:00
parent 61f11aa4fc
commit 3f22503ad2
5 changed files with 147 additions and 121 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/en_US/desktop_deployment.rst
View File

@@ -76,6 +76,10 @@ and the registry on Windows (HKEY_CURRENT_USER\\Software\\pgadmin\\pgadmin4).
The configuration settings: The configuration settings:
.. table::
:class: longtable
:widths: 2 1 4
+--------------------------+--------------------+---------------------------------------------------------------+ +--------------------------+--------------------+---------------------------------------------------------------+
| Key | Type | Purpose | | Key | Type | Purpose |
+==========================+====================+===============================================================+ +==========================+====================+===============================================================+

7
docs/en_US/keyboard_shortcuts.rst
View File

@@ -13,6 +13,7 @@ When using main browser window, the following keyboard shortcuts are available:
.. table:: .. table::
:class: longtable :class: longtable
:widths: 2 3
+----------------------------+-------------------------------------------------------+ +----------------------------+-------------------------------------------------------+
| Shortcut for all platforms | Function | | Shortcut for all platforms | Function |
@@ -53,6 +54,7 @@ Use the shortcuts below to navigate the tabsets on dialogs:
.. table:: .. table::
:class: longtable :class: longtable
:widths: 2 3
+----------------------------+-------------------------------------------------------+ +----------------------------+-------------------------------------------------------+
| Shortcut for all platforms | Function | | Shortcut for all platforms | Function |
@@ -69,6 +71,7 @@ When using the syntax-highlighting SQL editors, the following shortcuts are avai
.. table:: .. table::
:class: longtable :class: longtable
:widths: 2 2 3
+--------------------------+------------------+-------------------------------------+ +--------------------------+------------------+-------------------------------------+
| Shortcut (Windows/Linux) | Shortcut (Mac) | Function | | Shortcut (Windows/Linux) | Shortcut (Mac) | Function |
@@ -121,6 +124,7 @@ When using the Query Tool, the following shortcuts are available:
.. table:: .. table::
:class: longtable :class: longtable
:widths: 2 2 3
+--------------------------+--------------------+-----------------------------------+ +--------------------------+--------------------+-----------------------------------+
| Shortcut (Windows/Linux) | Shortcut (Mac) | Function | | Shortcut (Windows/Linux) | Shortcut (Mac) | Function |
@@ -169,6 +173,7 @@ When using the Debugger, the following shortcuts are available:
.. table:: .. table::
:class: longtable :class: longtable
:widths: 2 2 3
+--------------------------+--------------------+-----------------------------------+ +--------------------------+--------------------+-----------------------------------+
| Shortcut (Windows/Linux) | Shortcut (Mac) | Function | | Shortcut (Windows/Linux) | Shortcut (Mac) | Function |
@@ -196,6 +201,7 @@ for inner panel navigation:
.. table:: .. table::
:class: longtable :class: longtable
:widths: 2 2 3
+--------------------------+---------------------------+------------------------------+ +--------------------------+---------------------------+------------------------------+
| Shortcut (Windows/Linux) | Shortcut (Mac) | Function | | Shortcut (Windows/Linux) | Shortcut (Mac) | Function |
@@ -213,6 +219,7 @@ default access keys for supported browsers.
.. table:: .. table::
:class: longtable :class: longtable
:widths: 2 1 1 1
+-------------------+------------+------------+------------+ +-------------------+------------+------------+------------+
| | Windows | Linux | Mac | | | Windows | Linux | Mac |

57
docs/en_US/query_tool_toolbar.rst
View File

@@ -24,6 +24,7 @@ File Options
.. table:: .. table::
:class: longtable :class: longtable
:widths: 1 4 1
+----------------------+---------------------------------------------------------------------------------------------------+----------------+ +----------------------+---------------------------------------------------------------------------------------------------+----------------+
| Icon | Behavior | Shortcut | | Icon | Behavior | Shortcut |
@@ -44,25 +45,26 @@ Editing Options
.. table:: .. table::
:class: longtable :class: longtable
:widths: 1 4 1
+----------------------+---------------------------------------------------------------------------------------------------+----------------+ +----------------------+---------------------------------------------------------------------------------------------------+----------------+
| Icon | Behavior | Shortcut | | Icon | Behavior | Shortcut |
+======================+===================================================================================================+================+ +======================+===================================================================================================+================+
| *Find* | Use the *Find* menu to search, replace, or navigate the code displayed in the SQL Editor: | | | *Find* | Use the *Find* menu to search, replace, or navigate the code displayed in the SQL Editor: | |
| | | | | +---------------------------------------------------------------------------------------------------+----------------+
| | * Select *Find* to provide a search target, and search the SQL Editor contents. | Cmd+F | | | Select *Find* to provide a search target, and search the SQL Editor contents. | Cmd+F |
| | | | | +---------------------------------------------------------------------------------------------------+----------------+
| | * Select *Find next* to locate the next occurrence of the search target. | Cmd+G | | | Select *Find next* to locate the next occurrence of the search target. | Cmd+G |
| | | | | +---------------------------------------------------------------------------------------------------+----------------+
| | * Select *Find previous* to move to the last occurrence of the search target. | Cmd+Shift+G | | | Select *Find previous* to move to the last occurrence of the search target. | Cmd+Shift+G |
| | | | | +---------------------------------------------------------------------------------------------------+----------------+
| | * Select *Pesistent find* to identify all occurrences of the search target within the editor. | | | | Select *Pesistent find* to identify all occurrences of the search target within the editor. | |
| | | | | +---------------------------------------------------------------------------------------------------+----------------+
| | * Select *Replace* to locate and replace (with prompting) individual occurrences of the target. | Cmd+Shift+F | | | Select *Replace* to locate and replace (with prompting) individual occurrences of the target. | Cmd+Shift+F |
| | | | | +---------------------------------------------------------------------------------------------------+----------------+
| | * Select *Replace all* to locate and replace all occurrences of the target within the editor. | | | | Select *Replace all* to locate and replace all occurrences of the target within the editor. | |
| | | | | +---------------------------------------------------------------------------------------------------+----------------+
| | * Select *Jump* to navigate to the next occurrence of the search target. | Alt+G | | | Select *Jump* to navigate to the next occurrence of the search target. | Alt+G |
+----------------------+---------------------------------------------------------------------------------------------------+----------------+ +----------------------+---------------------------------------------------------------------------------------------------+----------------+
| *Copy* | Click the *Copy* icon to copy the content that is currently highlighted in the Data Output panel. | Accesskey + C | | *Copy* | Click the *Copy* icon to copy the content that is currently highlighted in the Data Output panel. | Accesskey + C |
| | when in View/Edit data mode. | | | | when in View/Edit data mode. | |
@@ -73,19 +75,18 @@ Editing Options
+----------------------+---------------------------------------------------------------------------------------------------+----------------+ +----------------------+---------------------------------------------------------------------------------------------------+----------------+
| *Edit* | Use options on the *Edit* menu to access text editing tools; the options operate on the text | | | *Edit* | Use options on the *Edit* menu to access text editing tools; the options operate on the text | |
| | displayed in the SQL Editor panel when in Query Tool mode: | | | | displayed in the SQL Editor panel when in Query Tool mode: | |
| | | | | +---------------------------------------------------------------------------------------------------+----------------+
| | * Select *Indent Selection* to indent the currently selected text. | Tab | | | Select *Indent Selection* to indent the currently selected text. | Tab |
| | | | | +---------------------------------------------------------------------------------------------------+----------------+
| | * Select *Unindent Selection* to remove indentation from the currently selected text. | Shift+Tab | | | Select *Unindent Selection* to remove indentation from the currently selected text. | Shift+Tab |
| | | | | +---------------------------------------------------------------------------------------------------+----------------+
| | * Select *Inline Comment Selection* to enclose any lines that contain the selection in | Cmd+/ | | | Select *Inline Comment Selection* to enclose any lines that contain the selection in SQL style | Cmd+/ |
| | SQL style comment notation. | | | | comment notation. | |
| | | | | +---------------------------------------------------------------------------------------------------+----------------+
| | * Select *Inline Uncomment Selection* to remove SQL style comment notation from the | Cmd+. | | | Select *Inline Uncomment Selection* to remove SQL style comment notation from the selected line. | Cmd+. |
| | selected line. | | | +---------------------------------------------------------------------------------------------------+----------------+
| | | | | | Select *Block Comment* to enclose all lines that contain the selection in C style comment | Shift+Cmd+/ |
| | * Select *Block Comment* to enclose all lines that contain the selection in C style | Shift+Cmd+/ | | | notation. This option acts as a toggle. | |
| | comment notation. This option acts as a toggle. | |
+----------------------+---------------------------------------------------------------------------------------------------+----------------+ +----------------------+---------------------------------------------------------------------------------------------------+----------------+
View/Edit Data Resultset Control View/Edit Data Resultset Control
@@ -93,6 +94,7 @@ View/Edit Data Resultset Control
.. table:: .. table::
:class: longtable :class: longtable
:widths: 1 4 1
+----------------------+---------------------------------------------------------------------------------------------------+----------------+ +----------------------+---------------------------------------------------------------------------------------------------+----------------+
| Icon | Behavior | Shortcut | | Icon | Behavior | Shortcut |
@@ -119,6 +121,7 @@ Query Execution
.. table:: .. table::
:class: longtable :class: longtable
:widths: 1 4 1
+----------------------+---------------------------------------------------------------------------------------------------+----------------+ +----------------------+---------------------------------------------------------------------------------------------------+----------------+
| Icon | Behavior | Shortcut | | Icon | Behavior | Shortcut |

4
docs/en_US/tabbed_browser.rst
View File

@@ -102,6 +102,10 @@ that is selected. Click a column heading to sort the table by the data displayed
in the column; click again to reverse the sort order. The following table lists in the column; click again to reverse the sort order. The following table lists
some of the statistics that are available: some of the statistics that are available:
.. table::
:class: longtable
:widths: 1 4
+----------------------------+------------------------------------------------------------------------------------------------------------+ +----------------------------+------------------------------------------------------------------------------------------------------------+
| Panel | Description | | Panel | Description |
+============================+============================================================================================================+ +============================+============================================================================================================+

8
docs/en_US/table_dialog.rst
View File

@@ -74,6 +74,10 @@ must satisfy for an *INSERT* or *UPDATE* operation to succeed. Select the
appropriate constraint type by selecting one of the following tabs on the appropriate constraint type by selecting one of the following tabs on the
*Constraints* panel: *Constraints* panel:
.. table::
:class: longtable
:widths: 1 4
+----------------+---------------------------------------------------------------------------------------------------------------------+ +----------------+---------------------------------------------------------------------------------------------------------------------+
| Tab Name | Constraint | | Tab Name | Constraint |
+================+=====================================================================================================================+ +================+=====================================================================================================================+
@@ -212,6 +216,10 @@ updated or deleted:
The supported actions are: The supported actions are:
.. table::
:class: longtable
:widths: 1 4
+-------------+------------------------------------------------------------------------------------------------------------+ +-------------+------------------------------------------------------------------------------------------------------------+
| NO ACTION | Produce an error indicating that the deletion or update will create a foreign key constraint violation. | | NO ACTION | Produce an error indicating that the deletion or update will create a foreign key constraint violation. |
| | If the constraint is deferred, this error will be produced at constraint check time if any referencing | | | If the constraint is deferred, this error will be produced at constraint check time if any referencing |