Commit 9e6da5a7 authored by Amos Latteier's avatar Amos Latteier

Moved help for External Method, ZCatalog, and MailHost to their own Product directories.

parent 5802a044
<dtml-var standard_html_header>
<h1>External Method</h1>
<p>External Methods allow you to add functionality to Zope by writing
Python functions which are exposed as callable Zope objects.</p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../External-Method.dtml">External Method</a>&gt;Add</h1>
<p> This view allows you to create a new External Method.</p>
<p> The <tt>Id</tt> field specifies the id of the external
method. The <tt>Title</tt> field allows you to specify the title of
the external method. The <tt>Function name</tt> field allows you to
specify the name of the function to use for the external method. The
<tt>Python module file</tt> field allows you to specify the module in
which the function is located. The Python module may be located in the Zope
Extensions directory, or in a
Extensions directory in a product directory. Product
directories are located in lib/python/Products. If the
Python module is in a product directory this should be indicated in the name of
the module which should be the name of the product followed by a dot followed
by the name of the Python module file. </p>
<p>Click the <tt>Add</tt> button to create a new External
Method.</p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../External-Method.dtml">External Method</a>&gt;Properties</h1>
<p> This view allows you to manage the properties of an external
method. </p>
<p> The <tt>Id</tt> field indicates the id of the external
method. The <tt>Title</tt> field allows you to specify the title of
the external method. The <tt>Function name</tt> field allows you to
specify the name of the function to use for the external method. The
<tt>Python module</tt> field allows you to specify the module in
which the function is located. The Python module may be located in the Zope
Extensions directory, or in a
Extensions directory in a product directory. Product
directories are located in lib/python/Products. If the
Python module is in a product directory this should be indicated in the name of
the module which should be the name of the product followed by a dot followed
by the name of the Python module file. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../External-Method.dtml">External Method</a>&gt;Security</h1>
<p> See <a href="../Folder_Security.dtml">Folder&gt;Security</a>. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../External-Method.dtml">External Method</a>&gt;Try It</h1>
<p> This view executes the external method. </p>
<p> This view executes the external method and returns the results if
any. Only parameters from the web request are passed the the external method.
</p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>Mail Host</h1>
<p> Mail Hosts allow you to send mail via SMTP.</p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Mail-Host.dtml">Mail Host</a>&gt;Add</h1>
<p> This view allows you to create a new Mail Host.</p>
<p> The <tt>Id</tt> field specifies the id of the mail host.
The <tt>Title</tt> field allows you to specify the title of the mail
host. The <tt>Local host</tt> field allows you to specify the name of
the server on which Zope is running. The <tt>SMTP host</tt> field
allows you to specify the name of the mail server. The <tt>SMTP
port</tt> field allows you to specify the port on which the mail server
accepts SMTP requests. The <tt>Max. timeout</tt> field allows you to
specify how long Zope should wait (in seconds) for a response from the mail
server before aborting a mail request. Click the <tt>Add</tt> button
to create a new Mail Host.</p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Mail-Host.dtml">Mail Host</a>&gt;Edit</h1>
<p> This view allows you to manage the attributes of the mail host.
</p>
<p> A mail host allows Zope to send mail with the SMTP protocol.
</p>
<p> The <tt>Id</tt> field indicates the id of the mail host.
The <tt>Title</tt> field allows you to specify the title of the mail
host. The <tt>Local host</tt> field allows you to specify the name of
the server on which Zope is running. The <tt>SMTP host</tt> field
allows you to specify the name of the mail server. The <tt>SMTP
port</tt> field allows you to specify the port on which the mail server
accepts SMTP requests. The <tt>Max. timeout</tt> field allows you to
specify how long Zope should wait (in seconds) for a response from the mail
server before aborting a mail request. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Mail-Host.dtml">Mail Host</a>&gt;Security</h1>
<p> See <a href="../Folder_Security.dtml">Folder&gt;Security</a>. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>ZCatalog</h1>
<p>ZCatalogs allow you to index and search for Zope objects.</p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../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>
<dtml-var standard_html_header>
<h1>
<a href="../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>
<dtml-var standard_html_header>
<h1>
<a href="../ZCatalog.dtml">ZCatalog</a>&gt;Contents</h1>
<p> See <a href="../Folder_Contents.dtml">Folder&gt;Contents</a>. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../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="../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>
<dtml-var standard_html_header>
<h1>
<a href="../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>
<dtml-var standard_html_header>
<h1>
<a href="../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>
<dtml-var standard_html_header>
<h1>
<a href="../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>
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