Added online help for ZSQL Methods

51659a93 · Amos Latteier · 28ae96d7 · 51659a93 · 51659a93 · 51659a93
Commit 51659a93 authored Jan 10, 2000 by Amos Latteier
8 changed files
--- a/lib/python/Products/ZSQLMethods/__init__.py
+++ b/lib/python/Products/ZSQLMethods/__init__.py
@@ -85,8 +85,8 @@
 __doc__='''SQL Method Product


-$Id: __init__.py,v 1.14 1999/03/30 19:33:47 jim Exp $'''
-__version__='$Revision: 1.14 $'[11:-2]
+$Id: __init__.py,v 1.15 2000/01/10 23:03:45 amos Exp $'''
+__version__='$Revision: 1.15 $'[11:-2]
 import Shared.DC.ZRDB.Search, Shared.DC.ZRDB.Aqueduct, SQL
 import Shared.DC.ZRDB.RDB
 import Shared.DC.ZRDB.sqlvar, Shared.DC.ZRDB.sqlgroup, Shared.DC.ZRDB.sqltest
@@ -110,6 +110,8 @@ def initialize(context):
                      Shared.DC.ZRDB.Search.manage_addZSearch),
        )

+    context.registerHelp()
+
 methods={
    # We still need this one, at least for now, for both editing and
    # adding.  Ugh.

--- a/lib/python/Products/ZSQLMethods/add.dtml
+++ b/lib/python/Products/ZSQLMethods/add.dtml
@@ -4,6 +4,8 @@
 <BODY BGCOLOR="#FFFFFF" LINK="#000099" VLINK="#555555">
 <H2>Add a SQL Method</H2>

+<dtml-var "HelpSys.HelpButton('Z-SQL-Method_Add.dtml','ZSQLMethods')">
+
 <dtml-if SQLConnectionIDs>
 <P>
 A SQL Method allows you to access a SQL database. For more
@@ -38,7 +40,7 @@ which the SQL Method will execute.
 <tr valign="top">    <th align='LEFT'><em>Arguments<em></th>
        <td align='LEFT'>
 	  <textarea name="arguments" cols="40" rows="4"></textarea>
-<!--<input name="arguments" size="40">></td></tr>
+        </td></tr>
 <tr>    <td colspan=2 align='LEFT'><strong>Query template</strong><br>
            <textarea name="template:text" rows=9 cols=50 wrap="off">select *
 from data</textarea></td></tr>

--- a/lib/python/Products/ZSQLMethods/help/Z-SQL-Method.dtml
+++ b/lib/python/Products/ZSQLMethods/help/Z-SQL-Method.dtml
+<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>
--- a/lib/python/Products/ZSQLMethods/help/Z-SQL-Method_Add.dtml
+++ b/lib/python/Products/ZSQLMethods/help/Z-SQL-Method_Add.dtml
+<dtml-var standard_html_header>
+<h1>
+<a href="../Z-SQL-Method.dtml">Z SQL Method</a>&gt;Add</h1>
+<p> This view allows you to create a new Z SQL Method.</p>
+<p> The <tt>ID</tt> field specifies the id of the sql
+		  method. The <tt>Title</tt> field allows you to specify the title of
+		  the sql method. The <tt>Connection id</tt> select list specifies the
+		  database connection on which the sql method operates. The
+		  <tt>Arguments</tt> field allows you to specify a list of arguments
+		  that the sql method takes. The arguments should be separated by spaces in the
+		  field. The <tt>Query template</tt> text area specifies the SQL query
+		  that the sql method will execute. The query template can contain DTML markup to
+		  tailor the SQL statement to the arguments. Note: the SQL statement need not be
+		  a SELECT query, it may be any valid SQL statement including an INSERT or
+		  UPDATE. </p>
+<dtml-var standard_html_footer>
--- a/lib/python/Products/ZSQLMethods/help/Z-SQL-Method_Advanced.dtml
+++ b/lib/python/Products/ZSQLMethods/help/Z-SQL-Method_Advanced.dtml
+<dtml-var standard_html_header>
+<h1>
+<a href="../Z-SQL-Method.dtml">Z SQL Method</a>&gt;Advanced</h1>
+<p> This view allows you to manage the advanced settings of a sql
+		  method. </p>
+<p> The <tt>ID</tt> and <tt>Title</tt> fields
+		  indicate the id and title of the sql method. The <tt>Maximum number of
+		  rows retrieved</tt> field allows you to specify an upper limit for the
+		  number of rows a sql method can retrieve. The <tt>Maximum number of
+		  results in the cache</tt> field allows you to set the size of the sql
+		  method cache. The <tt>Maximum time (seconds) to cache results</tt>
+		  field allows you to specify the how fresh the sql method cache must be. By
+		  setting this time to a number greater than zero you enable sql method caching.
+		  </p>
+<p> You can provide a Python class for adding behavior to returns
+		  rows. The results of the sql method will consist of a sequence of instances of
+		  the specified class. The <tt>Class name</tt> field allows you to
+		  specify the name of the Python class. The <tt>Class file</tt> field
+		  allows you to specify the name of the Python module that the class is defined
+		  in. The class file should reside in the Zope Extensions
+		  directory. </p>
+<dtml-var standard_html_footer>
--- a/lib/python/Products/ZSQLMethods/help/Z-SQL-Method_Edit.dtml
+++ b/lib/python/Products/ZSQLMethods/help/Z-SQL-Method_Edit.dtml
+<dtml-var standard_html_header>
+<h1>
+<a href="../Z-SQL-Method.dtml">Z SQL Method</a>&gt;Edit</h1>
+<p> This view allows you to edit the attributes of a sql method.
+		  </p>
+<p> The <tt>ID</tt> field indicates the id of the sql
+		  method. The <tt>Title</tt> field allows you to specify the title of
+		  the sql method. The <tt>Connection id</tt> select list specifies the
+		  database connection on which the sql method operates. The
+		  <tt>Arguments</tt> field allows you to specify a list of arguments
+		  that the sql method takes. The arguments should be separated by spaces in the
+		  field. The <tt>Query template</tt> text area specifies the SQL query
+		  that the sql method will execute. The query template can contain DTML markup to
+		  tailor the SQL statement to the arguments. Note: the SQL statement need not be
+		  a SELECT query, it may be any valid SQL statement including an INSERT or
+		  UPDATE. </p>
+<dtml-var standard_html_footer>
--- a/lib/python/Products/ZSQLMethods/help/Z-SQL-Method_Security.dtml
+++ b/lib/python/Products/ZSQLMethods/help/Z-SQL-Method_Security.dtml
+<dtml-var standard_html_header>
+<h1>
+<a href="../Z-SQL-Method.dtml">Z SQL Method</a>&gt;Security</h1>
+<p> See <a href="../Folder_Security.dtml">Folder&gt;Security</a>. </p>
+<dtml-var standard_html_footer>
--- a/lib/python/Products/ZSQLMethods/help/Z-SQL-Method_Test.dtml
+++ b/lib/python/Products/ZSQLMethods/help/Z-SQL-Method_Test.dtml
+<dtml-var standard_html_header>
+<h1>
+<a href="../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>