From 981eca4d50b5ca24214725ca6236b4f0d47d23b8 Mon Sep 17 00:00:00 2001 From: "Karl O. Pinc" Date: Sat, 27 Jun 2020 17:14:15 -0500 Subject: [PATCH] Route names must match pgwui component names --- README.rst | 11 +++++------ examples/etc/pgwui.ini | 14 +++++++++++--- examples/misc/development.ini | 6 +++--- 3 files changed, 19 insertions(+), 12 deletions(-) diff --git a/README.rst b/README.rst index fd8ef98..6a95adf 100644 --- a/README.rst +++ b/README.rst @@ -243,18 +243,17 @@ default route of ``logout`` in the URL pgwui.route_prefix = /pgwui/programs -The routes of individual PGWUI components can be changed:: +The routes of individual PGWUI components are configured via each +component's name and can be changed:: pgwui.routes = # The syntax is: routename = new/route/value # Make PGWUI Logout available at https://www.example.com/logmeout - logout = /logmeout + pgwui_logout = /logmeout # Make PGWUI upload available at https://www.example.com/gimmie - upload = /gimmie + pgwui_upload = /gimmie -The route names of each of the PGWUI components is given in their -respective documentation. In general, route names correspond to -component names. +Route names must match component names. Both ``pgwui.route_prefix`` and ``pgwui.routes`` may be used in one configuration. diff --git a/examples/etc/pgwui.ini b/examples/etc/pgwui.ini index bf00341..7cb1e4a 100644 --- a/examples/etc/pgwui.ini +++ b/examples/etc/pgwui.ini @@ -41,6 +41,14 @@ pgwui.default_db = template1 # Whether or not to change the db content. (required) pgwui.dry_run = False +# Menu presentation + +# The PGWUI_Menu component automaticaly constructs a menu for the +# PGWUI components in use. The display value of the menu items can +# be overridden. +#pgwui.pgwui_upload = +# menu_label = upload -- Upload File Into Database + # Routing # Routes are what call up specific pages. They are the @@ -65,14 +73,14 @@ pgwui.dry_run = False # The syntax is "name" = "route", one per line. The "name" is the # name of the PGWUI component. "route" is the route to use to access # the component. So to access the logout page at -# http://example.com/logmeout the line would be: logout = /logmeout +# http://example.com/logmeout the line would be: pgwui_logout = /logmeout # # Overriding routes is optional. # # The default for some PGWUI components are: # pgwui.routes = -# logout = /logmeout -# upload = /put-in +# pgwui_logout = /logmeout +# pgwui_upload = /put-in # Settings validation diff --git a/examples/misc/development.ini b/examples/misc/development.ini index 2ac1cd7..e80eadc 100644 --- a/examples/misc/development.ini +++ b/examples/misc/development.ini @@ -65,14 +65,14 @@ pgwui.dry_run = False # The syntax is "name" = "route", one per line. The "name" is the # name of the PGWUI component. "route" is the route to use to access # the component. So to access the logout page at -# http://example.com/logmeout the line would be: logout = /logmeout +# http://example.com/logmeout the line would be: pgwui_logout = /logmeout # # Overriding routes is optional. # # The default for some PGWUI components are: # pgwui.routes = -# logout = /logout -# upload = /upload +# pgwui_logout = /logout +# pgwui_upload = /upload # Settings validation -- 2.34.1