Commit 0ab7add0 authored by Amos Latteier's avatar Amos Latteier

Merged new help content changes into the trunk. This completes the switch form...

Merged new help content changes into the trunk. This completes the switch form DTML to STX. Also includes misc fixes to support help system.
parent ba6fe1ee
......@@ -84,7 +84,7 @@
##############################################################################
"""Access control support"""
__version__='$Revision: 1.38 $'[11:-2]
__version__='$Revision: 1.39 $'[11:-2]
from Globals import HTMLFile, MessageDialog, Dictionary
......@@ -127,7 +127,7 @@ class RoleManager(ExtensionClass.Base, PermissionMapping.RoleManager):
'filter': _isNotBeingUsedAsAMethod,
},
{'label':'Define Permissions', 'action':'manage_access',
'help':('OFSP','Security-DefinePermissions.stx'),
'help':('OFSP','Security_Define-Permissions.stx'),
'filter': _isBeingUsedAsAMethod,
},
)
......@@ -186,7 +186,10 @@ class RoleManager(ExtensionClass.Base, PermissionMapping.RoleManager):
return result
manage_roleForm=HTMLFile('roleEdit', globals())
manage_roleForm=HTMLFile('roleEdit', globals(), management_view='Security',
help_topic='Security_Manage-Role.stx',
help_product='OFSP')
def manage_role(self, role_to_manage, permissions=[], REQUEST=None):
"Change the permissions given to the given role"
self._isBeingUsedAsAMethod(REQUEST, 0)
......@@ -197,7 +200,10 @@ class RoleManager(ExtensionClass.Base, PermissionMapping.RoleManager):
if REQUEST is not None: return self.manage_access(self,REQUEST)
manage_acquiredForm=HTMLFile('acquiredEdit', globals())
manage_acquiredForm=HTMLFile('acquiredEdit', globals(), management_view='Security',
help_topic='Security_Manage-Acquisition.stx',
help_product='OFSP')
def manage_acquiredPermissions(self, permissions=[], REQUEST=None):
"Change the permissions that acquire"
self._isBeingUsedAsAMethod(REQUEST, 0)
......@@ -211,8 +217,10 @@ class RoleManager(ExtensionClass.Base, PermissionMapping.RoleManager):
if REQUEST is not None: return self.manage_access(self,REQUEST)
manage_permissionForm=HTMLFile('permissionEdit', globals())
manage_permissionForm=HTMLFile('permissionEdit', globals(), management_view='Security',
help_topic='Security_Manage-Permission.stx',
help_product='OFSP')
def manage_permission(self, permission_to_manage,
roles=[], acquire=0, REQUEST=None):
"""Change the settings for the given permission
......@@ -321,8 +329,13 @@ class RoleManager(ExtensionClass.Base, PermissionMapping.RoleManager):
__ac_local_roles__=None
manage_listLocalRoles=HTMLFile('listLocalRoles', globals())
manage_editLocalRoles=HTMLFile('editLocalRoles', globals())
manage_listLocalRoles=HTMLFile('listLocalRoles', globals(), management_view='Security',
help_topic='Security_Local-Roles.stx',
help_product='OFSP')
manage_editLocalRoles=HTMLFile('editLocalRoles', globals(), management_view='Security',
help_topic='Security_User-Local-Roles.stx',
help_product='OFSP')
def has_local_roles(self):
dict=self.__ac_local_roles__ or {}
......
......@@ -83,7 +83,7 @@
#
##############################################################################
__doc__="""System management components"""
__version__='$Revision: 1.60 $'[11:-2]
__version__='$Revision: 1.61 $'[11:-2]
import sys,os,time,string,Globals, Acquisition, os, Undo
......@@ -116,11 +116,11 @@ class DatabaseManager(Fake, SimpleItem.Item, Acquisition.Implicit):
manage_options=(
(
{'label':'Database', 'action':'manage_main',
'help':('OFSP','Database-Management_Database.dtml')},
'help':('OFSP','Database-Management_Database.stx')},
{'label':'Cache Parameters', 'action':'manage_cacheParameters',
'help':('OFSP','Database-Management_Cache-Parameters.dtml')},
'help':('OFSP','Database-Management_Cache-Parameters.stx')},
{'label':'Flush Cache', 'action':'manage_cacheGC',
'help':('OFSP','Database-Management_Flush-Cache.dtml')},
'help':('OFSP','Database-Management_Flush-Cache.stx')},
)
)
......@@ -137,7 +137,7 @@ class VersionManager(Fake, SimpleItem.Item, Acquisition.Implicit):
manage_options=(
(
{'label':'Version', 'action':'manage_main',
'help':('OFSP','Version-Management_Version.dtml')},
'help':('OFSP','Version-Management_Version.stx')},
)
)
......@@ -160,9 +160,9 @@ class DebugManager(Fake, SimpleItem.Item, Acquisition.Implicit):
manage_options=(
( {'label':'Debugging Info', 'action':'manage_main',
'help':('OFSP','DebugInfo-Debug.dtml')},
'help':('OFSP','Debug-Information_Debug.stx')},
{'label':'Profiling', 'action':'manage_profile',
'help':('OFSP','DebugInfo-Profile.dtml')},
'help':('OFSP','Debug-Information_Profile.stx')},
)
)
......@@ -285,7 +285,7 @@ class ApplicationManager(Folder,CacheManager):
manage_options=(
(
{'label':'Contents', 'action':'manage_main',
'help':('OFSP','Control-Panel_Contents.dtml')},
'help':('OFSP','Control-Panel_Contents.stx')},
)
+Undo.UndoSupport.manage_options
)
......
......@@ -84,8 +84,8 @@
##############################################################################
__doc__='''Factory objects
$Id: Factory.py,v 1.17 2000/05/11 18:54:13 jim Exp $'''
__version__='$Revision: 1.17 $'[11:-2]
$Id: Factory.py,v 1.18 2000/06/20 01:59:40 amos Exp $'''
__version__='$Revision: 1.18 $'[11:-2]
import OFS.SimpleItem, Acquisition, Globals, AccessControl.Role
import Products, Product
......@@ -110,10 +110,9 @@ class Factory(
manage_options=(
(
{'label':'Edit', 'action':'manage_main',
'help':('OFSP','Zope-Factory_Edit.dtml')},
{'label':'Define Permissions', 'action':'manage_access',
'help':('OFSP','Zope-Factory_Define-Permissions.dtml')},
'help':('OFSP','Zope-Factory_Edit.stx')},
)
+AccessControl.Role.RoleManager.manage_options
+OFS.SimpleItem.Item.manage_options
)
......
......@@ -84,8 +84,8 @@
##############################################################################
__doc__='''Zope registerable permissions
$Id: Permission.py,v 1.3 2000/05/11 18:54:13 jim Exp $'''
__version__='$Revision: 1.3 $'[11:-2]
$Id: Permission.py,v 1.4 2000/06/20 01:59:40 amos Exp $'''
__version__='$Revision: 1.4 $'[11:-2]
import OFS.SimpleItem, Acquisition, Globals, ExtensionClass, AccessControl.Role
......@@ -100,13 +100,11 @@ class Permission(
manage_options=(
(
{'label':'Edit', 'action':'manage_main',
'help':('OFSP','Zope-Permission_Edit.dtml')},
{'label':'Define Permissions', 'action':'manage_access',
'help':('OFSP','Zope-Permission_Define-Permissions.dtml')},
'help':('OFSP','Zope-Permission_Edit.stx')},
)
+AccessControl.Role.RoleManager.manage_options
+OFS.SimpleItem.Item.manage_options
)
def __init__(self, id, title, name):
self.id=id
......
......@@ -185,7 +185,7 @@ class Product(Folder, PermissionManager):
Folder.manage_options+
(
{'label':'Distribution', 'action':'manage_distributionView',
'help':('OFSP','Product_Distribution.dtml')},
'help':('OFSP','Product_Distribution.stx')},
)
)
......
......@@ -137,6 +137,14 @@
</dtml-if>
</dtml-if>
</td>
<dtml-if "_.has_key('help_topic') and _.has_key('help_product')">
<td align="right" valign="top">
<dtml-var "HelpSys.button(HelpSys, REQUEST,
product=help_product,
topic=help_topic)">
</td>
<dtml-else>
<dtml-with "_(option=manage_options[a_])">
<dtml-if "option.has_key('help')">
<td align="right" valign="top">
......@@ -145,6 +153,8 @@
topic=option['help'][1])">
</td>
</dtml-if></dtml-with>
</dtml-if>
</tr>
</table>
<dtml-if Zope-Version>
......
......@@ -83,7 +83,7 @@
#
##############################################################################
__doc__="""Find support"""
__version__='$Revision: 1.18 $'[11:-2]
__version__='$Revision: 1.19 $'[11:-2]
import sys, os, string, time, Globals, ExtensionClass
......@@ -100,7 +100,9 @@ class FindSupport(ExtensionClass.Base):
manage_findFrame=HTMLFile('findFrame', globals())
manage_findForm=HTMLFile('findForm', globals(), management_view='Find')
manage_findAdv=HTMLFile('findAdv', globals(), management_view='Find')
manage_findAdv=HTMLFile('findAdv', globals(), management_view='Find',
help_topic='Find_Advanced.stx',
help_product='OFSP')
manage_findResult=HTMLFile('findResult', globals())
__ac_permissions__=(
......
......@@ -84,7 +84,7 @@
##############################################################################
"""Property sheets"""
__version__='$Revision: 1.50 $'[11:-2]
__version__='$Revision: 1.51 $'[11:-2]
import time, string, App.Management, Globals
from ZPublisher.Converters import type_converters
......@@ -127,9 +127,13 @@ class View(App.Management.Tabs, Base):
r=[]
for d in self.aq_parent.aq_parent.manage_options:
path=d['action']
r.append({'label': d['label'],
option={'label': d['label'],
'action': pre+path,
'path': '../../'+path})
'path': '../../'+path}
help=d.get('help')
if help is not None:
option['help']=help
r.append(option)
return r
def tabs_path_info(self, script, path):
......
......@@ -45,7 +45,7 @@ information for the Folder.
<dtml-if "_.SecurityCheckPermission('Add Documents, Images, and Files',this())">
<TR>
<TD ALIGN="TOP" COLSPAN="2">
<INPUT TYPE="CHECKBOX" NAME="createPublic:int" VALUE="1" CHECKED ID="cbCreatePublic">
<INPUT TYPE="CHECKBOX" NAME="createPublic:int" VALUE="1" ID="cbCreatePublic">
<STRONG><LABEL FOR="cbCreatePublic">Create public interface</LABEL></STRONG>
</TD>
</TR>
......@@ -54,7 +54,7 @@ information for the Folder.
<dtml-if "_.SecurityCheckPermission('Add User Folders',this())">
<TR>
<TD ALIGN="TOP" COLSPAN="2">
<INPUT TYPE="CHECKBOX" NAME="createUserF:int" VALUE="1" CHECKED ID="cbCreateUserF">
<INPUT TYPE="CHECKBOX" NAME="createUserF:int" VALUE="1" ID="cbCreateUserF">
<STRONG><LABEL FOR="cbCreateUserF">Create user folder</LABEL></STRONG>
</TD>
</TR>
......
......@@ -26,6 +26,11 @@ To change property values, edit the
values and click "Save Changes".
</p>
<table border="0" cellspacing="0" cellpadding="2">
<tr>
<th colspan="3">Property</th>
<th>Type</th>
</tr>
<dtml-in propertyMap mapping>
<tr>
<td align="left" valign="top" width="16">
......@@ -100,8 +105,8 @@ values and click "Save Changes".
</table>
</dtml-if>
</td>
<td align="left">
-- &dtml-type;
<td align="left" valign="top">
&dtml-type;
</td>
</tr>
</dtml-in>
......
......@@ -12,7 +12,7 @@
<H2>Rename Item</H2>
</dtml-if>
<dtml-var "HelpSys.HelpButton('Folder_Rename.stx','OFSP')">
<dtml-var "HelpSys.HelpButton('ObjectManager_Rename.stx','OFSP')">
<P>
<FORM ACTION="<dtml-var URL1>" METHOD="POST">
......
<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>
\ No newline at end of file
External Method
Description
External Methods allow you to add functionality to Zope by writing
Python functions which are exposed as callable Zope objects.
External Methods do not reside in the ZODB. They
reside in the Zope Extension directory, which is by default
'ZOPE2/Extensions'. Zope will find only the Python modules
that are in this directory. The Python module should also have
the ending '.py'.
How can an External Method be used? There are two common ways.
* HTML output - You can save all the HTML output of the method
into one string variable and return it at the end. You can
display the HTML using '&lt;dtml-var ExtMethodName&gt;'
* Variable output - You can simply return a variable, that
Zope uses later on, like a number.
See Also
"Using External Methods": http://www.zope.org/Documentation/How-To/ExternalMethods
\ No newline at end of file
External Methods allow you to add functionality to Zope by writing
Python functions which are exposed as callable Zope objects.
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/ExternalMethod/Help/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>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/ExternalMethod/Help/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>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/ExternalMethod/Help/External-Method.dtml">External Method</a>&gt;Security</h1>
<p> See <a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/Folder_Security.dtml">Folder&gt;Security</a>. </p><dtml-var standard_html_footer>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/ExternalMethod/Help/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>
\ No newline at end of file
<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>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/MailHost/Help/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>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/MailHost/Help/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>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/MailHost/Help/Mail-Host.dtml">Mail Host</a>&gt;Security</h1>
<p> See <a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/Folder_Security.dtml">Folder&gt;Security</a>. </p><dtml-var standard_html_footer>
\ No newline at end of file
......@@ -84,7 +84,7 @@
##############################################################################
"""Version object"""
__version__='$Revision: 1.40 $'[11:-2]
__version__='$Revision: 1.41 $'[11:-2]
import Globals, time
from AccessControl.Role import RoleManager
......@@ -117,11 +117,11 @@ class Version(Persistent,Implicit,RoleManager,Item):
manage_options=(
(
{'label':'Join/Leave', 'action':'manage_main',
'help':('OFSP','Version_Join-Leave.dtml')},
'help':('OFSP','Version_Join-Leave.stx')},
{'label':'Save/Discard', 'action':'manage_end',
'help':('OFSP','Version_Save-Discard.dtml')},
'help':('OFSP','Version_Save-Discard.stx')},
{'label':'Properties', 'action':'manage_editForm',
'help':('OFSP','Version_Properties.dtml')},
'help':('OFSP','Version_Properties.stx')},
)
+Item.manage_options
+RoleManager.manage_options
......
<dtml-var standard_html_header><h1>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>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>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/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>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/Common-Instance-Property-Sheet.dtml">Common Instance Property Sheet</a>&gt;Define Permissions</h1>
<p> See <a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/ZClass_Define-Permissions.dtml">ZClass&gt;Define Permissions</a>. </p><dtml-var standard_html_footer>
\ No newline at end of file
<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>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/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>
\ No newline at end of file
<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>
\ No newline at end of file
<dtml-var standard_html_header><h1>
DTML
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/DTML-Document.dtml">Document</a>
or
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/DTML-Method.dtml">Method</a>
Edit</h1>
<p> This view allows you to edit the contents of a DTML document or method. </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 Document/Method - Edit: Edit the contents (properties)
DTML Document/Method - Edit: Edit contents
Description
This view allows you to edit the contents of a DTML document or method.
This view allows you to edit the contents of a DTML Document or Method.
Controls
......
<dtml-var standard_html_header><h1>
DTML
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/DTML-Document.dtml">Document</a>
or
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/DTML-Method.dtml">Method</a>
Proxy</h1>
<p> This view allows you to manage proxy roles for a document or method. </p>
<p>
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.
</p>
<p>
To see how proxy roles can 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.
</p>
<p>
To see how proxy roles can 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.
</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>
DTML
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/DTML-Document.dtml">Document</a>
or
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/DTML-Method.dtml">Method</a>
Upload</h1>
<p> This view allows you to upload DTML files. </p>
<p> 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. 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>
DTML
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/DTML-Document.dtml">Document</a>
or
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/DTML-Method.dtml">Method</a>
View</h1>
<p> This view allows you to preview the document or method. </p><dtml-var standard_html_footer>
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/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>
\ No newline at end of file
<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>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/DTML-Method.dtml">DTML Method</a>&gt;Add</h1>
<p> See <a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/DTML-Document_Add.dtml">DTML Document&gt;Add</a>. </p><dtml-var standard_html_footer>
\ No newline at end of file
......@@ -83,6 +83,13 @@
#
##############################################################################
def manage_addDocument(self, id, title):
"""
Add a DTML Document to the current ObjectManager
"""
class DTMLDocument:
"""
A DTML Document is a Zope object that contains and executes DTML
......@@ -188,3 +195,7 @@ class DTMLDocument:
Document in bytes.
"""
__constructor__=manage_addDocument
<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>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/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>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/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>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/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>
\ No newline at end of file
Debug Information - Debugging Information: Online Zope debugging
Zope provides a simple debugging interface to help
product authors find memory leaks in their products
as well as Zope itself. There is a special
object available to users with sufficient access
to use the control panel. From the Control Panel,
click the 'Debugging information' link.
The following information is displayed:
* The Zope version
* The Python version
* The system platform name
* The ID number of the Zope process (if available on your platform)
* The length of time Zope has been running
* The top refcounts, including a table listing the changes since the last snapshot
* The open object database connections
The Zope version, Python version, and system
platform name are used to
verify compatibility between Zope, Python,
and your system. On platforms
where the process ID number is available,
the Zope process can be managed
using a more forceful means than is available
through the web.
The top refcounts list lets you take a look
at what is being stored by
Zope in memory. The scrollable list shows
how many instances of each
type of object are currently in memory.
If there are items in the list with a very
high refcount, there is a good chance there
is a memory leak in a product or in Zope. Memory leaks,
which cause Zope to take up excessive amounts of RAM,
are not likely to occur as often in the Python language
as they do in languages that do not have a garbage
collector. But memory leaks
still occur when a reference to an object is kept
even after the object is no longer useful.
The following example illustrates a simple reference
to an object that is no longer needed::
helloString = 'Hello, %s!'
name = ''
def printHello():
print helloString % name
def printHelloWorld():
global name
name = 'World'
printHello()
printHelloWorld()
'printHelloWorld()' sets a variable for the module
then calls 'printHello()'.
The problem is that module variables, such as 'name',
are never cleaned up by the garbage collector.
The 'name' object, which in this case is just a string but
could be an image or a DTML method, is kept in memory until
the Python process exits. Under normal circumstances,
the Python process that runs Zope exits only when
stopped, which could mean months of continuous usage.
There are many other circumstances where unnecessary
references can be accidentally held. Finding the cause
of a memory leak can be a major task. Look for books
and mailing lists on http://www.python.org .
The table below the list is designed to assist in
locating a specific memory leak. The "Update Snapshot"
link just below the table will take
the current refcounts and store them in memory.
Then each time the debugging page is reloaded, the
table will show the difference in
refcounts between the snapshot and the current state.
If your product is causing memory leaks,
take a snapshot before the memory leak occurs,
do whatever it is that seems to cause the leak,
then reload the debugging page. You should see which
type of object is is taking up excessive RAM.
Then check for the leak in the sections of your
code that deal with that type of object.
Finally, the debugging page shows a list of currently
open database connections. In Zope 2.x a database
connection usually corresponds
with an HTTP request. The left column shows the
time at which the connection was opened. If there
is a request that has been running for a long
time you may need to restart Zope to kill the
corresponding thread. The middle column usually
shows the state of the REQUEST object with size
of the cache for that connection in parentheses.
The right column shows
information about the version the user is working in.
Debug Management - Profile: Performance testing
Zope can provide real-time profiling information.
Profiling helps product authors to speed up sections
of code that are taking too long
to perform their tasks. In order to use profiling,
Zope has to be started with the 'PROFILE_PUBLISHER'
environment variable set to a non-empty value. If the variable
is set to a valid filesystem path, then the accumlated profile
information will be dumped to the named file when Zope is shut
down. If the variable is simply set to a non-empty value that
is not a valid filesystem path then Zope will still run in
profiling mode, but profile information will only be available
through the web interface.
Once Zope has started in profiling mode (note that profiling
will slow Zope performance significantly), use your site with
your Web browser - Zope will accumulate profiling information
as you are working with your site. When you want to view the
profiling information, visit the Control Panel, click on the
'Debugging information' link and select the 'Profiling' tab.
The profiling screen will show a list of methods and the amount
of time each method is taking. Multiple views are available by
changing the sort order and pushing the "update" button. The
online profiler is based on the standard Python profile module.
For specific information on the meaning of the profile information,
see the standard Python documentation for the profile module.
<dtml-var standard_html_header>
<h1>Debugging Information</h1>
<p> Zope provides a simple debugging interface to help
product authors find memory leaks in their products
as well as Zope itself. There is a special
object available to users with sufficient access
to use the control panel. From the Control Panel,
click the <code>Debugging information</code> link.</p>
<p> The following information is displayed:</p>
<ul><li><p>The Zope version</p>
</li>
<li><p>The Python version</p>
</li>
<li><p>The system platform name</p>
</li>
<li><p>The ID number of the Zope process
(if available on your platform)</p>
</li>
<li><p>The length of time Zope has been running</p>
</li>
<li><p>The top refcounts, including a table listing
the changes since the last snapshot</p>
</li>
<li><p>The open object database connections</p>
</li></ul>
<p> The Zope version, Python version, and system
platform name are used to
verify compatibility between Zope, Python,
and your system. On platforms
where the process ID number is available,
the Zope process can be managed
using a more forceful means than is available
through the web.</p>
<p> The top refcounts list lets you take a look
at what is being stored by
Zope in memory. The scrollable list shows
how many instances of each
type of object are currently in memory.</p>
<p> If there are items in the list with a very
high refcount, there is a good chance there
is a memory leak in a product or in Zope. Memory leaks,
which cause Zope to take up excessive amounts of RAM,
are not likely to occur as often in the Python language
as they do in languages that do not have a garbage
collector. But memory leaks
still occur when a reference to an object is kept
even after the object is no longer useful.</p>
<p> The following example illustrates a simple reference
to an object that is no longer needed:</p>
<PRE>
helloString = 'Hello, %s!'
name = ''
def printHello():
print helloString % name
def printHelloWorld():
global name
name = 'World'
printHello()
printHelloWorld()
</PRE>
<p> <code>printHelloWorld()</code> sets a variable for the module
then calls <code>printHello()</code>.
The problem is that module variables, such as <code>name</code>,
are never cleaned up by the garbage collector.
The <code>name</code> object, which in this case is just a string but
could be an image or a DTML method, is kept in memory until
the Python process exits. Under normal circumstances,
the Python process that runs Zope exits only when
stopped, which could mean months of continuous usage.</p>
<p> There are many other circumstances where unnecessary
references can be accidentally held. Finding the cause
of a memory leak can be a major task. Look for books
and mailing lists on http://www.python.org .</p>
<p> The table below the list is designed to assist in
locating a specific memory leak. The "Update Snapshot"
link just below the table will take
the current refcounts and store them in memory.
Then each time the debugging page is reloaded, the
table will show the difference in
refcounts between the snapshot and the current state.</p>
<p> If your product is causing memory leaks,
take a snapshot before the memory leak occurs,
do whatever it is that seems to cause the leak,
then reload the debugging page. You should see which
type of object is is taking up excessive RAM.
Then check for the leak in the sections of your
code that deal with that type of object.</p>
<p> Finally, the debugging page shows a list of currently
open database connections. In Zope 2.x a database
connection usually corresponds
with an HTTP request. The left column shows the
time at which the connection was opened. If there
is a request that has been running for a long
time you may need to restart Zope to kill the
corresponding thread. The middle column usually
shows the state of the REQUEST object with size
of the cache for that connection in parentheses.
The right column shows
information about the version the user is working in.
</p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>Profiling Information</h1>
<p> Zope can provide real-time profiling information.
Profiling helps product authors to speed up sections
of code that are taking too long
to perform their tasks. In order to use profiling,
Zope has to be started with the <code>PROFILE_PUBLISHER</code>
environment variable set to a non-empty value. If the variable
is set to a valid filesystem path, then the accumlated profile
information will be dumped to the named file when Zope is shut
down. If the variable is simply set to a non-empty value that
is not a valid filesystem path then Zope will still run in
profiling mode, but profile information will only be available
through the web interface.
</p>
<p> Once Zope has started in profiling mode (note that profiling
will slow Zope performance significantly), use your site with
your Web browser - Zope will accumulate profiling information
as you are working with your site. When you want to view the
profiling information, visit the Control Panel, click on the
<code>Debugging information</code> link and select the <code>Profiling</code> tab.</p>
<p> The profiling screen will show a list of methods and the amount
of time each method is taking. Multiple views are available by
changing the sort order and pushing the "update" button. The
online profiler is based on the standard Python profile module.
For specific information on the meaning of the profile information,
see the standard Python documentation for the profile module.
</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>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/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>
\ No newline at end of file
File - Add: Allows you to create a new File
File/Image - Add: Create a new File or Image
Description
Add a new generic file (binary contents) to the ZODB.
Creates a new File or Image.
Controls
......
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/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>
\ No newline at end of file
File - Edit: Allows you to manage the attributes of the file.
File/Image - Edit: Allows you to manage the attributes of the file.
Description
......
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/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>
\ No newline at end of file
File - Upload: Allows you to upload a file.
File/Image - Upload: Allows you to upload a file.
Description
......
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/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>
\ No newline at end of file
<dtml-var standard_html_header><h1>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>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>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/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>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/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>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/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>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/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>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/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>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/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>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/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>
\ No newline at end of file
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
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/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>
\ No newline at end of file
<dtml-var standard_html_header><h1>Image</h1>
<p> Images allow you to store image files in Zope.</p><dtml-var standard_html_footer>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/Image.dtml">Image</a>&gt;Add</h1>
<p> See <a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/File_Add.dtml">File&gt;Add</a>. </p><dtml-var standard_html_footer>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/Image.dtml">Image</a>&gt;View</h1>
<p> This view previews the image. </p><dtml-var standard_html_footer>
\ No newline at end of file
<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>
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.
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/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="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/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="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/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>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/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. The import file should
be located in the Zope import directory of the Zope installation.
Click the <tt>Import</tt> button to import the objects in the import
file.
</p>
<p>
By default, you will become the owner of the objects you import. In
some cases you may want to preserve the ownership information in the
imported objects. To preserve the existing ownership information in
the imported objects, select the <tt>retain existing ownership information</tt>
option before clicking the <tt>Import</tt> button.
</p>
<p>
Note that when you elect to retain existing ownership information, the
ownership information will be used exactly as it appears in the imported
objects. For instance, if the object you are importing was acquiring its
ownership information in the place where you exported it, it will
continue to acquire its ownership information when you import it (though
the actual ownership information may now be different in the context into
which it is imported).
</p>
<p>
Likewise, if the ownership of an object was explicit
(not acquired) when it was exported, then it will be explicit after it is
imported. The important thing to note in this case is that if you export an
object from another Zope site, the user who owned that object in the other
site may not exist in the site you are importing the object into. Zope does
not check to make sure the owner exists if you import an object that was
explicitly owned.
</p>
<p>
If the explicitly named owner does not exist in the site
that you are importing into, imported objects that depended on their
owner having a higher level of privilege than the special <tt>nobody</tt>
user may not work correctly until their ownership has been reassigned to
another user with sufficient privileges. See the online help for <a
href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/Ownership.dtml">
ownership</a> for more details.
</p>
<dtml-var standard_html_footer>
ObjectManager - Rename: Change ID of objects
Description
This view allows you to change the ID of one or more objects.
Controls
'to' -- Allows you to specify a new ID of for each object. The
default value is the old ID.
'OK' -- Changes the IDs of the objects listed.
'Cancel' -- Cancels renaming operation.
<dtml-var standard_html_header>
<h1>Ownership</h1>
<h2>Overview</h2>
<p>
This view allows you to manage the ownership of a Zope object.
</p>
<p>
All Zope objects except objects within the Control Panel support
ownership. When an object is created, copied or imported in Zope,
the logged-in user performing the operation becomes the owner of
the resulting object(s). Note that simply moving or renaming an
object does not change its ownership.
</p>
<p>
Ownership is most important for Zope objects that "execute"
content supplied through the web, such as DTML Methods, DTML
Documents and SQL Methods. The abilities of these executable
objects are constrained by the abilities of the object's owner
as well as the user causing the object to execute from a Zope
security point of view. In other words, an executable cannot
perform operations that its owner could not perform directly.
</p>
<p>
While most Zope objects support ownership, objects may not
always have an owner assigned. Objects that do not have an
assigned owner are <tt>unowned</tt>. An unowned executable
object executes with the permissions of the user running the
object.
</p>
<p>
There are three possible states of ownership that a Zope object
may be in. The object may be <em>unowned</em>, it may be
<em>owned directly</em> or it may be <em>owned implicitly</em>.
If an object is owned directly, the ownership information is
stored in the object itself. If an object is owned implicitly,
it acquires its ownership information from its container (which
may in turn acquire its ownership information from <em>its</em>
container, and so on).
</p>
<p>
When Zope automatically assigns ownership
to newly created or copied objects, it tries to use implict
ownership if possible. This makes it easier to change the
ownership of many objects at one time without having to visit
each object directly. For example, if everything in the folder
<tt>research</tt> is owned by Fred and you want to change the
ownership of everything in the folder to Jim, you only need to
visit the <tt>research</tt> folder and change the ownership there
if all of the objects under <tt>research</tt> are owned implicitly.
</p>
<h2>Managing ownership</h2>
<p>
Clicking on the <em>Ownership</em> tab of a Zope object will
display the id and title of the object along with the current
ownership status of the object.
</p>
<p>
If the object is not owned, you will see a message like:
</p>
<p>
<tt>Zope QuickStart Outline (QuickStart) is unowned. </tt>
</p>
<p>
If you have the <em>Take ownership</em> permission for the object,
you will also see a button labeled <tt>Take ownership</tt>. Click
the button to take ownership of the object.
</p>
<p>
If the object is owned directly, you will see a message like:
</p>
<p>
<tt>My Folder (my_folder) is owned directly by fred (acl_users).</tt>
</p>
<p>
You will also see a button labeled <tt>Make ownership implicit
(acquired)</tt>. Click this button to remove the direct ownership
information in the object and have the object acquire its ownership
information from its container.
</p>
<p>
If you have the <em>Take ownership</em> permission for the object,
you will also see a button labeled <tt>Take ownership</tt>. Click
the button to take ownership of the object.
</p>
<p>
If the object is owned implicitly, you will see a message like:
</p>
<p>
<tt>My Folder (my_folder) is owned indirectly (through acquisition)
by fred (acl_users).</tt>
</p>
<p>
You will also see a button labeled <tt>Make ownership explicit
</tt>. Click this button to make the object store the ownership
information that it is currently acquiring in itself directly.
After making ownership explicit, changes to the ownership
information in the current object's containers will no longer
affect the ownership information of the current object.
</p>
<p>
If you have the <em>Take ownership</em> permission for the object,
you will also see a button labeled <tt>Take ownership</tt>. Click
the button to take ownership of the object.
</p>
<h2>Notes on Ownership</h2>
<p>
It is possible to remove a user in your Zope installation while
objects that were owned by that user remain (for instance,
someone in your organization moves on, so you remove his account
on your Zope server). When you remove a Zope user, objects that
were owned by that user still have ownership information that
refers to that user. This will not cause an error, but it is
important to understand what happens to Zope objects whose owners
no longer exist.
</p>
<p>
This is most important for "executable" objects. Usually, the
abilities of executable objects are constrained by the abilities
of the object's owner as well as the user causing the object to
execute. If Zope cannot find the user that the executable's ownership
information refers to when it tries to execute the object, it will
use the special <tt>nobody</tt> or anonymous user instead. The
<tt>nobody</tt> user has very minimal priveleges, so you should take
this into account when deciding what to do about a user's owned
objects when you delete the user. If the user had DTML documents or
other executable objects that depended upon their owner to have a
higher level of privilege than the <tt>nobody</tt> user, they will
not work correctly until their ownership has been reassigned to
another user with sufficient privileges.
</p>
<dtml-var standard_html_footer>
Ownership: Sets the owner for the project
Ownership: Manage ownership
Description
Description
This view allows you to set the ownership of an object.
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.
On the top of the page Zope will tell you whether the
object has an owner and who it is.
Controls
All Zope objects except objects within the Control Panel support
ownership. When an object is created, copied or imported in Zope,
the logged-in user performing the operation becomes the owner of
the resulting object(s). Note that simply moving or renaming an
object does not change its ownership.
'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.
Ownership is most important for Zope objects that "execute"
content supplied through the web, such as DTML Methods, DTML
Documents and SQL Methods. The abilities of these executable
objects are constrained by the abilities of the object's owner
as well as the user causing the object to execute from a Zope
security point of view. In other words, an executable cannot
perform operations that its owner could not perform directly.
'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.
While most Zope objects support ownership, objects may not
always have an owner assigned. Objects that do not have an
assigned owner are <tt>unowned</tt>. An unowned executable
object executes with the permissions of the user running the
object.
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
There are three possible states of ownership that a Zope object
may be in. The object may be <em>unowned</em>, it may be
<em>owned directly</em> or it may be <em>owned implicitly</em>.
If an object is owned directly, the ownership information is
stored in the object itself. If an object is owned implicitly,
it acquires its ownership information from its container (which
may in turn acquire its ownership information from <em>its</em>
container, and so on).
When Zope automatically assigns ownership
to newly created or copied objects, it tries to use implict
ownership if possible. This makes it easier to change the
ownership of many objects at one time without having to visit
each object directly. For example, if everything in the folder
<tt>research</tt> is owned by Fred and you want to change the
ownership of everything in the folder to Jim, you only need to
visit the <tt>research</tt> folder and change the ownership there
if all of the objects under <tt>research</tt> are owned implicitly.
It is possible to remove a user in your Zope installation while
objects that were owned by that user remain (for instance,
someone in your organization moves on, so you remove his account
on your Zope server). When you remove a Zope user, objects that
were owned by that user still have ownership information that
refers to that user. This will not cause an error, but it is
important to understand what happens to Zope objects whose owners
no longer exist.
This is most important for "executable" objects. Usually, the
abilities of executable objects are constrained by the abilities
of the object's owner as well as the user causing the object to
execute. If Zope cannot find the user that the executable's ownership
information refers to when it tries to execute the object, it will
use the special <tt>nobody</tt> or anonymous user instead. The
<tt>nobody</tt> user has very minimal priveleges, so you should take
this into account when deciding what to do about a user's owned
objects when you delete the user. If the user had DTML documents or
other executable objects that depended upon their owner to have a
higher level of privilege than the <tt>nobody</tt> user, they will
not work correctly until their ownership has been reassigned to
another user with sufficient privileges.
Controls
'Take ownership' -- Allows you (the current user) to
take the ownership of this project if you have the
'Take ownership' role.
**Note:** 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.
**Note:** 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.
**Note:** This button will only show, if the
ownership is acquired.
All options depend on your permissions for the system,
since just a regular user would not be allowed to give
her/himself ownership to an arbitrary object.
\ No newline at end of file
<dtml-var standard_html_header><h1>Product Management</h1>
<p> The Product Management Folder contains the Zope Products. </p><dtml-var standard_html_footer>
\ No newline at end of file
<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>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/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>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/Product.dtml">Product</a>&gt;Define Permissions</h1>
<p> XXX Remove view? </p><dtml-var standard_html_footer>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/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>
\ No newline at end of file
<dtml-var standard_html_header><h1>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>
<h3>The "Define Permissions" View</h3>
<p> 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.</p>
<p> 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.</p>
<p> 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:</p>
<ul><li><p>Cumbersone,</p>
<li><p>Error prone, and</p>
<li><p>likely to break as the interfaces of the high-level
objects evolve.</p>
</ul>
<p> 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. </p>
<p> 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.</p>
<p> 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.</p>
<p> 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.</p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header><h1>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>
Security - Define security settings
Description
Description
This view allows you to define security settings for this item.
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.
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.
Controls
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.
Assign Roles to Permissions
Roles are listed as columns, and permissions are listed as rows.
To assign a role to a permission, check the checkbox at the intersection of the
row and column. You can also manage roles and permissions individually by
clicking on their name links.
You can create and manage local roles by clicking the
'local roles' link.
Create Roles
You can create new roles by entering the role name in the text
entry field under the 'User defined roles' heading and
clicking the 'Add Role' button. You can delete any existing
user defined roles by selecting them from the selection list under the
'User defined roles' heading and clicking the 'Delete
Role' button.
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.
Local Roles
You can create and manage local roles by clicking the
'local roles' link.
Assign Permissions to a Role
You can manage the permissions assigned to a role by clicking on the role name.
Assign Roles to a Permission
You can manage the roles assigned to a permission by clicking on the permission name.
Acquire Permissions
The 'Acquire permission settings' check box next
to each permission indicates whether this item should inherit security settings
for this permission from its container object.
The acquired permission
settings may be augmented by selecting roles for a permission in addition to
selecting to acquire permissions.
You can manage the acquisition of permission
settings individually by clicking the 'Acquire permission
settings' link.
Define Permissions - Define permissions for an object
Security - Define Permissions: Define permissions for an object
Description
......@@ -52,3 +52,24 @@ Define Permissions - Define permissions for an object
change (mutate) an object should be disabled. Otherwise,
a method could be modified when used on an instance, such
as a ZClass instance.
This interface is used to define how the operations of this object (or
objects that acquire permission settings from this object) correspond
to the operations defined by your product or ZClass.
Note 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.
<dtml-var standard_html_header><h1>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>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>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/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>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/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>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/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>
\ No newline at end of file
<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>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/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>
\ No newline at end of file
<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>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/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>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/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>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/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>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/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>
\ No newline at end of file
<dtml-var standard_html_header><h1>Z Search Interface</h1>
<p>A Search Interface allows you to search Zope databases.</p>
<p> The Search Interface will create a search-input form and a report
for displaying the search results. </p><dtml-var standard_html_footer>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/Z-Search-Interface.dtml">Z Search Interface</a>&gt;Add</h1>
<p> This view allows you to create new a search results document and
optionally a search input form.</p>
<p>The <tt>Select one or more seachable objects</tt>
selection indicates which ZCatalogs, ZSQL Methods or other searchable object
should be searched. The <tt>Report Id</tt> field indicates the id of
the search results report document. The <tt>Report Title</tt> field
allows you to indicate the title of the search results report document. The
<tt>Report Style</tt> selection indicates whether the report should
group results by record or display them all in a table. </p>
<p>If you wish to create a search input form, specify an id in the
<tt>Seach Input Id</tt> field. The <tt>Search Input
Title</tt> field allows you to indicated the tile of the search input
form.</p><dtml-var standard_html_footer>
\ No newline at end of file
<dtml-var standard_html_header><h1>ZClass</h1>
<p> ZClasses allow you to define new types of Zope objects.</p><dtml-var standard_html_footer>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/ZClass.dtml">ZClass</a>&gt;Add</h1>
<p>This view allows you to create a new ZClass. </p>
<p>The <tt>Id</tt> field specifies the id of the new ZClass.
The <tt>Title</tt> field allows you to specify the title of the
ZClass. The <tt>Meta type</tt> field specifies the name of the ZClass
as it will appear in the product add list. The <tt>Create constructor
objects</tt> checkbox specifies whether or not to 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. </p>
<p>The <tt>base classes</tt> selections allows you to
specify base classes for your ZClass. To add a base class select it from the
<tt>Unselected</tt> 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 <tt>Selected</tt> 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. The
<tt>Include standard Zope persistent object base classes</tt>
checkbox specifies whether or not your ZClass should subclass Zope persistence
classes and thereby act as a normal persistent object.</p>
<p>Click the <tt>Add</tt> button to create a new
ZClass.</p><dtml-var standard_html_footer>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/ZClass.dtml">ZClass</a>&gt;Basic</h1>
<p> This view allows you to manage the basic attributes of a ZClass.
</p>
<p> The <tt>Base classes</tt> field indicates the base
classes of the ZClass. The <tt>Title</tt> field allows you to specify
the title of the ZClass. The <tt>meta type</tt> field specifies the
product name of the ZClass as it appears in the product add list. The
<tt>class id</tt> field specifies a unique class identifier for the
ZClass. The <tt>icon</tt> field specifies the path to the ZClass's
icon. The <tt>Icon image</tt> field 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 an image file to upload click the
<tt>Browse</tt> button. To commit your changes to the ZClass click
the <tt>Change</tt> button. </p><dtml-var standard_html_footer>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/ZClass.dtml">ZClass</a>&gt;Define Permissions</h1>
<p> This view allows you to map permissions on an object to define
security settings when it is used as a method. </p>
<p> In general you should map the <tt>View</tt> permission
to the <tt>View</tt> permission. For some kinds of objects you may
wish to enable additional permission mappings. For example, ZClasses should map
their <tt>Create class instances</tt> permission to the permission
used by the ZClass factory. </p>
<p> To manage the permissions mapping, select the target permission
from the select list for each permission that you wish to map and then click
the <tt>Change</tt> button. </p><dtml-var standard_html_footer>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/ZClass.dtml">ZClass</a>&gt;Methods</h1>
<p> This view allows you to manage a class's methods. </p>
<p> 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. </p>
<p> The creation and management of methods proceeds exactly like the
management of a folder's contents. See <a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/Folder_Contents.dtml">Folder&gt;Contents</a>. The
main difference between editing method objects and normal objects is that
methods have a <tt>Define Permissions</tt> view in place of a
<tt>Security</tt> view. See
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/ZClass_Define-Permissions.dtml">ZClass&gt;Define Permissions</a>. </p>
<p> 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 <tt>ObjectManager</tt> and
the inner class will be only relevant inside the outer class. </p><dtml-var standard_html_footer>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/ZClass.dtml">ZClass</a>&gt;Permissions</h1>
<p> This view allows you to select permissions to be used by a ZClass.
</p>
<p> 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. </p>
<p> To select permissions choose them from the multiple select list
and click the <tt>Change</tt> button. </p><dtml-var standard_html_footer>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/ZClass.dtml">ZClass</a>&gt;Property Sheets</h1>
<p> This view allows you to manage a ZClass's property sheets. </p>
<p> 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. </p>
<p> The creation and management of property sheets proceeds exactly
like the management of a folder's contents. See
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/Folder_Contents.dtml">Folder&gt;Contents</a>. </p><dtml-var standard_html_footer>
\ No newline at end of file
ZClass - Subobjects: Define suboject types
Description
This view allows you to control what types of objects
are addable within instances of your ZClass.
Controls
[select list] -- Select one or more of the listed meta-types
to indicate that objects of these types can be added to
instances of your ZClass.
Objects should appear in folder lists -- Controls whether or not
instances of your ZClass appear as folders in the left Zope
management frame.
Change -- Makes the changes
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/ZClass.dtml">ZClass</a>&gt;Views</h1>
<p> This view allows you to manage a ZClass's views. </p>
<p> 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. </p>
<p> To create a new view specify its name in the text field. Select a
method for the view from the select list and click the <tt>Add</tt>
button. </p>
<p> To delete existing views select the view(s) by clicking the
checkboxes in front of the view and then click the <tt>Delete</tt>
button. To change the view method of an existing view choose the view method
from the select list and click the <tt>Change</tt> button. To reorder
views select a view by checking the checkbox in front of the view and click the
<tt>First</tt> button. Continue to move views to the first position
until you achieve the desired view order. </p><dtml-var standard_html_footer>
\ No newline at end of file
<dtml-var standard_html_header><h1>Zope Factory</h1>
<p> Zope Factories allow you to insert objects into the product add
list.</p><dtml-var standard_html_footer>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/Zope-Factory.dtml">Zope Factory</a>&gt;Add</h1>
<p> This view allows you to create a new Zope Factory. </p>
<p> The <tt>Id</tt> field specifiess the factory id, the
<tt>Title</tt> field allows you to specify the factory's title. The
<tt>Add list name</tt> field specifies the name that appears in the
product add list. The <tt>Method</tt> selection list specifies what
method is executed when the product is chosen from the product add list.
Typically this method is an add form. Click the <tt>Generate</tt>
button to create a new Zope Factory.</p><dtml-var standard_html_footer>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/Zope-Factory.dtml">Zope Factory</a>&gt;Define Permissions</h1>
<p> XXX Remove view? </p><dtml-var standard_html_footer>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/Zope-Factory.dtml">Zope Factory</a>&gt;Edit</h1>
<p> This view allows you to edit factory settings. </p>
<p> A factory creates entries in the Zope product add list. </p>
<p> The <tt>Id</tt> field indicates the factory id, the
<tt>Title</tt> field allows you to specify the factory's title. The
<tt>Add list name</tt> field specifies the name that appears in the
product add list. The <tt>Initial method</tt> selection list
specifies what method is executed when the product is chosen from the product
add list. Typically this method is an add form. The
<tt>Permission</tt> selection list specifies 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.
</p><dtml-var standard_html_footer>
\ No newline at end of file
<dtml-var standard_html_header><h1>Zope Permission</h1>
<p> Zope Permissions allow you to define new permissions for
ZClasses.</p><dtml-var standard_html_footer>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/Zope-Permission.dtml">Zope Permission</a>&gt;Add</h1>
<p>This view allows you to create a new Permission.</p>
<p> The <tt>Id</tt> field specifies the permission's id. The
<tt>Title</tt> field allows you to specify the permissions's title.
The <tt>Name</tt> field specifies the name of the permission. A
permission's name must be unique. Click the <tt>Add</tt> button to
create a new Zope Permission. </p><dtml-var standard_html_footer>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/Zope-Permission.dtml">Zope Permission</a>&gt;Define Permissions</h1>
<p> XXX Remove view? </p><dtml-var standard_html_footer>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/Zope-Permission.dtml">Zope Permission</a>&gt;Edit</h1>
<p> This view allows you to edit permission settings. </p>
<p> The <tt>Id</tt> field indicates the permission's id. The
<tt>Title</tt> field allows you to specify the permissions's title.
The <tt>Name</tt> field specifies the name of the permission. A
permission's name must be unique. </p><dtml-var standard_html_footer>
\ No newline at end of file
......@@ -122,8 +122,10 @@ class Vocabulary(Item, Persistent, Implicit,
manage_options=(
(
{'label': 'Vocabulary', 'action': 'manage_main'},
{'label': 'Query', 'action': 'manage_query'},
{'label': 'Vocabulary', 'action': 'manage_main',
'help' : ('ZCatalog', 'Vocabulary_Vocabulary.stx')},
{'label': 'Query', 'action': 'manage_query',
'help': ('ZCatalog', 'Vocabulary_Query.stx')},
)
+Item.manage_options
+AccessControl.Role.RoleManager.manage_options
......
<dtml-var standard_html_header>
<h1>Vocabulary</h1>
<p>Vocabularies display a list of all the unique words that are
indexed by a Catalog or Catalogs that use this Vocabulary object.
This view allows you to browse all of the words in the Vocabulary</p>
<dtml-var standard_html_footer>
Vocabulary
Description
Vocabularies display a list of all the unique words that are
indexed by a Catalog or Catalogs that use this Vocabulary object.
This view allows you to browse all of the words in the Vocabulary
<dtml-var standard_html_header>
<h1>Vocabulary Query</h1>
<p>This form lets you query the Vocabulary for words that match a
certain pattern.</p>
<dtml-var standard_html_footer>
Vocabulary - Query: Query Vocabulary
Description
This form lets you query the Vocabulary for words that match a
certain pattern.
Controls
Vocabulary - Vocabulary: Description here
Description
Details here
Controls
Details here
<dtml-var standard_html_header><h1>ZCatalog</h1>
<p>ZCatalogs allow you to index and search for Zope objects.</p><dtml-var standard_html_footer>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/ZCatalog/Help/ZCatalog.dtml">ZCatalog</a>&gt;Add</h1>
<p>This view allows you to create a new ZCatalog.</p>
<p>The <tt>Id</tt> field specifies the id of the ZCatalog.
The <tt>Title</tt> field allows you to specify the title of the
ZCatalog. Click the <tt>Add</tt> button to create a new
ZCatalog.</p><dtml-var standard_html_footer>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/ZCatalog/Help/ZCatalog.dtml">ZCatalog</a>&gt;Cataloged Objects</h1>
<p> This view allows you to manage catalog entries. </p>
<p> The catalog holds records which refer to Zope objects. If the
catalog currently contains records they will be listed in this view. </p>
<p> You can update all the records by clicking the <tt>Update
Catalog</tt> button. You can remove all the records by clicking the
<tt>Clear Catalog</tt> button. To update or remove individual
records, check the checkboxes next to the selected record(s) and then click the
either of the <tt>Update</tt> buttons to update the record(s) or
click either of the <tt>Remove</tt> buttons to remove the record(s).
You can examine individual catalog records by clicking on the record name
links. </p><dtml-var standard_html_footer>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/ZCatalog/Help/ZCatalog.dtml">ZCatalog</a>&gt;Contents</h1>
<p> See <a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/Folder_Contents.dtml">Folder&gt;Contents</a>. </p><dtml-var standard_html_footer>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/ZCatalog/Help/ZCatalog.dtml">ZCatalog</a>&gt;Find Items to ZCatalog</h1>
<p> This view allows you to add records to the catalog. </p>
<p> This view operates like a normal find view (see
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/Folder_Find.dtml">Folder&gt;Find</a>) to locate objects for cataloging. Objects which
match the find criteria will be added to the catalog. </p><dtml-var standard_html_footer>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/ZCatalog/Help/ZCatalog.dtml">ZCatalog</a>&gt;Indexes</h1>
<p> This view allows you to manage the catalog indexes. </p>
<p> The catalog provides searching by indexing information about
cataloged objects. Indexes record information about object attributes. </p>
<p> To delete one or more index select the index(es) by checking the
checkbox in front of the index(es) and then click the <tt>Delete</tt>
button. To add a new index specify the name of the attribute or method that the
index in the text field, select the index type from the selection list, and
then click <tt>Add</tt>. <tt>TextIndexes</tt> are
appropriate for full text attributes, <tt>KeywordIndexes</tt> are
appropriate for attributes which return lists, and
<tt>FieldIndexes</tt> are appropriate for attributes which return
simple values. </p><dtml-var standard_html_footer>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/ZCatalog/Help/ZCatalog.dtml">ZCatalog</a>&gt;MetaData Table</h1>
<p> This view allows you to manage the catalog record schema. </p>
<p> The catalog holds records which describe the cataloged objects.
This view allows you to define columns for these records. </p>
<p> To delete one or more column select the column(s) by checking the
checkbox in front of the column(s) and then click the <tt>Delete</tt>
button. To add a new column specify the name of the attribute or method that
the column in the text field and then click <tt>Add</tt>. </p><dtml-var standard_html_footer>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/ZCatalog/Help/ZCatalog.dtml">ZCatalog</a>&gt;Status</h1>
<p> This view allows you to control advanced catalog features. </p>
<p> 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. </p>
<p> If substransactions are disabled you can enable them by clicking
the <tt>Enable</tt> button. If subtransactions are enabled you can
disable them by clicking the <tt>Disable</tt> button. If
subtransactions are enabled you can set the subtransaction threshold by
specifying the threshold in the text field and clicking the
<tt>Change</tt> button. </p><dtml-var standard_html_footer>
\ No newline at end of file
<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>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/ZSQLMethods/Help/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>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/ZSQLMethods/Help/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>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/ZSQLMethods/Help/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>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/ZSQLMethods/Help/Z-SQL-Method.dtml">Z SQL Method</a>&gt;Security</h1>
<p> See <a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/OFSP/Help/Folder_Security.dtml">Folder&gt;Security</a>. </p><dtml-var standard_html_footer>
\ No newline at end of file
<dtml-var standard_html_header><h1>
<a href="<dtml-var SCRIPT_NAME>/Control_Panel/Products/ZSQLMethods/Help/Z-SQL-Method.dtml">Z SQL Method</a>&gt;Test</h1>
<p> This view allows you to test a sql method. </p>
<p> If arguments have been defined for this method there will be
fields available to provide values for the arguments. To execute the sql method
click the <tt>Submit Query</tt> button and the results if any will be
returned. </p><dtml-var standard_html_footer>
\ No newline at end of file
......@@ -4,7 +4,7 @@
<H2>Add a Search Interface</H2>
<dtml-var "HelpSys.HelpButton('ZSearch-Interface_Add.dtml','OFSP')">
<dtml-var "HelpSys.HelpButton('ZSearch-Interface_Add.stx','OFSP')">
<form action="manage_addZSearch" method="POST">
......
......@@ -105,7 +105,8 @@ class ClassCaretaker:
if not getattr(klass,'_p_changed',None):
get_transaction().register(klass)
klass._p_changed=1
class ZCommonSheet(OFS.PropertySheets.PropertySheet, OFS.SimpleItem.Item):
"Property Sheet that has properties common to all instances"
meta_type="Common Instance Property Sheet"
......@@ -113,9 +114,9 @@ class ZCommonSheet(OFS.PropertySheets.PropertySheet, OFS.SimpleItem.Item):
manage_options=(
{'label':'Properties', 'action':'manage',
'help':('OFSP','Properties.dtml')},
'help':('OFSP','Properties.stx')},
{'label':'Define Permissions', 'action':'manage_security',
'help':('OFSP','ZClass_Define-Permissions.stx')},
'help':('OFSP','Security_Define-Permissions.stx')},
)
__ac_permissions__=(
......
......@@ -598,9 +598,10 @@ class ZObject:
{'label': 'Permissions',
'action' :'propertysheets/permissions/manage',
'help':('OFSP','ZClass_Permissions.stx')},
{'label': 'Security', 'action' :'manage_access',
{'label': 'Define Permissions', 'action' :'manage_access',
'help':('OFSP','Security-DefinePermissions.stx')},
)
ZStandardSheets=ZObject
......
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