torben Thu May 17 20:23:13 2001 EDT
Modified files:
/phpdoc/en/functions hw.xml
Log:
Just lowercased the <function>hw_*</function> tags so that the stylesheet
can match them up with the function entries for crossreferencing.
Index: phpdoc/en/functions/hw.xml
diff -u phpdoc/en/functions/hw.xml:1.9 phpdoc/en/functions/hw.xml:1.10
--- phpdoc/en/functions/hw.xml:1.9 Sun Oct 1 18:07:31 2000
+++ phpdoc/en/functions/hw.xml Thu May 17 20:23:13 2001
@@ -349,8 +349,8 @@
There are still some things todo:
<itemizedlist>
<listitem><simpara>The hw_InsertDocument has to be split into
- <function>hw_InsertObject</function> and
- <function>hw_PutDocument</function>.</simpara></listitem>
+ <function>hw_insertobject</function> and
+ <function>hw_putdocument</function>.</simpara></listitem>
<listitem><simpara>The names of several functions are not fixed, yet.
</simpara></listitem>
<listitem><simpara>Most functions require the current connection
@@ -485,7 +485,7 @@
is not encrypted.
</para>
<para>
- See also <function>hw_pConnect</function>.
+ See also <function>hw_pconnect</function>.
</para>
</refsect1>
</refentry>
@@ -605,12 +605,12 @@
Returns the object record of the document.
</para>
<para>
- For backward compatibility, <function>hw_DocumentAttributes</function>
+ For backward compatibility, <function>hw_documentattributes</function>
is also accepted. This is deprecated, however.
</para>
<para>
- See also <function>hw_Document_BodyTag</function>,
- and <function>hw_Document_Size</function>.
+ See also <function>hw_document_bodytag</function>,
+ and <function>hw_document_size</function>.
</para>
</refsect1>
</refentry>
@@ -633,11 +633,11 @@
document the BODY tag should be printed before the document.
</para>
<para>
- See also <function>hw_Document_Attributes</function>,
- and <function>hw_Document_Size</function>.
+ See also <function>hw_document_attributes</function>,
+ and <function>hw_document_size</function>.
</para>
<para>
- For backward compatibility, <function>hw_DocumentBodyTag</function>
+ For backward compatibility, <function>hw_documentbodytag</function>
is also accepted. This is deprecated, however.
</para>
</refsect1>
@@ -662,9 +662,9 @@
from the HEAD and BODY tag is in the stored in the object record.
</para>
<para>
- See also <function>hw_Document_Attributes</function>,
- <function>hw_Document_Size</function>,
- and <function>hw_DocumentSetContent</function>.
+ See also <function>hw_document_attributes</function>,
+ <function>hw_document_size</function>,
+ and <function>hw_documentsetcontent</function>.
</para>
</refsect1>
</refentry>
@@ -693,9 +693,9 @@
If this functions fails the document will retain its old content.
</para>
<para>
- See also <function>hw_Document_Attributes</function>,
- <function>hw_Document_Size</function>,
- and <function>hw_Document_Content</function>.
+ See also <function>hw_document_attributes</function>,
+ <function>hw_document_size</function>,
+ and <function>hw_document_content</function>.
</para>
</refsect1>
</refentry>
@@ -716,11 +716,11 @@
<para>
Returns the size in bytes of the document.</para>
<para>
- See also <function>hw_Document_BodyTag</function>,
- and <function>hw_Document_Attributes</function>.
+ See also <function>hw_document_bodytag</function>,
+ and <function>hw_document_attributes</function>.
</para>
<para>
- For backward compatibility, <function>hw_DocumentSize</function>
+ For backward compatibility, <function>hw_documentsize</function>
is also accepted. This is deprecated, however.
</para>
</refsect1>
@@ -770,12 +770,12 @@
control connection during the transfer.
</para>
<para>
- See also <function>hw_PipeDocument</function>,
- <function>hw_FreeDocument</function>,
- <function>hw_Document_BodyTag</function>,
- <function>hw_Document_Size</function>,
- <function>hw_Output_Document</function>,
- <function>hw_GetText</function>.
+ See also <function>hw_pipedocument</function>,
+ <function>hw_freedocument</function>,
+ <function>hw_document_bodytag</function>,
+ <function>hw_document_size</function>,
+ <function>hw_output_document</function>,
+ <function>hw_gettext</function>.
</para>
</refsect1>
</refentry>
@@ -883,8 +883,8 @@
<parameter>objectID</parameter>. The function will not
return child documents.</para>
<para>
- See also <function>hw_GetChildren</function>,
- and <function>hw_GetChildDocColl</function>.
+ See also <function>hw_getchildren</function>,
+ and <function>hw_getchilddoccoll</function>.
</para>
</refsect1>
</refentry>
@@ -910,8 +910,8 @@
child documents.
</para>
<para>
- See also <function>hw_ChildrenObj</function>,
- and <function>hw_GetChildDocCollObj</function>.
+ See also <function>hw_childrenobj</function>,
+ and <function>hw_getchilddoccollobj</function>.
</para>
</refsect1>
</refentry>
@@ -938,14 +938,14 @@
throught remote documents Hyperwave introduces the HGI (Hyperwave
Gateway Interface) which is similar to the CGI. Currently, only
ftp, http-servers and some databases can be accessed by the HGI.
- Calling <function>hw_GetRemote</function> returns the document from
+ Calling <function>hw_getremote</function> returns the document from
the external source. If you want to use this function you should be
very familiar with HGIs. You should also consider to use PHP instead
of Hyperwave to access external sources. Adding database support
by a Hyperwave gateway should be more difficult than doing it in PHP.
</para>
<para>
- See also <function>hw_GetRemoteChildren</function>.
+ See also <function>hw_getremotechildren</function>.
</para>
</refsect1>
</refentry>
@@ -974,7 +974,7 @@
Gateway Interface (HGI). If the number of children
is greater than 1 it will return an array of object record with
each maybe the input value for another call to
- <function>hw_GetRemoteChildren</function>. Those object records are
+ <function>hw_getremotechildren</function>. Those object records are
virtual and do not exist in the Hyperwave server, therefore they
do not have a valid object ID. How exactely such an object record
looks like is up to the HGI.
@@ -985,7 +985,7 @@
difficult than doing it in PHP.
</para>
<para>
- See also <function>hw_GetRemote</function>.
+ See also <function>hw_getremote</function>.
</para>
</refsect1>
</refentry>
@@ -1009,7 +1009,7 @@
<parameter>objectID</parameter>. The object can either be a document
or an anchor of type destination.</para>
<para>
- See also <function>hw_GetAnchors</function>.
+ See also <function>hw_getanchors</function>.
</para>
</refsect1>
</refentry>
@@ -1059,8 +1059,8 @@
the object is allowed.
</para>
<para>
- See also <function>hw_GetAndLock</function>,
- and <function>hw_GetObjectByQuery</function>.
+ See also <function>hw_getandlock</function>,
+ and <function>hw_getobjectbyquery</function>.
</para>
</refsect1>
</refentry>
@@ -1086,8 +1086,8 @@
it until it is unlocked.
</para>
<para>
- See also <function>hw_Unlock</function>,
- and <function>hw_GetObject</function>.
+ See also <function>hw_unlock</function>,
+ and <function>hw_getobject</function>.
</para>
</refsect1>
</refentry>
@@ -1151,11 +1151,11 @@
control connection during the transfer.
</para>
<para>
- See also <function>hw_PipeDocument</function>,
- <function>hw_FreeDocument</function>,
- <function>hw_Document_BodyTag</function>,
- <function>hw_Document_Size</function>,
- and <function>hw_Output_Document</function>.
+ See also <function>hw_pipedocument</function>,
+ <function>hw_freedocument</function>,
+ <function>hw_document_bodytag</function>,
+ <function>hw_document_size</function>,
+ and <function>hw_output_document</function>.
</para>
</refsect1>
</refentry>
@@ -1185,7 +1185,7 @@
The query will only work with indexed attributes.
</para>
<para>
- See also <function>hw_GetObjectByQueryObj</function>.
+ See also <function>hw_getobjectbyqueryobj</function>.
</para>
</refsect1>
</refentry>
@@ -1215,7 +1215,7 @@
The query will only work with indexed attributes.
</para>
<para>
- See also <function>hw_GetObjectByQuery</function>.
+ See also <function>hw_getobjectbyquery</function>.
</para>
</refsect1>
</refentry>
@@ -1247,7 +1247,7 @@
<para>
The query will only work with indexed attributes.</para>
<para>
- See also <function>hw_GetObjectByQueryCollObj</function>.
+ See also <function>hw_getobjectbyquerycollobj</function>.
</para>
</refsect1>
</refentry>
@@ -1280,7 +1280,7 @@
The query will only work with indexed attributes.
</para>
<para>
- See also <function>hw_GetObjectByQueryColl</function>.
+ See also <function>hw_getobjectbyquerycoll</function>.
</para>
</refsect1>
</refentry>
@@ -1303,8 +1303,8 @@
Returns array of object ids for child documents of a collection.
</para>
<para>
- See also <function>hw_GetChildren</function>,
- and <function>hw_GetChildColl</function>.
+ See also <function>hw_getchildren</function>,
+ and <function>hw_getchildcoll</function>.
</para>
</refsect1>
</refentry>
@@ -1326,8 +1326,8 @@
<para>
Returns an array of object records for child documents of a collection.</para>
<para>
- See also <function>hw_ChildrenObj</function>,
- and <function>hw_GetChildCollObj</function>.
+ See also <function>hw_childrenobj</function>,
+ and <function>hw_getchildcollobj</function>.
</para>
</refsect1>
</refentry>
@@ -1431,7 +1431,7 @@
be easier to identify with the opening of the connection.
</para>
<para>
- See also <function>hw_Connect</function>.
+ See also <function>hw_connect</function>.
</para>
</refsect1>
</refentry>
@@ -1540,8 +1540,8 @@
<function>hw_insertdocument</function> instead.
</para>
<para>
- See also <function>hw_InsertDocument</function>,
- and <function>hw_InsColl</function>.
+ See also <function>hw_insertdocument</function>,
+ and <function>hw_inscoll</function>.
</para>
</refsect1>
</refentry>
@@ -1565,14 +1565,14 @@
Uploads a document into the collection with
<parameter>parent_id</parameter>.
The document has to be created before with
- <function>hw_NewDocument</function>. Make sure that
+ <function>hw_new_document</function>. Make sure that
the object record of the new document contains at least
the attributes: Type, DocumentType, Title and Name. Possibly
you also want to set the MimeType. The functions returns the
object id of the new document or false.
</para>
<para>
- See also <function>hw_PipeDocument</function>.
+ See also <function>hw_pipedocument</function>.
</para>
</refsect1>
</refentry>
@@ -1604,10 +1604,10 @@
has no correspondig link in the annotation text.
</para>
<para>
- See also <function>hw_PipeDocument</function>,
- <function>hw_InsertDocument</function>,
- <function>hw_InsDoc</function>,
- and <function>hw_InsColl</function>.
+ See also <function>hw_pipedocument</function>,
+ <function>hw_insertdocument</function>,
+ <function>hw_insdoc</function>,
+ and <function>hw_inscoll</function>.
</para>
</refsect1>
</refentry>
@@ -1831,11 +1831,11 @@
insert the document into the Hyperwave server.
</para>
<para>
- See also <function>hw_FreeDocument</function>,
- <function>hw_Document_Size</function>,
- <function>hw_Document_BodyTag</function>,
- <function>hw_Output_Document</function>,
- and <function>hw_InsertDocument</function>.
+ See also <function>hw_freedocument</function>,
+ <function>hw_document_size</function>,
+ <function>hw_document_bodytag</function>,
+ <function>hw_output_document</function>,
+ and <function>hw_insertdocument</function>.
</para>
</refsect1>
</refentry>
@@ -1897,7 +1897,7 @@
Prints the document without the BODY tag.
</para>
<para>
- For backward compatibility, <function>hw_OutputDocument</function> is
+ For backward compatibility, <function>hw_outputdocument</function> is
also accepted. This is deprecated, however.
</para>
</refsect1>
@@ -1931,7 +1931,7 @@
index that is needed by other Hyperwave functions. You can have
multiple persistent connections open at once.</para>
<para>
- See also <function>hw_Connect</function>.
+ See also <function>hw_connect</function>.
</para>
</refsect1>
</refentry>
@@ -1957,11 +1957,11 @@
The document will be transfered via a special data connection which
does not block the control connection.</para>
<para>
- See also <function>hw_GetText</function> for more on link insertion,
- <function>hw_FreeDocument</function>,
- <function>hw_Document_Size</function>,
- <function>hw_Document_BodyTag</function>,
- and <function>hw_Output_Document</function>.
+ See also <function>hw_gettext</function> for more on link insertion,
+ <function>hw_freedocument</function>,
+ <function>hw_document_size</function>,
+ <function>hw_document_bodytag</function>,
+ and <function>hw_output_document</function>.
</para>
</refsect1>
</refentry>
@@ -2005,7 +2005,7 @@
Unlocks a document, so other users regain access.
</para>
<para>
- See also <function>hw_GetAndLock</function>.
+ See also <function>hw_getandlock</function>.
</para>
</refsect1>
</refentry>
