Route names must match pgwui component names
authorKarl O. Pinc <kop@karlpinc.com>
Sat, 27 Jun 2020 22:14:15 +0000 (17:14 -0500)
committerKarl O. Pinc <kop@karlpinc.com>
Sat, 27 Jun 2020 22:39:05 +0000 (17:39 -0500)
README.rst
examples/etc/pgwui.ini
examples/misc/development.ini

index fd8ef982138c5869838bcf8b800db8c50d2ad9f0..6a95adf5c564a8331deb647c215a151bd5d55622 100644 (file)
@@ -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.
index bf0034157007cc345d778d96a5f5f73f64935400..7cb1e4a9788640ed1e89d2bfad46ed67125e8a49 100644 (file)
@@ -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
 
index 2ac1cd7d1ceb0ba164ed0254ea1e88dfa13d3c33..e80eadcea5923ff42739a63f6e7a6fd770718e1b 100644 (file)
@@ -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