[Checkins] SVN: z3c.wizard/trunk/ - fixed typos
Michael Howitz
mh at gocept.com
Thu Jul 9 15:18:14 EDT 2009
Log message for revision 101774:
- fixed typos
- added zcml.txt to the long_descr
- added table of contents to long_desc
Changed:
U z3c.wizard/trunk/CHANGES.txt
U z3c.wizard/trunk/setup.py
U z3c.wizard/trunk/src/z3c/wizard/README.txt
U z3c.wizard/trunk/src/z3c/wizard/zcml.txt
-=-
Modified: z3c.wizard/trunk/CHANGES.txt
===================================================================
--- z3c.wizard/trunk/CHANGES.txt 2009-07-09 19:17:00 UTC (rev 101773)
+++ z3c.wizard/trunk/CHANGES.txt 2009-07-09 19:18:14 UTC (rev 101774)
@@ -8,6 +8,8 @@
- Remove dependency on z3c.i18n as it wasn't really used and we can
easily recreate a message factory for the "z3c" domain.
+- Fixed tests to work with z3c.form 2.0.
+
- Changed package's mailing list address to zope-dev at zope.org instead
of the retired zope3-dev one.
Modified: z3c.wizard/trunk/setup.py
===================================================================
--- z3c.wizard/trunk/setup.py 2009-07-09 19:17:00 UTC (rev 101773)
+++ z3c.wizard/trunk/setup.py 2009-07-09 19:18:14 UTC (rev 101774)
@@ -29,12 +29,11 @@
description = "Wizard based on z3c.form for for Zope3",
long_description=(
read('README.txt')
- + '\n\n' +
- 'Detailed Documentation\n'
- '**********************\n'
- + '\n\n' +
+ + '\n\n.. contents::\n\n' +
read('src', 'z3c', 'wizard', 'README.txt')
+ '\n\n' +
+ read('src', 'z3c', 'wizard', 'zcml.txt')
+ + '\n\n' +
read('CHANGES.txt')
),
license = "ZPL 2.1",
Modified: z3c.wizard/trunk/src/z3c/wizard/README.txt
===================================================================
--- z3c.wizard/trunk/src/z3c/wizard/README.txt 2009-07-09 19:17:00 UTC (rev 101773)
+++ z3c.wizard/trunk/src/z3c/wizard/README.txt 2009-07-09 19:18:14 UTC (rev 101774)
@@ -4,18 +4,19 @@
The goal of this package is to offer a form wizard. This implementation doesn't
use a session. It just offers the wizard logic, the data which the wizard will
-changes or add is not a part of this implementation. If you liek to implement
+changes or adds is not a part of this implementation. If you like to implement
some add wizard logic you probably need to use a session anf collect the values
-in the different wizard steps and create and add an object in the wizard
-doComplete or doFinish or the step doComplete method.
+in the different wizard steps and create and add an object in the wizard's
+``doComplete`` or ``doFinish`` or the step's ``doComplete`` method.
-All steps are available by it's own url. This allows us to cache each step if
+All steps are available by their own url. This allows us to cache each step if
needed. Each step url is only available if we are allowed to access a step. If
a step is accessible depends on the conditions of each step.
-Since steps are adapters, we can register steps for already existing wizards
-or we can also ovreride existing steps by register a UnavailableStep step which
-always will return False for the ``available`` argument.
+Since steps are adapters, we can register steps for already existing
+wizards or we can also override existing steps by registering a
+UnavailableStep step which always will return ``False`` for the
+``available`` argument.
If the wizard is completed we get redirected to the confirmation page. If we
access a completed wizard again, we will get redirected to the confirmation
@@ -32,8 +33,8 @@
>>> from z3c.form.testing import setupFormDefaults
>>> setupFormDefaults()
-And load the formui confguration, which will make sure that all macros get
-registered correctly.
+And load the formui configuration, which will make sure that all macros get
+registered correctly:
>>> from zope.configuration import xmlconfig
>>> import zope.component
@@ -95,7 +96,7 @@
----
Let's define some steps. First use a step which knows how to store the name
-of a person.
+of a person:
>>> from z3c.form import form
>>> from z3c.form import field
@@ -116,7 +117,7 @@
------
Now we can define our ``Wizard`` including our steps. Steps are named
-adapters. Let's use the global method addStep for doing the step setup:
+adapters. Let's use the global method ``addStep`` for doing the step setup:
>>> from z3c.wizard import wizard
>>> class IPersonWizard(z3c.wizard.interfaces.IWizard):
@@ -134,8 +135,8 @@
... step.addStep(self, 'address', weight=2),
... ]
-As next, we need to register our steps as named IStep adapters. This can be
-done by the z3c:wizardStep directive. Let's define our adapters with the
+As next, we need to register our steps as named ``IStep`` adapters. This can be
+done by the ``z3c:wizardStep`` directive. Let's define our adapters with the
provideAdapter method for now:
>>> import zope.interface
@@ -151,7 +152,7 @@
... z3c.wizard.interfaces.IStep, name='address')
We need to support the div form layer for our request. This is needed for the
-form part we usein our steps. Because our steps are forms:
+form part we use in our steps. Because our steps are forms:
>>> from z3c.formui.interfaces import IDivFormLayer
>>> from zope.interface import alsoProvides
@@ -161,7 +162,7 @@
Now we can use our wizard. Our wizard will allways force to traverse to the
current active step. This means the wizard provides a browserDefault which
-returns the default step instead of render the wizard as view. This allows us
+returns the default step instead of rendering the wizard as view. This allows us
to use the step as an adapter discriminator for viewlets and other adapters
like the menu implementation uses. The wizard acts like a dispatcher to the
right step and not as a view itself.
@@ -179,7 +180,7 @@
>>> names
('person',)
-Now traverse to the step, update and render them:
+Now traverse to the step, update and render it:
>>> personStep = obj.publishTraverse(request, names[0])
>>> personStep.update()
@@ -308,7 +309,7 @@
>>> addressStep
<AddressStep 'address'>
-Update and render them:
+Update and render it:
>>> addressStep.update()
>>> print addressStep.render()
Modified: z3c.wizard/trunk/src/z3c/wizard/zcml.txt
===================================================================
--- z3c.wizard/trunk/src/z3c/wizard/zcml.txt 2009-07-09 19:17:00 UTC (rev 101773)
+++ z3c.wizard/trunk/src/z3c/wizard/zcml.txt 2009-07-09 19:18:14 UTC (rev 101774)
@@ -2,8 +2,8 @@
Wizard and Step directive
=========================
-Show how we can use the wizard and wizardStep directives. Register the meta
-configuration for the directive.
+Show how we can use the ``wizard`` and ``wizardStep``
+directives. Register the meta configuration for the directive.
>>> import sys
>>> from zope.configuration import xmlconfig
@@ -16,10 +16,10 @@
>>> class MyWizard(z3c.wizard.wizard.Wizard):
... """Custom wizard"""
-Make them available under the fake package ``custom``:
+Make them available under the fake package `custom`:
>>> sys.modules['custom'] = type(
- ... 'Module', (),
+ ... 'Module', (),
... {'MyWizard': MyWizard})()
Register a wizard within the directive with minimal attributes:
@@ -35,13 +35,13 @@
... </configure>
... """, context)
-Now define a step:
+Now define a step,
>>> import z3c.wizard
>>> class FirstStep(z3c.wizard.step.Step):
... """First step"""
-register the new step classes in the custom module...
+register the new step classes in the custom module
>>> sys.modules['custom'].FirstStep = FirstStep
@@ -63,10 +63,10 @@
>>> import zope.component
>>> from zope.publisher.browser import TestRequest
- >>> wizard = zope.component.queryMultiAdapter((object(), TestRequest()),
+ >>> wizard = zope.component.queryMultiAdapter((object(), TestRequest()),
... name='wizard')
-and check them:
+and check it:
>>> wizard
<MyWizard u'wizard'>
@@ -81,7 +81,7 @@
>>> firstStep = zope.component.queryMultiAdapter(
... (object(), TestRequest(), wizard), name='first')
-and check them
+and check it
>>> firstStep
<FirstStep u'first'>
@@ -98,6 +98,6 @@
>>> z3c.wizard.interfaces.IWizard.providedBy(firstStep.wizard)
True
-Clean up the custom module.
+Clean up the custom module:
>>> del sys.modules['custom']
More information about the Checkins
mailing list