Skip to content

Z
Zope
Commit 446e16cf authored by Amos Latteier's avatar Amos Latteier
Browse files
Options

Revised, proofed and corrected online help topics and API docs.

parent f33d10f5
Hide whitespace changes
Inline Side-by-side
Showing with 1642 additions and 1676 deletions
lib/python/Products/OFSP/help/Common-Instance-Property-Sheet.stx
View file @ 446e16cf
Common Instance Property Sheet - Define Properties for ZClasses
Description
Common Instance Property Sheet - Define properties for ZClasses.
Common Instance Property Sheets allow ZClasses to define sets of
properties. A property sheets provides an editing view for the
properties, and default values for the properties.
Individual instances of ZClasses maintain their properties normally.
A property sheet merely provides a way to describe and edit a set of
properties.
Description
Common Instance Property Sheets allow ZClasses to define sets of
properties. A property sheets provides an editing view for the
properties and default values for the properties.
Individual instances of ZClasses have their own properties.
A property sheet provides a way to describe and edit a set of
properties.
lib/python/Products/OFSP/help/Common-Instance-Property-Sheet_Add.stx
View file @ 446e16cf
Common Instance Property Sheet - Add: Create a new Common Instance Property Sheet.
Description
This view allows you to add a 'container object' that will enclose all the
properties for the ZClass.
Description
Controls
This view allows you to add a 'container object' that will enclose all the
properties for the ZClass.
'Id' -- Specifies the id of the Common Instance Property Sheet.
'Title' -- Allows you to specify the title of the Common Instance Propery Sheet.
Controls
'Id' -- Specifies the id of the Common Instance Property Sheet.
'Title' -- Specifies an optional title of the Common Instance
Property Sheet.
'Add' -- Creates the Common Instance Property Sheet.
lib/python/Products/OFSP/help/Control-Panel.stx
View file @ 446e16cf
Control Panel - Provides access to centralized Zope management facilties.
Control Panel - Zope administration facilities.
Description
Description
From the Control Panel you can manage the Zope database, versions,
and Zope Products.
Control Panel provides centralized Zope administration facilities.
In the Control Panel you can restart and shutdown Zope,
access debugging information, manage the Zope database, and manage
versions.
Zope products are located inside the Control Panel.
lib/python/Products/OFSP/help/Control-Panel_Contents.stx
View file @ 446e16cf
Control Panel - Contents: View/Management of Zope internals and system management
Description
This view displays information about the Zope process and provides
access to system management functions.
Controls
The following list explains the information given to you on the top
of the Control Panel Contents screen.
**Note**: Some of these information are system/OS specific.
Zope version -- Indicates the version of Zope, the type of the release
(binary/source), the Python version, and the platform the binaries
were compiled on (for example: win32-x86 or linux2)
Python version -- Indicates the Python version that Zope is using. It also tells
you how many time it was attempted to build this version (#0 means
it is the binary release from "python.org":http://www.python.org ), when it
was built, and for which platform if was compiled.
System Platform -- Indicates the type of machine Zope is running on.
Example: win32 for Windows 95/98/2000 or linux-i386 for
Linux running on an Intel based platform.
Process ID -- Indicates the PID of the Zope process.
**Note:** Since on Windows systems the concept of
process IDs does not exists, the number (sometimes
negative) has no significance.
Running for -- Indicates how long the Zope process has been running.
The next buttons allow you to interfer with the Zope process by
shutting it down and/or restarting it.
Shutdown -- Button click will shutdown th Zope process.
**Important:** You will not be able to acces Zope
through the Web interface anymore after shutting it down.
Restart -- Button click will restart Zope. The button will only appear
if Zope is running under Deamon control.
**Note:** It may experience a delay in accessing you Zope
onjects again, since it takes the server a little time to
restart itself.
The last table shows the Zope administration options you can
execute through the Web management interface.
Database Management -- Provides access to the database management functions such
as packing and cache management.
Version Management -- Provides access to version management functions, including
version commit and abort.
Product Management -- Provides access to management functions for installed Zope
Products.
Control Panel - Contents: Zope system controls
Description
This view displays information about the Zope process and
allows you to restart and/or shutdown Zope.
System Information
'Zope version' -- The version of Zope, the type of the release
(binary/source), the Python version, and the platform the
binaries were compiled on.
'Python version' -- The Python version that Zope is using.
'System Platform' -- The type of machine Zope is running on.
'Process ID' -- The PID of the Zope process.
'Running for' -- How long the Zope process has been running.
Management Options
'Database Management' -- Provides access to the database
management functions such as packing and cache management.
'Version Management' -- Provides access to version management
functions, including version commit and abort.
'Product Management' -- Provides access to management functions
for installed Zope Products.
Controls
'Shutdown' -- Shutsdown the Zope process. **Important: You will
not be able to access Zope through the web after shutting it
down.**
'Restart' -- Restarts Zope. This control will only appear if Zope
is running under daemon control or as a win32 service. **Note: It
may take a few moments until the Zope comes back up after being
restarted.**
lib/python/Products/OFSP/help/DTML-Document.stx
View file @ 446e16cf
DTML Document: Provide general content management facilites to Zope.
DTML Document: Content object.
Discription
Description
They are DTML templates that are evaluated by Zope and then
served as an HTML page.
A DTML Document roughly corresponds to a web page. DTML Documents can
be viewed and edited through the web. DTML Documents can contain scripting
commands in Document Templates Markup Language (DTML).
A DTML Document contains web-editable content. A DTML Document
roughly corresponds to a web page.
DTML Documents can contain scripting commands in Document
Template Markup Language (DTML), which allows for dynamic
behavior.
Unlike DTML Methods, DTML Documents have properties and lookup
variables in their own namespace.
\ No newline at end of file
lib/python/Products/OFSP/help/DTML-DocumentOrMethod_Add.stx
View file @ 446e16cf
DTML Document/Method - Add: Allows you to create a new DTML Document/Method
Description
Create a new DTML document. You can either start entering code
or upload a local file to the server.
Controls
'Id' -- Allows you to specify the id of the DTML Document.
'Title' -- Allows you to specify the title of the DTML Document.
'File' -- Allows you to upload a file and make it the content of
the document. Use the 'Berowse...' button to locate
and select the file.
'Add' -- Upon click, the Document is added to the current Zope
folder and the content of the folder will be shown.
'Add and Edit' -- Upon click, the Document is added to the current Zope
folder and the 'Edit' view of the
Document is displayed.
DTML Document/Method - Add: Create a DTML Document/Method
Description
Creates a new DTML Document or Method.
Controls
'Id' -- The id of the DTML Document or Method.
'Title' -- The optional title of the DTML Document or Method.
'File' -- Allows you to upload a file to provide the contents for
the DTML Document or Method. Use the 'Browse...' button to select
a local file.
'Add' -- Create the DTML Document or Method.
'Add and Edit' -- Create the DTML Document or Method, and return
the 'Edit' view of the created object.
lib/python/Products/OFSP/help/DTML-DocumentOrMethod_Edit.stx
View file @ 446e16cf
DTML Document/Method - Edit: Edit contents
Description
This view allows you to edit the contents of a DTML Document or Method.
Controls
'Id' -- Indicates the id of the DTML Document or Method.
'Title' -- Allows you to specify the title of the DTML Document or Method.
'Size' -- Indicates the size of the document's contents.
'Last modified' -- Indicates the time the document was last changed.
'body [Text area]' -- Allows you to edit the contents of the document directly. You
can use any editing keys that your browser supports in the text area.
'Taller' and 'Shorter' -- Allows to adjust the height of the body text area, so you can
adjust it for you font size and screen resolution.
'Wider' and 'Narrower' -- Allows to adjust the width of the body text area, so you can
adjust it for you font size and screen resolution.
'Change' -- Submits the contant changes. Before the new version is saved,
the body is parsed for correct DTML syntax. The system will
throw an exception, if it found some incorrect DTML syntax,
such as a missing closing tag.
**Important:** After throwing an exception, Internet
Explorer 5.x will not let you use the back button, so that
you have no way to recover your changes. You may use any
any other browser or an editor that works via FTP.
DTML Document/Method - Edit: Edit contents.
Description
This view allows you to edit the contents of a DTML Document or
Method.
Information
'Id' -- The id of the DTML Document or Method.
'Size' -- The size of the contents.
'Last modified' -- The time the object was last changed.
Controls
'Title' -- The optional title.
'[Text area]' -- The contents of the DTML Document or Method.
'Taller' and 'Shorter' -- Allows to adjust the height of the
contents text area.
'Wider' and 'Narrower' -- Allows to adjust the width of the
contents text area.
'Change' -- Changes the contents.
**Note: When you change the contents it is parsed for correct
DTML syntax. If there is a syntax error, the contents will not
be changed.**
lib/python/Products/OFSP/help/DTML-DocumentOrMethod_Proxy.stx
View file @ 446e16cf
DTML Document/Method - Proxy: Manage proxy roles for a document or method
Description
DTML Document/Method - Proxy: Manage proxy roles.
Proxy roles replace the roles of the user who is viewing the
document or method to allow the document additional access or to
limit the access the document or method has.
How can proxy roles be used to **limit** access? Suppose we want to
assure that a document can only access public resources. We might do
this if we allowed untrusted users to edit the document. All we need
to do is to set the proxy roles to Anonymous. As long as we don't let
untrusted users change the proxy roles, we can let them edit the
document freely without worrying about giving them the ability to have
protected resources accessed when the document is viewed.
How can proxy roles be used to **grant** access? We might have a
method that performs some management task for an unpriviledged user.
For example, we might have a method that creates a folder for a user
and makes them the owner. The method needs to call the
'manage_addFolder' method to add the folder. Perhaps the
'manage_addFolder' requires the 'Manager' role. Simply give the method
the 'Manager' proxy role. This effectively allows the unpriviledged
user to create a folder, but only though the special method.
Description
Controls
Proxy roles control security for DTML Documents and Methods.
'Id' -- Indicates the id of the DTML Document or Method.
'Title' -- Indicates the title of the DTML Document or Method.
'Proxy Roles' -- Allows you to select the role(s) you wish to assign to the
documents or method.
Normally a DTML Document or Method executes with an intersection
of the owner's and viewer's roles. This means that the DTML can
only perform actions that are available to both the owner and
viewer.
Proxy roles explicitly list the roles that a DTML Document or
Method will execute with. This allows you to carefully control
access. Proxy roles can either increase or decrease access. **Note:
Proxy roles are limited to a subset of the owner's roles.**
Controls
'Proxy Roles' -- The proxy roles for the DTML Document or Method.
'Change' -- Change the proxy roles.
lib/python/Products/OFSP/help/DTML-DocumentOrMethod_Upload.stx
View file @ 446e16cf
DTML Document/Method - Upload: Allows you to upload DTML files.
Description
Use this view to completely replace the contents of a document or method
with the contents of an uploaded text file from your local computer.
Controls
'Browse...'[Button and Field] -- Allows you to locate and select the file to upload.
'Change' -- Upon click, the system replaces the document's contents with the
uploaded file. The upload will fail, if the uploaded file contains
a DTML syntax error.
DTML Document/Method - Upload: Upload contents.
Description
Use this view to completely replace the contents of a DTML
Document or Method with the contents of an uploaded file from your
local computer.
Controls
'File' -- The file to upload. Use the 'Browse ...' button to
select a local file.
'Change' -- Upload the file and change the contents.
lib/python/Products/OFSP/help/DTML-DocumentOrMethod_View.stx
View file @ 446e16cf
DTML Document/Method - View: Allows you to preview the document or method.
DTML Document/Method - View: Display
Description
**Note:** Zope will use the user with which you logged into the
management system. That causes sometimes complications, if you use
user-sensitive code.
Description
This view displays a DTML Document or Method.
lib/python/Products/OFSP/help/DTML-Method.stx
View file @ 446e16cf
DTML Method: Provide general templating management facilities to Zope.
DTML Method: Template object.
Description
Description
A DTML Method can be used to display almost any Zope object. DTML
Methods can be viewed and edited through the web. They can contain
scripting commands in Document Templates Markup Language. DTML Methods can be
called from DTML Documents and other DTML Methods.
I read the help for DTML Methods and Documents now, so what is the
difference? The best way to think of it is that DTML Documents are
like classes that have properties and methods, whereby DTML Methods
are methods that act on the class Folder. Therefore it makes no sense
for DTML Methods to have properties, whereby DTML Documents have
properties.
**Example:** Lets say you have the line '<dtml-var id>'
in your DTML Document and in your DTML Method. The Document will
display its own id (since it is a property of the Document), wherby
the Method will return the id of the parent calling object (eg.
DTML Document, Folder).
DTML Methods provide general templating and scripting facilities.
DTML Documents can contain scripting commands in Document
Template Markup Language (DTML), which allows for dynamic
behavior.
Unlike DTML Documents, DTML Methods have no properties, and lookup
variables in the namespace of the object they are bound to.
lib/python/Products/OFSP/help/DTMLDocument.py
View file @ 446e16cf
......@@ -109,30 +109,35 @@ class DTMLDocument:
interpretation, which can be any kind of object.
To accomplish its task, DTML Document often needs to resolve various
names into objects. For example, when the code <dtml-var
spam> is executed, the DTML engine tries to resolve the name
names into objects. For example, when the code '&lt;dtml-var
spam&gt;' is executed, the DTML engine tries to resolve the name
'spam'.
In order to resolve names, the Document must be passed a
names pace to look them up in. This can be done several ways:
namespace to look them up in. This can be done several ways:
By passing a 'client' object -- If the argument 'client' is
* By passing a 'client' object -- If the argument 'client' is
passed, then names are looked up as attributes on the
argument.
By passing a 'REQUEST' mapping -- If the argument 'REQUEST'
* By passing a 'REQUEST' mapping -- If the argument 'REQUEST'
is passed, then names are looked up as items on the
argument. If the object is not a mapping, an TypeError
will be raised when a name lookup is attempted.
By passing keyword arguments -- names and their values can
be passed as keyword arguments to the Document.
* By passing keyword arguments -- names and their values can
be passed as keyword arguments to the Document.
The names pace given to a DTML Document is the composite of these
three methods. You can pass any number of them or none at
all.
The namespace given to a DTML Document is the composite of
these three methods. You can pass any number of them or none
at all. Names are looked up first in the keyword arguments,
then in the client, and finally in the mapping.
Passing in a names pace to a DTML Document is often referred to
A DTMLDocument implicitly pass itself as a client argument in
addition to the specified client, so names are looked up in
the DTMLDocument itself.
Passing in a namespace to a DTML Document is often referred to
as providing the Document with a *context*.
DTML Documents are called three ways:
......@@ -163,9 +168,7 @@ class DTMLDocument:
By the Publisher -- When the URL of a DTML Document is fetched
from Zope, the DTML Document is called by the publisher.
The REQUEST object is passes as the second argument to the
Document. More information on the REQUEST can be found "on
the online Interface
documentation.":http://www.zope.org/Members/michel/Projects/Interfaces/PublisherRequest
Document.
Permission -- 'View'
......
lib/python/Products/OFSP/help/DTMLMethod.py
View file @ 446e16cf
......@@ -111,30 +111,34 @@ class DTMLMethod:
interpretation, which can be any kind of object.
To accomplish its task, DTML Method often needs to resolve various
names into objects. For example, when the code <dtml-var
spam> is executed, the DTML engine tries to resolve the name
names into objects. For example, when the code '&lt;dtml-var
spam&gt;' is executed, the DTML engine tries to resolve the name
'spam'.
In order to resolve names, the Method must be passed a
names pace to look them up in. This can be done several ways:
namespace to look them up in. This can be done several ways:
By passing a 'client' object -- If the argument 'client' is
* By passing a 'client' object -- If the argument 'client' is
passed, then names are looked up as attributes on the
argument.
By passing a 'REQUEST' mapping -- If the argument 'REQUEST'
* By passing a 'REQUEST' mapping -- If the argument 'REQUEST'
is passed, then names are looked up as items on the
argument. If the object is not a mapping, an TypeError
will be raised when a name lookup is attempted.
By passing keyword arguments -- names and their values can
be passed as keyword arguments to the Method.
* By passing keyword arguments -- names and their values can
be passed as keyword arguments to the Method.
The names pace given to a DTML Method is the composite of these
three methods. You can pass any number of them or none at
all.
The namespace given to a DTML Method is the composite of
these three methods. You can pass any number of them or none
at all. Names will be looked up first in the keyword argument,
next in the client and finally in the mapping.
Passing in a names pace to a DTML Method is often referred to
Unlike DTMLDocuments, DTMLMethods do not look up names in
their own instance dictionary.
Passing in a namespace to a DTML Method is often referred to
as providing the Method with a *context*.
DTML Methods are called three ways:
......@@ -165,9 +169,7 @@ class DTMLMethod:
By the Publisher -- When the URL of a DTML Method is fetched
from Zope, the DTML Method is called by the publisher.
The REQUEST object is passes as the second argument to the
Method. More information on the REQUEST can be found "on
the online Interface
documentation.":http://www.zope.org/Members/michel/Projects/Interfaces/PublisherRequest
Method.
Permission -- 'View'
"""
......
lib/python/Products/OFSP/help/Database-Management.stx
View file @ 446e16cf
Database Management: Provide access to management facilities for the Zope database.
Database Management: Zope Database Management.
Description
The Zope database is an object-oriented database that saves all
versions of an object. So, whenever an object is saved, a "new
version" object is created for it. Furthermore, the ZODB (Zope
Object DataBase) leaves commonly/often used objects in cache to
be able to access it faster.
The database management screens allow you to do some maintanance
on the ZODB. One task you should often do, especially during
development time or when you have often-changing Zope objects, is
to "pack" your database. You can find more here
Description
Database Management gives you access to Zope database controls.
The Zope database stores Zope objects.
You can manage the size of the Zope database by packing it. You
can control memory usage with the Zope database cache parameters.
lib/python/Products/OFSP/help/Database-Management_Cache-Parameters.stx
View file @ 446e16cf
Database Management - Cache Parameters: Adjust the Cahe options for your ZODB
Database Management - Cache Parameters: Zope database cache.
Description
Description
This view allows you to view cache statistics and set cache
parameters. The Zope cache operates by keeping frequently used objects in
memory to improve performance. A larger cache improves object access
speed, but increases memory usage and vice versa.
Controls
'Total number of objects in the database' -- Indicates the number of *persistent* objects in the Zope database.
'Number of objects in the cache' -- Indicates the number of objects which are currently loaded in memory. The
amount of objects in the cache can never exeed the target size of objects.
'Target size' -- Indicates ideal number of objects to have in memory. This number is usually
greater than the actual number of objects in the cache, especially on sites
that are not very busy.
'Target maximum time between accesses' -- Indicates the amount of time after which Zope should remove an
object from memory if it hasn't been accessed.
**Note: **The optimum entry for this field depends on your site's purpose
and structure.
This view allows you to view Zope database cache statistics and
set cache parameters. The Zope database cache operates by keeping
frequently used objects in memory to improve performance. A large
cache improves object access speed, but increases memory usage. A
small cache reduces memory usage but may slow down object access
speed.
Information
'Total number of objects in the database' -- Indicates the
number of *persistent* objects in the Zope database.
'Total number of objects in all the caches combined' --
Indicates the number of objects which are currently cached in
memory.
Controls
'Target size' -- Indicates ideal number of objects to have in
memory at any given time. This controls the size of the Zope
database cache.
'Target maximum time between accesses' -- Indicates the amount of
time after which Zope should remove an object from memory if it
hasn't been accessed. This controls how quickly the Zope database
cache removes objects that aren't being used.
lib/python/Products/OFSP/help/Database-Management_Database.stx
View file @ 446e16cf
Database Management - Database: Allows you to view database status information and pack the database.
Database Management - Database: Zope database information and pack.
Description
What do we mean by packing the database? Before this question can
be answered, you need to have some insight of how Zope stores
objects. As you may know, the Zope database is object-oriented;
therefore the Zope Object DataBase (ZODB). It is currently in
version 3. Furthermore, the ZODB includes a simple but effective
version control system. In order to make this version control
work, the database needs to keep track of all the old versions in
the ZODB. An old version can never expired. As you can imagine
that soon the database will be pretty big.
In order to keep this from happening you will be able to
"truncate" the old Zope objects from teh database. So, packing
simply looks at all the Zope old objects and deletes all that are
older than X days (specified in the 'days' field. You
should check regulary, and when your Zope installation takes a
performance hit, then it help most of the time to pack your
database first.
Please refer to the general database help screen
to read more about what packing does and how it works.
Controls
'Database Size' -- Indicates the size in kilobytes of the Zope database
(ZODB) file.
'Database Location' -- Indicates the path to the Zope database file.
**Note:** The Data.fs file is operating system independent.
Therefore you can just copy it into any Zope distribution
on any operating system and all your ojects are
transfered given that the destination Zope installation
contains the same products as the original one.
'Pack' -- Removes old versions of Zope objects, reducing the size of
the Zope database. Once you pack the database you cannot
retrieve old copies of objects that have been removed by the
packing operation.
'days (field)' -- Indicates how old object versions must be to be removed. For
example, if you pack the database and specify 2 days, then you
will not be able to revert to object versions older than 2 days.
Description
This view gives you information about the size and location of the
Zope database. The Zope database stores all Zope objects.
You can reduce the size of your Zope database by packing
it. Packing removes old revisions of objects, thus freeing up
space but also limiting your ability to undo object changes.
Controls
'Pack' -- Pack will remove all versions of objects from the Zope
database. This will reduce the size of your database. **Note Pack
will prevent you from undoing some or all old transactions.**
You can control which old revisions of objects are removed from
the database by specifying how many days old the revisions must be
to be removed. If you specify 0 days old, then all old object
revisions will be removed.
lib/python/Products/OFSP/help/Database-Management_Flush-Cache.stx
View file @ 446e16cf
Database Management - Flush Cache: Allows you to manually clear objects out of the Zope cache.
Database Management - Flush Cache: Zope Database cache flush.
Description
Description
The fllowing table lists the functionality of the buttons on
the 'Flush Cache' management screen:
This view allows you to flush the Zope database cache.
Controls
Controls
'Full Sweep' -- Allows you to remove objects from the cache. The
associated field (with the default value of 60 seconds) indicates
the number of seconds within which an object must have been
accessed in order *not* to be deactivated by the flush operation.
'Minimize' -- Allows you to remove objects from
the cache. The field (with the default value of 60 seconds)
indicates the number of seconds within which an object must have
been accessed in order not to be deactivated by the flush
operation. The minimize operation differs from the full sweep in
that it removes all objects which are no longer referenced from
the root, while the full sweep merely removes most objects.
'Full Sweep' -- Allows you to remove objects from the cache. The
associated field (with the default value of 60 seconds) indicates
the number of seconds within which an object must have been
accessed in order *not* to be deactivated by the flush operation.
'Minimize' -- Allows you to remove objects from
the cache. The field (with the default value of 60 seconds)
indicates the number of seconds within which an object must have
been accessed in order not to be deactivated by the flush
operation.
The minimize operation differs from the full sweep in that it
removes all objects which are no longer referenced from the
root, while the full sweep merely removes most objects. The
minimize operation takes longer than full sweep.
lib/python/Products/OFSP/help/DateTime.py
View file @ 446e16cf
......@@ -99,7 +99,7 @@ class DateTime:
DateTime objects may be created from a wide variety of string
or numeric data, or may be computed from other DateTime objects.
DateTimes support the ability to convert their representations
to many major timezones, as well as the ablility to create a
to many major timezones, as well as the ability to create a
DateTime object in the context of a given timezone.
DateTime objects provide partial numerical behavior:
......@@ -160,44 +160,42 @@ class DateTime:
that date/time will be returned.
As a general rule, any date-time representation that is
recognized and unambigous to a resident of North America is
recognized and unambiguous to a resident of North America is
acceptable.(The reason for this qualification is that
in North America, a date like: 2/1/1994 is interpreted
as February 1, 1994, while in some parts of the world,
it is interpreted as January 2, 1994.) A date/time
string consists of two components, a date component and
an optional time component, separated by one or more
spaces. If the time component is omited, 12:00am is
spaces. If the time component is omitted, 12:00am is
assumed. Any recognized timezone name specified as the
final element of the date/time string will be used for
computing the date/time value. (If you create a DateTime
with the string 'Mar 9, 1997 1:45pm US/Pacific', the
value will essentially be the same as if you had captured
time.time() at the specified date and time on a machine in
that timezone)
<PRE>
that timezone)::
e=DateTime('US/Eastern')
# returns current date/time, represented in US/Eastern.
e=DateTime("US/Eastern")
# returns current date/time, represented in US/Eastern.
x=DateTime('1997/3/9 1:45pm')
# returns specified time, represented in local machine zone.
x=DateTime("1997/3/9 1:45pm")
# returns specified time, represented in local machine zone.
y=DateTime('Mar 9, 1997 13:45:00')
# y is equal to x
y=DateTime("Mar 9, 1997 13:45:00")
# y is equal to x
</PRE>
The date component consists of year, month, and day
values. The year value must be a one-, two-, or
four-digit integer. If a one- or two-digit year is
used, the year is assumed to be in the twentieth
century. The month may an integer, from 1 to 12, a
month name, or a month abreviation, where a period may
optionally follow the abreviation. The day must be an
month name, or a month abbreviation, where a period may
optionally follow the abbreviation. The day must be an
integer from 1 to the number of days in the month. The
year, month, and day values may be separated by
periods, hyphens, forward, shashes, or spaces. Extra
periods, hyphens, forward, slashes, or spaces. Extra
spaces are permitted around the delimiters. Year,
month, and day values may be given in any order as long
as it is possible to distinguish the components. If all
......@@ -210,7 +208,7 @@ class DateTime:
must be an integer between 0 and 59 inclusively. The
second value may be an integer value between 0 and
59.999 inclusively. The second value or both the minute
and second values may be ommitted. The time may be
and second values may be omitted. The time may be
followed by am or pm in upper or lower case, in which
case a 12-hour clock is assumed.
......@@ -240,21 +238,21 @@ class DateTime:
in gmt (such as those returned by time.time()) and the
second a string naming a recognized timezone, a DateTime
with a value of that gmt time will be returned, represented
in the given timezone.
<PRE>
import time
t=time.time()
in the given timezone.::
now_east=DateTime(t,'US/Eastern')
# Time t represented as US/Eastern
import time
t=time.time()
now_west=DateTime(t,'US/Pacific')
# Time t represented as US/Pacific
now_east=DateTime(t,'US/Eastern')
# Time t represented as US/Eastern
now_west=DateTime(t,'US/Pacific')
# Time t represented as US/Pacific
# now_east == now_west
# only their representations are different
# now_east == now_west
# only their representations are different
</PRE>
- If the function is invoked with three or more numeric
arguments, then the first is taken to be an integer
......@@ -510,7 +508,7 @@ class DateTime:
def aMonth(self):
"""
Return the abreviated month name.
Return the abbreviated month name.
"""
......@@ -526,7 +524,7 @@ class DateTime:
def pMonth(self):
"""
Return the abreviated (with period) month name.
Return the abbreviated (with period) month name.
"""
......@@ -566,7 +564,7 @@ class DateTime:
def aDay(self):
"""
Return the abreviated name of the day of the week
Return the abbreviated name of the day of the week
"""
......@@ -574,7 +572,7 @@ class DateTime:
def pDay(self):
"""
Return the abreviated (with period) name of the day of the
Return the abbreviated (with period) name of the day of the
week
......@@ -592,7 +590,7 @@ class DateTime:
def dow(self):
"""
Return the integer day of the week, where sunday is 0
Return the integer day of the week, where Sunday is 0
"""
......@@ -600,7 +598,7 @@ class DateTime:
def dow_1(self):
"""
Return the integer day of the week, where sunday is 1
Return the integer day of the week, where Sunday is 1
"""
......
lib/python/Products/OFSP/help/Debug-Information_Debug.stx
View file @ 446e16cf
Debug Information - Debugging Information: Online Zope debugging
Zope provides a simple debugging interface to help
product authors find memory leaks in their products
as well as Zope itself. There is a special
object available to users with sufficient access
to use the control panel. From the Control Panel,
click the 'Debugging information' link.
The following information is displayed:
* The Zope version
* The Python version
* The system platform name
* The ID number of the Zope process (if available on your platform)
* The length of time Zope has been running
* The top refcounts, including a table listing the changes since the last snapshot
* The open object database connections
The Zope version, Python version, and system
platform name are used to
verify compatibility between Zope, Python,
and your system. On platforms
where the process ID number is available,
the Zope process can be managed
using a more forceful means than is available
through the web.
The top refcounts list lets you take a look
at what is being stored by
Zope in memory. The scrollable list shows
how many instances of each
type of object are currently in memory.
If there are items in the list with a very
high refcount, there is a good chance there
is a memory leak in a product or in Zope. Memory leaks,
which cause Zope to take up excessive amounts of RAM,
are not likely to occur as often in the Python language
as they do in languages that do not have a garbage
collector. But memory leaks
still occur when a reference to an object is kept
even after the object is no longer useful.
The following example illustrates a simple reference
to an object that is no longer needed::
helloString = 'Hello, %s!'
name = ''
def printHello():
print helloString % name
def printHelloWorld():
global name
name = 'World'
printHello()
printHelloWorld()
'printHelloWorld()' sets a variable for the module
then calls 'printHello()'.
The problem is that module variables, such as 'name',
are never cleaned up by the garbage collector.
The 'name' object, which in this case is just a string but
could be an image or a DTML method, is kept in memory until
the Python process exits. Under normal circumstances,
the Python process that runs Zope exits only when
stopped, which could mean months of continuous usage.
There are many other circumstances where unnecessary
references can be accidentally held. Finding the cause
of a memory leak can be a major task. Look for books
and mailing lists on http://www.python.org .
The table below the list is designed to assist in
locating a specific memory leak. The "Update Snapshot"
link just below the table will take
the current refcounts and store them in memory.
Then each time the debugging page is reloaded, the
table will show the difference in
refcounts between the snapshot and the current state.
If your product is causing memory leaks,
take a snapshot before the memory leak occurs,
do whatever it is that seems to cause the leak,
then reload the debugging page. You should see which
type of object is is taking up excessive RAM.
Then check for the leak in the sections of your
code that deal with that type of object.
Finally, the debugging page shows a list of currently
open database connections. In Zope 2.x a database
connection usually corresponds
with an HTTP request. The left column shows the
time at which the connection was opened. If there
is a request that has been running for a long
time you may need to restart Zope to kill the
corresponding thread. The middle column usually
shows the state of the REQUEST object with size
of the cache for that connection in parentheses.
The right column shows
information about the version the user is working in.
Description
This view provides simple debugging information to help product
authors find memory leaks in their products as well as Zope
itself.
Debugging Information
* The Zope version
* The Python version
* The system platform name
* The ID number of the Zope process (if available on your platform)
* The length of time Zope has been running
* The top refcounts, including a table listing the changes since
* the last snapshot
* The open object database connections
The Zope version, Python version, and system platform name are
used to verify compatibility between Zope, Python, and your
system. On platforms where the process ID number is available,
the Zope process can be managed using a more forceful means than
is available through the web.
Refcounts
The top refcounts list lets you take a look at what is being
stored by Zope in memory. The scrollable list shows how many
instances of each type of object are currently in memory.
If there are items in the list with a very high refcount, there
is a good chance there is a memory leak in a product or in Zope.
Using the snapshot and refresh options allow you to determine
which operations are causing memory leaks.
Open Connections
A database connection usually corresponds with an HTTP request.
The left column shows the time at which the connection was
opened. If there is a request that has been running for a long
time you may need to restart Zope to kill the corresponding
thread. The middle column usually shows the state of the REQUEST
object with size of the cache for that connection in
parentheses. The right column shows information about the
version the user is working in.
Controls
'Update Snapshot' -- Takes the current refcounts and store them in
memory. Then each time the debugging page is reloaded, the table
will show the difference in refcounts between the snapshot and the
current state.
'Refresh' -- Reloads and updates the debugging information.
'Auto refresh interval' -- The number of seconds to wait before
automatically refreshing the debugging information.
'Start auto refresh' -- Begins automatically refreshing the
debugging information.
'Stop auto refresh' -- Ends automatic refreshing of the debugging
information.
lib/python/Products/OFSP/help/Debug-Information_Profile.stx
View file @ 446e16cf
Debug Management - Profile: Performance testing
Zope can provide real-time profiling information.
Profiling helps product authors to speed up sections
of code that are taking too long
to perform their tasks. In order to use profiling,
Zope has to be started with the 'PROFILE_PUBLISHER'
environment variable set to a non-empty value. If the variable
is set to a valid filesystem path, then the accumlated profile
information will be dumped to the named file when Zope is shut
down. If the variable is simply set to a non-empty value that
is not a valid filesystem path then Zope will still run in
profiling mode, but profile information will only be available
through the web interface.
Once Zope has started in profiling mode (note that profiling
will slow Zope performance significantly), use your site with
your Web browser - Zope will accumulate profiling information
as you are working with your site. When you want to view the
profiling information, visit the Control Panel, click on the
'Debugging information' link and select the 'Profiling' tab.
The profiling screen will show a list of methods and the amount
of time each method is taking. Multiple views are available by
changing the sort order and pushing the "update" button. The
online profiler is based on the standard Python profile module.
For specific information on the meaning of the profile information,
see the standard Python documentation for the profile module.
Debug Management - Profile: Performance testing.
Description
Zope can provide real-time profiling information. Profiling helps
product authors to speed up sections of code that are taking too
long to perform their tasks.
In order to use profiling Zope has to be started with the
'PROFILE_PUBLISHER' environment variable set to a non-empty
value. If the variable is set to a valid filesystem path, then the
accumulated profile information will be dumped to the named file
when Zope is shut down. If the variable is simply set to a
non-empty value that is not a valid filesystem path then Zope will
still run in profiling mode, but profile information will only be
available through the web interface.
**Note: Profiling will slow Zope performance significantly.**
Once Zope has started in profiling mode visit your site with your Web
browser - Zope will accumulate profiling information as you are
working with your site. When you want to view the profiling
information, visit the Control Panel, click on the 'Debugging
information' link and select the 'Profiling' tab.
The profiling screen will show a list of methods and the amount of
time each method is taking. Multiple views are available by
changing the sort order and pushing the "update" button. The
online profiler is based on the standard Python profile module.
For specific information on the meaning of the profile
information, see the standard Python documentation for the
'profile' module.
When you are done profiling turn profiling off by restarting Zope
without the 'PROFILE_PUBLISHER' environment variable set.
Controls
'Sort' -- How to sort function calls.
'Limit' -- How many function calls to display.
'Update' -- Updates the profiling information.
See Also
"Python profiler documentation":http://www.python.org/doc/current/lib/module-profile.html
\ No newline at end of file
lib/python/Products/OFSP/help/ExternalMethod.py
View file @ 446e16cf
......@@ -84,6 +84,8 @@
##############################################################################
class ExternalMethod:
"""
......@@ -105,11 +107,10 @@ class ExternalMethod:
def manage_edit(self, title, module, function, REQUEST=None):
"""
Change the external method
See the description of manage_addExternalMethod for a
descriotion of the arguments 'module' and 'function'.
description of the arguments 'module' and 'function'.
Note that calling 'manage_edit' causes the "module" to be
effectively reloaded. This is useful during debugging to see
......
lib/python/Products/OFSP/help/File.py
View file @ 446e16cf
......@@ -115,7 +115,7 @@ class File:
create a list of HTML hyperlinks to all of the File objects in
the current Object Manager.
Also see Object Manager for details on the 'objectValues'
Also see ObjectManager for details on the 'objectValues'
method.
"""
......
lib/python/Products/OFSP/help/File.stx
View file @ 446e16cf
File: Allows you to store files in Zope.
File: Generic File.
Description
Description
File objects can hold any binary or textual data such as zip
files, Java applets, video, text, etcetera.
Files provide a very limited through the web interface and are
appropriate for data that will not be manipulated very much by
Zope.
This generic object can be used to store sound, video, and flash
files as well as Java applets in the Zope object database.
**Note:** Remember that the ZODB is just a single file, and
the more pages you serve using the ZODB, the more of a bottle
neck it becomes.
lib/python/Products/OFSP/help/File_Add.stx
View file @ 446e16cf
File/Image - Add: Create a new File or Image
File/Image - Add: Create a File or Image.
Description
Description
Creates a new File or Image.
Creates a new File or Image.
Controls
Controls
'Id' -- Allows you to specify the id of the File.
'Title' -- Allows you to specify the title of the File.
'Browse...'[Button and Field] -- Allows you to locate and select a file to be uploaded.
'Add' -- Upon click, Zope uploads the file into the ZODB and
creates the object.
'Id' -- The id of the File or Image.
**Note: If you do not provide an Id then the file name will be used.**
'Title' -- The optional title of the File or Image.
'File' -- The file to upload. use the 'Browse...' button to
select a local file.
'Add' -- Creates a new File or Image.
lib/python/Products/OFSP/help/File_Edit.stx
View file @ 446e16cf
File/Image - Edit: Allows you to manage the attributes of the file.
Description
Here you will be able to edit/view some of the file's properties.
Controls
'Id' -- Indicates the id of the File.
'Title' -- Allows you to specify the title of the File.
'Content type' -- Allows you to set the content type of the file. Zope will
try to guess an appropriate content type when you upload a
file.
'Precondition' -- Allows you to specify a precondition for the file. A
precondition is a method or document which is executed
before the file is viewed or downloaded. If the precondition
raises an exception then the file cannot be viewed.
'Size' -- Indicates the size of the uploaded file.
'Last modified' -- Indicates the last time the file was changed.
File - Edit: File Properties.
Description
This view allows you to edit File properties.
File information
'Id' -- The id of the File.
'Size' -- The size of the File.
'Last modified' -- The last time the File was changed.
Controls
'Title' -- The optional title of the File.
'Content type' -- The content type of the file. Zope will try to
guess an appropriate content type when you upload a File.
'Precondition' -- Allows you to specify a precondition for the
File. A precondition is a method or document which is executed
before the File is viewed or downloaded. If the precondition
raises an exception then the File cannot be viewed.
lib/python/Products/OFSP/help/File_Upload.stx
View file @ 446e16cf
File/Image - Upload: Allows you to upload a file.
File/Image - Upload: File upload.
Description
Description
Use this view to completely replace the file with an uploaded file
from your local computer.
Controls
'Id' -- Indicates the id of the File.
'Data'[Button and Field] -- Allows you to locate and select a file to be uploaded.
'Change' -- Upon click, Zope uploads the file into the ZODB and replaces
the old data.
Use this view to completely replace the File or Image with an
uploaded file from your local computer.
Controls
'Data' -- The file to upload. Use the 'Browse...' button to select
a local file.
'Change' -- Uploads the file.
lib/python/Products/OFSP/help/File_View.stx
View file @ 446e16cf
File - View: Allows you to preview a file.
File - View: File Preview.
Description
Description
Depending on how your browser is configured and the type of the
file this may download the file to your local computer.
This view downloads a File to your local computer.
lib/python/Products/OFSP/help/Find.stx
View file @ 446e16cf
Find
This view allows you to search for Zope objects.
ObjectManager - Find: Search Zope.
Description
To find objects you specify search criteria in the top frame and
then click the 'Find' button. The find results will appear in
the button frame. For more search criteria click the
'Advanced...' link.
'Find objects of type' -- Multiple selection list, that lets you choose the types of
objects you wish to search and/or list in the search
results.
'with ids' -- Allows you to restrict the ids the found items.
*Important*You have to enter the id exactly.
Parts of the id or wild cards will not work.
'containing' -- Allows you to specify text that must be contained in the
*body* of found items. Text in the title or other
attribute fields will not be searched.
'modified' -- Allows you to restrict your search to a specific time
period. You can choose whether objects 'before' or 'after' a specified
date/time (DateTime string format) should be searched.
**Note:** If you do not specify a date the current date is assumed.
**Examples of a valid DatTime string:** 'YYYY/MM/DD hh:mm:ss', 'YYYY-MM-DD',
and 'hh:mm'.
**Where?** -- Finally you may choose either the 'Search only in this
folder' or the 'Search all subfolders' radio box to control where Zope
should look for found items.
\ No newline at end of file
This view allows you to search for Zope objects.
To find objects you specify search criteria in the top frame and
then click the 'Find' button. The find results will appear in the
button frame. For more search criteria click the 'Advanced...'
link.
Controls
'Find objects of type' -- The types of objects to find.
'with ids' -- The ids of objects to find. You may specify one or
more ids separated by spaces.
'containing' -- The text that must be contained in the *body* of
found items. Text in the title or other attribute fields will not
be searched.
'modified' -- Allows you to restrict your search to a specific
time period. You can choose whether objects 'before' or 'after' a
specified date/time.
**Note: The date should be a DateTime string such as 'YYYY/MM/DD
hh:mm:ss', 'YYYY-MM-DD', or 'hh:mm'.**
'Search only in this folder' -- Find objects in this folder.
'Search all subfolders' -- Find objects in all subfolders.
'Find' -- Find objects matching the find criteria.
\ No newline at end of file
lib/python/Products/OFSP/help/Find_Advanced.stx
View file @ 446e16cf
Advanced Find: Search for Zope objects
ObjectManager - Advanced Find: Search Zope.
Description
To find objects you specify search criteria in the top frame and
then click the 'Find' button. The find results will appear in
the button frame. For less search criteria click the
'Simple...' link.
Description
Controls
This view allows you to search for Zope objects.
'Find objects of type' -- Multiple selection list, that lets you choose the
types of objects you wish to search and/or list in the search results.
'with ids' -- Allows you to restrict the ids the found items.
**Important**: You have to enter the id exactly. Parts of the id or wild cards will
not work.
'containing' -- Allows you to specify text that must be contained in the *body*
of found items. Text in the title or other attribute fields will not be searched.
'expr' -- Allows you to define DTML expressions to restrict found
items. If the expression evaluates to false in the context
of the found object, the object is rejected.
'modified' -- Allows you to restrict your search to a specific time period. You
can choose whether objects 'before' or 'after' a specified date/time (DateTime
string format) should be searched.
**Note:** If you do not specify a date the current date is assumed.
**Examples of a valid DatTime string:** 'YYYY/MM/DD hh:mm:ss', 'YYYY-MM-DD', and
'hh:mm'.
'where the roles' -- In combination with 'have permission' option. This
multiple select field allows you to select the user role.
Read more in the nect row...
'have permission' -- Allows you to only return objects which allow specific
roles (specified in 'where the roles') with
specific permissions (specified in 'have
permissions'.
*Where?* -- Finally you may choose either the 'Search only in this
folder' or the 'Search all subfolders' radio box to
control where Zope should look for found items.
To find objects you specify search criteria in the top frame and
then click the 'Find' button. The find results will appear in the
button frame. For fewer search criteria click the 'Simple...'
link.
Controls
'Find objects of type' -- The types of objects to find.
'with ids' -- The ids of objects to find. You may specify one or
more ids separated by spaces.
'containing' -- The text that must be contained in the *body* of
found items. Text in the title or other attribute fields will not
be searched.
'expr' -- A DTML expressions to restrict found items. If the
expression evaluates to false in the context of the found object,
the object is rejected.
'modified' -- Allows you to restrict your search to a specific
time period. You can choose whether objects 'before' or 'after' a
specified date/time.
**Note: The date should be a DateTime string such as 'YYYY/MM/DD
hh:mm:ss', 'YYYY-MM-DD', or 'hh:mm'.**
'where the roles' -- Use in combination with 'have permission'
option. Restricts found objects to those which provide the the
indicated permissions for the indicated roles.
'have permission' -- Use in combination with 'where the
roles'.Restricts found objects to those which provide the the
indicated permissions for the indicated roles.
'Search only in this folder' -- Find objects in this folder.
'Search all subfolders' -- Find objects in all subfolders.
'Find' -- Find objects matching the find criteria.
\ No newline at end of file
lib/python/Products/OFSP/help/Folder.py
View file @ 446e16cf
......@@ -87,13 +87,17 @@
def manage_addFolder(self, id, title):
"""
Add a Folder to the current ObjectManager
Permission -- 'Add Folders'
"""
class Folder:
"""
A Folder is a generic container object in Zope
A Folder is a generic container object in Zope.
Folders are the most common ObjectManager subclass in Zope.
"""
......
lib/python/Products/OFSP/help/Folder.stx
View file @ 446e16cf
Folder - Organize Zope obejcts (like directories)
Folder - Container object.
Description
Description
Folders allow you to organize Zope objects by grouping them together
inside Folders. Folder contain other Zope objects including other
Folders.
Folders behave like directories in a filesystem.
Folders allow you to organize Zope objects by grouping them together
inside Folders. Folder contain other Zope objects including other
Folders.
Folders behave like directories in a File System. You can also
think of them as a container class that contains sub-classes. And
yes, Folders can have properties, which can be quiet helpful.
lib/python/Products/OFSP/help/Folder_Add.stx
View file @ 446e16cf
Folder - Add: Allows you to add a new Folder.
Folder - Add: Add a Folder.
Description
This view allows you to create a new Folder based on your input.
Description
Controls
This view allows you to create a new Folder.
'Id' -- Allows you to specify the id of the Folder.
'Title' -- Allows you to specify the title of the Folder.
'Create public interface' -- When checked, creates automatically an 'index_html'
DTML Method inside the new folder to give the Folder a default HTML
representation.
'Create user folder' -- When checked, creates automatically a User
Folder in the new Folder to hold authorization information for the Folder.
**Note:** It will generate a standard Zope User Folder, not a GUF-derived
one or a UserDB Folder.
'Add' -- Clicked, it will generate the new Folder and places the
optional objects into it. The parent folder's contents screen
is displayed.
Controls
'Id' -- The id of the Folder.
'Title' -- The optional title of the Folder.
'Create public interface' -- Creates an 'index_html' DTML Method
inside the new Folder.
'Create user folder' -- Creates a User Folder inside the new
Folder to hold authorization information for the Folder.
'Add' -- Creates a new Folder.
\ No newline at end of file
lib/python/Products/OFSP/help/Folder_View.stx
View file @ 446e16cf
Folder - View: Preview public appearance
Folder - View: Folder Preview.
Description
Description
This view allows you to preview the public appearance of the folder.
This view will only be available if the folder contains (or acquires)
an 'index_html' object. So, for example, if your root folder
contains an 'index_html', all of you Folders will have this
view.
\ No newline at end of file
This view allows you to preview the public appearance of a Folder.
This view will only be available if the Folder contains (or acquires)
an 'index_html' object.
\ No newline at end of file
lib/python/Products/OFSP/help/History.stx 0 → 100644
View file @ 446e16cf
History: Object history.
Description
DTML Documents and Methods keep a history of their contents. This
view allows you to browse, compare, and revert to old versions.
Controls
Historical revisions are described by a date, a user and a
URL. This describes at what time by whom and at what URL the
object was changed.
Click on a historical version to view the object as it existed at
a given point in history.
'[Checkbox]' -- Select a historical revision.
'Copy to present' -- Changes the object to the same state as the
selected historical revision.
'Compare' -- Summarizes the difference between two historical
revisions. If you select one historical revision it will be
compared to the current state.
The comparison shows the changes needed to change the older
revision to match the newer revision.
lib/python/Products/OFSP/help/Image.stx
View file @ 446e16cf
Image - Store Image Files (GIF, PNG, JPG) in Zope
Image - Image object.
Description
Description
The Image object allows you to store image files in Zope.
Images can be displayed in DTML by calling them. For example,
&lt;dtml-var myImageId&gt;' The Image will generate an HTML 'IMG'
tag with all the correct attributes.
The Image object allows you to store image files in Zope.
Image objects differ from simple File objects. When displaying an
Image you simply write '&lt;dtml var IMAGE_ID&gt;' and Zope
will automatically generate an HTML 'IMG' tag with all the
correct attributes. Read more in the API Documentation.
lib/python/Products/OFSP/help/Image_Edit.stx 0 → 100644
View file @ 446e16cf
Image - Edit: Image Properties.
Description
This view allows you to edit Image properties.
File information
'Id' -- The id of the Image.
'Size' -- The size of the Image.
'Last modified' -- The last time the Image was changed.
Controls
'Title' -- The optional title of the Image.
'Content type' -- The content type of the Image. Zope will try to
guess an appropriate content type when you upload an Image.
lib/python/Products/OFSP/help/Image_View.stx
View file @ 446e16cf
Image - View: Preview Image
Image - View: Preview Image.
Description
Description
This view previews the image.
This view displays the Image.
lib/python/Products/OFSP/help/MailHost.py
View file @ 446e16cf
......@@ -88,8 +88,8 @@ class MailHost:
"""
MailHost objects work as adapters to Simple Mail Transfer Protocol
(SMTP) servers. MailHosts are used by <dtml-sendmail> tags to
find the proper host to deliver mail to.
(SMTP) servers. MailHosts are used by '&lt;dtml-sendmail&gt; tags
to find the proper host to deliver mail to.
"""
......@@ -98,19 +98,19 @@ class MailHost:
encode=None):
"""
Sends mail.
Sends an email message.
messageText - Is the body of the mail message.
messageText -- The body of the mail message.
mto - is a string or list of recipient(s) of the message.
mto -- A string or list of recipient(s) of the message.
mfrom - is the address of the message sender.
mfrom -- The address of the message sender.
subject - is the subject of the message.
subject -- The subject of the message.
encode - is the rfc822 defined encoding of the message. The
default of 'None' means no encoding is done. Valid values are
'base64', 'quoted-printable' and 'uuencode'.
encode - is the rfc822 defined encoding of the message. The
default of 'None' means no encoding is done. Valid values
are 'base64', 'quoted-printable' and 'uuencode'.
"""
......
lib/python/Products/OFSP/help/ObjectManager.py
View file @ 446e16cf
......@@ -87,7 +87,27 @@ class ObjectManager:
"""
An ObjectManager contains other Zope objects. The contained
objects are Object Manager Items.
"""
Creating Objects in an ObjectManager
To create an object inside an object manager use 'manage_addProduct'::
self.manage_addProduct['OFSP'].manage_addFolder(id, title)
In DTML this would be::
<dtml-call "manage_addProduct['OFSP'].manage_addFolder(id, title)">
These examples create a new Folder inside the current
ObjectManager.
'manage_addProduct' is a mapping that provides access to product
constructor methods. It is indexed by product id.
Constructor methods are registered during product initialization
and should be documented in the API docs for each addable
object.
"""
def objectIds(self, type=None):
"""
......@@ -168,3 +188,7 @@ class ObjectManager:
Permission -- Python only
"""
lib/python/Products/OFSP/help/ObjectManagerItem.py
View file @ 446e16cf
......@@ -121,7 +121,7 @@ class ObjectManagerItem:
If the title is not blank, return it, otherwise
return the id.
Permission -- 'Allways accessable'
Permission -- Always available
"""
def title_and_id(self):
......@@ -129,7 +129,7 @@ class ObjectManagerItem:
If the title is not blank, the return the title
followed by the id in parentheses. Otherwise return the id.
Permission -- 'Allways accessable'
Permission -- Always available
"""
def manage_workspace(self):
......@@ -139,6 +139,8 @@ class ObjectManagerItem:
item in a object manager contents view or in the Zope
Management navigation view.
Permission -- 'View management screens'
"""
def this(self):
......@@ -154,7 +156,7 @@ class ObjectManagerItem:
you are in a method of a non-item subobject of an item and you
need to get the item outside of the context of the subobject.
Permission --
Permission -- XXX
"""
def absolute_url(self, relative=None):
......@@ -166,14 +168,14 @@ class ObjectManagerItem:
virtual hosts are being used, then the path returned is a
logical, rather than a physical path.
Permission --Always available
Permission -- Always available
"""
def getPhysicalRoot(self):
"""
Returns the top-level Zope Application object.
Permission --Python only
Permission -- Python only
"""
def getPhysicalPath(self):
......@@ -192,6 +194,11 @@ class ObjectManagerItem:
with "unrestricted" because (almost) no security checks are
performed.
If an object is not found then the 'default' argument will be
returned.
Permission -- XXX
"""
def restrictedTraverse(self, path, default=None):
......@@ -199,6 +206,11 @@ class ObjectManagerItem:
Return the object obtained by traversing the given path from
the object on which the method was called, performing security
checks along the way.
If an object is not found then the 'default' argument will be
returned.
Permission -- XXX
"""
......
lib/python/Products/OFSP/help/ObjectManager_Contents.stx
View file @ 446e16cf
ObjectManager - Contents: Display the objects contained by the Object Manager
Description
ObjectManager - Contents: Edit contained objects.
This view displays the objects contained by the object managerr and allows
you to add, delete and change them.
Each contained object is displayed on a line and is identified by its icon
which shows what type of object it is, its 'id', and its title in
parenthesis. You can manage a contained object by clicking on its identifying
link. If the folder contains no objects, then none will be listed in this view.
If you are currently working in a version, there will be a notice
at the top of the list of objects indicating this. If there is a red diamond
following the name of an object this indicates that the object has been
modified in the version you are currently working in. If there is a red diamond
with a lock after an object, this indicates the the object has been modified in
another version.
Description
Controls
This view displays the contained objects and allows you to add,
delete and change them.
'[Checkbox]' -- Object Selection. Allows you to select the object in order to perform
operations on it. The operations you can perform are rename, cut, copy,
delete, and export. Some operations may not be visible if they are not
allowed.
Each contained object is displayed on a line and is identified by
an icon, an id and a title in parenthesis. You can manage an
object by clicking on its identifying link.
'Rename' -- Allows you to change the Ids of the selected objects.
Versions
'Cut' -- Allows you to cut an object and place it into the clipboard. This
is similar to cut in any file manager, such as Konquerer or
Explorer. When the objects are pasted into another location, the old
objects are deleted (similar to the 'mv' in UNIX).
If you are currently working in a version there will be a
notice at the top of the list of objects indicating this.
'Copy' -- Allows you to copy an object and place it in the clipboard. This
is similar to copy in any file manager, such as Konquerer or
Explorer. When the objects are pasted into another location, the old
objects are *not* deleted (similar to the 'cp' in
UNIX).
'Paste' -- Allows you to paste objects from the clipboard into this object
(for example: Folder).
**Note:** The button will only appear, if objects are in the
clipboard.
'Delete' -- Allows you to delete all selected objects from this
ObjectManager (Folder).
'Export...' -- Allows you to export an object from the Zope database (ZODB)
into a Zope Export File (.zexp) or into XML format.
**Important:** Only one selected object (first from
the top) will be taken for export. The other selections
are ignored.
If there is a red diamond following the name of an object this
indicates that the object has been modified in the version you
are currently working in. If there is a red diamond with a lock
after an object, this indicates the the object has been modified
in another version.
Controls
'[Checkbox]' -- Selects the object in order to perform operations
on it. The operations you can perform are rename, cut, copy,
delete, and export. Some operations may not be visible if they are
not allowed.
'Rename' -- Changes the ids of the selected objects.
'Cut' -- Cuts selected objects and place them into the
clipboard. This is similar to cut in most file managers. Cut
objects can be pasted in a new location. When cut objects are
pasted into another location the old objects are deleted.
'Copy' -- Copies selected objects and place them in the
clipboard. This is similar to copy in most file managers. Copied
objects can be pasted in a new location.
'Paste' -- Allows you to paste objects from the clipboard into
this object **Note: This option will only appear if objects have
previously been copied or cut.**
'Delete' -- Deletes the selected objects. Deleted objects are
*not* placed in the clipboard.
'Export...' -- Exports an object from the Zope.
'Available Objects' -- Selects a type of object to add.
'Add' -- Adds an object specified in 'Available Objects'.
lib/python/Products/OFSP/help/ObjectManager_Import-Export.stx
View file @ 446e16cf
Folder - Import/Export: Allows you to import/export objects from/into the Zope database.
Folder - Import/Export: Import/export Zope objects.
Description
Description
This screen actually allows you to do both, exporting and importing. The upper options
are for exporting an the lower ones for importing.
Controls
This view allows you to import or export Zope objects. Imported
objects will be inserted into the current object. Exported objects
will be saved to a file on the Zope server or downloaded to the
local client.
'Export object id' -- Specifies the id of the object to be exported.
**Note:**The object must be directly in this Folder object.
Aquisition will not be used for this operation.
Controls
'Export to' -- Allows you to choose, whether you want to save the exported file
locally ('Download to local machine') or on the server
('Save to file server').
'Export object id' -- The id of the object to be exported.
**Note: The exported object must be contained by the current
object.**
*XML format?* -- Allows you to choose, whether the exported object will be in
a Python pickel file (binary mode) or in XML format.
**Note:** Since XML is human readable, it is usually very easy
to do a search and replace. That comes sometimes very handy.
'Export to' -- Where you want to save the exported file. 'Download
to local machine' downloads the export file to your client, 'Save to
file server' saves the export file to the Zope 'var' directory.
'Export' -- Clicked, Zope exports the selected object to the specified
location in the specified format.
'XML format?' -- Whether the exported object
is in a binary format or in XML format.
'Import file name' -- Allows you to specify the filename of the Zope export file
that you would like to import.
**Note:** The file must be located in the 'import'
directory of your Zope installation in order for Zope to find
the file, otherwise Zope will throw a file not found
exception.
'Export' -- Exports the object.
'Import' -- Clicked, Zope will attempt to import the specified file.
'Import file name' -- The filename of the Zope export file that
you would like to import. The file must be located in the Zope
'import' directory.
'Import' -- Imports the object.
lib/python/Products/OFSP/help/ObjectManager_Rename.stx
View file @ 446e16cf
ObjectManager - Rename: Change ID of objects
ObjectManager - Rename: Change object ids.
Description
Description
This view allows you to change the ID of one or more objects.
This view allows you to change the id of one or more objects.
Controls
Controls
'to' -- Allows you to specify a new ID of for each object. The
default value is the old ID.
'to' -- The new id of each object. The
default value is the old id.
'OK' -- Changes the IDs of the objects listed.
'OK' -- Changes the ids of the objects.
'Cancel' -- Cancels renaming operation.
'Cancel' -- Cancels renaming operation.
lib/python/Products/OFSP/help/Ownership.stx
View file @ 446e16cf
Ownership: Manage ownership
Ownership: Manage ownership.
Description
......@@ -21,79 +21,66 @@ Ownership: Manage ownership
security point of view. In other words, an executable cannot
perform operations that its owner could not perform directly.
While most Zope objects support ownership, objects may not
always have an owner assigned. Objects that do not have an
assigned owner are <tt>unowned</tt>. An unowned executable
object executes with the permissions of the user running the
object.
While most Zope objects support ownership, objects may not always
have an owner assigned. Objects that do not have an assigned owner
are *unowned*. An unowned executable object executes with the
permissions of the user running the object.
There are three possible states of ownership that a Zope object
may be in. The object may be <em>unowned</em>, it may be
<em>owned directly</em> or it may be <em>owned implicitly</em>.
If an object is owned directly, the ownership information is
stored in the object itself. If an object is owned implicitly,
it acquires its ownership information from its container (which
may in turn acquire its ownership information from <em>its</em>
container, and so on).
When Zope automatically assigns ownership
to newly created or copied objects, it tries to use implict
ownership if possible. This makes it easier to change the
ownership of many objects at one time without having to visit
each object directly. For example, if everything in the folder
<tt>research</tt> is owned by Fred and you want to change the
ownership of everything in the folder to Jim, you only need to
visit the <tt>research</tt> folder and change the ownership there
if all of the objects under <tt>research</tt> are owned implicitly.
It is possible to remove a user in your Zope installation while
objects that were owned by that user remain (for instance,
someone in your organization moves on, so you remove his account
on your Zope server). When you remove a Zope user, objects that
were owned by that user still have ownership information that
refers to that user. This will not cause an error, but it is
important to understand what happens to Zope objects whose owners
no longer exist.
This is most important for "executable" objects. Usually, the
abilities of executable objects are constrained by the abilities
of the object's owner as well as the user causing the object to
execute. If Zope cannot find the user that the executable's ownership
information refers to when it tries to execute the object, it will
use the special <tt>nobody</tt> or anonymous user instead. The
<tt>nobody</tt> user has very minimal priveleges, so you should take
this into account when deciding what to do about a user's owned
objects when you delete the user. If the user had DTML documents or
other executable objects that depended upon their owner to have a
higher level of privilege than the <tt>nobody</tt> user, they will
not work correctly until their ownership has been reassigned to
another user with sufficient privileges.
may be in. The object may be *unowned*, it may be *owned directly*
or it may be *owned implicitly*. If an object is owned directly,
the ownership information is stored in the object itself. If an
object is owned implicitly, it acquires its ownership information
from its container (which may in turn acquire its ownership
information from its container, and so on).
When Zope automatically assigns ownership to newly created or
copied objects, it tries to use implicit ownership if
possible. This makes it easier to change the ownership of many
objects at one time without having to visit each object
directly. For example, if everything in the folder 'research' is
owned by Fred and you want to change the ownership of everything
in the folder to Jim, you only need to visit the 'research' folder
and change the ownership there if all of the objects under
'research' are owned implicitly.
It is possible to remove a user in your Zope installation while
objects that were owned by that user remain (for instance, someone
in your organization moves on, so you remove his account on your
Zope server). When you remove a Zope user, objects that were owned
by that user still have ownership information that refers to that
user. This will not cause an error, but it is important to
understand what happens to Zope objects whose owners no longer
exist.
This is most important for "executable" objects. Usually, the
abilities of executable objects are constrained by the abilities
of the object's owner as well as the user causing the object to
execute. If Zope cannot find the user that the executable's
ownership information refers to when it tries to execute the
object, it will use the special 'nobody' or anonymous user
instead. The 'nobody' user has very minimal privileges, so you
should take this into account when deciding what to do about a
user's owned objects when you delete the user. If the user had
DTML documents or other executable objects that depended upon
their owner to have a higher level of privilege than the 'nobody'
user, they will not work correctly until their ownership has been
reassigned to another user with sufficient privileges.
Controls
'Take ownership' -- Allows you (the current user) to
take the ownership of this project if you have the
'Take ownership' role.
'Take ownership' -- Gives you ownership of this object.
**Note:** This button will not show up, if you
(the current user) are the owner of the object.
**Note: For this operation you have the 'Take ownership' role.**
'Make ownership implicit (acquired)' -- Allows you
to adjust all sub-objects to have the same owner-
ship, if they have no owner.
'Make ownership implicit (acquired)' -- Remove ownership
information for this object so that it is acquired from its
container.
**Note:** This button will only show up, if the
object has an owner.
**Note: This operation will fail if it would result in a change
of ownership.**
'Make ownership explicit' -- Allows you to ignore
aquisition and set you (the current user) as the
owner of the object.
'Make ownership explicit' -- Add ownership information to this
object.
**Note:** This button will only show, if the
ownership is acquired.
All options depend on your permissions for the system,
since just a regular user would not be allowed to give
her/himself ownership to an arbitrary object.
\ No newline at end of file
lib/python/Products/OFSP/help/Product-Management.stx
View file @ 446e16cf
Product Management: Contains the Zope Products
Product Management: Contains Zope Products.
Description
There are two types of Zope products, Python-based products and
ZClasses (developed purely in Zope). You can usually differentiate
between the two by the icon. Python products have closed and
ZClasses have opened boxes as icon.
If you want to know more about these two types of products, you
will be able to find documentation on the
"Zope.org":http://www.zope.org or the
"ZDP":http://zdp.zope.org site.
Description
The Product Management Folder contains installed Zope Products.
There are two types of Zope products, Python Products which are
installed in the filesystem and
Products created through the web.
lib/python/Products/OFSP/help/Product.stx
View file @ 446e16cf
Product - Allows you ro extend Zope
Product - Zope extension.
Description
Description
Products allow you to extend Zope by creating new types of addable Zope
objects.
A Product contains other objects such as ZClasses and Factories
which allows you
to make your objects available via the product add list.
Products allow you to extend Zope by creating new types of addable Zope
objects.
**Note:** You can only create and manipulate ZClass-based Products
using the Zope Management interface.
A Product contains other objects including a Factory which allows you
to make your Product objects available via the Product add list. You
basically will be able to specify you own objects, like Image or
User.
lib/python/Products/OFSP/help/Product_Add.stx
View file @ 446e16cf
Product - Add: Create a new Product
Product - Add: Create a Product.
Description
Description
This view allows you to create a new Product.
Controls
'Id' -- Allows you to specify the id of the Product.
This view allows you to create a new Product.
'Title' -- Allows you to specify the title of the Product.
Controls
'Add' -- Clicked, Zope will create a Product in the Product Folder.
'Id' -- The id of the Product.
'Title' -- The optional title of the Product.
'Generate' -- Creates a new Product.
lib/python/Products/OFSP/help/Product_Distribution.stx
View file @ 446e16cf
Product - Distribution: Create a Product distribution
Product - Distribution: Create a Product distribution.
Description
Description
This view allows you to create a distribution from a control panel product.
A product distribution is a packaged version of a control panel
product which is meant to be shipped to users. A distribution provides limited
access to the internals of a product.
This view allows you to create a distribution from a Product.
Controls
A Product Distribution is a packaged version of a Product which is
meant to be shipped to users. A Distribution provides limited
access to the internals of a Product.
'Version' -- Allows you to specify the version of the objects you want to
archive/release.
Distribution files are installed by unpacking them in the Zope
directory.
'Configurable Objects' -- Allows you to specify the objects that will be included in the this
distributions. These will be the objects that will appear when the
release is installed as a Zope product.
Controls
'Create a distribution archive' -- Clicked, Zope will generate the archive and offer you to
download the GZipped file. The distribution file can be installed in other Zopes by
unzipping and untarring it inside the Zope directory.
'Version' -- The version of the Product distribution.
'Configurable objects' -- The objects that will be exposed by the
distribution. These will be the objects that will appear when the
distribution is installed as a Zope product.
'Create a distribution archive' -- Creates a distribution file and
downloads it to your local computer.
lib/python/Products/OFSP/help/Properties.stx
View file @ 446e16cf
Properties - Define prpoerties for your current object.
Properties - Define properties.
Description
Description
This view allows you to define properties on your current object, like a Folder
or DTML Document.
Controls
This view allows you to edit and define properties on the current
object.
The first list describes the fields that allow you to view and modify the
existing properties.
Property types
'[List of Properties]' -- Allows you to select the properties (with the checkbox)
and change the properties' values using the text filed. The default entry is the
current value of the properties.
'boolean' -- 1 or 0.
'Save Changes' -- Clicked, it will allow you to save the new values of the properties.
'date' -- A 'DateTime' value, for example '12/31/1999 15:42:52 PST'.
'float' -- A decimal number, for example '12.4'.
'Delete' -- Clicked, Zope will delete the checked Properties.
'int' -- An integer number, for example, '12'.
The next table lists all the options assisting you with creating new
properties.
'lines' -- A list of strings, one per line.
'Id' -- Allows you to specify the id (name) of the Property.
'long' -- A long integer, for example '12232322322323232323423'.
'Type' -- Select the type of the property. This is the same as specifying
the type of a variable/attribute in C/C++ or Java for example.
'string' -- A string of characters, for example 'This is a string'.
'Value' -- Allows you to specify the value of the property. Make sure that
your entered value can be wrapped into the type you specified.
**Example:** If your type is an integer, '12.1' is not
a legal value, wherby '12' is. Please see the table on types below.
**Note:** When creating 'selection' and 'multiple
selection' properties, specify the name of another property (or
method) as the 'Value'. This property (or method) should
return a list of strings will be used to provide choices for the
selection.
'text' -- A multi-line string, for example a paragraph.
'Add' -- Clicked, the property will be added to the object.
This table lists all the property types and lists the allowed values
for each.
'tokens' -- A list of strings separated by white space, for example
'one two three'.
Property Types with description
'selection' -- A string selected by a pop-up menu.
boolean -- 1 or 0.
'multiple selection' -- A list of strings selected by a selection list.
date -- A 'DateTime' value, for example '12/31/1999 15:42:52 PST'.
**Note:** DateTime objects in Zope are *not*
implemented using the 'mxDateTime' module. Therefore, not
all of the mxDateTime date syntax is supported.
Controls
float -- A decimal number, for example '12.4'.
Editing Properties
int -- An integer number, for example, '12'.
Existing properties can be edited by selecting them.
lines -- A list of strings, one per line.
'[Checkbox]' -- Select the properties to change.
'Property' -- The value of the property.
long -- A long integer, for example '12232322322323232323423'.
'Save Changes' -- Changes the value of the selected properties.
string -- A string of characters, for example 'This is a string'.
'Delete' -- Deletes the selected properties.
text -- A muli-line string, for example a paragraph.
Creating new properties
tokens -- A list of strings separated by white space, for example
'one two three'.
'Id' -- The id of the property.
selection -- A string selected by a pop-up menu.
'Type' -- The type of the property.
multiple selection -- A list of strings selected by a selection list.
'Value' -- The value of the property.
**Note: When creating 'selection' and 'multiple selection'
properties, specify the name of another property (or method)
as the 'Value'. This property (or method) should return a
list of strings will be used to provide choices for the
selection.**
'Add' -- Creates a new property.
lib/python/Products/OFSP/help/PropertySheet.py
View file @ 446e16cf
......@@ -102,7 +102,7 @@ class PropertySheet:
there is no default namespace for a given property sheet
(especially property sheets added in ZClass definitions).
Permission -
Permission -- XXX
"""
......@@ -112,17 +112,17 @@ class PropertySheet:
Get the property 'id', returning the optional second
argument or None if no such property is found.
Permission -
Permission -- XXX
"""
def getPropertyType(self, id):
"""
Get the type of property 'id'. returns None if no such
Get the type of property 'id'. Returns None if no such
property exists.
Permission -
Permission -- XXX
"""
......@@ -132,7 +132,7 @@ class PropertySheet:
Returns true if 'self' has a property with the given 'id',
false otherwise.
Permission - 'Access contents information'
Permission -- 'Access contents information'
"""
......@@ -141,7 +141,7 @@ class PropertySheet:
Returns a list of property ids.
Permission - 'Access contents information'
Permission -- 'Access contents information'
"""
......@@ -150,7 +150,7 @@ class PropertySheet:
Returns a list of actual property values.
Permission - 'Access contents information'
Permission -- 'Access contents information'
"""
......@@ -159,7 +159,7 @@ class PropertySheet:
Return a list of (id, property) tuples.
Permission - 'Access contents information'
Permission -- 'Access contents information'
"""
......@@ -168,7 +168,7 @@ class PropertySheet:
Returns a tuple of mappings, giving meta-data for properties.
Perimssion -
Perimssion -- XXX
"""
......@@ -177,7 +177,7 @@ class PropertySheet:
Returns a mapping containing property meta-data.
Permission
Permission -- XXX
"""
......@@ -185,16 +185,17 @@ class PropertySheet:
"""
Add a new property with the given 'id', 'value' and 'type'.
Supported values for the 'type' argument are outlined below
in the section "property types". This method will use the
passed in 'type' to try to convert the 'value' argument to
the named type. If the given 'value' cannot be converted,
a ValueError will be raised.
*If the given 'type' is not recognized, the 'value' and 'type'
given are simply stored blindly by the object. This seems like
Property Types
XXX
This method will use the passed in 'type' to try to convert
the 'value' argument to the named type. If the given 'value'
cannot be converted, a ValueError will be raised.
*If the given 'type' is not recognized, the 'value' and 'type'
given are simply stored blindly by the object. This seems like
bad behavior - it should probably raise an exception instead.*
If no value is passed in for 'REQUEST', the method will return
......@@ -205,7 +206,7 @@ class PropertySheet:
This method may be called via the web, from DTML or from
Python code.
Permission - 'Manage Properties'
Permission -- 'Manage Properties'
"""
......
lib/python/Products/OFSP/help/PropertySheets.py
View file @ 446e16cf
......@@ -110,7 +110,7 @@ class PropertySheets:
Return a sequence of all of the PropertySheet objects for
in the collection.
Permission -
Permission - XXX
"""
......@@ -120,7 +120,7 @@ class PropertySheets:
Return a sequence containing an '(id, object)' tuple for
each PropertySheet object in the collection.
Permission -
Permission - XXX
"""
......@@ -130,6 +130,15 @@ class PropertySheets:
Return the PropertySheet identified by 'name', or the value
given in 'default' if the named PropertySheet is not found.
Permission -
Permission - XXX
"""
lib/python/Products/OFSP/help/Request.py
View file @ 446e16cf
......@@ -99,30 +99,62 @@ class Request:
- Environment variables
These variables include input headers, server data, and other
request-related data. The variable names are as <a
href="http://hoohoo.ncsa.uiuc.edu/cgi/env.html">specified</a>
in the <a
href="http://hoohoo.ncsa.uiuc.edu/cgi/interface.html">CGI
specification</a>
These variables include input headers, server data, and
other request-related data. The variable names are as <a
href="http://hoohoo.ncsa.uiuc.edu/cgi/env.html">specified</a>
in the <a
href="http://hoohoo.ncsa.uiuc.edu/cgi/interface.html">CGI
specification</a>
- Form data
These are data extracted from either a URL-encoded query
string or body, if present.
These are data extracted from either a URL-encoded query
string or body, if present.
- Cookies
These are the cookie data, if present.
These are the cookie data, if present.
- Other
Data that may be set by an application object.
Data that may be set by an application object.
The request object may be used as a mapping object, in which case
values will be looked up in the order: environment variables,
other variables, form data, and then cookies.
Special Variables
These special variables are set in the Request
'PARENTS' -- A list of the objects traversed to get to the
published object. So, 'PARENTS[0]' would be the ancestor of
the published object.
'REQUEST' -- The Request object.
'RESPONSE' -- The Response object.
'URL' -- The URL of the Request without query string.
*URLn* -- 'URL0' is the same as 'URL'. 'URL1' is the same as
'URL0' with the last path element removed. 'URL2' is the same
as 'URL1' with the last element removed. Etcetera.
For example if URL='http://localhost/foo/bar', then
URL1='http://localhost/foo' and URL2='http://localhost'.
*BASEn* -- 'BASE0' is the URL up to but not including the Zope
application object. 'BASE1' is the URL of the Zope application
object. 'BASE2' is the URL of the Zope application object with
an additional path element added in the path to the published
object. Etcetera.
For example if URL='http://localhost/Zope.cgi/foo/bar', then
BASE0='http://localhost', BASE1='http://localhost/Zope.cgi',
and BASE2='http://localhost/Zope.cgi/foo'.
"""
......@@ -190,3 +222,13 @@ class Request:
Permission - Always available
"""
lib/python/Products/OFSP/help/Response.py
View file @ 446e16cf
......@@ -98,7 +98,7 @@ class Response:
Sets the HTTP status code of the response; the argument may
either be an integer or one of the following strings:
{ OK,
OK,
Created,
Accepted,
NoContent,
......@@ -113,11 +113,10 @@ class Response:
NotImplemented,
BadGateway,
ServiceUnavailable
}
that will be converted to the correct integer value.
Permission - Always available
Permission -- Always available
'''
......@@ -130,7 +129,7 @@ class Response:
preserved, otherwise word-capitalization will be performed on
the header name on output.
Permission - Always available
Permission -- Always available
'''
......@@ -140,7 +139,7 @@ class Response:
Set a new HTTP return header with the given value, while
retaining any previously set headers with the same name.
Permission - Always available
Permission -- Always available
'''
......@@ -149,7 +148,7 @@ class Response:
Set the base URL for the returned document.
Permission - Always available
Permission -- Always available
"""
......@@ -161,7 +160,7 @@ class Response:
cookie has previously been set in the response object, the new
value is appended to the old one separated by a colon.
Permission - Always available
Permission -- Always available
'''
......@@ -179,7 +178,7 @@ class Response:
when creating the cookie. The path can be specified as a keyword
argument.
Permission - Always available
Permission -- Always available
'''
......@@ -193,7 +192,7 @@ class Response:
"value". This overwrites any previously set value for the
cookie in the Response object.
Permission - Always available
Permission -- Always available
'''
......@@ -206,7 +205,7 @@ class Response:
appending it following a comma if there was a previous value
set for the header.
Permission - Always available
Permission -- Always available
'''
......@@ -215,7 +214,7 @@ class Response:
Cause a redirection without raising an error
Permission - Always available
Permission -- Always available
"""
......@@ -233,5 +232,7 @@ class Response:
Note that published objects must not generate any errors
after beginning stream-oriented output.
Permission -- XXX
"""
lib/python/Products/OFSP/help/Security.stx
View file @ 446e16cf
Security - Define security settings
Security - Define security settings.
Description
This view allows you to define security settings for this item.
This view allows you to define security settings.
Security settings are defined in terms of roles and permissions. When a role is
assigned to a permission, users with the given role will be able to perform
tasks associated with the permission on this item.
Security settings are defined in terms of *roles* and
*permissions*. When a role is assigned to a permission users with
the given role will be able to perform tasks associated with the
permission on the object.
Controls
Assign Roles to Permissions
Roles are listed as columns, and permissions are listed as rows.
To assign a role to a permission, check the checkbox at the intersection of the
row and column. You can also manage roles and permissions individually by
clicking on their name links.
Roles are listed in columns and permissions are listed in rows.
To assign a role to a permission check the checkbox at the
intersection of the row and column. You can also manage roles
and permissions individually by clicking on their name links.
Create Roles
You can create new roles by entering the role name in the text
entry field under the 'User defined roles' heading and
clicking the 'Add Role' button. You can delete any existing
user defined roles by selecting them from the selection list under the
'User defined roles' heading and clicking the 'Delete
Role' button.
entry field under the 'User defined roles' heading and clicking
the 'Add Role' button. You can delete any existing user defined
roles by selecting them from the selection list under the 'User
defined roles' heading and clicking the 'Delete Role' button.
Local Roles
......@@ -33,20 +33,22 @@ Security - Define security settings
Assign Permissions to a Role
You can manage the permissions assigned to a role by clicking on the role name.
You can manage the permissions assigned to a role by clicking on
the role name.
Assign Roles to a Permission
You can manage the roles assigned to a permission by clicking on the permission name.
You can manage the roles assigned to a permission by clicking on
the permission name.
Acquire Permissions
The 'Acquire permission settings' check box next
to each permission indicates whether this item should inherit security settings
for this permission from its container object.
The acquired permission
settings may be augmented by selecting roles for a permission in addition to
selecting to acquire permissions.
The 'Acquire permission settings' check box next to each
permission indicates whether this item should inherit security
settings for this permission from its container object. The
acquired permission settings may be augmented by selecting roles
for a permission in addition to selecting to acquire
permissions.
You can manage the acquisition of permission
settings individually by clicking the 'Acquire permission
......
lib/python/Products/OFSP/help/Security_Define-Permissions.stx
View file @ 446e16cf
Security - Define Permissions: Define permissions for an object
Security - Define Permissions: Map permissions.
Description
Description
Permissions are used to represent abstract operations or
types of usage. A permission may correspond to many
low-level object operations. Permissions provide a way to
control access to operations without having to list each
operation explicitly.
When creating products or ZClasses, we use high-level
objects, like DTML Methods to define operations. These
high-level objects have thier own permissions, which
represent abstract operations on the low-level
operations of these high-level objects.
When defining permissions for our products and ZClasses,
we need to define what low-level operations these new
permissions correspond to. We could enumerate the
low-level operations of the high-level objects used to
implement the operations of our products or ZClasses, but
this would be:
* Cumbersone,
* Error prone, and
* likely to break as the interfaces of the high-level
objects evolve.
What we do instead is to treat the permissions of the
high-level objects used to implement a product or ZClass'
operations as the low-level operations that the product or
ZClass operation's abstract.
This is done via the "Define Permissions" view.
The "Define Permissions" view is used to define how the
operations of this object (or objects that acquire
permission settings from this object) correspond to the
operations defined by your product or ZClass.
The view has a table with two columns. The first
column lists the permissions for an object. The second
column specifies the permissions that should have this
permission in this product or ZClass. For ZClass methods,
only permissions that are defined for the ZClass are
permitted.
In general, any permissions that include operations that
change (mutate) an object should be disabled. Otherwise,
a method could be modified when used on an instance, such
as a ZClass instance.
The "Define Permissions" view is used to define how the operations
of this object (or objects that acquire permission settings from
this object) correspond to the operations defined by your product
or ZClass.
Permissions
This interface is used to define how the operations of this object (or
objects that acquire permission settings from this object) correspond
to the operations defined by your product or ZClass.
Note that the 'View' permission should be always mapped to the
'View' permission, since every user, even 'Anonymous User'
has this permission.
Controls
Permissions are used to represent abstract operations or types of
usage. A permission may correspond to many low-level object
operations. Permissions provide a way to control access to
operations without having to list each operation explicitly.
'Permission for this object' -- This column shows you all the permissions
that are currently defined for this object.
'Permissions that ...' -- The 'Permissions that correspond to (i.e. have)
this permission' column allows you to map the object-specific
permissions to the general ones. These general permissions are
then linked to the user roles.
'Change' -- Clicked, Zope will commit the changes.
When creating Products or ZClasses, we use high-level objects,
like DTML Methods to define operations. These high-level objects
have their own permissions, which represent abstract operations on
the low-level operations of these high-level objects.
When defining permissions for our products and ZClasses we need
to define what low-level operations these new permissions
correspond to. We could enumerate the low-level operations of
the high-level objects used to implement the operations of our
products or ZClasses, but this would be cumbersome, error prone,
and likely to break as the interfaces of the high-level objects
evolve.
What we do instead is to treat the permissions of the high-level
objects used to implement a Product or ZClass operations as the
low-level operations that the product or ZClass operations
abstract.
Controls
The view has a table with two columns. The first column lists the
permissions for an object. The second column specifies the
permissions that should have this permission in this product or
ZClass. For ZClass methods only permissions that are defined for
the ZClass are permitted.
In general any permissions that include operations that change
(mutate) an object should be disabled. Otherwise, a method could
be modified when used on an instance, such as a ZClass instance.
This interface is used to define how the operations of this object
(or objects that acquire permission settings from this object)
correspond to the operations defined by your product or ZClass.
**Note: The 'View' permission should be always mapped to the
'View' permission, since every user, even 'Anonymous User' has
this permission.**
'Permission for this object' -- The object permission to map.
'Permissions that correspond to (i.e. have) this permission' --
The Product or ZClass permission to map to.
'Change' -- Changes the permissions mapping.
lib/python/Products/OFSP/help/Security_Local-Roles.stx
View file @ 446e16cf
Folder - Local Roles: Allows you to manage local roles
Folder - Local Roles: Manage local roles.
Description
Description
Local roles allow you to give a particular user additional roles (permissions) for
this Folder (and it children) additional to the regular ones.
Controls
'[User List]' -- Allows you to select select users. When clicking on the user name,
you will enter the user's local roles managemant screen.
**Note:** There will be no such list, if no local roles are defined.
'Remove' -- Upon click, Zope will delete all the checked (in the user list) users' local
roles.
**Note:** There will be no 'Remove' button, if local roles are defined.
'Users'[Select List] -- Select a user for which you would like to define a local role.
'Roles'[Multi Select] -- Select all the roles you would like to assign to this user
as local roles.
'Add' -- Clicked, the local roles for the chosen user will be added as local roles to
the Folder. You will be brought back to the same screen. If a role was already
assigned to a certain user, the system will reassign the role and proceed
without any further notification.
Local roles allow you to give users additional roles in the
context of an object.
Controls
Editing local roles
'[Checkbox]' -- Select users. Click a user's name to edit their
local roles.
'Remove' -- Deletes local roles for the selected users.
Creating local roles
'User' -- The user for which you would like to define local
roles.
'Roles' -- The local roles you would like to assign to the user.
'Add' -- Adds the selected local roles for the selected user.
lib/python/Products/OFSP/help/Security_Manage-Acquisition.stx
View file @ 446e16cf
Folder - Manage Permissions Acquisition: Manage Securoty Acquisition settings
Security - Permissions Acquisition: Security acquisition settings.
Description
Description
This view allows you to manage security acquisition settings.
This view allows you to manage security acquisition settings. You
can control which permissions acquire security settings.
Controls
Controls
'[Permissions List]' -- Allows you to select the permissions which should acquire security settings.
'[Permissions List]' -- The permissions which
should acquire security settings.
'Change' -- Clicked, it will change the security acquisition settings for the Folder.
'Change' -- Sets the acquisition settings.
lib/python/Products/OFSP/help/Security_Manage-Permission.stx
View file @ 446e16cf
Folder - Manage Permission: Allows you to assign roles to a permission
Folder - Manage Permission: Assign roles to a permission.
Description
Description
This view allows you to assign roles to different perissions.
This view allows you to assign roles to a permission.
Controls
Controls
'[User List]' -- Allows you to select all the users that will have this permission
(indicated in bold and italic font).
'[Role List]' -- The roles assigned to the permission.
**Inheritence?** -- The 'Also use roles acquired from folders containing this object'
check box indicates whether or not to acquire permissions settings for the
named permission.
'Also use roles acquired from folders containing this object' --
Whether or not to acquire permissions settings for the permission.
'Change' -- Clicked, it will set the permissions for the selected user.
'Change' -- Changes the security settings.
lib/python/Products/OFSP/help/Security_Manage-Role.stx
View file @ 446e16cf
Folder - Manage Role: Assign permissions to a role
Folder - Manage Role: Assign permissions to a role.
Description
Description
This view allows you to assign permissions to a role.
This view allows you to assign permissions to a role.
Controls
Controls
'[Permissions List]' -- Allows you to select the permissions the role (shown in bold italic font) has for
this object (and all its children).
'Change' -- Clicked, it will change the list of permissions for the shown user.
'[Permissions List]' -- The permissions
assigned to the role.
'Change' -- Changes the security settings.
lib/python/Products/OFSP/help/Security_User-Local-Roles.stx
View file @ 446e16cf
Folder - Manage User Local Roles: Manage a user's local role
Security - User local roles: Manage local roles.
Description
Description
This view allows you to manage a user's local roles.
This view allows you to manage a user's local roles.
Controls
Controls
'User' -- Indicates the user whose roles you going to change.
'User' -- The user whose local roles you going to change.
'Roles'[Selection List] -- Allows you to select the role(s) you wish to assign to the named user.
'Roles' -- The user's local roles.
'Change' -- Clicked, it will change the local roles for the shown user.
'Change' -- Change the local roles.
lib/python/Products/OFSP/help/Undo.stx
View file @ 446e16cf
Undo - Undo management actions
Undo - Undo management actions.
Description
This view allows you to undo changes to Zope's database.
Zope allows you to undo changes to its database. Changes are
defined in terms of transactions which group together related changes. Each
transaction has a URL and a user associated with it. In general the URL of a
transaction indicates the URL that was called to initiate the changes.
Furthermore, if an object was changed several times, and you want to recover
a version three changes back, you have to undo all the other changes first,
otherwise Zope will tell you that you cannot undo this transaction. In short,
you can undo only the leaves of the transaction tree.
Controls
'[List of Transacions]' -- Each line stands for one transaction. The transactions are sorted by
date and time. The checkbox in the front allows you to check the
transactions you would like to undo. The next entry on the line is the
URL that caused the transaction, followed by the user who commited the
transaction and the DateTime the transaction was performed.
'Earlier Transactions' -- Allows you to see transactions that were performed earlier then the
ones you currently see.
'Later Transactions' -- Allows you to see transactions that were performed later then the
ones you currently see.
'Undo' -- Clicked, Zope will attempt to undo the selected transactions. As
described above, if you selected a transaction that was not the
latest change of an object, Zope will be unable to undo this
transaction.
Description
This view allows you to undo changes to Zope's database.
Zope allows you to undo changes to its database. Changes are
defined in terms of transactions which group together related
changes. Each transaction has a URL and a user associated with
it. In general the URL of a transaction indicates the URL that was
called to initiate the changes.
If an object was changed several times and you want to recover a
version several changes back, you have to undo all the
intermediary transactions as well.
Controls
'[Checkbox]' -- Selects one or more transactions. Each line shows one
transaction. The transactions are sorted by date and time. The
checkbox in the front allows you to check the transactions you
would like to undo. The next entry on the line is the URL that
caused the transaction, followed by the user who committed the
transaction and the time transaction was performed.
'Earlier Transactions' -- Allows you to see transactions that were
performed earlier then the ones you currently see.
'Later Transactions' -- Allows you to see transactions that were
performed later then the ones you currently see.
'Undo' -- Undo the selected transactions.
lib/python/Products/OFSP/help/User-Folder.stx
View file @ 446e16cf
User Folder - Contains Zope users
User Folder - Defines users.
Description
Description
User Folders define Zope users.
You can only have one User Folder per Folder. User Folders always
have 'acl_users' as an id.
User Folders allow you to define new Zope users.
You can only have one User Folder per Folder. User Folders always
have 'acl_users' as an id.
This help screen and the sections listed below are only for the
standard Zope user folder that comes with Zope itself. You can
install many other types of authentication products (user folders)
such as NTUserFolder, IMAPUserFolder, UserDB (RDB based),
etcUserFolder (authenticates off the '/etc/passwd' file)
or write your own with the help of the Generic User Folder
(GUF).
lib/python/Products/OFSP/help/User-Folder_Add-User.stx
View file @ 446e16cf
User Folder - Add User: Define a new user
User Folder - Add User: Define a new user.
Description
This view allows you to define a new user.
Controls
'Name' -- Allows you to specify the userid/login/username of the User.
'Password' -- Allows you to assign a password to the user.
'Confirm' -- Allows you to confirm the password entered above.
'Domains' -- llows you to restrict
Internet domains from which the user can log in. Domains should be
separated by spaces.
**Example:** 'digicool.com zope.org'
'Roles' -- Allows you to select the user's roles. You will always see the
'manager' and 'owner' roles. Additional roles may
appear, if you defined any in the security settings of your
objects.
Description
This view allows you to define a new user.
Controls
'Name' -- The user's name.
'Password' -- The user's password.
'Confirm' -- Confirm the user's password.
'Domains' -- Optionally allows you to restrict the
Internet domains from which the user can log in. Domains should be
separated by spaces.
For example, 'digicool.com zope.org'
'Roles' -- The user's roles
'Add' -- Create a new user.
lib/python/Products/OFSP/help/User-Folder_Contents.stx
View file @ 446e16cf
User Folder - Contents: View and manage the users
User Folder - Contents: Manage users.
Description
Description
This view allows you to manage the users defined in a user folder.
Controls
This view allows you to manage the users defined in a User Folder.
'[List of Users]' -- There is one user per line listed. The checkbox allows you to
select users you wish to delete. The username/userid is also
listed on this line. If you clcik on the username, you will be
able to edit the user's information.
'Add...' -- Clicked, it will bring you to the Add User screen.
'Delete' -- Clicked, Zope will delete all the checked users from the User
Folder.
Controls
Users are listed one per line. Click on a user to edit the user.
'[Checkbox]' -- Selects users.
'Add...' -- Adds a new user.
'Delete' -- Deletes the selected users.
lib/python/Products/OFSP/help/User-Folder_Edit-User.stx
View file @ 446e16cf
User Folder - Edit User: Edit a user
Descriptions
This view allows you to edit a user.
Controls
'Name' -- Allows you to specify the userid/login/username of the User.
'Password' -- Allows you to assign a password to the user.
'Confirm' -- Allows you to confirm the password entered above.
'Domains' -- llows you to restrict
Internet domains from which the user can log in. Domains should be
separated by spaces.
**Example:** 'digicool.com zope.org'
'Roles' -- Allows you to select the user's roles. You will always see the
'manager' and 'owner' roles. Additional roles may
appear, if you defined any in the security settings of your
objects.
Descriptions
This view allows you to edit a user.
Controls
'Name' -- The user's name.
'Password' -- The user's password.
'Confirm' -- Confirm the user's password.
'Domains' -- Optionally allows you to restrict the
Internet domains from which the user can log in. Domains should be
separated by spaces.
For example, 'digicool.com zope.org'
'Roles' -- The user's roles
'Change' -- Change the user.
\ No newline at end of file
lib/python/Products/OFSP/help/Version-Management.stx
View file @ 446e16cf
Version Management - Control all Zope versions
Version Management - Control Zope versions.
Description
Description
Version Management allows you to control Zope Versions for a central
location.
That is in particular useful, when you try to get an overview on which
parts of the Web Site people currently work on.
Version Management allows you to control all Zope Versions.
\ No newline at end of file
lib/python/Products/OFSP/help/Version-Management_Version.stx
View file @ 446e16cf
Version Management - Version: Manage active versions
Description
This view allows you to manage active versions.
Controls
The following options and information will be only available, if there
are any versions initiated in this object tree (in this ZODB) and some
work was done using the activated version.
'[List of Versions]' -- There is one version per line. The checkbox allows
you to select each version you would either like to 'Save' or to 'Discard'.
Beside it you will find the path of the version, so you will be able
to see in which Folder the version is and what name (id) it has. Upon
clicking on the path, you will be taken to the 'Join/Leave'
management screen of this version.
'Save' -- Clicked, Zope will commit all the changes made by the selected
version to the public.
'Discard' -- Clicked, Zope will discard all the transactions saved by the
selected versions and not commit them to the public .
Version Management - Version: Manage versions.
Description
This view allows you to manage versions.
Controls
Non-empty versions are listed one per line. Click on a version to
edit it.
'[Checkbox]' -- Selects versions.
'Save' -- Commits the selected versions.
'Discard' -- Aborts the selected versions.
lib/python/Products/OFSP/help/Version.stx
View file @ 446e16cf
Version - Create "private sessions"
Version - Private session.
Description
A Version allows you to make changes to Zope in a private
session.
But what is a version? Since making objects is transaction-based, you
can make the difference between publicly and privately available
transactions (read changes). When you create a version and start
working in it, all the transactions (changes) you do are only done
privately, so that you the owner of the version can see the changes,
but the rest of the Web site still sees the old version of the
object until you commit the changes to the public. After you review
the changes you can discard them or make them live.
That can be extremely useful when you have to make changes to live
sites, where changing one object might break the site for a while
till you changed another one.
Description
A Version allows you to make changes to Zope in a private session.
No one else can see changes you make in a Version. Later you can
make your changes public or discard them.
Objects changed in a Version are locked.
lib/python/Products/OFSP/help/Version_Add.stx
View file @ 446e16cf
Version - Add: Create a new version
Description
This view allows you to create a new Version.
Controls
'Id' -- Allows you to specify the id of the Version.
'Title' -- Allows you to specify the title of the Version.
'Add' -- Clicked, Zope creates a new version.
**Note:** The version is deactivated by default. You need to enter the
'Join/Leave' Version management screen in order to activate the Version.
Version - Add: Create a new Version
Description
This view allows you to create a new Version.
Controls
'Id' -- The id of the Version.
'Title' -- The optional title of the Version.
'Add' -- Creates a new Version.
......
lib/python/Products/OFSP/help/Version_Join-Leave.stx
View file @ 446e16cf
Version - Join/Leave: Start/Stop working on a private version
Version - Join/Leave: Start/Stop working in a Version.
Description
This view allows you to start and stop working in a private
version. When you are working in a version all changes you make will be hidden
from other users. You may join and leave a session as many times as necessary
until you are ready to commit the version or discard it.
The 'Start Working in' button allows you to join
the version. The 'Quit Working in' button allows you to leave
the version.
Description
This view allows you to start and stop working in a private
Version.
When you are working in a version all changes you make will be
hidden from other users. You may join and leave a Version as many
times as necessary until you are ready to commit the Version or
discard it.
Controls
'Start Working in' -- Join the Version.
'Quit Working in' -- Leave the Version.
lib/python/Products/OFSP/help/Version_Properties.stx
View file @ 446e16cf
Version - Properties: Edit Version Properties
Version - Properties: Edit Version Properties.
Description
Description
This view allows you to edit the title of the version.
This view allows you to edit the title of a Version.
Controls
Controls
'Id' -- Indicates the id of the Version.
'Title' -- The title of the Version.
'Edit' -- Changes the title of the Version.
'Title' -- Allows you to specify the title of the Version.
'Edit' -- Clicked, Zope will change the title of the version.
lib/python/Products/OFSP/help/Version_Save-Discard.stx
View file @ 446e16cf
Version - Save/Discard: Allows to commit/discard Changes
Version - Save/Discard: Commit/abort Version changes.
Description
This view allows you to either commit or discard changes made in this version.
Controls
'[Comments textarea]' -- Allows you to enter some comments regarding the current
version, before saving or discarding the version.
**Note:** Comment fields are very common in version control systems. You should
use it to describe some basic changes you made to the system, so that you can refer
back to them later on.
'Save' -- Clicked, it will allow you to commit the changes in the version and make them
publically available.
'Discard' -- Clicked, Zope will discard all of the changes made using the version. None
of the transactions will be publically available and are deleted from the
version records.
Description
This view allows you to commit or discard changes made in a
Version.
Controls
When committing or discarding a Version you can enter comments in
the comments text area.
'Save' -- Commit the changes in the Version and make them public.
'Discard' -- Discard the changes made in the Version.
lib/python/Products/OFSP/help/ZClass.stx
View file @ 446e16cf
ZClass - Define new/custom Zope Objects
Description
ZClass - Define new Zope objects.
Description
ZClasses define new types of Zope objects.
ZClasses allow you to define new types of Zope objects.
ZClasses are only one way to create your custom Zope objects. You
can also write a Python product. ZClasses have the advantage that
you can create them entirely in the Zope management interface and
test them without restarting Zope all the time.
Furthermore, ZClasses are usually faster developed than real
Python products. You can easily inherit the properties of other
Zope objects and use existing objects to organize and display
your data. ZClasses are perfect for prototyping!
The disadvantage of ZClasses is that you are restricted in some
areas, where Python products could do more. Further, there is no
good way to upgrade from an older version to a new one yet.
lib/python/Products/OFSP/help/ZClass_Add.stx
View file @ 446e16cf
ZClass - Add: Add a new ZClass
Description
This view allows you to create a new ZClass.
Controls
'Id' -- Allows you to specify the id of the ZClass.
'Title' -- Allows you to specify the title of the ZClass.
'Meta type' -- Allows you to specify the name of the ZClass as it will appear in the
product add list.
'Create constructor objects' -- Allows you to specify whether you would like Zope
to automatically create the necessary objects to construct new ZClass instances. If
checked it will create a new Zope Permission, Zope Factory, add method and add form.
**Note:** If you are not sure about this option, just leave it checked.
'Base classes' -- Allows you to specify base classes for your ZClass. To add a base
class select it from the 'Unselected' list and click the right
arrow button. The base class should be added to the selected list. To
remove a base class select it from the 'Selected' list and
click the left arrow button. The names of base classes are divided
into two parts seperated by a colon indicating the product name and
the class name of the base class.
'Include standard Zope persistent object base classes' -- Allows you to specify
whether or not your ZClass should subclass Zope persistence classes and thereby act
as a normal persistent object.
'Add' -- Clicked, Zoep will create the ZClass and if selected, it will
also generate the constructor objects.
Description
This view allows you to create a new ZClass.
Controls
'Id' -- The id of the ZClass.
'Title' -- The optional title of the ZClass.
'Meta type' -- The name of the ZClass as it will appear in the
product add list.
'Create constructor objects' -- Create the necessary objects to
construct new ZClass instances. The created constructor objects are
a Zope Permission, a Zope Factory, an add method and an add form.
**Note: You must specify a 'Meta type' to create constructor objects**
'Base classes' -- Base classes of the ZClass.
To add a base class select it from the 'Unselected' list and
click the right arrow button. To remove a base class select it
from the 'Selected' list and click the left arrow button. The
names of base classes are divided into two parts separated by a
colon indicating the product name and the class name of the base
class. The order of Base classes is important.
'Include standard Zope persistent object base classes' -- Subclass
Zope persistence classes and thereby act as a normal persistent
object.
'Add' -- Creates the ZClass.
lib/python/Products/OFSP/help/ZClass_Basic.stx
View file @ 446e16cf
ZClass - Basic: Manage basic attributes
ZClass - Basic: Basic class attributes.
Description
This view allows you to manage the basic attributes of a ZClass.
Controls
'Base classes' -- Indicates the base classes of the ZClass.
'Title' -- Allows you to specify the title of the ZClass.
'Meta type' -- Allows you to specify the product name of the ZClass as it appears in
the product add list.
'class id' -- Allows you to specify a unique class identifier for the ZClass.
'icon' -- Allows you to specify the path to the ZClass's icon.
'Icon Image' -- Allows you to upload a new image file to sever as the ZClass's icon.
The uploaded image file should be a 16x16 pixel GIF file. To locate
and select an image file for upload, click the 'Browse' button.
'Change' -- Clicked, Zope will commit the changes and upload the image, if a
filename was specified in the Icon Image field.
Description
This view allows you to manage the basic attributes of a ZClass.
Controls
'Title' -- The title of the ZClass.
'Meta type' -- The name of the ZClass as it appears in the product
add list.
'class id' -- The unique class identifier for the ZClass.
'icon' -- The path to the ZClass's icon.
'Icon image' -- Upload a new image file to sever as the ZClass's
icon. Use the 'Browse...' button to local a file to upload.
The uploaded icon file should be a 16x16 pixel GIF file.
'Change' -- Change the ZClass.
lib/python/Products/OFSP/help/ZClass_Define-Permissions.stx deleted 100644 → 0
View file @ f33d10f5
ZClass - Define Permissions: Define relevant permissions for the ZClass
Description
This interface is used to define how the operations of this object (or
objects that acquire permission settings from this object) correspond
to the operations defined by your product or ZClass.
Note that the 'View' permission should be always mapped to the
'View' permission, since every user, even 'Anonymous User'
has this permission.
Controls
'Permission for this object' -- This column shows you all the permissions
that are currently defined for this object.
'Permissions that ...' -- The 'Permissions that correspond to (i.e. have)
this permission' column allows you to map the object-specific
permissions to the general ones. These general permissions are
then linked to the user roles.
'Change' -- Clicked, Zope will commit the changes.
lib/python/Products/OFSP/help/ZClass_Methods.stx
View file @ 446e16cf
ZClass - Methods: Manage the ZClass methods
ZClass - Methods: Manage ZClass methods.
Description
Description
This view allows you to manage ZClass methods.
A ZClass inherits methods from its base classes. It can also
contain methods which are managed through the web. This view
allows you to create and edit methods such as DTML Methods, ZSQL
Methods, and External Methods though the web. Methods that you
create through the web will be accessible as methods on instances
of the ZClass.
The creation and management of methods proceeds exactly like the
management of a Folder's contents. See "Folder - Contents". The
main difference between editing method objects and normal objects
is that methods have a 'Define Permissions' view in place of a
'Security' view. See "Security - Define Permissions".
If you create ZClasses inside the Methods view of a ZClass
instances of the inner class will be addable to instances of the
outer class. Typically the outer class will subclass
'ObjectManager' and the inner class will be only relevant inside
the outer class.
This view allows you to manage a class's methods.
A ZClass inherits methods from its base classes. It can also contain methods
which are managed through the web. This view allows you to manage methods
though the web. Methods that you create through the web will be accessible as
methods on instances of the ZClass.
The creation and management of methods proceeds exactly like the
management of a folder's contents. See "Folder - Contents".
The main difference between editing method objects
and normal objects is that methods have a 'Define Permissions' view in
place of a 'Security' view. See "ZClass - Define Permissions".
If you create ZClasses inside the Methods view of a ZClass instances of the
inner class will be addable to instances of the outer class. Typically the
outer class will subclass 'ObjectManager' and the inner class will be
only relevant inside the outer class.
lib/python/Products/OFSP/help/ZClass_Permissions.stx
View file @ 446e16cf
ZClass - Permissions: Select usable ZClass permissions
ZClass - Permissions: Select ZClass permissions.
Description
Description
This view allows you to select permissions to be used by a ZClass.
When setting permissions for individual methods or property sheets
of a ZClass, you will be able to select from inherited permissions and
those permission which you set with this view.
Controls
This view allows you to select permissions to be used by a ZClass.
'Class permissions' -- Allows you to select the permissions you like your class to
inherit. The multi select field lists all the permissions
available in Zope.
'Inherited permissions' -- Indicates the inherited permissions of your ZClass.
When setting permissions for individual methods or property sheets
of a ZClass, you will be able to select from inherited permissions
and class permission which you set with this view.
'Change' -- Clicked, Zope will add the selected permissions to the
list of the inherited ZClass permissions.
Controls
'Class permissions' -- The permissions available to your ZClass in
addition to inherited permissions.
'Inherited permissions' -- Indicates the inherited permissions of
your ZClass.
'Change' -- Change Class permissions.
lib/python/Products/OFSP/help/ZClass_Property-Sheets.stx
View file @ 446e16cf
ZClass - Property Sheets: Manage ZClass property sheets
Description
This view allows you to manage a ZClass's property sheets.
Property sheets provide a way to organize ZClass properties. A property
sheet defines default values for ZClass instance attributes and provides
an editing method for the attributes.
The creation and management of property sheets proceeds exactly like
the management of a folder's contents. See "ObjectManager - Contents".
ZClass - Property Sheets: Manage ZClass property sheets.
Description
This view allows you to manage a ZClass's property sheets.
Property sheets provide a way to organize ZClass properties. A property
sheet defines default values for ZClass instance attributes and provides
an editing method for the attributes.
The creation and management of property sheets proceeds exactly like
the management of a Folder's contents. See "ObjectManager - Contents".
lib/python/Products/OFSP/help/ZClass_Subobjects.stx
View file @ 446e16cf
ZClass - Subobjects: Define suboject types
ZClass - Subobjects: Define suboject types.
Description
......@@ -7,12 +7,13 @@ ZClass - Subobjects: Define suboject types
Controls
[select list] -- Select one or more of the listed meta-types
to indicate that objects of these types can be added to
instances of your ZClass.
Select one or more of the listed meta-types to indicate that
objects of these types can be added to instances of your ZClass.
'Objects should appear in folder lists' -- Controls whether or not
instances of your ZClass appear as folders in the left Zope
management frame.
'Change' -- Change subobject settings.
Objects should appear in folder lists -- Controls whether or not
instances of your ZClass appear as folders in the left Zope
management frame.
Change -- Makes the changes
\ No newline at end of file
lib/python/Products/OFSP/help/ZClass_Views.stx
View file @ 446e16cf
ZClass - Views: Manage ZClass views
Description
This view allows you to manage a ZClass's views.
Views are managements screens that are available as tabs while managing a
Zope object. To provides through the web management for your ZClasses you
need to define management views. Each management view consists of a name
and a method. When the management view is selected by the user the view's
method is executed. Typically view methods are edit forms. Note: a view will
not be visible to a user unless they have adequate permissions to execute
the view method.
Controls
'[Views]' -- Each line represents one view of the Zope object. All views listed
in the list will be available as labels on teh top of the right
Zope management screen when working in the object.
The 'name' of the view indicates the labels text that will
appear on the top of teh management screen. The 'Method'
selection field allows you to choose the method that will be called
when working in the specified view. The 'Help Topic' selection
list will allow you to map a help screen to the specified view. The
checkbox in the front of the line will allow you to select the views
for placing in front of the list ('First') or deleting the
view.
'Change' -- Clciked, Zope will apply all the changes to the system. All changed
objects, whether or not it is check-marked, will be updated.
'Delete' -- Clicked, it will delete all checked views.
'First' -- Takes the first selected object and places it on the top of the
view list. This feature will allow you to organize the order of the
views on the labels list.
'New' -- Allows you to create a new view. In the 'Name' field you
will be able to specify the label name of the view. The 'Method' and
'Help Topic' field are the same as above.
'Add' -- Clicked, Zope will add the new View to the Views list.
ZClass - Views: Define management views.
Description
This view allows you to manage a ZClass's views.
Views are managements screens that are available as tabs while
managing a Zope object. To provides through the web management for
your ZClass you need to define management views. Each management
view consists of a name, a method, and a help topic. When the
management view is selected by the user the view's method is
executed. Typically view methods are edit forms. Help topics
provide help for views. If a view has an associated help topic, a
help button will appear on the management view.
**Note: A view will not be visible to a user unless they have
adequate permissions to execute the view method.**
Controls
Editing Views
Views are listed one per line.
'[Checkbox]' -- Selects a view.
'Method' -- The method of the view.
'Help Topic' -- The help topic associated with the view.
'Change' -- Change the views.
'Delete' -- Delete the selected views.
'First' -- Moves the selected view to the beginning of the view
list. This allows you to change the order of the views.
Creating Views
'New' -- Allows you to create a new view. In the 'Name' field you
will be able to specify the label name of the view. The 'Method'
and 'Help Topic' field are the same as above.
'Name' -- The name of the view.
'Method' -- The method of the view.
'Help Topic' -- The help topic associated with the view.
'Add' -- Create a new view.
lib/python/Products/OFSP/help/ZSQLMethod.py
View file @ 446e16cf
......@@ -88,8 +88,8 @@ class ZSQLMethod:
"""
ZSQLMethods abstract SQL code in Zope.
They support three important abstractions:
They support three important abstractions:
- Method
......@@ -137,5 +137,8 @@ class ZSQLMethod:
The returned value is a sequence of record objects.
XXX describe record objects XXX
"""
lib/python/Products/OFSP/help/ZSearch-Interface.stx
View file @ 446e16cf
Z Search Interface: Interface to search the ZODB
Z Search Interface: Search wizard.
Description
Description
A Search Interface allows you to search Zope databases.
A Search Interface is a wizard that creates search and results forms.
The Search Interface will create a search-input form and a report
for displaying the search results. You will be able to specify
search objects (usually Z SQL Methods) that generate the contents
that is searched.
The Search Interface will create a search-input form and a report
for displaying the search results. You can search ZSQL Methods,
ZCatalogs, or any other objects that implement the searchable
interface.
lib/python/Products/OFSP/help/ZSearch-Interface_Add.stx
View file @ 446e16cf
Z Search Interface - Add: Add a Zope Search Interface
Description
This view allows you to create new a search results document and
optionally a search input form.
**Note:** This Zope feature may be more useful to Zope
starters, since a well-versed Zope user could easily
write these two methods him/herself and use some advanced
features, especially for the 'DTML-IN' tag.
Controls
'Select one or more seachable objects' -- Allows you to specify the
searchable objects (usually ZCatalogs or ZSQL Methods).
'Report Id' -- Allows you to specify the id of the result document.
'Report Title' -- Allows you to specify the title of the result document.
'Report Style' -- Allows you to specify whether the report style should group
results by 'Record' or display them all 'tabular'.
'Search Input Id' -- Allows you to specify the id of the input form.
'Search Input Title' -- Allows you to specify the title of the input form.
'Add' -- Creates 2 DTML Methods, one being the Search form and the
other for showing results.
Description
This view allows you to create new a search results document and
optionally a search input form.
Controls
'Select one or more seachable objects' -- The objects to be searched.
'Report Id' -- The id of the results document.
'Report Title' -- The optional title of the results document.
'Report Style' -- Search results format.
'Search Input Id' -- The id of the input form.
**Note: If you do not enter a search input id then no search
input form will be created.**
'Search Input Title' -- The optional title of the input form.
'Add' -- Creates a results document and optionally a search input
form.
lib/python/Products/OFSP/help/Zope-Factory.stx
View file @ 446e16cf
Zope Factory: Insert Projects into product add list
Zope Factory: Product creation facility.
Description
Description
Zope Factories allow you to insert objects into the product add
list.
Zope Factories insert objects into the product add list.
Typically Factories are used to place ZClasses in the product add
list.
They will help you to setup constructor for the new Zope object.
lib/python/Products/OFSP/help/Zope-Factory_Add.stx
View file @ 446e16cf
Zope Factory - Add: Create new Zope Factory
Zope Factory - Add: Create a Zope Factory.
Description
This view allows you to create a new Zope Factory.
Controls
'Id' -- Allows you to specify the id of the Zope Factory.
'Title' -- Allows you to specify the title of the Zope Factory.
'Add list name' -- Allows you to specify the name that will appear on the in the
product add list. It is sometimes referred to the meta type.
'Method' -- Allows you to specify what method is executed when the product
is chosen from the product add list. Typically this method is an
add form.
'Generate' -- Clicked, Zope will create the Factory and register the product
in the product list.
Description
This view allows you to create a new Zope Factory.
Controls
'Id' -- The id of the Zope Factory.
'Title' -- The optional title of the Zope Factory.
'Add list name' -- The name that will appear on the in the product
add list. In the case of ZClasses this is normally the ZClass's
meta-type.
'Method' -- The method that is executed when the product is chosen
from the product add list. Typically this method is an add form.
'Generate' -- Create the Factory and add its entry to the product
add list.
lib/python/Products/OFSP/help/Zope-Factory_Edit.stx
View file @ 446e16cf
Zope Factory - Edit: Edit Factory settings
Zope Factory - Edit: Edit Factory.
Description
This view allows you to edit factory settings.
Controls
'Id' -- Indicates the id of the Zope Factory.
'Title' -- Allows you to specify the title of the Zope Factory.
'Add list name' -- Allows you to specify the name that will appear on the in the
product add list. It is sometimes referred to the meta type.
'Method' -- Allows you to specify what method is executed when the product
is chosen from the product add list. Typically this method is an
add form.
'Permission' -- Allows you to specify what permission is needed to execute the
factory. If the user does not have the factory permission, the
factory's entry will not show up in the product add list.
'Change' -- Clicked, Zope will commit the changes to the systema and the
add Zope product list is updated.
Description
This view allows you to edit a Zope Factory.
Controls
'Title' -- The optional title of the Zope Factory.
'Add list name' -- The name that will appear on the in the product
add list. In the case of ZClasses this is normally the ZClass's
meta-type.
'Method' -- The method that is executed when the product is chosen
from the product add list. Typically this method is an add form.
'Permission' -- The permission needed to execute the factory. If
the user does not have the Factory permission, the Factory's entry
will not show up in the product add list.
'Change' -- Change the Factory and update the product add list.
lib/python/Products/OFSP/help/Zope-Permission.stx
View file @ 446e16cf
Zope Permission: Define new Permissions for ZClasses
Zope Permission: Define new Permissions.
Description
Description
Zope Permissions allow you to define new permissions for
ZClasses.
You can use your custom permissions to create special roles
for your user and have therefore more flexibility in laying
out you security model.
Zope Permissions allow you to define new permissions.
Typically new Permissions are associated with operations on ZClasses.
lib/python/Products/OFSP/help/Zope-Permission_Add.stx
View file @ 446e16cf
Zope Permission - Add: Create a new Permission
Zope Permission - Add: Create a new Permission.
Description
Description
This view allows you to create a new Permission.
Controls
This view allows you to create a new Permission.
'Id' -- Allows you to specify the id of the Zope Permission.
'Title' -- Allows you to specify the title of the Zope Permission.
'Name' -- Allows you to specify the name of the permission.<br>
**Important:** A permission's name must be unique.
'Add' -- Clicked, a new Permission for Zope will be created.
Controls
'Id' -- The id of the Zope Permission.
'Title' -- The optional title of the Zope Permission.
'Name' -- Allows you to specify the name of the permission.
**Note: A permission's name must be unique.**
'Add' -- Create a Permission.
lib/python/Products/OFSP/help/Zope-Permission_Edit.stx
View file @ 446e16cf
Zope Permission - Edit: Edit Permission settings
Zope Permission - Edit: Edit Permission.
Description
Description
This view allows you to edit Zope Permission settings.
This view allows you to edit permission settings.
Controls
Controls
'Title' -- The optional title of the Zope Permission.
'Name' -- The name of the permission.
**Note: A permission's name must be unique.**
'Change' -- Change the Permission.
'Id' -- Allows you to specify the id of the Zope Permission.
'Title' -- Allows you to specify the title of the Zope Permission.
'Name' -- Allows you to specify the name of the permission.
*Important:* A permission's name must be unique.
'Change' -- Clicked, the Permission will be changed.
lib/python/Products/ZCatalog/help/Vocabulary.py
View file @ 446e16cf
......@@ -98,10 +98,12 @@ class Vocabulary:
Query Vocabulary for words matching pattern.
Pattern format -- XXX
"""
def insert(self, word=''):
def insert(self, word):
"""
Insert a word in the Vocabulary.
......
lib/python/Products/ZCatalog/help/ZCatalog.py
View file @ 446e16cf
......@@ -89,22 +89,28 @@ class ZCatalog:
ZCatalog object
A ZCatalog contains arbirary index like references to Zope
A ZCatalog contains arbitrary index like references to Zope
objects. ZCatalog's can index either 'Field' values of object,
'Text' values, or 'KeyWord' values:
Indexes
Text -- XXX
Field -- XXX
Keyword -- XXX
Meta-data
XXX
ZCatalog does not store references to the objects themselves, but
rather to a unique identifier that defines how to get to the
object. In Zope, this unique idenfier is the object's relative
object. In Zope, this unique identifier is the object's relative
path to the ZCatalog (since two Zope object's cannot have the same
URL, this is an excellent unique qualifier in Zope).
Most of the dirty work is done in the _catalog object, which is an
instance of the Catalog class. An interesting feature of this
class is that it is not Zope specific. You can use it in any
Python program to catalog objects.
"""
def catalog_object(self, obj, uid):
......@@ -147,7 +153,7 @@ class ZCatalog:
def schema(self):
"""
Returns a sequence of names that corespond to columns in the
Returns a sequence of names that correspond to columns in the
meta-data table.
"""
......@@ -155,7 +161,7 @@ class ZCatalog:
def indexes(self):
"""
Returns a sequence of names that corespond to indexes.
Returns a sequence of names that correspond to indexes.
"""
......@@ -172,5 +178,13 @@ class ZCatalog:
Search the catalog. Search terms can be passed in the REQUEST
or as keyword arguments.
XXX search grammar, how terms are combined, special search
terms, format of returned results XXX
"""
def __call__(self, REQUEST=None, **kw):
"""
Search the catalog, the same way as 'searchResults'.
"""
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7