Commit 40d117a3 authored by Amos Latteier's avatar Amos Latteier

Added basic help screens for Zope products. Some of these maybe moved to other...

Added basic help screens for Zope products. Some of these maybe moved to other Products (e.g. ZCatalog help should probably be in the ZCatalog Product). These files were generated from ZCMR.xml (Zope Content Manager's Reference, a DocBook document in the ZopeDoc cvs repository) via XSLT. Yeeha!
parent d9569b0f
<dtml-var standard_html_header>
<h1>Common Instance Property Sheet</h1>
<p>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. </p>
<p>Individual instances of ZClasses maintain their properties normally.
A property sheet merely provides a way to describe and edit a set of
properties. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Common-Instance-Property-Sheet.dtml">Common Instance Property Sheet</a>&gt;Add</h1>
<p> This view allows you to create a new Common Instance Property
Sheet.</p>
<p>The <tt>Id</tt> field specifies the Id of the Common
Instance Property Sheet. The <tt>Title</tt> field allows you to
specify the title of the Common Instance Propery Sheet.</p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Common-Instance-Property-Sheet.dtml">Common Instance Property Sheet</a>&gt;Define Permissions</h1>
<p> See <a href="../ZClass_Define-Permissions.dtml">ZClass&gt;Define Permissions</a>. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Common-Instance-Property-Sheet.dtml">Common Instance Property Sheet</a>&gt;Properties</h1>
<p> See <a href="../Folder_Properties.dtml">Folder&gt;Properties</a>. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>Control Panel</h1>
<p>The Control Panel provides access to centralized Zope management
facilties.</p>
<p>From the Control Panel you can manage the Zope database, versions,
and Zope Products.</p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Control-Panel.dtml">Control Panel</a>&gt;Contents</h1>
<p> This view displays information about the Zope process and provides
access to system management functions. </p>
<p> <tt>Zope version</tt> indicates the version of the Zope
system. <tt>Python version</tt> indicates the version of Python that
Zope is using. <tt>System platform</tt> indicates the type of machine
Zope is running on. <tt>Process ID</tt> indicates the PID number of
the Zope process. <tt>Running for</tt> indicates how long the Zope
process has been running. </p>
<p> The <tt>Shutdown</tt> button will shutdown the Zope
process. The <tt>Restart</tt> button will restart the Zope process.
The <tt>Restart</tt> button will only appear if Zope is running under
daemon control. </p>
<p> The <tt>Database Management</tt> link provides access to
database management functions such as packing and cache management. The
<tt>Version Management</tt> links provides access to version
management functions include version commit and abort. The <tt>Product
Management</tt> link provides access to management functions for installed
Zope Products. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Control-Panel.dtml">Control Panel</a>&gt;Undo</h1>
<p> See <a href="../Folder_Undo.dtml">Folder&gt;Undo</a>. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>DTML Document</h1>
<p>DTML Documents provide general content management facilites to
Zope.</p>
<p>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.</p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../DTML-Document.dtml">DTML Document</a>&gt;Add</h1>
<p>This view allows you to create a new DTML Document.</p>
<p>The <tt>Id</tt> field specifies the id of the DTML
Document. The <tt>Title</tt> field allows you to specify the title of
the DTML Document. The <tt>File</tt> field allows you to upload a
file from your local computer. Click the <tt>Browse...</tt> button to
locate a file to upload. </p>
<p>Click the <tt>Add</tt> button to create a new DTML
Document. Click the <tt>Add and Edit</tt> button to create a new DTML
Document and go directly to it's Edit view.</p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../DTML-Document.dtml">DTML Document</a>&gt;Edit</h1>
<p> This view allows you to edit the contents of a document. </p>
<p> The <tt>id</tt> field indicates the id of the document.
The <tt>Title</tt> field allows you to edit the title of the
document. The <tt>Size</tt> field indicates the size of the
document's contents. The <tt>Last modified</tt> field indicates the
time the document was last changed. The 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. To change the dimensions of the text area
click the <tt>Taller</tt>, <tt>Shorter</tt>,
<tt>Wider</tt>, or <tt>Narrower</tt> buttons repeatedly
until the size is correctly adjusted. To change the contents of the document
click the <tt>Change</tt> button. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../DTML-Document.dtml">DTML Document</a>&gt;Properties</h1>
<p> See <a href="../Folder_Properties.dtml">Folder&gt;Properties</a>. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../DTML-Document.dtml">DTML Document</a>&gt;Proxy</h1>
<p> This view allows you to manage proxy roles for a document. </p>
<p> Proxy roles supplement the roles of the user who is viewing the
document in order to allow the document additional access. </p>
<p> Select the role(s) you wish to assign to the document from the
<tt>Proxy Roles</tt> multiple select list and click the
<tt>Change</tt> button to set proxy roles for the document. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../DTML-Document.dtml">DTML Document</a>&gt;Security</h1>
<p> See <a href="../Folder_Security.dtml">Folder&gt;Security</a>. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../DTML-Document.dtml">DTML Document</a>&gt;Upload</h1>
<p> This view allows you to upload document files. </p>
<p> Use this view to completely replace the contents of a document
with the contents of an uploaded text file from your local computer. Click the
<tt>Browse...</tt> button to locate a file to upload. Click the
<tt>Change</tt> button to replace the document's contents with the
uploaded file. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../DTML-Document.dtml">DTML Document</a>&gt;View</h1>
<p> This view allows you to preview the document. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>DTML Method</h1>
<p> DTML Methods provide general templating management facilities to
Zope.</p>
<p>A DTML Method can be used to display almost any Zope object. DTML
Methods can be viewed and edited through the web. DTML Documents can contain
scripting commands in Document Templates Markup Language. DTML Methods can be
called from DTML Documents and other DTML Methods.</p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../DTML-Method.dtml">DTML Method</a>&gt;Add</h1>
<p> See <a href="../DTML-Document_Add.dtml">DTML Document&gt;Add</a>. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../DTML-Method.dtml">DTML Method</a>&gt;Edit</h1>
<p> See <a href="../DTML-Document_Edit.dtml">DTML Document&gt;Edit</a>. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../DTML-Method.dtml">DTML Method</a>&gt;Proxy</h1>
<p> See <a href="../DTML-Document_Proxy.dtml">DTML Document&gt;Proxy</a>. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../DTML-Method.dtml">DTML Method</a>&gt;Security</h1>
<p> See <a href="../Folder_Security.dtml">Folder&gt;Security</a>. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../DTML-Method.dtml">DTML Method</a>&gt;Upload</h1>
<p> See <a href="../DTML-Document_Upload.dtml">DTML Document&gt;Upload</a>. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../DTML-Method.dtml">DTML Method</a>&gt;View</h1>
<p> See <a href="../DTML-Document_View.dtml">DTML Document&gt;View</a>. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>Database Management</h1>
<p> Database Management provides access to management facilities for the
Zope database.</p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Database-Management.dtml">Database Management</a>&gt;Cache Parameters</h1>
<p> 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. A smaller cache decreases object access speed, but
reduces memory usage. </p>
<p> <tt> Total number of objects in the database</tt>
indicates the number of persistent objects in the Zope database.
<tt>Number of objects in the cache</tt> indicates the number of
objects which are currently loaded in memory. <tt>Target size</tt>
indicates ideal number of objects to have in memory. <tt>Target maximum
time between accesses</tt> indicates the amount of time after which Zope
should remove an object from memory if it hasn't been accessed. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Database-Management.dtml">Database Management</a>&gt;Database</h1>
<p> This view allows you to view database status information. It also
allows you to perform maintenance tasks such as database packing, cache
management, and "undoing" previous changes to your site. </p>
<p> <tt>Database Size</tt> indicates the size in kilobytes
of the Zope database file. <tt>Database Location</tt> indicates the
path to the Zope database file. </p>
<p> The <tt>Pack</tt> button 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. The <tt>days</tt> field indicates how old objects 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.
</p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Database-Management.dtml">Database Management</a>&gt;Flush Cache</h1>
<p> This view allows you to manually clear objects out of the Zope
cache. </p>
<p> The <tt>Full Sweep</tt> button allows you to remove
objects from the cache. The field indicates the number of seconds within which
an object must have been accessed in order not to be deactivated by the flush
operation. The <tt>Minimize</tt> button allows you to remove objects
from the cache. The field 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. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Database-Management.dtml">Database Management</a>&gt;Undo</h1>
<p> See <a href="../Folder_Undo.dtml">Folder&gt;Undo</a>. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>External Method</h1>
<p>External Methods allow you to add functionality to Zope by writing
Python functions which are exposed as callable Zope objects.</p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../External-Method.dtml">External Method</a>&gt;Add</h1>
<p> This view allows you to create a new External Method.</p>
<p> The <tt>Id</tt> field specifies the id of the external
method. The <tt>Title</tt> field allows you to specify the title of
the external method. The <tt>Function name</tt> field allows you to
specify the name of the function to use for the external method. The
<tt>Python module file</tt> field 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. </p>
<p>Click the <tt>Add</tt> button to create a new External
Method.</p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../External-Method.dtml">External Method</a>&gt;Properties</h1>
<p> This view allows you to manage the properties of an external
method. </p>
<p> The <tt>Id</tt> field indicates the id of the external
method. The <tt>Title</tt> field allows you to specify the title of
the external method. The <tt>Function name</tt> field allows you to
specify the name of the function to use for the external method. The
<tt>Python module</tt> field 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. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../External-Method.dtml">External Method</a>&gt;Security</h1>
<p> See <a href="../Folder_Security.dtml">Folder&gt;Security</a>. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../External-Method.dtml">External Method</a>&gt;Try It</h1>
<p> This view executes the external method. </p>
<p> This view executes the external method and returns the results if
any. Only parameters from the web request are passed the the external method.
</p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>File</h1>
<p> Files allow you to store files in Zope. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../File.dtml">File</a>&gt;Add</h1>
<p> This view allows you to create a new File. </p>
<p> The <tt>Id</tt> field specifies the id of the file. The
<tt>Title</tt> field allows you to specify the title of the file.
Click the <tt>Browse...</tt> button to locate a file to upload. Click
the <tt>Add</tt> button to create a new File.</p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../File.dtml">File</a>&gt;Edit</h1>
<p> This view allows you to manage the attributes of the file. </p>
<p> The <tt>Id</tt> field indicates the id of the file. The
<tt>Title</tt> field allows you to specify the title of the file. The
<tt>Content type</tt> field allows you to set the content type of the
file. Zope will try to guess an appropriate content type when you upload the
file. The <tt>Precondition</tt> field allows you to specify a
precondition for the file. A precondition is a method of document which is
executed before the file is viewed or downloaded. If the precondition raises an
exception then the file cannot be viewed. The <tt>Size</tt> field
indicates the size of the uploaded file. The <tt>Last modified</tt>
field indicates the last time the file was changed. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../File.dtml">File</a>&gt;Properties</h1>
<p> See <a href="../Folder_Properties.dtml">Folder&gt;Properties</a>. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../File.dtml">File</a>&gt;Security</h1>
<p> See <a href="../Folder_Security.dtml">Folder&gt;Security</a>. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../File.dtml">File</a>&gt;Upload</h1>
<p> This view allows you to upload a file. </p>
<p> Use this view to completely replace the file with an uploaded file
from your local computer. Click the <tt>Browse...</tt> button to
locate a file to upload. Click the <tt>Change</tt> button to replace
the file with the uploaded file. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../File.dtml">File</a>&gt;View</h1>
<p> This view allows you to preview a file. </p>
<p> Depending on how your browser is configured and the type of the
file this may download the file to your local computer. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>Folder</h1>
<p>Folders allow you to organize Zope objects by grouping them together
inside Folders. Folder contain other Zope objects including other
Folders.</p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Folder.dtml">Folder</a>&gt;Add</h1>
<p> This view allows you to add a new Folder.</p>
<p>The <tt>Id</tt> field specifies the id of the Folder. The
<tt>Title</tt> field allows you to specify the title of the Folder.
The <tt>Create public interface</tt> checkbox creates an
<tt>index_html </tt>DTML Method inside the Folder to give the Folder
a default HTML representation. The <tt>Create user folder</tt>
checkbox creates a User Folder inside the Folder to hold authorization
information for the Folder. Click the <tt>Add</tt> button to create a
new Folder. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Folder.dtml">Folder</a>&gt;Advanced Find</h1>
<p> This view allows you to search for Zope objects. </p>
<p> To find objects you specify search criteria in the top frame and
then click the <tt>Find</tt> button. The find results will appear in
the button frame. For less search criteria click the
<tt>Simple...</tt> link. </p>
<p> Select the types of objects you wish to find by selecting object
types from the <tt>Find objects of type</tt> multiple selection list.
The <tt>with ids</tt> field allows you to restrict the ids the found
items. The <tt>containing</tt> field allows you to specify text that
must be contained in the body of found items. The <tt>expr</tt> field
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. Select <tt>before</tt> or <tt>after</tt> from the
<tt>modified</tt> selection list and enter a DateTime string in the
field to restrict found items by modification date. You can restrict found
objects by security settings by selecting one or more roles from the
<tt>where the roles</tt> multiple select list and selecting a
permission from the <tt>have permission</tt> select list. This will
restrict found objects to those for which the selected roles have the selected
permission. Finally you may choose to either the <tt>Search only in this
folder</tt> or the <tt>Search all subfolders</tt> radio box to
control where Zope should look for found items. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Folder.dtml">Folder</a>&gt;Contents</h1>
<p> This view displays the objects contained by the folder and allows
you to add, delete and change them. </p>
<p> Each contained object is displayed on a line. Each contained
object 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. </p>
<p> In front of each item is a check box which is used 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. </p>
<p> To change the id of an object select the object and click the
<tt>Rename</tt> button. See <a href="../Folder_Rename.dtml">Folder&gt;Rename</a>. </p>
<p> To move one or more objects select them and then click the
<tt>Cut</tt> button. The object(s) can now be moved to another
location by navigating to another location and clicking the
<tt>Paste</tt> button there. </p>
<p> To copy one or more objects select them and then click the
<tt>Copy</tt> button. The object(s) can now be copied to another
location by navigating to another location and clicking the
<tt>Paste</tt> button there. </p>
<p> To paste objects which have previously cut or copied, click the
<tt>Paste</tt> button. This will add the cut or copied object(s) to
the current folder. </p>
<p> To delete one or more objects select them and then click the
<tt>Delete</tt> button. </p>
<p> To export an object from the Zope database select it and then
click the <tt>Export</tt> button. See
<a href="../Folder_Import-Export.dtml">Folder&gt;Import/Export</a>. </p>
<p> 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. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Folder.dtml">Folder</a>&gt;Find</h1>
<p> This view allows you to search for Zope objects. </p>
<p> To find objects you specify search criteria in the top frame and
then click the <tt>Find</tt> button. The find results will appear in
the button frame. For more search criteria click the
<tt>Advanced...</tt> link. </p>
<p> Select the types of objects you wish to find by selecting object
types from the <tt>Find objects of type</tt> multiple selection list.
The <tt>with ids</tt> field allows you to restrict the ids the found
items. The <tt>containing</tt> field allows you to specify text that
must be contained in the body of found items. Select <tt>before</tt>
or <tt>after</tt> from the <tt>modified</tt> selection list
and enter a DateTime string in the field to restrict found items by
modification date. Finally you may choose to either the <tt>Search only in
this folder</tt> or the <tt>Search all subfolders</tt> radio box
to control where Zope should look for found items. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Folder.dtml">Folder</a>&gt;Import/Export</h1>
<p> This view allows you to import and export objects from the Zope
database. </p>
<p> To export an object specify its id in the <tt>Export object
id</tt> field and click the <tt>Export</tt> button. If you
choose <tt>Download to local machine</tt>, the export file will be
downloaded by your browser, if you choose <tt>Save to file on
server</tt>, the export file will be saved in the Zope
var directory of the server on which Zope is running. If
you choose <tt>XML format</tt>, the export file will be encoding as
XML, otherwise it will be encoded as a binary file. </p>
<p> To import an object into to Zope, specify the name of the import
file in the <tt>Import file name</tt> field and click the
<tt>Import</tt> button. The import file should be located in the Zope
import directory of the server on which Zope is running.
</p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Folder.dtml">Folder</a>&gt;Local Roles</h1>
<p> This view allows you to manage local roles. </p>
<p> To remove existing local roles select the local role setting(s)
and click the <tt>Remove</tt> button. You can edit a user's local
roles individually by clicking on the userid link. </p>
<p> To add local role settings select the userid from the User
selection list, select the Role(s) from the Roles multiple selection list and
click the <tt>Add</tt> button. This will create local roles for the
selected user with the selected role(s). </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Folder.dtml">Folder</a>&gt;Manage Permission</h1>
<p> This view allows you to assign roles to a permission. </p>
<p> Select the roles you wish to assign to the named permission from
the multiple selection list and click the <tt>Change</tt> button. The
<tt>Also use roles acquired from folders containing this object</tt>
check box indicates whether or not to acquire permissions settings for the
named permission. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Folder.dtml">Folder</a>&gt;Manage Permissions Acquisition</h1>
<p> This view allows you to manage security acquisition settings.
</p>
<p> Select the permissions which should acquire security settings from
the multiple selection list and click the <tt>Change</tt> button to
change the security acquisition settings. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Folder.dtml">Folder</a>&gt;Manage Role</h1>
<p> This view allows you to assign permissions to a role. </p>
<p> Select the permissions you wish to assign to the named role from
the multiple selection list and click the <tt>Change</tt> button.
</p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Folder.dtml">Folder</a>&gt;Manage User Local Roles</h1>
<p> This view allows you to manage a user's local roles. </p>
<p> Select the role(s) you wish to assign to the named user from the
<tt>Roles</tt> multiple selection list and click the
<tt>Change</tt> button to change the user's local roles. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Folder.dtml">Folder</a>&gt;Properties</h1>
<p> This view allows you to define properties on your folder. </p>
<p> Current properties are listed one per line. You can change the
value of existing properties by entering new values in the text entry field(s)
and clicking the <tt>Save Changes</tt> button. To remove an existing
property, select it and click the <tt>Delete</tt> button. </p>
<p> To create a new property first specify an id in the
<tt>Id</tt> field, a value in the <tt>Value</tt> field and
a choose a property type from the <tt>Type</tt> selection. Then click
the <tt>Add</tt> button. </p>
<p> When creating <tt>selection</tt> and <tt>multiple
selection</tt> properties, specify the name of another property (or
method) as the <tt>Value</tt>. This property (or method) should
return a list of strings will be used to provide choices for the selection.
</p>
<h2>Property Types</h2>
<table border="1">
<tr>
<th>Property Type</th>
<th>Description</th>
</tr>
<tr>
<td>boolean</td>
<td>1 or 0.</td>
</tr>
<tr>
<td>date</td>
<td>A <tt>DateTime</tt> value, for example
<tt>12/31/1999 15:42:52 PST</tt>.</td>
</tr>
<tr>
<td>float</td>
<td>A decimal number, for example
<tt>12.4</tt>.</td>
</tr>
<tr>
<td>int</td>
<td>An integer number, for example,
<tt>12</tt>.</td>
</tr>
<tr>
<td>lines</td>
<td>A list of strings, one per line.</td>
</tr>
<tr>
<td>long</td>
<td>A long integer, for example
<tt>12232322322323232323423</tt>.</td>
</tr>
<tr>
<td>string</td>
<td>A string of characters, for example <tt>This is a
string</tt>.</td>
</tr>
<tr>
<td>text</td>
<td>A muli-line string, for example a paragraph.</td>
</tr>
<tr>
<td>tokens</td>
<td>A list of strings separated by white space, for example
<tt>one two three</tt>.</td>
</tr>
<tr>
<td>selection</td>
<td>A string selected by a pop-up menu.</td>
</tr>
<tr>
<td>multiple selection</td>
<td>A list of strings selected by a selection list.</td>
</tr>
</table>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Folder.dtml">Folder</a>&gt;Rename</h1>
<p> This view allows you to change the id of an object. </p>
<p> Enter the new id in the text entry field. Click the
<tt>OK</tt> button to rename the object. Click the
<tt>Cancel</tt> button to abort the rename operation. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Folder.dtml">Folder</a>&gt;Security</h1>
<p> 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. </p>
<p> 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. </p>
<p> The <tt>Acquire permission settings</tt> 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 <tt>Acquire permission
settings</tt> link. </p>
<p> You can create and manage local roles by clicking the
<tt>local roles</tt> link. </p>
<p> You can create new roles by entering the role name in the text
entry field under the <tt>User defined roles</tt> heading and
clicking the <tt>Add Role</tt> button. You can delete any existing
user defined roles by selecting them from the selection list under the
<tt>User defined roles</tt> heading and clicking the <tt>Delete
Role</tt> button. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Folder.dtml">Folder</a>&gt;Undo</h1>
<p> This view allows you to undo changes to Zope's database. </p>
<p> 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. </p>
<p> To undo a transaction, select it from the list of transactions by
checking the checkbox next to it and then click either of the
<tt>Undo</tt> buttons. To see earlier or later transactions click the
<tt>Earlier Transactions</tt> or <tt>Later
Transactions</tt> links a the bottom and top of the view. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Folder.dtml">Folder</a>&gt;View</h1>
<p> This view allows you to preview the public appearance of the
folder. </p>
<p> This view will only be available if the folder contains (or
acquires) an index_html object. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>Image</h1>
<p> Images allow you to store image files in Zope.</p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Image.dtml">Image</a>&gt;Add</h1>
<p> See <a href="../File_Add.dtml">File&gt;Add</a>. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Image.dtml">Image</a>&gt;Edit</h1>
<p> See <a href="../File_Edit.dtml">File&gt;Edit</a>. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Image.dtml">Image</a>&gt;Properties</h1>
<p> See <a href="../Folder_Properties.dtml">Folder&gt;Properties</a>. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Image.dtml">Image</a>&gt;Security</h1>
<p> See <a href="../Folder_Security.dtml">Folder&gt;Security</a>. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Image.dtml">Image</a>&gt;Upload</h1>
<p> See <a href="../File_Upload.dtml">File&gt;Upload</a>. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Image.dtml">Image</a>&gt;View</h1>
<p> This view previews the image. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>Introduction</h1>
<p>
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. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>Mail Host</h1>
<p> Mail Hosts allow you to send mail via SMTP.</p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Mail-Host.dtml">Mail Host</a>&gt;Add</h1>
<p> This view allows you to create a new Mail Host.</p>
<p> The <tt>Id</tt> field specifies the id of the mail host.
The <tt>Title</tt> field allows you to specify the title of the mail
host. The <tt>Local host</tt> field allows you to specify the name of
the server on which Zope is running. The <tt>SMTP host</tt> field
allows you to specify the name of the mail server. The <tt>SMTP
port</tt> field allows you to specify the port on which the mail server
accepts SMTP requests. The <tt>Max. timeout</tt> field allows you to
specify how long Zope should wait (in seconds) for a response from the mail
server before aborting a mail request. Click the <tt>Add</tt> button
to create a new Mail Host.</p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Mail-Host.dtml">Mail Host</a>&gt;Edit</h1>
<p> This view allows you to manage the attributes of the mail host.
</p>
<p> A mail host allows Zope to send mail with the SMTP protocol.
</p>
<p> The <tt>Id</tt> field indicates the id of the mail host.
The <tt>Title</tt> field allows you to specify the title of the mail
host. The <tt>Local host</tt> field allows you to specify the name of
the server on which Zope is running. The <tt>SMTP host</tt> field
allows you to specify the name of the mail server. The <tt>SMTP
port</tt> field allows you to specify the port on which the mail server
accepts SMTP requests. The <tt>Max. timeout</tt> field allows you to
specify how long Zope should wait (in seconds) for a response from the mail
server before aborting a mail request. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Mail-Host.dtml">Mail Host</a>&gt;Security</h1>
<p> See <a href="../Folder_Security.dtml">Folder&gt;Security</a>. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>Product Management</h1>
<p> The Product Management Folder contains the Zope Products. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Product-Management.dtml">Product Management</a>&gt;Contents</h1>
<p> See <a href="../Folder_Contents.dtml">Folder&gt;Contents</a>. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Product-Management.dtml">Product Management</a>&gt;Find</h1>
<p> See <a href="../Folder_Find.dtml">Folder&gt;Find</a>. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Product-Management.dtml">Product Management</a>&gt;Properties</h1>
<p> See <a href="../Folder_Properties.dtml">Folder&gt;Properties</a>. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Product-Management.dtml">Product Management</a>&gt;Security</h1>
<p> See <a href="../Folder_Security.dtml">Folder&gt;Security</a>. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Product-Management.dtml">Product Management</a>&gt;Undo</h1>
<p> See <a href="../Folder_Undo.dtml">Folder&gt;Undo</a>. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>Product</h1>
<p>Products allow you to extend Zope by create new type of addable Zope
objects.</p>
<p>A Product contains other objects including a Factory which allows you
to make your Product objects available via the Product add list. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Product.dtml">Product</a>&gt;Add</h1>
<p> This view allows you to create a new Product.</p>
<p> The <tt>Id</tt> field specifies the id of the Product.
The <tt>Title</tt> field allows you to specify the title of the
Product. Click the <tt>Add</tt> button to create a new Product.
</p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Product.dtml">Product</a>&gt;Contents</h1>
<p> See <a href="../Folder_Contents.dtml">Folder&gt;Contents</a>. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Product.dtml">Product</a>&gt;Define Permissions</h1>
<p> XXX Remove view? </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Product.dtml">Product</a>&gt;Distribution</h1>
<p> This view allows you to create a distribution from a control panel
product. </p>
<p> 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. </p>
<p> To create a distribution file specify the version in the
<tt>Version</tt> field. The <tt>Configurable objects</tt>
multiple selection field specifies the objects which will appear in the control
panel when the distribution is installed. Click <tt>Create a distribution
archive</tt> to download the distribution file. The distribution file can
be installed in other Zopes by unzipping and untarring it inside the Zope
directory. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Product.dtml">Product</a>&gt;Find</h1>
<p> See <a href="../Folder_Find.dtml">Folder&gt;Find</a>. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Product.dtml">Product</a>&gt;Properties</h1>
<p> See <a href="../Folder_Properties.dtml">Folder&gt;Properties</a>. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Product.dtml">Product</a>&gt;Undo</h1>
<p> See <a href="../Folder_Undo.dtml">Folder&gt;Undo</a>. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>User Folder</h1>
<p> User Folders allow you to define new Zope users.</p>
<p>You can only have one User Folder per Folder. User Folders always
have <tt>acl_users</tt> as an id.</p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../User-Folder.dtml">User Folder</a>&gt;Add User</h1>
<p> This view allows you to define a new user. </p>
<p> The <tt>Name</tt> field allows you to specify the userid
of the user. The <tt>Password</tt> field allows you to assign a
password to the user. Enter the password again in the
<tt>(Confirm)</tt> field to make sure that you have entered the
correct password. The <tt>Domains</tt> field allows you to restrict
Internet domains from which the user can log in. Domains should be separated by
spaces. The <tt>Roles</tt> multiple selection list allows you to
specify the user's roles. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../User-Folder.dtml">User Folder</a>&gt;Contents</h1>
<p> This view allows you to manage the users defined in a user folder.
</p>
<p> The currently defined users are listed one per line with a
checkbox in front of each user. To edit a user click on its name link. To
delete one or more users click the checkboxes in front of the selected users
and click the <tt>Delete</tt> button. To add a new user click the
<tt>Add...</tt> button. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../User-Folder.dtml">User Folder</a>&gt;Edit User</h1>
<p> This view allows you to edit a user. </p>
<p> The <tt>Name</tt> field indicates the userid of the
user. The <tt>Password</tt> field allows you to assign a password to
the user. Enter the password again in the <tt>(Confirm)</tt> field to
make sure that you have entered the correct password. The
<tt>Domains</tt> field allows you to restrict Internet domains from
which the user can log in. Domains should be separated by spaces. The
<tt>Roles</tt> multiple selection list allows you to specify the
user's roles. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../User-Folder.dtml">User Folder</a>&gt;Security</h1>
<p> See <a href="../Folder_Security.dtml">Folder&gt;Security</a>. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../User-Folder.dtml">User Folder</a>&gt;Undo</h1>
<p> See <a href="../Folder_Undo.dtml">Folder&gt;Undo</a>. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>Version Management</h1>
<p> Version Management allows you to control Zope Versions for a central
location.</p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Version-Management.dtml">Version Management</a>&gt;Version</h1>
<p> This view allows you to manage active versions. </p>
<p> Currently active versions are listed one per line with a checkbox
in front of each version. To commit or discard changes made in one or more
versions check the checkboxes in front of the selected versions and then click
the <tt>Save</tt> button to save the changes in the selected
version(s) or click the <tt>Discard</tt> button to discard changes in
the selected version(s). </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>Version</h1>
<p> A Version allows you to make changes to Zope in a private
session.</p>
<p>After you review the changes you can discard them or make them live.
</p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Version.dtml">Version</a>&gt;Add</h1>
<p>This view allows you to create a new Version.</p>
<p> The <tt>Id</tt> field specifies the id of the Verson.
The <tt>Title</tt> field allows you to specify the title of the
Version. Click the <tt>Add</tt> button to create a new Version.
</p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Version.dtml">Version</a>&gt;Join/Leave</h1>
<p> 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. </p>
<p> The <tt>Start Working in</tt> button allows you to join
the version. The <tt>Quit Working in</tt> button allows you to leave
the version. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Version.dtml">Version</a>&gt;Properties</h1>
<p> This view allows you to edit the title of the version. </p>
<p> To change the title of the version enter the new title in the text
entry field and click the <tt>Edit</tt> button. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Version.dtml">Version</a>&gt;Save/Discard</h1>
<p> This view allows you to either commit or discard changes made in
this version. </p>
<p> The <tt>save</tt> button commits the changes made in the
version and makes them publicly visible. The <tt>discard</tt> button
removes the changes made in the version. The text entry field is available to
enter a comment regarding the version when saving or discarding the version.
</p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Version.dtml">Version</a>&gt;Security</h1>
<p> See <a href="../Folder_Security.dtml">Folder&gt;Security</a>. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>Z SQL Method</h1>
<p>Z SQL Methods allows you to access data in SQL databases.</p>
<p>Z SQL Methods define and call SQL statements on databases which are
defined by database connection objects.</p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Z-SQL-Method.dtml">Z SQL Method</a>&gt;Add</h1>
<p> This view allows you to create a new Z SQL Method.</p>
<p> The <tt>ID</tt> field specifies the id of the sql
method. The <tt>Title</tt> field allows you to specify the title of
the sql method. The <tt>Connection id</tt> select list specifies the
database connection on which the sql method operates. The
<tt>Arguments</tt> field allows you to specify a list of arguments
that the sql method takes. The arguments should be separated by spaces in the
field. The <tt>Query template</tt> text area 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. Note: the SQL statement need not be
a SELECT query, it may be any valid SQL statement including an INSERT or
UPDATE. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Z-SQL-Method.dtml">Z SQL Method</a>&gt;Advanced</h1>
<p> This view allows you to manage the advanced settings of a sql
method. </p>
<p> The <tt>ID</tt> and <tt>Title</tt> fields
indicate the id and title of the sql method. The <tt>Maximum number of
rows retrieved</tt> field allows you to specify an upper limit for the
number of rows a sql method can retrieve. The <tt>Maximum number of
results in the cache</tt> field allows you to set the size of the sql
method cache. The <tt>Maximum time (seconds) to cache results</tt>
field allows you to specify the how fresh the sql method cache must be. By
setting this time to a number greater than zero you enable sql method caching.
</p>
<p> You can provide a Python class for adding behavior to returns
rows. The results of the sql method will consist of a sequence of instances of
the specified class. The <tt>Class name</tt> field allows you to
specify the name of the Python class. The <tt>Class file</tt> field
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. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Z-SQL-Method.dtml">Z SQL Method</a>&gt;Edit</h1>
<p> This view allows you to edit the attributes of a sql method.
</p>
<p> The <tt>ID</tt> field indicates the id of the sql
method. The <tt>Title</tt> field allows you to specify the title of
the sql method. The <tt>Connection id</tt> select list specifies the
database connection on which the sql method operates. The
<tt>Arguments</tt> field allows you to specify a list of arguments
that the sql method takes. The arguments should be separated by spaces in the
field. The <tt>Query template</tt> text area 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. Note: the SQL statement need not be
a SELECT query, it may be any valid SQL statement including an INSERT or
UPDATE. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Z-SQL-Method.dtml">Z SQL Method</a>&gt;Security</h1>
<p> See <a href="../Folder_Security.dtml">Folder&gt;Security</a>. </p>
<dtml-var standard_html_footer>
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
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