diff --git a/reference/array/functions/array-product.xml b/reference/array/functions/array-product.xml index 71f38e0f6a..5ec13d1004 100644 --- a/reference/array/functions/array-product.xml +++ b/reference/array/functions/array-product.xml @@ -1,20 +1,44 @@ - + array_product Calculate the product of values in an array - - Description + + &reftitle.description; numberarray_product arrayarray array_product returns the product of values - in an array as an integer or float. + in an array. + + + &reftitle.parameters; + + + + array + + + The array. + + + + + + + + &reftitle.returnvalues; + + Returns the product as an integer or float. + + + + &reftitle.examples; <function>array_product</function> examples diff --git a/reference/array/functions/array-values.xml b/reference/array/functions/array-values.xml index 47a9bd5861..1fbbb979b4 100644 --- a/reference/array/functions/array-values.xml +++ b/reference/array/functions/array-values.xml @@ -1,13 +1,12 @@ - - + array_values Return all the values of an array - - Description + + &reftitle.description; arrayarray_values arrayinput @@ -17,6 +16,30 @@ input array and indexes numerically the array. + + + &reftitle.parameters; + + + + input + + + The array. + + + + + + + + &reftitle.returnvalues; + + Returns an indexed array of values. + + + + &reftitle.examples; <function>array_values</function> example @@ -40,8 +63,13 @@ Array + + + &reftitle.seealso; - See also array_keys. + + array_keys + diff --git a/reference/array/functions/end.xml b/reference/array/functions/end.xml index 3c3ed0e1dd..0d347ed8e5 100644 --- a/reference/array/functions/end.xml +++ b/reference/array/functions/end.xml @@ -1,13 +1,13 @@ - + end Set the internal pointer of an array to its last element - - Description + + &reftitle.description; mixedend arrayarray @@ -16,9 +16,33 @@ end advances array's internal pointer to the last element, and returns its value. + + + &reftitle.parameters; + + + + array + + + The array. + + + + + + + + &reftitle.returnvalues; + + Returns the value of the last element. + + + + &reftitle.examples; - A simple <function>end</function> example + <function>end</function> example + + + &reftitle.seealso; - See also current, - each, - prev, - next and - reset. + + current + each + prev + reset + next + diff --git a/reference/array/functions/key.xml b/reference/array/functions/key.xml index 23cdf6f601..b59436795d 100644 --- a/reference/array/functions/key.xml +++ b/reference/array/functions/key.xml @@ -1,21 +1,45 @@ - + key Fetch a key from an associative array - - Description + + &reftitle.description; mixedkey arrayarray - key returns the index element of the - current array position. + key returns the index element of the current array + position. + + + &reftitle.parameters; + + + + array + + + The array. + + + + + + + + &reftitle.returnvalues; + + Returns the index. + + + + &reftitle.examples; <function>key</function> example @@ -42,8 +66,14 @@ while ($fruit_name = current($array)) { + + + &reftitle.seealso; - See also current and next. + + current + next + diff --git a/reference/array/functions/shuffle.xml b/reference/array/functions/shuffle.xml index 428be4e4da..4319f606de 100644 --- a/reference/array/functions/shuffle.xml +++ b/reference/array/functions/shuffle.xml @@ -1,22 +1,43 @@ - - + shuffle Shuffle an array - - Description + + &reftitle.description; boolshuffle arrayarray - This function shuffles (randomizes the order of the elements in) - an array. + This function shuffles (randomizes the order of the elements in) an array. - ¬e.no-key-association; + + + &reftitle.parameters; + + + + array + + + The array. + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + &reftitle.examples; <function>shuffle</function> example @@ -34,13 +55,23 @@ foreach ($numbers as $number) { - + + + &reftitle.notes; + ¬e.no-key-association; ¬e.randomseed; - + + + &reftitle.seealso; - See also arsort, asort, - ksort, rsort, - sort, and usort. + + arsort + asort + ksort + rsort + sort + usort + diff --git a/reference/hw/functions/hw-array2objrec.xml b/reference/hw/functions/hw-array2objrec.xml index a8909dd450..fca5440a58 100644 --- a/reference/hw/functions/hw-array2objrec.xml +++ b/reference/hw/functions/hw-array2objrec.xml @@ -1,13 +1,12 @@ - - + hw_Array2Objrec Convert attributes from object array to object record - - Description + + &reftitle.description; stringhw_array2objrec arrayobject_array @@ -17,8 +16,34 @@ Multiple attributes like 'Title' in different languages are treated properly. + + + &reftitle.parameters; - See also hw_objrec2array. + + + object_array + + + The array. + + + + + + + + &reftitle.returnvalues; + + Returns an object record. + + + + &reftitle.seealso; + + + hw_objrec2array + diff --git a/reference/hw/functions/hw-changeobject.xml b/reference/hw/functions/hw-changeobject.xml index 524a045c51..e7c171a5c5 100644 --- a/reference/hw/functions/hw-changeobject.xml +++ b/reference/hw/functions/hw-changeobject.xml @@ -1,13 +1,12 @@ - - + hw_changeobject Changes attributes of an object (obsolete) - - Description + + &reftitle.description; boolhw_changeobject intlink diff --git a/reference/hw/functions/hw-close.xml b/reference/hw/functions/hw-close.xml index dd5f78373b..fd3d5c14c2 100644 --- a/reference/hw/functions/hw-close.xml +++ b/reference/hw/functions/hw-close.xml @@ -1,21 +1,39 @@ - - + hw_Close Closes the Hyperwave connection - - Description + + &reftitle.description; boolhw_close intconnection - 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. + Closes down the connection to a Hyperwave server. + + + + &reftitle.parameters; + + + + connection + + + The connection identifier. + + + + + + + + &reftitle.returnvalues; + + &return.success; diff --git a/reference/hw/functions/hw-connect.xml b/reference/hw/functions/hw-connect.xml index 12666417ab..de2cd1dbf6 100644 --- a/reference/hw/functions/hw-connect.xml +++ b/reference/hw/functions/hw-connect.xml @@ -1,13 +1,12 @@ - - + hw_Connect Opens a connection - - Description + + &reftitle.description; inthw_connect stringhost @@ -16,20 +15,64 @@ stringpassword - Opens a connection to a Hyperwave server and returns a connection - index on success, or &false; if the connection - could not be made. Each of the arguments should be a quoted string, - except for the port number. The username and - password arguments are - optional and can be left out. In such a case no identification with - the server will be done. It is similar to identify as user anonymous. - 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. + Opens a connection to a Hyperwave server. + You can have multiple connections open at once. + + + &reftitle.parameters; - See also hw_pconnect. + + + host + + + The server host name. + + + + + port + + + The server port number. + + + + + username + + + The Hyperwave user name. If ommited, no identification with the server + will be done. It is similar to identify as user anonymous. + + + + + password + + + The password for username. + Keep in mind, that the password is not encrypted. + + + + + + + + &reftitle.returnvalues; + + Returns a connection index on success, or &false; if the connection could + not be made. + + + + &reftitle.seealso; + + + hw_pconnect + diff --git a/reference/hw/functions/hw-connection-info.xml b/reference/hw/functions/hw-connection-info.xml index b2e169483e..d0ed1f438d 100644 --- a/reference/hw/functions/hw-connection-info.xml +++ b/reference/hw/functions/hw-connection-info.xml @@ -1,13 +1,12 @@ - - + hw_connection_info Prints information about the connection to Hyperwave server - - Description + + &reftitle.description; voidhw_connection_info intlink diff --git a/reference/hw/functions/hw-docbyanchorobj.xml b/reference/hw/functions/hw-docbyanchorobj.xml index 6f84d378c0..a22901ca91 100644 --- a/reference/hw/functions/hw-docbyanchorobj.xml +++ b/reference/hw/functions/hw-docbyanchorobj.xml @@ -1,21 +1,49 @@ - - + hw_DocByAnchorObj Object record object belonging to anchor - - Description + + &reftitle.description; stringhw_docbyanchorobj intconnection intanchorID - Returns an th object record of the document to - which anchorID belongs. + Returns an th object record of the document to which + anchorID belongs. + + + + &reftitle.parameters; + + + + connection + + + The connection identifier. + + + + + anchorID + + + The anchor identifier. + + + + + + + + &reftitle.returnvalues; + + Returns an object record. diff --git a/reference/hw/functions/hw-dummy.xml b/reference/hw/functions/hw-dummy.xml index 2b3f39d5ee..036406eaf4 100644 --- a/reference/hw/functions/hw-dummy.xml +++ b/reference/hw/functions/hw-dummy.xml @@ -1,13 +1,12 @@ - - + hw_dummy Hyperwave dummy function - - Description + + &reftitle.description; stringhw_dummy intlink diff --git a/reference/hw/functions/hw-error.xml b/reference/hw/functions/hw-error.xml index df3e17bf66..54bfde00bf 100644 --- a/reference/hw/functions/hw-error.xml +++ b/reference/hw/functions/hw-error.xml @@ -1,20 +1,47 @@ - - + hw_Error Error number - - Description + + &reftitle.description; inthw_error intconnection - Returns the last error number. If the return value is 0 no error has - occurred. The error relates to the last command. + Returns the last error number, for the last command. + + + + &reftitle.parameters; + + + + connection + + + The connection identifier. + + + + + + + + &reftitle.returnvalues; + + Returns the last error number or 0 if no error occured. + + + + &reftitle.seealso; + + + hw_errormsg + diff --git a/reference/hw/functions/hw-errormsg.xml b/reference/hw/functions/hw-errormsg.xml index 1aeb9f4802..df05985e29 100644 --- a/reference/hw/functions/hw-errormsg.xml +++ b/reference/hw/functions/hw-errormsg.xml @@ -1,21 +1,49 @@ - - + hw_ErrorMsg Returns error message - - Description + + &reftitle.description; stringhw_errormsg intconnection - 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. + Returns a string containing the last error message related to the last + command. + + + + &reftitle.parameters; + + + + connection + + + The connection identifier. + + + + + + + + &reftitle.returnvalues; + + Returns a string containing the last error message or 'No Error'. + If &false; is returned, this function failed. + + + + &reftitle.seealso; + + + hw_error + diff --git a/reference/hw/functions/hw-getanchors.xml b/reference/hw/functions/hw-getanchors.xml index 623c528f1e..b6f4ede491 100644 --- a/reference/hw/functions/hw-getanchors.xml +++ b/reference/hw/functions/hw-getanchors.xml @@ -1,21 +1,48 @@ - - + hw_GetAnchors Object ids of anchors of document - - Description + + &reftitle.description; arrayhw_getanchors intconnection intobjectID - Returns an array of object ids with anchors of the document - with object ID objectID. + Returns an array of object ids with anchors of the specified document. + + + + &reftitle.parameters; + + + + connection + + + The connection identifier. + + + + + objectID + + + The document object id. + + + + + + + + &reftitle.returnvalues; + + Returns an array of object ids. diff --git a/reference/hw/functions/hw-getrellink.xml b/reference/hw/functions/hw-getrellink.xml index 6ee494fe5b..fd0c2e3818 100644 --- a/reference/hw/functions/hw-getrellink.xml +++ b/reference/hw/functions/hw-getrellink.xml @@ -1,13 +1,12 @@ - - + hw_getrellink Get link from source to dest relative to rootid - - Description + + &reftitle.description; stringhw_getrellink intlink diff --git a/reference/hw/functions/hw-getusername.xml b/reference/hw/functions/hw-getusername.xml index dc9acde18e..c1879a68eb 100644 --- a/reference/hw/functions/hw-getusername.xml +++ b/reference/hw/functions/hw-getusername.xml @@ -1,13 +1,12 @@ - - + hw_getusername Name of currently logged in user - - Description + + &reftitle.description; stringhw_getusername intconnection @@ -16,6 +15,27 @@ Returns the username of the connection. + + &reftitle.parameters; + + + + connection + + + The connection identifier. + + + + + + + + &reftitle.returnvalues; + + Returns the username as a string. + + - + hw_Info Info about connection - - Description + + &reftitle.description; stringhw_info intconnection - Returns information about the current connection. The returned string - has the following format: <Serverstring>, <Host>, - <Port>, <Username>, <Port of Client>, + Returns information about the current connection. + + + + &reftitle.parameters; + + + + connection + + + The connection identifier. + + + + + + + + &reftitle.returnvalues; + + The returned string has the following format: <Serverstring>, + <Host>, <Port>, <Username>, <Port of Client>, <Byte swapping> diff --git a/reference/hw/functions/hw-output-document.xml b/reference/hw/functions/hw-output-document.xml index 56663b445c..eb50108762 100644 --- a/reference/hw/functions/hw-output-document.xml +++ b/reference/hw/functions/hw-output-document.xml @@ -1,13 +1,12 @@ - - + hw_Output_Document Prints hw_document - - Description + + &reftitle.description; boolhw_output_document inthw_document @@ -20,6 +19,27 @@ also accepted. This is deprecated, however. + + &reftitle.parameters; + + + + hw_document + + + The document identifier. + + + + + + + + &reftitle.returnvalues; + + &return.success; + + - + hw_setlinkroot Set the id to which links are calculated - - Description + + &reftitle.description; inthw_setlinkroot intlink diff --git a/reference/hw/functions/hw-stat.xml b/reference/hw/functions/hw-stat.xml index a6aee351de..71842b3d60 100644 --- a/reference/hw/functions/hw-stat.xml +++ b/reference/hw/functions/hw-stat.xml @@ -1,13 +1,12 @@ - - + hw_stat Returns status string - - Description + + &reftitle.description; stringhw_stat intlink diff --git a/reference/hw/functions/hw-unlock.xml b/reference/hw/functions/hw-unlock.xml index 0247dfa706..970f2ff8cc 100644 --- a/reference/hw/functions/hw-unlock.xml +++ b/reference/hw/functions/hw-unlock.xml @@ -1,13 +1,12 @@ - - + hw_Unlock Unlock object - - Description + + &reftitle.description; boolhw_unlock intconnection @@ -16,8 +15,42 @@ Unlocks a document, so other users regain access. + + + &reftitle.parameters; - See also hw_getandlock. + + + connection + + + The connection identifier. + + + + + objectID + + + The document object identifier. + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + &reftitle.seealso; + + + hw_getandlock + diff --git a/reference/strings/functions/htmlspecialchars.xml b/reference/strings/functions/htmlspecialchars.xml index 5a9e5cbe90..d05b844086 100644 --- a/reference/strings/functions/htmlspecialchars.xml +++ b/reference/strings/functions/htmlspecialchars.xml @@ -1,13 +1,13 @@ - + htmlspecialchars Convert special characters to HTML entities - - Description + + &reftitle.description; stringhtmlspecialchars stringstring @@ -27,7 +27,7 @@ This function is useful in preventing user-supplied text from containing HTML markup, such as in a message board or guest book - application. + application. The translations performed are: @@ -93,7 +93,7 @@ charset - Defines character set used in conversion. + Defines character set used in conversion. The default character set is ISO-8859-1. &reference.strings.charsets; @@ -111,7 +111,7 @@ - + &reftitle.returnvalues; @@ -182,7 +182,7 @@ echo $new; // <a href='test'>Test</a> - + &reftitle.seealso;