This repository has been archived by the owner on Sep 28, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
New Help Content Files in STX format. They are compliant with the new
Help Content Style Guide written by Amos.
- Loading branch information
Showing
72 changed files
with
1,598 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
Advanced Find: Search for Zope objects | ||
|
||
Description | ||
|
||
To find objects you specify search criteria in the top frame and | ||
then click the 'Find' button. The find results will appear in | ||
the button frame. For less search criteria click the | ||
'Simple...' link. | ||
|
||
Controls | ||
|
||
'Find objects of type' -- Multiple selection list, that lets you choose the | ||
types of objects you wish to search and/or list in the search results. | ||
|
||
'with ids' -- Allows you to restrict the ids the found items. | ||
**Important**: You have to enter the id exactly. Parts of the id or wild cards will | ||
not work. | ||
|
||
'containing' -- Allows you to specify text that must be contained in the *body* | ||
of found items. Text in the title or other attribute fields will not be searched. | ||
|
||
'expr' -- Allows you to define DTML expressions to restrict found | ||
items. If the expression evaluates to false in the context | ||
of the found object, the object is rejected. | ||
|
||
'modified' -- Allows you to restrict your search to a specific time period. You | ||
can choose whether objects 'before' or 'after' a specified date/time (DateTime | ||
string format) should be searched. | ||
**Note:** If you do not specify a date the current date is assumed. | ||
**Examples of a valid DatTime string:** 'YYYY/MM/DD hh:mm:ss', 'YYYY-MM-DD', and | ||
'hh:mm'. | ||
|
||
'where the roles' -- In combination with 'have permission' option. This | ||
multiple select field allows you to select the user role. | ||
Read more in the nect row... | ||
|
||
'have permission' -- Allows you to only return objects which allow specific | ||
roles (specified in 'where the roles') with | ||
specific permissions (specified in 'have | ||
permissions'. | ||
|
||
*Where?* -- Finally you may choose either the 'Search only in this | ||
folder' or the 'Search all subfolders' radio box to | ||
control where Zope should look for found items. | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
Common Instance Property Sheet - Define Properties for ZClasses | ||
|
||
Description | ||
|
||
Common Instance Property Sheets allow ZClasses to define sets of | ||
properties. A property sheets provides an editing view for the | ||
properties, and default values for the properties. | ||
|
||
Individual instances of ZClasses maintain their properties normally. | ||
A property sheet merely provides a way to describe and edit a set of | ||
properties. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
Common Instance Property Sheet - Add: Create a new Common Instance Property Sheet. | ||
|
||
Description | ||
|
||
This view allows you to add a 'container object' that will enclose all the | ||
properties for the ZClass. | ||
|
||
Controls | ||
|
||
'Id' -- Specifies the id of the Common Instance Property Sheet. | ||
|
||
'Title' -- Allows you to specify the title of the Common Instance Propery Sheet. | ||
|
||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
Control Panel - Provides access to centralized Zope management facilties. | ||
|
||
Description | ||
|
||
From the Control Panel you can manage the Zope database, versions, | ||
and Zope Products. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
Control Panel - Contents: View/Management of Zope internals and system management | ||
|
||
Description | ||
|
||
This view displays information about the Zope process and provides | ||
access to system management functions. | ||
|
||
Controls | ||
|
||
The following list explains the information given to you on the top | ||
of the Control Panel Contents screen. | ||
|
||
**Note**: Some of these information are system/OS specific. | ||
|
||
Zope version -- Indicates the version of Zope, the type of the release | ||
(binary/source), the Python version, and the platform the binaries | ||
were compiled on (for example: win32-x86 or linux2) | ||
|
||
Python version -- Indicates the Python version that Zope is using. It also tells | ||
you how many time it was attempted to build this version (#0 means | ||
it is the binary release from "python.org":http://www.python.org ), when it | ||
was built, and for which platform if was compiled. | ||
|
||
System Platform -- Indicates the type of machine Zope is running on. | ||
Example: win32 for Windows 95/98/2000 or linux-i386 for | ||
Linux running on an Intel based platform. | ||
|
||
Process ID -- Indicates the PID of the Zope process. | ||
**Note:** Since on Windows systems the concept of | ||
process IDs does not exists, the number (sometimes | ||
negative) has no significance. | ||
|
||
Running for -- Indicates how long the Zope process has been running. | ||
|
||
The next buttons allow you to interfer with the Zope process by | ||
shutting it down and/or restarting it. | ||
|
||
Shutdown -- Button click will shutdown th Zope process. | ||
**Important:** You will not be able to acces Zope | ||
through the Web interface anymore after shutting it down. | ||
|
||
Restart -- Button click will restart Zope. The button will only appear | ||
if Zope is running under Deamon control. | ||
**Note:** It may experience a delay in accessing you Zope | ||
onjects again, since it takes the server a little time to | ||
restart itself. | ||
|
||
The last table shows the Zope administration options you can | ||
execute through the Web management interface. | ||
|
||
Database Management -- Provides access to the database management functions such | ||
as packing and cache management. | ||
|
||
Version Management -- Provides access to version management functions, including | ||
version commit and abort. | ||
|
||
Product Management -- Provides access to management functions for installed Zope | ||
Products. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
DTML Document: Provide general content management facilites to Zope. | ||
|
||
Discription | ||
|
||
They are DTML templates that are evaluated by Zope and then | ||
served as an HTML page. | ||
|
||
A DTML Document roughly corresponds to a web page. DTML Documents can | ||
be viewed and edited through the web. DTML Documents can contain scripting | ||
commands in Document Templates Markup Language (DTML). | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
DTML Document/Method - Add: Allows you to create a new DTML Document/Method | ||
|
||
Description | ||
|
||
Create a new DTML document. You can either start entering code | ||
or upload a local file to the server. | ||
|
||
Controls | ||
|
||
'Id' -- Allows you to specify the id of the DTML Document. | ||
|
||
'Title' -- Allows you to specify the title of the DTML Document. | ||
|
||
'File' -- Allows you to upload a file and make it the content of | ||
the document. Use the 'Berowse...' button to locate | ||
and select the file. | ||
|
||
'Add' -- Upon click, the Document is added to the current Zope | ||
folder and the content of the folder will be shown. | ||
|
||
'Add and Edit' -- Upon click, the Document is added to the current Zope | ||
folder and the 'Edit' view of the | ||
Document is displayed. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
DTML Document/Method - Edit: Edit the contents (properties) | ||
|
||
Description | ||
|
||
This view allows you to edit the contents of a DTML document or method. | ||
|
||
Controls | ||
|
||
'Id' -- Indicates the id of the DTML Document or Method. | ||
|
||
'Title' -- Allows you to specify the title of the DTML Document or Method. | ||
|
||
'Size' -- Indicates the size of the document's contents. | ||
|
||
'Last modified' -- Indicates the time the document was last changed. | ||
|
||
'body [Text area]' -- Allows you to edit the contents of the document directly. You | ||
can use any editing keys that your browser supports in the text area. | ||
|
||
'Taller' and 'Shorter' -- Allows to adjust the height of the body text area, so you can | ||
adjust it for you font size and screen resolution. | ||
|
||
'Wider' and 'Narrower' -- Allows to adjust the width of the body text area, so you can | ||
adjust it for you font size and screen resolution. | ||
|
||
'Change' -- Submits the contant changes. Before the new version is saved, | ||
the body is parsed for correct DTML syntax. The system will | ||
throw an exception, if it found some incorrect DTML syntax, | ||
such as a missing closing tag. | ||
**Important:** After throwing an exception, Internet | ||
Explorer 5.x will not let you use the back button, so that | ||
you have no way to recover your changes. You may use any | ||
any other browser or an editor that works via FTP. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
DTML Document/Method - Proxy: Manage proxy roles for a document or method | ||
|
||
Description | ||
|
||
Proxy roles replace the roles of the user who is viewing the | ||
document or method to allow the document additional access or to | ||
limit the access the document or method has. | ||
|
||
How can proxy roles be used to **limit** access? Suppose we want to | ||
assure that a document can only access public resources. We might do | ||
this if we allowed untrusted users to edit the document. All we need | ||
to do is to set the proxy roles to Anonymous. As long as we don't let | ||
untrusted users change the proxy roles, we can let them edit the | ||
document freely without worrying about giving them the ability to have | ||
protected resources accessed when the document is viewed. | ||
|
||
How can proxy roles be used to **grant** access? We might have a | ||
method that performs some management task for an unpriviledged user. | ||
For example, we might have a method that creates a folder for a user | ||
and makes them the owner. The method needs to call the | ||
'manage_addFolder' method to add the folder. Perhaps the | ||
'manage_addFolder' requires the 'Manager' role. Simply give the method | ||
the 'Manager' proxy role. This effectively allows the unpriviledged | ||
user to create a folder, but only though the special method. | ||
|
||
Controls | ||
|
||
'Id' -- Indicates the id of the DTML Document or Method. | ||
|
||
'Title' -- Indicates the title of the DTML Document or Method. | ||
|
||
'Proxy Roles' -- Allows you to select the role(s) you wish to assign to the | ||
documents or method. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
DTML Document/Method - Upload: Allows you to upload DTML files. | ||
|
||
Description | ||
|
||
Use this view to completely replace the contents of a document or method | ||
with the contents of an uploaded text file from your local computer. | ||
|
||
Controls | ||
|
||
'Browse...'[Button and Field] -- Allows you to locate and select the file to upload. | ||
|
||
'Change' -- Upon click, the system replaces the document's contents with the | ||
uploaded file. The upload will fail, if the uploaded file contains | ||
a DTML syntax error. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
DTML Document/Method - View: Allows you to preview the document or method. | ||
|
||
Description | ||
|
||
**Note:** Zope will use the user with which you logged into the | ||
management system. That causes sometimes complications, if you use | ||
user-sensitive code. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
DTML Method: Provide general templating management facilities to Zope. | ||
|
||
Description | ||
|
||
A DTML Method can be used to display almost any Zope object. DTML | ||
Methods can be viewed and edited through the web. They can contain | ||
scripting commands in Document Templates Markup Language. DTML Methods can be | ||
called from DTML Documents and other DTML Methods. | ||
|
||
I read the help for DTML Methods and Documents now, so what is the | ||
difference? The best way to think of it is that DTML Documents are | ||
like classes that have properties and methods, whereby DTML Methods | ||
are methods that act on the class Folder. Therefore it makes no sense | ||
for DTML Methods to have properties, whereby DTML Documents have | ||
properties. | ||
|
||
**Example:** Lets say you have the line '<dtml-var id>' | ||
in your DTML Document and in your DTML Method. The Document will | ||
display its own id (since it is a property of the Document), wherby | ||
the Method will return the id of the parent calling object (eg. | ||
DTML Document, Folder). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
Database Management: Provide access to management facilities for the Zope database. | ||
|
||
Description | ||
|
||
The Zope database is an object-oriented database that saves all | ||
versions of an object. So, whenever an object is saved, a "new | ||
version" object is created for it. Furthermore, the ZODB (Zope | ||
Object DataBase) leaves commonly/often used objects in cache to | ||
be able to access it faster. | ||
|
||
The database management screens allow you to do some maintanance | ||
on the ZODB. One task you should often do, especially during | ||
development time or when you have often-changing Zope objects, is | ||
to "pack" your database. You can find more here |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
Database Management - Cache Parameters: Adjust the Cahe options for your ZODB | ||
|
||
Description | ||
|
||
This view allows you to view cache statistics and set cache | ||
parameters. The Zope cache operates by keeping frequently used objects in | ||
memory to improve performance. A larger cache improves object access | ||
speed, but increases memory usage and vice versa. | ||
|
||
Controls | ||
|
||
'Total number of objects in the database' -- Indicates the number of *persistent* objects in the Zope database. | ||
|
||
'Number of objects in the cache' -- Indicates the number of objects which are currently loaded in memory. The | ||
amount of objects in the cache can never exeed the target size of objects. | ||
|
||
'Target size' -- Indicates ideal number of objects to have in memory. This number is usually | ||
greater than the actual number of objects in the cache, especially on sites | ||
that are not very busy. | ||
|
||
'Target maximum time between accesses' -- Indicates the amount of time after which Zope should remove an | ||
object from memory if it hasn't been accessed. | ||
**Note: **The optimum entry for this field depends on your site's purpose | ||
and structure. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
Database Management - Database: Allows you to view database status information and pack the database. | ||
|
||
Description | ||
|
||
What do we mean by packing the database? Before this question can | ||
be answered, you need to have some insight of how Zope stores | ||
objects. As you may know, the Zope database is object-oriented; | ||
therefore the Zope Object DataBase (ZODB). It is currently in | ||
version 3. Furthermore, the ZODB includes a simple but effective | ||
version control system. In order to make this version control | ||
work, the database needs to keep track of all the old versions in | ||
the ZODB. An old version can never expired. As you can imagine | ||
that soon the database will be pretty big. | ||
|
||
In order to keep this from happening you will be able to | ||
"truncate" the old Zope objects from teh database. So, packing | ||
simply looks at all the Zope old objects and deletes all that are | ||
older than X days (specified in the 'days' field. You | ||
should check regulary, and when your Zope installation takes a | ||
performance hit, then it help most of the time to pack your | ||
database first. | ||
|
||
Please refer to the general database help screen | ||
to read more about what packing does and how it works. | ||
|
||
Controls | ||
|
||
'Database Size' -- Indicates the size in kilobytes of the Zope database | ||
(ZODB) file. | ||
|
||
'Database Location' -- Indicates the path to the Zope database file. | ||
**Note:** The Data.fs file is operating system independent. | ||
Therefore you can just copy it into any Zope distribution | ||
on any operating system and all your ojects are | ||
transfered given that the destination Zope installation | ||
contains the same products as the original one. | ||
|
||
'Pack' -- Removes old versions of Zope objects, reducing the size of | ||
the Zope database. Once you pack the database you cannot | ||
retrieve old copies of objects that have been removed by the | ||
packing operation. | ||
|
||
'days (field)' -- Indicates how old object versions must be to be removed. For | ||
example, if you pack the database and specify 2 days, then you | ||
will not be able to revert to object versions older than 2 days. | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
Oops, something went wrong.