From 238da587326f6684a5b67e03adba5f148beea0dd Mon Sep 17 00:00:00 2001 From: Dave Page Date: Fri, 20 May 2016 16:39:21 -0400 Subject: [PATCH] Helpfile refactoring. --- docs/en_US/browser.rst | 3 +- docs/en_US/build_code_snippet.py | 7 +- .../{create_cast.rst => cast_dialog.rst} | 26 ++-- .../{code-overview.rst => code_overview.rst} | 19 +-- .../{code-review.rst => code_review.rst} | 3 +- .../{code-snippet.rst => code_snippets.rst} | 5 +- ...ing-standards.rst => coding_standards.rst} | 13 +- ...ate_collation.rst => collation_dialog.rst} | 26 ++-- docs/en_US/create_resource_group.rst | 39 ------ docs/en_US/create_server_group.rst | 19 --- ...reate_database.rst => database_dialog.rst} | 30 ++-- docs/en_US/debugger.rst | 3 +- ...-deployment.rst => desktop_deployment.rst} | 3 +- ...raint.rst => domain_constraint_dialog.rst} | 24 ++-- ...t_trigger.rst => event_trigger_dialog.rst} | 28 ++-- ...ate_extension.rst => extension_dialog.rst} | 24 ++-- ...dw.rst => foreign_data_wrapper_dialog.rst} | 30 ++-- ...e_fts_parser.rst => fts_parser_dialog.rst} | 20 ++- ...s_template.rst => fts_template_dialog.rst} | 24 ++-- ...reate_function.rst => function_dialog.rst} | 34 +++-- ...ast_definition.png => cast_definition.png} | Bin ...eate_cast_general.png => cast_general.png} | Bin .../{create_cast_sql.png => cast_sql.png} | Bin ...t_sql_example.png => cast_sql_example.png} | Bin ...efinition.png => collation_definition.png} | Bin ...tion_general.png => collation_general.png} | Bin ...te_collation_sql.png => collation_sql.png} | Bin ..._example.png => collation_sql_example.png} | Bin ...definition.png => database_definition.png} | Bin ...abase_general.png => database_general.png} | Bin ...parameters.png => database_parameters.png} | Bin ...ase_security.png => database_security.png} | Bin ...eate_database_sql.png => database_sql.png} | Bin ...l_example.png => database_sql_example.png} | Bin ...n.png => domain_constraint_definition.png} | Bin ...eral.png => domain_constraint_general.png} | Bin ...aint_sql.png => domain_constraint_sql.png} | Bin ....png => domain_constraint_sql_example.png} | Bin ...constraints.png => domain_constraints.png} | Bin ...n_definition.png => domain_definition.png} | Bin ..._domain_general.png => domain_general.png} | Bin ...omain_security.png => domain_security.png} | Bin .../{create_domain_sql.png => domain_sql.png} | Bin ...sql_example.png => domain_sql_example.png} | Bin ...ition.png => event_trigger_definition.png} | Bin ..._general.png => event_trigger_general.png} | Bin ...ecurity.png => event_trigger_security.png} | Bin ..._trigger_sql.png => event_trigger_sql.png} | Bin ...efinition.png => extension_definition.png} | Bin ...sion_general.png => extension_general.png} | Bin ...te_extension_sql.png => extension_sql.png} | Bin ..._example.png => extension_sql_example.png} | Bin ...ng => foreign_data_wrapper_definition.png} | Bin ...l.png => foreign_data_wrapper_general.png} | Bin ...s.png => foreign_data_wrapper_options.png} | Bin ....png => foreign_data_wrapper_security.png} | Bin ...w_sql.png => foreign_data_wrapper_sql.png} | Bin ...g => foreign_data_wrapper_sql_example.png} | Bin ...tion.png => fts_dictionary_definition.png} | Bin ...general.png => fts_dictionary_general.png} | Bin ...options.png => fts_dictionary_options.png} | Bin ...tionary_sql.png => fts_dictionary_sql.png} | Bin ...ple.png => fts_dictionary_sql_example.png} | Bin ...finition.png => fts_parser_definition.png} | Bin ...ser_general.png => fts_parser_general.png} | Bin ..._fts_parser_sql.png => fts_parser_sql.png} | Bin ...nition.png => fts_template_definition.png} | Bin ...e_general.png => fts_template_general.png} | Bin ..._template_sql.png => fts_template_sql.png} | Bin ...ample.png => fts_template_sql_example.png} | Bin ...n_arguments.png => function_arguments.png} | Bin ...definition.png => function_definition.png} | Bin ...ction_general.png => function_general.png} | Bin ...ction_options.png => function_options.png} | Bin ...parameters.png => function_parameters.png} | Bin ...ion_security.png => function_security.png} | Bin ...eate_function_sql.png => function_sql.png} | Bin ...l_example.png => function_sql_example.png} | Bin ..._arguments.png => procedure_arguments.png} | Bin ...efinition.png => procedure_definition.png} | Bin ...dure_general.png => procedure_general.png} | Bin ...dure_options.png => procedure_options.png} | Bin ...arameters.png => procedure_parameters.png} | Bin ...re_security.png => procedure_security.png} | Bin ...te_procedure_sql.png => procedure_sql.png} | Bin ..._example.png => procedure_sql_example.png} | Bin ...general.png => resource_group_general.png} | Bin ...e_group_sql.png => resource_group_sql.png} | Bin ...ple.png => resource_group_sql_example.png} | Bin ...ole_definition.png => role_definition.png} | Bin ...eate_role_general.png => role_general.png} | Bin ...ole_parameters.png => role_parameters.png} | Bin ...ole_privileges.png => role_privileges.png} | Bin ...te_role_security.png => role_security.png} | Bin .../{create_role_sql.png => role_sql.png} | Bin ...e_sql_example.png => role_sql_example.png} | Bin ..._schema_general.png => schema_general.png} | Bin ...chema_security.png => schema_security.png} | Bin .../{create_schema_sql.png => schema_sql.png} | Bin ...sql_example.png => schema_sql_example.png} | Bin ...definition.png => sequence_definition.png} | Bin ...uence_general.png => sequence_general.png} | Bin ...nce_security.png => sequence_security.png} | Bin ...eate_sequence_sql.png => sequence_sql.png} | Bin ...l_example.png => sequence_sql_example.png} | Bin ...r_connection.png => server_connection.png} | Bin ..._server_general.png => server_general.png} | Bin ...eate_server_group.png => server_group.png} | Bin ...finition.png => tablespace_definition.png} | Bin ...ace_general.png => tablespace_general.png} | Bin ...rameters.png => tablespace_parameters.png} | Bin ...e_security.png => tablespace_security.png} | Bin ..._tablespace_sql.png => tablespace_sql.png} | Bin docs/en_US/index.rst | 132 ++++++++---------- docs/en_US/object-dialogs.rst | 28 ---- ...ate_procedure.rst => procedure_dialog.rst} | 32 ++--- docs/en_US/{query-tool.rst => query_tool.rst} | 3 +- docs/en_US/resource_group_dialog.rst | 37 +++++ .../{create_role.rst => role_dialog.rst} | 28 ++-- .../{create_schema.rst => schema_dialog.rst} | 26 ++-- ...reate_sequence.rst => sequence_dialog.rst} | 28 ++-- ...r-deployment.rst => server_deployment.rst} | 3 +- .../{create_server.rst => server_dialog.rst} | 16 +-- docs/en_US/server_group_dialog.rst | 17 +++ ...ing-patches.rst => submitting_patches.rst} | 3 +- ...e_tablespace.rst => tablespace_dialog.rst} | 28 ++-- docs/en_US/translations.rst | 9 +- .../casts/templates/cast/js/casts.js | 2 +- .../event_triggers/js/event_trigger.js | 2 +- .../templates/extensions/js/extensions.js | 2 +- .../js/foreign_data_wrappers.js | 2 +- .../templates/collation/js/collation.js | 2 +- .../js/domain-constraints.js | 2 +- .../templates/fts_parser/js/fts_parser.js | 2 +- .../fts_template/js/fts_templates.js | 2 +- .../templates/function/js/functions.js | 2 +- .../templates/procedure/js/procedures.js | 2 +- .../templates/sequence/js/sequence.js | 2 +- .../schemas/templates/schema/js/schema.js | 2 +- .../templates/databases/js/databases.js | 2 +- .../resource_groups/js/resource_groups.js | 2 +- .../servers/roles/templates/role/js/role.js | 2 +- .../templates/tablespaces/js/tablespaces.js | 2 +- .../servers/templates/servers/servers.js | 2 +- .../templates/server_groups/server_groups.js | 2 +- 145 files changed, 370 insertions(+), 436 deletions(-) rename docs/en_US/{create_cast.rst => cast_dialog.rst} (63%) rename docs/en_US/{code-overview.rst => code_overview.rst} (99%) rename docs/en_US/{code-review.rst => code_review.rst} (96%) rename docs/en_US/{code-snippet.rst => code_snippets.rst} (99%) rename docs/en_US/{coding-standards.rst => coding_standards.rst} (98%) rename docs/en_US/{create_collation.rst => collation_dialog.rst} (66%) delete mode 100644 docs/en_US/create_resource_group.rst delete mode 100644 docs/en_US/create_server_group.rst rename docs/en_US/{create_database.rst => database_dialog.rst} (78%) rename docs/en_US/{desktop-deployment.rst => desktop_deployment.rst} (97%) rename docs/en_US/{create_domain_constraint.rst => domain_constraint_dialog.rst} (63%) rename docs/en_US/{create_event_trigger.rst => event_trigger_dialog.rst} (62%) rename docs/en_US/{create_extension.rst => extension_dialog.rst} (53%) rename docs/en_US/{create_fdw.rst => foreign_data_wrapper_dialog.rst} (68%) rename docs/en_US/{create_fts_parser.rst => fts_parser_dialog.rst} (60%) rename docs/en_US/{create_fts_template.rst => fts_template_dialog.rst} (54%) rename docs/en_US/{create_function.rst => function_dialog.rst} (82%) rename docs/en_US/images/{create_cast_definition.png => cast_definition.png} (100%) rename docs/en_US/images/{create_cast_general.png => cast_general.png} (100%) rename docs/en_US/images/{create_cast_sql.png => cast_sql.png} (100%) rename docs/en_US/images/{create_cast_sql_example.png => cast_sql_example.png} (100%) rename docs/en_US/images/{create_collation_definition.png => collation_definition.png} (100%) rename docs/en_US/images/{create_collation_general.png => collation_general.png} (100%) rename docs/en_US/images/{create_collation_sql.png => collation_sql.png} (100%) rename docs/en_US/images/{create_collation_sql_example.png => collation_sql_example.png} (100%) rename docs/en_US/images/{create_database_definition.png => database_definition.png} (100%) rename docs/en_US/images/{create_database_general.png => database_general.png} (100%) rename docs/en_US/images/{create_database_parameters.png => database_parameters.png} (100%) rename docs/en_US/images/{create_database_security.png => database_security.png} (100%) rename docs/en_US/images/{create_database_sql.png => database_sql.png} (100%) rename docs/en_US/images/{create_database_sql_example.png => database_sql_example.png} (100%) rename docs/en_US/images/{create_domain_constraint_definition.png => domain_constraint_definition.png} (100%) rename docs/en_US/images/{create_domain_constraint_general.png => domain_constraint_general.png} (100%) rename docs/en_US/images/{create_domain_constraint_sql.png => domain_constraint_sql.png} (100%) rename docs/en_US/images/{create_domain_constraint_sql_example.png => domain_constraint_sql_example.png} (100%) rename docs/en_US/images/{create_domain_constraints.png => domain_constraints.png} (100%) rename docs/en_US/images/{create_domain_definition.png => domain_definition.png} (100%) rename docs/en_US/images/{create_domain_general.png => domain_general.png} (100%) rename docs/en_US/images/{create_domain_security.png => domain_security.png} (100%) rename docs/en_US/images/{create_domain_sql.png => domain_sql.png} (100%) rename docs/en_US/images/{create_domain_sql_example.png => domain_sql_example.png} (100%) rename docs/en_US/images/{create_event_trigger_definition.png => event_trigger_definition.png} (100%) rename docs/en_US/images/{create_event_trigger_general.png => event_trigger_general.png} (100%) rename docs/en_US/images/{create_event_trigger_security.png => event_trigger_security.png} (100%) rename docs/en_US/images/{create_event_trigger_sql.png => event_trigger_sql.png} (100%) rename docs/en_US/images/{create_extension_definition.png => extension_definition.png} (100%) rename docs/en_US/images/{create_extension_general.png => extension_general.png} (100%) rename docs/en_US/images/{create_extension_sql.png => extension_sql.png} (100%) rename docs/en_US/images/{create_extension_sql_example.png => extension_sql_example.png} (100%) rename docs/en_US/images/{create_fdw_definition.png => foreign_data_wrapper_definition.png} (100%) rename docs/en_US/images/{create_fdw_general.png => foreign_data_wrapper_general.png} (100%) rename docs/en_US/images/{create_fdw_options.png => foreign_data_wrapper_options.png} (100%) rename docs/en_US/images/{create_fdw_security.png => foreign_data_wrapper_security.png} (100%) rename docs/en_US/images/{create_fdw_sql.png => foreign_data_wrapper_sql.png} (100%) rename docs/en_US/images/{create_fdw_sql_example.png => foreign_data_wrapper_sql_example.png} (100%) rename docs/en_US/images/{create_fts_dictionary_definition.png => fts_dictionary_definition.png} (100%) rename docs/en_US/images/{create_fts_dictionary_general.png => fts_dictionary_general.png} (100%) rename docs/en_US/images/{create_fts_dictionary_options.png => fts_dictionary_options.png} (100%) rename docs/en_US/images/{create_fts_dictionary_sql.png => fts_dictionary_sql.png} (100%) rename docs/en_US/images/{create_fts_dictionary_sql_example.png => fts_dictionary_sql_example.png} (100%) rename docs/en_US/images/{create_fts_parser_definition.png => fts_parser_definition.png} (100%) rename docs/en_US/images/{create_fts_parser_general.png => fts_parser_general.png} (100%) rename docs/en_US/images/{create_fts_parser_sql.png => fts_parser_sql.png} (100%) rename docs/en_US/images/{create_fts_template_definition.png => fts_template_definition.png} (100%) rename docs/en_US/images/{create_fts_template_general.png => fts_template_general.png} (100%) rename docs/en_US/images/{create_fts_template_sql.png => fts_template_sql.png} (100%) rename docs/en_US/images/{create_fts_template_sql_example.png => fts_template_sql_example.png} (100%) rename docs/en_US/images/{create_function_arguments.png => function_arguments.png} (100%) rename docs/en_US/images/{create_function_definition.png => function_definition.png} (100%) rename docs/en_US/images/{create_function_general.png => function_general.png} (100%) rename docs/en_US/images/{create_function_options.png => function_options.png} (100%) rename docs/en_US/images/{create_function_parameters.png => function_parameters.png} (100%) rename docs/en_US/images/{create_function_security.png => function_security.png} (100%) rename docs/en_US/images/{create_function_sql.png => function_sql.png} (100%) rename docs/en_US/images/{create_function_sql_example.png => function_sql_example.png} (100%) rename docs/en_US/images/{create_procedure_arguments.png => procedure_arguments.png} (100%) rename docs/en_US/images/{create_procedure_definition.png => procedure_definition.png} (100%) rename docs/en_US/images/{create_procedure_general.png => procedure_general.png} (100%) rename docs/en_US/images/{create_procedure_options.png => procedure_options.png} (100%) rename docs/en_US/images/{create_procedure_parameters.png => procedure_parameters.png} (100%) rename docs/en_US/images/{create_procedure_security.png => procedure_security.png} (100%) rename docs/en_US/images/{create_procedure_sql.png => procedure_sql.png} (100%) rename docs/en_US/images/{create_procedure_sql_example.png => procedure_sql_example.png} (100%) rename docs/en_US/images/{create_resource_group_general.png => resource_group_general.png} (100%) rename docs/en_US/images/{create_resource_group_sql.png => resource_group_sql.png} (100%) rename docs/en_US/images/{create_resource_group_sql_example.png => resource_group_sql_example.png} (100%) rename docs/en_US/images/{create_role_definition.png => role_definition.png} (100%) rename docs/en_US/images/{create_role_general.png => role_general.png} (100%) rename docs/en_US/images/{create_role_parameters.png => role_parameters.png} (100%) rename docs/en_US/images/{create_role_privileges.png => role_privileges.png} (100%) rename docs/en_US/images/{create_role_security.png => role_security.png} (100%) rename docs/en_US/images/{create_role_sql.png => role_sql.png} (100%) rename docs/en_US/images/{create_role_sql_example.png => role_sql_example.png} (100%) rename docs/en_US/images/{create_schema_general.png => schema_general.png} (100%) rename docs/en_US/images/{create_schema_security.png => schema_security.png} (100%) rename docs/en_US/images/{create_schema_sql.png => schema_sql.png} (100%) rename docs/en_US/images/{create_schema_sql_example.png => schema_sql_example.png} (100%) rename docs/en_US/images/{create_sequence_definition.png => sequence_definition.png} (100%) rename docs/en_US/images/{create_sequence_general.png => sequence_general.png} (100%) rename docs/en_US/images/{create_sequence_security.png => sequence_security.png} (100%) rename docs/en_US/images/{create_sequence_sql.png => sequence_sql.png} (100%) rename docs/en_US/images/{create_sequence_sql_example.png => sequence_sql_example.png} (100%) rename docs/en_US/images/{create_server_connection.png => server_connection.png} (100%) rename docs/en_US/images/{create_server_general.png => server_general.png} (100%) rename docs/en_US/images/{create_server_group.png => server_group.png} (100%) rename docs/en_US/images/{create_tablespace_definition.png => tablespace_definition.png} (100%) rename docs/en_US/images/{create_tablespace_general.png => tablespace_general.png} (100%) rename docs/en_US/images/{create_tablespace_parameters.png => tablespace_parameters.png} (100%) rename docs/en_US/images/{create_tablespace_security.png => tablespace_security.png} (100%) rename docs/en_US/images/{create_tablespace_sql.png => tablespace_sql.png} (100%) delete mode 100644 docs/en_US/object-dialogs.rst rename docs/en_US/{create_procedure.rst => procedure_dialog.rst} (81%) rename docs/en_US/{query-tool.rst => query_tool.rst} (69%) create mode 100644 docs/en_US/resource_group_dialog.rst rename docs/en_US/{create_role.rst => role_dialog.rst} (85%) rename docs/en_US/{create_schema.rst => schema_dialog.rst} (67%) rename docs/en_US/{create_sequence.rst => sequence_dialog.rst} (79%) rename docs/en_US/{server-deployment.rst => server_deployment.rst} (98%) rename docs/en_US/{create_server.rst => server_dialog.rst} (78%) create mode 100644 docs/en_US/server_group_dialog.rst rename docs/en_US/{submitting-patches.rst => submitting_patches.rst} (96%) rename docs/en_US/{create_tablespace.rst => tablespace_dialog.rst} (76%) diff --git a/docs/en_US/browser.rst b/docs/en_US/browser.rst index c047371e6..51683e68c 100644 --- a/docs/en_US/browser.rst +++ b/docs/en_US/browser.rst @@ -1,5 +1,6 @@ +******* Browser -======= +******* The Browser is the main window used in pgAdmin. It allows you to connect to database servers and browse the objects on them. \ No newline at end of file diff --git a/docs/en_US/build_code_snippet.py b/docs/en_US/build_code_snippet.py index 0a8563f58..982952e46 100644 --- a/docs/en_US/build_code_snippet.py +++ b/docs/en_US/build_code_snippet.py @@ -13,11 +13,12 @@ if sys.path[0] != root: from pgadmin.utils import PgAdminModule -target = open('code-snippet.rst', 'w') +target = open('code_snippets.rst', 'w') target.truncate() -target.write("Code Snippet\n") -target.write("------------\n\n") +target.write("*************\n") +target.write("Code Snippets\n") +target.write("*************\n\n") target.write(""" This document contains code for some of the important classes, listed as below:\n\n""") diff --git a/docs/en_US/create_cast.rst b/docs/en_US/cast_dialog.rst similarity index 63% rename from docs/en_US/create_cast.rst rename to docs/en_US/cast_dialog.rst index df3d9bbbe..c20e47caa 100644 --- a/docs/en_US/create_cast.rst +++ b/docs/en_US/cast_dialog.rst @@ -1,18 +1,16 @@ -.. _create_cast: +*********** +Cast Dialog +*********** -************* -Create - Cast -************* +Use the *Cast* dialog to define a cast. A cast specifies how to convert a value from one data type to another. -Use the *Create - Cast* dialog to define a cast. A cast specifies how to convert a value from one data type to another. - -The *Create - Cast* dialog allows you to implement options of the *CREATE CAST* command. For more information about the *CREATE CAST* command, see the PostgreSQL core documentation available at: +The *Cast* dialog allows you to implement options of the *CREATE CAST* command. For more information about the *CREATE CAST* command, see the PostgreSQL core documentation available at: http://www.postgresql.org/docs/current/static/sql-createcast.html -The *Create - Cast* dialog organizes the development of a cast through the following dialog tabs: *General* and *Definition*. The *SQL* tab displays the SQL code generated by dialog selections. +The *Cast* dialog organizes the development of a cast through the following dialog tabs: *General* and *Definition*. The *SQL* tab displays the SQL code generated by dialog selections. -.. image:: images/create_cast_general.png +.. image:: images/cast_general.png Use the fields in the *General* tab to identify the cast: @@ -21,7 +19,7 @@ Use the fields in the *General* tab to identify the cast: Click the *Definition* tab to continue. -.. image:: images/create_cast_definition.png +.. image:: images/cast_definition.png Use the fields in the *Definition* tab to define parameters: @@ -32,9 +30,9 @@ Use the fields in the *Definition* tab to define parameters: Click the *SQL* tab to continue. -.. image:: images/create_cast_sql.png +.. image:: images/cast_sql.png -Your entries in the *Create - Cast* dialog generate a SQL command; you can review the command on the *SQL* pane. +Your entries in the *Cast* dialog generate a SQL command; you can review the command on the *SQL* pane. * Click the *Info* button (i) to access online help. * Click the *Save* button to save work. @@ -44,7 +42,7 @@ Your entries in the *Create - Cast* dialog generate a SQL command; you can revie Example ======= -The following is an example of the sql command generated by user selections in the *Create - Cast* dialog: +The following is an example of the sql command generated by user selections in the *Cast dialog*: -.. image:: images/create_cast_sql_example.png +.. image:: images/cast_sql_example.png diff --git a/docs/en_US/code-overview.rst b/docs/en_US/code_overview.rst similarity index 99% rename from docs/en_US/code-overview.rst rename to docs/en_US/code_overview.rst index ef813b4ac..f9eb64bdd 100644 --- a/docs/en_US/code-overview.rst +++ b/docs/en_US/code_overview.rst @@ -1,5 +1,6 @@ +************* Code Overview -============= +************* The bulk of pgAdmin is a Python web application written using the Flask framework on the backend, and HTML5 with CSS3, Bootstrap and jQuery on the front end. A @@ -7,14 +8,14 @@ desktop runtime is also included for users that prefer a desktop application to a web application, which is written in C++ using the QT framework. Runtime -------- +======= The runtime is essentially a Python webserver and browser in a box. Found in the **/runtime** directory in the source tree, it is a relatively simple QT application that is most easily modified using the **QT Creator** application. Web Application ---------------- +=============== The web application forms the bulk of pgAdmin and can be found in the **/web** directory in the source tree. The main file is **pgAdmin4.py** which can be used @@ -22,7 +23,7 @@ to run the built-in standalone web server, or as a WSGI application for producti use. Configuration -************* +------------- The core application configuration is found in **config.py**. This file includes all configurable settings for the application, along with descriptions of their @@ -31,7 +32,7 @@ a web server; these can be overriden in **config_local.py** to avoid modifying the main configuration file. User Settings -************* +------------- When running in desktop mode, pgAdmin has a single, default user account that is used for the desktop user. When running in server mode, there may be unlimited @@ -54,7 +55,7 @@ The local configuration will determine how the script sets up the database, particularly with regard to desktop vs. server mode. pgAdmin Core -************ +============ The heart of pgAdmin is the **pgadmin** package. This contains the globally available HTML templates used by the Jinja engine, as well as any global static @@ -65,7 +66,7 @@ is responsible for setting up logging and authentication, dynamically loading other modules, and a few other tasks. Modules -******* +======= Units of functionality are added to pgAdmin through the addition of modules. Theses are Python object instance of classes, inherits the @@ -187,7 +188,7 @@ loaded modules, but must use the defined hook points and fail gracefully in the event that a particular module is not present. Nodes -***** +===== Nodes are very similar to modules, it represents an individual node or, collection object on the browser treeview. To recognised as a node module, a @@ -199,7 +200,7 @@ Python package (along with javascript modules) must be created. This must: 3) An instance of the class object Front End -********* +========= pgAdmin uses javascript extensively for the front-end implementation. It uses require.js to allow the lazy loading (or, say load only when required), diff --git a/docs/en_US/code-review.rst b/docs/en_US/code_review.rst similarity index 96% rename from docs/en_US/code-review.rst rename to docs/en_US/code_review.rst index daea05e76..05823e914 100644 --- a/docs/en_US/code-review.rst +++ b/docs/en_US/code_review.rst @@ -1,5 +1,6 @@ +***************** Code Review Notes -================= +***************** This document lists a number of standard items that will be checked during the review process for any patches submitted for inclusion in pgAdmin. diff --git a/docs/en_US/code-snippet.rst b/docs/en_US/code_snippets.rst similarity index 99% rename from docs/en_US/code-snippet.rst rename to docs/en_US/code_snippets.rst index e4ca22727..09c5dc5ca 100644 --- a/docs/en_US/code-snippet.rst +++ b/docs/en_US/code_snippets.rst @@ -1,5 +1,6 @@ -Code Snippet ------------- +************* +Code Snippets +************* This document contains code for some of the important classes, listed as diff --git a/docs/en_US/coding-standards.rst b/docs/en_US/coding_standards.rst similarity index 98% rename from docs/en_US/coding-standards.rst rename to docs/en_US/coding_standards.rst index 1eb86d723..c234c8b1a 100644 --- a/docs/en_US/coding-standards.rst +++ b/docs/en_US/coding_standards.rst @@ -1,11 +1,12 @@ +**************** Coding Standards -================ +**************** pgAdmin uses multiple technologies and multiple languages, each of which have their own coding standards. General -------- +======= In all languages, indentations should be made with 4 spaces, and excessively long lines wrapped where appropriate to ensure they can be read on smaller displays @@ -17,7 +18,7 @@ Comments should be included in all code where required to explain its purpose or how it works if not obvious from a quick review of the code itself. CSS 3 ------ +===== CSS3 is used for styling and layout throughout the application. Extensive use is made of the Bootstrap Framework to aid in that process, however additional @@ -51,7 +52,7 @@ Styles should be specified clearly, one per line. For example: All stylesheets must be CSS3 compliant. HTML 5 ------- +====== HTML 5 is used for page structure throughout the application, in most cases being rendered from templates by the Jinja2 template engine in Flask. @@ -59,7 +60,7 @@ being rendered from templates by the Jinja2 template engine in Flask. All HTML must be HTML 5 compliant. Javascript ----------- +========== Client-side code is written in Javascript using jQuery and various plugins. Whilst much of the code is rendered from static files, there is also code that @@ -152,7 +153,7 @@ which may be omitted if on a single statement is present: } Python ------- +====== Python is used for the backend web server. All code must be compatible with Python 2.7 and should include PyDoc comments whilst following the official diff --git a/docs/en_US/create_collation.rst b/docs/en_US/collation_dialog.rst similarity index 66% rename from docs/en_US/create_collation.rst rename to docs/en_US/collation_dialog.rst index b677b3fcf..124147a0b 100644 --- a/docs/en_US/create_collation.rst +++ b/docs/en_US/collation_dialog.rst @@ -1,19 +1,17 @@ -.. _create_collation: - -****************** -Create - Collation -****************** +**************** +Collation Dialog +**************** -Use the *Create - Collation* dialog to define a collation. To be able to create a collation, you must have a CREATE privilege on the destination schema. +Use the *Collation* dialog to define a collation. To be able to create a collation, you must have a CREATE privilege on the destination schema. -The *Create - Collation* dialog allows you to implement options of the CREATE COLLATION command. For more information about the CREATE COLLATION command, see the documentation available at: +The *Collation* dialog allows you to implement options of the CREATE COLLATION command. For more information about the CREATE COLLATION command, see the documentation available at: http://www.postgresql.org/docs/current/static/sql-createcollation.html -The *Create - Collation* dialog organizes the development of a collation through the following dialog tabs: *General* and *Definition*. The *SQL* tab displays the SQL code generated by dialog selections. +The *Collation* dialog organizes the development of a collation through the following dialog tabs: *General* and *Definition*. The *SQL* tab displays the SQL code generated by dialog selections. -.. image:: images/create_collation_general.png +.. image:: images/collation_general.png Use the fields in the *General* tab to identify the collation: @@ -24,7 +22,7 @@ Use the fields in the *General* tab to identify the collation: Click the *Definition* tab to continue. -.. image:: images/create_collation_definition.png +.. image:: images/collation_definition.png Use the fields in the *Definition* tab to specify operating system locale settings: @@ -40,9 +38,9 @@ For more information about setting a locale, see Chapter 22.1 Locale Support of Click the *SQL* tab to continue. -.. image:: images/create_collation_sql.png +.. image:: images/collation_sql.png -Your entries in the *Create - Collation* dialog generate a generate a SQL command. The example shown demonstrates creating a collation named *french* that uses the rules specified for the locale, *fr_FR.utf8. The collation is owned by *enterprisedb*. +Your entries in the *Collation* dialog generate a generate a SQL command. The example shown demonstrates creating a collation named *french* that uses the rules specified for the locale, *fr_FR.utf8. The collation is owned by *enterprisedb*. * Click the *Info* button (i) to access online help. * Click the *Save* button to save work. @@ -52,8 +50,8 @@ Your entries in the *Create - Collation* dialog generate a generate a SQL comman Example ======= -The following is an example of the sql command generated by user selections in the *Create - Database* dialog: +The following is an example of the sql command generated by user selections in the *Database dialog*: -.. image:: images/create_collation_sql_example.png +.. image:: images/collation_sql_example.png diff --git a/docs/en_US/create_resource_group.rst b/docs/en_US/create_resource_group.rst deleted file mode 100644 index 9c9763531..000000000 --- a/docs/en_US/create_resource_group.rst +++ /dev/null @@ -1,39 +0,0 @@ -.. _create_resource: - -*********************** -Create - Resource Group -*********************** - -Use the *Create - Resource Group* dialog to create a resource group and set values for the groups resources. A resource group is a named, global group on which various resource usage limits can be defined. The resource group is accessible from all databases in the cluster. To use the *Create - Resource Group* dialog, you must have superuser privileges. Please note that resource groups are supported when connected to EDB Postgres Advanced Server; for more information about using resource groups, please see the EDB Postgres Advanced Server Guide, available at: - - http://www.enterprisedb.com/ - -The *Create - Resource Group* dialog organizes the development of a resource group through the *General* dialog tab. The *SQL* tab displays the SQL code generated by dialog selections. - -.. image:: images/create_resource_group_general.png - -Use the fields in the *General* tab to specify resource group parameters: - -* Use the *Group Name* field to add a descriptive name for the resource group. This name will be displayed in the *pgAdmin* tree control. -* Use the *CPU Rate Limit (%)* field to set the value of the CPU rate limit resource type assigned to the resource group. The valid range for a CPU rate limit is from 0 to 1.67772e+07. The default value is 0. -* Use the *Dirty Rate Limit (KB)* field to set the value of the dirty rate limit resource type assigned to the resource group. The valid range for a dirty rate limit is from 0 to 1.67772e+07. The default value is 0. - -Click the *SQL* tab to continue. - -.. image:: images/create_resource_group_sql.png - -Your entries in the *Create - Resource Group* dialog generate a SQL command; you can review the command on the *SQL* pane. - -* Click the *Info* button (i) to access online help. -* Click the *Save* button to save work. -* Click the *Cancel* button to exit without saving work. -* Click the *Reset* button to restore configuration parameters. - -Example -======= - -The following is an example of the sql command generated by selections made in the *Create - Resource Group* dialog: - -.. image:: images/create_resource_group_sql_example.png - -The example creates a resource group named *acctg* that sets *cpu_rate_limit* to *2*, and *dirty_rate_limit* to *6144*. \ No newline at end of file diff --git a/docs/en_US/create_server_group.rst b/docs/en_US/create_server_group.rst deleted file mode 100644 index b2c9a7958..000000000 --- a/docs/en_US/create_server_group.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. _create_server_group: - -******************* -Create Server Group -******************* - -Use the *Create - Server Group* dialog to add a new server group. Assign servers to server groups to simplify management of multiple servers. Server groups are displayed as part of the client tree control. - -.. image:: images/create_server_group.png - -Use the *Name* field on the *Create - Server Group* dialog to specify a name that will identify the server group in the pgAdmin tree control. - -* Click the *Info* button (i) to access online help. -* Click the *Save* button to save work. -* Click the *Cancel* button to exit without saving work. -* Click the *Reset* button to restore configuration parameters. - -To create server connections in a server group, right click on the named server group and select the *Create* option to open the *Create Server* dialog. - diff --git a/docs/en_US/create_database.rst b/docs/en_US/database_dialog.rst similarity index 78% rename from docs/en_US/create_database.rst rename to docs/en_US/database_dialog.rst index 8258a0e78..95c46a2ef 100644 --- a/docs/en_US/create_database.rst +++ b/docs/en_US/database_dialog.rst @@ -1,18 +1,16 @@ -.. _create_database: +*************** +Database Dialog +*************** -***************** -Create - Database -***************** +Use the *Database* dialog to create a database. To create a database, you must be a database superuser or have the CREATE privilege. -Use the *Create - Database* dialog to create a database. To create a database, you must be a database superuser or have the CREATE privilege. - -The *Create - Database* dialog allows you to implement options of the CREATE DATABASE command. For more information about the CREATE DATABASE command, please see: +The *Database* dialog allows you to implement options of the CREATE DATABASE command. For more information about the CREATE DATABASE command, please see: http://www.postgresql.org/docs/9.5/static/sql-createdatabase.html - The *Create - Database* dialog organizes the development of a database through the following dialog tabs: *General*, *Definition*, *Security*, and *Parameters*. The *SQL* tab displays the SQL code generated by dialog selections. + The *Database* dialog organizes the development of a database through the following dialog tabs: *General*, *Definition*, *Security*, and *Parameters*. The *SQL* tab displays the SQL code generated by dialog selections. -.. image:: images/create_database_general.png +.. image:: images/database_general.png Use the fields in the *General* tab to identify the database: @@ -22,7 +20,7 @@ Use the fields in the *General* tab to identify the database: Click the *Definition* tab to continue. -.. image:: images/create_database_definition.png +.. image:: images/database_definition.png Use the *Definition* tab to set properties for the database: @@ -35,7 +33,7 @@ Use the *Definition* tab to set properties for the database: Click the *Security* tab to continue. -.. image:: images/create_database_security.png +.. image:: images/database_security.png Use the *Security* tab to assign privileges and define security labels. @@ -56,7 +54,7 @@ To discard a security label, click the trash icon to the left of the row and con Click the *Parameters* tab to continue. -.. image:: images/create_database_parameters.png +.. image:: images/database_parameters.png Use the *Parameters* tab to set parameters for the database: @@ -69,9 +67,9 @@ Follow these steps to add additional parameter value definitions; to discard a p Click the *SQL* tab to continue. -.. image:: images/create_database_sql.png +.. image:: images/database_sql.png -Your entries in the *Create - Database* dialog generate a SQL command; you can review the command on the *SQL* pane. +Your entries in the *Database* dialog generate a SQL command; you can review the command on the *SQL* pane. * Click the *Info* button (i) to access online help. * Click the *Save* button to save work. @@ -81,8 +79,8 @@ Your entries in the *Create - Database* dialog generate a SQL command; you can r Example ======= -The following is an example of the sql command generated by user selections in the *Create - Database* dialog: +The following is an example of the sql command generated by user selections in the *Database* dialog: -.. image:: images/create_database_sql_example.png +.. image:: images/database_sql_example.png The example creates a database named *hr* that is owned by *enterprisedb*. It allows unlimited connections, and is available to authenticated users in the *public* schema. diff --git a/docs/en_US/debugger.rst b/docs/en_US/debugger.rst index 68e1917f0..7dc676540 100644 --- a/docs/en_US/debugger.rst +++ b/docs/en_US/debugger.rst @@ -1,4 +1,5 @@ +******** Debugger -======== +******** The Debugger allows you to debug PL/PGSQL functions interactively. \ No newline at end of file diff --git a/docs/en_US/desktop-deployment.rst b/docs/en_US/desktop_deployment.rst similarity index 97% rename from docs/en_US/desktop-deployment.rst rename to docs/en_US/desktop_deployment.rst index 457e7ec8b..8251f8de9 100644 --- a/docs/en_US/desktop-deployment.rst +++ b/docs/en_US/desktop_deployment.rst @@ -1,5 +1,6 @@ +****************** Desktop Deployment -================== +****************** pgAdmin may be deployed as a desktop application by configuring the application to run in desktop mode and then utilising the desktop runtime to host and diff --git a/docs/en_US/create_domain_constraint.rst b/docs/en_US/domain_constraint_dialog.rst similarity index 63% rename from docs/en_US/create_domain_constraint.rst rename to docs/en_US/domain_constraint_dialog.rst index 482f9eb8b..a8f27c17b 100644 --- a/docs/en_US/create_domain_constraint.rst +++ b/docs/en_US/domain_constraint_dialog.rst @@ -1,16 +1,14 @@ -.. _create_domain_constraint: +************************ +Domain Constraint Dialog +************************ -************************** -Create - Domain Constraint -************************** - -Use the *Create - Domain Constraint* dialog to create a domain constraint. The *Create - Domain Constraint* dialog implements options of the ALTER DOMAIN command. For more information about the ALTER DOMAIN command, see PostgreSQL core documentation available at: +Use the *Domain Constraint* dialog to create a domain constraint. The *Domain Constraint* dialog implements options of the ALTER DOMAIN command. For more information about the ALTER DOMAIN command, see PostgreSQL core documentation available at: http://www.postgresql.org/docs/9.5/static/sql-alterdomain.html -The *Create - Domain Constraint* dialog organizes the development of a domain constraint through the following dialog tabs: *General* and *Definition*. The *SQL* tab displays the SQL code generated by dialog selections. +The *Domain Constraint* dialog organizes the development of a domain constraint through the following dialog tabs: *General* and *Definition*. The *SQL* tab displays the SQL code generated by dialog selections. -.. image:: images/create_domain_constraint_general.png +.. image:: images/domain_constraint_general.png :align: center Use the fields in the *General* tab to identify the domain constraint: @@ -19,7 +17,7 @@ Use the fields in the *General* tab to identify the domain constraint: Click the *Definition* tab to continue. -.. image:: images/create_domain_constraint_definition.png +.. image:: images/domain_constraint_definition.png :align: center Use the fields in the *Definition* tab to define the domain constraint: @@ -29,10 +27,10 @@ Use the fields in the *Definition* tab to define the domain constraint: Click the *SQL* tab to continue. -.. image:: images/create_domain_constraint_sql.png +.. image:: images/domain_constraint_sql.png :align: center -Your entries in the *Create - Domain Constraint* dialog generate a SQL command; you can review the command on the *SQL* pane. +Your entries in the *Domain Constraint* dialog generate a SQL command; you can review the command on the *SQL* pane. * Click the *Info* button (i) to access online help. * Click the *Save* button to save work. @@ -42,9 +40,9 @@ Your entries in the *Create - Domain Constraint* dialog generate a SQL command; Example ======= -The following is an example of the sql command generated by user selections in the *Create - Domain Constraint* dialog: +The following is an example of the sql command generated by user selections in the *Domain Constraint dialog*: -.. image:: images/create_domain_constraint_sql_example.png +.. image:: images/domain_constraint_sql_example.png The example shown demonstrates creating a domain constraint on the domain *timesheets* named *weekday*. It constrains a value to equal *Monday*, *Tuesday*, *Wednesday*, *Thursday*, or *Friday*. diff --git a/docs/en_US/create_event_trigger.rst b/docs/en_US/event_trigger_dialog.rst similarity index 62% rename from docs/en_US/create_event_trigger.rst rename to docs/en_US/event_trigger_dialog.rst index 9bfcbc74c..07fcd3052 100644 --- a/docs/en_US/create_event_trigger.rst +++ b/docs/en_US/event_trigger_dialog.rst @@ -1,18 +1,16 @@ -.. _create_event trigger: - -************************* -Create - Event Trigger -************************* +******************** +Event Trigger Dialog +******************** -Use the *Create - Event Trigger* dialog to define an event trigger. Unlike regular triggers, which are attached to a single table and capture only DML events, event triggers are global to a particular database and are capable of capturing DDL events. Like regular triggers, event triggers can be written in any procedural language that includes event trigger support, or in C, but not in plain SQL. +Use the *Event Trigger* dialog to define an event trigger. Unlike regular triggers, which are attached to a single table and capture only DML events, event triggers are global to a particular database and are capable of capturing DDL events. Like regular triggers, event triggers can be written in any procedural language that includes event trigger support, or in C, but not in plain SQL. -The *Create - Event Trigger* dialog allows you to implement options of the *CREATE EVENT TRIGGER* command. For more information about the *CREATE EVENT TRIGGER* command, see the PostgreSQL core documentation available at: +The *Event Trigger* dialog allows you to implement options of the *CREATE EVENT TRIGGER* command. For more information about the *CREATE EVENT TRIGGER* command, see the PostgreSQL core documentation available at: http://www.postgresql.org/docs/9.5/static/sql-createeventtrigger.html -The *Create - Event Trigger* dialog organizes the development of a event trigger through the following dialog tabs: *General*, *Definition*, and *Security Labels*. The *SQL* tab displays the SQL code generated by dialog selections. +The *Event Trigger* dialog organizes the development of a event trigger through the following dialog tabs: *General*, *Definition*, and *Security Labels*. The *SQL* tab displays the SQL code generated by dialog selections. -.. image:: images/create_event_trigger_general.png +.. image:: images/event_trigger_general.png Use the fields in the *General* tab to identify the event trigger: @@ -22,7 +20,7 @@ Use the fields in the *General* tab to identify the event trigger: Click the *Definition* tab to continue. -.. image:: images/create_event_trigger_definition.png +.. image:: images/event_trigger_definition.png Use the fields in the *Definition* tab to define the event trigger: @@ -33,7 +31,7 @@ Use the fields in the *Definition* tab to define the event trigger: Click the *Security Labels* tab to continue. -.. image:: images/create_event_trigger_security.png +.. image:: images/event_trigger_security.png Use the *Security* tab to define security labels applied to the trigger. Click *Add* to add each security label. @@ -48,9 +46,9 @@ For more information about using security Labels, please see the PostgreSQL Core Click the *SQL* tab to continue. -.. image:: images/create_event_trigger_sql.png +.. image:: images/event_trigger_sql.png -Your entries in the *Create - Event Trigger* dialog generate a generate a SQL command; you can review the command on the *SQL* pane. +Your entries in the *Event Trigger* dialog generate a generate a SQL command; you can review the command on the *SQL* pane. * Click the *Info* button (i) to access online help. * Click the *Save* button to save work. @@ -60,7 +58,7 @@ Your entries in the *Create - Event Trigger* dialog generate a generate a SQL co Example ======= -The following is an example of the sql command generated by user selections in the *Create - Event Trigger* dialog: +The following is an example of the sql command generated by user selections in the *Event Trigger dialog*: -.. image:: images/create_event_trigger_sql_example.png "FIXME" +.. image:: images/event_trigger_sql_example.png "FIXME" diff --git a/docs/en_US/create_extension.rst b/docs/en_US/extension_dialog.rst similarity index 53% rename from docs/en_US/create_extension.rst rename to docs/en_US/extension_dialog.rst index b46ceafed..c201942fd 100644 --- a/docs/en_US/create_extension.rst +++ b/docs/en_US/extension_dialog.rst @@ -1,12 +1,10 @@ -.. _create_extension: +**************** +Extension Dialog +**************** -******************* -Create - Extension -******************* +Use the *Extension* dialog to install a new extension into the current database. Each extension must have a unique name. Before you can use CREATE EXTENSION to load an extension into a database, the extension's supporting files must be installed. -Use the *Create - Extension* dialog to install a new extension into the current database. Each extension must have a unique name. Before you can use CREATE EXTENSION to load an extension into a database, the extension's supporting files must be installed. - -The *Create - Extension* dialog allows you to implement options of the CREATE EXTENSION command through the following dialog tabs: *General* and *Definition*. The *SQL* tab displays the SQL code generated by dialog selections. +The *Extension* dialog allows you to implement options of the CREATE EXTENSION command through the following dialog tabs: *General* and *Definition*. The *SQL* tab displays the SQL code generated by dialog selections. For more information about creating extensions, please see the PostgreSQL core documentation available at: @@ -14,7 +12,7 @@ For more information about creating extensions, please see the PostgreSQL core d http://www.postgresql.org/docs/current/static/extend-extensions.html -.. image:: images/create_extension_general.png +.. image:: images/extension_general.png Use the fields in the *General* tab to identify an extension: @@ -22,7 +20,7 @@ Use the fields in the *General* tab to identify an extension: Click the *Definition* tab to continue. -.. image:: images/create_extension_definition.png +.. image:: images/extension_definition.png Use the *Definition* tab to select the *Schema* and *Version*: @@ -31,9 +29,9 @@ Use the *Definition* tab to select the *Schema* and *Version*: Click the *SQL* tab to continue. -.. image:: images/create_extension_sql.png +.. image:: images/extension_sql.png -Your entries in the *Create - Extension* dialog generate a SQL command; you can review the command on the *SQL* pane. +Your entries in the *Extension* dialog generate a SQL command; you can review the command on the *SQL* pane. * Click the *Info* button (i) to access online help. * Click the *Save* button to save work. @@ -43,8 +41,8 @@ Your entries in the *Create - Extension* dialog generate a SQL command; you can Example ======= -The following is an example of the sql command generated by user selections in the *Create - Extension* dialog: +The following is an example of the sql command generated by user selections in the *Extension* dialog: -.. image:: images/create_extension_sql_example.png +.. image:: images/extension_sql_example.png The command creates the *adminpack* extension in the *pg_catalog* schema. It is version *1.0* of *adminpack*. \ No newline at end of file diff --git a/docs/en_US/create_fdw.rst b/docs/en_US/foreign_data_wrapper_dialog.rst similarity index 68% rename from docs/en_US/create_fdw.rst rename to docs/en_US/foreign_data_wrapper_dialog.rst index 88bbd26d5..858e647f6 100644 --- a/docs/en_US/create_fdw.rst +++ b/docs/en_US/foreign_data_wrapper_dialog.rst @@ -1,20 +1,18 @@ -.. _create_fdw: +*************************** +Foreign Data Wrapper Dialog +*************************** -***************************** -Create - Foreign Data Wrapper -***************************** - -Use the *Create - Foreign Data Wrapper* dialog to create a foreign data wrapper. The foreign data wrapper consists of a set of functions; all operations on a foreign table are handled through the foreign data wrapper. The foreign data wrapper is responsible for fetching data from the remote data source and returning it to the PostgreSQL executor. +Use the *Foreign Data Wrapper* dialog to create a foreign data wrapper. The foreign data wrapper consists of a set of functions; all operations on a foreign table are handled through the foreign data wrapper. The foreign data wrapper is responsible for fetching data from the remote data source and returning it to the PostgreSQL executor. A foreign-data wrapper name must be unique within the database. You must be a superuser to create a foreign-data wrapper. -The *Create - Foreign Data Wrapper* dialog allows you to implement options of the CREATE FOREIGN DATA WRAPPER command. For more information about the CREATE FOREIGN DATA WRAPPER command, see PostgreSQL core documentation available at: +The *Foreign Data Wrapper* dialog allows you to implement options of the CREATE FOREIGN DATA WRAPPER command. For more information about the CREATE FOREIGN DATA WRAPPER command, see PostgreSQL core documentation available at: http://www.postgresql.org/docs/9.5/static/sql-createforeigndatawrapper.html -The *Create - Foreign Data Wrapper* dialog organizes the development of a foreign data wrapper through the following dialog tabs: *General*, *Definition*, *Options*, and *Security*. The *SQL* tab displays the SQL code generated by dialog selections. +The *Foreign Data Wrapper* dialog organizes the development of a foreign data wrapper through the following dialog tabs: *General*, *Definition*, *Options*, and *Security*. The *SQL* tab displays the SQL code generated by dialog selections. -.. image:: images/create_fdw_general.png +.. image:: images/foreign_data_wrapper_general.png Use the fields in the *General* tab to identify the foreign data wrapper: @@ -24,7 +22,7 @@ Use the fields in the *General* tab to identify the foreign data wrapper: Click the *Definition* tab to continue. -.. image:: images/create_fdw_definition.png +.. image:: images/foreign_data_wrapper_definition.png Use the fields in the *Definition* tab to set parameters: @@ -33,7 +31,7 @@ Use the fields in the *Definition* tab to set parameters: Click the *Options* tab to continue. -.. image:: images/create_fdw_options.png +.. image:: images/foreign_data_wrapper_options.png Use the fields in the *Options* tab to specify options: @@ -44,7 +42,7 @@ Click *Add* to specify each additional pair; to discard an option, click the tra Click the *Security* tab to continue. -.. image:: images/create_fdw_security.png +.. image:: images/foreign_data_wrapper_security.png Use the *Security* tab to assign security privileges. Click *Add* to assign a set of privileges. @@ -56,9 +54,9 @@ To discard a privilege, click the trash icon to the left of the row and confirm Click the *SQL* tab to continue. -.. image:: images/create_fdw_sql.png +.. image:: images/foreign_data_wrapper_sql.png -Your entries in the *Create - Foreign Data Wrapper* dialog generate a SQL command; you can review the command on the *SQL* pane. +Your entries in the *Foreign Data Wrapper* dialog generate a SQL command; you can review the command on the *SQL* pane. * Click the *Help* button (?) to access online help. * Click the *Save* button to save work. @@ -68,8 +66,8 @@ Your entries in the *Create - Foreign Data Wrapper* dialog generate a SQL comman Example ======= -The following is an example of the sql command generated by user selections in the *Create - Foreign Data Wrapper* dialog: +The following is an example of the sql command generated by user selections in the *Foreign Data Wrapper dialog*: -.. image:: images/create_fdw_sql_example.png +.. image:: images/foreign_data_wrapper_sql_example.png The example creates a foreign data wrapper named *libpq_debug* that uses pre-existing validator and handler functions, *dblink_fdw_validator* and *libpg_fdw_handler*. Selections on the *Options* tab set *debug* equal to *true*. The foreign data wrapper is owned by *enterprisedb*. diff --git a/docs/en_US/create_fts_parser.rst b/docs/en_US/fts_parser_dialog.rst similarity index 60% rename from docs/en_US/create_fts_parser.rst rename to docs/en_US/fts_parser_dialog.rst index 04e30003b..24ff4412d 100644 --- a/docs/en_US/create_fts_parser.rst +++ b/docs/en_US/fts_parser_dialog.rst @@ -1,18 +1,16 @@ -.. _fts_parser: +***************** +FTS Parser Dialog +***************** -******************* -Create - FTS Parser -******************* - -Use the *Create - FTS Parser* dialog to create a new text search parser. A text search parser defines a method for splitting a text string into tokens and assigning types (categories) to the tokens. The *Create - FTS Parser* dialog allows you to implement options of the CREATE TEXT SEARCH PARSER command. For more information about the CREATE TEXT SEARCH PARSER command, see PostgreSQL core documentation available at: +Use the *FTS Parser* dialog to create a new text search parser. A text search parser defines a method for splitting a text string into tokens and assigning types (categories) to the tokens. The *FTS Parser* dialog allows you to implement options of the CREATE TEXT SEARCH PARSER command. For more information about the CREATE TEXT SEARCH PARSER command, see PostgreSQL core documentation available at: http://www.postgresql.org/docs/9.5/static/sql-createtsparser.html -The *Create - FTS Parser* dialog organizes the development of a text search parser through the following dialog tabs: *General*, and *Definition*. The *SQL* tab displays the SQL code generated by dialog selections. +The *FTS Parser* dialog organizes the development of a text search parser through the following dialog tabs: *General*, and *Definition*. The *SQL* tab displays the SQL code generated by dialog selections. Click the *General* tab to begin. -.. image:: images/create_fts_parser_general.png +.. image:: images/fts_parser_general.png Use the fields in the *General* tab to identify a text search parser: @@ -22,7 +20,7 @@ Use the fields in the *General* tab to identify a text search parser: Click the *Definition* tab to continue. -.. image:: images/create_fts_parser_definition.png +.. image:: images/fts_parser_definition.png Use the fields in the *Definition* tab to define parameters: @@ -34,9 +32,9 @@ Use the fields in the *Definition* tab to define parameters: Click the *SQL* tab to continue. -.. image:: images/create_fts_parser_sql.png +.. image:: images/fts_parser_sql.png -Your entries in the *Create - Extension* dialog generate a generate a SQL command; you can review the command on the *SQL* pane. +Your entries in the *Extension* dialog generate a generate a SQL command; you can review the command on the *SQL* pane. * Click the *Info* button (i) to access online help. * Click the *Save* button to save work. diff --git a/docs/en_US/create_fts_template.rst b/docs/en_US/fts_template_dialog.rst similarity index 54% rename from docs/en_US/create_fts_template.rst rename to docs/en_US/fts_template_dialog.rst index 39f2e6183..102643ad0 100644 --- a/docs/en_US/create_fts_template.rst +++ b/docs/en_US/fts_template_dialog.rst @@ -1,16 +1,14 @@ -.. _fts_template: +******************* +FTS Template Dialog +******************* -********************** -Create - FTS Template -********************** - -Use the *Create - FTS Template* dialog to create a new text search template. A text search template defines the functions that implement text search dictionaries. The *Create - FTS Template* dialog allows you to implement options of the CREATE TEXT SEARCH TEMPLATE command. For more information about the CREATE TEXT SEARCH TEMPLATE command, see PostgreSQL core documentation available at: +Use the *FTS Template* dialog to create a new text search template. A text search template defines the functions that implement text search dictionaries. The *FTS Template* dialog allows you to implement options of the CREATE TEXT SEARCH TEMPLATE command. For more information about the CREATE TEXT SEARCH TEMPLATE command, see PostgreSQL core documentation available at: http://www.postgresql.org/docs/9.5/static/sql-createtstemplate.html -The *Create - FTS Template* dialog organizes the development of a text search Template through the following dialog tabs: *General*, and *Definition*. The *SQL* tab displays the SQL code generated by dialog selections. +The *FTS Template* dialog organizes the development of a text search Template through the following dialog tabs: *General*, and *Definition*. The *SQL* tab displays the SQL code generated by dialog selections. -.. image:: images/create_fts_template_general.png +.. image:: images/fts_template_general.png Use the fields in the *General* tab to identify a template: @@ -20,7 +18,7 @@ Use the fields in the *General* tab to identify a template: Click the *Definition* tab to continue. -.. image:: images/create_fts_template_definition.png +.. image:: images/fts_template_definition.png Use the fields in the *Definition* tab to define function parameters: @@ -29,9 +27,9 @@ Use the fields in the *Definition* tab to define function parameters: Click the *SQL* tab to continue. -.. image:: images/create_fts_template_sql.png +.. image:: images/fts_template_sql.png -Your entries in the *Create - FTS Template* dialog generate a SQL command; you can review the command on the *SQL* pane. +Your entries in the *FTS Template* dialog generate a SQL command; you can review the command on the *SQL* pane. * Click the *Info* button (i) to access online help. * Click the *Save* button to save work. @@ -41,9 +39,9 @@ Your entries in the *Create - FTS Template* dialog generate a SQL command; you c Example ======= -The following is an example of the sql command generated by user selections in the *Create - FTS Template* dialog: +The following is an example of the sql command generated by user selections in the *FTS Template dialog*: -.. image:: images/create_fts_template_sql_example.png +.. image:: images/fts_template_sql_example.png The example shown demonstrates creating a fts template named *ru_template* that uses the ispell dictionary. diff --git a/docs/en_US/create_function.rst b/docs/en_US/function_dialog.rst similarity index 82% rename from docs/en_US/create_function.rst rename to docs/en_US/function_dialog.rst index ac726ef85..a80f9bd1f 100644 --- a/docs/en_US/create_function.rst +++ b/docs/en_US/function_dialog.rst @@ -1,18 +1,16 @@ -.. _create_function: +*************** +Function Dialog +*************** -***************** -Create - Function -***************** +Use the *Function* dialog to define a function. If you drop and then recreate a function, the new function is not the same entity as the old; you must drop existing rules, views, triggers, etc. that refer to the old function. -Use the *Create - Function* dialog to define a function. If you drop and then recreate a function, the new function is not the same entity as the old; you must drop existing rules, views, triggers, etc. that refer to the old function. - -The *Create - Function* dialog allows you to implement options of the CREATE FUNCTION and ALTER FUNCTION commands. For more information about the CREATE FUNCTION command, see the PostgreSQL core documentation available at: +The *Function* dialog allows you to implement options of the CREATE FUNCTION and ALTER FUNCTION commands. For more information about the CREATE FUNCTION command, see the PostgreSQL core documentation available at: http://www.postgresql.org/docs/9.5/static/sql-createfunction.html -The *Create - Function* dialog organizes the development of a function through the following dialog tabs: *General*, *Definition*, *Options*, *Arguments*, *Parameters*, and *Security*. The *SQL* tab displays the SQL code generated by dialog selections. +The *Function* dialog organizes the development of a function through the following dialog tabs: *General*, *Definition*, *Options*, *Arguments*, *Parameters*, and *Security*. The *SQL* tab displays the SQL code generated by dialog selections. -.. image:: images/create_function_general.png +.. image:: images/function_general.png Use the fields in the *General* tab to identify a function: @@ -23,7 +21,7 @@ Use the fields in the *General* tab to identify a function: Click the *Definition* tab to continue. -.. image:: images/create_function_definition.png +.. image:: images/function_definition.png Use the fields in the *Definition* tab to define the function: @@ -33,7 +31,7 @@ Use the fields in the *Definition* tab to define the function: Click the *Options* tab to continue. -.. image:: images/create_function_options.png +.. image:: images/function_options.png Use the fields in the *Options* tab to describe or modify the action of the function: @@ -52,7 +50,7 @@ Use the fields in the *Options* tab to describe or modify the action of the func Click the *Arguments* tab to continue. -.. image:: images/create_function_arguments.png +.. image:: images/function_arguments.png Use the fields in the *Arguments* tab to define an argument. Click *Add* to set parameters and values for the argument: @@ -65,7 +63,7 @@ Click *Add* to define another argument; to discard an argument, click the trash Click the *Parameters* tab to continue. -.. image:: images/create_function_parameters.png +.. image:: images/function_parameters.png Use the fields in the *Parameters* tab to specify settings that will be applied when the function is invoked: @@ -75,7 +73,7 @@ Use the fields in the *Parameters* tab to specify settings that will be applied Click the *Security* tab to continue. -.. image:: images/create_function_security.png +.. image:: images/function_security.png Use the *Security* tab to assign privileges and define security labels. @@ -96,9 +94,9 @@ Click *Add* to assign additional security labels; to discard a security label, c Click the *SQL* tab to continue. -.. image:: images/create_function_sql.png +.. image:: images/function_sql.png -Your entries in the *Create - Function* dialog generate a generate a SQL command; you can review the command on the *SQL* pane. +Your entries in the *Function* dialog generate a generate a SQL command; you can review the command on the *SQL* pane. * Click the *Info* button (i) to access online help. * Click the *Save* button to save work. @@ -108,9 +106,9 @@ Your entries in the *Create - Function* dialog generate a generate a SQL command Example ======= -The following is an example of the sql command generated by selections made in the *Create - Function* dialog: +The following is an example of the sql command generated by selections made in the *Function dialog*: -.. image:: images/create_function_sql_example.png +.. image:: images/function_sql_example.png The example demonstrates creating an *edbspl* function named *emp_comp*. The function adds two columns (p_sal and p_comm), and then uses the result to compute a yearly salary, returning a NUMERIC value. diff --git a/docs/en_US/images/create_cast_definition.png b/docs/en_US/images/cast_definition.png similarity index 100% rename from docs/en_US/images/create_cast_definition.png rename to docs/en_US/images/cast_definition.png diff --git a/docs/en_US/images/create_cast_general.png b/docs/en_US/images/cast_general.png similarity index 100% rename from docs/en_US/images/create_cast_general.png rename to docs/en_US/images/cast_general.png diff --git a/docs/en_US/images/create_cast_sql.png b/docs/en_US/images/cast_sql.png similarity index 100% rename from docs/en_US/images/create_cast_sql.png rename to docs/en_US/images/cast_sql.png diff --git a/docs/en_US/images/create_cast_sql_example.png b/docs/en_US/images/cast_sql_example.png similarity index 100% rename from docs/en_US/images/create_cast_sql_example.png rename to docs/en_US/images/cast_sql_example.png diff --git a/docs/en_US/images/create_collation_definition.png b/docs/en_US/images/collation_definition.png similarity index 100% rename from docs/en_US/images/create_collation_definition.png rename to docs/en_US/images/collation_definition.png diff --git a/docs/en_US/images/create_collation_general.png b/docs/en_US/images/collation_general.png similarity index 100% rename from docs/en_US/images/create_collation_general.png rename to docs/en_US/images/collation_general.png diff --git a/docs/en_US/images/create_collation_sql.png b/docs/en_US/images/collation_sql.png similarity index 100% rename from docs/en_US/images/create_collation_sql.png rename to docs/en_US/images/collation_sql.png diff --git a/docs/en_US/images/create_collation_sql_example.png b/docs/en_US/images/collation_sql_example.png similarity index 100% rename from docs/en_US/images/create_collation_sql_example.png rename to docs/en_US/images/collation_sql_example.png diff --git a/docs/en_US/images/create_database_definition.png b/docs/en_US/images/database_definition.png similarity index 100% rename from docs/en_US/images/create_database_definition.png rename to docs/en_US/images/database_definition.png diff --git a/docs/en_US/images/create_database_general.png b/docs/en_US/images/database_general.png similarity index 100% rename from docs/en_US/images/create_database_general.png rename to docs/en_US/images/database_general.png diff --git a/docs/en_US/images/create_database_parameters.png b/docs/en_US/images/database_parameters.png similarity index 100% rename from docs/en_US/images/create_database_parameters.png rename to docs/en_US/images/database_parameters.png diff --git a/docs/en_US/images/create_database_security.png b/docs/en_US/images/database_security.png similarity index 100% rename from docs/en_US/images/create_database_security.png rename to docs/en_US/images/database_security.png diff --git a/docs/en_US/images/create_database_sql.png b/docs/en_US/images/database_sql.png similarity index 100% rename from docs/en_US/images/create_database_sql.png rename to docs/en_US/images/database_sql.png diff --git a/docs/en_US/images/create_database_sql_example.png b/docs/en_US/images/database_sql_example.png similarity index 100% rename from docs/en_US/images/create_database_sql_example.png rename to docs/en_US/images/database_sql_example.png diff --git a/docs/en_US/images/create_domain_constraint_definition.png b/docs/en_US/images/domain_constraint_definition.png similarity index 100% rename from docs/en_US/images/create_domain_constraint_definition.png rename to docs/en_US/images/domain_constraint_definition.png diff --git a/docs/en_US/images/create_domain_constraint_general.png b/docs/en_US/images/domain_constraint_general.png similarity index 100% rename from docs/en_US/images/create_domain_constraint_general.png rename to docs/en_US/images/domain_constraint_general.png diff --git a/docs/en_US/images/create_domain_constraint_sql.png b/docs/en_US/images/domain_constraint_sql.png similarity index 100% rename from docs/en_US/images/create_domain_constraint_sql.png rename to docs/en_US/images/domain_constraint_sql.png diff --git a/docs/en_US/images/create_domain_constraint_sql_example.png b/docs/en_US/images/domain_constraint_sql_example.png similarity index 100% rename from docs/en_US/images/create_domain_constraint_sql_example.png rename to docs/en_US/images/domain_constraint_sql_example.png diff --git a/docs/en_US/images/create_domain_constraints.png b/docs/en_US/images/domain_constraints.png similarity index 100% rename from docs/en_US/images/create_domain_constraints.png rename to docs/en_US/images/domain_constraints.png diff --git a/docs/en_US/images/create_domain_definition.png b/docs/en_US/images/domain_definition.png similarity index 100% rename from docs/en_US/images/create_domain_definition.png rename to docs/en_US/images/domain_definition.png diff --git a/docs/en_US/images/create_domain_general.png b/docs/en_US/images/domain_general.png similarity index 100% rename from docs/en_US/images/create_domain_general.png rename to docs/en_US/images/domain_general.png diff --git a/docs/en_US/images/create_domain_security.png b/docs/en_US/images/domain_security.png similarity index 100% rename from docs/en_US/images/create_domain_security.png rename to docs/en_US/images/domain_security.png diff --git a/docs/en_US/images/create_domain_sql.png b/docs/en_US/images/domain_sql.png similarity index 100% rename from docs/en_US/images/create_domain_sql.png rename to docs/en_US/images/domain_sql.png diff --git a/docs/en_US/images/create_domain_sql_example.png b/docs/en_US/images/domain_sql_example.png similarity index 100% rename from docs/en_US/images/create_domain_sql_example.png rename to docs/en_US/images/domain_sql_example.png diff --git a/docs/en_US/images/create_event_trigger_definition.png b/docs/en_US/images/event_trigger_definition.png similarity index 100% rename from docs/en_US/images/create_event_trigger_definition.png rename to docs/en_US/images/event_trigger_definition.png diff --git a/docs/en_US/images/create_event_trigger_general.png b/docs/en_US/images/event_trigger_general.png similarity index 100% rename from docs/en_US/images/create_event_trigger_general.png rename to docs/en_US/images/event_trigger_general.png diff --git a/docs/en_US/images/create_event_trigger_security.png b/docs/en_US/images/event_trigger_security.png similarity index 100% rename from docs/en_US/images/create_event_trigger_security.png rename to docs/en_US/images/event_trigger_security.png diff --git a/docs/en_US/images/create_event_trigger_sql.png b/docs/en_US/images/event_trigger_sql.png similarity index 100% rename from docs/en_US/images/create_event_trigger_sql.png rename to docs/en_US/images/event_trigger_sql.png diff --git a/docs/en_US/images/create_extension_definition.png b/docs/en_US/images/extension_definition.png similarity index 100% rename from docs/en_US/images/create_extension_definition.png rename to docs/en_US/images/extension_definition.png diff --git a/docs/en_US/images/create_extension_general.png b/docs/en_US/images/extension_general.png similarity index 100% rename from docs/en_US/images/create_extension_general.png rename to docs/en_US/images/extension_general.png diff --git a/docs/en_US/images/create_extension_sql.png b/docs/en_US/images/extension_sql.png similarity index 100% rename from docs/en_US/images/create_extension_sql.png rename to docs/en_US/images/extension_sql.png diff --git a/docs/en_US/images/create_extension_sql_example.png b/docs/en_US/images/extension_sql_example.png similarity index 100% rename from docs/en_US/images/create_extension_sql_example.png rename to docs/en_US/images/extension_sql_example.png diff --git a/docs/en_US/images/create_fdw_definition.png b/docs/en_US/images/foreign_data_wrapper_definition.png similarity index 100% rename from docs/en_US/images/create_fdw_definition.png rename to docs/en_US/images/foreign_data_wrapper_definition.png diff --git a/docs/en_US/images/create_fdw_general.png b/docs/en_US/images/foreign_data_wrapper_general.png similarity index 100% rename from docs/en_US/images/create_fdw_general.png rename to docs/en_US/images/foreign_data_wrapper_general.png diff --git a/docs/en_US/images/create_fdw_options.png b/docs/en_US/images/foreign_data_wrapper_options.png similarity index 100% rename from docs/en_US/images/create_fdw_options.png rename to docs/en_US/images/foreign_data_wrapper_options.png diff --git a/docs/en_US/images/create_fdw_security.png b/docs/en_US/images/foreign_data_wrapper_security.png similarity index 100% rename from docs/en_US/images/create_fdw_security.png rename to docs/en_US/images/foreign_data_wrapper_security.png diff --git a/docs/en_US/images/create_fdw_sql.png b/docs/en_US/images/foreign_data_wrapper_sql.png similarity index 100% rename from docs/en_US/images/create_fdw_sql.png rename to docs/en_US/images/foreign_data_wrapper_sql.png diff --git a/docs/en_US/images/create_fdw_sql_example.png b/docs/en_US/images/foreign_data_wrapper_sql_example.png similarity index 100% rename from docs/en_US/images/create_fdw_sql_example.png rename to docs/en_US/images/foreign_data_wrapper_sql_example.png diff --git a/docs/en_US/images/create_fts_dictionary_definition.png b/docs/en_US/images/fts_dictionary_definition.png similarity index 100% rename from docs/en_US/images/create_fts_dictionary_definition.png rename to docs/en_US/images/fts_dictionary_definition.png diff --git a/docs/en_US/images/create_fts_dictionary_general.png b/docs/en_US/images/fts_dictionary_general.png similarity index 100% rename from docs/en_US/images/create_fts_dictionary_general.png rename to docs/en_US/images/fts_dictionary_general.png diff --git a/docs/en_US/images/create_fts_dictionary_options.png b/docs/en_US/images/fts_dictionary_options.png similarity index 100% rename from docs/en_US/images/create_fts_dictionary_options.png rename to docs/en_US/images/fts_dictionary_options.png diff --git a/docs/en_US/images/create_fts_dictionary_sql.png b/docs/en_US/images/fts_dictionary_sql.png similarity index 100% rename from docs/en_US/images/create_fts_dictionary_sql.png rename to docs/en_US/images/fts_dictionary_sql.png diff --git a/docs/en_US/images/create_fts_dictionary_sql_example.png b/docs/en_US/images/fts_dictionary_sql_example.png similarity index 100% rename from docs/en_US/images/create_fts_dictionary_sql_example.png rename to docs/en_US/images/fts_dictionary_sql_example.png diff --git a/docs/en_US/images/create_fts_parser_definition.png b/docs/en_US/images/fts_parser_definition.png similarity index 100% rename from docs/en_US/images/create_fts_parser_definition.png rename to docs/en_US/images/fts_parser_definition.png diff --git a/docs/en_US/images/create_fts_parser_general.png b/docs/en_US/images/fts_parser_general.png similarity index 100% rename from docs/en_US/images/create_fts_parser_general.png rename to docs/en_US/images/fts_parser_general.png diff --git a/docs/en_US/images/create_fts_parser_sql.png b/docs/en_US/images/fts_parser_sql.png similarity index 100% rename from docs/en_US/images/create_fts_parser_sql.png rename to docs/en_US/images/fts_parser_sql.png diff --git a/docs/en_US/images/create_fts_template_definition.png b/docs/en_US/images/fts_template_definition.png similarity index 100% rename from docs/en_US/images/create_fts_template_definition.png rename to docs/en_US/images/fts_template_definition.png diff --git a/docs/en_US/images/create_fts_template_general.png b/docs/en_US/images/fts_template_general.png similarity index 100% rename from docs/en_US/images/create_fts_template_general.png rename to docs/en_US/images/fts_template_general.png diff --git a/docs/en_US/images/create_fts_template_sql.png b/docs/en_US/images/fts_template_sql.png similarity index 100% rename from docs/en_US/images/create_fts_template_sql.png rename to docs/en_US/images/fts_template_sql.png diff --git a/docs/en_US/images/create_fts_template_sql_example.png b/docs/en_US/images/fts_template_sql_example.png similarity index 100% rename from docs/en_US/images/create_fts_template_sql_example.png rename to docs/en_US/images/fts_template_sql_example.png diff --git a/docs/en_US/images/create_function_arguments.png b/docs/en_US/images/function_arguments.png similarity index 100% rename from docs/en_US/images/create_function_arguments.png rename to docs/en_US/images/function_arguments.png diff --git a/docs/en_US/images/create_function_definition.png b/docs/en_US/images/function_definition.png similarity index 100% rename from docs/en_US/images/create_function_definition.png rename to docs/en_US/images/function_definition.png diff --git a/docs/en_US/images/create_function_general.png b/docs/en_US/images/function_general.png similarity index 100% rename from docs/en_US/images/create_function_general.png rename to docs/en_US/images/function_general.png diff --git a/docs/en_US/images/create_function_options.png b/docs/en_US/images/function_options.png similarity index 100% rename from docs/en_US/images/create_function_options.png rename to docs/en_US/images/function_options.png diff --git a/docs/en_US/images/create_function_parameters.png b/docs/en_US/images/function_parameters.png similarity index 100% rename from docs/en_US/images/create_function_parameters.png rename to docs/en_US/images/function_parameters.png diff --git a/docs/en_US/images/create_function_security.png b/docs/en_US/images/function_security.png similarity index 100% rename from docs/en_US/images/create_function_security.png rename to docs/en_US/images/function_security.png diff --git a/docs/en_US/images/create_function_sql.png b/docs/en_US/images/function_sql.png similarity index 100% rename from docs/en_US/images/create_function_sql.png rename to docs/en_US/images/function_sql.png diff --git a/docs/en_US/images/create_function_sql_example.png b/docs/en_US/images/function_sql_example.png similarity index 100% rename from docs/en_US/images/create_function_sql_example.png rename to docs/en_US/images/function_sql_example.png diff --git a/docs/en_US/images/create_procedure_arguments.png b/docs/en_US/images/procedure_arguments.png similarity index 100% rename from docs/en_US/images/create_procedure_arguments.png rename to docs/en_US/images/procedure_arguments.png diff --git a/docs/en_US/images/create_procedure_definition.png b/docs/en_US/images/procedure_definition.png similarity index 100% rename from docs/en_US/images/create_procedure_definition.png rename to docs/en_US/images/procedure_definition.png diff --git a/docs/en_US/images/create_procedure_general.png b/docs/en_US/images/procedure_general.png similarity index 100% rename from docs/en_US/images/create_procedure_general.png rename to docs/en_US/images/procedure_general.png diff --git a/docs/en_US/images/create_procedure_options.png b/docs/en_US/images/procedure_options.png similarity index 100% rename from docs/en_US/images/create_procedure_options.png rename to docs/en_US/images/procedure_options.png diff --git a/docs/en_US/images/create_procedure_parameters.png b/docs/en_US/images/procedure_parameters.png similarity index 100% rename from docs/en_US/images/create_procedure_parameters.png rename to docs/en_US/images/procedure_parameters.png diff --git a/docs/en_US/images/create_procedure_security.png b/docs/en_US/images/procedure_security.png similarity index 100% rename from docs/en_US/images/create_procedure_security.png rename to docs/en_US/images/procedure_security.png diff --git a/docs/en_US/images/create_procedure_sql.png b/docs/en_US/images/procedure_sql.png similarity index 100% rename from docs/en_US/images/create_procedure_sql.png rename to docs/en_US/images/procedure_sql.png diff --git a/docs/en_US/images/create_procedure_sql_example.png b/docs/en_US/images/procedure_sql_example.png similarity index 100% rename from docs/en_US/images/create_procedure_sql_example.png rename to docs/en_US/images/procedure_sql_example.png diff --git a/docs/en_US/images/create_resource_group_general.png b/docs/en_US/images/resource_group_general.png similarity index 100% rename from docs/en_US/images/create_resource_group_general.png rename to docs/en_US/images/resource_group_general.png diff --git a/docs/en_US/images/create_resource_group_sql.png b/docs/en_US/images/resource_group_sql.png similarity index 100% rename from docs/en_US/images/create_resource_group_sql.png rename to docs/en_US/images/resource_group_sql.png diff --git a/docs/en_US/images/create_resource_group_sql_example.png b/docs/en_US/images/resource_group_sql_example.png similarity index 100% rename from docs/en_US/images/create_resource_group_sql_example.png rename to docs/en_US/images/resource_group_sql_example.png diff --git a/docs/en_US/images/create_role_definition.png b/docs/en_US/images/role_definition.png similarity index 100% rename from docs/en_US/images/create_role_definition.png rename to docs/en_US/images/role_definition.png diff --git a/docs/en_US/images/create_role_general.png b/docs/en_US/images/role_general.png similarity index 100% rename from docs/en_US/images/create_role_general.png rename to docs/en_US/images/role_general.png diff --git a/docs/en_US/images/create_role_parameters.png b/docs/en_US/images/role_parameters.png similarity index 100% rename from docs/en_US/images/create_role_parameters.png rename to docs/en_US/images/role_parameters.png diff --git a/docs/en_US/images/create_role_privileges.png b/docs/en_US/images/role_privileges.png similarity index 100% rename from docs/en_US/images/create_role_privileges.png rename to docs/en_US/images/role_privileges.png diff --git a/docs/en_US/images/create_role_security.png b/docs/en_US/images/role_security.png similarity index 100% rename from docs/en_US/images/create_role_security.png rename to docs/en_US/images/role_security.png diff --git a/docs/en_US/images/create_role_sql.png b/docs/en_US/images/role_sql.png similarity index 100% rename from docs/en_US/images/create_role_sql.png rename to docs/en_US/images/role_sql.png diff --git a/docs/en_US/images/create_role_sql_example.png b/docs/en_US/images/role_sql_example.png similarity index 100% rename from docs/en_US/images/create_role_sql_example.png rename to docs/en_US/images/role_sql_example.png diff --git a/docs/en_US/images/create_schema_general.png b/docs/en_US/images/schema_general.png similarity index 100% rename from docs/en_US/images/create_schema_general.png rename to docs/en_US/images/schema_general.png diff --git a/docs/en_US/images/create_schema_security.png b/docs/en_US/images/schema_security.png similarity index 100% rename from docs/en_US/images/create_schema_security.png rename to docs/en_US/images/schema_security.png diff --git a/docs/en_US/images/create_schema_sql.png b/docs/en_US/images/schema_sql.png similarity index 100% rename from docs/en_US/images/create_schema_sql.png rename to docs/en_US/images/schema_sql.png diff --git a/docs/en_US/images/create_schema_sql_example.png b/docs/en_US/images/schema_sql_example.png similarity index 100% rename from docs/en_US/images/create_schema_sql_example.png rename to docs/en_US/images/schema_sql_example.png diff --git a/docs/en_US/images/create_sequence_definition.png b/docs/en_US/images/sequence_definition.png similarity index 100% rename from docs/en_US/images/create_sequence_definition.png rename to docs/en_US/images/sequence_definition.png diff --git a/docs/en_US/images/create_sequence_general.png b/docs/en_US/images/sequence_general.png similarity index 100% rename from docs/en_US/images/create_sequence_general.png rename to docs/en_US/images/sequence_general.png diff --git a/docs/en_US/images/create_sequence_security.png b/docs/en_US/images/sequence_security.png similarity index 100% rename from docs/en_US/images/create_sequence_security.png rename to docs/en_US/images/sequence_security.png diff --git a/docs/en_US/images/create_sequence_sql.png b/docs/en_US/images/sequence_sql.png similarity index 100% rename from docs/en_US/images/create_sequence_sql.png rename to docs/en_US/images/sequence_sql.png diff --git a/docs/en_US/images/create_sequence_sql_example.png b/docs/en_US/images/sequence_sql_example.png similarity index 100% rename from docs/en_US/images/create_sequence_sql_example.png rename to docs/en_US/images/sequence_sql_example.png diff --git a/docs/en_US/images/create_server_connection.png b/docs/en_US/images/server_connection.png similarity index 100% rename from docs/en_US/images/create_server_connection.png rename to docs/en_US/images/server_connection.png diff --git a/docs/en_US/images/create_server_general.png b/docs/en_US/images/server_general.png similarity index 100% rename from docs/en_US/images/create_server_general.png rename to docs/en_US/images/server_general.png diff --git a/docs/en_US/images/create_server_group.png b/docs/en_US/images/server_group.png similarity index 100% rename from docs/en_US/images/create_server_group.png rename to docs/en_US/images/server_group.png diff --git a/docs/en_US/images/create_tablespace_definition.png b/docs/en_US/images/tablespace_definition.png similarity index 100% rename from docs/en_US/images/create_tablespace_definition.png rename to docs/en_US/images/tablespace_definition.png diff --git a/docs/en_US/images/create_tablespace_general.png b/docs/en_US/images/tablespace_general.png similarity index 100% rename from docs/en_US/images/create_tablespace_general.png rename to docs/en_US/images/tablespace_general.png diff --git a/docs/en_US/images/create_tablespace_parameters.png b/docs/en_US/images/tablespace_parameters.png similarity index 100% rename from docs/en_US/images/create_tablespace_parameters.png rename to docs/en_US/images/tablespace_parameters.png diff --git a/docs/en_US/images/create_tablespace_security.png b/docs/en_US/images/tablespace_security.png similarity index 100% rename from docs/en_US/images/create_tablespace_security.png rename to docs/en_US/images/tablespace_security.png diff --git a/docs/en_US/images/create_tablespace_sql.png b/docs/en_US/images/tablespace_sql.png similarity index 100% rename from docs/en_US/images/create_tablespace_sql.png rename to docs/en_US/images/tablespace_sql.png diff --git a/docs/en_US/index.rst b/docs/en_US/index.rst index 4cbff703a..06604e0ad 100644 --- a/docs/en_US/index.rst +++ b/docs/en_US/index.rst @@ -1,5 +1,6 @@ +********* pgAdmin 4 -========= +********* .. image:: images/logo-right-128.png :align: right @@ -7,9 +8,9 @@ pgAdmin 4 Welcome to pgAdmin 4. pgAdmin is the leading Open Source management tool for Postgres, the world's most advanced Open Source database. pgAdmin 4 is designed to meet the needs of both novice and experienced Postgres users alike, providing a powerful graphical interface that simplifies the creation, maintenance and use of database objects. -*************** Client Features -*************** +=============== + pgAdmin 4 has a highly-customizable display that features drag-and-drop panels that you can arrange to make the best use of your desktop environment. The client features a tree control that provides an elegant overview of the managed servers, and the objects that reside on each server. Tabbed dialogs provide quick access to statistical information about each object in the tree control. Use the *Preferences* dialog to customize the content and colors of the pgAdmin display. To open the *Preferences* dialog, select *Preferences* from the *File* menu. @@ -20,55 +21,50 @@ Contents: .. toctree:: :maxdepth: 2 - - test - pgAdmin_index + + pgadmin_index using - tree_control - tabbed_browser - pgAdmin_menu_bar + browser + pgadmin_menu_bar preferences help -*************** Getting Started -*************** +=============== Before you can use the pgAdmin client to manage your Postgres installation, you must define a connection to the server. .. toctree:: :maxdepth: 1 - - create_server_group - create_server + + server_group_dialog + server_dialog connecting error_messages - -****************************** + Creating Cluster Level Objects -****************************** +============================== Some object definitions reside at the cluster level: - *Resource Groups - *Roles - *Tablespaces - *Databases +* Resource Groups +* Roles +* Tablespaces +* Databases pgAdmin 4 provides dialogs that allow you to create these objects, manage them, and control their relationships to each other. To access a dialog that allows you to create a database object, right-click on the object type in the pgAdmin tree control, and select the *Create* option for that object. For example, to create a new database, right-click on the *Databases* node, and select *Create Database...* .. toctree:: :maxdepth: 2 - create_database - create_resource_group - create_role - create_tablespace + database_dialog + resource_group_dialog + role_dialog + tablespace_dialog -************************* Creating Database Objects -************************* +========================= pgAdmin 4 provides simple but powerful dialogs that you can use to design and create database objects. Each dialog contains a series of tabs that you use to describe the object that will be created by the dialog; the SQL tab displays the SQL command that the server will execute when creating the object. @@ -77,26 +73,21 @@ To access a dialog that allows you to create a database object, right-click on t .. toctree:: :maxdepth: 2 - create_cast - create_event_trigger - create_extension - create_fdw - create_schema - create_collation - create_domain - create_domain_constraint - fts_dictionary - fts_parser - fts_template - create_function - create_procedure - create_sequence - create_type - - -***************************** + cast_dialog + collation_dialog + domain_constraint_dialog + event_trigger_dialog + extension_dialog + foreign_data_wrapper_dialog + fts_parser_dialog + fts_template_dialog + function_dialog + procedure_dialog + schema_dialog + sequence_dialog + Creating or Modifying a Table -***************************** +============================= pgAdmin 4 provides dialogs that allow you to modify all table properties and attributes. @@ -105,17 +96,16 @@ To access a dialog that allows you to create a database object, right-click on t .. toctree:: :maxdepth: 2 - create_table - create_column - create_constraint - create_index - create_rule - create_trigger + table_dialog + column_dialog + constraint_dialog + index_dialog + rule_dialog + trigger_dialog -***************** Management Basics -***************** +================= pgAdmin provides a graphical interface that you can use to manage security issues related to your Postgres servers. Point and click dialogs allow you to create login or group roles, administer object privileges, and control access to the server. @@ -132,11 +122,10 @@ To modify the postgresql.conf or pg_hba.conf file, you must have sufficient priv managing_server configuration_editor - maintenance "(vacuum, etc)" + maintenance -****************** Backup and Restore -****************** +================== A powerful, but user-friendly Backup and Restore tool provides an easy way to use pg_dump, pg_dumpall, and pg_restore to take backups and create copies of databases or database objects for use in a development environment. @@ -147,9 +136,8 @@ A powerful, but user-friendly Backup and Restore tool provides an easy way to us restore -*************** Developer Tools -*************** +=============== The pgAdmin *Tools* menu displays a list of powerful developer tools that you can use to execute and analyze complex SQL commands, manage data, and debug PL/SQL code. @@ -161,23 +149,21 @@ The pgAdmin *Tools* menu displays a list of powerful developer tools that you ca data_filter debugger - -****************** + pgAdmin Deployment -****************** +================== Pre-compiled and configured installation packages for pgAdmin 4 are available for a number of desktop environments; we recommend using an installer whenever possible. If you are interested in learning more about the project, or if a pgAdmin installer is not available for your environment, the pages listed below will provide detailed information about creating a custom deployment. .. toctree:: :maxdepth: 2 - desktop-deployment - server-deployment + desktop_deployment + server_deployment -***************************** pgAdmin Project Contributions -***************************** +============================= pgAdmin is an open-source project that invites you to get involved in the development process. For more information about contributing to the pgAdmin project, contact the developers on the pgAdmin mailing list to discuss any ideas you might have for enhancements or bug fixes. @@ -188,16 +174,16 @@ Contents: .. toctree:: :maxdepth: 2 - submitting-patches - code-overview - coding-standards - code-review - + submitting_patches + code_overview + coding_standards + code_snippets + code_review + translations -******* Licence -******* +======= pgAdmin is released under the `PostgreSQL Licence `_, which is a diff --git a/docs/en_US/object-dialogs.rst b/docs/en_US/object-dialogs.rst deleted file mode 100644 index f950306a7..000000000 --- a/docs/en_US/object-dialogs.rst +++ /dev/null @@ -1,28 +0,0 @@ -Object Dialogs -============== - -Each database object type has a corresponding dialog in pgAdmin for creating and -editing objects. Please refer to the documentation pages below for information -on the usage of those dialogs. - -.. toctree:: - :maxdepth: 1 - - create_cast - create_collation - create_database - create_domain_constraint - create_event_trigger - create_extension - create_fdw - create_fts_parser - create_fts_template - create_function - create_procedure - create_resource_group - create_role - create_schema - create_sequence - create_server - create_server_group - create_tablespace \ No newline at end of file diff --git a/docs/en_US/create_procedure.rst b/docs/en_US/procedure_dialog.rst similarity index 81% rename from docs/en_US/create_procedure.rst rename to docs/en_US/procedure_dialog.rst index e8e1175a8..e755e724e 100644 --- a/docs/en_US/create_procedure.rst +++ b/docs/en_US/procedure_dialog.rst @@ -1,16 +1,14 @@ -.. _create_procedure: - -****************** -Create - Procedure -****************** +**************** +Procedure Dialog +**************** -Use the *Create - Procedure* dialog to create a procedure; procedures are supported by EDB Postgres Advanced Server. The *Create - Procedure* dialog allows you to implement options of the CREATE PROCEDURE command; for more information about the CREATE PROCEDURE SQL command, please see the Database Compatibility for Oracle Developer's, available at: +Use the *Procedure* dialog to create a procedure; procedures are supported by EDB Postgres Advanced Server. The *Procedure* dialog allows you to implement options of the CREATE PROCEDURE command; for more information about the CREATE PROCEDURE SQL command, please see the Database Compatibility for Oracle Developer's, available at: http://www.enterprisedb.com -The *Create - Procedure* dialog organizes the development of a procedure through the following dialog tabs: *General*, *Definition*, *Options*, *Arguments*, *Parameters*, and *Security*. The *SQL* tab displays the SQL code generated by dialog selections. +The *Procedure* dialog organizes the development of a procedure through the following dialog tabs: *General*, *Definition*, *Options*, *Arguments*, *Parameters*, and *Security*. The *SQL* tab displays the SQL code generated by dialog selections. -.. image:: images/create_procedure_general.png +.. image:: images/procedure_general.png Use the fields in the *General* tab to identify a procedure: @@ -21,7 +19,7 @@ Use the fields in the *General* tab to identify a procedure: Click the *Definition* tab to continue. -.. image:: images/create_procedure_definition.png +.. image:: images/procedure_definition.png Use the fields in the *Definition* tab to define the procedure: @@ -30,7 +28,7 @@ Use the fields in the *Definition* tab to define the procedure: Click the *Options* tab to continue. -.. image:: images/create_procedure_options.png +.. image:: images/procedure_options.png Use the fields in the *Options* tab to describe or modify the behavior of the procedure: @@ -45,7 +43,7 @@ Use the fields in the *Options* tab to describe or modify the behavior of the pr Click the *Arguments* tab to continue. -.. image:: images/create_procedure_arguments.png +.. image:: images/procedure_arguments.png Use the fields in the *Arguments* tab to define an argument. Click *Add* to set parameters and values for the argument: @@ -58,7 +56,7 @@ Click *Add* to define another argument; to discard an argument, click the trash Click the *Parameters* tab to continue. -.. image:: images/create_procedure_parameters.png +.. image:: images/procedure_parameters.png Use the fields in the *Parameters* tab to specify settings that will be applied when the procedure is invoked: @@ -68,7 +66,7 @@ Use the fields in the *Parameters* tab to specify settings that will be applied Click the *Security* tab to continue. -.. image:: images/create_procedure_security.png +.. image:: images/procedure_security.png Use the *Security* tab to assign privileges and define security labels. @@ -89,9 +87,9 @@ Click *Add* to assign additional security labels; to discard a security label, c Click the *SQL* tab to continue. -.. image:: images/create_procedure_sql.png +.. image:: images/procedure_sql.png -Your entries in the *Create - Procedure* dialog generate a SQL command; you can review the command on the *SQL* pane. +Your entries in the *Procedure* dialog generate a SQL command; you can review the command on the *SQL* pane. * Click the *Info* button (i) to access online help. * Click the *Save* button to save work. @@ -101,9 +99,9 @@ Your entries in the *Create - Procedure* dialog generate a SQL command; you can Example ======= -The following is an example of the sql command generated by selections made in the *Create - Procedure* dialog: +The following is an example of the sql command generated by selections made in the *Procedure* dialog: -.. image:: images/create_procedure_sql_example.png +.. image:: images/procedure_sql_example.png The example demonstrates creating a procedure that returns a list of employees from a table named *emp*. The procedure is a SECURITY DEFINER, and will execute with the privileges of the role that defined the procedure. diff --git a/docs/en_US/query-tool.rst b/docs/en_US/query_tool.rst similarity index 69% rename from docs/en_US/query-tool.rst rename to docs/en_US/query_tool.rst index f2619c83a..4629ebf49 100644 --- a/docs/en_US/query-tool.rst +++ b/docs/en_US/query_tool.rst @@ -1,5 +1,6 @@ +********** Query Tool -========== +********** The Query Tool allows you to compose and execute arbitrary SQL statements and view the results. \ No newline at end of file diff --git a/docs/en_US/resource_group_dialog.rst b/docs/en_US/resource_group_dialog.rst new file mode 100644 index 000000000..70b23dba0 --- /dev/null +++ b/docs/en_US/resource_group_dialog.rst @@ -0,0 +1,37 @@ +********************* +Resource Group Dialog +********************* + +Use the *Resource Group* dialog to create a resource group and set values for the groups resources. A resource group is a named, global group on which various resource usage limits can be defined. The resource group is accessible from all databases in the cluster. To use the *Resource Group dialog*, you must have superuser privileges. Please note that resource groups are supported when connected to EDB Postgres Advanced Server; for more information about using resource groups, please see the EDB Postgres Advanced Server Guide, available at: + + http://www.enterprisedb.com/ + +The *Resource Group* dialog organizes the development of a resource group through the *General* dialog tab. The *SQL* tab displays the SQL code generated by dialog selections. + +.. image:: images/resource_group_general.png + +Use the fields in the *General* tab to specify resource group parameters: + +* Use the *Group Name* field to add a descriptive name for the resource group. This name will be displayed in the *pgAdmin* tree control. +* Use the *CPU Rate Limit (%)* field to set the value of the CPU rate limit resource type assigned to the resource group. The valid range for a CPU rate limit is from 0 to 1.67772e+07. The default value is 0. +* Use the *Dirty Rate Limit (KB)* field to set the value of the dirty rate limit resource type assigned to the resource group. The valid range for a dirty rate limit is from 0 to 1.67772e+07. The default value is 0. + +Click the *SQL* tab to continue. + +.. image:: images/resource_group_sql.png + +Your entries in the *Resource Group* dialog generate a SQL command; you can review the command on the *SQL* pane. + +* Click the *Info* button (i) to access online help. +* Click the *Save* button to save work. +* Click the *Cancel* button to exit without saving work. +* Click the *Reset* button to restore configuration parameters. + +Example +======= + +The following is an example of the sql command generated by selections made in the *Resource Group dialog*: + +.. image:: images/resource_group_sql_example.png + +The example creates a resource group named *acctg* that sets *cpu_rate_limit* to *2*, and *dirty_rate_limit* to *6144*. \ No newline at end of file diff --git a/docs/en_US/create_role.rst b/docs/en_US/role_dialog.rst similarity index 85% rename from docs/en_US/create_role.rst rename to docs/en_US/role_dialog.rst index e9c87a1c7..0616333d2 100644 --- a/docs/en_US/create_role.rst +++ b/docs/en_US/role_dialog.rst @@ -1,16 +1,14 @@ -.. _create_role: - -************************* -Create - Login/Group Role -************************* +*********** +Role Dialog +*********** A role may be an individual user (with or without login privileges) or a group of users. Note that roles defined at the cluster level are shared by all databases in the cluster. For more information about creating roles, please see the PostgreSQL core documentation available at: http://www.postgresql.org/docs/9.5/static/sql-createrole.html -The dialog *Create - Login/Group Role* organizes the creation of roles through the following dialog tabs: *General*, *Definition*, *Role Privileges*, *Parameters*, and *Security*. The *SQL* tab displays the SQL code generated by dialog selections. +The *Role* dialog organizes the creation of roles through the following dialog tabs: *General*, *Definition*, *Role Privileges*, *Parameters*, and *Security*. The *SQL* tab displays the SQL code generated by dialog selections. -.. image:: images/create_role_general.png +.. image:: images/role_general.png Use the fields in the *General* tab to identify the role. @@ -19,7 +17,7 @@ Use the fields in the *General* tab to identify the role. Click the *Definition* tab to continue. -.. image:: images/create_role_definition.png +.. image:: images/role_definition.png Use the *Definition* tab to set a password and configure connection rules: @@ -29,7 +27,7 @@ Use the *Definition* tab to set a password and configure connection rules: Click the *Role Privileges* tab to continue. -.. image:: images/create_role_privileges.png +.. image:: images/role_privileges.png Use the *Role Privileges* tab to grant privileges to the role. @@ -44,7 +42,7 @@ Use the *Role Privileges* tab to grant privileges to the role. Click the *Parameters* tab to continue. -.. image:: images/create_role_parameters.png +.. image:: images/role_parameters.png Use the fields on the *Parameters* tab to set session defaults for a selected configuration parameter when the user is connected to a specified database. This tab invokes the ALTER ROLE... SET configuration_parameter syntax. @@ -57,7 +55,7 @@ Click *Add* to specify each additional parameter; to discard a parameter, click Click the *Security* tab to continue. -.. image:: images/create_role_security.png +.. image:: images/role_security.png Use the *Security* tab to define security labels applied to the role. Click *Add* to add each security label selection. @@ -72,9 +70,9 @@ For more information about using security labels, please see the PostgreSQL Core Click the *SQL* tab to continue. -.. image:: images/create_role_sql.png +.. image:: images/role_sql.png -Your entries in the *Create - Login/Group Role* dialog generate a SQL command; you can review the command on the *SQL* pane. +Your entries in the *Role* dialog generate a SQL command; you can review the command on the *SQL* pane. * Click the *Info* button (i) to access online help. * Click the *Save* button to save work. @@ -84,9 +82,9 @@ Your entries in the *Create - Login/Group Role* dialog generate a SQL command; y Example ======= -The following is an example of the sql command generated by user selections in the *Create - Login/Group Role* dialog: +The following is an example of the sql command generated by user selections in the *Role dialog*: -.. image:: images/create_role_sql_example.png +.. image:: images/role_sql_example.png The example creates a login role named *alice*; the role is limited to 3 connections to the server at any given time. When EDB auditing is enabled, any transactions written to the audit log by alice will include a tag that states *acctg - payroll*. diff --git a/docs/en_US/create_schema.rst b/docs/en_US/schema_dialog.rst similarity index 67% rename from docs/en_US/create_schema.rst rename to docs/en_US/schema_dialog.rst index ccd6475af..6b9fc2474 100644 --- a/docs/en_US/create_schema.rst +++ b/docs/en_US/schema_dialog.rst @@ -1,18 +1,16 @@ -.. _create_schema: +************* +Schema Dialog +************* -*************** -Create - Schema -*************** +Use the *Schema* dialog to define a schema. A schema is the organizational workhorse of a database, similar to directories or namespaces. To create a schema, you must be a database superuser or have the CREATE privilege. -Use the *Create - Schema* dialog to define a schema. A schema is the organizational workhorse of a database, similar to directories or namespaces. To create a schema, you must be a database superuser or have the CREATE privilege. - -The *Create - Schema* dialog allows you to implement options of the CREATE SCHEMA command. For more information about the CREATE SCHEMA command, please see: +The *Schema* dialog allows you to implement options of the CREATE SCHEMA command. For more information about the CREATE SCHEMA command, please see: http://www.postgresql.org/docs/current/static/sql-createschema.html - The *Create - Schema* dialog organizes the development of schema through the following dialog tabs: *General* and *Security*. The *SQL* tab displays the SQL code generated by dialog selections. + The *Schema* dialog organizes the development of schema through the following dialog tabs: *General* and *Security*. The *SQL* tab displays the SQL code generated by dialog selections. -.. image:: images/create_schema_general.png +.. image:: images/schema_general.png Use the fields on the *General* tab to identify the schema. @@ -22,7 +20,7 @@ Use the fields on the *General* tab to identify the schema. Click the *Security* tab to continue. -.. image:: images/create_schema_security.png +.. image:: images/schema_security.png Use the *Security* tab to assign privileges and security labels for the schema. @@ -43,9 +41,9 @@ To discard a security label, click the trash icon to the left of the row and con Click the *SQL* tab to continue. -.. image:: images/create_schema_sql.png +.. image:: images/schema_sql.png -Your entries in the *Create - Schema* dialog generate a SQL command; you can review the command on the *SQL* pane. +Your entries in the *Schema* dialog generate a SQL command; you can review the command on the *SQL* pane. * Click the *Info* button (i) to access online help. * Click the *Save* button to save work. @@ -55,9 +53,9 @@ Your entries in the *Create - Schema* dialog generate a SQL command; you can rev Example ======= -The following is an example of the sql command generated by selections made in the *Create - Schema* dialog: +The following is an example of the sql command generated by selections made in the *Schema dialog*: -.. image:: images/create_extension_sql_example.png +.. image:: images/schema_sql_example.png The example creates a schema named hr; the command grants *USAGE* privileges to *public*. diff --git a/docs/en_US/create_sequence.rst b/docs/en_US/sequence_dialog.rst similarity index 79% rename from docs/en_US/create_sequence.rst rename to docs/en_US/sequence_dialog.rst index 5024d451e..9b69b4561 100644 --- a/docs/en_US/create_sequence.rst +++ b/docs/en_US/sequence_dialog.rst @@ -1,18 +1,16 @@ -.. _create_sequence: +*************** +Sequence Dialog +*************** -***************** -Create - Sequence -***************** +Use the *Sequence* dialog to create a sequence. A sequence generates unique values in a sequential order (not necessarily contiguous). -Use the *Create - Sequence* dialog to create a sequence. A sequence generates unique values in a sequential order (not necessarily contiguous). - -The *Create - Sequence* dialog allows you to implement options of the CREATE SEQUENCE command. For more information about the CREATE SEQUENCE command, see the PostgreSQL core documentation available at: +The *Sequence* dialog allows you to implement options of the CREATE SEQUENCE command. For more information about the CREATE SEQUENCE command, see the PostgreSQL core documentation available at: http://www.postgresql.org/docs/9.5/static/sql-createsequence.html -The *Create - Sequence* dialog organizes the development of a sequence through the following dialog tabs: *General*, *Definition*, and *Security*. The *SQL* tab displays the SQL code generated by dialog selections. +The *Sequence* dialog organizes the development of a sequence through the following dialog tabs: *General*, *Definition*, and *Security*. The *SQL* tab displays the SQL code generated by dialog selections. -.. image:: images/create_sequence_general.png +.. image:: images/sequence_general.png :align: center Use the fields in the *General* tab to identify a sequence: @@ -24,7 +22,7 @@ Use the fields in the *General* tab to identify a sequence: Click the *Definition* tab to continue. -.. image:: images/create_sequence_definition.png +.. image:: images/sequence_definition.png :align: center Use the fields in the *Definition* tab to define the sequence: @@ -38,7 +36,7 @@ Use the fields in the *Definition* tab to define the sequence: Click the *Security* tab to continue. -.. image:: images/create_sequence_security.png +.. image:: images/sequence_security.png :align: center Use the *Security* tab to assign privileges and define security labels. @@ -61,10 +59,10 @@ Click *Add* to assign additional security labels; to discard a security label, c Click the *SQL* tab to continue. -.. image:: images/create_sequence_sql.png +.. image:: images/sequence_sql.png :align: center -Your entries in the *Create - Sequence* dialog generate a generate a SQL command; you can review the command on the *SQL* pane. +Your entries in the *Sequence* dialog generate a generate a SQL command; you can review the command on the *SQL* pane. * Click the *Info* button (i) to access online help. * Click the *Save* button to save work. @@ -74,9 +72,9 @@ Your entries in the *Create - Sequence* dialog generate a generate a SQL command Example ======= -The following is an example of the sql command generated by user selections in the *Create - Database* dialog: +The following is an example of the sql command generated by user selections in the *Database dialog*: -.. image:: images/create_sequence_sql_example.png +.. image:: images/sequence_sql_example.png The example shown demonstrates a sequence named *seconds*. It will increment by *5* with a start value equal to *0* (cached) and a maximum value equal to *60*. diff --git a/docs/en_US/server-deployment.rst b/docs/en_US/server_deployment.rst similarity index 98% rename from docs/en_US/server-deployment.rst rename to docs/en_US/server_deployment.rst index eba28cc51..d47eb84a4 100644 --- a/docs/en_US/server-deployment.rst +++ b/docs/en_US/server_deployment.rst @@ -1,5 +1,6 @@ +***************** Server Deployment -================= +***************** pgAdmin may be deployed as a web application by configuring the app to run in server mode and then deploying it either behind a webserver running as a reverse diff --git a/docs/en_US/create_server.rst b/docs/en_US/server_dialog.rst similarity index 78% rename from docs/en_US/create_server.rst rename to docs/en_US/server_dialog.rst index 07532fb62..2c0ee1369 100644 --- a/docs/en_US/create_server.rst +++ b/docs/en_US/server_dialog.rst @@ -1,14 +1,12 @@ -.. _create_server: +************* +Server Dialog +************* -*************** -Create - Server -*************** +Use the *Server* dialog to describe a connection to a server. Note: you must ensure the pg_hba.conf file of the server from which you are connecting allows connections from the host of the client. -Use the *Create - Server* dialog to describe a connection to a server. Note: you must ensure the pg_hba.conf file of the server from which you are connecting allows connections from the host of the client. +The *Server* dialog organizes the connection of a server through the following dialog tabs: *General*, and *Connection*. -The *Create - Server* dialog organizes the connection of a server through the following dialog tabs: *General*, and *Connection*. - -.. image:: images/create_server_general.png +.. image:: images/server_general.png Use the fields in the *General* tab to identify the server: @@ -17,7 +15,7 @@ Use the fields in the *General* tab to identify the server: Click the *Connection* tab to continue. -.. image:: images/create_server_connection.png +.. image:: images/server_connection.png Use the fields in the *Connection* tab to configure a connection: diff --git a/docs/en_US/server_group_dialog.rst b/docs/en_US/server_group_dialog.rst new file mode 100644 index 000000000..d8757c4c0 --- /dev/null +++ b/docs/en_US/server_group_dialog.rst @@ -0,0 +1,17 @@ +******************* +Server Group Dialog +******************* + +Use the *Server Group* dialog to add a new server group. Assign servers to server groups to simplify management of multiple servers. Server groups are displayed as part of the client tree control. + +.. image:: images/server_group.png + +Use the *Name* field on the *Server Group* dialog to specify a name that will identify the server group in the pgAdmin tree control. + +* Click the *Info* button (i) to access online help. +* Click the *Save* button to save work. +* Click the *Cancel* button to exit without saving work. +* Click the *Reset* button to restore configuration parameters. + +To create server connections in a server group, right click on the named server group and select the *Create* option to open the *Server dialog*. + diff --git a/docs/en_US/submitting-patches.rst b/docs/en_US/submitting_patches.rst similarity index 96% rename from docs/en_US/submitting-patches.rst rename to docs/en_US/submitting_patches.rst index 4cd533170..de1c129e1 100644 --- a/docs/en_US/submitting-patches.rst +++ b/docs/en_US/submitting_patches.rst @@ -1,5 +1,6 @@ +****************** Submitting Patches -================== +****************** Before developing a patch for pgAdmin you should always contact the developers on the `mailing list ` to discuss your diff --git a/docs/en_US/create_tablespace.rst b/docs/en_US/tablespace_dialog.rst similarity index 76% rename from docs/en_US/create_tablespace.rst rename to docs/en_US/tablespace_dialog.rst index 15456f3ec..e02281cac 100644 --- a/docs/en_US/create_tablespace.rst +++ b/docs/en_US/tablespace_dialog.rst @@ -1,18 +1,16 @@ -.. _create_tablespace: - -******************* -Create - Tablespace -******************* +***************** +Tablespace Dialog +***************** A tablespace allows superusers to define an alternative location on the file system where the data files containing database objects (such as tables and indexes) reside. Tablespaces are only supported on systems that support symbolic links. Note that a tablespace cannot be used independently of the cluster in which it is defined. -The *Create - Tablespace* dialog allows you to implement options of the CREATE TABLESPACE command. For more information about the CREATE TABLESPACE command, please see: +The *Tablespace* dialog allows you to implement options of the CREATE TABLESPACE command. For more information about the CREATE TABLESPACE command, please see: http://www.postgresql.org/docs/9.5/static/sql-createtablespace.html -The *Create - Tablespace* dialog organizes the definition of a tablespace through the following tabs: *General*, *Definition*, *Parameters*, and *Security*. The *SQL* tab displays the SQL code generated by dialog selections. +The *Tablespace* dialog organizes the definition of a tablespace through the following tabs: *General*, *Definition*, *Parameters*, and *Security*. The *SQL* tab displays the SQL code generated by dialog selections. -.. image:: images/create_tablespace_general.png +.. image:: images/tablespace_general.png * Use the *Name* field to identify the tablespace with a descriptive name. The name cannot begin with pg\_; these names are reserved for system tablespaces. * Select the owner of the tablespace from the drop-down listbox in the *Owner* field. @@ -20,13 +18,13 @@ The *Create - Tablespace* dialog organizes the definition of a tablespace throug Click the *Definition* tab to continue. -.. image:: images/create_tablespace_definition.png +.. image:: images/tablespace_definition.png * Use the *Location* field to specify an absolute path to a directory that will contain the tablespace. Click the *Parameters* tab to continue. -.. image:: images/create_tablespace_parameters.png +.. image:: images/tablespace_parameters.png Use the *Parameters* tab to set parameters for the tablespace: @@ -38,7 +36,7 @@ Click *Add* to specify each additional parameter; to discard a parameter, click Click the *Security* tab to continue. -.. image:: images/create_tablespace_security.png +.. image:: images/tablespace_security.png Use the *Security* tab to assign privileges and define security labels. @@ -59,9 +57,9 @@ To discard a security label, click the trash icon to the left of the row and con Click the *SQL* tab to continue. -.. image:: images/create_tablespace_sql.png +.. image:: images/tablespace_sql.png -Your entries in the *Create - Tablespace* dialog generate a SQL command; you can review the command on the *SQL* pane. +Your entries in the *Tablespace* dialog generate a SQL command; you can review the command on the *SQL* pane. * Click the *Info* button (i) to access online help. * Click the *Save* button to save work. @@ -71,7 +69,7 @@ Your entries in the *Create - Tablespace* dialog generate a SQL command; you can Example ======= -The following is an example of the sql command generated by user selections in the *Create - Tablespace* dialog: +The following is an example of the sql command generated by user selections in the *Tablespace dialog*: -.. image:: images/create_tablespace_sql_example.png +.. image:: images/tablespace_sql_example.png diff --git a/docs/en_US/translations.rst b/docs/en_US/translations.rst index f3f4faede..523278aee 100644 --- a/docs/en_US/translations.rst +++ b/docs/en_US/translations.rst @@ -1,5 +1,6 @@ +************ Translations -============ +************ pgAdmin supports multiple languages using the `Flask-Babel `_ Python module. A list of supported @@ -7,7 +8,7 @@ languages is included in the **web/config.py** configuration file and must be updated whenever langauges are added or removed. Translation Marking -------------------- +=================== Strings can be marked for translation in either Python code (using **gettext()**) or Jinja templates (using **_()**). Here are some examples that show how this @@ -37,7 +38,7 @@ Jinja: ) Updating and Merging --------------------- +==================== Whenever new strings are added to the application, the template catalogues (**web/pgadmin/messages.pot**) must be updated and the existing catalogues @@ -112,7 +113,7 @@ Finally, the message catalogues can be compiled for use: compiling catalog 'pgadmin/translations/fr/LC_MESSAGES/messages.po' to 'pgadmin/translations/fr/LC_MESSAGES/messages.mo' Adding a new Language ---------------------- +===================== Adding a new language is simple. First, add the language name and identifier to **web/config.py**:: diff --git a/web/pgadmin/browser/server_groups/servers/databases/casts/templates/cast/js/casts.js b/web/pgadmin/browser/server_groups/servers/databases/casts/templates/cast/js/casts.js index 290b9cf07..fb53135e9 100644 --- a/web/pgadmin/browser/server_groups/servers/databases/casts/templates/cast/js/casts.js +++ b/web/pgadmin/browser/server_groups/servers/databases/casts/templates/cast/js/casts.js @@ -20,7 +20,7 @@ function($, _, S, pgAdmin, pgBrowser, alertify) { type: 'cast', sqlAlterHelp: 'sql-altercast.html', sqlCreateHelp: 'sql-createcast.html', - dialogHelp: '{{ url_for('help.static', filename='create_cast.html') }}', + dialogHelp: '{{ url_for('help.static', filename='cast_dialog.html') }}', canDrop: true, canDropCascade: true, label: '{{ _('Cast') }}', diff --git a/web/pgadmin/browser/server_groups/servers/databases/event_triggers/templates/event_triggers/js/event_trigger.js b/web/pgadmin/browser/server_groups/servers/databases/event_triggers/templates/event_triggers/js/event_trigger.js index 823750320..195a292da 100644 --- a/web/pgadmin/browser/server_groups/servers/databases/event_triggers/templates/event_triggers/js/event_trigger.js +++ b/web/pgadmin/browser/server_groups/servers/databases/event_triggers/templates/event_triggers/js/event_trigger.js @@ -49,7 +49,7 @@ function($, _, S, pgAdmin, pgBrowser, alertify) { type: 'event_trigger', sqlAlterHelp: 'sql-altereventtrigger.html', sqlCreateHelp: 'sql-createeventtrigger.html', - dialogHelp: '{{ url_for('help.static', filename='create_event_trigger.html') }}', + dialogHelp: '{{ url_for('help.static', filename='event_trigger_dialog.html') }}', label: '{{ _('Event Trigger') }}', hasSQL: true, hasDepends: true, diff --git a/web/pgadmin/browser/server_groups/servers/databases/extensions/templates/extensions/js/extensions.js b/web/pgadmin/browser/server_groups/servers/databases/extensions/templates/extensions/js/extensions.js index a667f152a..7ac302acb 100644 --- a/web/pgadmin/browser/server_groups/servers/databases/extensions/templates/extensions/js/extensions.js +++ b/web/pgadmin/browser/server_groups/servers/databases/extensions/templates/extensions/js/extensions.js @@ -40,7 +40,7 @@ function($, _, S, pgAdmin, pgBrowser) { type: 'extension', sqlAlterHelp: 'sql-alterextension.html', sqlCreateHelp: 'sql-createextension.html', - dialogHelp: '{{ url_for('help.static', filename='create_extension.html') }}', + dialogHelp: '{{ url_for('help.static', filename='extension_dialog.html') }}', hasSQL: true, hasDepends: true, canDrop: true, diff --git a/web/pgadmin/browser/server_groups/servers/databases/foreign_data_wrappers/templates/foreign_data_wrappers/js/foreign_data_wrappers.js b/web/pgadmin/browser/server_groups/servers/databases/foreign_data_wrappers/templates/foreign_data_wrappers/js/foreign_data_wrappers.js index 31b6b0aba..69036f93a 100644 --- a/web/pgadmin/browser/server_groups/servers/databases/foreign_data_wrappers/templates/foreign_data_wrappers/js/foreign_data_wrappers.js +++ b/web/pgadmin/browser/server_groups/servers/databases/foreign_data_wrappers/templates/foreign_data_wrappers/js/foreign_data_wrappers.js @@ -54,7 +54,7 @@ function($, _, S, pgAdmin, pgBrowser, alertify) { type: 'foreign_data_wrapper', sqlAlterHelp: 'sql-alterforeigndatawrapper.html', sqlCreateHelp: 'sql-createforeigndatawrapper.html', - dialogHelp: '{{ url_for('help.static', filename='create_fdw.html') }}', + dialogHelp: '{{ url_for('help.static', filename='foreign_data_wrapper_dialog.html') }}', label: '{{ _('Foreign Data Wrapper') }}', hasSQL: true, hasDepends: true, diff --git a/web/pgadmin/browser/server_groups/servers/databases/schemas/collations/templates/collation/js/collation.js b/web/pgadmin/browser/server_groups/servers/databases/schemas/collations/templates/collation/js/collation.js index a6bdc3025..eb12f4041 100644 --- a/web/pgadmin/browser/server_groups/servers/databases/schemas/collations/templates/collation/js/collation.js +++ b/web/pgadmin/browser/server_groups/servers/databases/schemas/collations/templates/collation/js/collation.js @@ -17,7 +17,7 @@ function($, _, S, pgAdmin, pgBrowser, alertify) { type: 'collation', sqlAlterHelp: 'sql-altercollation.html', sqlCreateHelp: 'sql-createcollation.html', - dialogHelp: '{{ url_for('help.static', filename='create_collation.html') }}', + dialogHelp: '{{ url_for('help.static', filename='collation_dialog.html') }}', label: '{{ _('Collation') }}', collection_type: 'coll-collation', hasSQL: true, diff --git a/web/pgadmin/browser/server_groups/servers/databases/schemas/domains/domain-constraints/templates/domain-constraints/js/domain-constraints.js b/web/pgadmin/browser/server_groups/servers/databases/schemas/domains/domain-constraints/templates/domain-constraints/js/domain-constraints.js index db215c43f..5bde04469 100644 --- a/web/pgadmin/browser/server_groups/servers/databases/schemas/domains/domain-constraints/templates/domain-constraints/js/domain-constraints.js +++ b/web/pgadmin/browser/server_groups/servers/databases/schemas/domains/domain-constraints/templates/domain-constraints/js/domain-constraints.js @@ -20,7 +20,7 @@ function($, _, S, pgAdmin, pgBrowser, alertify) { type: 'domain-constraints', sqlAlterHelp: 'sql-alterdomain.html', sqlCreateHelp: 'sql-alterdomain.html', - dialogHelp: '{{ url_for('help.static', filename='create_domain_constraint.html') }}', + dialogHelp: '{{ url_for('help.static', filename='domain_constraint_dialog.html') }}', label: '{{ _('Domain Constraints') }}', collection_type: 'coll-domain-constraints', hasSQL: true, diff --git a/web/pgadmin/browser/server_groups/servers/databases/schemas/fts_parser/templates/fts_parser/js/fts_parser.js b/web/pgadmin/browser/server_groups/servers/databases/schemas/fts_parser/templates/fts_parser/js/fts_parser.js index 22efec37d..fa541e38b 100644 --- a/web/pgadmin/browser/server_groups/servers/databases/schemas/fts_parser/templates/fts_parser/js/fts_parser.js +++ b/web/pgadmin/browser/server_groups/servers/databases/schemas/fts_parser/templates/fts_parser/js/fts_parser.js @@ -21,7 +21,7 @@ function($, _, S, pgAdmin, pgBrowser, alertify) { type: 'fts_parser', sqlAlterHelp: 'sql-altertsparser.html', sqlCreateHelp: 'sql-createtsparser.html', - dialogHelp: '{{ url_for('help.static', filename='create_fts_parser.html') }}', + dialogHelp: '{{ url_for('help.static', filename='fts_parser_dialog.html') }}', canDrop: true, canDropCascade: true, label: '{{ _('FTS Parser') }}', diff --git a/web/pgadmin/browser/server_groups/servers/databases/schemas/fts_templates/templates/fts_template/js/fts_templates.js b/web/pgadmin/browser/server_groups/servers/databases/schemas/fts_templates/templates/fts_template/js/fts_templates.js index 7ee9d85e9..4b0e44926 100644 --- a/web/pgadmin/browser/server_groups/servers/databases/schemas/fts_templates/templates/fts_template/js/fts_templates.js +++ b/web/pgadmin/browser/server_groups/servers/databases/schemas/fts_templates/templates/fts_template/js/fts_templates.js @@ -20,7 +20,7 @@ function($, _, S, pgAdmin, pgBrowser, alertify) { type: 'fts_template', sqlAlterHelp: 'sql-altertstemplate.html', sqlCreateHelp: 'sql-createtstemplate.html', - dialogHelp: '{{ url_for('help.static', filename='create_fts_template.html') }}', + dialogHelp: '{{ url_for('help.static', filename='fts_template_dialog.html') }}', canDrop: true, canDropCascade: true, label: '{{ _('FTS Template') }}', diff --git a/web/pgadmin/browser/server_groups/servers/databases/schemas/functions/templates/function/js/functions.js b/web/pgadmin/browser/server_groups/servers/databases/schemas/functions/templates/function/js/functions.js index 8b567602c..39a7bc599 100644 --- a/web/pgadmin/browser/server_groups/servers/databases/schemas/functions/templates/function/js/functions.js +++ b/web/pgadmin/browser/server_groups/servers/databases/schemas/functions/templates/function/js/functions.js @@ -104,7 +104,7 @@ function($, _, S, pgAdmin, pgBrowser, alertify) { type: 'function', sqlAlterHelp: 'sql-alterfunction.html', sqlCreateHelp: 'sql-createfunction.html', - dialogHelp: '{{ url_for('help.static', filename='create_function.html') }}', + dialogHelp: '{{ url_for('help.static', filename='function_dialog.html') }}', label: '{{ _('Function') }}', collection_type: 'coll-function', hasSQL: true, diff --git a/web/pgadmin/browser/server_groups/servers/databases/schemas/functions/templates/procedure/js/procedures.js b/web/pgadmin/browser/server_groups/servers/databases/schemas/functions/templates/procedure/js/procedures.js index 2756721f1..d2a1beae9 100644 --- a/web/pgadmin/browser/server_groups/servers/databases/schemas/functions/templates/procedure/js/procedures.js +++ b/web/pgadmin/browser/server_groups/servers/databases/schemas/functions/templates/procedure/js/procedures.js @@ -24,7 +24,7 @@ function($, _, S, pgAdmin, pgBrowser, alertify, Function) { type: 'procedure', sqlAlterHelp: 'sql-alterprocedure.html', sqlCreateHelp: 'sql-createprocedure.html', - dialogHelp: '{{ url_for('help.static', filename='create_procedure.html') }}', + dialogHelp: '{{ url_for('help.static', filename='procedure_dialog.html') }}', label: '{{ _('Procedure') }}', collection_type: 'coll-procedure', hasSQL: true, diff --git a/web/pgadmin/browser/server_groups/servers/databases/schemas/sequences/templates/sequence/js/sequence.js b/web/pgadmin/browser/server_groups/servers/databases/schemas/sequences/templates/sequence/js/sequence.js index 2f3607946..d070f2b83 100644 --- a/web/pgadmin/browser/server_groups/servers/databases/schemas/sequences/templates/sequence/js/sequence.js +++ b/web/pgadmin/browser/server_groups/servers/databases/schemas/sequences/templates/sequence/js/sequence.js @@ -53,7 +53,7 @@ function($, _, S, pgAdmin, pgBrowser, alertify) { type: 'sequence', sqlAlterHelp: 'sql-altersequence.html', sqlCreateHelp: 'sql-createsequence.html', - dialogHelp: '{{ url_for('help.static', filename='create_sequence.html') }}', + dialogHelp: '{{ url_for('help.static', filename='sequence_dialog.html') }}', label: '{{ _('Sequence') }}', collection_type: 'coll-sequence', hasSQL: true, diff --git a/web/pgadmin/browser/server_groups/servers/databases/schemas/templates/schema/js/schema.js b/web/pgadmin/browser/server_groups/servers/databases/schemas/templates/schema/js/schema.js index 210f3e68d..2a497e309 100644 --- a/web/pgadmin/browser/server_groups/servers/databases/schemas/templates/schema/js/schema.js +++ b/web/pgadmin/browser/server_groups/servers/databases/schemas/templates/schema/js/schema.js @@ -303,7 +303,7 @@ function($, _, S, pgAdmin, pgBrowser, Backform, alertify) { type: 'schema', sqlAlterHelp: 'sql-alterschema.html', sqlCreateHelp: 'sql-createschema.html', - dialogHelp: '{{ url_for('help.static', filename='create_schema.html') }}', + dialogHelp: '{{ url_for('help.static', filename='schema_dialog.html') }}', label: '{{ _('Schema') }}', hasSQL: true, canDrop: true, diff --git a/web/pgadmin/browser/server_groups/servers/databases/templates/databases/js/databases.js b/web/pgadmin/browser/server_groups/servers/databases/templates/databases/js/databases.js index 979f416a7..5d551706a 100644 --- a/web/pgadmin/browser/server_groups/servers/databases/templates/databases/js/databases.js +++ b/web/pgadmin/browser/server_groups/servers/databases/templates/databases/js/databases.js @@ -50,7 +50,7 @@ function($, _, S, pgAdmin, pgBrowser, Alertify) { type: 'database', sqlAlterHelp: 'sql-alterdatabase.html', sqlCreateHelp: 'sql-createdatabase.html', - dialogHelp: '{{ url_for('help.static', filename='create_database.html') }}', + dialogHelp: '{{ url_for('help.static', filename='database_dialog.html') }}', hasSQL: true, hasDepends: true, hasStatistics: true, diff --git a/web/pgadmin/browser/server_groups/servers/resource_groups/templates/resource_groups/js/resource_groups.js b/web/pgadmin/browser/server_groups/servers/resource_groups/templates/resource_groups/js/resource_groups.js index 326d2f5ce..c98c41ad4 100644 --- a/web/pgadmin/browser/server_groups/servers/resource_groups/templates/resource_groups/js/resource_groups.js +++ b/web/pgadmin/browser/server_groups/servers/resource_groups/templates/resource_groups/js/resource_groups.js @@ -18,7 +18,7 @@ define( pgAdmin.Browser.Nodes['resource_group'] = pgAdmin.Browser.Node.extend({ parent_type: 'server', type: 'resource_group', - dialogHelp: '{{ url_for('help.static', filename='create_resource_group.html') }}', + dialogHelp: '{{ url_for('help.static', filename='resource_group_dialog.html') }}', label: '{{ _('Resource Group') }}', hasSQL: true, canDrop: true, diff --git a/web/pgadmin/browser/server_groups/servers/roles/templates/role/js/role.js b/web/pgadmin/browser/server_groups/servers/roles/templates/role/js/role.js index 3b355b9d8..6d5cc51d6 100644 --- a/web/pgadmin/browser/server_groups/servers/roles/templates/role/js/role.js +++ b/web/pgadmin/browser/server_groups/servers/roles/templates/role/js/role.js @@ -294,7 +294,7 @@ function($, _, S, pgAdmin, pgBrowser, alertify, Backform) { type: 'role', sqlAlterHelp: 'sql-alterrole.html', sqlCreateHelp: 'sql-createrole.html', - dialogHelp: '{{ url_for('help.static', filename='create_role.html') }}', + dialogHelp: '{{ url_for('help.static', filename='role_dialog.html') }}', label: '{{ _('Login/Group Role') }}', hasSQL: true, canDrop: true, diff --git a/web/pgadmin/browser/server_groups/servers/tablespaces/templates/tablespaces/js/tablespaces.js b/web/pgadmin/browser/server_groups/servers/tablespaces/templates/tablespaces/js/tablespaces.js index 298bcf05d..8a868d491 100644 --- a/web/pgadmin/browser/server_groups/servers/tablespaces/templates/tablespaces/js/tablespaces.js +++ b/web/pgadmin/browser/server_groups/servers/tablespaces/templates/tablespaces/js/tablespaces.js @@ -49,7 +49,7 @@ function($, _, S, pgAdmin, pgBrowser, alertify) { type: 'tablespace', sqlAlterHelp: 'sql-altertablespace.html', sqlCreateHelp: 'sql-createtablespace.html', - dialogHelp: '{{ url_for('help.static', filename='create_tablespace.html') }}', + dialogHelp: '{{ url_for('help.static', filename='tablespace_dialog.html') }}', label: '{{ _('Tablespace') }}', hasSQL: true, canDrop: true, diff --git a/web/pgadmin/browser/server_groups/servers/templates/servers/servers.js b/web/pgadmin/browser/server_groups/servers/templates/servers/servers.js index 0251437cb..33deafbc4 100644 --- a/web/pgadmin/browser/server_groups/servers/templates/servers/servers.js +++ b/web/pgadmin/browser/server_groups/servers/templates/servers/servers.js @@ -6,7 +6,7 @@ function($, _, S, pgAdmin, pgBrowser, alertify) { pgAdmin.Browser.Nodes['server'] = pgAdmin.Browser.Node.extend({ parent_type: 'server-group', type: 'server', - dialogHelp: '{{ url_for('help.static', filename='create_server.html') }}', + dialogHelp: '{{ url_for('help.static', filename='server_dialog.html') }}', label: '{{ _('Server') }}', canDrop: true, hasStatistics: true, diff --git a/web/pgadmin/browser/server_groups/templates/server_groups/server_groups.js b/web/pgadmin/browser/server_groups/templates/server_groups/server_groups.js index e8f0f4c6a..acf7ef42b 100644 --- a/web/pgadmin/browser/server_groups/templates/server_groups/server_groups.js +++ b/web/pgadmin/browser/server_groups/templates/server_groups/server_groups.js @@ -6,7 +6,7 @@ function($, _, pgAdmin, Backbone) { pgAdmin.Browser.Nodes['server-group'] = pgAdmin.Browser.Node.extend({ parent_type: null, type: 'server-group', - dialogHelp: '{{ url_for('help.static', filename='create_server_group.html') }}', + dialogHelp: '{{ url_for('help.static', filename='server_group_dialog.html') }}', label: '{{ _('Server Group') }}', Init: function() { /* Avoid multiple registration of menus */