diff options
Diffstat (limited to 'docs/tutorials/bfgwiki/basiclayout.rst')
| -rw-r--r-- | docs/tutorials/bfgwiki/basiclayout.rst | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/docs/tutorials/bfgwiki/basiclayout.rst b/docs/tutorials/bfgwiki/basiclayout.rst index bbfab7247..2649a345f 100644 --- a/docs/tutorials/bfgwiki/basiclayout.rst +++ b/docs/tutorials/bfgwiki/basiclayout.rst @@ -2,13 +2,14 @@ Basic Layout ============ -The starter files generated by the ``bfg_zodb`` template are basic, +The starter files generated by the ``pyramid_zodb`` template are basic, but they provide a good orientation for the high-level patterns common -to most :term:`traversal` -based :mod:`repoze.bfg` (and :term:`ZODB` +to most :term:`traversal` -based :mod:`pyramid` (and :term:`ZODB` based) projects. -The source code for this tutorial stage can be browsed at -`docs.repoze.org <http://docs.repoze.org/bfgwiki-1.3/basiclayout>`_. +The source code for this tutorial stage can be browsed via +`http://github.com/Pylons/pyramid/tree/master/docs/tutorials/wiki/src/basiclayout/ +<http://github.com/Pylons/pyramid/tree/master/docs/tutorials/wiki/src/basiclayout/>`_. ``__init__.py`` --------------- @@ -20,7 +21,7 @@ directory as a Python package. Configuration With ``configure.zcml`` -------------------------------------- -The ``bfg_zodb`` template uses :term:`ZCML` to perform system +The ``pyramid_zodb`` template uses :term:`ZCML` to perform system configuration. The ZCML file generated by the template looks like the following: @@ -28,14 +29,13 @@ following: :linenos: :language: xml -#. *Line 1*. The root ``<configure>`` element, in a ``bfg`` - namespace. +#. *Line 1*. The root ``<configure>`` element. #. *Line 4*. Boilerplate, the comment explains. #. *Lines 6-10*. Register a ``<view>`` that names a ``context`` type that is a class. ``.views.my_view`` is a *function* we write - (generated by the ``bfg_zodb`` template) that is given a + (generated by the ``pyramid_zodb`` template) that is given a ``context`` object and a ``request`` and which returns a dictionary. The ``renderer`` tag indicates that the ``templates/mytemplate.pt`` template should be used to turn the @@ -60,11 +60,11 @@ following: Content Models with ``models.py`` --------------------------------- -:mod:`repoze.bfg` often uses the word :term:`model` when talking about +:mod:`pyramid` often uses the word :term:`model` when talking about content resources arranged in the hierarchical *object graph* consulted by :term:`traversal`. The ``models.py`` file is where the -``bfg_zodb`` Paster template put the classes that implement our model -objects. +``pyramid_zodb`` Paster template put the classes that implement our +model objects. Here is the source for ``models.py``: @@ -83,7 +83,7 @@ Here is the source for ``models.py``: #. *Lines 6-12*. ``appmaker`` is used to return the *application root* object. It is called on *every request* to the - :mod:`repoze.bfg` application. It also performs bootstrapping by + :mod:`pyramid` application. It also performs bootstrapping by *creating* an application root (inside the ZODB root object) if one does not already exist. @@ -125,13 +125,13 @@ function within the file named ``run.py``: factory is named ``get_root``. #. *Lines 19-21*. Begin configuration using the ``begin`` method of - the :meth:`repoze.bfg.configuration.Configurator` class, load the + the :meth:`pyramid.configuration.Configurator` class, load the ``configure.zcml`` file from our package using the - :meth:`repoze.bfg.configuration.Configurator.load_zcml` method, and + :meth:`pyramid.configuration.Configurator.load_zcml` method, and end configuration using the - :meth:`repoze.bfg.configuration.Configurator.end` method. + :meth:`pyramid.configuration.Configurator.end` method. #. *Line 22*. Use the - :meth:`repoze.bfg.configuration.Configurator.make_wsgi_app` method + :meth:`pyramid.configuration.Configurator.make_wsgi_app` method to return a :term:`WSGI` application. |