Skip to content
This repository has been archived by the owner on Sep 28, 2020. It is now read-only.

Commit

Permalink
Added basic help screens for Zope products. Some of these maybe moved…
Browse files Browse the repository at this point in the history
… to other Products (e.g. ZCatalog help should probably be in the ZCatalog Product). These files were generated from ZCMR.xml (Zope Content Manager's Reference, a DocBook document in the ZopeDoc cvs repository) via XSLT. Yeeha!
  • Loading branch information
latteier committed Dec 9, 1999
1 parent efa5b58 commit cd69bf4
Show file tree
Hide file tree
Showing 127 changed files with 1,298 additions and 0 deletions.
9 changes: 9 additions & 0 deletions help/Common-Instance-Property-Sheet.dtml
@@ -0,0 +1,9 @@
<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>
9 changes: 9 additions & 0 deletions help/Common-Instance-Property-Sheet_Add.dtml
@@ -0,0 +1,9 @@
<dtml-var standard_html_header>
<h1>
<a href="../Common-Instance-Property-Sheet.dtml">Common Instance Property Sheet</a>&gt;Add</h1>
<p> This view allows you to create a new Common Instance Property
Sheet.</p>
<p>The <tt>Id</tt> field specifies the Id of the Common
Instance Property Sheet. The <tt>Title</tt> field allows you to
specify the title of the Common Instance Propery Sheet.</p>
<dtml-var standard_html_footer>
5 changes: 5 additions & 0 deletions help/Common-Instance-Property-Sheet_Define-Permissions.dtml
@@ -0,0 +1,5 @@
<dtml-var standard_html_header>
<h1>
<a href="../Common-Instance-Property-Sheet.dtml">Common Instance Property Sheet</a>&gt;Define Permissions</h1>
<p> See <a href="../ZClass_Define-Permissions.dtml">ZClass&gt;Define Permissions</a>. </p>
<dtml-var standard_html_footer>
5 changes: 5 additions & 0 deletions help/Common-Instance-Property-Sheet_Properties.dtml
@@ -0,0 +1,5 @@
<dtml-var standard_html_header>
<h1>
<a href="../Common-Instance-Property-Sheet.dtml">Common Instance Property Sheet</a>&gt;Properties</h1>
<p> See <a href="../Folder_Properties.dtml">Folder&gt;Properties</a>. </p>
<dtml-var standard_html_footer>
7 changes: 7 additions & 0 deletions help/Control-Panel.dtml
@@ -0,0 +1,7 @@
<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>
22 changes: 22 additions & 0 deletions help/Control-Panel_Contents.dtml
@@ -0,0 +1,22 @@
<dtml-var standard_html_header>
<h1>
<a href="../Control-Panel.dtml">Control Panel</a>&gt;Contents</h1>
<p> This view displays information about the Zope process and provides
access to system management functions. </p>
<p> <tt>Zope version</tt> indicates the version of the Zope
system. <tt>Python version</tt> indicates the version of Python that
Zope is using. <tt>System platform</tt> indicates the type of machine
Zope is running on. <tt>Process ID</tt> indicates the PID number of
the Zope process. <tt>Running for</tt> indicates how long the Zope
process has been running. </p>
<p> The <tt>Shutdown</tt> button will shutdown the Zope
process. The <tt>Restart</tt> button will restart the Zope process.
The <tt>Restart</tt> button will only appear if Zope is running under
daemon control. </p>
<p> The <tt>Database Management</tt> link provides access to
database management functions such as packing and cache management. The
<tt>Version Management</tt> links provides access to version
management functions include version commit and abort. The <tt>Product
Management</tt> link provides access to management functions for installed
Zope Products. </p>
<dtml-var standard_html_footer>
5 changes: 5 additions & 0 deletions help/Control-Panel_Undo.dtml
@@ -0,0 +1,5 @@
<dtml-var standard_html_header>
<h1>
<a href="../Control-Panel.dtml">Control Panel</a>&gt;Undo</h1>
<p> See <a href="../Folder_Undo.dtml">Folder&gt;Undo</a>. </p>
<dtml-var standard_html_footer>
8 changes: 8 additions & 0 deletions help/DTML-Document.dtml
@@ -0,0 +1,8 @@
<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>
13 changes: 13 additions & 0 deletions help/DTML-Document_Add.dtml
@@ -0,0 +1,13 @@
<dtml-var standard_html_header>
<h1>
<a href="../DTML-Document.dtml">DTML Document</a>&gt;Add</h1>
<p>This view allows you to create a new DTML Document.</p>
<p>The <tt>Id</tt> field specifies the id of the DTML
Document. The <tt>Title</tt> field allows you to specify the title of
the DTML Document. The <tt>File</tt> field allows you to upload a
file from your local computer. Click the <tt>Browse...</tt> button to
locate a file to upload. </p>
<p>Click the <tt>Add</tt> button to create a new DTML
Document. Click the <tt>Add and Edit</tt> button to create a new DTML
Document and go directly to it's Edit view.</p>
<dtml-var standard_html_footer>
16 changes: 16 additions & 0 deletions help/DTML-Document_Edit.dtml
@@ -0,0 +1,16 @@
<dtml-var standard_html_header>
<h1>
<a href="../DTML-Document.dtml">DTML Document</a>&gt;Edit</h1>
<p> This view allows you to edit the contents of a document. </p>
<p> The <tt>id</tt> field indicates the id of the document.
The <tt>Title</tt> field allows you to edit the title of the
document. The <tt>Size</tt> field indicates the size of the
document's contents. The <tt>Last modified</tt> field indicates the
time the document was last changed. The text area allows you to edit the
contents of the document directly. You can use any editing keys that your
browser supports in the text area. To change the dimensions of the text area
click the <tt>Taller</tt>, <tt>Shorter</tt>,
<tt>Wider</tt>, or <tt>Narrower</tt> buttons repeatedly
until the size is correctly adjusted. To change the contents of the document
click the <tt>Change</tt> button. </p>
<dtml-var standard_html_footer>
5 changes: 5 additions & 0 deletions help/DTML-Document_Properties.dtml
@@ -0,0 +1,5 @@
<dtml-var standard_html_header>
<h1>
<a href="../DTML-Document.dtml">DTML Document</a>&gt;Properties</h1>
<p> See <a href="../Folder_Properties.dtml">Folder&gt;Properties</a>. </p>
<dtml-var standard_html_footer>
10 changes: 10 additions & 0 deletions help/DTML-Document_Proxy.dtml
@@ -0,0 +1,10 @@
<dtml-var standard_html_header>
<h1>
<a href="../DTML-Document.dtml">DTML Document</a>&gt;Proxy</h1>
<p> This view allows you to manage proxy roles for a document. </p>
<p> Proxy roles supplement the roles of the user who is viewing the
document in order to allow the document additional access. </p>
<p> Select the role(s) you wish to assign to the document from the
<tt>Proxy Roles</tt> multiple select list and click the
<tt>Change</tt> button to set proxy roles for the document. </p>
<dtml-var standard_html_footer>
5 changes: 5 additions & 0 deletions help/DTML-Document_Security.dtml
@@ -0,0 +1,5 @@
<dtml-var standard_html_header>
<h1>
<a href="../DTML-Document.dtml">DTML Document</a>&gt;Security</h1>
<p> See <a href="../Folder_Security.dtml">Folder&gt;Security</a>. </p>
<dtml-var standard_html_footer>
10 changes: 10 additions & 0 deletions help/DTML-Document_Upload.dtml
@@ -0,0 +1,10 @@
<dtml-var standard_html_header>
<h1>
<a href="../DTML-Document.dtml">DTML Document</a>&gt;Upload</h1>
<p> This view allows you to upload document files. </p>
<p> Use this view to completely replace the contents of a document
with the contents of an uploaded text file from your local computer. Click the
<tt>Browse...</tt> button to locate a file to upload. Click the
<tt>Change</tt> button to replace the document's contents with the
uploaded file. </p>
<dtml-var standard_html_footer>
5 changes: 5 additions & 0 deletions help/DTML-Document_View.dtml
@@ -0,0 +1,5 @@
<dtml-var standard_html_header>
<h1>
<a href="../DTML-Document.dtml">DTML Document</a>&gt;View</h1>
<p> This view allows you to preview the document. </p>
<dtml-var standard_html_footer>
9 changes: 9 additions & 0 deletions help/DTML-Method.dtml
@@ -0,0 +1,9 @@
<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>
5 changes: 5 additions & 0 deletions help/DTML-Method_Add.dtml
@@ -0,0 +1,5 @@
<dtml-var standard_html_header>
<h1>
<a href="../DTML-Method.dtml">DTML Method</a>&gt;Add</h1>
<p> See <a href="../DTML-Document_Add.dtml">DTML Document&gt;Add</a>. </p>
<dtml-var standard_html_footer>
5 changes: 5 additions & 0 deletions help/DTML-Method_Edit.dtml
@@ -0,0 +1,5 @@
<dtml-var standard_html_header>
<h1>
<a href="../DTML-Method.dtml">DTML Method</a>&gt;Edit</h1>
<p> See <a href="../DTML-Document_Edit.dtml">DTML Document&gt;Edit</a>. </p>
<dtml-var standard_html_footer>
5 changes: 5 additions & 0 deletions help/DTML-Method_Proxy.dtml
@@ -0,0 +1,5 @@
<dtml-var standard_html_header>
<h1>
<a href="../DTML-Method.dtml">DTML Method</a>&gt;Proxy</h1>
<p> See <a href="../DTML-Document_Proxy.dtml">DTML Document&gt;Proxy</a>. </p>
<dtml-var standard_html_footer>
5 changes: 5 additions & 0 deletions help/DTML-Method_Security.dtml
@@ -0,0 +1,5 @@
<dtml-var standard_html_header>
<h1>
<a href="../DTML-Method.dtml">DTML Method</a>&gt;Security</h1>
<p> See <a href="../Folder_Security.dtml">Folder&gt;Security</a>. </p>
<dtml-var standard_html_footer>
5 changes: 5 additions & 0 deletions help/DTML-Method_Upload.dtml
@@ -0,0 +1,5 @@
<dtml-var standard_html_header>
<h1>
<a href="../DTML-Method.dtml">DTML Method</a>&gt;Upload</h1>
<p> See <a href="../DTML-Document_Upload.dtml">DTML Document&gt;Upload</a>. </p>
<dtml-var standard_html_footer>
5 changes: 5 additions & 0 deletions help/DTML-Method_View.dtml
@@ -0,0 +1,5 @@
<dtml-var standard_html_header>
<h1>
<a href="../DTML-Method.dtml">DTML Method</a>&gt;View</h1>
<p> See <a href="../DTML-Document_View.dtml">DTML Document&gt;View</a>. </p>
<dtml-var standard_html_footer>
5 changes: 5 additions & 0 deletions help/Database-Management.dtml
@@ -0,0 +1,5 @@
<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>
16 changes: 16 additions & 0 deletions help/Database-Management_Cache-Parameters.dtml
@@ -0,0 +1,16 @@
<dtml-var standard_html_header>
<h1>
<a href="../Database-Management.dtml">Database Management</a>&gt;Cache Parameters</h1>
<p> This view allows you to view cache statistics and set cache
parameters. The Zope cache operates by keeping frequently used objects in
memory to improve performance. A larger cache improves object access speed, but
increases memory usage. A smaller cache decreases object access speed, but
reduces memory usage. </p>
<p> <tt> Total number of objects in the database</tt>
indicates the number of persistent objects in the Zope database.
<tt>Number of objects in the cache</tt> indicates the number of
objects which are currently loaded in memory. <tt>Target size</tt>
indicates ideal number of objects to have in memory. <tt>Target maximum
time between accesses</tt> indicates the amount of time after which Zope
should remove an object from memory if it hasn't been accessed. </p>
<dtml-var standard_html_footer>
17 changes: 17 additions & 0 deletions help/Database-Management_Database.dtml
@@ -0,0 +1,17 @@
<dtml-var standard_html_header>
<h1>
<a href="../Database-Management.dtml">Database Management</a>&gt;Database</h1>
<p> This view allows you to view database status information. It also
allows you to perform maintenance tasks such as database packing, cache
management, and "undoing" previous changes to your site. </p>
<p> <tt>Database Size</tt> indicates the size in kilobytes
of the Zope database file. <tt>Database Location</tt> indicates the
path to the Zope database file. </p>
<p> The <tt>Pack</tt> button removes old versions of Zope
objects, reducing the size of the Zope database. Once you pack the database you
cannot retrieve old copies of objects that have been removed by the packing
operation. The <tt>days</tt> field indicates how old objects versions
must be to be removed. For example if you pack the database and specify 2 days,
then you will not be able to revert to object versions older than 2 days.
</p>
<dtml-var standard_html_footer>
15 changes: 15 additions & 0 deletions help/Database-Management_Flush-Cache.dtml
@@ -0,0 +1,15 @@
<dtml-var standard_html_header>
<h1>
<a href="../Database-Management.dtml">Database Management</a>&gt;Flush Cache</h1>
<p> This view allows you to manually clear objects out of the Zope
cache. </p>
<p> The <tt>Full Sweep</tt> button allows you to remove
objects from the cache. The field indicates the number of seconds within which
an object must have been accessed in order not to be deactivated by the flush
operation. The <tt>Minimize</tt> button allows you to remove objects
from the cache. The field indicates the number of seconds within which an
object must have been accessed in order not to be deactivated by the flush
operation. The minimize operation differs from the full sweep in that it
removes all objects which are no longer referenced from the root, while the
full sweep merely removes most objects. </p>
<dtml-var standard_html_footer>
5 changes: 5 additions & 0 deletions help/Database-Management_Undo.dtml
@@ -0,0 +1,5 @@
<dtml-var standard_html_header>
<h1>
<a href="../Database-Management.dtml">Database Management</a>&gt;Undo</h1>
<p> See <a href="../Folder_Undo.dtml">Folder&gt;Undo</a>. </p>
<dtml-var standard_html_footer>
5 changes: 5 additions & 0 deletions help/External-Method.dtml
@@ -0,0 +1,5 @@
<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>
19 changes: 19 additions & 0 deletions help/External-Method_Add.dtml
@@ -0,0 +1,19 @@
<dtml-var standard_html_header>
<h1>
<a href="../External-Method.dtml">External Method</a>&gt;Add</h1>
<p> This view allows you to create a new External Method.</p>
<p> The <tt>Id</tt> field specifies the id of the external
method. The <tt>Title</tt> field allows you to specify the title of
the external method. The <tt>Function name</tt> field allows you to
specify the name of the function to use for the external method. The
<tt>Python module file</tt> field allows you to specify the module in
which the function is located. The Python module may be located in the Zope
Extensions directory, or in a
Extensions directory in a product directory. Product
directories are located in lib/python/Products. If the
Python module is in a product directory this should be indicated in the name of
the module which should be the name of the product followed by a dot followed
by the name of the Python module file. </p>
<p>Click the <tt>Add</tt> button to create a new External
Method.</p>
<dtml-var standard_html_footer>
18 changes: 18 additions & 0 deletions help/External-Method_Properties.dtml
@@ -0,0 +1,18 @@
<dtml-var standard_html_header>
<h1>
<a href="../External-Method.dtml">External Method</a>&gt;Properties</h1>
<p> This view allows you to manage the properties of an external
method. </p>
<p> The <tt>Id</tt> field indicates the id of the external
method. The <tt>Title</tt> field allows you to specify the title of
the external method. The <tt>Function name</tt> field allows you to
specify the name of the function to use for the external method. The
<tt>Python module</tt> field allows you to specify the module in
which the function is located. The Python module may be located in the Zope
Extensions directory, or in a
Extensions directory in a product directory. Product
directories are located in lib/python/Products. If the
Python module is in a product directory this should be indicated in the name of
the module which should be the name of the product followed by a dot followed
by the name of the Python module file. </p>
<dtml-var standard_html_footer>
5 changes: 5 additions & 0 deletions help/External-Method_Security.dtml
@@ -0,0 +1,5 @@
<dtml-var standard_html_header>
<h1>
<a href="../External-Method.dtml">External Method</a>&gt;Security</h1>
<p> See <a href="../Folder_Security.dtml">Folder&gt;Security</a>. </p>
<dtml-var standard_html_footer>
8 changes: 8 additions & 0 deletions help/External-Method_Try-It.dtml
@@ -0,0 +1,8 @@
<dtml-var standard_html_header>
<h1>
<a href="../External-Method.dtml">External Method</a>&gt;Try It</h1>
<p> This view executes the external method. </p>
<p> This view executes the external method and returns the results if
any. Only parameters from the web request are passed the the external method.
</p>
<dtml-var standard_html_footer>
4 changes: 4 additions & 0 deletions help/File.dtml
@@ -0,0 +1,4 @@
<dtml-var standard_html_header>
<h1>File</h1>
<p> Files allow you to store files in Zope. </p>
<dtml-var standard_html_footer>
9 changes: 9 additions & 0 deletions help/File_Add.dtml
@@ -0,0 +1,9 @@
<dtml-var standard_html_header>
<h1>
<a href="../File.dtml">File</a>&gt;Add</h1>
<p> This view allows you to create a new File. </p>
<p> The <tt>Id</tt> field specifies the id of the file. The
<tt>Title</tt> field allows you to specify the title of the file.
Click the <tt>Browse...</tt> button to locate a file to upload. Click
the <tt>Add</tt> button to create a new File.</p>
<dtml-var standard_html_footer>
15 changes: 15 additions & 0 deletions help/File_Edit.dtml
@@ -0,0 +1,15 @@
<dtml-var standard_html_header>
<h1>
<a href="../File.dtml">File</a>&gt;Edit</h1>
<p> This view allows you to manage the attributes of the file. </p>
<p> The <tt>Id</tt> field indicates the id of the file. The
<tt>Title</tt> field allows you to specify the title of the file. The
<tt>Content type</tt> field allows you to set the content type of the
file. Zope will try to guess an appropriate content type when you upload the
file. The <tt>Precondition</tt> field allows you to specify a
precondition for the file. A precondition is a method of document which is
executed before the file is viewed or downloaded. If the precondition raises an
exception then the file cannot be viewed. The <tt>Size</tt> field
indicates the size of the uploaded file. The <tt>Last modified</tt>
field indicates the last time the file was changed. </p>
<dtml-var standard_html_footer>
5 changes: 5 additions & 0 deletions help/File_Properties.dtml
@@ -0,0 +1,5 @@
<dtml-var standard_html_header>
<h1>
<a href="../File.dtml">File</a>&gt;Properties</h1>
<p> See <a href="../Folder_Properties.dtml">Folder&gt;Properties</a>. </p>
<dtml-var standard_html_footer>
5 changes: 5 additions & 0 deletions help/File_Security.dtml
@@ -0,0 +1,5 @@
<dtml-var standard_html_header>
<h1>
<a href="../File.dtml">File</a>&gt;Security</h1>
<p> See <a href="../Folder_Security.dtml">Folder&gt;Security</a>. </p>
<dtml-var standard_html_footer>
9 changes: 9 additions & 0 deletions help/File_Upload.dtml
@@ -0,0 +1,9 @@
<dtml-var standard_html_header>
<h1>
<a href="../File.dtml">File</a>&gt;Upload</h1>
<p> This view allows you to upload a file. </p>
<p> Use this view to completely replace the file with an uploaded file
from your local computer. Click the <tt>Browse...</tt> button to
locate a file to upload. Click the <tt>Change</tt> button to replace
the file with the uploaded file. </p>
<dtml-var standard_html_footer>
7 changes: 7 additions & 0 deletions help/File_View.dtml
@@ -0,0 +1,7 @@
<dtml-var standard_html_header>
<h1>
<a href="../File.dtml">File</a>&gt;View</h1>
<p> This view allows you to preview a file. </p>
<p> Depending on how your browser is configured and the type of the
file this may download the file to your local computer. </p>
<dtml-var standard_html_footer>
6 changes: 6 additions & 0 deletions help/Folder.dtml
@@ -0,0 +1,6 @@
<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>
13 changes: 13 additions & 0 deletions help/Folder_Add.dtml
@@ -0,0 +1,13 @@
<dtml-var standard_html_header>
<h1>
<a href="../Folder.dtml">Folder</a>&gt;Add</h1>
<p> This view allows you to add a new Folder.</p>
<p>The <tt>Id</tt> field specifies the id of the Folder. The
<tt>Title</tt> field allows you to specify the title of the Folder.
The <tt>Create public interface</tt> checkbox creates an
<tt>index_html </tt>DTML Method inside the Folder to give the Folder
a default HTML representation. The <tt>Create user folder</tt>
checkbox creates a User Folder inside the Folder to hold authorization
information for the Folder. Click the <tt>Add</tt> button to create a
new Folder. </p>
<dtml-var standard_html_footer>

0 comments on commit cd69bf4

Please sign in to comment.