From c1a6ef6f751a16b7a352bc3fdad13d4b5b73f212 Mon Sep 17 00:00:00 2001
From: Chris McDonough <chrism@agendaless.com>
Date: Tue, 22 Jul 2008 11:12:12 +0000
Subject:

---
 docs/api/urldispatch.rst | 25 +++++++++++++++++++++----
 1 file changed, 21 insertions(+), 4 deletions(-)

(limited to 'docs/api')

diff --git a/docs/api/urldispatch.rst b/docs/api/urldispatch.rst
index 81b28cebb..18edddc8a 100644
--- a/docs/api/urldispatch.rst
+++ b/docs/api/urldispatch.rst
@@ -22,9 +22,26 @@ of dispatch::
 
   <bfg:view
       for="repoze.bfg.interfaces.IURLDispatchModel"
-      view=".views.url_dispatch_view"
-      name="url_dispatch_controller"
+      view=".views.articles_view"
+      name="articles"
       />
 
-This view will be called with its context as a model with attributes
-matching the Routes routing dictionary associated with the request.
+You might then configure the ``RoutesMapper`` like so::
+
+  def fallback_get_root(environ):
+      return {} # the graph traversal root is empty in this example
+
+  get_root = RoutesMapper(fallback_get_root)
+  get_root.connect('archives/:article', controller='articles')
+
+  import myapp
+  from repoze.bfg.router import make_app
+
+  app = make_app(get_root, myapp)
+
+At this point, if any URL matches the pattern ``archives/:article``,
+the ``.views.articles_view`` view will be called with its context as a
+only-the-fly-generated-model with attributes matching the Routes
+routing dictionary associated with the request.  In particular, in
+this case the model will have an ``article`` attribute matching the
+article picked off the URL by Routes.
-- 
cgit v1.2.3