From 1de5ec90e0ecb81ee1f4c4ade0b11c2cc8cf646a Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Tue, 19 Jan 2010 03:34:51 +0000 Subject: Spellcheck. --- docs/authorintro.rst | 2 +- docs/glossary.rst | 2 +- docs/latexindex.rst | 2 +- docs/narr/configuration.rst | 2 +- docs/narr/firstapp.rst | 2 +- docs/narr/hybrid.rst | 4 +- docs/narr/models.rst | 4 +- docs/narr/templates.rst | 2 +- docs/narr/traversal.rst | 8 ++-- docs/narr/urldispatch.rst | 2 +- docs/narr/views.rst | 6 +-- docs/narr/zca.rst | 2 +- docs/zcml.rst | 2 +- docs/zcml/repozewho1authenticatiohnpolicy.rst | 53 --------------------------- docs/zcml/repozewho1authenticationpolicy.rst | 53 +++++++++++++++++++++++++++ 15 files changed, 73 insertions(+), 73 deletions(-) delete mode 100644 docs/zcml/repozewho1authenticatiohnpolicy.rst create mode 100644 docs/zcml/repozewho1authenticationpolicy.rst diff --git a/docs/authorintro.rst b/docs/authorintro.rst index eb8dbec24..5a4a225f9 100644 --- a/docs/authorintro.rst +++ b/docs/authorintro.rst @@ -96,7 +96,7 @@ The Genesis of :mod:`repoze.bfg` I wrote :mod:`repoze.bfg` after many years of writing applications using :term:`Zope`. Zope provided me with a lot of mileage: it wasn't -until almost a decade of succesfully creating applications using it +until almost a decade of successfully creating applications using it that I decided to write a different web framework. Although :mod:`repoze.bfg` takes inspiration from a variety of web frameworks, it owes more of its core design to Zope than any other. diff --git a/docs/glossary.rst b/docs/glossary.rst index b8ac383e3..87e1a2d38 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -495,7 +495,7 @@ Glossary serialization format. renderer - A serializer that can be referrred to via :term:`view + A serializer that can be referred to via :term:`view configuration` which converts a non-:term:`Response` return values from a :term:`view` into a string (and ultimately a response). Using a renderer can make writing views that require diff --git a/docs/latexindex.rst b/docs/latexindex.rst index bfdfb3899..45438e939 100644 --- a/docs/latexindex.rst +++ b/docs/latexindex.rst @@ -116,7 +116,7 @@ ZCML Directive Reference zcml/notfound zcml/remoteuserauthenticationpolicy zcml/renderer - zcml/repozewho1authenticatiohnpolicy + zcml/repozewho1authenticationpolicy zcml/resource zcml/route zcml/scan diff --git a/docs/narr/configuration.rst b/docs/narr/configuration.rst index 435ec7a83..66ecd486c 100644 --- a/docs/narr/configuration.rst +++ b/docs/narr/configuration.rst @@ -187,7 +187,7 @@ filesystem. Let's take a look at that ``configure.zcml`` file again: Note that this file contains some XML, and that the XML contains a ```` :term:`configuration declaration` tag that references a :term:`dotted Python name`. This dotted name refers to the -``hello_world`` function that lives in our ``helloword`` Python +``hello_world`` function that lives in our ``helloworld`` Python module. This ```` declaration tag performs the same function as the diff --git a/docs/narr/firstapp.rst b/docs/narr/firstapp.rst index 138e92706..00628f08c 100644 --- a/docs/narr/firstapp.rst +++ b/docs/narr/firstapp.rst @@ -246,7 +246,7 @@ learn in later chapters what a :term:`view name` is, and under which circumstances a request will have a view name that is the empty string; in this particular application, it means that the ``hello_world`` view callable will be invoked when the root URL ``/`` -is visted by a browser. +is visited by a browser. The line ``config.add_view(goodbye_world, name='goodbye')`` registers the ``goodbye_world`` function as a view callable. The line calls diff --git a/docs/narr/hybrid.rst b/docs/narr/hybrid.rst index 7d4768cf6..350b6acc9 100644 --- a/docs/narr/hybrid.rst +++ b/docs/narr/hybrid.rst @@ -124,7 +124,7 @@ The ``.views.foobar`` view callable above will be called when the URL Hybrid Applications ------------------- -Clearl *either* traversal or url dispatch can be used to create a +Clearly *either* traversal or url dispatch can be used to create a :mod:`repoze.bfg` application. However, it is possible to combine the competing concepts of traversal and url dispatch to resolve URLs to code within the same application. @@ -347,7 +347,7 @@ callables that match a route use the very weakly binding ``None`` value as the context value's interface. Given how :term:`view lookup` works, if the context that is found has a specific interface, and a global view configuration statement is registered using this interface -as its ``context``, it's likely that the *global* view calable will +as its ``context``, it's likely that the *global* view callable will match *before* the view callable that is attached to the route. This behavior can be subverted if the ``view_context`` attribute is used on the route registration, because then both the request type and the diff --git a/docs/narr/models.rst b/docs/narr/models.rst index c85db63bf..2964ccb20 100644 --- a/docs/narr/models.rst +++ b/docs/narr/models.rst @@ -9,7 +9,7 @@ omnipresent in :mod:`repoze.bfg`: willing to walk over when :term:`traversal` is used. - The ``context`` and ``containment`` arguments to - :meth:`repoze.bfg.configuration.Configurator.add_vew` often + :meth:`repoze.bfg.configuration.Configurator.add_view` often reference a model class. - A :term:`root factory` returns a model instance. @@ -55,7 +55,7 @@ Defining a Model Constructor ---------------------------- An example of a model constructor, ``BlogEntry`` is presented below. -It is implemente as a class which, when instantiated, becomes a model +It is implemented as a class which, when instantiated, becomes a model instance. .. code-block:: python diff --git a/docs/narr/templates.rst b/docs/narr/templates.rst index c073d201f..3cd5e8f15 100644 --- a/docs/narr/templates.rst +++ b/docs/narr/templates.rst @@ -424,7 +424,7 @@ which renders this template: def my_view(request): return {'name':'world'} -When the template is renderered, it will show: +When the template is rendered, it will show: .. code-block:: text diff --git a/docs/narr/traversal.rst b/docs/narr/traversal.rst index 2388aa7f3..ef3803b13 100644 --- a/docs/narr/traversal.rst +++ b/docs/narr/traversal.rst @@ -92,7 +92,7 @@ query string elements or fragment element. For example the Traversal treats the ``PATH_INFO`` segment of a URL as a sequence of path segments. For example, the ``PATH_INFO`` string ``/a/b/c`` is -coverted to the sequence ``['a', 'b', 'c']``. +converted to the sequence ``['a', 'b', 'c']``. After the path info is converted, a lookup is performed against the object graph for each path segment. Each lookup uses the @@ -105,7 +105,7 @@ For example, if the path info sequence is ``['a', 'b', 'c']``: ``__getitem__`` method using that value (``a``) as an argument; we'll presume it succeeds. -- When the root object's ``__getitem__`` succeeeds it will return an +- When the root object's ``__getitem__`` succeeds it will return an object, which we'll call "A". The :term:`context` temporarily becomes the "A" object. @@ -518,7 +518,7 @@ expected to return a response. ``context`` attribute of the request object, e.g. ``request.context``. The :term:`view name` is available as the ``view_name`` attribute of the request object, - e.g. ``request.view_name``. Other :mod:`repoze.bfg` -speficic + e.g. ``request.view_name``. Other :mod:`repoze.bfg` -specific request attributes are also available as described in :ref:`special_request_attributes`. @@ -536,5 +536,5 @@ deal with traversal, such as traversal invocation from within application code. The :func:`repoze.bfg.url.model_url` function generates a URL when -given an object retrived from an object graph. +given an object retrieved from an object graph. diff --git a/docs/narr/urldispatch.rst b/docs/narr/urldispatch.rst index d7e3a17fb..05c04e03f 100644 --- a/docs/narr/urldispatch.rst +++ b/docs/narr/urldispatch.rst @@ -48,7 +48,7 @@ If route configuration is present in an application, the :mod:`repoze.bfg` :term:`Router` checks every incoming request against an ordered set of URL matching patterns present in a *route map*. -If any route patern matches the information in the :term:`request` +If any route pattern matches the information in the :term:`request` provided to :mod:`repoze.bfg`, a route-specific :term:`context` and :term:`view name` will be generated. In this circumstance, :mod:`repoze.bfg` will shortcut :term:`traversal`, and will invoke diff --git a/docs/narr/views.rst b/docs/narr/views.rst index 4ee66d709..368b09737 100644 --- a/docs/narr/views.rst +++ b/docs/narr/views.rst @@ -11,7 +11,7 @@ a request made to your application. .. note:: - A :mod:`repoze.bfg` :term:`view callable` is oten referred to in + A :mod:`repoze.bfg` :term:`view callable` is often referred to in conversational shorthand as a :term:`view`. In this documentation, however, we need to use less ambiguous terminology because there are significant differences between view *configuration*, the code @@ -758,7 +758,7 @@ renderer factory, use: factory="repoze.bfg.chameleon_zpt.renderer_factory"/> After you do this, :mod:`repoze.bfg` will treat templates ending in -both the ``.pt`` and ``.zpt`` filename extensions as Chameleon ZTP +both the ``.pt`` and ``.zpt`` filename extensions as Chameleon ZPT templates. To override the default mapping in which files with a ``.pt`` @@ -1025,7 +1025,7 @@ arguments. Many arguments supplied during view configuration are :term:`view predicate` arguments. View predicate arguments used during view configuration are used to narrow the set of circumstances in which -:mod:`view lookup` will find a partcular view callable. In general, +:mod:`view lookup` will find a particular view callable. In general, the fewer number of predicates which are supplied to a particular view configuration, the more likely it is that the associated view callable will be invoked. A greater the number supplied, the less likely. diff --git a/docs/narr/zca.rst b/docs/narr/zca.rst index 2fe6109d7..2fbdcd873 100644 --- a/docs/narr/zca.rst +++ b/docs/narr/zca.rst @@ -111,7 +111,7 @@ ZCA "global" API functions such as ``zope.component.getSiteManager``, component registry has a method API that offers the same functionality; it can be used instead. For example, presuming the ``registry`` value below is a Zope Component Architecture component -registry, the folllowing bit of code is equivalent to +registry, the following bit of code is equivalent to ``zope.component.getUtility(IFoo)``: .. code-block:: python diff --git a/docs/zcml.rst b/docs/zcml.rst index ba40f5072..1c2f69146 100644 --- a/docs/zcml.rst +++ b/docs/zcml.rst @@ -17,7 +17,7 @@ directive documentation is organized alphabetically by directive name. zcml/notfound zcml/remoteuserauthenticationpolicy zcml/renderer - zcml/repozewho1authenticatiohnpolicy + zcml/repozewho1authenticationpolicy zcml/resource zcml/route zcml/scan diff --git a/docs/zcml/repozewho1authenticatiohnpolicy.rst b/docs/zcml/repozewho1authenticatiohnpolicy.rst deleted file mode 100644 index 62713e822..000000000 --- a/docs/zcml/repozewho1authenticatiohnpolicy.rst +++ /dev/null @@ -1,53 +0,0 @@ -.. _repozewho1authenticationpolicy_directive: - -``repozewho1authenticationpolicy`` ----------------------------------- - -When this directive is used, authentication information is obtained -from a ``repoze.who.identity`` key in the WSGI environment, assumed to -be set by :term:`repoze.who` middleware. - -Attributes -~~~~~~~~~~ - -``identifier_name`` - The ``identifier_name`` controls the name used to look up the - :term:`repoze.who` "identifier" plugin within - ``request.environ['repoze.who.plugins']`` which is used by this - policy to "remember" and "forget" credentials. It defaults to - ``auth_tkt``. - -``callback`` - The ``callback`` is a Python dotted name to a function passed the - repoze.who identity and the request as positional arguments. The - callback is expected to return None if the user represented by the - identity doesn't exist or a sequence of group identifiers - (possibly empty) if the user does exist. If ``callback`` is None, - the userid will be assumed to exist with no groups. It defaults - to ``None``. - -Example -~~~~~~~ - -.. code-block:: xml - :linenos: - - - -Alternatives -~~~~~~~~~~~~ - -You may create an instance of the -:class:`repoze.bfg.authentication.RepozeWho1AuthenticationPolicy` and -pass it to the :class:`repoze.bfg.configuration.Configurator` -constructor as the ``authentication_policy`` argument during initial -application configuration. - -See Also -~~~~~~~~ - -See also :ref:`authentication_policies_directives_section` and -:class:`repoze.bfg.authentication.RepozeWho1AuthenticationPolicy`. diff --git a/docs/zcml/repozewho1authenticationpolicy.rst b/docs/zcml/repozewho1authenticationpolicy.rst new file mode 100644 index 000000000..62713e822 --- /dev/null +++ b/docs/zcml/repozewho1authenticationpolicy.rst @@ -0,0 +1,53 @@ +.. _repozewho1authenticationpolicy_directive: + +``repozewho1authenticationpolicy`` +---------------------------------- + +When this directive is used, authentication information is obtained +from a ``repoze.who.identity`` key in the WSGI environment, assumed to +be set by :term:`repoze.who` middleware. + +Attributes +~~~~~~~~~~ + +``identifier_name`` + The ``identifier_name`` controls the name used to look up the + :term:`repoze.who` "identifier" plugin within + ``request.environ['repoze.who.plugins']`` which is used by this + policy to "remember" and "forget" credentials. It defaults to + ``auth_tkt``. + +``callback`` + The ``callback`` is a Python dotted name to a function passed the + repoze.who identity and the request as positional arguments. The + callback is expected to return None if the user represented by the + identity doesn't exist or a sequence of group identifiers + (possibly empty) if the user does exist. If ``callback`` is None, + the userid will be assumed to exist with no groups. It defaults + to ``None``. + +Example +~~~~~~~ + +.. code-block:: xml + :linenos: + + + +Alternatives +~~~~~~~~~~~~ + +You may create an instance of the +:class:`repoze.bfg.authentication.RepozeWho1AuthenticationPolicy` and +pass it to the :class:`repoze.bfg.configuration.Configurator` +constructor as the ``authentication_policy`` argument during initial +application configuration. + +See Also +~~~~~~~~ + +See also :ref:`authentication_policies_directives_section` and +:class:`repoze.bfg.authentication.RepozeWho1AuthenticationPolicy`. -- cgit v1.2.3