diff options
| author | Chris McDonough <chrism@agendaless.com> | 2008-09-21 22:53:15 +0000 |
|---|---|---|
| committer | Chris McDonough <chrism@agendaless.com> | 2008-09-21 22:53:15 +0000 |
| commit | 8fd58c42615b12585b903c1132d71eac30073774 (patch) | |
| tree | 1ba20da7eb1bdef649a0d0b3779932787be3c2c5 /docs | |
| parent | 1f25cd571cd2dceb576dcbe3504450e38745df21 (diff) | |
| download | pyramid-8fd58c42615b12585b903c1132d71eac30073774.tar.gz pyramid-8fd58c42615b12585b903c1132d71eac30073774.tar.bz2 pyramid-8fd58c42615b12585b903c1132d71eac30073774.zip | |
Add workflow chapter, fix renderings.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/glossary.rst | 12 | ||||
| -rw-r--r-- | docs/index.rst | 9 | ||||
| -rw-r--r-- | docs/tutorials/cmf/actions.rst | 7 | ||||
| -rw-r--r-- | docs/tutorials/cmf/index.rst | 4 | ||||
| -rw-r--r-- | docs/tutorials/cmf/workflow.rst | 14 |
5 files changed, 34 insertions, 12 deletions
diff --git a/docs/glossary.rst b/docs/glossary.rst index 7a6c0f3a9..51eb8c2fa 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -165,11 +165,11 @@ Glossary that your application be served as a WSGI application. Middleware *Middleware* is a :term:`WSGI` concept. It is a WSGI component - that acts both as a server and an application. Interesting uses - for middleware exist, such as caching, content-transport - encoding, and other functions. See `WSGI.org <http://wsgi.org>`_ - or `PyPI <http://python.org/pypi>`_ to find middleware for your - application. + that acts both as a server and an application. Interesting uses + for middleware exist, such as caching, content-transport + encoding, and other functions. See `WSGI.org <http://wsgi.org>`_ + or `PyPI <http://python.org/pypi>`_ to find middleware for your + application. Pipeline The :term:`Paste` term for a single configuration of a WSGI server, a WSGI application, with a set of middleware in-between. @@ -279,7 +279,7 @@ Glossary ``repoze.bfg.interfaces.IRequest``. When a user writes view code, and registers a view without specifying a particular request type, the view is assumed to be registered for requests that have - ``repoze.bfg.interfaces.IRequest` attached to them. However if + ``repoze.bfg.interfaces.IRequest`` attached to them. However if the view is registered with a different interface as its request type, the view will be invoked only when the request possesses that particular interface. Application code can cause requests to diff --git a/docs/index.rst b/docs/index.rst index 5362b9681..9f9f9cdf5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -40,13 +40,20 @@ Narrative documentation in chapter form explaining how to use Tutorials ========= -Step-by-step sample applications that use :mod:`repoze.bfg`. +Step-by-step tutorials which demonstrate how you might use +:mod:`repoze.bfg`. .. toctree:: :maxdepth: 3 tutorials/lxmlgraph/index.rst +.. toctree:: + :maxdepth: 3 + + tutorials/cmf/index.rst + + API documentation ================= diff --git a/docs/tutorials/cmf/actions.rst b/docs/tutorials/cmf/actions.rst index 7e66f3236..3703db770 100644 --- a/docs/tutorials/cmf/actions.rst +++ b/docs/tutorials/cmf/actions.rst @@ -17,9 +17,10 @@ which has keys that are action names, and values which are tuples of have some passable actions tool replacement within a single application. The `repoze.bfg.viewgroup -<http://svn.repoze.org/repoze.bfg.viewgroup/trunk/>` package provides +<http://svn.repoze.org/repoze.bfg.viewgroup/trunk/>`_ package provides some functionality for creating "view groups". Each view in a viewgroup can provide some snippet of HTML (e.g. a single "tab"), and -views (tabs) which cannot be displayed to the user due to the user's -lack of permissions will be omitted from the group. +individual views (tabs) within the group which cannot be displayed to +the user due to the user's lack of permissions will be omitted from +the rendered output. diff --git a/docs/tutorials/cmf/index.rst b/docs/tutorials/cmf/index.rst index 09223138c..9b1168be9 100644 --- a/docs/tutorials/cmf/index.rst +++ b/docs/tutorials/cmf/index.rst @@ -25,11 +25,10 @@ because CMF happens to provide other helpful services, such as types, skins, and workflow; this tutorial is for those sorts of developers and projects. -Missing: +XXX Missing: templates.rst forms.rst - workflow.rst membership.rst discussions.rst syndication.rst @@ -42,5 +41,6 @@ Missing: catalog.rst skins.rst actions.rst + workflow.rst diff --git a/docs/tutorials/cmf/workflow.rst b/docs/tutorials/cmf/workflow.rst new file mode 100644 index 000000000..251ce3fc4 --- /dev/null +++ b/docs/tutorials/cmf/workflow.rst @@ -0,0 +1,14 @@ +.. _workflow_chapter: + +======== +Workflow +======== + +In CMF, the "workflow tool" allows developers to design state machines +which imply transition between content states. + +:mod:`repoze.bfg` itself has no such concept, but the +:term:`repoze.lemonade` packge provides a simple persistent state +machine implementation that can act as a barebones workflow tool. See +its documentation for more information. + |
