cherry pick from 1.5-branch

2 files changed, 210 insertions, 93 deletions

diff --git a/docs/tutorials/wiki/design.rst b/docs/tutorials/wiki/design.rst
index 28380bd66..49c30d29a 100644
--- a/docs/tutorials/wiki/design.rst
+++ b/docs/tutorials/wiki/design.rst
@@ -2,22 +2,22 @@
 Design
 ==========
 
-Following is a quick overview of our wiki application, to help
-us understand the changes that we will be doing next in our
-default files generated by the ``zodb`` scaffold.
+Following is a quick overview of the design of our wiki application, to help
+us understand the changes that we will be making as we work through the
+tutorial.
 
 Overall
 -------
 
-We choose to use ``reStructuredText`` markup in the wiki text.
-Translation from reStructuredText to HTML is provided by the
-widely used ``docutils`` Python module.  We will add this module
-in the dependency list on the project ``setup.py`` file.
+We choose to use :term:`reStructuredText` markup in the wiki text. Translation
+from reStructuredText to HTML is provided by the widely used ``docutils``
+Python module.  We will add this module in the dependency list on the project
+``setup.py`` file.
 
 Models
 ------
 
-The root resource, named *Wiki*, will be a mapping of wiki page
+The root resource named ``Wiki`` will be a mapping of wiki page
 names to page resources.  The page resources will be instances
 of a *Page* class and they store the text content.
 
@@ -29,9 +29,9 @@ To add a page to the wiki, a new instance of the page resource
 is created and its name and reference are added to the Wiki
 mapping.
 
-A page named *FrontPage* containing the text *This is the front
-page*, will be created when the storage is initialized, and will
-be used as the wiki home page.
+A page named ``FrontPage`` containing the text *This is the front page*, will
+be created when the storage is initialized, and will be used as the wiki home
+page.
 
 Views
 -----
@@ -57,14 +57,13 @@ use to do this are below.
   corresponding passwords.
 
 - GROUPS, a dictionary mapping :term:`userids <userid>` to a
-  list of groups to which they belong to.
+  list of groups to which they belong.
 
-- ``groupfinder``, an *authorization callback* that looks up
-  USERS and GROUPS.  It will be provided in a new
-  *security.py* file.
+- ``groupfinder``, an *authorization callback* that looks up USERS and
+  GROUPS.  It will be provided in a new ``security.py`` file.
 
-- An :term:`ACL` is attached to the root :term:`resource`.  Each
-  row below details an :term:`ACE`:
+- An :term:`ACL` is attached to the root :term:`resource`.  Each row below
+  details an :term:`ACE`:
 
   +----------+----------------+----------------+
   | Action   | Principal      | Permission     |
@@ -125,7 +124,7 @@ listed in the following table:
 |                      |             |                 |  authenticate.        |            |            |
 |                      |             |                 |                       |            |            |
 |                      |             |                 |  - If authentication  |            |            |
-|                      |             |                 |    successful,        |            |            |
+|                      |             |                 |    succeeds,          |            |            |
 |                      |             |                 |    redirect to the    |            |            |
 |                      |             |                 |    page that we       |            |            |
 |                      |             |                 |    came from.         |            |            |
@@ -145,6 +144,6 @@ listed in the following table:
        when there is no view name.
 .. [2] Pyramid will return a default 404 Not Found page
        if the page *PageName* does not exist yet.
-.. [3] pyramid.exceptions.Forbidden is reached when a
+.. [3] ``pyramid.exceptions.Forbidden`` is reached when a
        user tries to invoke a view that is
        not authorized by the authorization policy.
diff --git a/docs/tutorials/wiki/installation.rst b/docs/tutorials/wiki/installation.rst
index b51254b92..20df389c6 100644
--- a/docs/tutorials/wiki/installation.rst
+++ b/docs/tutorials/wiki/installation.rst
@@ -2,125 +2,218 @@
 Installation
 ============
 
-Preparation
-===========
+Before you begin
+================
 
-Follow the steps in :ref:`installing_chapter`, but name the virtualenv
-directory ``pyramidtut``.
+This tutorial assumes that you have already followed the steps in
+:ref:`installing_chapter`, except **do not create a virtualenv or install
+Pyramid**.  Thereby you will satisfy the following requirements.
 
-Preparation, UNIX
------------------
+* Python interpreter is installed on your operating system
+* :term:`setuptools` or :term:`distribute` is installed
+* :term:`virtualenv` is installed
 
+Create directory to contain the project
+---------------------------------------
 
-#. Switch to the ``pyramidtut`` directory:
+We need a workspace for our project files.
 
-   .. code-block:: text
+On UNIX
+^^^^^^^
 
-     $ cd pyramidtut
+.. code-block:: text
+
+    $ mkdir ~/pyramidtut
+
+On Windows
+^^^^^^^^^^
+
+.. code-block:: text
+
+   c:\> mkdir pyramidtut
 
-#. Install tutorial dependencies:
+Create and use a virtual Python environment
+-------------------------------------------
 
-   .. code-block:: text
+Next let's create a `virtualenv` workspace for our project.  We will
+use the `VENV` environment variable instead of the absolute path of the
+virtual environment.
 
-     $ $VENV/bin/easy_install docutils pyramid_tm pyramid_zodbconn \
-               pyramid_debugtoolbar nose coverage
+On UNIX
+^^^^^^^
 
-Preparation, Windows
---------------------
+.. code-block:: text
+
+   $ export VENV=~/pyramidtut
+   $ virtualenv $VENV
+   New python executable in /home/foo/env/bin/python
+   Installing setuptools.............done.
+
+On Windows
+^^^^^^^^^^
 
+.. code-block:: text
+
+   c:\> set VENV=c:\pyramidtut
 
-#. Switch to the ``pyramidtut`` directory:
+Versions of Python use different paths, so you will need to adjust the
+path to the command for your Python version.
 
-   .. code-block:: text
+Python 2.7:
 
-     c:\> cd pyramidtut
+.. code-block:: text
 
-#. Install tutorial dependencies:
+   c:\> c:\Python27\Scripts\virtualenv %VENV%
 
-   .. code-block:: text
+Python 3.2:
+
+.. code-block:: text
+
+   c:\> c:\Python32\Scripts\virtualenv %VENV%
+
+Install Pyramid and tutorial dependencies into the virtual Python environment
+-----------------------------------------------------------------------------
+
+On UNIX
+^^^^^^^
+
+.. code-block:: text
+
+    $ $VENV/bin/easy_install docutils pyramid_tm pyramid_zodbconn \
+            pyramid_debugtoolbar nose coverage
+
+On Windows
+^^^^^^^^^^
+
+.. code-block:: text
 
-     c:\pyramidtut> %VENV%\Scripts\easy_install docutils pyramid_tm \
-           pyramid_zodbconn pyramid_debugtoolbar nose coverage
+     c:\> %VENV%\Scripts\easy_install docutils pyramid_tm pyramid_zodbconn \
+            pyramid_debugtoolbar nose coverage
+
+Change Directory to Your Virtual Python Environment
+---------------------------------------------------
+
+Change directory to the ``pyramidtut`` directory.
+
+On UNIX
+^^^^^^^
+
+.. code-block:: text
+
+   $ cd pyramidtut
+
+On Windows
+^^^^^^^^^^
+
+.. code-block:: text
+
+   c:\> cd pyramidtut
 
 .. _making_a_project:
 
-Make a Project
-==============
+Making a project
+================
+
+Your next step is to create a project.  For this tutorial, we will use
+the :term:`scaffold` named ``zodb``, which generates an application
+that uses :term:`ZODB` and :term:`traversal`.
 
-Your next step is to create a project.  For this tutorial, we will use the
-:term:`scaffold` named ``zodb``, which generates an application
-that uses :term:`ZODB` and :term:`traversal`.  :app:`Pyramid`
-supplies a variety of scaffolds to generate sample projects.
+:app:`Pyramid` supplies a variety of scaffolds to generate sample
+projects. We will use `pcreate`—a script that comes with Pyramid to
+quickly and easily generate scaffolds, usually with a single command—to
+create the scaffold for our project.
 
-The below instructions assume your current working directory is the
-"virtualenv" named "pyramidtut".
+By passing `zodb` into the `pcreate` command, the script creates
+the files needed to use ZODB. By passing in our application name
+`tutorial`, the script inserts that application name into all the
+required files.
 
-On UNIX:
+The below instructions assume your current working directory is "pyramidtut".
+
+On UNIX
+-------
 
 .. code-block:: text
 
-  $ $VENV/bin/pcreate -s zodb tutorial
+   $ $VENV/bin/pcreate -s zodb tutorial
 
-On Windows:
+On Windows
+----------
 
 .. code-block:: text
 
    c:\pyramidtut> %VENV%\Scripts\pcreate -s zodb tutorial
 
-.. note:: You don't have to call it `tutorial` -- the code uses
-   relative paths for imports and finding templates and static
-   resources.
+.. note:: If you are using Windows, the ``zodb``
+   scaffold may not deal gracefully with installation into a
+   location that contains spaces in the path.  If you experience
+   startup problems, try putting both the virtualenv and the project
+   into directories that do not contain spaces in their paths.
 
-.. note:: If you are using Windows, the ``zodb`` scaffold
-   doesn't currently deal gracefully with installation into a location
-   that contains spaces in the path.  If you experience startup
-   problems, try putting both the virtualenv and the project into
-   directories that do not contain spaces in their paths.
+.. _installing_project_in_dev_mode_zodb:
 
-Install the Project in "Development Mode"
-=========================================
+Installing the project in development mode
+==========================================
 
 In order to do development on the project easily, you must "register"
 the project as a development egg in your workspace using the
-``setup.py develop`` command.  In order to do so, cd to the "tutorial"
+``setup.py develop`` command.  In order to do so, cd to the `tutorial`
 directory you created in :ref:`making_a_project`, and run the
-"setup.py develop" command using virtualenv Python interpreter.
+``setup.py develop`` command using the virtualenv Python interpreter.
 
-On UNIX:
+On UNIX
+-------
 
 .. code-block:: text
 
-  $ cd tutorial
-  $ $VENV/bin/python setup.py develop
+   $ cd tutorial
+   $ $VENV/bin/python setup.py develop
 
-On Windows:
+On Windows
+----------
 
 .. code-block:: text
 
-  C:\pyramidtut> cd tutorial
-  C:\pyramidtut\tutorial> %VENV%\Scripts\python setup.py develop
+   c:\pyramidtut> cd tutorial
+   c:\pyramidtut\tutorial> %VENV%\Scripts\python setup.py develop
+
+The console will show `setup.py` checking for packages and installing
+missing packages. Success executing this command will show a line like
+the following::
+
+   Finished processing dependencies for tutorial==0.0
 
 .. _running_tests:
 
-Run the Tests
+Run the tests
 =============
 
 After you've installed the project in development mode, you may run
 the tests for the project.
 
-On UNIX:
+On UNIX
+-------
 
 .. code-block:: text
 
-  $ $VENV/bin/python setup.py test -q
+   $ $VENV/bin/python setup.py test -q
 
-On Windows:
+On Windows
+----------
 
 .. code-block:: text
 
-  c:\pyramidtut\tutorial> %VENV%\Scripts\python setup.py test -q
+   c:\pyramidtut\tutorial> %VENV%\Scripts\python setup.py test -q
 
-Expose Test Coverage Information
+For a successful test run, you should see output that ends like this::
+
+  .
+  ----------------------------------------------------------------------
+  Ran 1 test in 0.094s
+ 
+  OK
+
+Expose test coverage information
 ================================
 
 You can run the ``nosetests`` command to see test coverage
@@ -129,48 +222,73 @@ test`` does but provides additional "coverage" information, exposing
 which lines of your project are "covered" (or not covered) by the
 tests.
 
-On UNIX:
+On UNIX
+-------
 
 .. code-block:: text
 
-  $ $VENV/bin/nosetests --cover-package=tutorial --cover-erase --with-coverage
+   $ $VENV/bin/nosetests --cover-package=tutorial --cover-erase --with-coverage
 
-On Windows:
+On Windows
+----------
 
 .. code-block:: text
 
-  c:\pyramidtut\tutorial> %VENV%\Scripts\nosetests --cover-package=tutorial ^
-       --cover-erase --with-coverage
+   c:\pyramidtut\tutorial> %VENV%\Scripts\nosetests --cover-package=tutorial \
+         --cover-erase --with-coverage
+
+If successful, you will see output something like this::
 
-Looks like the code in the ``zodb`` scaffold for ZODB projects is
-missing some test coverage, particularly in the file named
-``models.py``.
+    .
+    Name                 Stmts   Miss  Cover   Missing
+    --------------------------------------------------
+    tutorial.py             12      7    42%   7-8, 14-18
+    tutorial/models.py      10      6    40%   9-14
+    tutorial/views.py        4      0   100%   
+    --------------------------------------------------
+    TOTAL                   26     13    50%   
+    ----------------------------------------------------------------------
+    Ran 1 test in 0.392s
+
+    OK
+
+Looks like our package doesn't quite have 100% test coverage.
 
 .. _wiki-start-the-application:
 
-Start the Application
+Start the application
 =====================
 
 Start the application.
 
-On UNIX:
+On UNIX
+-------
 
 .. code-block:: text
 
-  $ $VENV/bin/pserve development.ini --reload
+   $ $VENV/bin/pserve development.ini --reload
 
-On Windows:
+On Windows
+----------
 
 .. code-block:: text
 
-  c:\pyramidtut\tutorial> %VENV%\Scripts\pserve development.ini --reload
+   c:\pyramidtut\tutorial> %VENV%\Scripts\pserve development.ini --reload
 
 .. note::
 
    Your OS firewall, if any, may pop up a dialog asking for authorization
    to allow python to accept incoming network connections.
 
-Visit the Application in a Browser
+If successful, you will see something like this on your console::
+
+    Starting subprocess with file monitor
+    Starting server in PID 95736.
+    serving on http://0.0.0.0:6543
+
+This means the server is ready to accept requests.
+
+Visit the application in a browser
 ==================================
 
 In a browser, visit `http://localhost:6543/ <http://localhost:6543>`_.  You
@@ -181,7 +299,7 @@ page.  You can read more about the purpose of the icon at
 :ref:`debug_toolbar`.  It allows you to get information about your
 application while you develop.
 
-Decisions the ``zodb`` Scaffold Has Made For You
+Decisions the ``zodb`` scaffold has made for you
 ================================================
 
 Creating a project using the ``zodb`` scaffold makes the following
@@ -189,11 +307,11 @@ assumptions:
 
 - you are willing to use :term:`ZODB` as persistent storage
 
-- you are willing to use :term:`traversal` to map URLs to code.
+- you are willing to use :term:`traversal` to map URLs to code
 
 .. note::
 
    :app:`Pyramid` supports any persistent storage mechanism (e.g., a SQL
-   database or filesystem files).  :app:`Pyramid` also supports an additional
+   database or filesystem files).  It also supports an additional
    mechanism to map URLs to code (:term:`URL dispatch`).  However, for the
    purposes of this tutorial, we'll only be using traversal and ZODB.