diff options
Diffstat (limited to 'docs/tutorials/bfgwiki')
| -rw-r--r-- | docs/tutorials/bfgwiki/authorization.rst | 40 | ||||
| -rw-r--r-- | docs/tutorials/bfgwiki/basiclayout.rst | 5 | ||||
| -rw-r--r-- | docs/tutorials/bfgwiki/definingmodels.rst | 8 | ||||
| -rw-r--r-- | docs/tutorials/bfgwiki/distributing.rst | 50 |
4 files changed, 26 insertions, 77 deletions
diff --git a/docs/tutorials/bfgwiki/authorization.rst b/docs/tutorials/bfgwiki/authorization.rst index 52e7cc528..13443ca53 100644 --- a/docs/tutorials/bfgwiki/authorization.rst +++ b/docs/tutorials/bfgwiki/authorization.rst @@ -209,33 +209,29 @@ Viewing the Application in a Browser We can finally examine our application in a browser. The views we'll try are as follows: -- Visiting `http://localhost:6543/ <http://localhost:6543/>`_ in a - browser invokes the ``view_wiki`` view. This always redirects to - the ``view_page`` view of the FrontPage page object. It is - executable by any user. - -- Visiting `http://localhost:6543/FrontPage/ - <http://localhost:6543/FrontPage/>`_ in a browser invokes the - ``view_page`` view of the front page page object. This is because - it's the :term:`default view` (a view without a ``name``) for - ``Page`` objects. It is executable by any user. - -- Visiting `http://localhost:6543/FrontPage/edit_page - <http://localhost:6543/FrontPage/edit_page>`_ in a browser invokes - the edit view for the front page object. It is executable by only +- Visiting ``http://localhost:6543/`` in a browser invokes the + ``view_wiki`` view. This always redirects to the ``view_page`` view + of the FrontPage page object. It is executable by any user. + +- Visiting ``http://localhost:6543/FrontPage/`` in a browser invokes + the ``view_page`` view of the front page page object. This is + because it's the :term:`default view` (a view without a ``name``) + for ``Page`` objects. It is executable by any user. + +- Visiting ``http://localhost:6543/FrontPage/edit_page`` in a browser + invokes the edit view for the front page object. It is executable + by only the ``editor`` user. If a different user (or the anonymous + user) invokes it, a login form will be displayed. Supplying the + credentials with the username ``editor``, password ``editor`` will + show the edit page form being displayed. + +- Visiting ``http://localhost:6543/add_page/SomePageName`` in a + browser invokes the add view for a page. It is executable by only the ``editor`` user. If a different user (or the anonymous user) invokes it, a login form will be displayed. Supplying the credentials with the username ``editor``, password ``editor`` will show the edit page form being displayed. -- Visiting `http://localhost:6543/add_page/SomePageName - <http://localhost:6543/add_page/SomePageName>`_ in a browser invokes - the add view for a page. It is executable by only the ``editor`` - user. If a different user (or the anonymous user) invokes it, a - login form will be displayed. Supplying the credentials with the - username ``editor``, password ``editor`` will show the edit page - form being displayed. - Seeing Our Changes To ``views.py`` and our Templates ---------------------------------------------------- diff --git a/docs/tutorials/bfgwiki/basiclayout.rst b/docs/tutorials/bfgwiki/basiclayout.rst index f0b7d963c..5934799b9 100644 --- a/docs/tutorials/bfgwiki/basiclayout.rst +++ b/docs/tutorials/bfgwiki/basiclayout.rst @@ -110,9 +110,8 @@ function within the file named ``run.py``: (something like ``file:///path/to/Data.fs``). #. *Line 14*. We create a "finder" object using the - ``repoze.zodbconn.finder.PersistentApplicationFinder`` helper - class, passing it the ZODB URI and the "appmaker" we've imported - from ``models.py``. + ``PersistentApplicationFinder`` helper class, passing it the ZODB + URI and the "appmaker" we've imported from ``models.py``. #. *Lines 15 - 16*. We create a :term:`root factory` which uses the finder to return a ZODB root object. diff --git a/docs/tutorials/bfgwiki/definingmodels.rst b/docs/tutorials/bfgwiki/definingmodels.rst index ef5798362..effbaa4bf 100644 --- a/docs/tutorials/bfgwiki/definingmodels.rst +++ b/docs/tutorials/bfgwiki/definingmodels.rst @@ -71,10 +71,10 @@ Add an Appmaker --------------- We're using a mini-framework callable named -``repoze.zodbconn.finder.PersistentApplicationFinder`` in our -application (see ``run.py``). A ``PersistentApplicationFinder`` -accepts a ZODB URL as well as an "appmaker" callback. This callback -typically lives in the ``models.py`` file. +``PersistentApplicationFinder`` in our application (see ``run.py``). +A ``PersistentApplicationFinder`` accepts a ZODB URL as well as an +"appmaker" callback. This callback typically lives in the +``models.py`` file. We want to change the appmaker function in our ``models.py`` file so that our application root is a Wiki instance, and we'll also slot a diff --git a/docs/tutorials/bfgwiki/distributing.rst b/docs/tutorials/bfgwiki/distributing.rst index 06d126a64..3ed84a892 100644 --- a/docs/tutorials/bfgwiki/distributing.rst +++ b/docs/tutorials/bfgwiki/distributing.rst @@ -6,7 +6,7 @@ Once your application works properly, you can create a "tarball" from it by using the ``setup.py sdist`` command. The following commands assume your current working directory is the ``tutorial`` package we've created and that the parent directory of the ``tutorial`` -package is a virtualenv representing a BFG environment. +package is a virtualenv representing a :mod:`repoze.bfg` environment. On UNIX: @@ -32,53 +32,7 @@ The output of such a command will be something like: .. code-block:: text running sdist - running egg_info - writing requirements to tutorial.egg-info/requires.txt - writing tutorial.egg-info/PKG-INFO - writing top-level names to tutorial.egg-info/top_level.txt - writing dependency_links to tutorial.egg-info/dependency_links.txt - writing entry points to tutorial.egg-info/entry_points.txt - writing manifest file 'tutorial.egg-info/SOURCES.txt' - warning: sdist: missing required meta-data: url - warning: sdist: missing meta-data: either (author and author_email) or (maintainer and maintainer_email) must be supplied - creating tutorial-0.1 - creating tutorial-0.1/tutorial - creating tutorial-0.1/tutorial.egg-info - creating tutorial-0.1/tutorial/templates - creating tutorial-0.1/tutorial/templates/static - creating tutorial-0.1/tutorial/templates/static/images - making hard links in tutorial-0.1... - hard linking CHANGES.txt -> tutorial-0.1 - hard linking README.txt -> tutorial-0.1 - hard linking setup.cfg -> tutorial-0.1 - hard linking setup.py -> tutorial-0.1 - hard linking tutorial.ini -> tutorial-0.1 - hard linking tutorial/__init__.py -> tutorial-0.1/tutorial - hard linking tutorial/configure.zcml -> tutorial-0.1/tutorial - hard linking tutorial/models.py -> tutorial-0.1/tutorial - hard linking tutorial/run.py -> tutorial-0.1/tutorial - hard linking tutorial/tests.py -> tutorial-0.1/tutorial - hard linking tutorial/views.py -> tutorial-0.1/tutorial - hard linking tutorial.egg-info/PKG-INFO -> tutorial-0.1/tutorial.egg-info - hard linking tutorial.egg-info/SOURCES.txt -> tutorial-0.1/tutorial.egg-info - hard linking tutorial.egg-info/dependency_links.txt -> tutorial-0.1/tutorial.egg-info - hard linking tutorial.egg-info/entry_points.txt -> tutorial-0.1/tutorial.egg-info - hard linking tutorial.egg-info/not-zip-safe -> tutorial-0.1/tutorial.egg-info - hard linking tutorial.egg-info/requires.txt -> tutorial-0.1/tutorial.egg-info - hard linking tutorial.egg-info/top_level.txt -> tutorial-0.1/tutorial.egg-info - hard linking tutorial/templates/edit.pt -> tutorial-0.1/tutorial/templates - hard linking tutorial/templates/mytemplate.pt -> tutorial-0.1/tutorial/templates - hard linking tutorial/templates/view.pt -> tutorial-0.1/tutorial/templates - hard linking tutorial/templates/static/default.css -> tutorial-0.1/tutorial/templates/static - hard linking tutorial/templates/static/style.css -> tutorial-0.1/tutorial/templates/static - hard linking tutorial/templates/static/templatelicense.txt -> tutorial-0.1/tutorial/templates/static - hard linking tutorial/templates/static/images/img01.gif -> tutorial-0.1/tutorial/templates/static/images - hard linking tutorial/templates/static/images/img02.gif -> tutorial-0.1/tutorial/templates/static/images - hard linking tutorial/templates/static/images/img03.gif -> tutorial-0.1/tutorial/templates/static/images - hard linking tutorial/templates/static/images/img04.gif -> tutorial-0.1/tutorial/templates/static/images - hard linking tutorial/templates/static/images/spacer.gif -> tutorial-0.1/tutorial/templates/static/images - copying setup.cfg -> tutorial-0.1 - Writing tutorial-0.1/setup.cfg + # .. more output .. creating dist tar -cf dist/tutorial-0.1.tar tutorial-0.1 gzip -f9 dist/tutorial-0.1.tar |