cvs commit

From: steinm Date: Fri Jul 9 01:48:51 1999 Modified files: phpdoc/functions/hw.sgml Log message: fixed potential problem mentioned by Egon Index: phpdoc/functions/hw.sgml diff -u phpdoc/functions/hw.sgml:1.6 phpdoc/functions/hw.sgml:1.7 --- phpdoc/functions/hw.sgml:1.6 Wed Jul 7 11:29:55 1999 +++ phpdoc/functions/hw.sgml Fri Jul 9 01:48:50 1999 @@ -923,13 +923,14 @@ <funcdef>int <function>hw_gettext</function></funcdef> <paramdef>int <parameter>connection</parameter></paramdef> <paramdef>int <parameter>objectID</parameter></paramdef> - <paramdef>[int|string] <parameter>[rootID|prefix]</parameter></paramdef> + <paramdef>mixed <parameter>rootID/prefix</parameter></paramdef> </funcsynopsis> <para> Returns the document with object ID <parameter>objectID</parameter>. If the document has anchors which can be inserted, they will be inserted already. - The optional parameter <parameter>rootID</parameter> determines + The optional parameter <parameter>rootID/prefix</parameter> can + be a string or an integer. If it is an integer it determines how links are inserted into the document. The default is 0 and will result in links that are constructed from the name of the link's destination object. This @@ -941,17 +942,18 @@ example '/my_script.php3/internet_movie'. 'my_script.php3' will have to evaluate $PATH_INFO and retrieve the document. All links will have the prefix '/my_script.php3/'. If you do not - want this you can set the optional parameter to any prefix which - is used instead. + 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> - If <parameter>rootID</parameter> is unequal to 0 the link is - constructed from all the names - starting at the object with the id <parameter>rootID</parameter> + If <parameter>rootID/prefix</parameter> is an integer and + unequal to 0 the link is constructed from all the names + starting at the object with the id <parameter>rootID/prefix</parameter> separated by a slash relative to the current object. If for example the above document 'internet_movie' is located at 'a-b-c-internet_movie' with '-' being the seperator between - hierachy levels and the source document is located at - 'a-b-d-source' the resulting HTML link would be: + hierachy levels on the Hyperwave server and the source document is + located at 'a-b-d-source' the resulting HTML link would be: &lt;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.