[Checkins] SVN: z3c.form/branches/pcardune-sphinx/ minor edits to
easily cross reference sections of the documentation and to
generate a module index.
Paul Carduner
paulcarduner at gmail.com
Thu Apr 24 02:47:14 EDT 2008
Log message for revision 85687:
minor edits to easily cross reference sections of the documentation and to generate a module index.
Changed:
U z3c.form/branches/pcardune-sphinx/index.txt
U z3c.form/branches/pcardune-sphinx/src/z3c/form/README.txt
U z3c.form/branches/pcardune-sphinx/src/z3c/form/action.txt
U z3c.form/branches/pcardune-sphinx/src/z3c/form/adding.txt
U z3c.form/branches/pcardune-sphinx/src/z3c/form/browser/README.txt
U z3c.form/branches/pcardune-sphinx/src/z3c/form/button.txt
U z3c.form/branches/pcardune-sphinx/src/z3c/form/converter.txt
U z3c.form/branches/pcardune-sphinx/src/z3c/form/datamanager.txt
U z3c.form/branches/pcardune-sphinx/src/z3c/form/error.txt
U z3c.form/branches/pcardune-sphinx/src/z3c/form/field.txt
U z3c.form/branches/pcardune-sphinx/src/z3c/form/form.txt
U z3c.form/branches/pcardune-sphinx/src/z3c/form/group.txt
U z3c.form/branches/pcardune-sphinx/src/z3c/form/subform.txt
U z3c.form/branches/pcardune-sphinx/src/z3c/form/term.txt
U z3c.form/branches/pcardune-sphinx/src/z3c/form/util.txt
U z3c.form/branches/pcardune-sphinx/src/z3c/form/validator.txt
U z3c.form/branches/pcardune-sphinx/src/z3c/form/value.txt
U z3c.form/branches/pcardune-sphinx/src/z3c/form/widget.txt
U z3c.form/branches/pcardune-sphinx/src/z3c/form/zcml.txt
-=-
Modified: z3c.form/branches/pcardune-sphinx/index.txt
===================================================================
--- z3c.form/branches/pcardune-sphinx/index.txt 2008-04-24 06:06:49 UTC (rev 85686)
+++ z3c.form/branches/pcardune-sphinx/index.txt 2008-04-24 06:47:13 UTC (rev 85687)
@@ -27,6 +27,7 @@
src/z3c/form/value
src/z3c/form/widget
src/z3c/form/zcml
+ src/z3c/form/browser/README
Indices and tables
Modified: z3c.form/branches/pcardune-sphinx/src/z3c/form/README.txt
===================================================================
--- z3c.form/branches/pcardune-sphinx/src/z3c/form/README.txt 2008-04-24 06:06:49 UTC (rev 85686)
+++ z3c.form/branches/pcardune-sphinx/src/z3c/form/README.txt 2008-04-24 06:47:13 UTC (rev 85687)
@@ -1,87 +1,97 @@
-=================
-Forms and Widgets
-=================
+========
+Overview
+========
-This package provides an implementation for HTML forms and widgets. The goal
-is to provide a simple API but with the ability to easily customize any data or
-steps. This document, provides the content of this package's documentation
-files. The documents are ordered in the way they should be read:
+This package provides an implementation for HTML forms and
+widgets. The goal is to provide a simple API but with the ability to
+easily customize any data or steps. Below is an overview of this
+package's documentation. The documents are ordered in the way they
+should be read:
-- ``form.txt`` [must read]
+Must Read
+---------
+- :ref:`form.txt`
+
Describes the setup and usage of forms in the most common usages. Some
details are provided to the structure of form components.
-- ``group.txt`` [must read]
+- :ref:`group.txt`
This document describes how widget groups are implemented within this
package and how they can be used.
-- ``subform.txt`` [must read]
+- :ref:`subform.txt`
Introduces the complexities surrounding sub-forms and details two classes of
sub-forms, including code examples.
-- ``field.txt`` [must read]
+- :ref:`field.txt`
Provides a comprehensive explanation of the field manager API and how it is
to be used.
-- ``button.txt`` [must read]
+- :ref:`button.txt`
Provides a comprehensive explanation of the button manager API. It also
outlines how to create buttons within schemas and how buttons are converted
to actions.
-- ``zcml.txt`` [must read]
+- :ref:`zcml.txt`
Explains the ZCML directives defines by this package, which are designed to
make it easier to register new templates without writing Python code.
-- ``validator.txt`` [advanced users]
+Advanced Users
+--------------
+- :ref:`validator.txt`
+
Validators are used to validate converted form data. This document provides
a comprehensive overview of the API and how to use it effectively.
-- ``widget.txt`` [advanced users]
+- :ref:`widget.txt`
Explains in detail the design goals surrounding widgets and widget managers
and how they were realized with the implemented API.
-- ``action.txt`` [advanced users]
+- :ref:`action.txt`
Explains in detail the design goals surrounding action managers and
actions. The execution of actions using action handlers is also covered. The
document demonstrates how actions can be created without the use of buttons.
-- ``value.txt`` [informative]
+Informative
+-----------
+- :ref:`value.txt`
+
The concept of attribute value adapters is introduced and fully
explained. Some motivation for this new and powerful pattern is given as
well.
-- ``datamanager.txt`` [informative]
+- :ref:`datamanager.txt`
Data managers are resposnsible for accessing and writing the data. While
attribute access is the most common case, data managers can also manage
other data structures, such as dictionaries.
-- ``converter.txt`` [informative]
+- :ref:`converter.txt`
Data converters convert data between internal and widget values and vice
versa.
-- ``term.txt`` [informative]
+- :ref:`term.txt`
Terms are wrappers around sources and vocabularies to provide a common
interface for choices in this package.
-- ``util.txt`` [informative]
+- :ref:`util.txt`
The ``util`` module provides several helper functions and classes. The
components not tested otherwise are explained in this file.
-- ``adding.txt`` [informative]
+- :ref:`adding.txt`
This module provides a base class for add forms that work with the
``IAdding`` interface.
@@ -93,12 +103,14 @@
There are several documentation files in the ``browser/`` sub-package. They
mainly document the basic widgets provided by the package.
-- ``README.txt`` [advanced users]
+Advanced Users
+--------------
+- :ref:`browserREADME.txt`
+
This file contains a checklist, ensuring that all fields have a widget.
- ``<fieldname>.txt``
Each field name documentation file comprehensively explains the widget and
how it is ensured to work properly.
-
Modified: z3c.form/branches/pcardune-sphinx/src/z3c/form/action.txt
===================================================================
--- z3c.form/branches/pcardune-sphinx/src/z3c/form/action.txt 2008-04-24 06:06:49 UTC (rev 85686)
+++ z3c.form/branches/pcardune-sphinx/src/z3c/form/action.txt 2008-04-24 06:47:13 UTC (rev 85687)
@@ -1,3 +1,5 @@
+.. _action.txt:
+
===============
Action Managers
===============
@@ -2,2 +4,5 @@
+.. module:: z3c.form.action
+ :synopsis: Managing and executing form actions.
+
Action managers are components that manage all actions that can be taken
Modified: z3c.form/branches/pcardune-sphinx/src/z3c/form/adding.txt
===================================================================
--- z3c.form/branches/pcardune-sphinx/src/z3c/form/adding.txt 2008-04-24 06:06:49 UTC (rev 85686)
+++ z3c.form/branches/pcardune-sphinx/src/z3c/form/adding.txt 2008-04-24 06:47:13 UTC (rev 85687)
@@ -1,3 +1,5 @@
+.. _adding.txt:
+
=========================
Add Forms for ``IAdding``
=========================
@@ -2,2 +4,5 @@
+.. module:: z3c.form.adding
+ :synopsis: Supporting IAdding, but only if you have to.
+
While using ``IAdding``-based add forms is strongly discouraged by this
Modified: z3c.form/branches/pcardune-sphinx/src/z3c/form/browser/README.txt
===================================================================
--- z3c.form/branches/pcardune-sphinx/src/z3c/form/browser/README.txt 2008-04-24 06:06:49 UTC (rev 85686)
+++ z3c.form/branches/pcardune-sphinx/src/z3c/form/browser/README.txt 2008-04-24 06:47:13 UTC (rev 85687)
@@ -1,3 +1,5 @@
+.. _browserREADME.txt:
+
======
README
======
Modified: z3c.form/branches/pcardune-sphinx/src/z3c/form/button.txt
===================================================================
--- z3c.form/branches/pcardune-sphinx/src/z3c/form/button.txt 2008-04-24 06:06:49 UTC (rev 85686)
+++ z3c.form/branches/pcardune-sphinx/src/z3c/form/button.txt 2008-04-24 06:47:13 UTC (rev 85687)
@@ -1,3 +1,5 @@
+.. _button.txt:
+
=======
Buttons
=======
@@ -2,2 +4,6 @@
+.. module:: z3c.form.button
+ :synopsis: Representing actionable form buttons.
+
+
Buttons are a method to declare actions for a form. Like fields describe
Modified: z3c.form/branches/pcardune-sphinx/src/z3c/form/converter.txt
===================================================================
--- z3c.form/branches/pcardune-sphinx/src/z3c/form/converter.txt 2008-04-24 06:06:49 UTC (rev 85686)
+++ z3c.form/branches/pcardune-sphinx/src/z3c/form/converter.txt 2008-04-24 06:47:13 UTC (rev 85687)
@@ -1,3 +1,5 @@
+.. _converter.txt:
+
==============
Data Converter
==============
@@ -2,2 +4,6 @@
+.. module:: z3c.form.converter
+ :synopsis: Converting data between external widgets and internal
+ python data structures
+
The data converter is the component that converts an internal data value as
Modified: z3c.form/branches/pcardune-sphinx/src/z3c/form/datamanager.txt
===================================================================
--- z3c.form/branches/pcardune-sphinx/src/z3c/form/datamanager.txt 2008-04-24 06:06:49 UTC (rev 85686)
+++ z3c.form/branches/pcardune-sphinx/src/z3c/form/datamanager.txt 2008-04-24 06:47:13 UTC (rev 85687)
@@ -1,3 +1,5 @@
+.. _datamanager.txt:
+
=============
Data Managers
=============
@@ -2,2 +4,5 @@
+.. module:: z3c.form.datamanager
+ :synopsis: Abstraction for getting and setting data.
+
For the longest time the way widgets retrieved and stored their values on the
Modified: z3c.form/branches/pcardune-sphinx/src/z3c/form/error.txt
===================================================================
--- z3c.form/branches/pcardune-sphinx/src/z3c/form/error.txt 2008-04-24 06:06:49 UTC (rev 85686)
+++ z3c.form/branches/pcardune-sphinx/src/z3c/form/error.txt 2008-04-24 06:47:13 UTC (rev 85687)
@@ -2,6 +2,9 @@
Error Views
===========
+.. module:: z3c.form.error
+ :synopsis: Error message handling and customization.
+
Error views are looked up every time a validation error occurs during data
extraction and/or validation. Unfortunately, it was often hard to adjust error
messages based on specific situations. The error view implementation in this
Modified: z3c.form/branches/pcardune-sphinx/src/z3c/form/field.txt
===================================================================
--- z3c.form/branches/pcardune-sphinx/src/z3c/form/field.txt 2008-04-24 06:06:49 UTC (rev 85686)
+++ z3c.form/branches/pcardune-sphinx/src/z3c/form/field.txt 2008-04-24 06:47:13 UTC (rev 85687)
@@ -1,3 +1,5 @@
+.. _field.txt:
+
==============
Field Managers
==============
@@ -2,2 +4,5 @@
+.. module:: z3c.form.field
+ :synopsis: Defining form fields from schemas.
+
One of the features in ``zope.formlib`` that works really well is the syntax
Modified: z3c.form/branches/pcardune-sphinx/src/z3c/form/form.txt
===================================================================
--- z3c.form/branches/pcardune-sphinx/src/z3c/form/form.txt 2008-04-24 06:06:49 UTC (rev 85686)
+++ z3c.form/branches/pcardune-sphinx/src/z3c/form/form.txt 2008-04-24 06:47:13 UTC (rev 85687)
@@ -1,3 +1,5 @@
+.. _form.txt:
+
=====
Forms
=====
@@ -2,2 +4,5 @@
+.. module:: z3c.form.form
+ :synopsis: Common form patterns for real-world use cases.
+
The purpose of this package is to make development of forms as simple
Modified: z3c.form/branches/pcardune-sphinx/src/z3c/form/group.txt
===================================================================
--- z3c.form/branches/pcardune-sphinx/src/z3c/form/group.txt 2008-04-24 06:06:49 UTC (rev 85686)
+++ z3c.form/branches/pcardune-sphinx/src/z3c/form/group.txt 2008-04-24 06:47:13 UTC (rev 85687)
@@ -1,3 +1,5 @@
+.. _group.txt:
+
===========
Group Forms
===========
@@ -2,2 +4,5 @@
+.. module:: z3c.form.group
+ :synopsis: Grouping form fields into logical units.
+
Group forms allow you to split up a form into several logical units without
Modified: z3c.form/branches/pcardune-sphinx/src/z3c/form/subform.txt
===================================================================
--- z3c.form/branches/pcardune-sphinx/src/z3c/form/subform.txt 2008-04-24 06:06:49 UTC (rev 85686)
+++ z3c.form/branches/pcardune-sphinx/src/z3c/form/subform.txt 2008-04-24 06:47:13 UTC (rev 85687)
@@ -1,3 +1,5 @@
+.. _subform.txt:
+
=========
Sub-Forms
=========
@@ -2,2 +4,5 @@
+.. module:: z3c.form.subform
+ :synopsis: Support for forms within forms.
+
Traditionally, the Zope community talks about sub-forms in a generic manner
Modified: z3c.form/branches/pcardune-sphinx/src/z3c/form/term.txt
===================================================================
--- z3c.form/branches/pcardune-sphinx/src/z3c/form/term.txt 2008-04-24 06:06:49 UTC (rev 85686)
+++ z3c.form/branches/pcardune-sphinx/src/z3c/form/term.txt 2008-04-24 06:47:13 UTC (rev 85687)
@@ -1,3 +1,5 @@
+.. _term.txt:
+
=====
Terms
=====
@@ -2,2 +4,5 @@
+.. module:: z3c.form.term
+ :synopsis: Providing choices for sequene widgets.
+
Terms are used to provide choices for sequence widgets or any other construct
Modified: z3c.form/branches/pcardune-sphinx/src/z3c/form/util.txt
===================================================================
--- z3c.form/branches/pcardune-sphinx/src/z3c/form/util.txt 2008-04-24 06:06:49 UTC (rev 85686)
+++ z3c.form/branches/pcardune-sphinx/src/z3c/form/util.txt 2008-04-24 06:47:13 UTC (rev 85687)
@@ -1,3 +1,5 @@
+.. _util.txt:
+
=============================
Utility Functions and Classes
=============================
@@ -2,2 +4,5 @@
+.. module:: z3c.form.util
+ :synopsis: Utility functions and classes.
+
This file documents the utility functions and classes that are otherwise not
Modified: z3c.form/branches/pcardune-sphinx/src/z3c/form/validator.txt
===================================================================
--- z3c.form/branches/pcardune-sphinx/src/z3c/form/validator.txt 2008-04-24 06:06:49 UTC (rev 85686)
+++ z3c.form/branches/pcardune-sphinx/src/z3c/form/validator.txt 2008-04-24 06:47:13 UTC (rev 85687)
@@ -1,3 +1,5 @@
+.. _validator.txt:
+
==========
Validators
==========
@@ -2,2 +4,5 @@
+.. module:: z3c.form.validator
+ :synopsis: Validating form input.
+
Validators are components that validate submitted data. This is certainly not
Modified: z3c.form/branches/pcardune-sphinx/src/z3c/form/value.txt
===================================================================
--- z3c.form/branches/pcardune-sphinx/src/z3c/form/value.txt 2008-04-24 06:06:49 UTC (rev 85686)
+++ z3c.form/branches/pcardune-sphinx/src/z3c/form/value.txt 2008-04-24 06:47:13 UTC (rev 85687)
@@ -1,3 +1,5 @@
+.. _value.txt:
+
========================
Attribute Value Adapters
========================
@@ -2,2 +4,5 @@
+.. module:: z3c.form.value
+ :synopsis: Highly customizable form properties with adapter lookups.
+
In advanced, highly customized projects it is often the case that a property
Modified: z3c.form/branches/pcardune-sphinx/src/z3c/form/widget.txt
===================================================================
--- z3c.form/branches/pcardune-sphinx/src/z3c/form/widget.txt 2008-04-24 06:06:49 UTC (rev 85686)
+++ z3c.form/branches/pcardune-sphinx/src/z3c/form/widget.txt 2008-04-24 06:47:13 UTC (rev 85687)
@@ -1,3 +1,5 @@
+.. _widget.txt:
+
=======
Widgets
=======
@@ -2,2 +4,5 @@
+.. module:: z3c.form.widget
+ :synopsis: UI components for user input.
+
Widgets are small UI components that accept and process the textual user
Modified: z3c.form/branches/pcardune-sphinx/src/z3c/form/zcml.txt
===================================================================
--- z3c.form/branches/pcardune-sphinx/src/z3c/form/zcml.txt 2008-04-24 06:06:49 UTC (rev 85686)
+++ z3c.form/branches/pcardune-sphinx/src/z3c/form/zcml.txt 2008-04-24 06:47:13 UTC (rev 85687)
@@ -1,3 +1,5 @@
+.. _zcml.txt:
+
==========
Directives
==========
@@ -2,2 +4,5 @@
+.. module:: z3c.form.zcml
+ :synopsis: ZCML directives for use with z3c.form.
+
Widget template directive
More information about the Checkins
mailing list