Skip to content

Z
Zope
Commit a8ddf90b authored by Stephan Richter's avatar Stephan Richter
Browse files
Options

New Help Content Files in STX format. They are compliant with the new 

Help Content Style Guide written by Amos.
parent 12068872
Hide whitespace changes
Inline Side-by-side
Showing with 2053 additions and 0 deletions
lib/python/Products/ExternalMethod/help/External-Method_Add.stx 0 → 100644
View file @ a8ddf90b
External Method - Add: Create a new External Method.
Description
Creates a new External Method and adds it to the
current Folder.
Controls
'ID' -- Specifies the id of the external method.
'Title' -- Allows you to specify the title of the external method.
'Function name' -- Allows you to specify the name of the function
to use for the external method.
'Python module file' -- Allows you to specify the module in which
the function is located. The Python module may be located in the
Zope 'Extensions' directory, or in a 'Extensions'
directory in a product directory. Product directories are
located in 'lib/python/Products'. If the Python
module is in a product directory this should be indicated
in the name of the module which should be the name of the
product followed by a dot followed by the name of the
Python module file.
lib/python/Products/ExternalMethod/help/External-Method_Properties.stx 0 → 100644
View file @ a8ddf90b
External Method - Properties: Manage the properties of an external method.
Description
View and manage the properties of the currebt External Method.
Controls
'ID' -- Specifies the id of the external method.
'Title' -- Allows you to specify the title of the external method.
'Function name' -- Allows you to specify the name of the function
(method) to use for the external method.
'Python module file' -- Allows you to specify the module in which
the function is located. The Python module may be located in the
Zope 'Extensions' directory, or in a 'Extensions' directory in a
product directory. Product directories are located in
'lib/python/Products'. If the Python module is in a product
directory this should be indicated in the name of the module which
should be the name of the product followed by a dot followed by
the name of the Python module file.
lib/python/Products/ExternalMethod/help/External-Method_Try-It.stx 0 → 100644
View file @ a8ddf90b
External Method - Try It: This view executes the external method.
Description
This view executes the external method and returns the results if
any. Objects, such as classes, lists and dictionaries are rendered
to a string to be displayed. Only parameters from the web request
are passed the the external method.
\ No newline at end of file
lib/python/Products/MailHost/help/Mail-Host.stx 0 → 100644
View file @ a8ddf90b
Mail Host
Mail Hosts allow you to send mail via SMTP.
**Note:** Please be aware that this object uses relaying
to send the E-Mail message. Most E-Mail servers do not allow
relaying other from themselves. So, if you have a Mail
server setup by default on your box (like for Red Hat
installs), you should be able to use your localhost as mail
server.
\ No newline at end of file
lib/python/Products/MailHost/help/Mail-Host_Add.stx 0 → 100644
View file @ a8ddf90b
Mail Host - Add: Create a new mail host
Description
This view allows you to create a new Mail Host.
Controls
'ID' -- Specifies the id of the mail host.
'Title' -- Allows you to specify the title of the mail host.
'SMTP host' -- Allows you to specify the name of the mail server. You can simply
specify teh host to be 'localhost', which should be true
for most cases.
*Important:* The mailhost must allow relaying from the the
server you are on. If the mail server is the same as the Web
server then your mail server needs to allow relaying from
'localhost' (often the default).
'SMTP port' -- Allows you to specify the port on which the mail server accepts
SMTP requests. Zope suggests port 25, which is the standard UNIX mail port.
lib/python/Products/MailHost/help/Mail-Host_Edit.stx 0 → 100644
View file @ a8ddf90b
Mail Host - Edit: Edit mail host properties
Description
This view allows you to manage the attributes of the mail host.
Controls
A mail host allows Zope to send mail with the SMTP protocol.
'ID' -- Indicates the id of the mail host.
'Title' -- Allows you to specify the title of the mail host.
'SMTP host' -- Allows you to specify the name of the mail server. You can simply
specify the host to be 'localhost', which should be true
for most cases.
*Important:* The mailhost must allow relaying from the the
server you are on. If the mail server is the same as the Web
server then your mail server needs to allow relaying from
'localhost' (often the default).
'SMTP port' -- Allows you to specify the port on which the mail server accepts
SMTP requests. Zope suggests port 25, which is the standard UNIX
mail port.
lib/python/Products/OFSP/help/Advanced-Find.stx 0 → 100644
View file @ a8ddf90b
Advanced Find: Search for Zope objects
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.
Controls
'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.
lib/python/Products/OFSP/help/Common-Instance-Property-Sheet.stx 0 → 100644
View file @ a8ddf90b
Common Instance Property Sheet - Define Properties for ZClasses
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 maintain their properties normally.
A property sheet merely provides a way to describe and edit a set of
properties.
lib/python/Products/OFSP/help/Common-Instance-Property-Sheet_Add.stx 0 → 100644
View file @ a8ddf90b
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.
Controls
'Id' -- Specifies the id of the Common Instance Property Sheet.
'Title' -- Allows you to specify the title of the Common Instance Propery Sheet.
lib/python/Products/OFSP/help/Control-Panel.stx 0 → 100644
View file @ a8ddf90b
Control Panel - Provides access to centralized Zope management facilties.
Description
From the Control Panel you can manage the Zope database, versions,
and Zope Products.
lib/python/Products/OFSP/help/Control-Panel_Contents.stx 0 → 100644
View file @ a8ddf90b
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.
lib/python/Products/OFSP/help/DTML-Document.stx 0 → 100644
View file @ a8ddf90b
DTML Document: Provide general content management facilites to Zope.
Discription
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).
lib/python/Products/OFSP/help/DTML-DocumentOrMethod_Add.stx 0 → 100644
View file @ a8ddf90b
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.
lib/python/Products/OFSP/help/DTML-DocumentOrMethod_Edit.stx 0 → 100644
View file @ a8ddf90b
DTML Document/Method - Edit: Edit the contents (properties)
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.
lib/python/Products/OFSP/help/DTML-DocumentOrMethod_Proxy.stx 0 → 100644
View file @ a8ddf90b
DTML Document/Method - Proxy: Manage proxy roles for a document or method
Description
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.
Controls
'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.
lib/python/Products/OFSP/help/DTML-DocumentOrMethod_Upload.stx 0 → 100644
View file @ a8ddf90b
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.
lib/python/Products/OFSP/help/DTML-DocumentOrMethod_View.stx 0 → 100644
View file @ a8ddf90b
DTML Document/Method - View: Allows you to preview the document or method.
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.
lib/python/Products/OFSP/help/DTML-Method.stx 0 → 100644
View file @ a8ddf90b
DTML Method: Provide general templating management facilities to Zope.
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).
lib/python/Products/OFSP/help/Database-Management.stx 0 → 100644
View file @ a8ddf90b
Database Management: Provide access to management facilities for the Zope database.
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
lib/python/Products/OFSP/help/Database-Management_Cache-Parameters.stx 0 → 100644
View file @ a8ddf90b
Database Management - Cache Parameters: Adjust the Cahe options for your ZODB
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.
lib/python/Products/OFSP/help/Database-Management_Database.stx 0 → 100644
View file @ a8ddf90b
Database Management - Database: Allows you to view database status information and pack the database.
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.
lib/python/Products/OFSP/help/Database-Management_Flush-Cache.stx 0 → 100644
View file @ a8ddf90b
Database Management - Flush Cache: Allows you to manually clear objects out of the Zope cache.
Description
The fllowing table lists the functionality of the buttons on
the 'Flush Cache' management screen:
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.
lib/python/Products/OFSP/help/File.stx 0 → 100644
View file @ a8ddf90b
File: Allows you to store files in Zope.
Description
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 0 → 100644
View file @ a8ddf90b
File - Add: Allows you to create a new File
Description
Add a new generic file (binary contents) to the ZODB.
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.
lib/python/Products/OFSP/help/File_Edit.stx 0 → 100644
View file @ a8ddf90b
File - 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.
lib/python/Products/OFSP/help/File_Upload.stx 0 → 100644
View file @ a8ddf90b
File - Upload: Allows you to upload a file.
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.
lib/python/Products/OFSP/help/File_View.stx 0 → 100644
View file @ a8ddf90b
File - View: Allows you to preview a file.
Description
Depending on how your browser is configured and the type of the
file this may download the file to your local computer.
lib/python/Products/OFSP/help/Find.stx 0 → 100644
View file @ a8ddf90b
Find
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.
'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
lib/python/Products/OFSP/help/Folder.stx 0 → 100644
View file @ a8ddf90b
Folder - Organize Zope obejcts (like directories)
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 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 0 → 100644
View file @ a8ddf90b
Folder - Add: Allows you to add a new Folder.
Description
This view allows you to create a new Folder based on your input.
Controls
'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.
lib/python/Products/OFSP/help/Folder_Local-Roles.stx 0 → 100644
View file @ a8ddf90b
Folder - Local Roles: Allows you to manage local roles
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.
lib/python/Products/OFSP/help/Folder_Manage-Permission.stx 0 → 100644
View file @ a8ddf90b
Folder - Manage Permission: Allows you to assign roles to a permission
Description
This view allows you to assign roles to different perissions.
Controls
'[User List]' -- Allows you to select all the users that will have this permission
(indicated in bold and italic font).
**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.
'Change' -- Clicked, it will set the permissions for the selected user.
lib/python/Products/OFSP/help/Folder_Manage-Permissions-Acquisition.stx 0 → 100644
View file @ a8ddf90b
Folder - Manage Permissions Acquisition: Manage Securoty Acquisition settings
Description
This view allows you to manage security acquisition settings.
Controls
'[Permissions List]' -- Allows you to select the permissions which should acquire security settings.
'Change' -- Clicked, it will change the security acquisition settings for the Folder.
lib/python/Products/OFSP/help/Folder_Manage-Role.stx 0 → 100644
View file @ a8ddf90b
Folder - Manage Role: Assign permissions to a role
Description
This view allows you to assign permissions to a role.
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.
lib/python/Products/OFSP/help/Folder_Manage-User-Local-Roles.stx 0 → 100644
View file @ a8ddf90b
Folder - Manage User Local Roles: Manage a user's local role
Description
This view allows you to manage a user's local roles.
Controls
'User' -- Indicates the user whose roles you going to change.
'Roles'[Selection List] -- Allows you to select the role(s) you wish to assign to the named user.
'Change' -- Clicked, it will change the local roles for the shown user.
lib/python/Products/OFSP/help/Folder_Rename.stx 0 → 100644
View file @ a8ddf90b
Folder - Rename: Change 'id' of an object(s)
Description
This view allows you to change the id of an object(s).
Controls
'[Old Object Id]' -- Indicates the old object Id and the object type is shown
by the little icon.
'[New Object Id]' -- Allows you to alter the Id of every listed object. The
default value is the old Id.
'OK' -- Clicked, Zoep changes the Ids of the objects listed.
'Cancel' -- Clicked, it cancels renaming the objects and returns to
the Folder contents view.
\ No newline at end of file
lib/python/Products/OFSP/help/Folder_View.stx 0 → 100644
View file @ a8ddf90b
Folder - View: Preview public appearance
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
lib/python/Products/OFSP/help/Image.stx 0 → 100644
View file @ a8ddf90b
Image - Store Image Files (GIF, PNG, JPG) in Zope
Description
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 '<dtml var IMAGE_ID>' 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_View.stx 0 → 100644
View file @ a8ddf90b
Image - View: Preview Image
Description
This view previews the image.
lib/python/Products/OFSP/help/Introduction.stx 0 → 100644
View file @ a8ddf90b
Introduction
The Zope Content Manager's Reference documents standard Zope objects
and how to use them. It provides content for the Zope on-line help system.
lib/python/Products/OFSP/help/ObjectManager_Contents.stx 0 → 100644
View file @ a8ddf90b
ObjectManager - Contents: Display the objects contained by the Object Manager
Description
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.
Controls
'[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.
'Rename' -- Allows you to change the Ids of the selected objects.
'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).
'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.
lib/python/Products/OFSP/help/ObjectManager_Import-Export.stx 0 → 100644
View file @ a8ddf90b
Folder - Import/Export: Allows you to import/export objects from/into the Zope database.
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
'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.
'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').
*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' -- Clicked, Zope exports the selected object to the specified
location in the specified 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.
'Import' -- Clicked, Zope will attempt to import the specified file.
lib/python/Products/OFSP/help/Ownership.stx 0 → 100644
View file @ a8ddf90b
Ownership: Sets the owner for the project
Description
This view allows you to set the ownership of an object.
On the top of the page Zope will tell you whether the
object has an owner and who it is.
Controls
'Take ownership' -- Allows you (the current user) to
take the ownership of this project.
**Important:** This button will not show up, if you
(the current user) are the owner of the object.
'Make ownership implicit (acquired)' -- Allows you
to adjust all sub-objects to have the same owner-
ship, if they have no owner.
**Important:** This button will only show up, if the
object has an owner.
'Make ownership explicit' -- Allows you to ignore
aquisition and set you (the current user) as the
owner of the object.
**Important:** 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 0 → 100644
View file @ a8ddf90b
Product Management: Contains the 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.
lib/python/Products/OFSP/help/Product.stx 0 → 100644
View file @ a8ddf90b
Product - Allows you ro extend Zope
Description
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 0 → 100644
View file @ a8ddf90b
Product - Add: Create a new Product
Description
This view allows you to create a new Product.
Controls
'Id' -- Allows you to specify the id of the Product.
'Title' -- Allows you to specify the title of the Product.
'Add' -- Clicked, Zope will create a Product in the Product Folder.
lib/python/Products/OFSP/help/Product_Distribution.stx 0 → 100644
View file @ a8ddf90b
Product - Distribution: Create a Product distribution
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.
Controls
'Version' -- Allows you to specify the version of the objects you want to
archive/release.
'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.
'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.
lib/python/Products/OFSP/help/Properties.stx 0 → 100644
View file @ a8ddf90b
Properties - Define prpoerties for your current object.
Description
This view allows you to define properties on your current object, like a Folder
or DTML Document.
Controls
The first list describes the fields that allow you to view and modify the
existing properties.
'[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.
'Save Changes' -- Clicked, it will allow you to save the new values of the properties.
'Delete' -- Clicked, Zope will delete the checked Properties.
The next table lists all the options assisting you with creating new
properties.
'Id' -- Allows you to specify the id (name) of the Property.
'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.
'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.
'Add' -- Clicked, the property will be added to the object.
This table lists all the property types and lists the allowed values
for each.
Property Types with description
boolean -- 1 or 0.
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.
float -- A decimal number, for example '12.4'.
int -- An integer number, for example, '12'.
lines -- A list of strings, one per line.
long -- A long integer, for example '12232322322323232323423'.
string -- A string of characters, for example 'This is a string'.
text -- A muli-line string, for example a paragraph.
tokens -- A list of strings separated by white space, for example
'one two three'.
selection -- A string selected by a pop-up menu.
multiple selection -- A list of strings selected by a selection list.
lib/python/Products/OFSP/help/Security-DefinePermissions.stx 0 → 100644
View file @ a8ddf90b
Define Permissions - Define permissions for an object
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.
lib/python/Products/OFSP/help/Security.stx 0 → 100644
View file @ a8ddf90b
Security - Define security settings
Description
This view allows you to define security settings for 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 this item.
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.
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. Note: 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
settings' link.
You can create and manage local roles by clicking the
'local roles' link.
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.
lib/python/Products/OFSP/help/Undo.stx 0 → 100644
View file @ a8ddf90b
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.
lib/python/Products/OFSP/help/User-Folder.stx 0 → 100644
View file @ a8ddf90b
User Folder - Contains Zope users
Description
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 0 → 100644
View file @ a8ddf90b
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.
lib/python/Products/OFSP/help/User-Folder_Contents.stx 0 → 100644
View file @ a8ddf90b
User Folder - Contents: View and manage the users
Description
This view allows you to manage the users defined in a user folder.
Controls
'[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.
lib/python/Products/OFSP/help/User-Folder_Edit-User.stx 0 → 100644
View file @ a8ddf90b
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.
lib/python/Products/OFSP/help/Version-Management.stx 0 → 100644
View file @ a8ddf90b
Version Management - Control all Zope versions
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.
lib/python/Products/OFSP/help/Version-Management_Version.stx 0 → 100644
View file @ a8ddf90b
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 .
lib/python/Products/OFSP/help/Version.stx 0 → 100644
View file @ a8ddf90b
Version - Create "private sessions"
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.
lib/python/Products/OFSP/help/Version_Add.stx 0 → 100644
View file @ a8ddf90b
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.
lib/python/Products/OFSP/help/Version_Join-Leave.stx 0 → 100644
View file @ a8ddf90b
Version - Join/Leave: Start/Stop working on a private 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.
lib/python/Products/OFSP/help/Version_Properties.stx 0 → 100644
View file @ a8ddf90b
Version - Properties: Edit Version Properties
Description
This view allows you to edit the title of the version.
Controls
'Id' -- Indicates the id 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 0 → 100644
View file @ a8ddf90b
Version - Save/Discard: Allows to commit/discard 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.
lib/python/Products/OFSP/help/Z-Search-Interface.stx 0 → 100644
View file @ a8ddf90b
Z Search Interface: Interface to search the ZODB
Description
A Search Interface allows you to search Zope databases.
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.
lib/python/Products/OFSP/help/Z-Search-Interface_Add.stx 0 → 100644
View file @ a8ddf90b
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.
lib/python/Products/OFSP/help/ZClass.stx 0 → 100644
View file @ a8ddf90b
ZClass - Define new/custom Zope Objects
Description
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 0 → 100644
View file @ a8ddf90b
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.
lib/python/Products/OFSP/help/ZClass_Basic.stx 0 → 100644
View file @ a8ddf90b
ZClass - Basic: Manage basic 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.
lib/python/Products/OFSP/help/ZClass_Define-Permissions.stx 0 → 100644
View file @ a8ddf90b
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 0 → 100644
View file @ a8ddf90b
ZClass - Methods: Manage the ZClass methods
Description
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 0 → 100644
View file @ a8ddf90b
ZClass - Permissions: Select usable ZClass permissions
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
'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.
'Change' -- Clicked, Zope will add the selected permissions to the
list of the inherited ZClass permissions.
lib/python/Products/OFSP/help/ZClass_Property-Sheets.stx 0 → 100644
View file @ a8ddf90b
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_Views.stx 0 → 100644
View file @ a8ddf90b
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.
lib/python/Products/OFSP/help/Zope-Factory.stx 0 → 100644
View file @ a8ddf90b
Zope Factory: Insert Projects into product add list
Description
Zope Factories allow you to insert objects into 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 0 → 100644
View file @ a8ddf90b
Zope Factory - Add: Create new 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.
lib/python/Products/OFSP/help/Zope-Factory_Edit.stx 0 → 100644
View file @ a8ddf90b
Zope Factory - Edit: Edit Factory settings
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.
lib/python/Products/OFSP/help/Zope-Permission.stx 0 → 100644
View file @ a8ddf90b
Zope Permission: Define new Permissions for ZClasses
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.
lib/python/Products/OFSP/help/Zope-Permission_Add.stx 0 → 100644
View file @ a8ddf90b
Zope Permission - Add: Create a new Permission
Description
This view allows you to create a new Permission.
Controls
'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.
lib/python/Products/OFSP/help/Zope-Permission_Edit.stx 0 → 100644
View file @ a8ddf90b
Zope Permission - Edit: Edit Permission settings
Description
This view allows you to edit permission settings.
Controls
'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/ZCatalog.stx 0 → 100644
View file @ a8ddf90b
ZCatalog: Index and Search for Zope objects
Description
ZCatalogs allow you to index and search for Zope objects.
But ZCatalog is not just simply a data managemengt system that allows
you to search through it content. You have the choice which properties
are stored in the Catalog and which attributes are used for searching.
Once a set of objects is inserted into the Catalog, you will be able
to update this object inventory by updating the objects, deleting and
adding them.
lib/python/Products/ZCatalog/help/ZCatalog_Add.stx 0 → 100644
View file @ a8ddf90b
ZCatalog - Add: Create new ZCatalog
Description
This view allows you to create a new ZCatalog.
Controls
'Id' -- Allows you to specify the id of the ZCatalog.
'Title' -- Allows you to specify the title of the ZCatalog.
'Vocabulary' -- Allows you to select whether or not you
would like to use a 'Vocabulary' and then choose the
Vocabulary from the selection list.
'Add' -- Create a new and empty Catalog.
lib/python/Products/ZCatalog/help/ZCatalog_Cataloged-Objects.stx 0 → 100644
View file @ a8ddf90b
ZCatalog - Cataloged Objects: Manage catalog entries
Description
This view allows you to manage catalog entries.
The catalog holds records which refer to Zope objects. If the
catalog currently contains records they will be listed in this view.
Controls
'Update Catalog' -- Clicked, it will update the meta data for all of the objects in the
Catalog.
**Note:** The Catalog is not being updated after each transaction.
'Clear Catalog' -- Clicked, all objects are removed from the Catalog.
'Size' -- Indicates the amount of objects in the Catalog.
'[List of objects]' -- Each lines describes one object. The checkbox in the front of the
line, allows you to checkmark the object for deletion
('Delete') or to update the objects ('Update'). Next
the object type is listed, followed by the object path and the
object title. Clicking on the path and title of the object, you
can examine individual catalog records by clicking on the record
name links.
'Next/Previos XX entries' -- Allows you to see more of the cataloged objects. These teo links
will only appear if you have enough objects in the Catalog.
'Update' -- Clicked, Zope greps the newest content for each checked object
and updates the meta data (the cataloged attributes of the object)
in the Catalog.
'Remove' -- Clicked, it removes all the selected objects from the Catalog.
**Note:** No objects are deleted from the database.
lib/python/Products/ZCatalog/help/ZCatalog_Find-Items-to-ZCatalog.stx 0 → 100644
View file @ a8ddf90b
ZCatalog - Find Items to ZCatalog: Add records to the Catalog
Description
This view allows you to add records to the catalog.
This view operates like a normal find view (see "Folder - Find")
to locate objects for cataloging. Objects which match the find criteria
will be added to the catalog.
lib/python/Products/ZCatalog/help/ZCatalog_Indexes.stx 0 → 100644
View file @ a8ddf90b
ZCatalog - Indexes: Manage Catalog Indexes
Description
This view allows you to manage the catalog indexes.
The catalog provides searching by indexing information about
cataloged objects. Indexes record information about object attributes.
Controls
'[List of Indexes]' -- Each line contains one Index entry. The checkbox in the front allows
you to mark an index for deletion. Next the Index nameis listed which
corresponds to attribute names of various objects, is displayed.
'Delete' -- Clicked, the checkmarked Index(es) will be deleted.
'Add Index' - Name -- Allows you to enter the name of a new index.
'[Type of Index]' -- You have the choice between three types of Indexes, called
'TextIndex', 'FieldIndex', and 'KeywordIndex'.
Please refer to the table below to see a description of each Index.
'Add' -- Clicked, the new Index will be added to this catalog.
This table lists the different Index types and describes their purpose.
'TextIndex' -- Breaks text up into individual words, and are often refered to as full-text
indexes. Text indexes sort results by score meaning they return 'hits' in
order from the most relevant to the lest relevant.
'FieldIndex' -- Treat the value of an objects attribute atomically, and can be used, for
example, to track only a certain subset of object values, such as 'meta_type'.
'KeywordIndex' -- Index a sequence of objects that act as 'keywords' for an object. A Keyword
Index will return any objects that have one or more keywords specified in a
search query.
lib/python/Products/ZCatalog/help/ZCatalog_MetaData-Table.stx 0 → 100644
View file @ a8ddf90b
ZCatalog - MetaData Table: Manage Catalog record schema
Description
This view allows you to manage the catalog record schema.
The catalog holds records which describe the cataloged objects.
This view allows you to define columns for these records.
Controls
'[List of Indexes]' -- Each line contains one Meta Data entry (column).
The checkbox in the front allows you to mark a meta data entry for
deletion. Next the meta data entry's name is listed which corresponds to
attribute names of various objects, is displayed.
'Delete' -- Clicked, the checkmarked Meta Data entries (columns) will be
deleted.
'Meta Data name' -- Allows you to enter the name of a new meta data entry.
'Add' -- Clicked, the new entry (column) will be added to this catalog.
lib/python/Products/ZCatalog/help/ZCatalog_Status.stx 0 → 100644
View file @ a8ddf90b
ZCatalog - Status: Control advanced Catalog features
Description
This view allows you to control advanced catalog features.
Subtransactions reduce the memory requirements of ZCatalog, but at
the expense of speed. If you choose to enable subtransactions, you can adjust
how often ZCatalog commits a subtransactions by adjusting the threshold. The
index status reports how many objects are cataloged in each index.
Controls
'Enable/Disable' -- If enables, the Subtransaction system is enabled and the threshold
specified below is used.
'Subtransaction Threshold' -- Allows you to specify how often the ZCatalog will commit the
subtransactions. The default value is 10000.
'Change' -- Clicked, Zope will update the subtransaction threshold.
'Index Status' List -- Each line corresponds to one Index. The line indicates how
many objects are cataloged for each Index.
lib/python/Products/ZSQLMethods/help/Z-SQL-Method.stx 0 → 100644
View file @ a8ddf90b
Z SQL Method Object: Communicate via SQL with any RDB database
Description
Z SQL Methods allows you to access data in SQL databases.
Z SQL Methods define and call SQL statements on databases which are
defined by database connection objects. To create a new Z SQL Method
you will need to setup a database connection first.
Every Z SQL Method is directly linked to a database connection.
**Note:** You will not be able to make a new Z SQL Method without
having a DB connection that can be seen from your location (read
Acquisition).
*Important:* Even though you may be able to write
database-specific SQL statements, you should be aware that by
switching the databases, your SQL statement inside the Z SQL Method
may break, and cause a Zope exception.
For example, PostGreSQL supports regular expression in 'SQL
WHERE' clauses. While a ZSQL statement containing a regular
expression search may work fine in PostGres, it will break when
connecting this SQL statement to another database.
\ No newline at end of file
lib/python/Products/ZSQLMethods/help/Z-SQL-Method_Add.stx 0 → 100644
View file @ a8ddf90b
Z SQL Method - Add: Create new Z SQL Method
Description
This view allows you to create a new Z SQL Method.
Controls
'ID' -- Specifies the id of the sql method.
'Title' -- Allows you to specify the title of the sql method.
'Connection id' -- Select list that specifies the database connection on which
the sql method operates.
**Note:** If you change the ID of your DB Connection object, all the Z SQL Methods
using this connection object will *NOT* be updated. You have to update all Methods
one by one.
'Arguments' -- Allows you to specify a list of arguments that the sql
method takes. The arguments should be separated by spaces or
a newline in the field. Furthermore, you can specify the
type of the argument as well as a default
value.
**Example:** 'title:string="No title!"', where 'title' is the attribute, 'string' is the
type of the attribute, and '"No title!"' is the default value.
'Query template' -- Text area that specifies the SQL query that the sql method
will execute. The query template can contain DTML markup to
tailor the SQL statement to the arguments.
There are three additional DTML tags called 'SQLVAR', 'SQLTEST', and
'SQLGROUP'. Please refer to their references get more details on how to use them in your
SQL statement.
**Note:** the SQL statement need not be a 'SELECT' query, it may be any valid SQL
statement including an INSERT or UPDATE.
**Important:** You can have several SQL statements in one ZSQL Mathod.
\ No newline at end of file
lib/python/Products/ZSQLMethods/help/Z-SQL-Method_Advanced.stx 0 → 100644
View file @ a8ddf90b
Z SQL Method - Advanced: Manage advanced settings
Description
This view allows you to manage the advanced settings such as
caching and plugable brains of a SQL method.
Controls
'ID' -- Indicates the id of the sql method.
'Title' -- Allows you to specify the title of the sql method.
'Maximum number of rows retrieved' -- Allows
you to specify an upper limit for the number of rows a sql
method can retrieve. Setting this option correctly (based on
your specific environment) can increase the speed of your site
significantly.
'Maximum number of results in the cache' -- Allows you to set the
size of the sql method cache. Why is the method cache useful? Let's
say you have a query that returns all day long the same result (since
the DB is only updated at night) then it would be very expensive to
execute this query every single time. Instead, Zope saves the query
result in the method and now everyone can access it faster.
Another example would be, if you call the same SQL method twice
in one DTML Method or DTML Document, you would not want to execute the
query twice, but use the cache the second time.
'Maximum time (seconds) to cache results' -- Allows you to specify how
fresh the sql method cache must be, so that the method cache is used
as result, instead of querying the database again. The method cache
is disabled by default and by setting this time to a number greater
than zero you enable SQL Method caching.
Usually a query returns a list of rows that were
returned. This data could be considered "dumb", since it
does not know anything about it surroundings or where it
came from. But Zope allows you to transform this "dumb"
(flat) data into objects. You ask, how?
Well, usually custom objects are implemented using classes,
which consist basically of properties and methods. Now, lets
say that each column in a particular DB table corresponds to
one property of a class. All what we need to do now is to
define the methods that go with these properties. Note that
we know the properties' names from the column title.
So you can write a class in Python that contains only methods
and the Zope will fill in the attributes from using the
query results. For each returned row, there will be one
instance of the specified class, so that your result is
a list of class instances (read objects). These Python
classes are called "Plugable Brains" by the Zope
community.
In the next two fields you will specify the location and
the name of the class, so Zope will be able to use it.
'Class name' -- Allows you to specify the name of the Python class.
'Class file' -- Allows you to specify the name of the Python module that
the class is defined in. The class file should reside in
the Zope 'Extensions' directory.
lib/python/Products/ZSQLMethods/help/Z-SQL-Method_Edit.stx 0 → 100644
View file @ a8ddf90b
Z SQL Method - Edit: Change attributes of a SQL method
Description
This view allows you to edit the attributes of a SQL method.
Controls
'ID' -- Indicates the id of the sql method.
'Title' -- Allows you to specify the title of the sql method.
'Connection id' -- Select list that specifies the database connection on which
the sql method operates.
**Note:** If you change the ID of your DB Connection object, all the Z SQL
Methods using this connection object will also be updated.
'Arguments' -- Allows you to specify a list of arguments that the sql
method takes. The arguments should be separated by spaces or a newline in
the field. Furthermore, you can specify the type of the argument as well
as a default value.
**Example:** 'title:string="No title!"', where 'title' is the attribute,
'string' is the type of the attribute, and '"No title!"' is the default value.
'Query template' -- Text area that specifies the SQL query that the sql method
will execute. The query template can contain DTML markup to
tailor the SQL statement to the arguments.
There are three additional DTML tags called 'SQLVAR', 'SQLTEST', and 'SQLGROUP'.
Please refer to their references get more details on how to use them in your
SQL statement.
**Note:** the SQL statement need not be a 'SELECT' query, it may be any valid
SQL statement including an INSERT or UPDATE.
lib/python/Products/ZSQLMethods/help/Z-SQL-Method_Test.stx 0 → 100644
View file @ a8ddf90b
Z SQL Method - Test: Test the validity of your SQL statement
Description
This view allows you to test a SQL method.
Controls
'*[arument names]*' -- There will be one text field for each argument specified for
the SQL method. The text field will contain the default
value.
**Important:** You must enter a value matching the specified argument type, otherwise a
"Type Error" is returned.
'Submit Query' -- Causes the wuery to be executed and the results are returned
as an HTML table. If the query was had a syntax error or
the accessed table did not exist, a database-specific error
message is returned in form of an exception.
Furthermore, if you have a SQL statement that does not
return any data, Zope will tell you that this SQL statement
was not a query. Even though that may look like an error
message, Zope exits cleanly and does not throw an exception.
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