Zope Quick Reference

Version 0.8


Brian Hooper

David Kankiewicz

Evelyn Mitchell

Stephan Richter

 

Index


DTML
Syntax
variable names
Tags
_ (special namespace variable)
Zope-defined Web request variables
CGI-defined Web request variables
Document Templates
Default Document Source
structured Text
XML Document

Object Reference
Zope Objects and Methods

Object Reference
Common methods
DTML Document methods
DTML Method
DTML Method
ZSQL Method
External Method
File
Folder
Image
Mail Host
Object Manager
P SQL Input Wizard
Product
User Folder
Version
Version Management
ZCatalog
ZClass
Zope Draft (depreciated, Broken 1.x)
Zope Factory
DateTime
Find

Zope General Information
Security Measures
Undo Section
Find Interface
Control Panel
Versions
Product Management
Add


DTML

Syntax

Tag
Zope 2.x only

Entity-reference syntax (equivalent to )
<dtml-tagname attribute1="value1" attribute2="value2" ...> </dtml-tagname>

Tag
Zope 1.x (deprecated)


<!--#tag-name attribute1="value1" attribute2="value2" ... -->

Python String Format
Zope 1.x (deprecated)


%(tag-name attribute1="value1" attribute2="value2")s

variable names

object ids
All versions

[a-zA-Z0-9-_~\,\. ] Object ids can include letters, numbers, or any of the characters dash (-), underscore (_), tilde (~), comma (,), period (.), or space ( ). Object ids may not begin with an underscore. Object ids must be unique with respect to their containing object (i.e., within a Folder 'foo', there can only one object with the id 'bar') and must also not conflict with property ids of the container (in the above example, Folder 'foo' cannot have a property 'bar' if it contains an object called 'bar'). If the variable name could be interpreted as a python expression, (in particular, if the name contains '-' or '.') when used in the 'expr' attribute of a DTML tag it can only be referenced using the namespace variable, i.e.: <dtml-if expr="_['sequence-length' ] > 20">

property ids
all versions

Property ids can contain any printable characters other than space ( ). Property ids, like object ids, may not begin with an underscore. Property ids must be unique with respect to their containing object; for example, Folder 'foo' can only have one property 'color' (Note: insert info here about property types)

Tags

General

Describes general and global functionalities of DTML tags.
name
(may be omitted) - the name of the variable data, caches the value name="input_name" input_name
capitalize
The first letter of the inserted text should be capitalized.
expr
Syntax is that of Python.


expr="age > 18"
"age < 18"
x*2+3
func(a,b)
obj.title
obj.meth(a,b)
(age < 12 or age > 65) and status == 'student'
REQUEST['HTTP_REFERER' ] - gets the HTTP_REFERER

var

Substitutes variable data into text.

Zope automatically defines the DTML methods standard_html_header and standard_html_footer. They define the usual HTML things, like the header and the body tag. To incorporate them into your DTML/HTML Document or Method you need to use the var tag as follows: <dtml-var standard_html_header>
Note: When you create a DTML Document or Method the standard_html_header and standard_html_footer are automatically inserted for you. They currently use the old way: <!--#var standard_html_header>

Another good example, that makes use of the 'fmt' attribute is displaying the current time in Zope. Again, Zope has a predefined object called 'ZopeTime' that will return a the output of DateTime.now() which is a DateTime object (not a string). Let's say you want to just display the date and not the time. You can do this with a predefined 'Date-Time format' or use the common 'strftime syntax'. Here are both ways of doing this: <dtml-var ZopeTime fmt=date> or <dtml-var ZopeTime fmt="%m/%d/%Y">

name=arg
See general tag.
expr=arg
See general tag.
fmt=arg
The choices are between specifying a special, custom or C-style format.
special
whole-dollars
Show a numeric value with a dollar symbol.
dollars-and-cents
Show a numeric value with a dollar symbol and two decimal places.
collection-length
Show the length of a collection of objects.
structured-text
Show the name or expr as Structured Text (see the Structured Text section for details).
Date-time
AMPM
Return the time string for an object to the nearest second.
AMPMMinutes
Return the time string for an object not showing seconds.
aCommon
Return the time string for an object not showing seconds.
aCommonZ
Return the time string for an object not showing seconds.
aDay
Return the time string for an object not showing seconds.
aMonth
Return the time string for an object not showing seconds.
ampm
Return the appropriate time modifier (am or pm).
Date
Return the date string for the object.
Day
Return the full name of the day of the week.
DayOfWeek
Compatibility: see Day.
day
Return the integer day.
dayOfYear
Return the day of the year, in context of the time-zone representation of the object.
dd
Return day as a 2 digit string.
fCommon
Return a string representing the object's value with the format: March 1, 1997 1:45 pm.
fCommonZ
Return a string representing the object's value with the format: March 1, 1997 1:45 pm US/Eastern.
h_12
Return the 12-hour clock representation of the hour.
h_24
Return the 24-hour clock representation of the hour.
hour
Return the 24-hour clock representation of the hour.
isCurrentHour
Return true if this object represents a date/time that falls within the current hour, in the context of this object's time-zone representation.
isCurrentMonth
Return true if this object represents a date/time that falls within the current month, in the context of this object's time-zone representation.
isFuture
Return true if this object represents a date/time later than the time of the call.
isLeapYear
Return true if the current year (in the context of the object's time zone) is a leap year.
isPast
Return true if this object represents a date/time earlier than the time of the call.
Mon_
Return the full month name.
Mon
Compatibility: see aMonth.
Month
Return the full month name.
minute
Return the minute.
mm
Return month as a 2 digit string.
month
Return the month of the object as an integer.
notEqualTo(t)
Compare this DateTime object to another DateTime object OR a floating point number, such as that which is returned by the python time module. Returns true if the object represents a date/time not equal to the specified DateTime or time module style time.
PreciseAMPM
Return the time string for the object.
PreciseTime
Return the time string for the object.
pCommon
Return a string representing the object's value with the format: Mar. 1, 1997 1:45 pm.
pCommonZ
Return a string representing the object's value with the format: Mar. 1, 1997 1:45 pm US/Eastern.
pDay
Return the abbreviated (with period) name of the day of the week.
pMonth
Return the abbreviated (with period) month name.
rfc822
Return the date in RFC 822 format.
second
Return the second.
TimeMinutes
Return the time string for an object not showing seconds.
Time
Return the time string for an object to the nearest second.
timezone
Return the time zone in which the object is represented.
year
Return the calendar year of the object
yy
Return calendar year as a 2 digit string.
strftime-style
%a
Locale's abbreviated weekday name.
%A
Locale's full weekday name.
%b
Locale's abbreviated month name.
%B
Locale's full month name.
%c
Locale's appropriate date and time representation.
%d
Day of the month as a decimal number [01,31].
%H
Hour (24-hour clock) as a decimal number [00,23].
%I
Hour (12-hour clock) as a decimal number [01,12].
%j
Day of the year as a decimal number [001,366].
%m
Month as a decimal number [01,12].
%M
Minute as a decimal number [00,59].
%p
Locale's equivalent of either AM or PM.
%S
Second as a decimal number [00,61].
%U
Week number of the year (Sunday as the first day of the week) as a decimal number [00,53]. All days in a new year preceding the first Sunday are considered to be in week 0.
%w
Weekday as a decimal number [0(Sunday),6].
%W
Week number of the year (Monday as the first day of the week) as a decimal number [00,53]. All days in a new year preceding the first Sunday are considered to be in week 0.
%x
Locale's appropriate date representation.
%X
Locale's appropriate time representation.
%y
Year without century as a decimal number [00,99].
%Y
Year with century as a decimal number.
%Z
Time zone name (or by no characters if no time zone exists).
%%
%
C-style
d
Signed decimal integer.
e
Scientific notation.
E
Scientific Notation (upper case E).
f
Decimal floating point.
g
Shorter of e or f.
G
Shorter of E or F.
I
Signed decimal integers.
o
Unsigned octal.
s
String of characters.
u
Unsigned decimal integers.
x
Unsigned hexadecimal lowercase.
X
Unsigned hexadecimal uppercase.
null=arg
Specifies what should be displayed in case of a NULL (None) value.
<dtml-var cost fmt="$%.2d" null='n/a'>
lower
Cause all upper-case letters to be converted to lower case.
upper
Cause all lower-case letters to be converted to upper case.
capitalize
Cause the first character of the inserted value to be converted to upper-case.
spacify
Cause underscores in the inserted value to be converted to spaces.
thousands_commas
Cause commas to be inserted every three digits to the left of a decimal point in values containing numbers (i.e., "12000 widgets" becomes "12,000 widgets").
html_quote
Convert characters that have special meaning in HTML to HTML character entities.
url_quote
Convert characters that have special meaning in URLs to HTML character entities using decimal values.
sql_quote
Convert single quotes to pairs of single quotes. This is needed to safely include values in SQL strings.
newline_to_br
Convert newlines and carriage-return and newline combinations to break tags.
size=arg
Truncates a string argument at the given length (Note: if a space occurs in the second half of the truncated string, then the string is further truncated to the right-most space).
etc=arg
Specifies a string to add to the end of a string which has been truncated (by setting the size= attribute listed above). By default, this is '...' For example, if spam is the string 'red yellow green', then
<dtml-var spam size=10 etc=", etc.">
will produce the output
red yellow, etc.

if [elif]* [else] /if

Allows you to do Programming level logic.
<dtml-if argument>
(block)
<dtml-elif argument>
(block)
<dtml-else>
(block)
</dtml-if>

Let's say you had a form and one of the choices was to select the gender and to type in the last name of the person. Now knowing the gender you want to address the person in the right way. Here how you would do it:
<dtml-with REQUEST>
<dtml-if "gender == 'female'">
Dear Misses <dtml-var name>,
<dtml-elif "gender == 'male'"
Dear Mister <dtml-var name>,
<dtml-else>
Dear Misses or Mister <dtml-var name>,
</dtml-if>
</dtml-with>

name
See general tag.
expr
See general tag.

unless /unless

evaluates the enclosed content if a condition is false.
name
See general tag.
expr
See general tag.

in [else] /in

Iterative Insertion
<dtml-in list>
(block)
<dtml-else>
(block)
</dtml-in>


name=arg
See general tag.
expr=arg
See general tag.
mapping
Normally, the attributes of items in the sequence are displayed. But, some items should be treated as mapping objects, meaning that the items are to be looked up.
reverse
sort=arg
The sort attribute is used to cause a sequence of objects to be sorted before text insertion is performed. The attribute value is the name of the attribute (or key if the mapping attribute was provided) that items should be sorted on.
start=arg
The name of a (request) variable that specifies the number of the row on which to start a batch
size=arg
The batch size.
skip_unauthorized
Use of this attribute causes items to be skipped if access to the item is unauthorized. See Access Control. If this attribute is not used, then Unauthorized errors are raised if unauthorized items are encountered.
orphan=arg
The desired minimum batch size. The default is "3", meaning less than 3, e.g. any sequence with a batch "size" set to 5 will display up to 7 items without creating a next batch.
overlap=arg
The number of rows to overlap between batches, default none.
previous
If the previous attribute is included, then iterative insertion will not be performed. The text following the in tag will be inserted and batch processing variables associated with information about a previous batch will be made available.
next
The next attribute has the same meaning and use as the previous attribute except that variables associated with the next batch are provided.
sequence
sequence-item[-even|-odd]
The current item in a sequence. -even|-odd Specifies whether the sequence item is even or odd. The variables will contain true or false respectively.
sequence-key[-even|-odd]
The key associated with the element in an items sequence. An items sequence is a sequence of value pairs that represent a mapping from a key to a value. -even|-odd Specifies whether the sequence key is even or odd. The variables will contain true or false respectively.
sequence-index[-var-xxx]
The index, starting from 0, of the element within the sequence. -var-xxx where -xxx is an element attribute name or key. This will display the value of the variable xxx in each iteration.
sequence-number
1, 2, 3, 4, 5
sequence-roman
i, ii, iii, iv, v
sequence-Roman
I, II, III, IV, V
sequence-letter
a, b, c, d, e
sequence-Letter
A, B, C, D, E
sequence-var-nnn
Each one of these variables has an associated variable name -var-nnn where nnn is an element attribute name or key.
Example:
<dtml-in sequence-query-var-id></dtml-in>
Summary
total-nnn
The total of numeric values.
count-nnn
The total number of non-missing values.
min-nnn
The minimum of non-missing values.
max-nnn
The maximum of non-missing values.
median-nnn
The median of non-missing values.
mean-nnn
The mean of numeric values.
variance-nnn
The variance of numeric values computed with a degrees of freedom equal to the (count - 1).
variance-n-nnn
The variance of numeric values computed with a degrees of freedom equal to the count.
standard-deviation-nnn
The standard deviation of numeric values computed with a degrees of freedom equal to the (count - 1).
standard-deviation-n-nnn
The standard deviation of numeric values computed with a degrees of freedom equal to the count.
Grouping
first-nnn
True if the current item is the first item among the displayed items that has the current value for variable, nnn ; False otherwise.
last-nnn
True if the current item is the last item among the displayed items that has the current value for variable, nnn ; False otherwise.
Batch Processing
sequence-start
This is useful when text must be inserted at the beginning of an dtml-in tag, especially if the text refers to any variables defined by the dtml-in tag.
sequence-end
The variable is true if the element being displayed is the last of the displayed elements, and false otherwise. This is useful when text must be inserted at the end of an dtml-in tag, especially if the text refers to any variables defined by the dtml-in tag.
sequence-query
The original query string given in a get request with the form variable named in the start attribute removed.
sequence-step-size
The batch size used.
sequence-step-start-index
???
sequence-step-end-index
???
previous-sequence
The variable is true when the first element is displayed, and when the first element displayed is not the first element in the sequence.
previous-sequence-start-index
The index, starting from 0, of the start of the batch previous to the current batch.
previous-sequence-end-index
The index, starting from 0, of the end of the batch previous to the current batch.
previous-sequence-size
The size of the batch previous to the current batch.
previous-batches
A sequence of mapping objects containing information about all of the batches prior to the batch being displayed.
next-sequence
The variable is true when the last element is displayed, and when the last element displayed is not the last element in the sequence.
next-sequence-start-index
The index, starting from 0, of the start of the batch after the current batch.
next-sequence-end-index
The index, starting from 0, of the end of the batch after the current batch.
next-sequence-size
The size of the batch after the current batch.
next-batches
A sequence of mapping objects containing information about all of the batches after the batch being displayed.
batch-start-index
The index, starting from 0, of the beginning of the batch.
batch-end-index
The index, starting from 0, of the end of the batch.
batch-size
The size of the batch.

with /with

Expand the namespace of a document template by adding attributes or mapping keys from an object which already exists in the document template namespace.


only
Prunes enclosing namespaces, use this to prevent acquisition within a DTML with tag.

let

Similar to with "_.namespace()", multiple assignments. Limited scope.


call

Elvaluate without including any returned value.

raise /raise

Raises a Python-like Error. It also causes any changes made by a web request to be ignored, if they occurred within transactional persistence mechanism.

try [except]* /try

Error handling (Python class-based exceptions). Used to avoids returning a Zope error message and continue rendering.

tag

Generates an HTML Image tag with an absolute url.

comment /comment

excludes source from being rendered and returns an HTML comment.

tree /tree

Display Zope objects hierarchically.


name=arg
See general tag.
expr=arg
See general tag.
branches=arg
The name of the method used to find sub-objects. This defaults to tpValues, which is a method defined by a number of objects in Zope and in Zope products.
branches_expr=arg
An expression which is evaluated to find sub-objects. This attribute performs the same function as the branches attribute but uses an expression rather than the name of a method.
id=arg
The name of a method or attribute used to determine the id of an object for the purposes of calculating tree state. This defaults to tpId which is a method defined by many Zope objects. This attribute is mostly useful for developers who wish to have fine control of the internal representation of the tree state.
url=arg
The name of a method or attribute used to determine the url of an object. This defaults to tpURL which is a method defined by many Zope objects. This attribute is mostly useful for developers who wish to have fine control over tree url generation.
leaves=arg
The name of a Document used to expand sub-objects that do not have sub-object branches.
header=arg
The name of a Document to be shown at the top of each expansion. This provides an opportunity to "brand" a branch in a hierarchy. If the named document cannot be found for a branch, then the header attribute is ignored for that branch.
footer=arg
The name of a Document to be shown at the bottom of each expansion. If the named document cannot be found for a branch, then the footer attribute is ignored for that branch.
nowrap=arg
Either 0 or 1. If 0, then branch text will wrap to fit in available space, otherwise, text may be truncated. The default value is 0.
sort=arg
Sort branches before text insertion is performed. The attribute value is the name of the attribute that items should be sorted on.
assume_children=arg
Either 0 or 1. If 1, then all items are assume to have sub-items, and will therefore always have a plus sign in front of them when they are collapsed. Only when an item is expanded will sub-objects be looked for. This could be a good option when the retrieval of sub-objects is a costly process.
single=arg
Either 0 or 1. If 1, then only one branch of the tree can be expanded. Any expanded branches will collapse when a new branch is expanded.
skip_unauthorized=arg
Either 0 or 1. If 1, then no errors will be raised trying to display sub-objects to which the user does not have sufficient access.
variables set by tree tag
tree-item-expanded
True is the current item is expanded.
tree-item-url
The URL of the current item relative to the URL of the DTML document in which the tree tag appears. This variable relies on the tree tag's url attribute to generate the tree-item URL.
tree-root-url
The URL of the DTML document in which the tree tag appears.
tree-level
The depth of the current item. Items at the top of the tree have a level of 0.
tree-colspan
The number of levels deep the tree is being rendered. This variable along with the tree-level variable can be used to calculate table rows and colspan settings when inserting table rows into the tree table.
tree-state
The tree state expressed as a list of ids and sub-lists of ids. This variable is mostly of interest to developers who which to have precise knowledge of a tree's state.
Variables that influence the tree tag
expand-all
If set to a true value, this variable causes the entire tree to be expanded.
collapse-all
If set to a true value, this variable causes the entire tree to be collapsed.
tree-s
This variable contains the tree state in a compressed and encoded form. This variable is set in a cookie to allow the tree to maintain its state. Developers may control the state of the tree directly by setting this variable, though this is not recommended.
tree-e
This variable contains a compressed and encoded list of ids to expand. Developers may control the state of the tree directly by setting this variable, though this is not recommended.
tree-c
This variable contains a compressed and encoded list of ids to collapse. Developers may control the state of the tree directly by setting this variable, though this is not recommended.

sqlvar

The sqlvar tag is used to type-safely insert values into SQL text. The sqlvar tag is similar to the var tag, except that it replaces text formatting parameters with SQL type information.
name
The name of the variable to insert. The name= prefix is usually omitted.
type
Required. The data type of the value to be inserted: string, int, float, or nb. nb indicates a string that must have a length that is greater than 0.
optional
Optional flag. If a value has this flag and is not provided or is blank then the string null is inserted.

sqltest

The sqltest tag is used to insert SQL source to test whether an SQL column is equal to a value given in a DTML variable.
name
The name of the variable to insert. The name= prefix is usually omitted.
type
Required. The data type of the value to be inserted: string, int, float, or nb. nb indicates a string that must have a length that is greater than 0.
column
The name of the SQL column, if different than name.
multiple
A flag indicating whether multiple values may be provided.
optional
Optional flag. If a value has this flag and is not provided or is blank then the string null is inserted.

sqlgroup

The sqlgroup tag checks to see if text to be inserted contains other than whitespace characters. If it does, then it is inserted with the appropriate boolean operator, as indicated by use of an 'and' or 'or' tag, otherwise, no text is inserted.
required
The required attribute is used to flag groups that must include at least one test. This is useful when you want to make sure that a query is qualified, but want to be very flexible about how it is qualified.
where
The where flag is used to cause an sql "where" to be included if a group contains any text. This attribute is useful for queries that may be either qualified or unqualified.

sendmail /sendmail

The sendmail tag is used to send an electronic message using the Simple Mail Transport Protocol (SMPT). Unlike other DTML tags, the sendmail tag does not cause any text to be included in output.


mailhost
A Zope MailHost object that manages Simple Mail Transport Protocol (SMTP) and port information. This attribute is not used if the smtphost attribute is used.
smtphost
The address of a SMTP server. Mail will be delivered to this server, which will do most of the work of sending mail. This attribute is not used if the mailhost attribute is used.
port
If the smtphost attribute is used, then the port attribute is used to specify a port number to connect to. If not specified, then port 25 will be used.
mailto
A recipient address or a list of recipient addresses separated by commas.
mailfrom
A sender address.
subject
The subject of the message.

mime

The mime tag is used in conjunction with the sendmail tag to send attachments along with electronic mail messages. See the README in Products/MIMETools for examples and exact hehavior.
boundary
The boundary tag is used within the mime tag to include multipart attachments. It accepts the same arguments as the mime tag.
type
Sets the MIME header, Content-Type, of the subsequent data.
disposition
Sets the MIME header, Content-Disposition, of the subsequent data. If disposition is not specified in a mime or boundary tag, then Content-Disposition MIME header is not included.
encode
Sets the MIME header, Content-Transfer-Encoding, of the subsequent data. If encode is not specified, base64 is used as default. The options for encode are: base64, quoted-printable, uuencode, x-uuencode, uue, x-uue, and 7bit. No encoding is done if set to 7bit.

_ (special namespace variable)

General Attributes
abs(X)
Return the absolute value of a number.
chr(I)
Return a string of one character whose ASCII code is integer I , e.g., chr(97) returns the string 'a' . This is the inverse of ord() . The argument must be in the range 0-255, inclusive.
DateTime()
Create a DateTime object from zero or more arguments. See Object Reference DateTime.
divmod(A,B)
Take two numbers as arguments and return a pair of integers consisting of their integer quotient and remainder. With mixed operand types, the rules for binary arithmetic operators apply. For integers, the result is the same as (A/B,A%B). For floating point numbers the result is the same as (math.floor(A/B),A%B).
float(X)
Convert a number to floating point. The argument may be a plain or long integer or a floating point number.
getattr(O,name)
Get the named attribute from an object.
hasattr(O,name)
Test whether the name can be found in the namespace.
getitem(name,flag)
Lookup a name in the namespace. If the value is callable and the flag is true, then the result of calling the value is returned, otherwise the value is returned. flag defaults to false.
hash(O)
Return the 32-bit integer hash value of the object.
hex(X)
Convert an integer to a hexadecimal string.
int(X)
Convert a number to an integer.
len(S)
Return the length (the number of items) of a collection of items.
math
The math module (table See Attributes defined by the math module), which defines mathematical functions.
max(S)
Return the largest item of a non-empty sequence.
min(S)
Return the smallest item of a non-empty sequence.
namespace(name1=value1,name2=value2, ...)
The namespace function can be used with the in tag to assign variables for use within a section of DTML. The function accepts any number of "keyword" arguments, which are given as name=value pairs.
None
A special value that means "nothing".
oct(X)
Convert an integer.
ord(C)
Return the ASCII value of a string of one character. E.g., ord('a') returns the integer 97 . This is the inverse of chr() .
pow(X,Y)
Return X to the power Y . The arguments must have numeric types. With mixed operand types, the rules for binary arithmetic operators apply. The effective operand type is also the type of the result; if the result is not expressible in this type, the function raises an exception, e.g. pow(2,-1) and pow(2,35000) raise exceptions.
random
The random module (See: random attributes), which defines various random-number generating functions.
round(X,N)
Return the floating point value X rounded to N digits after the decimal point. If N is omitted, the default value is zero. The result is a floating point number. Values are rounded to the closest multiple of 10 to the power minus N; if two multiples are equally close, rounding is done away from 0 (so e.g. round(0.5) is 1.0 and round(-0.5) is -1.0 ).
str(O)
Return a string containing a representation of an object.
string
The string module (table See Attributes defined by the string module), which defines string functions.
whrandom
The whrandom module (See: whrandom attributes), which defines random-number generating functions using the Wichmann-Hill pseudo-random number generator.
Math module attributes
acos(X)
Compute the inverse cosine, in radians, of X.
asin(X)
Compute the inverse sine, in radians, of X.
atan(X)
Compute the inverse tangent, in radians, of X.
atan2(X)
Compute the inverse tangent, in radians, of the quotient of X and Y.
ceil(X)
Return the smallest integer that is greater than X.
cos(X)
Compute the cosine of X, which is in radians.
cosh(X)
Compute the hyperbolic cosine of X.
e
The base of the natural logarithms.
exp(X)
Compute the exponential function of X, or e to the power X, where e is the base of the natural logarithms.
fabs(X)
Compute a floating-point absolute value of the number, X.
floor(X)
Return the largest integer less than X.
fmod(X)
Return the remainder of the division of X by Y.
frexp(X)
Return the mantissa and exponent in base 2 of the floating-point value of X, such that absolute value mantissa is between 0.5 and 1.0 or is 0.
hypot(X)
Compute the hypotenuse of a right triangle with sides X and Y.
ldexp(X)
Return X times two to the power of Y.
log(X)
Compute the natural (base e) logarithm of X.
log10(X)
Compute the common (base 10) logarithm of X.
modf(X)
Break a number into its whole and fractional parts.
pi
The mathematical constant, pi
pow(X, Y)
Raise X to the power Y.
sin(X)
Compute the sine of X.
sinh(X)
Compute the sine of X.
sqrt(X)
Compute the square-root of X.
tan(X)
Compute the tangent of X.
tanh(X)
Compute the hyperbolic tangent of X.
random module attributes
betavariate (alpha, beta)
Beta distribution. Conditions on the parameters are alpha >- 1 and beta > -1. Returned values will range between 0 and 1.
choice(seq)
Choose a random element from the non-empty sequence seq and return it.
cunifvariate(mean, arc)
Circular uniform distribution. mean is the mean angle, and arc is the range of the distribution, centered around the mean angle. Both values must be expressed in radians, and can range between 0 and *. Returned values will range between mean - arc/2 and mean + arc/2.
expovariate(lambd)
Exponential distribution. lambd is 1.0 divided by the desired mean. (The parameter would be called "lambda", but that is a reserved word in Python.) Returned values will range from 0 to positive infinity.
gamma(alpha, beta)
Gamma distribution. (Not the gamma function!) Conditions on the parameters are alpha > -1 and beta > 0.
gauss(mu, sigma)
Gaussian distribution. mu is the mean, and sigma is the standard deviation. This is slightly faster than the normalvariate() function defined below.
lognormvariate(mu, sigma)
Log normal distribution. If you take the natural logarithm of this distribution, you'll get a normal distribution with mean mu and standard deviation sigma. mu can have any value, and sigma must be greater than zero.
normalvariate(mu, sigma)
Normal distribution. mu is the mean, and sigma is the standard deviation.
paretovariate(alpha)
Pareto distribution. alpha is the shape parameter.
randint(a, b)
Return a random integer N, such that a<=N<=b
random()
Return a random real number N, such that 0<=N<1.
uniform(a, b)
Return a random real number N, such that a<=N
vonmisesvariate(mu, kappa)
mu is the mean angle, expressed in radians between 0 and pi, and kappa is the concentration parameter, which must be greater then or equal to zero. If kappa is equal to zero, this distribution reduces to a uniform random angle over the range 0 to pi. (I'm assuming pi, the DTML guide was blank?)
weibullvariate(alpha, beta)
Weibull distribution. alpha is the scale parameter and beta is the shape parameter.
string module attributes
digits
The string '0123456789'.
hexdigits
The string `0123456789abcdefABCDEF'.
letters
The concatenation of the strings lowercase' and uppercase' described below.
lowercase
A string containing all the characters that are considered lowercase letters. On most systems this is the string `abcdefghijklmnopqrstuvwxyz'.
octdigits
The string `01234567'.
uppercase
A string containing all the characters that are considered uppercase letters. On most systems this is the string `ABCDEFGHIJKLMNOPQRSTUVWXYZ'.
whitespace
A string containing all characters that are considered "white space". On most systems this includes the characters space, tab, line feed, return, form feed, and vertical tab.
atof(X)
Convert a string to a floating point number.
atoi(S[,BASE])
Convert string S to an integer in the given BASE. The string must consist of one or more digits, optionally preceded by a sign (+' or -'). The BASE defaults to 10. If the base is 0, a default base is chosen depending on the leading characters of the string (after stripping the sign): '0x' or '0X' means 16, '0' means 8, anything else means 10. If BASE is 16, a leading '0x' or '0X' is always accepted.
capatilize(W)
Capitalize the first character of the argument.
capwords(S)
Convert sequences of spaces, tabs, new-line characters, and returns to single spaces and convert every lower-case letter at the beginning of the string or that follows space to an uppercase letter.
find(S, SUB[,START])
Return the lowest index in S not smaller than START where the sub-string SUB is found. Return -1 when SUB does not occur as a sub-string of S with index at least START. If START is omitted, the default value is 0. If START is negative, then it is added to the length of the string.
rfind(S, SUB[,START])
Like find but find the highest index.
index(S, SUB[,START])
Like find but raise a ValueError exception when the substring is not found.
rindex(S, SUB[,START])
Like rfind but raise ValueError exception when the substring is not found.
count(S, SUB[,START])
Return the number of (non-overlapping) occurrences of substring SUB in string S with index at least START. If START is omitted, the default value is 0. If START is negative, then it is added to the length of the string.
lower(S)
Convert letters to lower case.
maketrans(FROM, TO)
Return a translation table suitable for passing to string.translate, that will map each character in FROM into the character at the same position in TO; FROM and TO must have the same length.
split(S [,SEP [,MAX]])
Return a list of the words of the string S. If the optional second argument SEP is absent or None, the words are separated by arbitrary strings of white-space characters (space, tab, new line, return, form feed). If the second argument SEP is present and not None, it specifies a string to be used as the word separator. The returned list will then have one more item than the number of non-overlapping occurrences of the separator in the string. The optional third argument MAX defaults to 0. If it is nonzero, at most MAX number of splits occur, and the remainder of the string is returned as the final element of the list (thus, the list will have at most MAX+1 elements).
join(WORDS[,SEP])
Concatenate a list or tuple of words with intervening occurrences of SEP. The default value for SEP is a single space character. It is always true that string.join(string.split(S, SEP), SEP) equals S.
lstrip(S)
Remove leading white space from string S.
rstrip(S)
Remove trailing white space from string S
strip(S)
Remove leading and trailing white space from string S.
swapcase(S)
Convert lower case letters to upper case and vice versa.
translate(S, TABLE[,DELS]
Delete all characters from S that are in DELS (if present), and then translate the characters using TABLE, which is a 256-character string giving the translation for each character value, indexed by its ordinal.
upper(S)
Convert letters to upper case.
ljust(S, WIDTH)
These functions respectively left-justify, right-justify and center a string in a field of given width. They return a string that is at least WIDTH characters wide, created by padding the string S with spaces until the given width on the right, left or both sides. The string is never truncated.
rjust(S, WIDTH)
See ljust(S, WIDTH).
center(S, WIDTH)
See ljust(S, WIDTH).
zfill(S, WIDTH)
Pad a numeric string on the left with zero digits until the given width is reached. Strings starting with a sign are handled properly.
whrandom module attributes


choice(seq)
Choose a random element from the non-empty sequence seq and return it.
randint(a, b)
Return a random integer N, such that a<=N<=b.
random()
Return a random real number N, such that 0<=N<1.
seed(X, Y, Z)
Initialize the random number generator from the integers X, Y and Z.
uniform(a, b)
Return a random real number N, such that a<=N

Zope-defined Web request variables

AUTHENTICATED_USER
An object that represents an authenticated user. When inserted into a DTML document, the value is the user name. This object currently provides no public attributes. Note that this variable may not be defined in Documents that are not protected by security information.


has_role(self, roles, [object])
Check to see if a has a given role or roles.
has_permission(self, permission, object)
Check to see if a user has a given permission on an object.
getDomains(self)
Returns a list of domain restrictions for a user.
getRoles(self)
Returns a list of roles assigned to a user.
getUserName(self)
Returns the name of the current user
AUTHENTICATION_PATH
The path to the object containing the user database folder which contained the definition for the authenticated user.
PARENTS
A sequence of ancestors of the object that was accessed in the current request. For example, if the accessed object is a Document, then PARENTS[0] is the folder containing the document, PARENTS[1] is the folder containing the folder containing the document, and so on.
REQUEST
An object that represents the current request. This object may be used in an expr expression to look up request data, including variables described in this table, CGI-defined variables (table See CGI-defined Web request variables), form variables, cookies, and HTTP headers. In addition, expr expressions may use the following request attributes.
cookies
If an HTTP Cookie was included in the request, then this attribute is a dictionary containing the cookie data. This allows cookie data to be looked up, even if a cookie name is the same as a form variable or an object attribute name.
form
If a request was initiated by submitting a form, then the form attribute is a dictionary object, containing the form data. This allows form data to be looked up, even if a form name is the same as an object attribute name.
has_key(name)
Determine whether the REQUEST defines a given name.
set(name, value)
Set a variable in the request.
RESPONSE
An object that represents the response to the current request. This object is primarily useful in expr expressions using the following attributes.
setStatus(status)
Set the HTTP status code of the response; the argument may either be an integer or a string from {Created, Accepted, NoContent, MovedPermanently, MovedTemporarily, NotModified, BadRequest, Unauthorized, Forbidden, NotFound, InternalError, NotImplemented, BadGateway, ServiceUnavailable} that will be converted to the correct integer value.
setHeader(name, value)
Set an HTTP return header name with value value , clearing the previous value set for the header, if one exists.
getStatus()
Return the current HTTP status code as an integer.
setBase(base)
Set the base URL for the returned document.
expireCookie(name)
Cause an HTTP cookie to be removed from the browser The response will include an HTTP header that will remove the cookie corresponding to "name" on the client, if one exists. This is accomplished by sending a new cookie with an already passed expiration date.
setCookie(name, value, ...)
Cause the response to include an HTTP header that sets a cookie on cookie-enabled browsers with a key name and value value. This overwrites any previously set value for the cookie in the Response object. Additional cookie parameters can be included by supplying keyword arguments. The valid cookie parameters are expires, domain, path, max_age, comment, and secure.
getHeader(name)
Return the value associated with an HTTP return header or None if no such header has been set in the response.
appendHeader(name, value)
Set an HTTP return header "name" with value "value" and appending it following a comma if there is a previous value set for the header.
redirect(location)
Cause a redirection without raising an error.
set(name, value)
Set a variable in the request.
URL
The URL used to invoke the request without the query string, if any.

CGI-defined Web request variables

SERVER_SOFTWARE
The name and version of the information server software answering the request. Format: name/version
SERVER_NAME
The server's host name, DNS alias or IP address as it would appear in self-referencing URLs.
GATEWAY_INTERFACE
The revision of the CGI specification to which this server complies. Format: CGI/revision.
SERVER_PROTOCOL
The name and revision of the information protcol this request came in with. Format: protocol/revision
SERVER_PORT
The port number to which the request was sent.
REQUESTED_METHOD
The method with which the request was made. For HTTP, this is "GET", "HEAD", "POST", etc.
PATH_INFO
The part of the request URL, not counting the query string, following the name of the Zope installation or module published by ZPublisher.
PATH_TRANSLATED
The server provides a translated version of PATH_INFO, which takes the path and does any virtual-to-physical mapping to it.
SCRIPT_NAME
A virtual path to the script being executed, used for self-referencing URLs.
QUERY_STRING
The information which follows the ? in the URL which referenced this script. This is the query information.
REMOTE_HOST
The host name making the request. If the server does not have this information, it should REMOTE_ADDR and leave REMOTE_HOST unset.
REMOTE_ADDR
The IP address of the remote host making the request.
AUTH_TYPE
If the server supports user authentication, and the script is protected, this is the protocol-specific authentication method used to validate the user.
REMOTE_USER
If the server supports user authentication, and the script is protected, this is the username under which it has been authenticated.
REMOTE_IDENT
If the HTTP server supports RFC 931 identification, then this variable will be set to the remote username retrieved from the server. Usage of this variable should be limited to logging only.
CONTENT_TYPE
For queries which have attached information, such as HTTP POST and PUT, this is the content type of the data.
CONTENT_LENGTH
The length of the said content as given by the client.

Document Templates

The abstract should explain the creation and the calling section. SR It should also cover the ZPublisher section.
HTML
Source is provided as a Python string in HTML server-side-include syntax.
HTMLFile
Source is provided as an external file in HTML server-side-include syntax.
String
Source is provided as a Python string in extended Python string format syntax.
File
Source is provided as an external file in extended Python string format syntax.

Default Document Source

standard_html_header
The standard HTML header contains some HTML code that initializes a site. It usually includes the entire HTML header.
standard_html_footer
The standard HTML footer closes all the tags open by the Standard HTML header, such as the BODY and HTML tag.
title_or_id()
This function returns the title or the the ID of an object. It first tries to return the title, if no title is defined it returns the ID of the current active object. This function is called by standard_html_header. It will be the default headline of the page.
title_and_id()
This function returns both, title and ID.
document_id()
Returns the ID of the current document (DTML Method/Document).
document_title()
Returns the title of the current document (DTML Method/Document).
id()
The attribute containing the ID of the currently active object.
title()
The attribute containing the title of the currently active object.
bobobase_modification_time
The attribute containing the last modified time in a date-time string
get_size()
Returns the object size in bytes of the document/object.
absolute_url()
This attribute describes the path which is the basis of all the realtive paths in the document.
BASEn
???

structured Text

Structured elements: A structured string consists of a sequence of paragraphs separated by one or more blank lines. Each paragraph has a level which is defined as the minimum indentation of the paragraph. A paragraph is a sub-paragraph of another paragraph if the other paragraph is the last preceding paragraph that has a lower level.


Header
A single-line paragraph immediately succeeded by lower level paragraphs.
Unordered lists
Elements (paragraphs) begin with '-', '*', or 'o' (bullets).
Ordered lists
Elements (paragraphs) begin with a sequence of digits followed by a white-space
Ordered lists(2)
Elements (paragraphs) begin with a sequence of digits or letters followed by a period.
Element's title and description
The first line of a paragrpah if seperated by whitespace and '--', is interpreted as a title and description.
Example code
A paragraph following a paragrpah that ends in 'example', 'examples', or '::', is left un-rendered.
Example code(2)
Text enclosed in single quotes followed by white-space or puctuation, is left un-rendered.
Emphasized text
Text surrounded by '*' followed by white-space or puctuation is emphasized.
Strong text
Text surrounded by '**' followed by white-space or puctuation is made strong.
Underlined text
Text surrounded by '_' followed by white-space or puctuation is underlined.
Hyperlinks (relative or absolute)
Text enclosed by "double quotes":colon, URL, and puctuation then white-space, or just white-space.
Hyperlinks (absolute)
Text enclosed by "double quotes",comma, one or more spaces, absolute URL and concluded by punctuation then white space, or just white space.
Reference links
Text enclosed in [brackets] which consists only of letters, digits, underscores and dashes.
Named links (Referencing)
Text enclosed in brackets, preceded by the start of a line, two periods and a white-space.

XML Document

XML Document Methods, attributes, and other section are an attempt at breaking up the otherwise long list of methods.
DOM attributes
getNodeName(self)
The name of this node, depending on its type.
getNodeType(self)
A code representing the type of the node.
1 = ELEMENT_NODE
2 = ATTRIBUTE_NODE
3 = TEXT_NODE
4 = CDATA_SECTION_NODE
5 = ENTITY_REFERENCE_NODE
6 = ENTITY_NODE
7 = PROCESSING_INSTRUCTION_NODE
8 = COMMENT_NODE
9 = DOCUMENT_NODE
10 = DOCUMENT_TYPE_NODE
11 = DOCUMENT_FRAGMENT_NODE
12 = NOTATION_NODE
getNodeValue(self)
The value of this node, depending on its type.
getParentNode(self)
The parent of this node. All nodes except Document DocumentFragment and Attr may have a parent.
getChildNodes(self)
Returns a NodeList that contains all children of this node, if none, this is a empty NodeList.
getFirstChild(self)
The first child of this node, otherwise returns None.
getLastChild(self)
The last child of this node, otherwise returns None.
getPreviousSibling(self)
The node immediately preceding this node, otherwise returns None.
getNextSibling(self)
The node immediately preceding this node, otherwise returns None.
getAttributes(self)
Returns a NamedNodeMap containing the attributes of this node (if it is an element) or None otherwise.
getOwnerDocument(self)
The Document object associated with this node, if document this is None
getLength(self)
The length of the NodeList.
DOM Methods
hasChildNodes(self)
Returns true if the node has any children, false if it doesn't.
getAttribute(self, name)
Retrieves an attribute value by name.
getAttributeNode(self, name)
Retrieves an Attr node by name or None if there is no such attribute.
getName(self)
Returns the name of this attribute.
getElementsByTagName(self, tagname)
Returns a NodeList of all the Elements with a given tag name (* = all tags) in the order in which they would be encountered in a preorder traversal of the Document tree.
item(self, index)
Returns the index-th item in the map.
getNamedItem(self, name)
Retrieves a node specified by name. Parameters name: Name of a node to retrieve. Return Value A Node (of any type) with the specified name, or None if the specified name did not identify any node in the map.
getData(self)
The character data of this node.
getTagName(self)
The name of the element
substringData(self,offset,count)
Extracts a range of data from the node.
appendData(self, arg)
Append the string to the end of the character data of the node. Upon success, data provides access to the concatenation of data and the string specified.
insertData(self, offset, arg)
Insert a string at the specified character offset.
deleteData(self, offset, count)
Remove a range of characters from the node. Upon success, data and length reflect the change.
replaceData(self, offset, count, arg)
Replace the characters starting at the specified character offset with the specified string.
normalize(self)
Consolidate child Text nodes.
insertBefore(self, newChild, refChild=None)
Inserts the node newChild before the existing child node refChild. If refChild is None, insert newChild at the end of the list of children. If the newChild is already in the tree, it is first removed.
replaceChild(self, newChild, oldChild)
Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node. If the newChild is already in the tree, it is first removed.
removeChild(self, oldChild)
Removes the child node indicated by oldChild from the list of children, and returns it.
appendChild(self, newChild)
Adds the node newChild to the end of the list of children of this node. If the newChild is already in the tree, it is first removed.
cloneNode(self, deep=0)
Returns a duplicate of this node, serving as a generic copy constructor for nodes. The duplicate node has no parent. Includes text if Deep is set.
setAttribute(self, name, value)
Adds a new attribute. If present, replaces current elements value. Value is a simple string.
removeAttribute(self, name)
Removes an attribute by name. If the removed attribute has a ault value it is immediately replaced.
setAttributeNode(self, newAttr)
Adds a new attribute. If an attribute with that name is already present in the element, it is replaced by the new one.
removeAttributeNode(self, oldAttr)
Removes the specified attribute.
splitText(self, offset)
On Text Nodes: Breaks this Text node into two Text nodes, the orginal and one new, at the specified offset.
Document Node DOM Methods
getDocType(self)
The Document Type Declaration associated with this document.
getImplementation(self)
The DOMImplementation object that handles this document.
getDocumentElement(self)
The child node that is the root element of the document.
getElementsByTagName(self,name)
Returns a Python list of all descendant elements with a given tag name, in the order in which they would be encountered in a preorder traversal of the Element tree.
Other methods
objectIds(self, spec=None)
Returns a list of sub-Element ids.
objectValues(self, spec=None)
Returns a list of sub-Elements
objectItems(self, spec=None)
Returns a list of tuples (id, Element)"> of sub-Elements.
meta_type(self)
tpValues(self)
Returns children of type Element.
tpURL(self)
URL for tree navigation.
text_content(self)
Concatination of all child Text nodes.
toXML(self, deep=1, RESPONSE=None)
DOM tree as XML from this Node. If 'deep' is false, just return the XML of this node and its attributes.
nextObject(self, spec=None)
Returns the next sibling element of type spec.
previousObject(self, spec=None)
Returns the previous sibling element of type spec.
hasFeature(self, feature, version = None)
Test if the DOM implementation implements a specific feature. Version number of the package name to test. In Level 1, this is the string "1.0". If the version is not specified, supporting any version of the feature will cause the method to return true. Return Value true if the feature is implemented in the specified version, false otherwise.

Object Reference

Zope Objects and Methods

Method Descriptions
ac_inherited_permissions([all])
Returns inherited permissions.
access_debug_info
Returns debug information.
acquiredRolesAreUsedBy(permission)
Used by management screen in the permission lists, returns CHECKED or nothing.
all_meta_types
Returns meta - permissions, types, manage_ add method, etc..
bobobase_modification_time
Object attribute, the last modified time in a date-time string.
cb_dataItems
List of objects in the clip board.
cb_dataValid
Return true if clipboard data seems valid.
cb_isCopyable
Is object copyable? Returns 0 or 1
cb_isMoveable
Is object moveable? Returns 0 or 1
changeClassId
ZClass, Only change a Class Id when you know why to.
classDefinedAndInheritedPermissions
ZClass, used by management interface.
classDefinedPermissions
ZClass, used by management interface.
classInheritedPermissions
ZClass, used by management interface.
connected
ZSQL and DA's connections, test if a connection is open.
connectionIsValid
ZSQL and DA's connections, Used to test if a connection is valid.
COPY(REQUEST, RESPONSE)
Create a duplicate of the source resource whose state and behavior match that of the source resource as closely as possible.
createInObjectManager(id, REQUEST, [RESPONSE])
Create Z instance. If called with a RESPONSE, the RESPONSE will be redirected to the management screen of the new instance's parent Folder. Otherwise, the instance will be returned.
da_has_single_argument
DA's connections, used to tests if direct traversal is allowed.
default([name])
Change or query default values in a document template. If a name is specified, the value of the named default value before the operation is returned. Keyword arguments are used to provide default values.
DELETE
Delete a resource. For non-collection resources, DELETE may return either 200 or 204 (No Content) to indicate success.
Destination
Product, return the destination for factory output
DestinationURL
Product, return the URL for the destination for factory output
discard
Version, discard changes made during the version
document_src
Return unprocessed document source.
enter(REQUEST, RESPONSE)
Version, begin working in a version.
filtered_manage_options([REQUEST, help_option_])
Used to build the tabs, in the management interface
filtered_meta_types(user)
Those meta types for which a user has adequate permissions.
get_local_roles
Returns local roles from the local
get_local_roles_for_userid(userid)
Returns local roles assigned to a user.
get_request_var_or_attr(name, default)
???Returns the named variable from the REQUEST object.
get_size
alternate of getSize, returns the length of the object.
get_valid_userids
Returns a list of valid user ids.
getAttribute(name)
Retrieves an attribute value by name.
getAttributeNode(name)
Retrieves an Attr node by name or None if there is no such attribute.
getAttributes
Returns a NamedNodeMap containing the attributes of this node (if it is an element) or None otherwise.
getChildNodes
Returns a NodeList that contains all children of this node. If there are no children, this is a empty NodeList
getClassAttr(name, [default=_marker, inherit=0])
ZClass, ???
getContentType
Returns the content type of the object in mime form.
getElementsByTagName(tagname)
Returns a NodeList of all the Elements with a given tag name in the order in which they would be encountered in a preorder traversal of the Document tree. Parameter: tagname The name of the tag to match (* = all tags). Return Value: A new NodeList object containing all the matched Elements.
getFirstChild
The first child of this node. If there is no such node this returns None
getLastChild
The last child of this node. If there is no such node this returns None.
getNextSibling
The node immediately preceding this node. If there is no such node, this returns None.
getNodeName
The name of this node, depending on its type.
getNodeType
A code representing the type of the node.
getNodeValue
The value of this node, depending on its type.
getOwnerDocument
The Document object associated with this node. When this is a document this is None
getParentNode
The parent of this node. All nodes except Document DocumentFragment and Attr may have a parent.
getPreviousSibling
The node immediately preceding this node. If there is no such node, this returns None.
getProperty(id, [d])
Get the property id, returning the optional second argument or None if no such property is found.
getPropertyType
Get the type of property id, returning None if no such property exists.
getSize
Returns the size of the file or image.
getTagName
The name of the element
getUser(name)
Returns the named user object or None.
getUserNames
Returns a list of usernames.
getUsers
Returns a list of user objects.
has_local_roles
Returns true if local roles are present.
hasChildNodes
Returns true if the node has any children, false if it doesn't.
hasProperty(id)
Return true if object has a property id.
HEAD
Retrieve resource information without a response body.
id
Returns the id of a object, if it is used inside a method than it returns the id of the calling object.
index_html([REQUEST, RESPONSE])
Renders the standard view of an object. Also, sets the Content-Type HTTP header to the objects content type.
inheritedAttribute(class,name)
Get an attribute that would be inherited if the given (extension) class did not define it. This method is used when overriding inherited methods.
leave(REQUEST, RESPONSE)
Version, temporarily stop working in a version.
leave_another(REQUEST, RESPONSE)
Version, leave a version that may not be the current version.
LOCK
A write lock MUST prevent a principal without the lock from successfully executing a PUT, POST, PROPPATCH, LOCK, UNLOCK, MOVE, DELETE, or MKCOL on the locked resource. All other current methods, GET in particular, function independently of the lock.
locked_in_version
Was the object modified in any version?
mailhost_list
Returns a list of available mailhosts.
manage(URL1)
Goes to the management interface.
manage_access(trueself, self, REQUEST, [_normal_manage_access, _method_manage_access])
Return an interface for modifying permissions settings.
manage_acquiredPermissions([permissions, REQUEST])
Change the permissions that are acquired.
manage_addDocument(id, [title, file, REQUEST, submit])
Add a DTML Method object with the contents of file. If file is empty, default document text is used.
manage_addDTMLDocument(id, [title, file, REQUEST, submit])
Add a DTML Document object with the contents of file. If file is empty, default document text is used.
manage_addDTMLMethod(id, [title, file, REQUEST, submit])
Add a DTML Method object with the contents of file. If file is empty, default document text is used.
manage_addFile(id, file, [title, precondition, content_type, REQUEST])
Add a new File object. Creates a new File object id with the contents of file
manage_addFolder(id, [title, createPublic, createUserF, REQUEST])
Add a new Folder object with id id. If the createPublic and createUserF parameters are set to any true value, an index_html and a UserFolder objects are created respectively in the new folder.
manage_addImage(id, file, [title, precondition, content_type, REQUEST])
Add a new Image object. Creates a new Image object id with the contents of file.
manage_addLocalRoles(userid, roles, [REQUEST])
Set local roles for a user.
manage_addMailHost(id, [title, smtp_host, localhost, smtp_port, timeout, REQUEST])
add a MailHost into the system.
manage_addPermission(id, title, permission, [REQUEST])
Product, create a permission object.
manage_addPrincipiaFactory(id, title, object_type, initial, [permission, REQUEST])
Product, create a factory object, controls add list items and maps an action to the item.
manage_addProduct(id, title, [REQUEST])
Create a product folder. ZClasses, etc., are created inside a product folder.
manage_addProperty(id, value, type, [REQUEST])
Add a new property via the web. Sets a new property with the given id, type, and value.
manage_addUserFolder([dtself, REQUEST])
Create an acl_users, Access Control List_Users, folder.
manage_addZClass(id, [title, baseclasses, meta_type, CreateAFactory, REQUEST])
Create a ZClass product.
manage_addZGadflyConnection(id, title, connection, [check, REQUEST])
Create a connection to a Gadfly Database.
manage_addZGadflyConnectionForm(REQUEST)
Management Interface, Create a connection to a Gadfly Database.
manage_advanced(max_rows, max_cache, cache_time, class_name, class_file, [direct, REQUEST])
Change advanced properties on a DA connection. The arguments are: max_rows, The maximum number of rows to be returned from a query. max_cache, The maximum number of results to cache cache_time, The maximum amound of time to use a cached result. class_name, The name of a class that provides additional attributes for result record objects. This class will be a base class of the result record class. class_file, The name of the file containing the class definition. The class file normally resides in the Extensions directory, however, the file name may have a prefix of product., indicating that it should be found in a product directory. For example, if the class file is: ACMEWidgets.foo, then an attempt will first be made to use the file lib/python/Products/ACMEWidgets/Extensions/foo.py. If this failes, then the file Extensions/ACMEWidgets.foo.py will be used.
manage_changePermissions(REQUEST)
Change all permissions settings, called by management screen
manage_changeProperties(REQUEST)
Change existing object properties. Change object properties by passing either a mapping object of name:value pairs {'foo':6} or passing name=value parameters
manage_clone(ob, id, [REQUEST])
Clone an object, creating a new object with the given id.
manage_CopyContainerFirstItem(REQUEST)
???
manage_copyObjects(ids, [REQUEST])
Put a reference to the objects named in ids in the clipboard
manage_createEditor(id, [title, REQUEST])
ZClass, Create an edit interface for a property sheet.
manage_createView(id, [title, ps_view_type, REQUEST])
ZClass, Create a view of a property sheet.
manage_cutObjects(ids, [REQUEST])
Put a reference to the objects named in ids in the clipboard, read for a "paste then remove" operation.
manage_defined_roles([submit, REQUEST])
Called by management screen.
manage_delLocalRoles(userids, [REQUEST])
Remove all local roles for a user.
manage_delObjects([ids, REQUEST])
Delete a subordinate object The objects specified in ids get deleted.
manage_delProperties([ids, REQUEST])
Delete one or more properties specified by ids.
manage_distribute(version, RESPONSE, configurable_objects=[])
Set the product up to create a distribution and give a link.
manage_edit(data, title, [SUBMIT, dtpref_cols, dtpref_rows, REQUEST])
Replaces a Documents contents with Data, Title with Title. The SUBMIT parameter is also used to change the size of the editing area on the default Document edit screen. If the value is "Smaller", the rows and columns decrease by 5. If the value is "Bigger", the rows and columns increase by 5. If any other or no value is supplied, the data gets checked for DTML errors and is saved.
manage_editedDialog(REQUEST)
???is this useful to anyone???
manage_editProperties(REQUEST)
Edit object properties via the web.
manage_editRoles(REQUEST, [acl_type, acl_roles])
Manage Roles.
manage_exportObject([id, download, toxml, RESPONSE])
Exports an object to a file and returns that file.
manage_FTPget
FTP get handler.
manage_FTPlist
FTP listing handler.
manage_FTPstat
FTP stat handler.
manage_get_product_readme__
Used by management interface to retrieve a product README.
manage_getPermissionMapping
Return the permission mapping for the object This is a list of dictionaries with: permission_name, The name of the native object permission class_permission, The class permission the permission is mapped to.
manage_haveProxy
Returns true if the self has proxy roles.
manage_help
Management interface, (Hidden in Zope2, needs to be enhanced).
manage_importObject(file, [REQUEST])
Import an object from a file.
manage_listLocalRoles
Management Interface, lists current local roles and allows local roles to be added.
manage_pasteObjects([cb_copy_data, REQUEST])
Paste previously copied objects into the current object. If calling manage_pasteObjects from python code, pass the result of a previous call to manage_cutObjects or manage_copyObjects as the first argument.
manage_permission(permission_to_manage, [roles, acquire, REQUEST])
Management Interface, Change the settings for the given permission If optional arg acquire is true, then the roles for the permission are acquired, in addition to the ones specified, otherwise the permissions are restricted to only the designated roles.
manage_propertiesForm
Management Interface,
manage_proxy([roles, REQUEST])
Change Proxy Roles
manage_renameObject(id, new_id, [REQUEST])
Rename a particular sub-object.
manage_role(role_to_manage, [permissions, REQUEST])
Change the permissions given to the given role.
manage_setLocalRoles(userid, roles, [REQUEST])
Set local roles for a user.
manage_setPermissionMapping([permission_names, class_permissions, REQUEST])
Change the permission mapping.
manage_subclassableClassNames
ZClass, Returns Sub-Classable Class names.
manage_test(REQUEST)
DA's, used by management interface. Tests a Database Query.
manage_testForm(REQUEST)
DA's, Management Interface. Tests a Database Query.
manage_undo_transactions(transaction_info, [REQUEST])
Used by management interface, undo transactions.
manage_upload([file, REQUEST])
Replaces the current contents of the File or Image object with file. The file or images contents are replaced with the contents of file.
manage_users([submit, REQUEST, RESPONSE])
User Folder, Manage Users. submit can equal 'Add...', 'Add', 'Edit', 'Change', or 'Delete'. Add and Edit use the following variables from the REQUEST object: name,password,confirm,[roles,domains]. ???
manage_workspace(REQUEST)
Dispatch to first interface in manage_options
management_interface
Hook to allow public execution of management interface with everything else private.
MKCOL(REQUEST, RESPONSE)
Create a new collection resource. If called on an existing resource, MKCOL must fail with 405 (Method Not Allowed).
modified_in_version
Returns true if modified in this version.
MOVE(REQUEST, RESPONSE)
Move a resource to a new location. (Limited to within Zope for now)
munge([source_string, mapping])
??? Should this be used in DTML??? Change the text or default values for a document template.
name
???(limitations?) Returns the name of the object.
new_version([_intending])
??? Version or Product Distribution ???
nonempty
Version, Returns true if this version is empty.
objectIds([spec])
Return a list of subobject ids. Returns a list of subobject ids of the current object. If spec is specified, returns objects whose meta_type matches spec.
objectItems([spec])
Return a list of (id, subobject) tuples. Returns a list of (id, subobject) tuples of the current object. If spec is specified, returns only objects whose meta_type match spec.
objectMap
Returns a object map of subobjects in the acquired folderish object's namespace.
objectValues([spec])
Return a list of the actual subobjects. Returns a list of actual subobjects of the current object. If spec is specified, returns only objects whose meta_type match spec.
OPTIONS(REQUEST, RESPONSE)
Retrieve communication options.
permission_settings
Returns user-role permission settings
permissionMappingPossibleValues
???Used by management interface, Returns ???
permissionsOfRole(role)
Used by management inteface.
possible_permissions
Used by management interface, returns all possible permissions.
PrincipiaFind
Alternate name for ZopeFind, See ZopeFind
PrincipiaSearchSource
Returns the Data object used in searching with ZopeFind
propdict
Returns a map of properties defined in the container.
property_extensible_schema__
ZClass, ???
propertyIds
Returns a list of property ids.
propertyItems
Returns a list of (id,property) tuples
propertyLabel(id)
Return a label for the given property id.
propertyMap
Return a tuple of mappings, giving meta-data for properties.
propertyValues
Returns a list of actual property objects
PROPFIND(REQUEST, RESPONSE)
Retrieve properties defined on the resource.
PROPPATCH(REQUEST, RESPONSE)
Set and/or remove properties defined on the resource.
PUT(REQUEST, RESPONSE)
The PUT method has no inherent meaning for collection resources, though collections are not specifically forbidden to handle PUT requests. The default response to a PUT request for collections is 405 (Method Not Allowed).
query_day
???
query_month
???
query_year
???
quoted_input
???
quoted_report
???
raise_standardErrorMessage([client, REQUEST, error_type, error_value, tb, error_tb, error_message, tagSearch])
???
read([raw])
Returns the data object.
read_raw([raw])
alternated of read. Returns the data object.
rolesOfPermission(permission)
Used by management screen
save(remark, [REQUEST])
Version, make version changes permanent.
setClassAttr
ZClass,
size
Returns the size of a file or image.
SQLConnectionIDs
Find SQL database connections in the current folder and above. This function return a list of ids
superValues(type)
Returns all of the objects of a given type. The search is performed in this folder and in folders above.
tabs_path_info
Used by management interface, displays breadcrumbs of above objects with manage_workplace appended.
tag
Returns html Image tag. Inside DTML, "imagename.tag(border='0',...)"
test_url_
Method for testing server connection information
this
Handy way to talk to ourselves in document templates.
title
Property available on most objects
title_and_id([st])
Utility that returns the title if it is not blank and the id otherwise. If the title is not blank, then the id is included in parens.
title_or_id([st])
Utility that returns the title if it is not blank and the id otherwise.
tpURL
URL of self as used by tree tag
tpValues
Sub-objects of self as used by the tree tag
TRACE
Return the HTTP message received back to the client as the entity-body of a 200 (OK) response. This will often usually be intercepted by the web server in use. If not, the TRACE request will fail with a 405 (Method Not Allowed), since it is not often possible to reproduce the HTTP request verbatim from within the Zope environment.
undoable_transactions([AUTHENTICATION_PATH, first_transaction, last_transaction, PrincipiaUndoBatchSize])
Used by management interface to list undoable transactions.
UNLOCK
Remove an existing lock on a resource.
update_data(data, [content_type, size])
Used to set the content of self. For file, image, etc.
user_names
Returns user names of self. For acl_users objects.
userdefined_roles
Returns a list of user-defined roles
valid_property_id(id)
Returns true if the id is valid.
valid_roles
Returns a list of valid roles.
validate_roles(roles)
Returns true if all given roles are valid.
validClipData
Returns true if clipboard data seems valid.
validRoles
Returns a list of valid roles.
view_image_or_file
The default view of the contents of the File or Image.
xml_namespace
Internal???, Returns a namespace string usable as an xml namespace for a property set.
zclass_candidate_view_actions
Used by management interface, mapping 'product views' management tags and and their actions.
ZClassBaseClassNames
ZClass, Returns names of the base classes, subclassed items.
ziconImage
ZClass and Products, display the icon image defined for a product. Displayed automatically in the management interface next to a instance.
ZopeFind(self, obj, [obj_ids, obj_metatypes, obj_searchterm, obj_expr, obj_mtime, obj_mspec, obj_permission, obj_roles, search_sub, REQUEST, result, pre])
Zope Find Interface. See 'Find'
ZQueryIds
Returns a list of Connections.
COPY
Create a duplicate of the source resource whose state and behavior match that of the source resource as closely as possible. Though we may later try to make a copy appear seamless across namespaces (e.g. from Zope to Apache), COPY is currently only supported within the Zope namespace.
DELETE
Delete a resource. For non-collection resources, DELETE may return either 200 or 204 (No Content) to indicate success.
HEAD
Retrieve resource information without a response body.
LOCK
A write lock MUST prevent a principal without the lock from successfully executing a PUT, POST, PROPPATCH, LOCK, UNLOCK, MOVE, DELETE, or MKCOL on the locked resource. All other current methods, GET in particular, function independently of the lock.
MKCOL
Create a new collection resource. If called on an existing resource, MKCOL must fail with 405 (Method Not Allowed).
MOVE
Move a resource to a new location, only within the Zope namespace.
OPTIONS
Retrieve communication options.
PROPFIND
Retrieve properties defined on the resource.
PROPPATCH
Set and/or remove properties defined on the resource.
PUT
Handle HTTP PUT requests
TRACE
Return the HTTP message received back to the client as the entity-body of a 200 (OK) response. This will often usually be intercepted by the web server in use. If not, the TRACE request will fail with a 405 (Method Not Allowed), since it is not often possible to reproduce the HTTP request verbatim from within the Zope environment.
UNLOCK
Remove an existing lock on a resource.
manage_ methods
The manage_ methods have their own permission setting, to use these you will need to setup a proxy for the DTML or be logged-in as user with the appropiate role/permissions.
manage_FTPlist
manage_FTPstat
manage_access
manage_help
Unreferenced HelpSys (Hidden in Zope2). A patch is available from Zope Mailing list (it was very useful in finding all the methods available for the section, many thanks to Stuart (Zen) Bishop).
Widely accessible methods
These methods can be used with most of the items in the Object Reference. See 'Methods Descriptions' for more details.
access_debug_info
ac_inherited_permissions
acquiredRolesAreUsedBy
bobobase_modification_time
cb_isCopyable
cb_isMoveable
dav__init
dav__validate
filtered_manage_options
getAttribute
getAttributeNode
getAttributes
getChildNodes
getElementsByTagName
getFirstChild
getLastChild
getNextSibling
getNodeName
getNodeType
getNodeValue
getOwnerDocument
getParentNode
getPreviousSibling
getTagName
get_local_roles
get_local_roles_for_userid
get_valid_userids
hasChildNodes
has_local_roles
inheritedAttribute
locked_in_version
modified_in_version
objectIds
objectItems
objectValues
permission_settings
permissionsOfRole
possible_permissions
raise_standardErrorMessage
rolesOfPermission
this
id
title
title_and_id
title_or_id
tabs_path_info
tpURL
tpValues
userdefined_roles
validate_roles
common instance
common instance, methods are available to ZClass instances.???
dav__allprop
dav__propnames
dav__propstat
hasProperty
permissionMappingPossibleValues
property_extensible_schema__
valid_property_id
xml_namespace
manage_ methods
See Zope Object and Methods, manage_.
manage
manage_acquiredPermissions
manage_addLocalRoles
manage_afterAdd
manage_afterClone
manage_beforeDelete
manage_changePermissions
manage_defined_roles
manage_delLocalRoles
manage_editRoles
manage_editedDialog
manage_getPermissionMapping
manage_permission
manage_role
manage_setLocalRoles
manage_setPermissionMapping
manage_workspace
ZClass
Notes: Subclassing CatalogAware, has to be first in the management interface to work. Subclassing User Folder, the id is "acl_users" unless you subclass Folder (or something similar).
getClassAttr
Only in ZClass
get_local_roles
get_local_roles_for_userid
get_valid_userids
validRoles
valid_roles
ZClassBaseClassNames
changeClassId
classDefinedAndInheritedPermissions
classDefinedPermissions
classInheritedPermissions
createInObjectManager
delClassAttr
index_html
setClassAttr
zclass_candidate_view_actions
ziconImage
manage_ methods
See Zope Object and Methods, manage_.
manage
manage_acquiredPermissions
manage_addLocalRoles
manage_afterAdd
manage_afterClone
manage_beforeDelete
manage_changePermissions
manage_defined_roles
manage_delLocalRoles
manage_editRoles
manage_editedDialog
manage_getPermissionMapping
manage_permission
manage_role
manage_setLocalRoles
manage_setPermissionMapping
manage_workspace
Object Manager
"Folderish" Object handler base ZClass
all_meta_types
filtered_meta_types
get_request_var_or_attr
objectMap
superValues
tabs_path_info
tpValues
undoable_transactions
validClipData
manage_ methods
manage_CopyContainerFirstItem
manage_addDTMLDocument
manage_addDTMLMethod
manage_addDocument
manage_addFile
manage_addFolder
manage_addImage
manage_addMailHost
manage_addUserFolder
manage_afterAdd
manage_afterClone
manage_beforeDelete
manage_clone
manage_copyObjects
manage_cutObjects
manage_delObjects
manage_exportObject
manage_importObject
manage_pasteObjects
manage_renameObject
manage_undo_transactions
manage_workspace
no manage_access
Available if the ZClass uses a subclass with it.
Method
DTML Method, these act similar to a property within a folder which holds a DTML script.
getProperty
getSize ---- alt: get_size
validRoles
valid_roles
PrincipiaSearchSource
cook
default
document_src
munge
name
manage_ methods
See Zope Object and Methods, manage_.
manage_FTPget
manage_acquiredPermissions
manage_addLocalRoles
manage_afterAdd
manage_afterClone
manage_beforeDelete
manage_changePermissions
manage_defined_roles
manage_delLocalRoles
manage_edit
manage_editRoles
manage_editedDialog
manage_getPermissionMapping
manage_haveProxy
manage_permission
manage_proxy
manage_role
manage_setLocalRoles
manage_setPermissionMapping
manage_upload
manage_workspace
management_interface
Permission
Availablable only inside a product, such as a ZClass product or other product folder.
validRoles
valid_roles
hasChildNodes
manage_ methods
See Zope Object and Methods, manage_.
manage
manage_acquiredPermissions
manage_addLocalRoles
manage_afterAdd
manage_afterClone
manage_beforeDelete
manage_changePermissions
manage_defined_roles
manage_delLocalRoles
manage_edit
manage_editRoles
manage_editedDialog
manage_getPermissionMapping
manage_permission
manage_role
manage_setLocalRoles
manage_setPermissionMapping
manage_workspace
User Folder
getUser
getUserNames
getUsers
get_request_var_or_attr
undoable_transactions
user_names
validRoles
valid_roles
manage_ methods
See Zope Object and Methods, manage_.
manage_acquiredPermissions
manage_addLocalRoles
manage_afterAdd
manage_afterClone
manage_beforeDelete
manage_changePermissions
manage_defined_roles
manage_delLocalRoles
manage_editRoles
manage_editedDialog
manage_getPermissionMapping
manage_permission
manage_role
manage_setLocalRoles
manage_setPermissionMapping
manage_undo_transactions
manage_users
manage_workspace
Version
Special object that allows other objects to change inside of itself and commit changes at one time.
discard
enter
leave
leave_another
nonempty
save
validRoles
valid_roles
manage_ methods
See Zope Object and Methods, manage_.
manage
manage_acquiredPermissions
manage_addLocalRoles
manage_afterAdd
manage_afterClone
manage_beforeDelete
manage_changePermissions
manage_defined_roles
manage_delLocalRoles
manage_edit
manage_editRoles
manage_editedDialog
manage_getPermissionMapping
manage_permission
manage_role
manage_setLocalRoles
manage_setPermissionMapping
manage_workspace
ZSQL
Z SQL Methods provide access to relational and possibly other databases from Zope.
validRoles
valid_roles
PrincipiaSearchSource
connected
connectionIsValid
da_has_single_argument
index_html
query_day
query_month
query_year
quoted_input
quoted_report
test_url_
manage_ methods
See Zope Object and Methods, manage_.
manage
manage_acquiredPermissions
manage_addLocalRoles
manage_advanced
manage_afterAdd
manage_afterClone
manage_beforeDelete
manage_changePermissions
manage_defined_roles
manage_delLocalRoles
manage_edit
manage_editRoles
manage_editedDialog
manage_getPermissionMapping
manage_permission
manage_role
manage_setLocalRoles
manage_setPermissionMapping
manage_test
manage_testForm
manage_workspace
Common to the following objects
These provide access to properties.
propertyIds
propertyItems
propertyLabel
propertyMap
propertyValues
Document
DTML Document's are similar to DTML methods, except they do not refer to the calling object's properties (apart from acquisition).
getProperty
getPropertyType
getSize ---- alt: get_size
validRoles
valid_roles
PrincipiaSearchSource
SubTemplate
cook
default
document_src
hasProperty
munge
name
propdict
read ---- alt: read_raw
setName
valid_property_id
manage_ methods
See Zope Object and Methods, manage_.
manage_FTPget
manage_acquiredPermissions
manage_addLocalRoles
manage_addProperty
manage_afterAdd
manage_afterClone
manage_beforeDelete
manage_changePermissions
manage_changeProperties
manage_defined_roles
manage_delLocalRoles
manage_delProperties
manage_edit
manage_editProperties
manage_editRoles
manage_editedDialog
manage_getPermissionMapping
manage_haveProxy
manage_permission
manage_proxy
manage_role
manage_setLocalRoles
manage_setPermissionMapping
manage_upload
manage_workspace
Product Management
Useful methods for managing products.
getProperty
getPropertyType
get_request_var_or_attr
PrincipiaFind
SQLConnectionIDs
ZQueryIds
ZopeFind
all_meta_types
cb_dataItems
cb_dataValid
filtered_meta_types
hasProperty
mailhost_list
navigate_filter
objectMap
propdict
superValues
undoable_transactions
validClipData
validRoles
valid_property_id
valid_roles
manage_ methods
See Zope Object and Methods, manage_.
manage_CopyContainerFirstItem
manage_acquiredPermissions
manage_addDTMLDocument
manage_addDTMLMethod
manage_addDocument
manage_addFile
manage_addFolder
manage_addImage
manage_addLocalRoles
manage_addMailHost
manage_addProduct
manage_addProperty
manage_addUserFolder
manage_addZGadflyConnection
manage_addZGadflyConnectionForm
manage_afterAdd
manage_afterClone
manage_beforeDelete
manage_changePermissions
manage_changeProperties
manage_clone
manage_copyObjects
manage_cutObjects
manage_defined_roles
manage_delLocalRoles
manage_delObjects
manage_delProperties
manage_editProperties
manage_editRoles
manage_editedDialog
manage_exportHack
manage_exportObject
manage_getPermissionMapping
manage_importHack
manage_importObject
manage_pasteObjects
manage_permission
manage_renameObject
manage_role
manage_setLocalRoles
manage_setPermissionMapping
manage_undo_transactions
manage_workspace
Products
(Very similar list of methods to above?).
getProperty
getPropertyType
get_request_var_or_attr
validRoles
valid_roles
Destination
DestinationURL
PrincipiaFind
SQLConnectionIDs
ZQueryIds
ZopeFind
all_meta_types
cb_dataItems
cb_dataValid
filtered_meta_types
hasProperty
mailhost_list
new_version
objectMap
permissionMappingPossibleValues
propdict
superValues
undoable_transactions
validClipData
valid_property_id
manage_ methods
See Zope Object and Methods, manage_.
manage_CopyContainerFirstItem
manage_acquiredPermissions
manage_addDTMLDocument
manage_addDTMLMethod
manage_addDocument
manage_addFile
manage_addFolder
manage_addImage
manage_addLocalRoles
manage_addMailHost
manage_addPermission
manage_addPrincipiaFactory
manage_addProperty
manage_addUserFolder
manage_addZClass
manage_addZGadflyConnection
manage_addZGadflyConnectionForm
manage_afterAdd
manage_afterClone
manage_beforeDelete
manage_changePermissions
manage_changeProperties
manage_clone
manage_copyObjects
manage_cutObjects
manage_defined_roles
manage_delLocalRoles
manage_delObjects
manage_delProperties
manage_distribute
manage_editProperties
manage_editRoles
manage_editedDialog
manage_exportHack
manage_exportObject
manage_getPermissionMapping
manage_get_product_readme__
manage_importHack
manage_importObject
manage_pasteObjects
manage_permission
manage_renameObject
manage_role
manage_setLocalRoles
manage_setPermissionMapping
manage_subclassableClassNames
manage_undo_transactions
manage_workspace
Image
Image object, object handler for image files.
getProperty
getPropertyType
getSize alt: get_size
validRoles
valid_roles
hasProperty
index_html
propdict
size
tag
update_data
valid_property_id
manage_ methods
See Zope Object and Methods, manage_.
manage_FTPget
manage_acquiredPermissions
manage_addLocalRoles
manage_addProperty
manage_afterAdd
manage_afterClone
manage_beforeDelete
manage_changePermissions
manage_changeProperties
manage_defined_roles
manage_delLocalRoles
manage_delProperties
manage_edit
manage_editProperties
manage_editRoles
manage_editedDialog
manage_getPermissionMapping
manage_permission
manage_role
manage_setLocalRoles
manage_setPermissionMapping
manage_upload
manage_workspace
Folder
Folder, what else need be said.
getProperty
getPropertyType
get_request_var_or_attr
validRoles
valid_roles
PrincipiaFind
SQLConnectionIDs
ZQueryIds
ZopeFind
all_meta_types
cb_dataItems
cb_dataValid
filtered_meta_types
hasProperty
locked_in_version
mailhost_list
modified_in_version
navigate_filter
objectMap
propdict
superValues
undoable_transactions
validClipData
valid_property_id
manage_ methods
See Zope Object and Methods, manage_.
manage_CopyContainerFirstItem
manage_acquiredPermissions
manage_addConferaTopic
manage_addDTMLDocument
manage_addDTMLMethod
manage_addDocument
manage_addFile
manage_addFolder
manage_addImage
manage_addLocalRoles
manage_addMailHost
manage_addProperty
manage_addUserFolder
manage_addZGadflyConnection
manage_addZGadflyConnectionForm
manage_afterAdd
manage_afterClone
manage_beforeDelete
manage_changePermissions
manage_changeProperties
manage_clone
manage_copyObjects
manage_cutObjects
manage_defined_roles
manage_delLocalRoles
manage_delObjects
manage_delProperties
manage_editProperties
manage_editRoles
manage_editedDialog
manage_exportHack
manage_exportObject
manage_getPermissionMapping
manage_importHack
manage_importObject
manage_pasteObjects
manage_permission
manage_renameObject
manage_role
manage_setLocalRoles
manage_setPermissionMapping
manage_undo_transactions
manage_workspace
File
File object, used for binary files, etc.
getProperty
getContentType
getSize alt: get_size (or size, only with image and file)
validRoles
valid_roles
hasProperty
index_html
propdict
size
update_data
valid_property_id
view_image_or_file
manage_ methods
See Zope Object and Methods, manage_.
manage_FTPget
manage_acquiredPermissions
manage_addLocalRoles
manage_addProperty
manage_afterAdd
manage_afterClone
manage_beforeDelete
manage_changePermissions
manage_changeProperties
manage_defined_roles
manage_delLocalRoles
manage_delProperties
manage_edit
manage_editProperties
manage_editRoles
manage_editedDialog
manage_getPermissionMapping
manage_permission
manage_role
manage_setLocalRoles
manage_setPermissionMapping
manage_upload
manage_workspace

Object Reference

Common methods

PUT(self, REQUEST, RESPONSE)
Handles HTTP PUT requests.
manage_edit(self, data, title, [SUBMIT, dtpref_cols, dtpref_rows, REQUEST])
manage_upload(self, [file, REQUEST])

DTML Document methods

PUT(self, REQUEST, RESPONSE)
Handles HTTP PUT requests.
manage_edit(self, data, title, [SUBMIT, dtpref_cols, dtpref_rows, REQUEST])
manage_upload(self, [file, REQUEST])

DTML Method

PUT(self, REQUEST, RESPONSE)
Handles HTTP PUT requests.
document_src(self, REQUEST, RESPONSE)
Returns unprocessed document source.
manage_FTPget(self)
manage_FTPlist(self, REQUEST)
manage_FTPstat(self, REQUEST)
manage_edit(self, data, title, [SUBMIT, dtpref_cols, dtpref_rows, REQUEST])
manage_haveProxy(self, roles)
manage_proxy(self, [roles, REQUEST])
manage_upload(self, [file, REQUEST])

DTML Method

DELETE(self, REQUEST, RESPONSE)
HEAD(self, REQUEST, RESPONSE)
PROPFIND(self, REQUEST, RESPONSE)
PROPPATCH(self, REQUEST, RESPONSE)

ZSQL Method

SQL Querry. It will return a Zope object (list of elements) that was the result of the querry. Note: If you have a querry without a return value, it will work, even the test from the management interface told you otherwise.


External Method



manage_edit (self, title, module, function, [REQUEST])

File

DELETE(self, REQUEST, RESPONSE)
PUT(self, REQUEST, RESPONSE)
getContentType(self)
getSize(self)
index_html(self, REQUEST, RESPONSE)
manage_FTPget(self)
manage_FTPlist(self, REQUEST)
manage_FTPstat(self, REQUEST)
manage_edit(self, title, content_type, [precondition, REQUEST])
manage_upload(self, [file, REQUEST])
view_image_or_file(self, URL1)

Folder

manage_addMailHost(self, id, [title, smtp_host, localhost, smtp_port, timeout, REQUEST])
manage_createWizard(self, connection_id, REQUEST)
PUT(self)
hasProperty(self, id)
manage_acquiredPermissions(self, [permissions, REQUEST])
manage_addDiscussionTopic(self, id, [title, mailhost, exp, expire, moderated, REQUEST])
manage_addDocument(self, id, [title, file, REQUEST, submit])
manage_addDTMLMethod(self, id, title, file, [REQUEST, submit])
manage_addExternalMethod(self, id, title, module, function, [REQUEST])
manage_addFile(self, id, file, [title, precondition, REQUEST])
manage_addFolder(self, id, [title, createPublic, createUserF, REQUEST])
manage_addImage(self, id, file, [title, precondition, content_type, REQUEST])
manage_addProperty(self, id, value, type, [REQUEST])
manage_addSession(self, id, title, [REQUEST])
manage_addUserDb(self, connection_id, [cookie_mode, REQUEST])
manage_addUserFolder(self, [dtself, REQUEST])
manage_addZGadflyConnection(self, id, title, connection, [check, REQUEST])
manage_addZGadflyConnectionForm(self, REQUEST)
manage_addZSQLMethod(self, id, title, connection_id, arguments, template, [REQUEST])
manage_changePermissions(self, REQUEST)
manage_changeProperties(self, [REQUEST])
manage_copyObjects(self, ids, [REQUEST, RESPONSE])
manage_cutObjects(self, ids, [REQUEST])
manage_defined_roles(self, [submit, REQUEST])
manage_delObjects(self, [ids, REQUEST])
manage_delProperties(self, ids, [REQUEST])
manage_editProperties(self, REQUEST)
manage_pasteObjects(self, [cb_copy_data, REQUEST])
manage_permission(self, permission_to_manage, [roles, acquire, REQUEST])
manage_renameObject(self, id, new_id, [REQUEST])
manage_role(self, role_to_manage, [permissions, REQUEST])
manage_undo_transactions(self, transaction_info, [REQUEST])
objectIds(self, [spec])
objectItems(self, [spec])
objectValues(self, [spec])
propertyIds(self)
propertyItems(self)
propertyValues(self)

Image

DELETE(self, REQUEST, RESPONSE)
PUT(self, REQUEST, RESPONSE)
getContentType(self)
getSize(self)
index_html(self, REQUEST, RESPONSE)
manage_FTPget(self)
manage_FTPlist(self, REQUEST)
manage_FTPstat(self, REQUEST)
manage_edit(self, title, content_type, [precondition, REQUEST])
manage_upload(self, [file, REQUEST])

Mail Host

manage_makeChanges(self, title, localHost, smtpHost, smtpPort, timeout, [REQUEST])

Object Manager

manage_FTPlist(self, REQUEST)
manage_FTPstat(self, REQUEST)
manage_delObjects(self, [ids, REQUEST])
manage_exportObject(self, [id, download, RESPONSE])
manage_importObject(self, file, [REQUEST])
all_meta_types(self)
filtered_meta_types(self, user)
filtered by the user's permissions.
objectIds(self, [spec])
objectItems(self, [spec])
objectMap(self)
Tuple of mappings containing subobjects meta-data
objectValues(self, [spec])
superValues(self, type)
Returns all the objects of a given type. Searches folders above and within this folder.
tpValues(self)
Returns a list of the folder's sub-folders, used by the tree tag.

P SQL Input Wizard

createSQLInput(self, RESPONSE, URL2, formId, resultId, sqlId, [formTitle, resultTitle, sqlTitle])
getObjectsInfo(self, REQUEST)
index_html(self)
quit(self, RESPONSE, URL2)

Product

mange_createWizard(self, connection_id, REQUEST)

User Folder

getUser(self, name)
getUserNames(self)
getUsers(self)
manage_users(self, [submit, REQUEST, RESPONSE])

Version

discard(self, [REQUEST])
enter(self, REQUEST, RESPONSE)
leave(self, REQUEST, RESPONSE)
leave_another(self, REQUEST, RESPONSE)
manage_edit(self, title, [REQUEST])
save(self, remark, [REQUEST])

Version Management

DELETE(self, REQUEST, RESPONSE)
HEAD(self, REQUEST, RESPONSE)
PROPFIND(self, REQUEST, RESPONSE)
PROPPATCH(self, REQUEST, RESPONSE)

ZCatalog

manage_addZCatalog(self,id,title,REQUEST=None)
Add a ZCatalog object
manage_edit(self, RESPONSE, URL1, [threshold=1000, REQUEST])
edit the catalog
manage_catalogObject(self, REQUEST, RESPONSE, URL1, [urls])
index all Zope objects that 'urls' point to
manage_uncatalogObject(self, REQUEST, RESPONSE, URL1, [urls])
removes Zope object 'urls' from catalog
manage_catalogReindex(self, REQUEST, RESPONSE, URL1)
clear the catalog, then re-index everything
manage_catalogClear(self, REQUEST, RESPONSE, URL1)
clears the whole enchelada
manage_catalogFoundItems(self, REQUEST, RESPONSE, URL2, URL1, [obj_metatypes, obj_ids, obj_searchterm, obj_expr, obj_mtime, obj_mspec, obj_roles, obj_permission])
Find object according to search criteria and Catalog them
manage_addColumn(self, name, REQUEST, RESPONSE, URL1)
add a column
manage_delColumns(self, names, REQUEST, RESPONSE, URL1)
del a column
manage_addIndex(self, name, type, REQUEST, RESPONSE, URL1)
add an index
manage_delIndexes(self, names, REQUEST, RESPONSE, URL1)
del an index
catalog_object(self, obj, uid)
wrapper around catalog
uncatalog_object(self, uid)
wrapper around catalog
uniqueValuesFor(self, name)
returns the unique values for a given FieldIndex
getpath(self, rid)
Return the path to a cataloged object given a 'data_record_id_'
getobject(self, rid, REQUEST=None)
Return a cataloged object given a 'data_record_id_'
schema(self)
indexes(self)
index_objects(self)
searchResults(self, REQUEST, used, query_map={type(regex.compile('')): Query.Regex,type([]): orify, type(''): Query.String, }, **kw)
This needs to be cut down in length... Search the catalog according to the ZTables search interface. Search terms can be passed in the REQUEST or as keyword arguments.

ZClass



manage_addZClass(self, id, [title, baseclasses, meta_type, CreateAFactory, REQUEST])
Note if using ZCatalogAware as a base class, it must be the first base class.
PropertySheets
DC, any comments on what should/not be here would be appreciated.
manage_workspace(self, URL1, RESPONSE)
Implement a "management" interface.
tpURL(self)
manage_options(self)
Return a manage option data structure for me instance
tabs_path_info(self, script, path)
meta_type(self)
property_extensible_schema__(self)
xml_namespace(self)
Return a namespace string usable as an xml namespace for this property set.
valid_property_id(self, id)
Return a true value if the given id is valid to use as a property id. Note that this method does not consider factors other than the actual value of the id, such as whether the given id is already in use.
hasProperty(self, id)
Return a true value if a property exists with the given id.
getProperty(self, id, [default])
Return the property with the given id, returning the optional second argument or None if no such property is found.
propertyIds(self)
Return a list of property ids.
propertyValues(self)
Return a list of property values.
propertyItems(self)
Return a list of (id, property) tuples.
propertyInfo(self, id)
Return a mapping containing property meta-data
propertyMap(self)
Return a tuple of mappings, giving meta-data for properties.
manage_propertiesForm(self, URL1)
manage_addProperty(self, id, value, type, [REQUEST])
Add a new property via the web. Sets a new property with the given id, type, and value.
manage_changeProperties(self, [REQUEST, **kw])
Change existing object properties by passing either a mapping object of name:value pairs {'foo':6} or passing name=value parameters.
manage_editProperties(self, REQUEST)
Edit object properties via the web.
manage_delProperties(self, [ids, REQUEST])
Delete one or more properties specified by 'ids'.
getProperty(self, id, [default])
propertyMap(self)
values(self)
items(self)
get(self, name, [default)
manage_addPropertySheet(self, id, ns)
addPropertySheet(self, propset)
delPropertySheet(self, name)
manage_options(self)
Return a manage option data structure for me instance
tabs_path_info(self, script, path):
propertyMap(self)
Return a tuple of mappings, giving meta-data for properties.
property_extensible_schema__(self)

Zope Draft (depreciated, Broken 1.x)

manage_Discard__draft__(self, [REQUEST])
manage_Save__draft__(self, remark, [REQUEST])

Zope Factory

DELETE(self, REQUEST, RESPONSE)
HEAD(self, REQUEST, RESPONSE)
PROPFIND(self, REQUEST, RESPONSE)
PROPPATCH(self, REQUEST, RESPONSE)

DateTime

(Python module)Encapsulation of date/time values
DateTime()
Return a new date-time object.
aMonth()
Return the abreviated month name.
pCommon()
Return a string representing the object's value in the format: Mar. 1, 1997 1:45 pm
minute()
Return a minute
isLeadYear()
Return true if the current year (in the context of the object's timezone) is a leap year
pMonth()
Return the abreviated (with period) month name.
isCurrentDay()
eturn true if this object represents a date/time that falls within the current day, in the context of this object's timezone representation
hour()
Return the 24-hour clock representation of the hour
Date()
Return the date string for the object.
aCommonZ()
Return a string representing the object's value in the format: Mar 1, 1997 1:45 pm US/Eastern
fCommonZ()
Return a string representing the object's value in the format: March 1, 1997 1:45 pm US/Eastern
isCurrentYear()
Return true if this object represents a date/time that falls within the current year, in the context of this object's timezone representation
AMPMMinutes()
Return the time string for an object not showing seconds.
dd()
Return day as a 2 digit string
TimeMinutes()
Return the time string for an object not showing seconds.
h_24()
Return the 24-hour clock representation of the hour
isPast()
Return true if this object represents a date/time earlier than the time of the call
dow()
Return the integer day of the week, where sunday is 0
dow()_1
1 Return the integer day of the week, where sunday is 1
isFuture()
Return true if this object represents a date/time later than the time of the call
pCommonZ()
Return a string representing the object's value in the format: Mar. 1, 1997 1:45 pm US/Eastern
timezone()
Return the timezone in which the object is represented.
h_12()
Return the 12-hour clock representation of the hour
PreciseTime()
Return the time string for the object.
isCurrentMinute()
Return true if this object represents a date/time that falls within the current minute, in the context of this object's timezone representation
rfc822()
Return the date in RFC 822 format
equalTo(t)
Compare this DateTime object to another DateTime object OR a floating point number such as that which is returned by the python time module. Returns true if the object represents a date/time equal to the specified DateTime or time module style time.
yy()
Return calendar year as a 2 digit string
mm()
Return month as a 2 digit string
toZone(z)
Return a DateTime with the value as the current object, represented in the indicated timezone.
earliestTime()
Return a new DateTime object that represents the earliest possible time (in whole seconds) that still falls within the current object's day, in the object's timezone context
aDay()
Return the abreviated name of the day of the week
dayOfYear()
Return the day of the year, in context of the timezone representation of the object
latestTime()
Return a new DateTime object that represents the latest possible time (in whole seconds) that still falls within the current object's day, in the object's timezone context
notEqualTo(t)
Compare this DateTime object to another DateTime object OR a floating point number such as that which is returned by the python time module. Returns true if the object represents a date/time not equal to the specified DateTime or time module style time.
PreciseAMPM()
Return the time string for the object.
day()
Return the integer day
timeTime()
Return the date/time as a floating-point number in UTC, in the format used by the python time module. Note that it is possible to create date/time values with DateTime that have no meaningful value to the time module, and in such cases a DateTimeError is raised. A DateTime object's value must generally be between Jan 1, 1970 (or your local machine epoch) and Jan 2038 to produce a valid time.time() style value.
ampm()
Return the appropriate time modifier (am or pm)
greaterThan(t)
Compare this DateTime object to another DateTime object OR a floating point number such as that which is returned by the python time module. Returns true if the object represents a date/time greater than the specified DateTime or time module style time.
month()
Return the month of the object as an integer
AMPM()
Return the time string for an object to the nearest second.
second()
Return the second
parts()
Return a tuple containing the calendar year, month, day, hour, minute second and timezone of the object
greaterThanEqualTo(t)
Compare this DateTime object to another DateTime object OR a floating point number such as that which is returned by the python time module. Returns true if the object represents a date/time greater than or equal to the specified DateTime or time module style time.
lessThanEqualTo(t)
Compare this DateTime object to another DateTime object OR a floating point number such as that which is returned by the python time module. Returns true if the object represents a date/time less than or equal to the specified DateTime or time module style time.
isCurrentHour()
Return true if this object represents a date/time that falls within the current hour, in the context of this object's timezone representation
aCommon()
Return a string representing the object's value in the format: Mar 1, 1997 1:45 pm
Day()
Return the full name of the day of the week
fCommon()
Return a string representing the object's value in the format: March 1, 1997 1:45 pm
Month()
Return the full month name
isCurrentMonth()
Return true if this object represents a date/time that falls within the current month, in the context of this object's timezone representation
year()
Return the calendar year of the object
lessThan(t)
Compare this DateTime object to another DateTime object OR a floating point number such as that which is returned by the python time module. Returns true if the object represents a date/time less than the specified DateTime or time module style time.
Time()
Return the time string for an object to the nearest second.
pDay()
Return the abreviated (with period) name of the day of the week

Find

ZopeFind(self, obj, [obj_ids, obj_metatypes, obj_searchterm, obj_expr, obj_mtime, obj_mspec, obj_permission, obj_roles, search_sub, REQUEST, result, pre])
Zope Find Interface


<dtml-var standard_html_header>
This will list all object ids in the current folder<br>
<dtml-in "ZopeFind(this())">
<dtml-var "_['sequence-item' ][0 ]">
</dtml-in>
</dtml-var standard_html_footer>
obj is the object to start looking from (in our example, this()) and is the only required argument The next 8 arguments are find terms, for example, if an object has an id you specify with 'obj_ids', it will be returned. search_sub means recursivly descend into sub folders, default is 0. REQUEST is, as allways, the request object. result and pre are used by the recursion machinery and should not be diddled with. ZopeFind returns a list of two item tuples. The first item is the object's id, the second is it path *relative to the 'obj' argument*.

Zope General Information

Security Measures

On a per-item or acquired basis
Local roles
Extra roles in the context of this objects and sub-objects. Designated users are given that role when viewing that object (like Owner).
Proxy Roles
the object assumes that role, whether the user has that role or not.
Acquire Permissions
Permission
Roles
Anonymous
Manager
Owner

Undo Section

Undo
Reverts to a previous state of settings or data. Select one or more transactions. To get to an earlier state than the last transaction, select all transactions back to the wanted state. Note Undo reports an error if you select a transaction and do not select all later transactions that have modified the same object(s).

Find Interface

Simple
Find objects of type (varies according to where it is called from) with ids: (id) containing: (keywords) modified before/after (date) search only in this folder/search all subfolders
Advanced
Find objects of type (varies according to where it is called from) with ids: (id) containing: (keywords) expr: (regular expression?) modified before/after (date) where the roles: (Anonymous/Manager/Owner) have permission: (Permissions select list) search only in this folder/search all subfolders

Control Panel

Zope version information
Zope version
Python version
System Platform
Process Id
Process lifetime
Shutdown
Database Management
Database
Size
Location
Pack (remove Undo-able revisions)
Cache Parameters
Number of Objects in DB
Number of objects in cache
Target size of cache (set)
Target maximum time between accesses (set)
Mean time since last access
Deallocation rate (objects/minute)
Deactivation rate (objects/minute)
Time of last cache garbage collection
Flush Cache
Manual Cache Garbage collection

Versions

Version Management (ZODB3 only)

Product Management



Contents
Properties
change
delete

Add

Id
attributes
required
Non-blank string
ignore_empty
Ignore empty
default
default
type
boolean
date
float
int
lines
long
string (default)
text
tokens
selection
multiple selection
record
records