From 3214690b08e3c495ab64170e1430ece240853110 Mon Sep 17 00:00:00 2001
From: Steve Piercy <web@stevepiercy.com>
Date: Fri, 13 Nov 2015 02:30:32 -0800
Subject: update wiki2/src/views and wiki2/definingviews.rst

---
 docs/tutorials/wiki2/definingviews.rst | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

(limited to 'docs/tutorials/wiki2/definingviews.rst')

diff --git a/docs/tutorials/wiki2/definingviews.rst b/docs/tutorials/wiki2/definingviews.rst
index 0b495445a..8a96e433c 100644
--- a/docs/tutorials/wiki2/definingviews.rst
+++ b/docs/tutorials/wiki2/definingviews.rst
@@ -14,7 +14,7 @@ and a user visits ``http://example.com/foo/bar``, our pattern would be matched
 against ``/foo/bar`` and the ``matchdict`` would look like ``{'one':'foo',
 'two':'bar'}``.
 
-Declaring Dependencies in Our ``setup.py`` File
+Declaring dependencies in our ``setup.py`` file
 ===============================================
 
 The view code in our application will depend on a package which is not a
@@ -47,7 +47,7 @@ directory in which ``setup.py`` lives) and execute the following command.
 
 On UNIX:
 
-.. code-block:: text
+.. code-block:: bash
 
    $ cd tutorial
    $ $VENV/bin/python setup.py develop
@@ -60,17 +60,17 @@ On Windows:
    c:\pyramidtut\tutorial> %VENV%\Scripts\python setup.py develop
 
 Success executing this command will end with a line to the console something
-like::
+like this::
 
    Finished processing dependencies for tutorial==0.0
 
 Adding view functions in ``views.py``
 =====================================
 
-It's time for a major change.  Open ``tutorial/tutorial/views.py`` and edit it
-to look like the following:
+It's time for a major change.  Open ``tutorial/tutorial/views/default.py`` and
+edit it to look like the following:
 
-.. literalinclude:: src/views/tutorial/views.py
+.. literalinclude:: src/views/tutorial/views/default.py
    :linenos:
    :language: python
    :emphasize-lines: 1-7,14,16-72
-- 
cgit v1.2.3


From 429529a09992554229ef7274bfc4f43394256105 Mon Sep 17 00:00:00 2001
From: Steve Piercy <web@stevepiercy.com>
Date: Fri, 13 Nov 2015 03:46:13 -0800
Subject: update wiki2/src/views and wiki2/definingviews.rst

---
 docs/tutorials/wiki2/definingviews.rst | 113 +++++++++++++++++----------------
 1 file changed, 58 insertions(+), 55 deletions(-)

(limited to 'docs/tutorials/wiki2/definingviews.rst')

diff --git a/docs/tutorials/wiki2/definingviews.rst b/docs/tutorials/wiki2/definingviews.rst
index 8a96e433c..08fa8f16b 100644
--- a/docs/tutorials/wiki2/definingviews.rst
+++ b/docs/tutorials/wiki2/definingviews.rst
@@ -64,8 +64,8 @@ like this::
 
    Finished processing dependencies for tutorial==0.0
 
-Adding view functions in ``views.py``
-=====================================
+Adding view functions in ``views/default.py``
+=============================================
 
 It's time for a major change.  Open ``tutorial/tutorial/views/default.py`` and
 edit it to look like the following:
@@ -73,18 +73,19 @@ edit it to look like the following:
 .. literalinclude:: src/views/tutorial/views/default.py
    :linenos:
    :language: python
-   :emphasize-lines: 1-7,14,16-72
+   :emphasize-lines: 1-9,12-70
 
 The highlighted lines need to be added or edited.
 
-We added some imports and created a regular expression to find "WikiWords".
+We added some imports, and created a regular expression to find "WikiWords".
 
 We got rid of the ``my_view`` view function and its decorator that was added
 when we originally rendered the ``alchemy`` scaffold.  It was only an example
-and isn't relevant to our application.
+and isn't relevant to our application.  We also delated the ``db_err_msg``
+string.
 
-Then we added four :term:`view callable` functions to our ``views.py``
-module: 
+Then we added four :term:`view callable` functions to our ``views/default.py``
+module:
 
 * ``view_wiki()`` - Displays the wiki itself. It will answer on the root URL.
 * ``view_page()`` - Displays an individual page.
@@ -95,20 +96,20 @@ We'll describe each one briefly in the following sections.
 
 .. note::
 
-  There is nothing special about the filename ``views.py``.  A project may
-  have many view callables throughout its codebase in arbitrarily named
-  files.  Files implementing view callables often have ``view`` in their
-  filenames (or may live in a Python subpackage of your application package
-  named ``views``), but this is only by convention.
+  There is nothing special about the filename ``default.py``.  A project may
+  have many view callables throughout its codebase in arbitrarily named files.
+  Files implementing view callables often have ``view`` in their filenames (or
+  may live in a Python subpackage of your application package named ``views``,
+  as in our case), but this is only by convention.
 
 The ``view_wiki`` view function
 -------------------------------
 
 Following is the code for the ``view_wiki`` view function and its decorator:
 
-.. literalinclude:: src/views/tutorial/views.py
-   :lines: 20-24
-   :lineno-start: 20
+.. literalinclude:: src/views/tutorial/views/default.py
+   :lines: 17-20
+   :lineno-start: 17
    :linenos:
    :language: python
 
@@ -130,9 +131,9 @@ The ``view_page`` view function
 
 Here is the code for the ``view_page`` view function and its decorator:
 
-.. literalinclude:: src/views/tutorial/views.py
-   :lines: 25-45
-   :lineno-start: 25
+.. literalinclude:: src/views/tutorial/views/default.py
+   :lines: 22-42
+   :lineno-start: 22
    :linenos:
    :language: python
 
@@ -158,17 +159,17 @@ template, and we return a dictionary with a number of arguments.  The fact that
 ``view_page()`` returns a dictionary (as opposed to a :term:`response` object)
 is a cue to :app:`Pyramid` that it should try to use a :term:`renderer`
 associated with the view configuration to render a response.  In our case, the
-renderer used will be the ``templates/view.pt`` template, as indicated in the
-``@view_config`` decorator that is applied to ``view_page()``.
+renderer used will be the ``templates/view.jinja2`` template, as indicated in
+the ``@view_config`` decorator that is applied to ``view_page()``.
 
 The ``add_page`` view function
 ------------------------------
 
 Here is the code for the ``add_page`` view function and its decorator:
 
-.. literalinclude:: src/views/tutorial/views.py
-   :lines: 47-58
-   :lineno-start: 47
+.. literalinclude:: src/views/tutorial/views/default.py
+   :lines: 44-55
+   :lineno-start: 44
    :linenos:
    :language: python
 
@@ -189,15 +190,15 @@ If the view execution *is* a result of a form submission (i.e., the expression
 ``'form.submitted' in request.params`` is ``True``), we grab the page body
 from the form data, create a Page object with this page body and the name
 taken from ``matchdict['pagename']``, and save it into the database using
-``DBSession.add``.  We then redirect back to the ``view_page`` view for the
-newly created page.
+``request.dbession.add``.  We then redirect back to the ``view_page`` view for
+the newly created page.
 
 If the view execution is *not* a result of a form submission (i.e., the
 expression ``'form.submitted' in request.params`` is ``False``), the view
 callable renders a template.  To do so, it generates a ``save_url`` which the
 template uses as the form post URL during rendering.  We're lazy here, so
-we're going to use the same template (``templates/edit.pt``) for the add
-view as well as the page edit view. To do so we create a dummy Page object
+we're going to use the same template (``templates/edit.jinja2``) for the add
+view as well as the page edit view. To do so we create a dummy ``Page`` object
 in order to satisfy the edit form's desire to have *some* page object
 exposed as ``page``. :app:`Pyramid` will render the template associated
 with this view to a response.
@@ -207,14 +208,14 @@ The ``edit_page`` view function
 
 Here is the code for the ``edit_page`` view function and its decorator:
 
-.. literalinclude:: src/views/tutorial/views.py
-   :lines: 60-72
-   :lineno-start: 60
+.. literalinclude:: src/views/tutorial/views/default.py
+   :lines: 57-69
+   :lineno-start: 57
    :linenos:
    :language: python
 
 ``edit_page()`` is invoked when a user clicks the "Edit this
-Page" button on the view form.  It renders an edit form but it also acts as
+Page" button on the view form.  It renders an edit form, but it also acts as
 the handler for the form it renders.  The ``matchdict`` attribute of the
 request passed to the ``edit_page`` view will have a ``'pagename'`` key
 matching the name of the page the user wants to edit.
@@ -234,49 +235,51 @@ Adding templates
 ================
 
 The ``view_page``, ``add_page`` and ``edit_page`` views that we've added
-reference a :term:`template`.  Each template is a :term:`Chameleon`
-:term:`ZPT` template.  These templates will live in the ``templates``
-directory of our tutorial package.  Chameleon templates must have a ``.pt``
-extension to be recognized as such.
+reference a :term:`template`.  Each template is a :term:`Jinja2` template.
+These templates will live in the ``templates`` directory of our tutorial
+package.  Jinja2 templates must have a ``.jinja2`` extension to be recognized
+as such.
 
-The ``view.pt`` template
-------------------------
+The ``view.jinja2`` template
+----------------------------
 
-Create ``tutorial/tutorial/templates/view.pt`` and add the following
+Create ``tutorial/tutorial/templates/view.jinja2`` and add the following
 content:
 
-.. literalinclude:: src/views/tutorial/templates/view.pt
+.. literalinclude:: src/views/tutorial/templates/view.jinja2
    :linenos:
+   :emphasize-lines: 36,38-40
    :language: html
 
 This template is used by ``view_page()`` for displaying a single
 wiki page. It includes:
 
-- A ``div`` element that is replaced with the ``content`` value provided by
-  the view (lines 36-38).  ``content`` contains HTML, so the ``structure``
-  keyword is used to prevent escaping it (i.e., changing ">" to "&gt;", etc.)
-- A link that points at the "edit" URL which invokes the ``edit_page`` view
-  for the page being viewed (lines 40-42).
+- A variable that is replaced with the ``content`` value provided by the view
+  (line 36).  ``content`` contains HTML, so the ``|safe`` filter is used to
+  prevent escaping it (e.g., changing ">" to "&gt;").
+- A link that points at the "edit" URL which invokes the ``edit_page`` view for
+  the page being viewed (lines 38-40).
 
-The ``edit.pt`` template
-------------------------
+The ``edit.jinja2`` template
+----------------------------
 
-Create ``tutorial/tutorial/templates/edit.pt`` and add the following
+Create ``tutorial/tutorial/templates/edit.jinja2`` and add the following
 content:
 
-.. literalinclude:: src/views/tutorial/templates/edit.pt
+.. literalinclude:: src/views/tutorial/templates/edit.jinja2
    :linenos:
+   :emphasize-lines: 42,44,47
    :language: html
 
 This template is used by ``add_page()`` and ``edit_page()`` for adding and
 editing a wiki page.  It displays a page containing a form that includes:
 
-- A 10 row by 60 column ``textarea`` field named ``body`` that is filled
-  with any existing page data when it is rendered (line 45).
-- A submit button that has the name ``form.submitted`` (line 48).
+- A 10-row by 60-column ``textarea`` field named ``body`` that is filled with
+  any existing page data when it is rendered (line 44).
+- A submit button that has the name ``form.submitted`` (line 47).
 
 The form POSTs back to the ``save_url`` argument supplied by the view (line
-43).  The view will use the ``body`` and ``form.submitted`` values.
+42).  The view will use the ``body`` and ``form.submitted`` values.
 
 .. note:: Our templates use a ``request`` object that none of our tutorial
    views return in their dictionary. ``request`` is one of several names that
@@ -284,7 +287,7 @@ The form POSTs back to the ``save_url`` argument supplied by the view (line
    See :ref:`renderer_system_values` for information about other names that
    are available by default when a template is used as a renderer.
 
-Static Assets
+Static assets
 -------------
 
 Our templates name static assets, including CSS and images.  We don't need
@@ -299,7 +302,7 @@ subdirectories) and are just referred to by URL or by using the convenience
 method ``static_url``, e.g.,
 ``request.static_url('<package>:static/foo.css')`` within templates.
 
-Adding Routes to ``__init__.py``
+Adding routes to ``__init__.py``
 ================================
 
 The ``__init__.py`` file contains
@@ -340,7 +343,7 @@ something like:
 
 .. literalinclude:: src/views/tutorial/__init__.py
    :linenos:
-   :emphasize-lines: 19-22
+   :emphasize-lines: 11-14
    :language: python
 
 The highlighted lines are the ones that need to be added or edited.
-- 
cgit v1.2.3


From d1cb34643e086ac74965455b486ce0058764324f Mon Sep 17 00:00:00 2001
From: Michael Merickel <michael@merickel.org>
Date: Sun, 7 Feb 2016 13:57:51 -0600
Subject: assume the user is in the tutorial folder

this is already assumed inside of installation where commands are run
relative to setup.py
---
 docs/tutorials/wiki2/definingviews.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

(limited to 'docs/tutorials/wiki2/definingviews.rst')

diff --git a/docs/tutorials/wiki2/definingviews.rst b/docs/tutorials/wiki2/definingviews.rst
index 08fa8f16b..8660c2772 100644
--- a/docs/tutorials/wiki2/definingviews.rst
+++ b/docs/tutorials/wiki2/definingviews.rst
@@ -67,7 +67,7 @@ like this::
 Adding view functions in ``views/default.py``
 =============================================
 
-It's time for a major change.  Open ``tutorial/tutorial/views/default.py`` and
+It's time for a major change.  Open ``tutorial/views/default.py`` and
 edit it to look like the following:
 
 .. literalinclude:: src/views/tutorial/views/default.py
@@ -243,7 +243,7 @@ as such.
 The ``view.jinja2`` template
 ----------------------------
 
-Create ``tutorial/tutorial/templates/view.jinja2`` and add the following
+Create ``tutorial/templates/view.jinja2`` and add the following
 content:
 
 .. literalinclude:: src/views/tutorial/templates/view.jinja2
@@ -263,7 +263,7 @@ wiki page. It includes:
 The ``edit.jinja2`` template
 ----------------------------
 
-Create ``tutorial/tutorial/templates/edit.jinja2`` and add the following
+Create ``tutorial/templates/edit.jinja2`` and add the following
 content:
 
 .. literalinclude:: src/views/tutorial/templates/edit.jinja2
-- 
cgit v1.2.3


From 4b23c9f1344a359214455668741b52c3db8cf6ea Mon Sep 17 00:00:00 2001
From: Michael Merickel <michael@merickel.org>
Date: Sun, 7 Feb 2016 22:08:52 -0600
Subject: update definingviews chapter of wiki2 tutorial

---
 docs/tutorials/wiki2/definingviews.rst | 29 ++++++++++++++++-------------
 1 file changed, 16 insertions(+), 13 deletions(-)

(limited to 'docs/tutorials/wiki2/definingviews.rst')

diff --git a/docs/tutorials/wiki2/definingviews.rst b/docs/tutorials/wiki2/definingviews.rst
index 8660c2772..4bc7f461b 100644
--- a/docs/tutorials/wiki2/definingviews.rst
+++ b/docs/tutorials/wiki2/definingviews.rst
@@ -96,11 +96,12 @@ We'll describe each one briefly in the following sections.
 
 .. note::
 
-  There is nothing special about the filename ``default.py``.  A project may
-  have many view callables throughout its codebase in arbitrarily named files.
-  Files implementing view callables often have ``view`` in their filenames (or
+  There is nothing special about the filename ``default.py`` exept that
+  it is a Python module.  A project may have many view callables throughout
+  its codebase in arbitrarily named modules.
+  Modules implementing view callables often have ``view`` in their name (or
   may live in a Python subpackage of your application package named ``views``,
-  as in our case), but this is only by convention.
+  as in our case), but this is only by convention, not a requirement.
 
 The ``view_wiki`` view function
 -------------------------------
@@ -109,7 +110,7 @@ Following is the code for the ``view_wiki`` view function and its decorator:
 
 .. literalinclude:: src/views/tutorial/views/default.py
    :lines: 17-20
-   :lineno-start: 17
+   :lineno-match:
    :linenos:
    :language: python
 
@@ -119,8 +120,8 @@ represents the path to our "FrontPage".
 
 The ``view_wiki`` view callable always redirects to the URL of a Page resource
 named "FrontPage".  To do so, it returns an instance of the
-:class:`pyramid.httpexceptions.HTTPFound` class (instances of which implement
-the :class:`pyramid.interfaces.IResponse` interface, like
+:class:`pyramid.httpexceptions.HTTPFound` class (instances of which
+implement the :class:`pyramid.interfaces.IResponse` interface, like
 :class:`pyramid.response.Response` does). It uses the
 :meth:`pyramid.request.Request.route_url` API to construct an URL to the
 ``FrontPage`` page (i.e., ``http://localhost:6543/FrontPage``), and uses it as
@@ -133,7 +134,7 @@ Here is the code for the ``view_page`` view function and its decorator:
 
 .. literalinclude:: src/views/tutorial/views/default.py
    :lines: 22-42
-   :lineno-start: 22
+   :lineno-match:
    :linenos:
    :language: python
 
@@ -159,7 +160,7 @@ template, and we return a dictionary with a number of arguments.  The fact that
 ``view_page()`` returns a dictionary (as opposed to a :term:`response` object)
 is a cue to :app:`Pyramid` that it should try to use a :term:`renderer`
 associated with the view configuration to render a response.  In our case, the
-renderer used will be the ``templates/view.jinja2`` template, as indicated in
+renderer used will be the ``view.jinja2`` template, as indicated in
 the ``@view_config`` decorator that is applied to ``view_page()``.
 
 The ``add_page`` view function
@@ -169,7 +170,7 @@ Here is the code for the ``add_page`` view function and its decorator:
 
 .. literalinclude:: src/views/tutorial/views/default.py
    :lines: 44-55
-   :lineno-start: 44
+   :lineno-match:
    :linenos:
    :language: python
 
@@ -209,8 +210,8 @@ The ``edit_page`` view function
 Here is the code for the ``edit_page`` view function and its decorator:
 
 .. literalinclude:: src/views/tutorial/views/default.py
-   :lines: 57-69
-   :lineno-start: 57
+   :lines: 57-68
+   :lineno-match:
    :linenos:
    :language: python
 
@@ -281,7 +282,9 @@ editing a wiki page.  It displays a page containing a form that includes:
 The form POSTs back to the ``save_url`` argument supplied by the view (line
 42).  The view will use the ``body`` and ``form.submitted`` values.
 
-.. note:: Our templates use a ``request`` object that none of our tutorial
+.. note::
+
+   Our templates use a ``request`` object that none of our tutorial
    views return in their dictionary. ``request`` is one of several names that
    are available "by default" in a template when a template renderer is used.
    See :ref:`renderer_system_values` for information about other names that
-- 
cgit v1.2.3


From e01b270c451ce6f23b53181ad79b430666ebe003 Mon Sep 17 00:00:00 2001
From: Michael Merickel <michael@merickel.org>
Date: Wed, 10 Feb 2016 23:45:32 -0600
Subject: explain the base layout.jinja2 template and notfound view

---
 docs/tutorials/wiki2/definingviews.rst | 81 ++++++++++++++++++++++++++++++----
 1 file changed, 73 insertions(+), 8 deletions(-)

(limited to 'docs/tutorials/wiki2/definingviews.rst')

diff --git a/docs/tutorials/wiki2/definingviews.rst b/docs/tutorials/wiki2/definingviews.rst
index 4bc7f461b..6629839f8 100644
--- a/docs/tutorials/wiki2/definingviews.rst
+++ b/docs/tutorials/wiki2/definingviews.rst
@@ -73,7 +73,7 @@ edit it to look like the following:
 .. literalinclude:: src/views/tutorial/views/default.py
    :linenos:
    :language: python
-   :emphasize-lines: 1-9,12-70
+   :emphasize-lines: 1-9,12-68
 
 The highlighted lines need to be added or edited.
 
@@ -241,6 +241,26 @@ These templates will live in the ``templates`` directory of our tutorial
 package.  Jinja2 templates must have a ``.jinja2`` extension to be recognized
 as such.
 
+The ``layout.jinja2`` template
+------------------------------
+
+Replace ``tutorial/templates/layout.jinja2`` with the following content:
+
+.. literalinclude:: src/views/tutorial/templates/layout.jinja2
+   :linenos:
+   :emphasize-lines: 11,36
+   :language: html
+
+Since we're using a templating engine we can factor common boilerplate out of
+our page templates into reusable components. One method for doing this
+is template inheritance via blocks.
+
+- We have defined 2 placeholders in the layout template where a child template
+  can override the content. These blocks are named ``title`` (line 11) and
+  ``content`` (line 36).
+- Please refer to the Jinja2_ documentation for more information about
+  template inheritance.
+
 The ``view.jinja2`` template
 ----------------------------
 
@@ -249,17 +269,21 @@ content:
 
 .. literalinclude:: src/views/tutorial/templates/view.jinja2
    :linenos:
-   :emphasize-lines: 36,38-40
+   :emphasize-lines: 1,4,6-8
    :language: html
 
 This template is used by ``view_page()`` for displaying a single
 wiki page. It includes:
 
+- We begin by extending the ``layout.jinja2`` template defined above
+  which provides the skeleton of the page (line 1).
+- We override the ``content`` block from the base layout to insert our markup
+  into the body (line 3).
 - A variable that is replaced with the ``content`` value provided by the view
-  (line 36).  ``content`` contains HTML, so the ``|safe`` filter is used to
+  (line 4).  ``content`` contains HTML, so the ``|safe`` filter is used to
   prevent escaping it (e.g., changing ">" to "&gt;").
 - A link that points at the "edit" URL which invokes the ``edit_page`` view for
-  the page being viewed (lines 38-40).
+  the page being viewed (lines 6-8).
 
 The ``edit.jinja2`` template
 ----------------------------
@@ -269,18 +293,57 @@ content:
 
 .. literalinclude:: src/views/tutorial/templates/edit.jinja2
    :linenos:
-   :emphasize-lines: 42,44,47
+   :emphasize-lines: 3,12,14,17
    :language: html
 
 This template is used by ``add_page()`` and ``edit_page()`` for adding and
 editing a wiki page.  It displays a page containing a form that includes:
 
+- Again we are extending the ``layout.jinja2`` template which provides
+  the skeleton of the page.
+- Override the ``title`` block to affect the ``<title>`` tag in the
+  ``head`` of the page (line 3).
 - A 10-row by 60-column ``textarea`` field named ``body`` that is filled with
-  any existing page data when it is rendered (line 44).
-- A submit button that has the name ``form.submitted`` (line 47).
+  any existing page data when it is rendered (line 14).
+- A submit button that has the name ``form.submitted`` (line 17).
 
 The form POSTs back to the ``save_url`` argument supplied by the view (line
-42).  The view will use the ``body`` and ``form.submitted`` values.
+12).  The view will use the ``body`` and ``form.submitted`` values.
+
+The ``404.jinja2`` template
+---------------------------
+
+Replace ``tutorial/templates/404.jinja2`` with the following content:
+
+.. literalinclude:: src/views/tutorial/templates/404.jinja2
+   :linenos:
+   :language: html
+
+This template is linked from the ``notfound_view`` defined in
+``tutorial/views/notfound.py`` as shown here:
+
+.. literalinclude:: src/views/tutorial/views/notfound.py
+   :linenos:
+   :language: python
+
+There are several important things to note about this configuration:
+
+- The ``notfound_view`` in the above snippet is called an
+  :term:`exception view`. For more information see
+  :ref:`special_exceptions_in_callables`.
+- The ``notfound_view`` sets the response status to 404. It's possible to
+  affect the response object used by the renderer via
+  :ref:`request_response_attr`.
+- The ``notfound_view`` is registered as an exception view and will be invoked
+  **only** if ``pyramid.httpexceptions.HTTPNotFound`` is raised as an
+  exception. This means it will not be invoked for any responses returned
+  from a view normally. For example, on line 27 of
+  ``tutorial/views/default.py`` the exception is raised which will trigger
+  the view.
+
+Finally, you may delete the ``tutorial/templates/mytemplate.jinja2``
+template that was provided by the ``alchemy`` scaffold as we have created
+our own templates for the wiki.
 
 .. note::
 
@@ -373,3 +436,5 @@ each of the following URLs, checking that the result is as expected:
   will generate a ``NoResultFound: No row was found for one()`` error. You'll
   see an interactive traceback facility provided by
   :term:`pyramid_debugtoolbar`.
+
+.. _jinja2: http://jinja.pocoo.org/
-- 
cgit v1.2.3


From 23c2d7b337a5873dba0ca6c146e1174136ac2187 Mon Sep 17 00:00:00 2001
From: Michael Merickel <michael@merickel.org>
Date: Fri, 12 Feb 2016 02:54:37 -0600
Subject: update the views/models with setup.py develop

---
 docs/tutorials/wiki2/definingviews.rst | 43 +++++++---------------------------
 1 file changed, 8 insertions(+), 35 deletions(-)

(limited to 'docs/tutorials/wiki2/definingviews.rst')

diff --git a/docs/tutorials/wiki2/definingviews.rst b/docs/tutorials/wiki2/definingviews.rst
index 6629839f8..8bccc3fc0 100644
--- a/docs/tutorials/wiki2/definingviews.rst
+++ b/docs/tutorials/wiki2/definingviews.rst
@@ -14,13 +14,12 @@ and a user visits ``http://example.com/foo/bar``, our pattern would be matched
 against ``/foo/bar`` and the ``matchdict`` would look like ``{'one':'foo',
 'two':'bar'}``.
 
-Declaring dependencies in our ``setup.py`` file
-===============================================
+Adding the ``docutils`` dependency
+==================================
 
-The view code in our application will depend on a package which is not a
-dependency of the original "tutorial" application.  The original "tutorial"
-application was generated by the ``pcreate`` command; it doesn't know
-about our custom application requirements.
+Remember in the previous chapter we added a new dependency on the ``bcrypt``
+package. Again, the view code in our application will depend on a package which
+is not a dependency of the original "tutorial" application.
 
 We need to add a dependency on the ``docutils`` package to our ``tutorial``
 package's ``setup.py`` file by assigning this dependency to the ``requires``
@@ -30,39 +29,13 @@ Open ``tutorial/setup.py`` and edit it to look like the following:
 
 .. literalinclude:: src/views/setup.py
    :linenos:
-   :emphasize-lines: 20
+   :emphasize-lines: 13
    :language: python
 
 Only the highlighted line needs to be added.
 
-Running ``setup.py develop``
-============================
-
-Since a new software dependency was added, you will need to run ``python
-setup.py develop`` again inside the root of the ``tutorial`` package to obtain
-and register the newly added dependency distribution.
-
-Make sure your current working directory is the root of the project (the
-directory in which ``setup.py`` lives) and execute the following command.
-
-On UNIX:
-
-.. code-block:: bash
-
-   $ cd tutorial
-   $ $VENV/bin/python setup.py develop
-
-On Windows:
-
-.. code-block:: text
-
-   c:\pyramidtut> cd tutorial
-   c:\pyramidtut\tutorial> %VENV%\Scripts\python setup.py develop
-
-Success executing this command will end with a line to the console something
-like this::
-
-   Finished processing dependencies for tutorial==0.0
+Again, as we did in the previous chapter, the dependency now needs to be
+installed so re-run the ``python setup.py develop`` command.
 
 Adding view functions in ``views/default.py``
 =============================================
-- 
cgit v1.2.3


From 60891b844c883d2c9ce864522f2202d9514d8d83 Mon Sep 17 00:00:00 2001
From: Michael Merickel <michael@merickel.org>
Date: Sat, 13 Feb 2016 13:26:05 -0600
Subject: improve the views section by removing quirks and explaining
 transactions

---
 docs/tutorials/wiki2/definingviews.rst | 274 +++++++++++++++++++--------------
 1 file changed, 159 insertions(+), 115 deletions(-)

(limited to 'docs/tutorials/wiki2/definingviews.rst')

diff --git a/docs/tutorials/wiki2/definingviews.rst b/docs/tutorials/wiki2/definingviews.rst
index 8bccc3fc0..8f0f7b51d 100644
--- a/docs/tutorials/wiki2/definingviews.rst
+++ b/docs/tutorials/wiki2/definingviews.rst
@@ -37,6 +37,80 @@ Only the highlighted line needs to be added.
 Again, as we did in the previous chapter, the dependency now needs to be
 installed so re-run the ``python setup.py develop`` command.
 
+Static assets
+-------------
+
+Our templates name static assets, including CSS and images.  We don't need
+to create these files within our package's ``static`` directory because they
+were provided at the time we created the project.
+
+As an example, the CSS file will be accessed via
+``http://localhost:6543/static/theme.css`` by virtue of the call to the
+``add_static_view`` directive we've made in the ``__init__.py`` file.  Any
+number and type of static assets can be placed in this directory (or
+subdirectories) and are just referred to by URL or by using the convenience
+method ``static_url``, e.g.,
+``request.static_url('<package>:static/foo.css')`` within templates.
+
+Adding routes to ``__init__.py``
+================================
+
+This is the URL Dispatch tutorial and so let's start by adding some
+URL patterns to our app. Later we'll attach views to handle the URLs.
+
+The ``__init__.py`` file contains
+:meth:`pyramid.config.Configurator.add_route` calls which serve to add routes
+to our application.  First, we’ll get rid of the existing route created by
+the template using the name ``'home'``. It’s only an example and isn’t
+relevant to our application.
+
+We then need to add four calls to ``add_route``.  Note that the *ordering* of
+these declarations is very important.  ``route`` declarations are matched in
+the order they're found in the ``__init__.py`` file.
+
+#. Add a declaration which maps the pattern ``/`` (signifying the root URL)
+   to the route named ``view_wiki``.  It maps to our ``view_wiki`` view
+   callable by virtue of the ``@view_config`` attached to the ``view_wiki``
+   view function indicating ``route_name='view_wiki'``.
+
+#. Add a declaration which maps the pattern ``/{pagename}`` to the route named
+   ``view_page``.  This is the regular view for a page.  It maps
+   to our ``view_page`` view callable by virtue of the ``@view_config``
+   attached to the ``view_page`` view function indicating
+   ``route_name='view_page'``.
+
+#. Add a declaration which maps the pattern ``/add_page/{pagename}`` to the
+   route named ``add_page``.  This is the add view for a new page.  It maps
+   to our ``add_page`` view callable by virtue of the ``@view_config``
+   attached to the ``add_page`` view function indicating
+   ``route_name='add_page'``.
+
+#. Add a declaration which maps the pattern ``/{pagename}/edit_page`` to the
+   route named ``edit_page``.  This is the edit view for a page.  It maps
+   to our ``edit_page`` view callable by virtue of the ``@view_config``
+   attached to the ``edit_page`` view function indicating
+   ``route_name='edit_page'``.
+
+As a result of our edits, the ``__init__.py`` file should look
+something like:
+
+.. literalinclude:: src/views/tutorial/__init__.py
+   :linenos:
+   :emphasize-lines: 11-14
+   :language: python
+
+The highlighted lines are the ones that need to be added or edited.
+
+.. warn::
+
+   The order of the routes is important! If you placed
+   ``/{pagename}/edit_page`` **before** ``/add_page/{pagename}`` then we would
+   never be able to add pages because the first route would always match
+   a request to ``/add_page/edit_page`` whereas we want ``/add_page/..`` to
+   have priority. This isn't a huge problem in this particular app because
+   wiki pages are always camel case but it's important to be aware of this
+   behavior in your own apps.
+
 Adding view functions in ``views/default.py``
 =============================================
 
@@ -46,7 +120,7 @@ edit it to look like the following:
 .. literalinclude:: src/views/tutorial/views/default.py
    :linenos:
    :language: python
-   :emphasize-lines: 1-9,12-68
+   :emphasize-lines: 1-9,12-70
 
 The highlighted lines need to be added or edited.
 
@@ -54,7 +128,7 @@ We added some imports, and created a regular expression to find "WikiWords".
 
 We got rid of the ``my_view`` view function and its decorator that was added
 when we originally rendered the ``alchemy`` scaffold.  It was only an example
-and isn't relevant to our application.  We also delated the ``db_err_msg``
+and isn't relevant to our application.  We also deleted the ``db_err_msg``
 string.
 
 Then we added four :term:`view callable` functions to our ``views/default.py``
@@ -88,7 +162,7 @@ Following is the code for the ``view_wiki`` view function and its decorator:
    :language: python
 
 ``view_wiki()`` is the :term:`default view` that gets called when a request is
-made to the root URL of our wiki.  It always redirects to an URL which
+made to the root URL of our wiki.  It always redirects to a URL which
 represents the path to our "FrontPage".
 
 The ``view_wiki`` view callable always redirects to the URL of a Page resource
@@ -96,7 +170,7 @@ named "FrontPage".  To do so, it returns an instance of the
 :class:`pyramid.httpexceptions.HTTPFound` class (instances of which
 implement the :class:`pyramid.interfaces.IResponse` interface, like
 :class:`pyramid.response.Response` does). It uses the
-:meth:`pyramid.request.Request.route_url` API to construct an URL to the
+:meth:`pyramid.request.Request.route_url` API to construct a URL to the
 ``FrontPage`` page (i.e., ``http://localhost:6543/FrontPage``), and uses it as
 the "location" of the ``HTTPFound`` response, forming an HTTP redirect.
 
@@ -116,12 +190,12 @@ Here is the code for the ``view_page`` view function and its decorator:
 ``Page`` model object) as HTML.  Then it substitutes an HTML anchor for each
 *WikiWord* reference in the rendered HTML using a compiled regular expression.
 
-The curried function named ``check`` is used as the first argument to
+The curried function named ``add_link`` is used as the first argument to
 ``wikiwords.sub``, indicating that it should be called to provide a value for
 each WikiWord match found in the content.  If the wiki already contains a
-page with the matched WikiWord name, ``check()`` generates a view
+page with the matched WikiWord name, ``add_link()`` generates a view
 link to be used as the substitution value and returns it.  If the wiki does
-not already contain a page with the matched WikiWord name, ``check()``
+not already contain a page with the matched WikiWord name, ``add_link()``
 generates an "add" link as the substitution value and returns it.
 
 As a result, the ``content`` variable is now a fully formed bit of HTML
@@ -136,19 +210,73 @@ associated with the view configuration to render a response.  In our case, the
 renderer used will be the ``view.jinja2`` template, as indicated in
 the ``@view_config`` decorator that is applied to ``view_page()``.
 
+If the page does not exist then we need to handle that by raising
+:class:`pyramid.httpexceptions.HTTPNotFound`` to trigger our 404 handling
+defined in ``tutorial/views/notfound.py``.
+
+.. note::
+
+   Using ``raise`` versus ``return`` with the http exceptions is an important
+   distinction that can commonly mess people up. In
+   ``tutorial/views/notfound.py`` there is an :term:`exception view`
+   registered for handling the ``HTTPNotFound`` exception. Exception views
+   are only triggered for raised exceptions. If the ``HTTPNotFound`` is
+   returned then it has an internal "stock" template that it will use
+   to render itself as a response. If you aren't seeing your exception
+   view being executed this is probably the problem! See
+   :ref:`special_exceptions_in_callables` for more information about
+   exception views.
+
+The ``edit_page`` view function
+-------------------------------
+
+Here is the code for the ``edit_page`` view function and its decorator:
+
+.. literalinclude:: src/views/tutorial/views/default.py
+   :lines: 44-56
+   :lineno-match:
+   :linenos:
+   :language: python
+
+``edit_page()`` is invoked when a user clicks the "Edit this
+Page" button on the view form.  It renders an edit form, but it also acts as
+the handler for the form it renders.  The ``matchdict`` attribute of the
+request passed to the ``edit_page`` view will have a ``'pagename'`` key
+matching the name of the page the user wants to edit.
+
+If the view execution *is* a result of a form submission (i.e., the expression
+``'form.submitted' in request.params`` is ``True``), the view grabs the
+``body`` element of the request parameters and sets it as the ``data``
+attribute of the page object.  It then redirects to the ``view_page`` view
+of the wiki page.
+
+If the view execution is *not* a result of a form submission (i.e., the
+expression ``'form.submitted' in request.params`` is ``False``), the view
+simply renders the edit form, passing the page object and a ``save_url``
+which will be used as the action of the generated form.
+
+.. note::
+
+   Since our ``request.dbsession`` defined in the previous chapter is
+   registered with the ``pyramid_tm`` transaction manager any changes we make
+   to objects managed by the that session will be committed automatically.
+   In the event that there was an error (even later, in our template code) the
+   changes would be aborted. This means the view itself does not need to
+   concern itself with commit/rollback logic.
+
 The ``add_page`` view function
 ------------------------------
 
 Here is the code for the ``add_page`` view function and its decorator:
 
 .. literalinclude:: src/views/tutorial/views/default.py
-   :lines: 44-55
+   :lines: 58-70
    :lineno-match:
    :linenos:
    :language: python
 
 ``add_page()`` is invoked when a user clicks on a *WikiWord* which
-isn't yet represented as a page in the system.  The ``check`` function
+isn't yet represented as a page in the system.  The ``add_link`` function
 within the ``view_page`` view generates URLs to this view.
 ``add_page()`` also acts as a handler for the form that is generated
 when we want to add a page object.  The ``matchdict`` attribute of the
@@ -164,8 +292,12 @@ If the view execution *is* a result of a form submission (i.e., the expression
 ``'form.submitted' in request.params`` is ``True``), we grab the page body
 from the form data, create a Page object with this page body and the name
 taken from ``matchdict['pagename']``, and save it into the database using
-``request.dbession.add``.  We then redirect back to the ``view_page`` view for
-the newly created page.
+``request.dbession.add``.  Since we have not yet covered authentication we
+don't have a logged-in user to add as the page's ``creator``. Until we
+get to that point in the tutorial we'll just assume that all pages are created
+by the ``editor`` user so we query that object and set it on ``page.creator``.
+Finally, we redirect the client back to the ``view_page`` view for the newly
+created page.
 
 If the view execution is *not* a result of a form submission (i.e., the
 expression ``'form.submitted' in request.params`` is ``False``), the view
@@ -177,34 +309,6 @@ in order to satisfy the edit form's desire to have *some* page object
 exposed as ``page``. :app:`Pyramid` will render the template associated
 with this view to a response.
 
-The ``edit_page`` view function
--------------------------------
-
-Here is the code for the ``edit_page`` view function and its decorator:
-
-.. literalinclude:: src/views/tutorial/views/default.py
-   :lines: 57-68
-   :lineno-match:
-   :linenos:
-   :language: python
-
-``edit_page()`` is invoked when a user clicks the "Edit this
-Page" button on the view form.  It renders an edit form, but it also acts as
-the handler for the form it renders.  The ``matchdict`` attribute of the
-request passed to the ``edit_page`` view will have a ``'pagename'`` key
-matching the name of the page the user wants to edit.
-
-If the view execution *is* a result of a form submission (i.e., the expression
-``'form.submitted' in request.params`` is ``True``), the view grabs the
-``body`` element of the request parameters and sets it as the ``data``
-attribute of the page object.  It then redirects to the ``view_page`` view
-of the wiki page.
-
-If the view execution is *not* a result of a form submission (i.e., the
-expression ``'form.submitted' in request.params`` is ``False``), the view
-simply renders the edit form, passing the page object and a ``save_url``
-which will be used as the action of the generated form.
-
 Adding templates
 ================
 
@@ -229,7 +333,7 @@ our page templates into reusable components. One method for doing this
 is template inheritance via blocks.
 
 - We have defined 2 placeholders in the layout template where a child template
-  can override the content. These blocks are named ``title`` (line 11) and
+  can override the content. These blocks are named ``subtitle`` (line 11) and
   ``content`` (line 36).
 - Please refer to the Jinja2_ documentation for more information about
   template inheritance.
@@ -237,44 +341,45 @@ is template inheritance via blocks.
 The ``view.jinja2`` template
 ----------------------------
 
-Create ``tutorial/templates/view.jinja2`` and add the following
-content:
+Create ``tutorial/templates/view.jinja2`` and add the following content:
 
 .. literalinclude:: src/views/tutorial/templates/view.jinja2
    :linenos:
    :emphasize-lines: 1,4,6-8
    :language: html
 
-This template is used by ``view_page()`` for displaying a single
-wiki page. It includes:
+This template is used by ``view_page()`` for displaying a single wiki page.
+It includes:
 
 - We begin by extending the ``layout.jinja2`` template defined above
   which provides the skeleton of the page (line 1).
+- We override the ``subtitle`` block from the base layout to insert the
+  page name of the page into the page's title (line 3).
 - We override the ``content`` block from the base layout to insert our markup
-  into the body (line 3).
+  into the body (line 5-18).
 - A variable that is replaced with the ``content`` value provided by the view
-  (line 4).  ``content`` contains HTML, so the ``|safe`` filter is used to
+  (line 6).  ``content`` contains HTML, so the ``|safe`` filter is used to
   prevent escaping it (e.g., changing ">" to "&gt;").
 - A link that points at the "edit" URL which invokes the ``edit_page`` view for
-  the page being viewed (lines 6-8).
+  the page being viewed (line 9).
 
 The ``edit.jinja2`` template
 ----------------------------
 
-Create ``tutorial/templates/edit.jinja2`` and add the following
-content:
+Create ``tutorial/templates/edit.jinja2`` and add the following content:
 
 .. literalinclude:: src/views/tutorial/templates/edit.jinja2
    :linenos:
    :emphasize-lines: 3,12,14,17
    :language: html
 
-This template is used by ``add_page()`` and ``edit_page()`` for adding and
-editing a wiki page.  It displays a page containing a form that includes:
+This template serves two use-cases. It is used by ``add_page()`` and
+``edit_page()`` for adding and editing a wiki page.  It displays a page
+containing a form that includes:
 
-- Again we are extending the ``layout.jinja2`` template which provides
-  the skeleton of the page.
-- Override the ``title`` block to affect the ``<title>`` tag in the
+- Again, we are extending the ``layout.jinja2`` template which provides
+  the skeleton of the page (line 1).
+- Override the ``subtitle`` block to affect the ``<title>`` tag in the
   ``head`` of the page (line 3).
 - A 10-row by 60-column ``textarea`` field named ``body`` that is filled with
   any existing page data when it is rendered (line 14).
@@ -326,67 +431,6 @@ our own templates for the wiki.
    See :ref:`renderer_system_values` for information about other names that
    are available by default when a template is used as a renderer.
 
-Static assets
--------------
-
-Our templates name static assets, including CSS and images.  We don't need
-to create these files within our package's ``static`` directory because they
-were provided at the time we created the project.
-
-As an example, the CSS file will be accessed via
-``http://localhost:6543/static/theme.css`` by virtue of the call to the
-``add_static_view`` directive we've made in the ``__init__.py`` file.  Any
-number and type of static assets can be placed in this directory (or
-subdirectories) and are just referred to by URL or by using the convenience
-method ``static_url``, e.g.,
-``request.static_url('<package>:static/foo.css')`` within templates.
-
-Adding routes to ``__init__.py``
-================================
-
-The ``__init__.py`` file contains
-:meth:`pyramid.config.Configurator.add_route` calls which serve to add routes
-to our application.  First, we’ll get rid of the existing route created by
-the template using the name ``'home'``. It’s only an example and isn’t
-relevant to our application.
-
-We then need to add four calls to ``add_route``.  Note that the *ordering* of
-these declarations is very important.  ``route`` declarations are matched in
-the order they're found in the ``__init__.py`` file.
-
-#. Add a declaration which maps the pattern ``/`` (signifying the root URL)
-   to the route named ``view_wiki``.  It maps to our ``view_wiki`` view
-   callable by virtue of the ``@view_config`` attached to the ``view_wiki``
-   view function indicating ``route_name='view_wiki'``.
-
-#. Add a declaration which maps the pattern ``/{pagename}`` to the route named
-   ``view_page``.  This is the regular view for a page.  It maps
-   to our ``view_page`` view callable by virtue of the ``@view_config``
-   attached to the ``view_page`` view function indicating
-   ``route_name='view_page'``.
-
-#. Add a declaration which maps the pattern ``/add_page/{pagename}`` to the
-   route named ``add_page``.  This is the add view for a new page.  It maps
-   to our ``add_page`` view callable by virtue of the ``@view_config``
-   attached to the ``add_page`` view function indicating
-   ``route_name='add_page'``.
-
-#. Add a declaration which maps the pattern ``/{pagename}/edit_page`` to the
-   route named ``edit_page``.  This is the edit view for a page.  It maps
-   to our ``edit_page`` view callable by virtue of the ``@view_config``
-   attached to the ``edit_page`` view function indicating
-   ``route_name='edit_page'``.
-
-As a result of our edits, the ``__init__.py`` file should look
-something like:
-
-.. literalinclude:: src/views/tutorial/__init__.py
-   :linenos:
-   :emphasize-lines: 11-14
-   :language: python
-
-The highlighted lines are the ones that need to be added or edited.
-
 Viewing the application in a browser
 ====================================
 
-- 
cgit v1.2.3


From 4c391c55057acbb36df28215f562c42d2b616872 Mon Sep 17 00:00:00 2001
From: Michael Merickel <michael@merickel.org>
Date: Sat, 13 Feb 2016 21:01:09 -0600
Subject: fix syntax

---
 docs/tutorials/wiki2/definingviews.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'docs/tutorials/wiki2/definingviews.rst')

diff --git a/docs/tutorials/wiki2/definingviews.rst b/docs/tutorials/wiki2/definingviews.rst
index 8f0f7b51d..acaefe6e8 100644
--- a/docs/tutorials/wiki2/definingviews.rst
+++ b/docs/tutorials/wiki2/definingviews.rst
@@ -101,7 +101,7 @@ something like:
 
 The highlighted lines are the ones that need to be added or edited.
 
-.. warn::
+.. warning::
 
    The order of the routes is important! If you placed
    ``/{pagename}/edit_page`` **before** ``/add_page/{pagename}`` then we would
-- 
cgit v1.2.3


From bca6c996d9e879c21d8b207bb36bc10ebe1db256 Mon Sep 17 00:00:00 2001
From: Michael Merickel <michael@merickel.org>
Date: Sat, 13 Feb 2016 21:08:58 -0600
Subject: highlight more appropriate lines in views

---
 docs/tutorials/wiki2/definingviews.rst | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

(limited to 'docs/tutorials/wiki2/definingviews.rst')

diff --git a/docs/tutorials/wiki2/definingviews.rst b/docs/tutorials/wiki2/definingviews.rst
index acaefe6e8..fea682628 100644
--- a/docs/tutorials/wiki2/definingviews.rst
+++ b/docs/tutorials/wiki2/definingviews.rst
@@ -345,7 +345,7 @@ Create ``tutorial/templates/view.jinja2`` and add the following content:
 
 .. literalinclude:: src/views/tutorial/templates/view.jinja2
    :linenos:
-   :emphasize-lines: 1,4,6-8
+   :emphasize-lines: 1,3,6
    :language: html
 
 This template is used by ``view_page()`` for displaying a single wiki page.
@@ -402,6 +402,7 @@ This template is linked from the ``notfound_view`` defined in
 
 .. literalinclude:: src/views/tutorial/views/notfound.py
    :linenos:
+   :emphasize-lines: 6
    :language: python
 
 There are several important things to note about this configuration:
@@ -409,8 +410,8 @@ There are several important things to note about this configuration:
 - The ``notfound_view`` in the above snippet is called an
   :term:`exception view`. For more information see
   :ref:`special_exceptions_in_callables`.
-- The ``notfound_view`` sets the response status to 404. It's possible to
-  affect the response object used by the renderer via
+- The ``notfound_view`` sets the response status to 404. It's possible
+  to affect the response object used by the renderer via
   :ref:`request_response_attr`.
 - The ``notfound_view`` is registered as an exception view and will be invoked
   **only** if ``pyramid.httpexceptions.HTTPNotFound`` is raised as an
-- 
cgit v1.2.3


From da5ebc28c38ea32ad99389b5bc23e2f847af8047 Mon Sep 17 00:00:00 2001
From: Michael Merickel <michael@merickel.org>
Date: Sun, 14 Feb 2016 17:40:03 -0600
Subject: split routes into a separate module

---
 docs/tutorials/wiki2/definingviews.rst | 17 ++++++++---------
 1 file changed, 8 insertions(+), 9 deletions(-)

(limited to 'docs/tutorials/wiki2/definingviews.rst')

diff --git a/docs/tutorials/wiki2/definingviews.rst b/docs/tutorials/wiki2/definingviews.rst
index fea682628..184f9e1fa 100644
--- a/docs/tutorials/wiki2/definingviews.rst
+++ b/docs/tutorials/wiki2/definingviews.rst
@@ -46,19 +46,19 @@ were provided at the time we created the project.
 
 As an example, the CSS file will be accessed via
 ``http://localhost:6543/static/theme.css`` by virtue of the call to the
-``add_static_view`` directive we've made in the ``__init__.py`` file.  Any
+``add_static_view`` directive we've made in the ``routes.py`` file.  Any
 number and type of static assets can be placed in this directory (or
 subdirectories) and are just referred to by URL or by using the convenience
 method ``static_url``, e.g.,
 ``request.static_url('<package>:static/foo.css')`` within templates.
 
-Adding routes to ``__init__.py``
-================================
+Adding routes to ``routes.py``
+==============================
 
 This is the URL Dispatch tutorial and so let's start by adding some
 URL patterns to our app. Later we'll attach views to handle the URLs.
 
-The ``__init__.py`` file contains
+The ``routes.py`` file contains
 :meth:`pyramid.config.Configurator.add_route` calls which serve to add routes
 to our application.  First, we’ll get rid of the existing route created by
 the template using the name ``'home'``. It’s only an example and isn’t
@@ -66,7 +66,7 @@ relevant to our application.
 
 We then need to add four calls to ``add_route``.  Note that the *ordering* of
 these declarations is very important.  ``route`` declarations are matched in
-the order they're found in the ``__init__.py`` file.
+the order they're registered.
 
 #. Add a declaration which maps the pattern ``/`` (signifying the root URL)
    to the route named ``view_wiki``.  It maps to our ``view_wiki`` view
@@ -91,12 +91,11 @@ the order they're found in the ``__init__.py`` file.
    attached to the ``edit_page`` view function indicating
    ``route_name='edit_page'``.
 
-As a result of our edits, the ``__init__.py`` file should look
-something like:
+As a result of our edits, the ``routes.py`` file should look something like:
 
-.. literalinclude:: src/views/tutorial/__init__.py
+.. literalinclude:: src/views/tutorial/routes.py
    :linenos:
-   :emphasize-lines: 11-14
+   :emphasize-lines: 3-6
    :language: python
 
 The highlighted lines are the ones that need to be added or edited.
-- 
cgit v1.2.3


From c956c9bf07607dbd66f092a11b8cbd1d359829df Mon Sep 17 00:00:00 2001
From: Steve Piercy <web@stevepiercy.com>
Date: Fri, 26 Feb 2016 02:02:59 -0800
Subject: update definingviews (done) - minor grammar and syntax

---
 docs/tutorials/wiki2/definingviews.rst | 249 +++++++++++++++++----------------
 1 file changed, 130 insertions(+), 119 deletions(-)

(limited to 'docs/tutorials/wiki2/definingviews.rst')

diff --git a/docs/tutorials/wiki2/definingviews.rst b/docs/tutorials/wiki2/definingviews.rst
index 184f9e1fa..e48980dc8 100644
--- a/docs/tutorials/wiki2/definingviews.rst
+++ b/docs/tutorials/wiki2/definingviews.rst
@@ -3,10 +3,10 @@ Defining Views
 ==============
 
 A :term:`view callable` in a :app:`Pyramid` application is typically a simple
-Python function that accepts a single parameter named :term:`request`.  A
-view callable is assumed to return a :term:`response` object.
+Python function that accepts a single parameter named :term:`request`. A view
+callable is assumed to return a :term:`response` object.
 
-The request object has a dictionary as an attribute named ``matchdict``.  A
+The request object has a dictionary as an attribute named ``matchdict``. A
 ``matchdict`` maps the placeholders in the matching URL ``pattern`` to the
 substrings of the path in the :term:`request` URL. For instance, if a call to
 :meth:`pyramid.config.Configurator.add_route` has the pattern ``/{one}/{two}``,
@@ -14,10 +14,11 @@ and a user visits ``http://example.com/foo/bar``, our pattern would be matched
 against ``/foo/bar`` and the ``matchdict`` would look like ``{'one':'foo',
 'two':'bar'}``.
 
+
 Adding the ``docutils`` dependency
 ==================================
 
-Remember in the previous chapter we added a new dependency on the ``bcrypt``
+Remember in the previous chapter we added a new dependency of the ``bcrypt``
 package. Again, the view code in our application will depend on a package which
 is not a dependency of the original "tutorial" application.
 
@@ -35,7 +36,8 @@ Open ``tutorial/setup.py`` and edit it to look like the following:
 Only the highlighted line needs to be added.
 
 Again, as we did in the previous chapter, the dependency now needs to be
-installed so re-run the ``python setup.py develop`` command.
+installed, so re-run the ``python setup.py develop`` command.
+
 
 Static assets
 -------------
@@ -46,52 +48,54 @@ were provided at the time we created the project.
 
 As an example, the CSS file will be accessed via
 ``http://localhost:6543/static/theme.css`` by virtue of the call to the
-``add_static_view`` directive we've made in the ``routes.py`` file.  Any
-number and type of static assets can be placed in this directory (or
-subdirectories) and are just referred to by URL or by using the convenience
-method ``static_url``, e.g.,
-``request.static_url('<package>:static/foo.css')`` within templates.
+``add_static_view`` directive we've made in the ``routes.py`` file. Any number
+and type of static assets can be placed in this directory (or subdirectories)
+and are just referred to by URL or by using the convenience method
+``static_url``, e.g., ``request.static_url('<package>:static/foo.css')`` within
+templates.
+
 
 Adding routes to ``routes.py``
 ==============================
 
-This is the URL Dispatch tutorial and so let's start by adding some
-URL patterns to our app. Later we'll attach views to handle the URLs.
+This is the `URL Dispatch` tutorial, so let's start by adding some URL patterns
+to our app. Later we'll attach views to handle the URLs.
 
-The ``routes.py`` file contains
-:meth:`pyramid.config.Configurator.add_route` calls which serve to add routes
-to our application.  First, we’ll get rid of the existing route created by
-the template using the name ``'home'``. It’s only an example and isn’t
-relevant to our application.
+The ``routes.py`` file contains :meth:`pyramid.config.Configurator.add_route`
+calls which serve to add routes to our application. First we'll get rid of the
+existing route created by the template using the name ``'home'``. It's only an
+example and isn't relevant to our application.
 
-We then need to add four calls to ``add_route``.  Note that the *ordering* of
-these declarations is very important.  ``route`` declarations are matched in
-the order they're registered.
+We then need to add four calls to ``add_route``. Note that the *ordering* of
+these declarations is very important. Route declarations are matched in the
+order they're registered.
 
-#. Add a declaration which maps the pattern ``/`` (signifying the root URL)
-   to the route named ``view_wiki``.  It maps to our ``view_wiki`` view
-   callable by virtue of the ``@view_config`` attached to the ``view_wiki``
-   view function indicating ``route_name='view_wiki'``.
+#. Add a declaration which maps the pattern ``/`` (signifying the root URL) to
+   the route named ``view_wiki``. In the next step, we will map it to our
+   ``view_wiki`` view callable by virtue of the ``@view_config`` decorator
+   attached to the ``view_wiki`` view function, which in turn will be indicated
+   by ``route_name='view_wiki'``.
 
 #. Add a declaration which maps the pattern ``/{pagename}`` to the route named
-   ``view_page``.  This is the regular view for a page.  It maps
-   to our ``view_page`` view callable by virtue of the ``@view_config``
-   attached to the ``view_page`` view function indicating
-   ``route_name='view_page'``.
+   ``view_page``. This is the regular view for a page. Again, in the next step,
+   we will map it to our ``view_page`` view callable by virtue of the
+   ``@view_config`` decorator attached to the ``view_page`` view function,
+   whin in turn will be indicated by ``route_name='view_page'``.
 
 #. Add a declaration which maps the pattern ``/add_page/{pagename}`` to the
-   route named ``add_page``.  This is the add view for a new page.  It maps
-   to our ``add_page`` view callable by virtue of the ``@view_config``
-   attached to the ``add_page`` view function indicating
-   ``route_name='add_page'``.
+   route named ``add_page``. This is the add view for a new page. We will map
+   it to our ``add_page`` view callable by virtue of the ``@view_config``
+   decorator attached to the ``add_page`` view function, which in turn will be
+   indicated by ``route_name='add_page'``.
 
 #. Add a declaration which maps the pattern ``/{pagename}/edit_page`` to the
-   route named ``edit_page``.  This is the edit view for a page.  It maps
+   route named ``edit_page``. This is the edit view for a page. We will map it
    to our ``edit_page`` view callable by virtue of the ``@view_config``
-   attached to the ``edit_page`` view function indicating
-   ``route_name='edit_page'``.
+   decorator attached to the ``edit_page`` view function, which in turn will be
+   indicated by ``route_name='edit_page'``.
 
-As a result of our edits, the ``routes.py`` file should look something like:
+As a result of our edits, the ``routes.py`` file should look like the
+following:
 
 .. literalinclude:: src/views/tutorial/routes.py
    :linenos:
@@ -103,13 +107,14 @@ The highlighted lines are the ones that need to be added or edited.
 .. warning::
 
    The order of the routes is important! If you placed
-   ``/{pagename}/edit_page`` **before** ``/add_page/{pagename}`` then we would
-   never be able to add pages because the first route would always match
-   a request to ``/add_page/edit_page`` whereas we want ``/add_page/..`` to
-   have priority. This isn't a huge problem in this particular app because
-   wiki pages are always camel case but it's important to be aware of this
+   ``/{pagename}/edit_page`` *before* ``/add_page/{pagename}``, then we would
+   never be able to add pages. This is because the first route would always
+   match a request to ``/add_page/edit_page`` whereas we want ``/add_page/..``
+   to have priority. This isn't a huge problem in this particular app because
+   wiki pages are always camel case, but it's important to be aware of this
    behavior in your own apps.
 
+
 Adding view functions in ``views/default.py``
 =============================================
 
@@ -131,23 +136,24 @@ and isn't relevant to our application.  We also deleted the ``db_err_msg``
 string.
 
 Then we added four :term:`view callable` functions to our ``views/default.py``
-module:
+module, as mentioned in the previous step:
 
 * ``view_wiki()`` - Displays the wiki itself. It will answer on the root URL.
 * ``view_page()`` - Displays an individual page.
-* ``add_page()`` - Allows the user to add a page.
 * ``edit_page()`` - Allows the user to edit a page.
+* ``add_page()`` - Allows the user to add a page.
 
 We'll describe each one briefly in the following sections.
 
 .. note::
 
-  There is nothing special about the filename ``default.py`` exept that
-  it is a Python module.  A project may have many view callables throughout
-  its codebase in arbitrarily named modules.
-  Modules implementing view callables often have ``view`` in their name (or
-  may live in a Python subpackage of your application package named ``views``,
-  as in our case), but this is only by convention, not a requirement.
+  There is nothing special about the filename ``default.py`` exept that it is a
+  Python module. A project may have many view callables throughout its codebase
+  in arbitrarily named modules. Modules implementing view callables often have
+  ``view`` in their name (or may live in a Python subpackage of your
+  application package named ``views``, as in our case), but this is only by
+  convention, not a requirement.
+
 
 The ``view_wiki`` view function
 -------------------------------
@@ -166,13 +172,14 @@ represents the path to our "FrontPage".
 
 The ``view_wiki`` view callable always redirects to the URL of a Page resource
 named "FrontPage".  To do so, it returns an instance of the
-:class:`pyramid.httpexceptions.HTTPFound` class (instances of which
-implement the :class:`pyramid.interfaces.IResponse` interface, like
-:class:`pyramid.response.Response` does). It uses the
+:class:`pyramid.httpexceptions.HTTPFound` class (instances of which implement
+the :class:`pyramid.interfaces.IResponse` interface, like
+:class:`pyramid.response.Response`). It uses the
 :meth:`pyramid.request.Request.route_url` API to construct a URL to the
 ``FrontPage`` page (i.e., ``http://localhost:6543/FrontPage``), and uses it as
 the "location" of the ``HTTPFound`` response, forming an HTTP redirect.
 
+
 The ``view_page`` view function
 -------------------------------
 
@@ -201,7 +208,7 @@ As a result, the ``content`` variable is now a fully formed bit of HTML
 containing various view and add links for WikiWords based on the content of
 our current page object.
 
-We then generate an edit URL because it's easier to do here than in the
+We then generate an edit URL, because it's easier to do here than in the
 template, and we return a dictionary with a number of arguments.  The fact that
 ``view_page()`` returns a dictionary (as opposed to a :term:`response` object)
 is a cue to :app:`Pyramid` that it should try to use a :term:`renderer`
@@ -209,22 +216,22 @@ associated with the view configuration to render a response.  In our case, the
 renderer used will be the ``view.jinja2`` template, as indicated in
 the ``@view_config`` decorator that is applied to ``view_page()``.
 
-If the page does not exist then we need to handle that by raising
-:class:`pyramid.httpexceptions.HTTPNotFound`` to trigger our 404 handling
+If the page does not exist, then we need to handle that by raising a
+:class:`pyramid.httpexceptions.HTTPNotFound` to trigger our 404 handling,
 defined in ``tutorial/views/notfound.py``.
 
 .. note::
 
-   Using ``raise`` versus ``return`` with the http exceptions is an important
+   Using ``raise`` versus ``return`` with the HTTP exceptions is an important
    distinction that can commonly mess people up. In
    ``tutorial/views/notfound.py`` there is an :term:`exception view`
-   registered for handling the ``HTTPNotFound`` exception. Exception views
-   are only triggered for raised exceptions. If the ``HTTPNotFound`` is
-   returned then it has an internal "stock" template that it will use
-   to render itself as a response. If you aren't seeing your exception
-   view being executed this is probably the problem! See
-   :ref:`special_exceptions_in_callables` for more information about
-   exception views.
+   registered for handling the ``HTTPNotFound`` exception. Exception views are
+   only triggered for raised exceptions. If the ``HTTPNotFound`` is returned,
+   then it has an internal "stock" template that it will use to render itself
+   as a response. If you aren't seeing your exception view being executed, this
+   is most likely the problem! See :ref:`special_exceptions_in_callables` for
+   more information about exception views.
+
 
 The ``edit_page`` view function
 -------------------------------
@@ -237,11 +244,11 @@ Here is the code for the ``edit_page`` view function and its decorator:
    :linenos:
    :language: python
 
-``edit_page()`` is invoked when a user clicks the "Edit this
-Page" button on the view form.  It renders an edit form, but it also acts as
-the handler for the form it renders.  The ``matchdict`` attribute of the
-request passed to the ``edit_page`` view will have a ``'pagename'`` key
-matching the name of the page the user wants to edit.
+``edit_page()`` is invoked when a user clicks the "Edit this Page" button on
+the view form. It renders an edit form, but it also acts as the handler for the
+form which it renders. The ``matchdict`` attribute of the request passed to the
+``edit_page`` view will have a ``'pagename'`` key matching the name of the page
+that the user wants to edit.
 
 If the view execution *is* a result of a form submission (i.e., the expression
 ``'form.submitted' in request.params`` is ``True``), the view grabs the
@@ -257,12 +264,13 @@ which will be used as the action of the generated form.
 .. note::
 
    Since our ``request.dbsession`` defined in the previous chapter is
-   registered with the ``pyramid_tm`` transaction manager any changes we make
-   to objects managed by the that session will be committed automatically.
-   In the event that there was an error (even later, in our template code) the
+   registered with the ``pyramid_tm`` transaction manager, any changes we make
+   to objects managed by the that session will be committed automatically. In
+   the event that there was an error (even later, in our template code), the
    changes would be aborted. This means the view itself does not need to
    concern itself with commit/rollback logic.
 
+
 The ``add_page`` view function
 ------------------------------
 
@@ -274,27 +282,26 @@ Here is the code for the ``add_page`` view function and its decorator:
    :linenos:
    :language: python
 
-``add_page()`` is invoked when a user clicks on a *WikiWord* which
-isn't yet represented as a page in the system.  The ``add_link`` function
-within the ``view_page`` view generates URLs to this view.
-``add_page()`` also acts as a handler for the form that is generated
-when we want to add a page object.  The ``matchdict`` attribute of the
-request passed to the ``add_page()`` view will have the values we need
-to construct URLs and find model objects.
+``add_page()`` is invoked when a user clicks on a *WikiWord* which isn't yet
+represented as a page in the system. The ``add_link`` function within the
+``view_page`` view generates URLs to this view. ``add_page()`` also acts as a
+handler for the form that is generated when we want to add a page object. The
+``matchdict`` attribute of the request passed to the ``add_page()`` view will
+have the values we need to construct URLs and find model objects.
 
-The ``matchdict`` will have a ``'pagename'`` key that matches the name of
-the page we'd like to add.  If our add view is invoked via,
-e.g., ``http://localhost:6543/add_page/SomeName``, the value for
-``'pagename'`` in the ``matchdict`` will be ``'SomeName'``.
+The ``matchdict`` will have a ``'pagename'`` key that matches the name of the
+page we'd like to add. If our add view is invoked via, for example,
+``http://localhost:6543/add_page/SomeName``, the value for ``'pagename'`` in
+the ``matchdict`` will be ``'SomeName'``.
 
 If the view execution *is* a result of a form submission (i.e., the expression
-``'form.submitted' in request.params`` is ``True``), we grab the page body
-from the form data, create a Page object with this page body and the name
-taken from ``matchdict['pagename']``, and save it into the database using
-``request.dbession.add``.  Since we have not yet covered authentication we
-don't have a logged-in user to add as the page's ``creator``. Until we
-get to that point in the tutorial we'll just assume that all pages are created
-by the ``editor`` user so we query that object and set it on ``page.creator``.
+``'form.submitted' in request.params`` is ``True``), we grab the page body from
+the form data, create a Page object with this page body and the name taken from
+``matchdict['pagename']``, and save it into the database using
+``request.dbession.add``. Since we have not yet covered authentication, we
+don't have a logged-in user to add as the page's ``creator``. Until we get to
+that point in the tutorial, we'll just assume that all pages are created by the
+``editor`` user. Thus we query for that object, and set it on ``page.creator``.
 Finally, we redirect the client back to the ``view_page`` view for the newly
 created page.
 
@@ -308,6 +315,7 @@ in order to satisfy the edit form's desire to have *some* page object
 exposed as ``page``. :app:`Pyramid` will render the template associated
 with this view to a response.
 
+
 Adding templates
 ================
 
@@ -317,25 +325,28 @@ These templates will live in the ``templates`` directory of our tutorial
 package.  Jinja2 templates must have a ``.jinja2`` extension to be recognized
 as such.
 
+
 The ``layout.jinja2`` template
 ------------------------------
 
-Replace ``tutorial/templates/layout.jinja2`` with the following content:
+Update ``tutorial/templates/layout.jinja2`` with the following content, as
+indicated by the emphasized lines:
 
 .. literalinclude:: src/views/tutorial/templates/layout.jinja2
    :linenos:
    :emphasize-lines: 11,36
    :language: html
 
-Since we're using a templating engine we can factor common boilerplate out of
-our page templates into reusable components. One method for doing this
-is template inheritance via blocks.
+Since we're using a templating engine, we can factor common boilerplate out of
+our page templates into reusable components. One method for doing this is
+template inheritance via blocks.
+
+- We have defined two placeholders in the layout template where a child
+  template can override the content. These blocks are named ``subtitle`` (line
+  11) and ``content`` (line 36).
+- Please refer to the Jinja2_ documentation for more information about template
+  inheritance.
 
-- We have defined 2 placeholders in the layout template where a child template
-  can override the content. These blocks are named ``subtitle`` (line 11) and
-  ``content`` (line 36).
-- Please refer to the Jinja2_ documentation for more information about
-  template inheritance.
 
 The ``view.jinja2`` template
 ----------------------------
@@ -344,23 +355,22 @@ Create ``tutorial/templates/view.jinja2`` and add the following content:
 
 .. literalinclude:: src/views/tutorial/templates/view.jinja2
    :linenos:
-   :emphasize-lines: 1,3,6
    :language: html
 
 This template is used by ``view_page()`` for displaying a single wiki page.
-It includes:
 
-- We begin by extending the ``layout.jinja2`` template defined above
-  which provides the skeleton of the page (line 1).
-- We override the ``subtitle`` block from the base layout to insert the
-  page name of the page into the page's title (line 3).
+- We begin by extending the ``layout.jinja2`` template defined above, which
+  provides the skeleton of the page (line 1).
+- We override the ``subtitle`` block from the base layout, inserting the page
+  name into the page's title (line 3).
 - We override the ``content`` block from the base layout to insert our markup
-  into the body (line 5-18).
-- A variable that is replaced with the ``content`` value provided by the view
-  (line 6).  ``content`` contains HTML, so the ``|safe`` filter is used to
+  into the body (lines 5-18).
+- We use a variable that is replaced with the ``content`` value provided by the
+  view (line 6). ``content`` contains HTML, so the ``|safe`` filter is used to
   prevent escaping it (e.g., changing ">" to "&gt;").
-- A link that points at the "edit" URL which invokes the ``edit_page`` view for
-  the page being viewed (line 9).
+- We create a link that points at the "edit" URL, which when clicked invokes
+  the ``edit_page`` view for the requested page (line 9).
+
 
 The ``edit.jinja2`` template
 ----------------------------
@@ -369,23 +379,23 @@ Create ``tutorial/templates/edit.jinja2`` and add the following content:
 
 .. literalinclude:: src/views/tutorial/templates/edit.jinja2
    :linenos:
-   :emphasize-lines: 3,12,14,17
+   :emphasize-lines: 1,3,12,14,17
    :language: html
 
-This template serves two use-cases. It is used by ``add_page()`` and
+This template serves two use cases. It is used by ``add_page()`` and
 ``edit_page()`` for adding and editing a wiki page.  It displays a page
-containing a form that includes:
+containing a form and which provides the following:
 
-- Again, we are extending the ``layout.jinja2`` template which provides
-  the skeleton of the page (line 1).
+- Again, we extend the ``layout.jinja2`` template, which provides the skeleton
+  of the page (line 1).
 - Override the ``subtitle`` block to affect the ``<title>`` tag in the
   ``head`` of the page (line 3).
 - A 10-row by 60-column ``textarea`` field named ``body`` that is filled with
   any existing page data when it is rendered (line 14).
 - A submit button that has the name ``form.submitted`` (line 17).
+- The form POSTs back to the ``save_url`` argument supplied by the view (line
+  12). The view will use the ``body`` and ``form.submitted`` values.
 
-The form POSTs back to the ``save_url`` argument supplied by the view (line
-12).  The view will use the ``body`` and ``form.submitted`` values.
 
 The ``404.jinja2`` template
 ---------------------------
@@ -419,9 +429,9 @@ There are several important things to note about this configuration:
   ``tutorial/views/default.py`` the exception is raised which will trigger
   the view.
 
-Finally, you may delete the ``tutorial/templates/mytemplate.jinja2``
-template that was provided by the ``alchemy`` scaffold as we have created
-our own templates for the wiki.
+Finally, we may delete the ``tutorial/templates/mytemplate.jinja2`` template
+that was provided by the ``alchemy`` scaffold, as we have created our own
+templates for the wiki.
 
 .. note::
 
@@ -431,6 +441,7 @@ our own templates for the wiki.
    See :ref:`renderer_system_values` for information about other names that
    are available by default when a template is used as a renderer.
 
+
 Viewing the application in a browser
 ====================================
 
-- 
cgit v1.2.3


From 3e30040da7c2d5c38b330727b48d9f6b852956d9 Mon Sep 17 00:00:00 2001
From: Steve Piercy <web@stevepiercy.com>
Date: Sun, 28 Feb 2016 22:30:22 -0800
Subject: redirect to edit page when user attempts to add page that already
 exists - update src/*/views/default.py - update src/*/routes.py - write new
 test - revise docs, double-checking line counts and highlighting

---
 docs/tutorials/wiki2/definingviews.rst | 23 ++++++++++++++++-------
 1 file changed, 16 insertions(+), 7 deletions(-)

(limited to 'docs/tutorials/wiki2/definingviews.rst')

diff --git a/docs/tutorials/wiki2/definingviews.rst b/docs/tutorials/wiki2/definingviews.rst
index e48980dc8..b0cbe7dc4 100644
--- a/docs/tutorials/wiki2/definingviews.rst
+++ b/docs/tutorials/wiki2/definingviews.rst
@@ -124,7 +124,7 @@ edit it to look like the following:
 .. literalinclude:: src/views/tutorial/views/default.py
    :linenos:
    :language: python
-   :emphasize-lines: 1-9,12-70
+   :emphasize-lines: 1-9,12-
 
 The highlighted lines need to be added or edited.
 
@@ -277,7 +277,7 @@ The ``add_page`` view function
 Here is the code for the ``add_page`` view function and its decorator:
 
 .. literalinclude:: src/views/tutorial/views/default.py
-   :lines: 58-70
+   :lines: 58-
    :lineno-match:
    :linenos:
    :language: python
@@ -294,6 +294,10 @@ page we'd like to add. If our add view is invoked via, for example,
 ``http://localhost:6543/add_page/SomeName``, the value for ``'pagename'`` in
 the ``matchdict`` will be ``'SomeName'``.
 
+Next a check is performed to determine whether the ``Page`` already exists in
+the database. If it already exists, then the client is redirected to the
+``edit_page`` view, else we continue to the next check.
+
 If the view execution *is* a result of a form submission (i.e., the expression
 ``'form.submitted' in request.params`` is ``True``), we grab the page body from
 the form data, create a Page object with this page body and the name taken from
@@ -452,13 +456,18 @@ each of the following URLs, checking that the result is as expected:
 - http://localhost:6543/ invokes the ``view_wiki`` view.  This always
   redirects to the ``view_page`` view of the ``FrontPage`` page object.
 
-- http://localhost:6543/FrontPage invokes the ``view_page`` view of the front
-  page object.
+- http://localhost:6543/FrontPage invokes the ``view_page`` view of the
+  ``FrontPage`` page object.
+
+- http://localhost:6543/FrontPage/edit_page invokes the ``edit_page`` view for
+  the ``FrontPage`` page object.
 
-- http://localhost:6543/FrontPage/edit_page invokes the edit view for the
-  front page object.
+- http://localhost:6543/add_page/SomePageName invokes the ``add_page`` view for
+  a page. If the page already exists, then it redirects the user to the
+  ``edit_page`` view for the page object.
 
-- http://localhost:6543/add_page/SomePageName invokes the add view for a page.
+- http://localhost:6543/SomePageName/edit_page invokes the ``edit_page`` view
+  for an existing page, or generates an error if the page does not exist.
 
 - To generate an error, visit http://localhost:6543/foobars/edit_page which
   will generate a ``NoResultFound: No row was found for one()`` error. You'll
-- 
cgit v1.2.3