1.1 --- a/XSLForms/Fields.py Sat Jul 16 20:59:05 2005 +0000
1.2 +++ b/XSLForms/Fields.py Sat Jul 16 20:59:14 2005 +0000
1.3 @@ -2,33 +2,52 @@
1.4 # -*- coding: iso-8859-1 -*-
1.5
1.6 """
1.7 -Classes which process field collections, producing instance
1.8 -documents. Each field entry consists of a field name mapped
1.9 -to a string value, where the field name may have the following
1.10 -formats:
1.11 +Interpretation of field collections from sources such as HTTP request parameter
1.12 +dictionaries.
1.13 +
1.14 +Copyright (C) 2005 Paul Boddie <paul@boddie.org.uk>
1.15 +
1.16 +This library is free software; you can redistribute it and/or
1.17 +modify it under the terms of the GNU Lesser General Public
1.18 +License as published by the Free Software Foundation; either
1.19 +version 2.1 of the License, or (at your option) any later version.
1.20 +
1.21 +This library is distributed in the hope that it will be useful,
1.22 +but WITHOUT ANY WARRANTY; without even the implied warranty of
1.23 +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
1.24 +Lesser General Public License for more details.
1.25 +
1.26 +You should have received a copy of the GNU Lesser General Public
1.27 +License along with this library; if not, write to the Free Software
1.28 +Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
1.29 +
1.30 +--------
1.31 +
1.32 +Classes which process field collections, producing instance documents. Each
1.33 +field entry consists of a field name mapped to a string value, where the field
1.34 +name may have the following formats:
1.35
1.36 /name1#n1/name2
1.37 /name1#n1/name2#n2/name3
1.38 /name1#n1/name2#n2/name3#n3/name4
1.39 ...
1.40
1.41 -The indexes n1, n2, n3, ... indicate the position of elements
1.42 -(starting from 1) in the entire element list, whose elements
1.43 -may have different names. For example:
1.44 +The indexes n1, n2, n3, ... indicate the position of elements (starting from 1)
1.45 +in the entire element list, whose elements may have different names. For
1.46 +example:
1.47
1.48 /zoo#1/name
1.49 /zoo#1/cage#1/name
1.50 /zoo#1/cage#2/name
1.51 /zoo#1/funding#3/contributor#1/name
1.52
1.53 -Where multiple values can be collected for a given field, the
1.54 -following notation is employed:
1.55 +Where multiple values can be collected for a given field, the following notation
1.56 +is employed:
1.57
1.58 /package#1/categories#1/category##value
1.59
1.60 -Some fields may contain the "=" string. This string is
1.61 -reserved and all text following it is meant to specify a path
1.62 -into a particular document. For example:
1.63 +Some fields may contain the "=" string. This string is reserved and all text
1.64 +following it is meant to specify a path into a particular document. For example:
1.65
1.66 _action_add_animal=/zoo#1/cage#2
1.67 """