 |
 |
 |
 |
|
|
Date: 10/01/00
- Next message: Ron Chmara: "[PHP-DOC] cvs: phpdoc /en/chapters security.xml"
- Previous message: Ron Chmara: "[PHP-DOC] cvs: phpdoc /en/functions curl.xml"
- Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]
ronabop Sun Oct 1 18:07:31 2000 EDT
Modified files:
/phpdoc/en/functions hw.xml
Log:
Depreciated usage of functions, misnamed functions, some nesting and indentation.
Index: phpdoc/en/functions/hw.xml
diff -u phpdoc/en/functions/hw.xml:1.8 phpdoc/en/functions/hw.xml:1.9
--- phpdoc/en/functions/hw.xml:1.8 Fri Sep 29 19:01:26 2000
+++ phpdoc/en/functions/hw.xml Sun Oct 1 18:07:31 2000
@@ -9,11 +9,13 @@
<para>
<productname>Hyperwave</productname> has been developed at <ulink url="&url.iicm;">IICM</ulink> in Graz. It started with
the name <acronym>Hyper-G</acronym> and changed to Hyperwave when
- it was commercialised (If I remember properly it was in 1996).</para>
+ it was commercialised (If I remember properly it was in 1996).
+ </para>
<para>
Hyperwave is not free software. The current version, 4.1, is
available at <ulink url="&url.hyperwave;">www.hyperwave.com</ulink>.
- A time limited version can be ordered for free (30 days).</para>
+ A time limited version can be ordered for free (30 days).
+ </para>
<para>
Hyperwave is an information system similar to a database
(<acronym>HIS</acronym>, Hyperwave Information Server). Its focus
@@ -33,7 +35,8 @@
e.g. 'en:Title in English' or 'ge:Titel in deutsch'. Other attributes
like a description or keywords are potential candidates. You may
also replace the language abbreviation by any other string as long
- as it separated by colon from the rest of the attribute value.</para>
+ as it separated by colon from the rest of the attribute value.
+ </para>
<para>
Each object record has native a string representation with each
name/value
@@ -44,7 +47,8 @@
abbreviation. Actually any multiple attribute forms an associated
array with the string left to the colon in the attribute value
being the key. (This is not fully implemented. Only the attributes
- Title, Description and Keyword are treated properly yet.)</para>
+ Title, Description and Keyword are treated properly yet.)
+ </para>
<para>
Besides the documents, all hyper links contained in a document
are stored as object records as well. Hyper links which
@@ -61,7 +65,8 @@
is pointing to changes its name, the link can easily be modified
accordingly. The document containing the link is not affected
at all. You may even add a link to a document without modifying
- the document itself.</para>
+ the document itself.
+ </para>
<para>
Saying that <function>hw_pipedocument</function> and
<function>hw_gettext</function> do the link insertion automatically
@@ -86,7 +91,8 @@
An object with name 'parent/my_object' could be the child of
'my_object' in the Hyperwave hierarchy, though in a web namespace it
appears to be just the opposite and the user might get confused.
- This can only be prevented by selecting reasonable object names.</para>
+ This can only be prevented by selecting reasonable object names.
+ </para>
<para>
Having made this decision a second problem arises. How do you
involve PHP? The URL http://host/my_object will not call any
@@ -99,9 +105,11 @@
searching in the Hyperwave server would be impossible. Therefore
you will need at least a second rewriting rule to exclude certain
URLS like all e.g. starting with http://host/Hyperwave. This is
- basically sharing of a namespace by the web and Hyperwave server.</para>
+ basically sharing of a namespace by the web and Hyperwave server.
+ </para>
<para>
- Based on the above mechanism links are insert into documents.</para>
+ Based on the above mechanism links are insert into documents.
+ </para>
<para>
It gets more complicated if PHP is not run as a server module or CGI
script but as a standalone application e.g. to dump the content of
@@ -109,7 +117,8 @@
retain the Hyperwave hierarchy and map in onto the file system. This
conflicts with the object names if they reflect its own hierarchy
(e.g. by choosing names including '/'). Therefore '/' has to be
- replaced by another character, e.g. '_'. to be continued.</para>
+ replaced by another character, e.g. '_'. to be continued.
+ </para>
<para>
The network protocol to communicate
with the Hyperwave server is called <ulink url="&spec.hyperwave;">HG-CSP</ulink>
@@ -127,36 +136,41 @@
<abbrev>PLACE</abbrev> lacks a lot of features of a real programming
language and any extension to it only enlarges the list of
placeholders. This has led to the use of JavaScript which IMO does
- not make life easier.</para>
-
+ not make life easier.
+ </para>
<para>
Adding Hyperwave support to PHP should fill in the gap of a
missing programming language for interface customisation. It
implements all the messages as defined by the
<abbrev>HG-CSP</abbrev> but also provides more powerful commands
- to e.g. retrieve complete documents.</para>
-
+ to e.g. retrieve complete documents.
+ </para>
<para>
Hyperwave has its own terminology to name certain pieces of
information. This has widely been taken over and extended.
Almost all functions operate on one of the following data types.
<itemizedlist>
- <listitem><simpara>
+ <listitem>
+ <simpara>
object ID: An unique integer value for each object in the
Hyperwave server. It is also one of the attributes of the
object record (ObjectID). Object ids are often used as an
input parameter to specify an object.
- </simpara></listitem>
- <listitem><simpara>
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
object record: A string with attribute-value pairs of the form
attribute=value. The pairs are separated by a carriage return
from each other. An object record can easily be converted into
an object array with <function>hw_object2array</function>.
Several functions return object records. The names of those
functions end with obj.
- </simpara></listitem>
- <listitem><simpara>
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
object array: An associated array with all attributes of an
object. The key is the attribute name. If an attribute occurs
more than once in an object record it will result in another
@@ -165,14 +179,17 @@
associated array with the key set to the language
abbreviation. All other multiple attributes will form an
indexed array. PHP functions never return object arrays.
- </simpara></listitem>
- <listitem><simpara>
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
hw_document: This is a complete new data type which holds the
actual document, e.g. HTML, PDF etc. It is somewhat optimised
for HTML documents but may be used for any format.
- </simpara></listitem>
- </itemizedlist></para>
-
+ </simpara>
+ </listitem>
+ </itemizedlist>
+ </para>
<para>
Several functions which return an array of object records do also
return an associated array with statistical information about
@@ -181,40 +198,59 @@
<variablelist>
<varlistentry>
<term>Hidden</term>
- <listitem><simpara>
+ <listitem>
+ <simpara>
Number of object records with attribute PresentationHints
- set to Hidden.</simpara></listitem>
+ set to Hidden.
+ </simpara>
+ </listitem>
</varlistentry>
<varlistentry>
<term>CollectionHead</term>
- <listitem><simpara>
+ <listitem>
+ <simpara>
Number of object records with attribute
- PresentationHints set to CollectionHead.</simpara></listitem>
+ PresentationHints set to CollectionHead.
+ </simpara>
+ </listitem>
</varlistentry>
<varlistentry>
<term>FullCollectionHead</term>
- <listitem><simpara>
+ <listitem>
+ <simpara>
Number of object records with attribute
- PresentationHints set to FullCollectionHead.</simpara></listitem>
+ PresentationHints set to FullCollectionHead.
+ </simpara>
+ </listitem>
</varlistentry>
<varlistentry>
<term>CollectionHeadNr</term>
- <listitem><simpara>
+ <listitem>
+ <simpara>
Index in array of object records with
- attribute PresentationHints set to CollectionHead.</simpara></listitem>
+ attribute PresentationHints set to CollectionHead.
+ </simpara>
+ </listitem>
</varlistentry>
<varlistentry>
<term>FullCollectionHeadNr</term>
- <listitem><simpara>
+ <listitem>
+ <simpara>
Index in array of object records with
- attribute PresentationHints set to FullCollectionHead.</simpara></listitem>
+ attribute PresentationHints set to FullCollectionHead.
+ </simpara>
+ </listitem>
</varlistentry>
<varlistentry>
<term>Total</term>
- <listitem><simpara>
- Total: Number of object records.</simpara></listitem>
+ <listitem>
+ <simpara>
+ Total: Number of object records.
+ </simpara>
+ </listitem>
</varlistentry>
- </variablelist></para>
+ </variablelist>
+ </para>
</sect1>
<sect1 id="hw-apache">
@@ -223,8 +259,8 @@
The Hyperwave extension is best used when PHP is compiled as an
Apache module. In such a case the underlying Hyperwave server can
be hidden from users almost completely if Apache uses its rewriting
- engine. The following instructions will explain this.</para>
-
+ engine. The following instructions will explain this.
+ </para>
<para>
Since PHP with Hyperwave support built into Apache is intended
to replace the native Hyperwave solution based on Wavemaster I
@@ -233,14 +269,16 @@
configuration. The concept is quite simple. First of all you
need a PHP script which evaluates the <envar>PATH_INFO</envar>
variable and treats its value as the name of a Hyperwave
- object. Let's call this script 'Hyperwave'. The URL <systemitem role="url">http://your.hostname/Hyperwave/name_of_object>
+ object. Let's call this script 'Hyperwave'. The URL
+ <systemitem role="url">http://your.hostname/Hyperwave/name_of_object>
would than return the Hyperwave object with the name
'name_of_object'. Depending on the type of the object the script
has to react accordingly. If it is a collection, it will probably
return a list of children. If it is a document it will return the
mime type and the content. A slight improvement can be achieved
if the Apache rewriting engine is used. From the users point of
- view it would be more straight forward if the URL <systemitem role="url">http://your.hostname/name_of_object> would
+ view it would be more straight forward if the URL
+ <systemitem role="url">http://your.hostname/name_of_object> would
return the object. The rewriting rule is quite easy:
<informalexample><programlisting role="apache-conf">
@@ -274,19 +312,35 @@
scripts:
<itemizedlist>
- <listitem><simpara>
- to return the object itself</simpara></listitem>
- <listitem><simpara>
- to allow searching</simpara></listitem>
- <listitem><simpara>
- to identify yourself</simpara></listitem>
- <listitem><simpara>
- to set your profile</simpara></listitem>
- <listitem><simpara>
+ <listitem>
+ <simpara>
+ to return the object itself
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ to allow searching
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ to identify yourself
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ to set your profile
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
one for each additional function like to show
the object attributes, to show information about users,
- to show the status of the server, etc.</simpara></listitem>
- </itemizedlist></para>
+ to show the status of the server, etc.
+ </simpara>
+ </listitem>
+ </itemizedlist>
+ </para>
</sect1>
<sect1 id="hw-todo">
@@ -307,7 +361,8 @@
<listitem><simpara>Conversion form object record into object array
needs to handle any multiple attribute.
</simpara></listitem>
- </itemizedlist></para>
+ </itemizedlist>
+ </para>
</sect1>
</partintro>
@@ -327,9 +382,11 @@
<para>
Converts an <parameter>object_array</parameter> into an object record.
Multiple attributes like 'Title' in different languages are treated
- properly.</para>
+ properly.
+ </para>
<para>
- See also <function>hw_objrec2array</function>.</para>
+ See also <function>hw_objrec2array</function>.
+ </para>
</refsect1>
</refentry>
@@ -393,7 +450,8 @@
<para>
Returns false if connection is not a valid connection index,
otherwise true. Closes down the connection to a Hyperwave server
- with the given connection index.</para>
+ with the given connection index.
+ </para>
</refsect1>
</refentry>
@@ -424,9 +482,11 @@
This function returns a connection
index that is needed by other Hyperwave functions. You can have
multiple connections open at once. Keep in mind, that the password
- is not encrypted.</para>
+ is not encrypted.
+ </para>
<para>
- See also <function>hw_pConnect</function>.</para>
+ See also <function>hw_pConnect</function>.
+ </para>
</refsect1>
</refentry>
@@ -448,11 +508,14 @@
<para>
Copies the objects with object ids as specified in the second
parameter to the collection
- with the id <parameter>destination id</parameter>.</para>
+ with the id <parameter>destination id</parameter>.
+ </para>
<para>
- The value return is the number of copied objects.</para>
+ The value return is the number of copied objects.
+ </para>
<para>
- See also <function>hw_mv</function>.</para>
+ See also <function>hw_mv</function>.
+ </para>
</refsect1>
</refentry>
@@ -472,11 +535,14 @@
</funcsynopsis>
<para>
Deletes the object with the given object id in the second
- parameter. It will delete all instances of the object.</para>
+ parameter. It will delete all instances of the object.
+ </para>
<para>
- Returns TRUE if no error occurs otherwise FALSE.</para>
+ Returns TRUE if no error occurs otherwise FALSE.
+ </para>
<para>
- See also <function>hw_mv</function>.</para>
+ See also <function>hw_mv</function>.
+ </para>
</refsect1>
</refentry>
@@ -496,7 +562,8 @@
</funcsynopsis>
<para>
Returns an th object id of the document to
- which <parameter>anchorID</parameter> belongs.</para>
+ which <parameter>anchorID</parameter> belongs.
+ </para>
</refsect1>
</refentry>
@@ -516,87 +583,102 @@
</funcsynopsis>
<para>
Returns an th object record of the document to
- which <parameter>anchorID</parameter> belongs.</para>
+ which <parameter>anchorID</parameter> belongs.
+ </para>
</refsect1>
</refentry>
- <refentry id="function.hw-documentattributes">
+ <refentry id="function.hw-document-attributes">
<refnamediv>
- <refname>hw_DocumentAttributes</refname>
+ <refname>hw_Document_Attributes</refname>
<refpurpose>object record of hw_document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
- <funcdef>string <function>hw_documentattributes</function></funcdef>
+ <funcdef>string <function>hw_document_attributes</function></funcdef>
<paramdef>int <parameter>hw_document</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- Returns the object record of the document.</para>
+ Returns the object record of the document.
+ </para>
<para>
- See also <function>hw_DocumentBodyTag</function>,
- <function>hw_DocumentSize</function>.</para>
+ 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>.
+ </para>
</refsect1>
</refentry>
- <refentry id="function.hw-documentbodytag">
+ <refentry id="function.hw-document-bodytag">
<refnamediv>
- <refname>hw_DocumentBodyTag</refname>
+ <refname>hw_Document_BodyTag</refname>
<refpurpose>body tag of hw_document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
- <funcdef>string <function>hw_documentbodytag</function></funcdef>
+ <funcdef>string <function>hw_document_bodytag</function></funcdef>
<paramdef>int <parameter>hw_document</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
Returns the BODY tag of the document. If the document is an HTML
- document the BODY tag should be printed before the document.</para>
+ document the BODY tag should be printed before the document.
+ </para>
<para>
- See also <function>hw_DocumentAttributes</function>,
- <function>hw_DocumentSize</function>.</para>
+ See also <function>hw_Document_Attributes</function>,
+ and <function>hw_Document_Size</function>.
+ </para>
+ <para>
+ For backward compatibility, <function>hw_DocumentBodyTag</function>
+ is also accepted. This is deprecated, however.
+ </para>
</refsect1>
</refentry>
- <refentry id="function.hw-documentcontent">
+ <refentry id="function.hw-document-content">
<refnamediv>
- <refname>hw_DocumentContent</refname>
+ <refname>hw_Document_Content</refname>
<refpurpose>returns content of hw_document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
- <funcdef>string <function>hw_documentcontent</function></funcdef>
+ <funcdef>string <function>hw_document_content</function></funcdef>
<paramdef>int <parameter>hw_document</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
Returns the content of the document. If the document is an HTML
document the content is everything after the BODY tag. Information
- from the HEAD and BODY tag is in the stored in the object record.</para>
+ from the HEAD and BODY tag is in the stored in the object record.
+ </para>
<para>
- See also <function>hw_DocumentAttributes</function>,
- <function>hw_DocumentSize</function>,
- <function>hw_DocumentSetContent</function>.</para>
+ See also <function>hw_Document_Attributes</function>,
+ <function>hw_Document_Size</function>,
+ and <function>hw_DocumentSetContent</function>.
+ </para>
</refsect1>
</refentry>
- <refentry id="function.hw-documentsetcontent">
+ <refentry id="function.hw-document-setcontent">
<refnamediv>
- <refname>hw_DocumentSetContent</refname>
+ <refname>hw_Document_SetContent</refname>
<refpurpose>sets/replaces content of hw_document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
- <funcdef>string <function>hw_documentsetcontent</function></funcdef>
+ <funcdef>string <function>hw_document_setcontent</function></funcdef>
<paramdef>int <parameter>hw_document</parameter></paramdef>
<paramdef>string <parameter>content</parameter></paramdef>
</funcprototype>
@@ -608,32 +690,39 @@
If you provide this information in the content of the document too,
the Hyperwave server will change the object record accordingly when
the document is inserted. Probably not a very good idea.
- If this functions fails the document will retain its old content.</para>
+ If this functions fails the document will retain its old content.
+ </para>
<para>
- See also <function>hw_DocumentAttributes</function>,
- <function>hw_DocumentSize</function>,
- <function>hw_DocumentContent</function>.</para>
+ See also <function>hw_Document_Attributes</function>,
+ <function>hw_Document_Size</function>,
+ and <function>hw_Document_Content</function>.
+ </para>
</refsect1>
</refentry>
- <refentry id="function.hw-documentsize">
+ <refentry id="function.hw-document-size">
<refnamediv>
- <refname>hw_DocumentSize</refname>
+ <refname>hw_Document_Size</refname>
<refpurpose>size of hw_document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function>hw_documentsize</function></funcdef>
+ <funcdef>int <function>hw_document_size</function></funcdef>
<paramdef>int <parameter>hw_document</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
Returns the size in bytes of the document.</para>
+ <para>
+ See also <function>hw_Document_BodyTag</function>,
+ and <function>hw_Document_Attributes</function>.
+ </para>
<para>
- See also <function>hw_DocumentBodyTag</function>,
- <function>hw_DocumentAttributes</function>.</para>
+ For backward compatibility, <function>hw_DocumentSize</function>
+ is also accepted. This is deprecated, however.
+ </para>
</refsect1>
</refentry>
@@ -653,7 +742,8 @@
<para>
Returns a string containing the last error message or 'No Error'. If false
is returned, this function failed.
- The message relates to the last command.</para>
+ The message relates to the last command.
+ </para>
</refsect1>
</refentry>
@@ -677,14 +767,16 @@
is edited.
This function will only works for pure text documents. It will
not open a special data connection and therefore blocks the
- control connection during the transfer.</para>
+ control connection during the transfer.
+ </para>
<para>
See also <function>hw_PipeDocument</function>,
- <function>hw_FreeDocument</function>,
- <function>hw_DocumentBodyTag</function>,
- <function>hw_DocumentSize</function>,
- <function>hw_OutputDocument</function>,
- <function>hw_GetText</function>.</para>
+ <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>
@@ -703,7 +795,8 @@
</funcsynopsis>
<para>
Returns the last error number. If the return value is 0 no error has
- occurred. The error relates to the last command.</para>
+ occurred. The error relates to the last command.
+ </para>
</refsect1>
</refentry>
@@ -721,7 +814,8 @@
</funcprototype>
</funcsynopsis>
<para>
- Frees the memory occupied by the Hyperwave document.</para>
+ Frees the memory occupied by the Hyperwave document.
+ </para>
</refsect1>
</refentry>
@@ -741,7 +835,8 @@
</funcsynopsis>
<para>
Returns an indexed array of object ids. Each object id belongs to
- a parent of the object with ID <parameter>objectID</parameter>.</para>
+ a parent of the object with ID <parameter>objectID</parameter>.
+ </para>
</refsect1>
</refentry>
@@ -763,7 +858,8 @@
Returns an indexed array of object records plus an associated array with statistical
information about the object records. The associated array is the
last entry of the returned array. Each object record belongs to
- a parent of the object with ID <parameter>objectID</parameter>.</para>
+ a parent of the object with ID <parameter>objectID</parameter>.
+ </para>
</refsect1>
</refentry>
@@ -788,7 +884,8 @@
return child documents.</para>
<para>
See also <function>hw_GetChildren</function>,
- <function>hw_GetChildDocColl</function>.</para>
+ and <function>hw_GetChildDocColl</function>.
+ </para>
</refsect1>
</refentry>
@@ -810,10 +907,12 @@
Returns an array of object records. Each object records
belongs to a child collection of the collection with ID
<parameter>objectID</parameter>. The function will not return
- child documents.</para>
+ child documents.
+ </para>
<para>
See also <function>hw_ChildrenObj</function>,
- <function>hw_GetChildDocCollObj</function>.</para>
+ and <function>hw_GetChildDocCollObj</function>.
+ </para>
</refsect1>
</refentry>
@@ -843,9 +942,11 @@
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>
+ by a Hyperwave gateway should be more difficult than doing it in PHP.
+ </para>
<para>
- See also <function>hw_GetRemoteChildren</function>.</para>
+ See also <function>hw_GetRemoteChildren</function>.
+ </para>
</refsect1>
</refentry>
@@ -881,9 +982,11 @@
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>
+ difficult than doing it in PHP.
+ </para>
<para>
- See also <function>hw_GetRemote</function>.</para>
+ See also <function>hw_GetRemote</function>.
+ </para>
</refsect1>
</refentry>
@@ -906,7 +1009,8 @@
<parameter>objectID</parameter>. The object can either be a document
or an anchor of type destination.</para>
<para>
- See also <function>hw_GetAnchors</function>.</para>
+ See also <function>hw_GetAnchors</function>.
+ </para>
</refsect1>
</refentry>
@@ -930,7 +1034,8 @@
<parameter>objectID</parameter> if the second parameter is an integer.
If the second parameter is an array of integer the function will
return an array of object records. In such a case the last
- parameter is also evaluated which is a query string.</para>
+ parameter is also evaluated which is a query string.
+ </para>
<para>
The query string has the following syntax:</para>
<simpara>
@@ -951,10 +1056,12 @@
of given objects. Unlike the other
query functions, this query may use not indexed attributes. How many
object records are returned depends on the query and if access to
- the object is allowed.</para>
+ the object is allowed.
+ </para>
<para>
See also <function>hw_GetAndLock</function>,
- <function>hw_GetObjectByQuery</function>.</para>
+ and <function>hw_GetObjectByQuery</function>.
+ </para>
</refsect1>
</refentry>
@@ -976,10 +1083,12 @@
Returns the object record for the object with ID
<parameter>objectID</parameter>.
It will also lock the object, so other users cannot access
- it until it is unlocked.</para>
+ it until it is unlocked.
+ </para>
<para>
See also <function>hw_Unlock</function>,
- <function>hw_GetObject</function>.</para>
+ and <function>hw_GetObject</function>.
+ </para>
</refsect1>
</refentry>
@@ -1021,7 +1130,8 @@
All links will have the prefix '/my_script.php3/'. If you do not
want this you can set the optional parameter
<parameter>rootID/prefix</parameter> to any prefix which
- is used instead. Is this case it has to be a string.</para>
+ is used instead. Is this case it has to be a string.
+ </para>
<para>
If <parameter>rootID/prefix</parameter> is an integer and
unequal to 0 the link is constructed from all the names
@@ -1033,17 +1143,20 @@
located at 'a-b-d-source' the resulting HTML link would be:
<A HREF="../c/internet_movie">. This is useful if you want
to download the whole server content onto disk and map
- the document hierachy onto the file system.</para>
+ the document hierachy onto the file system.
+ </para>
<para>
This function will only work for pure text documents. It will
not open a special data connection and therefore blocks the
- control connection during the transfer.</para>
+ control connection during the transfer.
+ </para>
<para>
See also <function>hw_PipeDocument</function>,
- <function>hw_FreeDocument</function>,
- <function>hw_DocumentBodyTag</function>,
- <function>hw_DocumentSize</function>,
- <function>hw_OutputDocument</function>.</para>
+ <function>hw_FreeDocument</function>,
+ <function>hw_Document_BodyTag</function>,
+ <function>hw_Document_Size</function>,
+ and <function>hw_Output_Document</function>.
+ </para>
</refsect1>
</refentry>
@@ -1066,11 +1179,14 @@
Searches for objects on the whole server and returns an array of
object ids. The maximum number of matches is limited to
<parameter>max_hits</parameter>. If <parameter>max_hits</parameter>
- is set to -1 the maximum number of matches is unlimited.</para>
+ is set to -1 the maximum number of matches is unlimited.
+ </para>
<para>
- The query will only work with indexed attributes.</para>
+ The query will only work with indexed attributes.
+ </para>
<para>
- See also <function>hw_GetObjectByQueryObj</function>.</para>
+ See also <function>hw_GetObjectByQueryObj</function>.
+ </para>
</refsect1>
</refentry>
@@ -1093,11 +1209,14 @@
Searches for objects on the whole server and returns an array of
object records. The maximum number of matches is limited to
<parameter>max_hits</parameter>. If <parameter>max_hits</parameter>
- is set to -1 the maximum number of matches is unlimited.</para>
+ is set to -1 the maximum number of matches is unlimited.
+ </para>
<para>
- The query will only work with indexed attributes.</para>
+ The query will only work with indexed attributes.
+ </para>
<para>
- See also <function>hw_GetObjectByQuery</function>.</para>
+ See also <function>hw_GetObjectByQuery</function>.
+ </para>
</refsect1>
</refentry>
@@ -1123,11 +1242,13 @@
object ids. The maximum number of matches is limited to
<parameter>max_hits</parameter>.
If <parameter>max_hits</parameter>
- is set to -1 the maximum number of matches is unlimited.</para>
+ is set to -1 the maximum number of matches is unlimited.
+ </para>
<para>
The query will only work with indexed attributes.</para>
<para>
- See also <function>hw_GetObjectByQueryCollObj</function>.</para>
+ See also <function>hw_GetObjectByQueryCollObj</function>.
+ </para>
</refsect1>
</refentry>
@@ -1153,11 +1274,14 @@
object records. The maximum number of matches is limited to
<parameter>max_hits</parameter>.
If <parameter>max_hits</parameter>
- is set to -1 the maximum number of matches is unlimited.</para>
+ is set to -1 the maximum number of matches is unlimited.
+ </para>
<para>
- The query will only work with indexed attributes.</para>
+ The query will only work with indexed attributes.
+ </para>
<para>
- See also <function>hw_GetObjectByQueryColl</function>.</para>
+ See also <function>hw_GetObjectByQueryColl</function>.
+ </para>
</refsect1>
</refentry>
@@ -1176,10 +1300,12 @@
</funcprototype>
</funcsynopsis>
<para>
- Returns array of object ids for child documents of a collection.</para>
+ Returns array of object ids for child documents of a collection.
+ </para>
<para>
See also <function>hw_GetChildren</function>,
- <function>hw_GetChildColl</function>.</para>
+ and <function>hw_GetChildColl</function>.
+ </para>
</refsect1>
</refentry>
@@ -1201,7 +1327,8 @@
Returns an array of object records for child documents of a collection.</para>
<para>
See also <function>hw_ChildrenObj</function>,
- <function>hw_GetChildCollObj</function>.</para>
+ and <function>hw_GetChildCollObj</function>.
+ </para>
</refsect1>
</refentry>
@@ -1221,7 +1348,8 @@
</funcsynopsis>
<para>
Returns an array of object ids with anchors of the document
- with object ID <parameter>objectID</parameter>.</para>
+ with object ID <parameter>objectID</parameter>.
+ </para>
</refsect1>
</refentry>
@@ -1241,7 +1369,8 @@
</funcsynopsis>
<para>
Returns an array of object records with anchors of the document
- with object ID <parameter>objectID</parameter>.</para>
+ with object ID <parameter>objectID</parameter>.
+ </para>
</refsect1>
</refentry>
@@ -1268,12 +1397,15 @@
If the destination id is 0 the objects will
be unlinked from the source collection. If this is the last instance
of that object it will be deleted. If you want to delete all instances
- at once, use <function>hw_deleteobject</function>.</para>
+ at once, use <function>hw_deleteobject</function>.
+ </para>
<para>
- The value return is the number of moved objects.</para>
+ The value return is the number of moved objects.
+ </para>
<para>
See also <function>hw_cp</function>,
- <function>hw_deleteobject</function>.</para>
+ and <function>hw_deleteobject</function>.
+ </para>
</refsect1>
</refentry>
@@ -1296,9 +1428,11 @@
<parameter>password</parameter>. Identification
is only valid for the current session. I do not thing this
function will be needed very often. In most cases it will
- be easier to identify with the opening of the connection.</para>
+ be easier to identify with the opening of the connection.
+ </para>
<para>
- See also <function>hw_Connect</function>.</para>
+ See also <function>hw_Connect</function>.
+ </para>
</refsect1>
</refentry>
@@ -1330,8 +1464,8 @@
set of collections that have one or more objects of this subset as
children are returned as an array. This option allows a client to,
e.g., highlight the part of the collection hierarchy that contains
- the matches of a previous query, in a graphical overview.</para>
- <para></para>
+ the matches of a previous query, in a graphical overview.
+ </para>
</refsect1>
</refentry>
@@ -1352,7 +1486,8 @@
Returns information about the current connection. The returned string
has the following format: <Serverstring>, <Host>,
<Port>, <Username>, <Port of Client>,
- <Byte swapping></para>
+ <Byte swapping>
+ </para>
</refsect1>
</refentry>
@@ -1374,7 +1509,8 @@
<para>
Inserts a new collection with attributes as in
<parameter>object_array</parameter> into
- collection with object ID <parameter>objectID</parameter>.</para>
+ collection with object ID <parameter>objectID</parameter>.
+ </para>
</refsect1>
</refentry>
@@ -1401,10 +1537,12 @@
an object record only or an object record and a pure ascii text in
<parameter>text</parameter> if <parameter>text</parameter> is given.
If you want to insert a general document of any kind use
- <function>hw_insertdocument</function> instead.</para>
+ <function>hw_insertdocument</function> instead.
+ </para>
<para>
See also <function>hw_InsertDocument</function>,
- <function>hw_InsColl</function>.</para>
+ and <function>hw_InsColl</function>.
+ </para>
</refsect1>
</refentry>
@@ -1431,9 +1569,11 @@
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>
+ object id of the new document or false.
+ </para>
<para>
- See also <function>hw_PipeDocument</function>.</para>
+ See also <function>hw_PipeDocument</function>.
+ </para>
</refsect1>
</refentry>
@@ -1455,17 +1595,20 @@
<para>
Inserts an object into the server. The object can be
any valid hyperwave object. See the HG-CSP documentation
- for a detailed information on how the parameters have to be.</para>
+ for a detailed information on how the parameters have to be.
+ </para>
<para>
Note: If you want to insert an Anchor, the attribute Position
has always been set either to a start/end value or to
'invisible'. Invisible positions are needed if the annotation
- has no correspondig link in the annotation text.</para>
+ has no correspondig link in the annotation text.
+ </para>
<para>
See also <function>hw_PipeDocument</function>,
- <function>hw_InsertDocument</function>,
- <function>hw_InsDoc</function>,
- <function>hw_InsColl</function>.</para>
+ <function>hw_InsertDocument</function>,
+ <function>hw_InsDoc</function>,
+ and <function>hw_InsColl</function>.
+ </para>
</refsect1>
</refentry>
@@ -1491,13 +1634,14 @@
used as any other object id, e.g. to obtain the object record
with <function>hw_getobject</function>. The server id is the
first part of the global object id (GOid) of the object which
- is actually the IP number as an integer.</para>
+ is actually the IP number as an integer.
+ </para>
<para>
Note: In order to use this function you will have to set
the F_DISTRIBUTED flag, which can currently only be set at
compile time in hg_comm.c. It is not set by default. Read
the comment at the beginning of hg_comm.c
- </para>
+ </para>
</refsect1>
</refentry>
@@ -1517,7 +1661,6 @@
<paramdef>array <parameter>remove</parameter></paramdef>
<paramdef>array <parameter>add</parameter></paramdef>
<paramdef>int <parameter>mode</parameter></paramdef>
-
</funcprototype>
</funcsynopsis>
<para>
@@ -1529,15 +1672,15 @@
to add. In order to modify an attribute one will have to remove
the old one and add a new one. <function>hw_modifyobject</function>
will always remove the attributes before it adds attributes unless
- the value of the attribute to remove is not a string or array.</para>
-
+ the value of the attribute to remove is not a string or array.
+ </para>
<para>
The last parameter determines if the modification is performed
recursively. 1 means recurive modification. If some of the objects
cannot be modified they will be skiped without notice.
<function>hw_error</function> may not indicate an error though
- some of the objects could not be modified.</para>
-
+ some of the objects could not be modified.
+ </para>
<para>
The keys of both arrays are the attributes name. The value of each
array element can either be an array, a string or anything else.
@@ -1554,8 +1697,8 @@
removed which would fail since it doesn't exist. The following addition of
a new value for that attribute would also fail. Setting the value
for that attribute to e.g. 0 would not even try to remove it and
- the addition will work.</para>
-
+ the addition will work.
+ </para>
<para>
If you would like to change the attribute 'Name' with the current
value 'books' into 'articles' you will have to create two arrays
@@ -1583,7 +1726,8 @@
$addarr = array("Name" => "articles");
$hw_modifyobject($connect, $objid, $remarr, $addarr);
</programlisting>
- </example></para>
+ </example>
+ </para>
<para>
<note>
<simpara>
@@ -1591,7 +1735,8 @@
ways. Either by providing the attributes value in its native
form 'language':'title' or by providing an array with elements
for each language as described above. The above example would
- than be:</simpara>
+ than be:
+ </simpara>
</note>
<example>
<title>modifying Title attribute</title>
@@ -1620,34 +1765,45 @@
$hw_modifyobject($connect, $objid, $remarr, $addarr);
</programlisting>
</example>
- <note><simpara>
+ <note>
+ <simpara>
This will remove all attributes with the name 'Title' and adds
a new 'Title' attribute. This comes in handy if you want to
remove attributes recursively.
- </simpara></note>
+ </simpara>
+ </note>
<note>
<simpara>
If you need to delete all attributes with a certain name you
- will have to pass an empty string as the attribute value.</simpara>
+ will have to pass an empty string as the attribute value.
+ </simpara>
+ </note>
+ <note>
+ <simpara>
+ Only the attributes 'Title', 'Description' and 'Keyword' will
+ properly handle the language prefix. If those attributes don't carry
+ a language prefix, the prefix 'xx' will be assigned.
+ </simpara>
+ </note>
+ <note>
+ <simpara>
+ The 'Name' attribute is somewhat special. In some cases it cannot
+ be complete removed. You will get an error message 'Change of base
+ attribute' (not clear when this happens). Therefore you will always
+ have to add a new Name first and than remove the old one.
+ </simpara>
+ </note>
+ <note>
+ <simpara>
+ You may not suround this function by calls to
+ <function>hw_getandlock</function> and <function>hw_unlock</function>.
+ <function>hw_modifyobject</function> does this internally.
+ </simpara>
</note>
- <note><simpara>
- Only the attributes 'Title', 'Description' and 'Keyword' will
- properly handle the language prefix. If those attributes don't carry
- a language prefix, the prefix 'xx' will be assigned.
- </simpara></note>
- <note><simpara>
- The 'Name' attribute is somewhat special. In some cases it cannot
- be complete removed. You will get an error message 'Change of base
- attribute' (not clear when this happens). Therefore you will always
- have to add a new Name first and than remove the old one.
- </simpara></note>
- <note><simpara>
- You may not suround this function by calls to
- <function>hw_getandlock</function> and <function>hw_unlock</function>.
- <function>hw_modifyobject</function> does this internally.
- </simpara></note></para>
+ </para>
<para>
- Returns TRUE if no error occurs otherwise FALSE.</para>
+ Returns TRUE if no error occurs otherwise FALSE.
+ </para>
</refsect1>
</refentry>
@@ -1672,13 +1828,15 @@
<parameter>object_record</parameter>. The length of the
<parameter>document_data</parameter> has to passed in
<parameter>document_size</parameter>This function does not
- insert the document into the Hyperwave server.</para>
+ insert the document into the Hyperwave server.
+ </para>
<para>
See also <function>hw_FreeDocument</function>,
- <function>hw_DocumentSize</function>,
- <function>hw_DocumentBodyTag</function>,
- <function>hw_OutputDocument</function>,
- <function>hw_InsertDocument</function>.</para>
+ <function>hw_Document_Size</function>,
+ <function>hw_Document_BodyTag</function>,
+ <function>hw_Output_Document</function>,
+ and <function>hw_InsertDocument</function>.
+ </para>
</refsect1>
</refentry>
@@ -1717,25 +1875,31 @@
<literal>HW_ATTR_LANG</literal> or <literal>HW_ATTR_NONE</literal>
</para>
<para>
- See also <function>hw_array2objrec</function>.</para>
+ See also <function>hw_array2objrec</function>.
+ </para>
</refsect1>
</refentry>
- <refentry id="function.hw-outputdocument">
+ <refentry id="function.hw-output-document">
<refnamediv>
- <refname>hw_OutputDocument</refname>
+ <refname>hw_Output_Document</refname>
<refpurpose>prints hw_document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function>hw_outputdocument</function></funcdef>
+ <funcdef>int <function>hw_output_document</function></funcdef>
<paramdef>int <parameter>hw_document</parameter></paramdef>
</funcprototype>
</funcsynopsis>
+ <para>
+ Prints the document without the BODY tag.
+ </para>
<para>
- Prints the document without the BODY tag.</para>
+ For backward compatibility, <function>hw_OutputDocument</function> is
+ also accepted. This is deprecated, however.
+ </para>
</refsect1>
</refentry>
@@ -1767,7 +1931,8 @@
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>.</para>
+ See also <function>hw_Connect</function>.
+ </para>
</refsect1>
</refentry>
@@ -1793,10 +1958,11 @@
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_DocumentSize</function>,
- <function>hw_DocumentBodyTag</function>,
- <function>hw_OutputDocument</function>.</para>
+ <function>hw_FreeDocument</function>,
+ <function>hw_Document_Size</function>,
+ <function>hw_Document_BodyTag</function>,
+ and <function>hw_Output_Document</function>.
+ </para>
</refsect1>
</refentry>
@@ -1816,7 +1982,8 @@
<para>
Returns the object ID of the hyperroot collection. Currently this
is always 0. The child collection of the hyperroot is the root
- collection of the connected server.</para>
+ collection of the connected server.
+ </para>
</refsect1>
</refentry>
@@ -1835,9 +2002,11 @@
</funcprototype>
</funcsynopsis>
<para>
- Unlocks a document, so other users regain access.</para>
+ Unlocks a document, so other users regain access.
+ </para>
<para>
- See also <function>hw_GetAndLock</function>.</para>
+ See also <function>hw_GetAndLock</function>.
+ </para>
</refsect1>
</refentry>
@@ -1858,7 +2027,8 @@
Returns an array of users currently logged into the Hyperwave server.
Each entry in this array is an array itself containing the elements id,
name, system, onSinceDate, onSinceTime, TotalTime and self. 'self'
- is 1 if this entry belongs to the user who initianted the request.</para>
+ is 1 if this entry belongs to the user who initianted the request.
+ </para>
</refsect1>
</refentry>
@@ -1876,7 +2046,8 @@
</funcprototype>
</funcsynopsis>
<para>
- Returns the username of the connection.</para>
+ Returns the username of the connection.
+ </para>
</refsect1>
</refentry>