Document pgwui.routes in the ini files

diff --git a/examples/development.ini b/examples/development.ini
index 4500ff67a2e70bd29586c0092d004bd4a5e8fa74..dad0465b192db52451dd96f7474e12b1894b1767 100644 (file)
--- a/examples/development.ini
+++ b/examples/development.ini
@@ -51,6 +51,18 @@ pgwui.dry_run = False
 # The default is no prefix.
 # pgwui.route_prefix =
 
+# Overriding routes of specific PGWUI components
+
+# 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
+#
+# The default for some PGWUI components are:
+# pgwui_routes =
+#   logout = /logout
+#   upload = /upload
+
 
 #
 # Pyramid configuration

diff --git a/examples/pgwui.ini b/examples/pgwui.ini
index 99213bacd8f226bbe1fe6d08d3d025596d2f4d1d..fc86f63e6d9c8806c1946c14787c97e65a1c834c 100644 (file)
--- a/examples/pgwui.ini
+++ b/examples/pgwui.ini
@@ -49,6 +49,17 @@ pgwui.dry_run = False
 # The default is no prefix.
 # pgwui.route_prefix =
 
+# Overriding routes of specific PGWUI components
+
+# 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
+#
+# The default for some PGWUI components are:
+# pgwui_routes =
+#   logout = /logmeout
+#   upload = /put-in
 
 #
 # Pyramid configuration