From 5bf378d8621d90e8618d64cd9e93df83f109a21b Mon Sep 17 00:00:00 2001 From: Ron Chmara Date: Mon, 2 Oct 2000 01:07:31 +0000 Subject: [PATCH] Depreciated usage of functions, misnamed functions, some nesting and indentation. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@33242 c90b9560-bf6c-de11-be94-00142212c4b1 --- functions/hw.xml | 595 ++++++++++++++++++++++++++++++----------------- 1 file changed, 383 insertions(+), 212 deletions(-) diff --git a/functions/hw.xml b/functions/hw.xml index cbd03d5c11..23a8171a0a 100644 --- a/functions/hw.xml +++ b/functions/hw.xml @@ -9,11 +9,13 @@ Hyperwave has been developed at IICM in Graz. It started with the name Hyper-G and changed to Hyperwave when - it was commercialised (If I remember properly it was in 1996). + it was commercialised (If I remember properly it was in 1996). + Hyperwave is not free software. The current version, 4.1, is available at www.hyperwave.com. - A time limited version can be ordered for free (30 days). + A time limited version can be ordered for free (30 days). + Hyperwave is an information system similar to a database (HIS, 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. + as it separated by colon from the rest of the attribute value. + 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.) + Title, Description and Keyword are treated properly yet.) + 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. + the document itself. + Saying that hw_pipedocument and hw_gettext 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. + This can only be prevented by selecting reasonable object names. + 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. + basically sharing of a namespace by the web and Hyperwave server. + - Based on the above mechanism links are insert into documents. + Based on the above mechanism links are insert into documents. + 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. + replaced by another character, e.g. '_'. to be continued. + The network protocol to communicate with the Hyperwave server is called HG-CSP @@ -127,36 +136,41 @@ PLACE 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. - + not make life easier. + 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 HG-CSP but also provides more powerful commands - to e.g. retrieve complete documents. - + to e.g. retrieve complete documents. + 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. - + + 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. - - + + + + 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 hw_object2array. Several functions return object records. The names of those functions end with obj. - - + + + + 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. - - + + + + 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. - - - + + + + Several functions which return an array of object records do also return an associated array with statistical information about @@ -181,40 +198,59 @@ Hidden - + + Number of object records with attribute PresentationHints - set to Hidden. + set to Hidden. + + CollectionHead - + + Number of object records with attribute - PresentationHints set to CollectionHead. + PresentationHints set to CollectionHead. + + FullCollectionHead - + + Number of object records with attribute - PresentationHints set to FullCollectionHead. + PresentationHints set to FullCollectionHead. + + CollectionHeadNr - + + Index in array of object records with - attribute PresentationHints set to CollectionHead. + attribute PresentationHints set to CollectionHead. + + FullCollectionHeadNr - + + Index in array of object records with - attribute PresentationHints set to FullCollectionHead. + attribute PresentationHints set to FullCollectionHead. + + Total - - Total: Number of object records. + + + Total: Number of object records. + + - + + @@ -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. - + engine. The following instructions will explain this. + 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 PATH_INFO variable and treats its value as the name of a Hyperwave - object. Let's call this script 'Hyperwave'. The URL http://your.hostname/Hyperwave/name_of_object + object. Let's call this script 'Hyperwave'. The 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 http://your.hostname/name_of_object would + view it would be more straight forward if the URL + http://your.hostname/name_of_object would return the object. The rewriting rule is quite easy: @@ -274,19 +312,35 @@ RewriteEngine on scripts: - - to return the object itself - - to allow searching - - to identify yourself - - to set your profile - + + + to return the object itself + + + + + to allow searching + + + + + to identify yourself + + + + + to set your profile + + + + one for each additional function like to show the object attributes, to show information about users, - to show the status of the server, etc. - + to show the status of the server, etc. + + + + @@ -307,7 +361,8 @@ RewriteEngine on Conversion form object record into object array needs to handle any multiple attribute. - + + @@ -327,9 +382,11 @@ RewriteEngine on Converts an object_array into an object record. Multiple attributes like 'Title' in different languages are treated - properly. + properly. + - See also hw_objrec2array. + See also hw_objrec2array. + @@ -393,7 +450,8 @@ RewriteEngine on 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. + with the given connection index. + @@ -424,9 +482,11 @@ RewriteEngine on 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. + is not encrypted. + - See also hw_pConnect. + See also hw_pConnect. + @@ -448,11 +508,14 @@ RewriteEngine on Copies the objects with object ids as specified in the second parameter to the collection - with the id destination id. + with the id destination id. + - The value return is the number of copied objects. + The value return is the number of copied objects. + - See also hw_mv. + See also hw_mv. + @@ -472,11 +535,14 @@ RewriteEngine on Deletes the object with the given object id in the second - parameter. It will delete all instances of the object. + parameter. It will delete all instances of the object. + - Returns TRUE if no error occurs otherwise FALSE. + Returns TRUE if no error occurs otherwise FALSE. + - See also hw_mv. + See also hw_mv. + @@ -496,7 +562,8 @@ RewriteEngine on Returns an th object id of the document to - which anchorID belongs. + which anchorID belongs. + @@ -516,87 +583,102 @@ RewriteEngine on Returns an th object record of the document to - which anchorID belongs. + which anchorID belongs. + - + - hw_DocumentAttributes + hw_Document_Attributes object record of hw_document Description - string hw_documentattributes + string hw_document_attributes int hw_document - Returns the object record of the document. + Returns the object record of the document. + - See also hw_DocumentBodyTag, - hw_DocumentSize. + For backward compatibility, hw_DocumentAttributes + is also accepted. This is deprecated, however. + + + See also hw_Document_BodyTag, + and hw_Document_Size. + - + - hw_DocumentBodyTag + hw_Document_BodyTag body tag of hw_document Description - string hw_documentbodytag + string hw_document_bodytag int hw_document Returns the BODY tag of the document. If the document is an HTML - document the BODY tag should be printed before the document. + document the BODY tag should be printed before the document. + - See also hw_DocumentAttributes, - hw_DocumentSize. + See also hw_Document_Attributes, + and hw_Document_Size. + + + For backward compatibility, hw_DocumentBodyTag + is also accepted. This is deprecated, however. + - + - hw_DocumentContent + hw_Document_Content returns content of hw_document Description - string hw_documentcontent + string hw_document_content int hw_document 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. + from the HEAD and BODY tag is in the stored in the object record. + - See also hw_DocumentAttributes, - hw_DocumentSize, - hw_DocumentSetContent. + See also hw_Document_Attributes, + hw_Document_Size, + and hw_DocumentSetContent. + - + - hw_DocumentSetContent + hw_Document_SetContent sets/replaces content of hw_document Description - string hw_documentsetcontent + string hw_document_setcontent int hw_document string content @@ -608,32 +690,39 @@ RewriteEngine on 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. + If this functions fails the document will retain its old content. + - See also hw_DocumentAttributes, - hw_DocumentSize, - hw_DocumentContent. + See also hw_Document_Attributes, + hw_Document_Size, + and hw_Document_Content. + - + - hw_DocumentSize + hw_Document_Size size of hw_document Description - int hw_documentsize + int hw_document_size int hw_document Returns the size in bytes of the document. - See also hw_DocumentBodyTag, - hw_DocumentAttributes. + See also hw_Document_BodyTag, + and hw_Document_Attributes. + + + For backward compatibility, hw_DocumentSize + is also accepted. This is deprecated, however. + @@ -653,7 +742,8 @@ RewriteEngine on 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. + The message relates to the last command. + @@ -677,14 +767,16 @@ RewriteEngine on 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. + control connection during the transfer. + See also hw_PipeDocument, - hw_FreeDocument, - hw_DocumentBodyTag, - hw_DocumentSize, - hw_OutputDocument, - hw_GetText. + hw_FreeDocument, + hw_Document_BodyTag, + hw_Document_Size, + hw_Output_Document, + hw_GetText. + @@ -703,7 +795,8 @@ RewriteEngine on Returns the last error number. If the return value is 0 no error has - occurred. The error relates to the last command. + occurred. The error relates to the last command. + @@ -721,7 +814,8 @@ RewriteEngine on - Frees the memory occupied by the Hyperwave document. + Frees the memory occupied by the Hyperwave document. + @@ -741,7 +835,8 @@ RewriteEngine on Returns an indexed array of object ids. Each object id belongs to - a parent of the object with ID objectID. + a parent of the object with ID objectID. + @@ -763,7 +858,8 @@ RewriteEngine on 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 objectID. + a parent of the object with ID objectID. + @@ -788,7 +884,8 @@ RewriteEngine on return child documents. See also hw_GetChildren, - hw_GetChildDocColl. + and hw_GetChildDocColl. + @@ -810,10 +907,12 @@ RewriteEngine on Returns an array of object records. Each object records belongs to a child collection of the collection with ID objectID. The function will not return - child documents. + child documents. + See also hw_ChildrenObj, - hw_GetChildDocCollObj. + and hw_GetChildDocCollObj. + @@ -843,9 +942,11 @@ RewriteEngine on 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. + by a Hyperwave gateway should be more difficult than doing it in PHP. + - See also hw_GetRemoteChildren. + See also hw_GetRemoteChildren. + @@ -881,9 +982,11 @@ RewriteEngine on 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. + difficult than doing it in PHP. + - See also hw_GetRemote. + See also hw_GetRemote. + @@ -906,7 +1009,8 @@ RewriteEngine on objectID. The object can either be a document or an anchor of type destination. - See also hw_GetAnchors. + See also hw_GetAnchors. + @@ -930,7 +1034,8 @@ RewriteEngine on objectID 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. + parameter is also evaluated which is a query string. + The query string has the following syntax: @@ -951,10 +1056,12 @@ RewriteEngine on 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. + the object is allowed. + See also hw_GetAndLock, - hw_GetObjectByQuery. + and hw_GetObjectByQuery. + @@ -976,10 +1083,12 @@ RewriteEngine on Returns the object record for the object with ID objectID. It will also lock the object, so other users cannot access - it until it is unlocked. + it until it is unlocked. + See also hw_Unlock, - hw_GetObject. + and hw_GetObject. + @@ -1021,7 +1130,8 @@ RewriteEngine on All links will have the prefix '/my_script.php3/'. If you do not want this you can set the optional parameter rootID/prefix to any prefix which - is used instead. Is this case it has to be a string. + is used instead. Is this case it has to be a string. + If rootID/prefix is an integer and unequal to 0 the link is constructed from all the names @@ -1033,17 +1143,20 @@ RewriteEngine on 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. + the document hierachy onto the file system. + 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. + control connection during the transfer. + See also hw_PipeDocument, - hw_FreeDocument, - hw_DocumentBodyTag, - hw_DocumentSize, - hw_OutputDocument. + hw_FreeDocument, + hw_Document_BodyTag, + hw_Document_Size, + and hw_Output_Document. + @@ -1066,11 +1179,14 @@ RewriteEngine on Searches for objects on the whole server and returns an array of object ids. The maximum number of matches is limited to max_hits. If max_hits - is set to -1 the maximum number of matches is unlimited. + is set to -1 the maximum number of matches is unlimited. + - The query will only work with indexed attributes. + The query will only work with indexed attributes. + - See also hw_GetObjectByQueryObj. + See also hw_GetObjectByQueryObj. + @@ -1093,11 +1209,14 @@ RewriteEngine on Searches for objects on the whole server and returns an array of object records. The maximum number of matches is limited to max_hits. If max_hits - is set to -1 the maximum number of matches is unlimited. + is set to -1 the maximum number of matches is unlimited. + - The query will only work with indexed attributes. + The query will only work with indexed attributes. + - See also hw_GetObjectByQuery. + See also hw_GetObjectByQuery. + @@ -1123,11 +1242,13 @@ RewriteEngine on object ids. The maximum number of matches is limited to max_hits. If max_hits - is set to -1 the maximum number of matches is unlimited. + is set to -1 the maximum number of matches is unlimited. + The query will only work with indexed attributes. - See also hw_GetObjectByQueryCollObj. + See also hw_GetObjectByQueryCollObj. + @@ -1153,11 +1274,14 @@ RewriteEngine on object records. The maximum number of matches is limited to max_hits. If max_hits - is set to -1 the maximum number of matches is unlimited. + is set to -1 the maximum number of matches is unlimited. + - The query will only work with indexed attributes. + The query will only work with indexed attributes. + - See also hw_GetObjectByQueryColl. + See also hw_GetObjectByQueryColl. + @@ -1176,10 +1300,12 @@ RewriteEngine on - Returns array of object ids for child documents of a collection. + Returns array of object ids for child documents of a collection. + See also hw_GetChildren, - hw_GetChildColl. + and hw_GetChildColl. + @@ -1201,7 +1327,8 @@ RewriteEngine on Returns an array of object records for child documents of a collection. See also hw_ChildrenObj, - hw_GetChildCollObj. + and hw_GetChildCollObj. + @@ -1221,7 +1348,8 @@ RewriteEngine on Returns an array of object ids with anchors of the document - with object ID objectID. + with object ID objectID. + @@ -1241,7 +1369,8 @@ RewriteEngine on Returns an array of object records with anchors of the document - with object ID objectID. + with object ID objectID. + @@ -1268,12 +1397,15 @@ RewriteEngine on 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 hw_deleteobject. + at once, use hw_deleteobject. + - The value return is the number of moved objects. + The value return is the number of moved objects. + See also hw_cp, - hw_deleteobject. + and hw_deleteobject. + @@ -1296,9 +1428,11 @@ RewriteEngine on password. 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. + be easier to identify with the opening of the connection. + - See also hw_Connect. + See also hw_Connect. + @@ -1330,8 +1464,8 @@ RewriteEngine on 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. - + the matches of a previous query, in a graphical overview. + @@ -1352,7 +1486,8 @@ RewriteEngine on Returns information about the current connection. The returned string has the following format: <Serverstring>, <Host>, <Port>, <Username>, <Port of Client>, - <Byte swapping> + <Byte swapping> + @@ -1374,7 +1509,8 @@ RewriteEngine on Inserts a new collection with attributes as in object_array into - collection with object ID objectID. + collection with object ID objectID. + @@ -1401,10 +1537,12 @@ RewriteEngine on an object record only or an object record and a pure ascii text in text if text is given. If you want to insert a general document of any kind use - hw_insertdocument instead. + hw_insertdocument instead. + See also hw_InsertDocument, - hw_InsColl. + and hw_InsColl. + @@ -1431,9 +1569,11 @@ RewriteEngine on 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. + object id of the new document or false. + - See also hw_PipeDocument. + See also hw_PipeDocument. + @@ -1455,17 +1595,20 @@ RewriteEngine on 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. + for a detailed information on how the parameters have to be. + 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. + has no correspondig link in the annotation text. + See also hw_PipeDocument, - hw_InsertDocument, - hw_InsDoc, - hw_InsColl. + hw_InsertDocument, + hw_InsDoc, + and hw_InsColl. + @@ -1491,13 +1634,14 @@ RewriteEngine on used as any other object id, e.g. to obtain the object record with hw_getobject. 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. + is actually the IP number as an integer. + 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 - + @@ -1517,7 +1661,6 @@ RewriteEngine on array remove array add int mode - @@ -1529,15 +1672,15 @@ RewriteEngine on to add. In order to modify an attribute one will have to remove the old one and add a new one. hw_modifyobject will always remove the attributes before it adds attributes unless - the value of the attribute to remove is not a string or array. - + the value of the attribute to remove is not a string or array. + 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. hw_error may not indicate an error though - some of the objects could not be modified. - + some of the objects could not be modified. + 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 @@ RewriteEngine on 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. - + the addition will work. + 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 @@ RewriteEngine on $addarr = array("Name" => "articles"); $hw_modifyobject($connect, $objid, $remarr, $addarr); - + + @@ -1591,7 +1735,8 @@ RewriteEngine on 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: + than be: + modifying Title attribute @@ -1620,34 +1765,45 @@ RewriteEngine on $hw_modifyobject($connect, $objid, $remarr, $addarr); - + + 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. - + + If you need to delete all attributes with a certain name you - will have to pass an empty string as the attribute value. + will have to pass an empty string as the attribute value. + - - 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. - - - 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. - - - You may not suround this function by calls to - hw_getandlock and hw_unlock. - hw_modifyobject does this internally. - + + + 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. + + + + + 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. + + + + + You may not suround this function by calls to + hw_getandlock and hw_unlock. + hw_modifyobject does this internally. + + + - Returns TRUE if no error occurs otherwise FALSE. + Returns TRUE if no error occurs otherwise FALSE. + @@ -1672,13 +1828,15 @@ RewriteEngine on object_record. The length of the document_data has to passed in document_sizeThis function does not - insert the document into the Hyperwave server. + insert the document into the Hyperwave server. + See also hw_FreeDocument, - hw_DocumentSize, - hw_DocumentBodyTag, - hw_OutputDocument, - hw_InsertDocument. + hw_Document_Size, + hw_Document_BodyTag, + hw_Output_Document, + and hw_InsertDocument. + @@ -1717,25 +1875,31 @@ RewriteEngine on HW_ATTR_LANG or HW_ATTR_NONE - See also hw_array2objrec. + See also hw_array2objrec. + - + - hw_OutputDocument + hw_Output_Document prints hw_document Description - int hw_outputdocument + int hw_output_document int hw_document - Prints the document without the BODY tag. + Prints the document without the BODY tag. + + + For backward compatibility, hw_OutputDocument is + also accepted. This is deprecated, however. + @@ -1767,7 +1931,8 @@ RewriteEngine on index that is needed by other Hyperwave functions. You can have multiple persistent connections open at once. - See also hw_Connect. + See also hw_Connect. + @@ -1793,10 +1958,11 @@ RewriteEngine on does not block the control connection. See also hw_GetText for more on link insertion, - hw_FreeDocument, - hw_DocumentSize, - hw_DocumentBodyTag, - hw_OutputDocument. + hw_FreeDocument, + hw_Document_Size, + hw_Document_BodyTag, + and hw_Output_Document. + @@ -1816,7 +1982,8 @@ RewriteEngine on 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. + collection of the connected server. + @@ -1835,9 +2002,11 @@ RewriteEngine on - Unlocks a document, so other users regain access. + Unlocks a document, so other users regain access. + - See also hw_GetAndLock. + See also hw_GetAndLock. + @@ -1858,7 +2027,8 @@ RewriteEngine on 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. + is 1 if this entry belongs to the user who initianted the request. + @@ -1876,7 +2046,8 @@ RewriteEngine on - Returns the username of the connection. + Returns the username of the connection. +