cvs: phpdoc /en/reference/hwapi configure.xml ini.xml reference.xml /en/reference/hwapi/functions hwapi-attribute-key.xml
hwapi-attribute-langdepvalue.xml hwapi-attribute-value.xml hwapi-attribute-values.xml hwapi-attribute.xml hwapi-checkin.xml hwapi-checkout.xml
hwapi-children.xml hwapi-content-mimetype.xml hwapi-content-read.xml hwapi-content.xml hwapi-copy.xml hwapi-dbstat.xml hwapi-dcstat.xml
hwapi-dstanchors.xml hwapi-dstofsrcanchors.xml hwapi-error-count.xml hwapi-error-reason.xml hwapi-find.xml hwapi-ftstat.xml hwapi-hgcsp.xml
hwapi-hwstat.xml hwapi-identify.xml hwapi-info.xml hwapi-insert.xml hwapi-insertanchor.xml hwapi-insertcollection.xml hwapi-insertdocument.xml
hwapi-link.xml hwapi-lock.xml hwapi-move.xml hwapi-new-content.xml hwapi-object-assign.xml hwapi-object-attreditable.xml hwapi-object-count.xml
hwapi-object-insert.xml hwapi-object-new.xml hwapi-object-remove.xml hwapi-object-title.xml hwapi-object-value.xml hwapi-object.xml
hwapi-objectbyanchor.xml hwapi-parents.xml hwapi-reason-description.xml hwapi-reason-type.xml hwapi-remove.xml hwapi-replace.xml
hwapi-setcommitedversion.xml hwapi-srcanchors.xml hwapi-srcsofdst.xml hwapi-unlock.xml hwapi-user.xml hwapi-userlist.xml

dams Mon Jun 2 13:00:52 2003 EDT Modified files: /phpdoc/en/reference/hwapi configure.xml ini.xml reference.xml /phpdoc/en/reference/hwapi/functions hwapi-attribute-key.xml hwapi-attribute-langdepvalue.xml hwapi-attribute-value.xml hwapi-attribute-values.xml hwapi-attribute.xml hwapi-checkin.xml hwapi-checkout.xml hwapi-children.xml hwapi-content-mimetype.xml hwapi-content-read.xml hwapi-content.xml hwapi-copy.xml hwapi-dbstat.xml hwapi-dcstat.xml hwapi-dstanchors.xml hwapi-dstofsrcanchors.xml hwapi-error-count.xml hwapi-error-reason.xml hwapi-find.xml hwapi-ftstat.xml hwapi-hgcsp.xml hwapi-hwstat.xml hwapi-identify.xml hwapi-info.xml hwapi-insert.xml hwapi-insertanchor.xml hwapi-insertcollection.xml hwapi-insertdocument.xml hwapi-link.xml hwapi-lock.xml hwapi-move.xml hwapi-new-content.xml hwapi-object-assign.xml hwapi-object-attreditable.xml hwapi-object-count.xml hwapi-object-insert.xml hwapi-object-new.xml hwapi-object-remove.xml hwapi-object-title.xml hwapi-object-value.xml hwapi-object.xml hwapi-objectbyanchor.xml hwapi-parents.xml hwapi-reason-description.xml hwapi-reason-type.xml hwapi-remove.xml hwapi-replace.xml hwapi-setcommitedversion.xml hwapi-srcanchors.xml hwapi-srcsofdst.xml hwapi-unlock.xml hwapi-user.xml hwapi-userlist.xml Log: Reverting to Englishcvs update

Index: phpdoc/en/reference/hwapi/configure.xml diff -u phpdoc/en/reference/hwapi/configure.xml:1.2 phpdoc/en/reference/hwapi/configure.xml:1.3 --- phpdoc/en/reference/hwapi/configure.xml:1.2 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/configure.xml Mon Jun 2 13:00:51 2003 @@ -1,9 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <section id="hwapi.installation"> - &reftitle.install; +&reftitle.install; <para> - Apr&egrave;s avoir install&eacute; le SDK Hyperwave, compilez PHP avec l'option + After installing the Hyperwave SDK, configure PHP with <option role="configure">--with-hwapi[=DIR]</option>. </para> </section> Index: phpdoc/en/reference/hwapi/ini.xml diff -u phpdoc/en/reference/hwapi/ini.xml:1.3 phpdoc/en/reference/hwapi/ini.xml:1.4 --- phpdoc/en/reference/hwapi/ini.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/ini.xml Mon Jun 2 13:00:51 2003 @@ -1,17 +1,20 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <section id="hwapi.configuration"> &reftitle.runtime; &extension.runtime; - <para> <table> - &ini.table.title; + <title>Hyperwave API configuration options</title> <tgroup cols="3"> <thead> - &ini.table.top; + <row> + <entry>Name</entry> + <entry>Default</entry> + <entry>Changeable</entry> + </row> </thead> - <tbody> + <tbody> <row> <entry>hwapi.allow_persistent</entry> <entry>"0"</entry> @@ -20,7 +23,8 @@ </tbody> </tgroup> </table> - &ini.table.bottom + For further details and definition of the PHP_INI_* constants see + <function>ini_set</function>. </para> </section> Index: phpdoc/en/reference/hwapi/reference.xml diff -u phpdoc/en/reference/hwapi/reference.xml:1.8 phpdoc/en/reference/hwapi/reference.xml:1.9 --- phpdoc/en/reference/hwapi/reference.xml:1.8 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/reference.xml Mon Jun 2 13:00:51 2003 @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <reference id="ref.hwapi"> - <title>Hyperwave API</title> + <title>Hyperwave API functions</title> <titleabbrev>Hyperwave API</titleabbrev> <partintro> @@ -9,50 +9,50 @@ <section id="hwapi.intro"> &reftitle.intro; <para> - <productname>Hyperwave</productname> a &eacute;t&eacute; d&eacute;velopp&eacute; &agrave; - l'<ulink url="&url.iicm;">IICM</ulink> &agrave; Graz. Le projet a commenc&eacute; - avec le nom de <acronym>Hyper-G</acronym>, puis il est devenu - Hyperwave, lors de sa commercialisation en 1996. + <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 (in 1996). </para> <para> - Hyperwave n'est pas un logiciel libre. Sa version courante, la 5.5, - est disponible &agrave; <ulink url="&url.hyperwave;">&url.hyperwave;</ulink>. - Une version limit&eacute;e dans le temps est commandable gratuitement (30 jours). + Hyperwave is not free software. The current version, 5.5, is + available at <ulink url="&url.hyperwave;">&url.hyperwave;</ulink>. + A time limited version can be ordered for free (30 days). </para> <para> - Voir aussi le module <link linkend="ref.hyperwave">Hyperwave</link>. + See also the <link linkend="ref.hyperwave">Hyperwave</link> module. </para> <para> - Hyperwave est un syst&egrave;me d'information comparable &agrave; une base de donn&eacute;es - (<acronym>HIS</acronym>, Hyperwave Information Server). Il se - concentre sur le stockage et la gestion de documents. Un document - peut &ecirc;tre n'importe quelle pi&egrave;ce de donn&eacute;es qui soit stockable dans - un fichier. Chaque document est accompagn&eacute; de son propre enregistrement. - L'enregistrement contient les m&eacute;ta-donn&eacute;es du document. Les m&eacute;tas donn&eacute;es - sont des listes d'attributs qui peuvent &ecirc;tre manipul&eacute;s par l'utilisateur. - Certains attributs sont g&eacute;r&eacute;s par le serveur Hyperwave, les autres - peuvent &ecirc;tre modifi&eacute;s par l'utilisateur. + Hyperwave is an information system similar to a database + (<acronym>HIS</acronym>, Hyperwave Information Server). Its focus + is the storage and management of documents. A document can be any + possible piece of data that may as well be stored in file. Each + document is accompanied by its object record. The object record + contains meta data for the document. The meta data is a list of + attributes which can be extended by the user. Certain attributes + are always set by the Hyperwave server, other may be modified by + the user. </para> </section> <section id="hwapi.requirements"> &reftitle.required; <para> - Depuis 2001, il y a un SDK Hyperwave disponible. Il supporte Java, - JavaScript et C++. Cette extension PHP est bas&eacute;e sur l'interface C++. - Pour activer le support hwapi de PHP, vous devez installer le - SDK d'abord. + Since 2001 there is a Hyperwave SDK available. It supports Java, + JavaScript and C++. This PHP Extension is based on the C++ interface. + In order to activate the hwapi support in PHP you will have to install + the Hyperwave SDK first. </para> </section> -&reference.hwapi.configure; + &reference.hwapi.configure; <section id="hwapi.apache"> - <title>int&eacute;gration dans Apache</title> + <title>Integration with Apache</title> <para> - L'int&eacute;gration dans Apache et &eacute;ventuellement d'autres serveurs est - d&eacute;j&agrave; d&eacute;crite dans le <link linkend="ref.hyperwave">module Hyperwave</link>, - qui a &eacute;t&eacute; la premi&egrave;re extension &agrave; se connecter au serveur Hyperwave. + The integration with Apache and possible other servers is already + described in the <link linkend="ref.hyperwave">Hyperwave module</link> + which has been the first extension to connect a Hyperwave Server. </para> </section> @@ -71,9 +71,9 @@ <section id="hwapi.classes"> <title>Classes</title> <para> - L'API fournie avec l'extension HW_API est compl&eacute;tement orient&eacute;e objet. - Elle est tr&egrave;s similaire &agrave; l'interface C++ du SDK Hyperwave. - Elle est constitu&eacute;e des classes suivantes : + The API provided by the HW_API extension is fully object oriented. + It is very similar to the C++ interface of the Hyperwave SDK. + It consist of the following classes. <itemizedlist> <listitem> <simpara> @@ -106,66 +106,67 @@ </simpara> </listitem> </itemizedlist> - Certains classes basiques comme <classname>HW_API_String</classname>, - <classname>HW_API_String_Array</classname>, etc., qui existent dans le SDK - Hyperwave SDK n'ont pas &eacute;t&eacute; impl&eacute;ment&eacute;es, car PHP a de puissants ersatz pour elles. + Some basic classes like <classname>HW_API_String</classname>, + <classname>HW_API_String_Array</classname>, etc., which exist in the + Hyperwave SDK have not been implemented since PHP has powerful + replacements for them. </para> <para> - Chaque classe dispose de certaines m&eacute;thodes, dont les noms sont identiques &agrave; - leur alter ego du SDK Hyperwave SDK. Le passage des arguments &agrave; ces fonctions - diff&egrave;re de toutes les autres extensions PHP, mais est proche de l'API C++ - du SDK Hyperwave. Au lieu de passer plusieurs param&egrave;tres, ils sont tous - plac&eacute;s dans un tableau associatif, et transmis sous la forme d'un seul - param&egrave;tre. Les param&egrave;tres les plus communs sont list&eacute;s ci-dessous. Si d'autres - param&egrave;tres sont n&eacute;cessaires, ils seront document&eacute;s &agrave; chaque cas. + Each class has certain method, whose names are identical to its + counterparts in the Hyperwave SDK. Passing arguments to this function + differs from all the other PHP extensions but is close to the C++ API of + the HW SDK. Instead of passing serval parameters they are all put into + an associated array and passed as one paramter. The names of the keys + are identical to those documented in the HW SDK. The common parameters + are listed below. If other parameters are required they will be + documented if needed. <itemizedlist> <listitem> <simpara> - <classname>objectIdentifier</classname> Le nom ou l'identifiant de l'objet, + <classname>objectIdentifier</classname> The name or id of an object, e.g. "rootcollection", "0x873A8768 0x00000002". </simpara> </listitem> <listitem> <simpara> - <classname>parentIdentifier</classname> Le nom ou l'identifiant de l'objet - qui est consid&eacute;r&eacute; comme parent. + <classname>parentIdentifier</classname> The name or id of an object + which is considered to be a parent. </simpara> </listitem> <listitem> <simpara> - <classname>object</classname> Une instance de la classe HW_API_Object. + <classname>object</classname> An instance of class HW_API_Object. </simpara> </listitem> <listitem> <simpara> - <classname>parameters</classname> Une instance de la classe HW_API_Object. + <classname>parameters</classname> An instance of class HW_API_Object. </simpara> </listitem> <listitem> <simpara> - <classname>version</classname> La version de l'objet. + <classname>version</classname> The version of an object. </simpara> </listitem> <listitem> <simpara> - <classname>mode</classname> Un entier qui d&eacute;termine la m&eacute;thode - d'ex&eacute;cution de l'op&eacute;ration. + <classname>mode</classname> An integer value determine the way an + operation is executed. </simpara> </listitem> <listitem> <simpara> - <classname>attributeSelector</classname> Un tableau de cha&icirc;nes de - caract&egrave;res, chacun contenant le nom d'un attribut. C'est le cas si - vous lisez des enregistrements d'objets, et que vous voulez inclure - certains attributs. + <classname>attributeSelector</classname> Any array of strings, each + containing a name of an attribute. This is used if you retrieve the + object record and want to include certain attributes. </simpara> </listitem> <listitem> <simpara> - <classname>objectQuery</classname> Une requ&ecirc;te pour s&eacute;lectionner - certains objets dans une liste. Elle est utilis&eacute;e pour r&eacute;duire - le nombre d'objets qui a &eacute;t&eacute; livr&eacute; par une fonction comme - <function>hw_api->children</function> ou <function>hw_api->find</function>. + <classname>objectQuery</classname> A query to select certain object + out of a list of objects. This is used to reduce the number of objects + which was delivered by a function like + <function>hw_api->children</function> or <function>hw_api->find</function>. </simpara> </listitem> </itemizedlist> Index: phpdoc/en/reference/hwapi/functions/hwapi-attribute-key.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-attribute-key.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-attribute-key.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-attribute-key.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-attribute-key.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-attribute-key"> <refnamediv> <refname>hw_api_attribute->key</refname> - <refpurpose>Retourne la cl&eacute; d'un attribut</refpurpose> + <refpurpose>Returns key of the attribute</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -13,11 +13,10 @@ <methodparam><type>void</type><parameter></parameter></methodparam> </methodsynopsis> <para> - <methodname>key</methodname> retourne le nom de l'attribut. + Returns the name of the attribute. </para> <para> - Voir aussi - <function>hwapi_attribute_value</function>. + See also <function>hwapi_attribute_value</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-attribute-langdepvalue.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-attribute-langdepvalue.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-attribute-langdepvalue.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-attribute-langdepvalue.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-attribute-langdepvalue.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-attribute-langdepvalue"> <refnamediv> <refname>hw_api_attribute->langdepvalue</refname> - <refpurpose>Retourne la valeur d'un attribut dans une langue</refpurpose> + <refpurpose>Returns value for a given language</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -13,12 +13,10 @@ <methodparam><type>string</type><parameter>language</parameter></methodparam> </methodsynopsis> <para> - <function>hw_api_attribute->langdepvalue</function> retourne la valeur - de l'attribut dans la langue <parameter>language</parameter>. + Returns the value in the given language of the attribute. </para> <para> - Voir aussi - <function>hwapi_attribute_value</function>. + See also <function>hwapi_attribute_value</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-attribute-value.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-attribute-value.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-attribute-value.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-attribute-value.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-attribute-value.xml Mon Jun 2 13:00:51 2003 @@ -1,24 +1,23 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-attribute-value"> <refnamediv> <refname>hw_api_attribute->value</refname> - <refpurpose>Retourne la valeur de l'attribut HW</refpurpose> + <refpurpose>Returns value of the attribute</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> - <type>string</type><methodname>hw_api_attribute->value</methodname> + <type>string</type><methodname>value</methodname> <methodparam><type>void</type><parameter></parameter></methodparam> </methodsynopsis> <para> - <function>hw_api_attribute->value</function> retourne la valeur de l'attribut. + Returns the value of the attribute. </para> <para> - Voir aussi - <function>hwapi_attribute_key</function> et - <function>hwapi_attribute_values</function>. + See also <function>hwapi_attribute_key</function>, + <function>hwapi_attribute_values</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-attribute-values.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-attribute-values.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-attribute-values.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-attribute-values.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-attribute-values.xml Mon Jun 2 13:00:51 2003 @@ -1,12 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-attribute-values"> <refnamediv> <refname>hw_api_attribute->values</refname> - <refpurpose> - Retourne toutes les valeurs de l'attribut sous la forme d'un tableau de cha&icirc;nes - </refpurpose> + <refpurpose>Returns all values of the attribute</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -15,12 +13,10 @@ <methodparam><type>void</type><parameter></parameter></methodparam> </methodsynopsis> <para> - <function>hw_api_attribute->values</function> retourne toutes - les valeurs de l'attribut sous la forme d'un tableau de cha&icirc;nes. + Returns all values of the attribute as an array of strings. </para> <para> - Voir aussi - <function>hwapi_attribute_value</function>. + See also <function>hwapi_attribute_value</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-attribute.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-attribute.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-attribute.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-attribute.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-attribute.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-attribute"> <refnamediv> <refname>hw_api_attribute</refname> - <refpurpose>Cr&eacute;e une nouvelle instance de la classe hw_api_attribute</refpurpose> + <refpurpose>Creates instance of class hw_api_attribute</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -14,10 +14,7 @@ <methodparam choice="opt"><type>string</type><parameter>value</parameter></methodparam> </methodsynopsis> <para> - <function>hw_api_attribute->attribute</function> - cr&eacute;e une nouvelle instance de la classe - hw_api_attribute avec le nom <parameter>name</parameter> - et la valeur <parameter>value</parameter>. + Creates a new instance of hw_api_attribute with the given name and value. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-checkin.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-checkin.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-checkin.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-checkin.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-checkin.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-checkin"> <refnamediv> <refname>hw_api->checkin</refname> - <refpurpose>Archive un objet</refpurpose> + <refpurpose>Checks in an object</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -13,72 +13,70 @@ <methodparam><type>array</type><parameter>parameter</parameter></methodparam> </methodsynopsis> <para> - <methodname>hw_api->checkin</methodname> archive un objet ou - une hi&eacute;rarchie d'objets. Le param&egrave;tre obligatoire - <parameter>parameter</parameter> contient un 'objectIdentifier' - et les &eacute;l&eacute;ments optionnels 'version', 'comment', 'mode' et - 'objectQuery'. 'version' sp&eacute;cifie la version de l'objet. - Elle est constitu&eacute;e de version majeure et mineure, s&eacute;par&eacute;e par des - virgules. Si une version n'existe pas, la version mineure est incr&eacute;ment&eacute;e. - 'mode' peut &ecirc;tre l'une des constantes suivantes : + This function checks in an object or a whole hiearchie of objects. + The parameters array contains the required element + 'objectIdentifier' and the optional element 'version', 'comment', 'mode' + and + 'objectQuery'. 'version' sets the version of the object. It consists of + the major and minor version separated by a period. If the version is not + set, the minor version is incremented. 'mode' can be one of the following + values: <variablelist> <varlistentry> - <term><constant>HW_API_CHECKIN_NORMAL</constant></term> + <term>HW_API_CHECKIN_NORMAL</term> <listitem> <simpara> - Archive et valide l'objet. L'objet doit &ecirc;tre un document. + Checks in and commits the object. The object must be a document. </simpara> </listitem> </varlistentry> <varlistentry> - <term><constant>HW_API_CHECKIN_RECURSIVE</constant></term> + <term>HW_API_CHECKIN_RECURSIVE</term> <listitem> <simpara> - Si l'objet &agrave; archiver est une collection, tous les fils seront - v&eacute;rifi&eacute; r&eacute;cursivement, si ils sont des documents. Tenter d'archiver - une collectoin g&eacute;n&eacute;rera une erreur. + If the object to check in is a collection, all children will be + checked in recursively if they are documents. Trying to check in + a collection would result in an error. </simpara> </listitem> </varlistentry> <varlistentry> - <term><constant>HW_API_CHECKIN_FORCE_VERSION_CONTROL</constant></term> + <term>HW_API_CHECKIN_FORCE_VERSION_CONTROL</term> <listitem> <simpara> - Archive un objet m&ecirc;me si il ne passe pas sous le contr&ocirc;le de - versions. + Checks in an object even if it is not under version control. </simpara> </listitem> </varlistentry> <varlistentry> - <term><constant>HW_API_CHECKIN_REVERT_IF_NOT_CHANGED</constant></term> + <term>HW_API_CHECKIN_REVERT_IF_NOT_CHANGED</term> <listitem> <simpara> - V&eacute;rifie si il existe une version diff&eacute;rente de la derni&egrave;re version. - A moins que cela ne soit le cas, l'objet sera alors archiv&eacute;. + Check if the new version is different from the last version. Unless + this is the case the object will be checked in. </simpara> </listitem> </varlistentry> <varlistentry> - <term><constant>HW_API_CHECKIN_KEEP_TIME_MODIFIED</constant></term> + <term>HW_API_CHECKIN_KEEP_TIME_MODIFIED</term> <listitem> <simpara> - Conserve la date de modification du plus r&eacute;cent objet. + Keeps the time modified from the most recent object. </simpara> </listitem> </varlistentry> <varlistentry> - <term><constant>HW_API_CHECKIN_NO_AUTO_COMMIT</constant></term> + <term>HW_API_CHECKIN_NO_AUTO_COMMIT</term> <listitem> <simpara> - L'objet n'est pas automatiquement valid&eacute; lors de l'archivage. + The object is not automatically commited on checkin. </simpara> </listitem> </varlistentry> </variablelist> </para> <para> - Voir aussi - <function>hwapi_checkout</function>. + See also <function>hwapi_checkout</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-checkout.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-checkout.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-checkout.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-checkout.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-checkout.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-checkout"> <refnamediv> <refname>hw_api->checkout</refname> - <refpurpose>Extrait un objet</refpurpose> + <refpurpose>Checks out an object</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -13,17 +13,16 @@ <methodparam><type>array</type><parameter>parameter</parameter></methodparam> </methodsynopsis> <para> - <methodname>hw_api->checkout</methodname> extrait un objet ou - toute une hi&eacute;rarchie d'objets. Le param&egrave;tre <parameter>parameter</parameter> - contient l'&eacute;l&eacute;ment obligatoire 'objectIdentifier' et les &eacute;l&eacute;ments - optionnels 'version', 'mode' et 'objectQuery'. 'mode' peut prendre l'une des - valeurs suivantes : + This function checks out an object or a whole hiearchie of objects. + The parameters array contains the required element + 'objectIdentifier' and the optional element 'version', 'mode' + and 'objectQuery'. 'mode' can be one of the following values: <variablelist> <varlistentry> <term><constant>HW_API_CHECKIN_NORMAL</constant></term> <listitem> <simpara> - Extrait un objet. L'objet doit &ecirc;tre un document. + Checks out an object. The object must be a document. </simpara> </listitem> </varlistentry> @@ -31,17 +30,16 @@ <term><constant>HW_API_CHECKIN_RECURSIVE</constant></term> <listitem> <simpara> - Si l'objet &agrave; extraire est une collection, tous les fils seront - extraits r&eacute;cursivement, si ce sont des documents. Extraire une - collection g&eacute;n&eacute;rera une erreur. + If the object to check out is a collection, all children will be + checked out recursively if they are documents. Trying to check out + a collection would result in an error. </simpara> </listitem> </varlistentry> </variablelist> </para> <para> - Voir aussi - <function>hwapi_checkin</function>. + See also <function>hwapi_checkin</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-children.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-children.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-children.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-children.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-children.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-children"> <refnamediv> <refname>hw_api->children</refname> - <refpurpose>Retourne le fils d'un objet</refpurpose> + <refpurpose>Returns children of an object</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -13,19 +13,19 @@ <methodparam><type>array</type><parameter>parameter</parameter></methodparam> </methodsynopsis> <para> - <function>hw_api->children</function> retrouve le fils d'une collection - ou l'attribut d'un document. Le fils peut &ecirc;tre ensuite filtr&eacute; en - sp&eacute;cifiant une requ&ecirc;te d'objet. Le param&egrave;tre <parameter>parameter</parameter> - contient les &eacute;l&eacute;ments requis 'objectIdentifier' et les &eacute;l&eacute;ments - optionnels 'attributeSelector' et 'objectQuery'. + Retrieves the children of a collection or the attributes of a document. + The children can be further filtered by specifying an object query. + The parameter array + contains the required elements 'objectIdentifier' and the optional + elements 'attributeSelector' and 'objectQuery'. </para> <para> - La valeur retourn&eacute;e est un tableau d'objets de type - <classname>HW_API_Object</classname> ou + The return value is an array of objects of type + <classname>HW_API_Object</classname> or <classname>HW_API_Error</classname>. </para> <para> - Voir aussi <function>hwapi_parents</function>. + See also <function>hwapi_parents</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-content-mimetype.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-content-mimetype.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-content-mimetype.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-content-mimetype.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-content-mimetype.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-content-mimetype"> <refnamediv> <refname>hw_api_content->mimetype</refname> - <refpurpose>Retourne le type MIME</refpurpose> + <refpurpose>Returns mimetype</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -13,7 +13,7 @@ <methodparam><type>void</type><parameter></parameter></methodparam> </methodsynopsis> <para> - <methodname>hw_api_content->mimetype</methodname> retourne le type MIME du contenu. + Returns the mimetype of the content. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-content-read.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-content-read.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-content-read.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-content-read.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-content-read.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-content-read"> <refnamediv> <refname>hw_api_content->read</refname> - <refpurpose>Lit le contenu</refpurpose> + <refpurpose>Read content</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -14,8 +14,8 @@ <methodparam><type>integer</type><parameter>len</parameter></methodparam> </methodsynopsis> <para> - <function>hw_api_content->read</function> lit <parameter>len</parameter> octets dans le - buffer <parameter>buffer</parameter>. + Reads <parameter>len</parameter> bytes from the content into the given + buffer. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-content.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-content.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-content.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-content.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-content.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-content"> <refnamediv> <refname>hw_api->content</refname> - <refpurpose>Retourne le contenu d'un objet</refpurpose> + <refpurpose>Returns content of an object</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -13,22 +13,19 @@ <methodparam><type>array</type><parameter>parameter</parameter></methodparam> </methodsynopsis> <para> - <function>hw_api->content</function> retourne le contenu d'un - document sous la forme d'un objet de type - <classname>hw_api_content</classname>. Le param&egrave;tre - <parameter>parameter</parameter> est un tableau qui contient - l'&eacute;l&eacute;ment obligatoire 'objectidentifier' et l'&eacute;l&eacute;ment optionnel - 'mode'. Le mode peut &ecirc;tre l'une des constantes suivantes : + This function returns the content of a document as an object of type + <classname>hw_api_content</classname>. The parameter array + contains the required elements 'objectidentifier' and the optional + element 'mode'. The mode can be one of the constants <constant>HW_API_CONTENT_ALLLINKS</constant>, - <constant>HW_API_CONTENT_REACHABLELINKS</constant> ou + <constant>HW_API_CONTENT_REACHABLELINKS</constant> or <constant>HW_API_CONTENT_PLAIN</constant>. - <constant>HW_API_CONTENT_ALLLINKS</constant> signifie qu'il faut ins&eacute;rer - toutes les ancres m&ecirc;me si la destination n'est pas accessible. - <constant>HW_API_CONTENT_REACHABLELINKS</constant> indique &agrave; - <function>hw_api_content</function> qu'il faut ins&eacute;rer uniquement les - destinations accessibles, et - <constant>HW_API_CONTENT_PLAIN</constant> conduit &agrave; un document sans - aucun liens. + <constant>HW_API_CONTENT_ALLLINKS</constant> means to insert all + anchors even if the destination is not reachable. + <constant>HW_API_CONTENT_REACHABLELINKS</constant> tells + <function>hw_api_content</function> to insert only reachable links and + <constant>HW_API_CONTENT_PLAIN</constant> will lead to + document without any links. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-copy.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-copy.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-copy.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-copy.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-copy.xml Mon Jun 2 13:00:51 2003 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-copy"> <refnamediv> @@ -13,17 +13,15 @@ <methodparam><type>array</type><parameter>parameter</parameter></methodparam> </methodsynopsis> <para> - <function>hw_api->copy</function> fait une copie physique incluant - le contenu &eacute;ventuel, et retourne un nouvel objet, ou un objet d'erreur. - Le param&egrave;tre <parameter>parameter</parameter> est un tableau, qui - contient les &eacute;l&eacute;ments obligatoires 'objectIdentifier' et - 'destinationParentIdentifier' et l'&eacute;l&eacute;ment optionnel - 'attributeSelector'. + This function will make a physical copy including the content if it + exists and returns the new object or an error object. + The parameter array contains the + required elements 'objectIdentifier' and 'destinationParentIdentifier'. + The optional parameter is 'attributeSelector'` </para> <para> - Voir aussi - <function>hwapi_move</function> et - <function>hwapi_link</function>. + See also <function>hwapi_move</function>, + <function>hwapi_link</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-dbstat.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-dbstat.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-dbstat.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-dbstat.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-dbstat.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-dbstat"> <refnamediv> <refname>hw_api->dbstat</refname> - <refpurpose>Retourne des statistiques sur le serveur de bases</refpurpose> + <refpurpose>Returns statistics about database server</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -13,13 +13,11 @@ <methodparam><type>array</type><parameter>parameter</parameter></methodparam> </methodsynopsis> <para> - <function>dbstat</function> retourne des statistiques sur le serveur de bases. </para> <para> - Voir aussi - <function>hwapi_dcstat</function>, - <function>hwapi_hwstat</function> et - <function>hwapi_ftstat</function>. + See also <function>hwapi_dcstat</function>, + <function>hwapi_hwstat</function>, + <function>hwapi_ftstat</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-dcstat.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-dcstat.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-dcstat.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-dcstat.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-dcstat.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-dcstat"> <refnamediv> <refname>hw_api->dcstat</refname> - <refpurpose>Retourne des statistiques sur le serveur de cache de document</refpurpose> + <refpurpose>Returns statistics about document cache server</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -13,14 +13,11 @@ <methodparam><type>array</type><parameter>parameter</parameter></methodparam> </methodsynopsis> <para> - <function>hw_api->dcstat</function> retourne des statistiques sur - le serveur de cache de document. </para> <para> - Voir aussi - <function>hwapi_hwstat</function>, - <function>hwapi_dbstat</function> et - <function>hwapi_ftstat</function>. + See also <function>hwapi_hwstat</function>, + <function>hwapi_dbstat</function>, + <function>hwapi_ftstat</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-dstanchors.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-dstanchors.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-dstanchors.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-dstanchors.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-dstanchors.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-dstanchors"> <refnamediv> <refname>hw_api->dstanchors</refname> - <refpurpose>Liste toutes les ancres de destination</refpurpose> + <refpurpose>Returns a list of all destination anchors</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -13,14 +13,13 @@ <methodparam><type>array</type><parameter>parameter</parameter></methodparam> </methodsynopsis> <para> - <function>hw_api->dstanchors</function> liste toutes les ancres de - destination. Le param&egrave;tre <parameter>parameter</parameter> contient - l'&eacute;l&eacute;ment obligatoire 'objectIdentifier' et les &eacute;l&eacute;ments optionnels - 'attributeSelector' et 'objectQuery'. + Retrieves all destination anchors of an object. The parameter array + contains + the required element 'objectIdentifier' and the optional elements + 'attributeSelector' and 'objectQuery'. </para> <para> - Voir aussi - <function>hwapi_srcanchors</function>. + See also <function>hwapi_srcanchors</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-dstofsrcanchors.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-dstofsrcanchors.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-dstofsrcanchors.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-dstofsrcanchors.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-dstofsrcanchors.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-dstofsrcanchors"> <refnamediv> <refname>hw_api->dstofsrcanchors</refname> - <refpurpose>Retourne la destination d'une ancre source</refpurpose> + <refpurpose>Returns destination of a source anchor</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -13,18 +13,15 @@ <methodparam><type>array</type><parameter>parameter</parameter></methodparam> </methodsynopsis> <para> - <function>hw_api->dstofsrcanchors</function> retourne l'objet de destination - sur lequel pointe l'ancre source sp&eacute;cifi&eacute;e. L'objet de destination - peut &ecirc;tre une ancre de destination ou un document entier. - Le param&egrave;tre <parameter>parameter</parameter> contient - l'&eacute;l&eacute;ment obligatoire 'objectIdentifier' et le param&egrave;tre optionnel - 'attributeSelector'. + Retrieves the destination object pointed by the specified source anchors. + The destination object can either be a destination anchor or a whole + document. The parameters array contains the required element + 'objectIdentifier' and the optional element 'attributeSelector'. </para> <para> - Voir aussi - <function>hwapi_srcanchors</function>, - <function>hwapi_dstanchors</function> et - <function>hwapi_objectbyanchor</function>. + See also <function>hwapi_srcanchors</function>, + <function>hwapi_dstanchors</function>, + <function>hwapi_objectbyanchor</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-error-count.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-error-count.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-error-count.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-error-count.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-error-count.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-error-count"> <refnamediv> <refname>hw_api_error->count</refname> - <refpurpose>Retourne le nombre de raisons d'erreurs</refpurpose> + <refpurpose>Returns number of reasons</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -13,12 +13,10 @@ <methodparam><type>void</type><parameter></parameter></methodparam> </methodsynopsis> <para> - <function>hw_api_error->count</function> retourne le nombre - de raisons d'erreurs. + Returns the number of error reasons. </para> <para> - Voir aussi - <function>hwapi_error_reason</function>. + See also <function>hwapi_error_reason</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-error-reason.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-error-reason.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-error-reason.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-error-reason.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-error-reason.xml Mon Jun 2 13:00:51 2003 @@ -1,23 +1,22 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-error-reason"> <refnamediv> <refname>hw_api_error->reason</refname> - <refpurpose>Retourne la premi&egrave;re raison d'erreur</refpurpose> + <refpurpose>Returns reason of error</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> - <type>object</type><methodname>hw_api_error->reason</methodname> + <type>object</type><methodname>reason</methodname> <methodparam><type>void</type><parameter></parameter></methodparam> </methodsynopsis> <para> - <function>hw_api_error->reason</function> retourne la premi&egrave;re raison d'erreur. + Returns the first error reason. </para> <para> - Voir aussi - <function>hwapi_error_count</function>. + See also <function>hwapi_error_count</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-find.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-find.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-find.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-find.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-find.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-find"> <refnamediv> <refname>hw_api->find</refname> - <refpurpose>Recherche des objets</refpurpose> + <refpurpose>Search for objects</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -13,19 +13,17 @@ <methodparam><type>array</type><parameter>parameter</parameter></methodparam> </methodsynopsis> <para> - <function>hw_api->find</function> recherche des objets gr&acirc;ce &agrave; - leur cl&eacute; d'ex&eacute;cution et/ou gr&acirc;ce &agrave; une requ&ecirc;te en texte plein. Les - objets trouv&eacute;s peuvent alors &ecirc;tre filtr&eacute;s &agrave; nouveau par une requ&ecirc;te - optionnelle. Les objets sont tri&eacute;s par importance. La seconde - op&eacute;ration de recherche est relativement lente, et ses r&eacute;sultats peuvent - &ecirc;tre limit&eacute;s &agrave; certaines valeurs. Cela permet de r&eacute;aliser des recherches - incr&eacute;mentales, chacune retournant un sous ensemble de tous les - documents trouv&eacute;s, en partant d'un index donn&eacute;. Le param&egrave;tre - <parameter>parameter</parameter> est un tableau qui contient les - &eacute;l&eacute;ments obligatoires 'objectquery', 'scope', 'lanugages' et - 'attributeselector'. En cas de recherche incr&eacute;mentale, les &eacute;l&eacute;ments - optionnels 'startIndex', 'numberOfObjectsToGet' et 'exactMatchUnit' - peuvent aussi &ecirc;tre pass&eacute;s. + This functions searches for objects either by executing a key or/and full + text query. The found objects can further be filtered by an optional + object query. They are sorted by their importance. The second search + operation is relatively slow and its result can be limited to a certain + number of hits. This allows to perform an incremental search, each + returning just a subset of all found documents, starting at a given + index. The parameter array contains the 'keyquery' or/and 'fulltextquery' + depending on who you would like to search. Optional parameters are + 'objectquery', 'scope', 'lanugages' and 'attributeselector'. In case of + an incremental search the optional parameters 'startIndex', + numberOfObjectsToGet' and 'exactMatchUnit' can be passed. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-ftstat.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-ftstat.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-ftstat.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-ftstat.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-ftstat.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-ftstat"> <refnamediv> <refname>hw_api->ftstat</refname> - <refpurpose>Retourne des statistiques sur le serveur de textes</refpurpose> + <refpurpose>Returns statistics about fulltext server</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -13,13 +13,11 @@ <methodparam><type>array</type><parameter>parameter</parameter></methodparam> </methodsynopsis> <para> - <function>ftstat</function> retourne des statistiques sur le serveur de textes. </para> <para> - Voir aussi - <function>hwapi_dcstat</function>, - <function>hwapi_dbstat</function> et - <function>hwapi_hwstat</function>. + See also <function>hwapi_dcstat</function>, + <function>hwapi_dbstat</function>, + <function>hwapi_hwstat</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-hgcsp.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-hgcsp.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-hgcsp.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-hgcsp.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-hgcsp.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-hgcsp"> <refnamediv> <refname>hwapi_hgcsp</refname> - <refpurpose>Retourne un objet de classe hw_api</refpurpose> + <refpurpose>Returns object of class hw_api</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -14,14 +14,12 @@ <methodparam choice="opt"><type>int</type><parameter>port</parameter></methodparam> </methodsynopsis> <para> - <function>hwapi_hgcsp</function> ouvre une connexion - au serveur Hyperwave sur l'h&ocirc;te - <parameter>hostname</parameter>. Le protocole utilis&eacute; est - HGCSP. Si vous l'omettez, le port 418 sera utilis&eacute;. + Opens a connection to the Hyperwave server on host + <parameter>hostname</parameter>. The protocol used is HGCSP. + If you do not pass a port number, 418 is used. </para> <para> - Voir aussi - <function>hwapi_hwtp</function>. + See also <function>hwapi_hwtp</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-hwstat.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-hwstat.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-hwstat.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-hwstat.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-hwstat.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-hwstat"> <refnamediv> <refname>hw_api->hwstat</refname> - <refpurpose>Retourne les statistiques sur le serveur Hyperwave</refpurpose> + <refpurpose>Returns statistics about Hyperwave server</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -13,14 +13,11 @@ <methodparam><type>array</type><parameter>parameter</parameter></methodparam> </methodsynopsis> <para> - <methodname>hwstat</methodname> </para> - <function>hwstat</function> retourne les statistiques sur le serveur Hyperwave. <para> - Voir aussi - <function>hwapi_dcstat</function>, - <function>hwapi_dbstat</function> et - <function>hwapi_ftstat</function>. + See also <function>hwapi_dcstat</function>, + <function>hwapi_dbstat</function>, + <function>hwapi_ftstat</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-identify.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-identify.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-identify.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-identify.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-identify.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-identify"> <refnamediv> <refname>hw_api->identify</refname> - <refpurpose>S'identifie aupr&egrave;s du serveur Hyperwave</refpurpose> + <refpurpose>Log into Hyperwave Server</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -13,14 +13,13 @@ <methodparam><type>array</type><parameter>parameter</parameter></methodparam> </methodsynopsis> <para> - <function>hw_api->identify</function> s'identifie aupr&egrave;s du serveur - Hyperwave. Le param&egrave;tre <parameter>parameter</parameter> est un tableau - qui contient les &eacute;l&eacute;ments obligatoires 'username' et 'password'. + Logs into the Hyperwave Server. The parameter array must contain the + elements 'username' und 'password'. </para> <para> - La valeur retourn&eacute;e sera un objet du type - <classname>HW_API_Error</classname> si l'identification a &eacute;chou&eacute;, - ou bien &true; si cela a fonctionn&eacute;. + The return value will be an object of type + <classname>HW_API_Error</classname> if identification failed or TRUE + if it was successful. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-info.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-info.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-info.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-info.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-info.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-info"> <refnamediv> <refname>hw_api->info</refname> - <refpurpose>Retourne des information sur la configuration du serveur</refpurpose> + <refpurpose>Returns information about server configuration</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -13,15 +13,12 @@ <methodparam><type>array</type><parameter>parameter</parameter></methodparam> </methodsynopsis> <para> - <function>hw_api->info</function> retourne des information sur la configuration - du serveur. </para> <para> - Voir aussi - <function>hwapi_dcstat</function>, - <function>hwapi_dbstat</function>, - <function>hwapi_ftstat</function> et - <function>hwapi_hwstat</function>. + See also <function>hwapi_dcstat</function>, + <function>hwapi_dbstat</function>, + <function>hwapi_ftstat</function>, + <function>hwapi_hwstat</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-insert.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-insert.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-insert.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-insert.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-insert.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-insert"> <refnamediv> <refname>hw_api->insert</refname> - <refpurpose>Ins&egrave;re un nouvel objet</refpurpose> + <refpurpose>Inserts a new object</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -13,34 +13,33 @@ <methodparam><type>array</type><parameter>parameter</parameter></methodparam> </methodsynopsis> <para> - <function>hw_api->insert</function> ins&egrave;re un nouvel objet. Le type - d'objet peut &ecirc;tre user, group, document ou anchor. Suivant le type - de l'autre objet, des attributs suppl&eacute;mentaires doivent &ecirc;tre assign&eacute;s. - Le param&egrave;tre <parameter>parameter</parameter> est un tableau qui contient - les &eacute;l&eacute;ment obligatoires 'object' et 'content' (si l'objet est un - document) et les &eacute;l&eacute;ments optionnels 'parameters', 'mode' et 'attributeSelector'. - 'object' doit contenir tous les attributs de l'objet. - 'parameters' est un objet, qu contient les attributs suppl&eacute;mentaires, - comme ceux de destination (attribut 'Parent'). 'content' est une - combinaison des constantes suivantes : + Insert a new object. The object type can be user, group, document or + anchor. Depending on the type other object attributes has to be set. + The parameter array contains the required elements 'object' and 'content' + (if the object is a document) and the optional parameters 'parameters', + 'mode' and 'attributeSelector'. The 'object' must contain all attributes + of the object. 'parameters' is an object as well holding futher + attributes like the destination (attribute key is 'Parent'). 'content' is + the content of the document. 'mode' can be a + combination of the following flags: <variablelist> <varlistentry> <term><constant>HW_API_INSERT_NORMAL</constant></term> <listitem> <simpara> - L'object est inser&eacute; sur le serveur. + The object in inserted into the server. </simpara> </listitem> </varlistentry> <varlistentry> - <term><constant>HW_API_INSERT_FORCE-VERSION-CONTROL</constant></term> + <term><constant>HW_API_INSERT_FORCE_VERSION_CONTROL</constant></term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> - <term><constant>HW_API_INSERT_AUTOMATIC-CHECKOUT</constant></term> + <term><constant>HW_API_INSERT_AUTOMATIC_CHECKOUT</constant></term> <listitem> <simpara> </simpara> @@ -70,8 +69,7 @@ </variablelist> </para> <para> - Voir aussi - <function>hwapi_replace</function>. + See also <function>hwapi_replace</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-insertanchor.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-insertanchor.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-insertanchor.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-insertanchor.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-insertanchor.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-insertanchor"> <refnamediv> <refname>hw_api->insertanchor</refname> - <refpurpose>Ins&egrave;re un nouvel objet de type ancre</refpurpose> + <refpurpose>Inserts a new object of type anchor</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -13,23 +13,23 @@ <methodparam><type>array</type><parameter>parameter</parameter></methodparam> </methodsynopsis> <para> - <function>hw_api->insertanchor</function> est un raccourci pour - <function>hwapi_insert</function>. Elle ins&egrave;re un objet de type - ancre ('anchor') et assigne les attribus n&eacute;cessaires. - Le param&egrave;tre <parameter>parameter</parameter> contient les &eacute;l&eacute;ments obligatoires - 'object' et 'documentIdentifier' et les &eacute;l&eacute;ments optionnels - 'destinationIdentifier', 'parameter', 'hint' et 'attributeSelector'. - L'&eacute;l&eacute;ment 'documentIdentifier' sp&eacute;cifie le document d'insertion de l'ancre. - La cible de l'ancre est sp&eacute;cifi&eacute;e par 'destinationIdentifier' si il - existe. Si la cible n'existe pas, l'&eacute;l&eacute;ment 'hint' doit &ecirc;tre configur&eacute; - avec le nom de l'objet qui est pr&eacute;vu pour &ecirc;tre ins&eacute;r&eacute; ult&eacute;rieurement. - Une fois que l'insertion a &eacute;t&eacute; faite, la cible sera r&eacute;solue automatiquement. + This function is a shortcut for <function>hwapi_insert</function>. It + inserts an object of type anchor and sets some of the attributes + required + for an anchor. The parameter array contains the required elements + 'object' and 'documentIdentifier' and the optional elements + 'destinationIdentifier', 'parameter', 'hint' and 'attributeSelector'. + The 'documentIdentifier' + specifies the document where the anchor shall be inserted. The target of + the anchor is set in 'destinationIdentifier' if it already exists. If the + target does not exists the element 'hint' has to be set to the name of + object which is supposed to be inserted later. Once it is inserted the + anchor target is resolved automatically. </para> <para> - Voir aussi - <function>hwapi_insertdocument</function>, - <function>hwapi_insertcollection</function> et - <function>hwapi_insert</function>. + See also <function>hwapi_insertdocument</function>, + <function>hwapi_insertcollection</function>, + <function>hwapi_insert</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-insertcollection.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-insertcollection.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-insertcollection.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-insertcollection.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-insertcollection.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-insertcollection"> <refnamediv> <refname>hw_api->insertcollection</refname> - <refpurpose>Ins&egrave;re un nouvel objet de type collection</refpurpose> + <refpurpose>Inserts a new object of type collection</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -13,20 +13,18 @@ <methodparam><type>array</type><parameter>parameter</parameter></methodparam> </methodsynopsis> <para> - <function>hw_api->insertcollection</function> est un raccourci pour la fonction - <function>hwapi_insert</function>. Elle ins&egrave;re un objet de type - collection et lui assigne certains attributs obligatoires. - <parameter>parameter</parameter> est un tableau qui contient - les &eacute;l&eacute;ments obligatoires 'object' et 'parentIdentifier', et les - &eacute;l&eacute;ments optionnels 'parameter' et 'attributeSelector'. Voyez - <function>hwapi_insert</function> pour connaitre le d&eacute;tails de chaque - &eacute;l&eacute;ment. + This function is a shortcut for <function>hwapi_insert</function>. It + inserts an object of type collection and sets some of the attributes + required + for a collection. The parameter array contains the required elements + 'object' and 'parentIdentifier' and the optional elements + 'parameter' and 'attributeSelector'. See + <function>hwapi_insert</function> for the meaning of each element. </para> <para> - Voir aussi - <function>hwapi_insertdocument</function>, - <function>hwapi_insertanchor</function> et - <function>hwapi_insert</function>. + See also <function>hwapi_insertdocument</function>, + <function>hwapi_insertanchor</function>, + <function>hwapi_insert</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-insertdocument.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-insertdocument.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-insertdocument.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-insertdocument.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-insertdocument.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-insertdocument"> <refnamediv> <refname>hw_api->insertdocument</refname> - <refpurpose>Ins&egrave;re un nouvel objet de type document</refpurpose> + <refpurpose>Inserts a new object of type document</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -13,20 +13,17 @@ <methodparam><type>array</type><parameter>parameter</parameter></methodparam> </methodsynopsis> <para> - <function>hw_api->insertdocument</function> est un raccourci pour - <function>hwapi_insert</function>. Il ins&egrave;re un objet avec un contenu - et assigne certains attributs obligatoires. Le param&egrave;tre - <parameter>parameter</parameter> est un tableau qui contient - les &eacute;l&eacute;ments obligatoires 'object', 'parentIdentifier' et 'content' et - les &eacute;l&eacute;ments optionnels 'mode', 'parameter' et 'attributeSelector'. - Voyez <function>hwapi_insert</function> pour la signification de chacun - des &eacute;l&eacute;ments. + This function is a shortcut for <function>hwapi_insert</function>. It + inserts an object with content and sets some of the attributes required + for a document. The parameter array contains the required elements + 'object', 'parentIdentifier' and 'content' and the optional elements + 'mode', 'parameter' and 'attributeSelector'. See + <function>hwapi_insert</function> for the meaning of each element. </para> <para> - Voir aussi - <function>hwapi_insert</function> - <function>hwapi_insertanchor</function> et - <function>hwapi_insertcollection</function>. + See also <function>hwapi_insert</function> + <function>hwapi_insertanchor</function>, + <function>hwapi_insertcollection</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-link.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-link.xml:1.4 phpdoc/en/reference/hwapi/functions/hwapi-link.xml:1.5 --- phpdoc/en/reference/hwapi/functions/hwapi-link.xml:1.4 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-link.xml Mon Jun 2 13:00:51 2003 @@ -1,31 +1,28 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-link"> <refnamediv> <refname>hw_api->link</refname> - <refpurpose>Cr&eacute;e un lien avec un objet</refpurpose> + <refpurpose>Creates a link to an object</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> - <type>object</type><methodname>hw_api->link</methodname> + <type>object</type><methodname>link</methodname> <methodparam><type>array</type><parameter>parameter</parameter></methodparam> </methodsynopsis> <para> - <function>hw_api->link</function> cr&eacute;e un lien avec un objet. - Acc&eacute;der &agrave; ce lien revient &agrave; acc&eacute;der &agrave; l'objet vers lequel il pointe. - Le param&egrave;tre <parameter>parameter</parameter> contient les - &eacute;l&eacute;ments obligatoires de 'objectIdentifier' et 'destinationParentIdentifier'. - 'destinationParentIdentifier' est la collection de destination. + Creates a link to an object. Accessing this link is like accessing the + object to links points to. The parameter array contains the required + elements 'objectIdentifier' and 'destinationParentIdentifier'. + 'destinationParentIdentifier' is the target collection. </para> <para> - <function>hw_api->link</function> retourne &true; en cas de succ&egrave;s, - et sinon, un objet d'erreur. + The function returns &true; on success or an error object. </para> <para> - Voir aussi - <function>hwapi_copy</function>. + See also <function>hwapi_copy</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-lock.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-lock.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-lock.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-lock.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-lock.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-lock"> <refnamediv> <refname>hw_api->lock</refname> - <refpurpose>Verrouille un objet</refpurpose> + <refpurpose>Locks an object</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -13,22 +13,21 @@ <methodparam><type>array</type><parameter>parameter</parameter></methodparam> </methodsynopsis> <para> - <function>hw_api->lock</function> verrouille un objet pour le faire - &eacute;diter exclusivement par l'utilisateur qui appelle cette fonction. - L'objet ne peut &ecirc;tre d&eacute;verrouill&eacute; que par cet utilisateur ou par le - syst&egrave;me. Le param&egrave;tre <parameter>parameter</parameter> est un tableau - qui contient l'&eacute;l&eacute;ment obligatoire 'objectIdentifier' et les param&egrave;tres - optionnels 'mode' et 'objectquery'. 'mode' d&eacute;termine comment l'objet - est verrouill&eacute;. <constant>HW_API_LOCK_NORMAL</constant> signifie que le - 'objet est verrouill&eacute; jusqu'&agrave; son d&eacute;verrouillage. - <constant>HW_API_LOCK_RECURSIVE</constant> est uniquement valide pour une collection - et verrouille tous les objets de la collexion et des sous-collections. - <constant>HW_API_LOCK_SESSION</constant> signifie que l'objet est verrouill&eacute; - aussi longtemps que tient la session en cours. + Locks an object for exclusive editing by the user calling this function. + The object can be only unlocked by this user or the sytem user. The + parameter array contains the required element 'objectIdentifier' and the + optional parameters 'mode' and 'objectquery'. + 'mode' determines how an object is locked. + <constant>HW_API_LOCK_NORMAL</constant> means, + an object is locked until it is unlocked. + <constant>HW_API_LOCK_RECURSIVE</constant> + is only valid for collection and locks all objects + within th collection und possible subcollections. + <constant>HW_API_LOCK_SESSION</constant> means, an + object is locked only as long as the session is valid. </para> <para> - Voir aussi - <function>hwapi_unlock</function>. + See also <function>hwapi_unlock</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-move.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-move.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-move.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-move.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-move.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-move"> <refnamediv> <refname>hw_api->move</refname> - <refpurpose>D&eacute;place un objet d'une collection &agrave; l'autre</refpurpose> + <refpurpose>Moves object between collections</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -13,12 +13,9 @@ <methodparam><type>array</type><parameter>parameter</parameter></methodparam> </methodsynopsis> <para> - <function>hw_api->move</function> d&eacute;place un objet d'une collection - &agrave; l'autre. </para> <para> - Voir aussi - <function>hw_objrec2array</function>. + See also <function>hw_objrec2array</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-new-content.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-new-content.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-new-content.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-new-content.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-new-content.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-new-content"> <refnamediv> - <refname>hw_api->content</refname> - <refpurpose>Cr&eacute;e une nouvelle instance de la classe hw_api_content</refpurpose> + <refname>hw_api_content</refname> + <refpurpose>Create new instance of class hw_api_content</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -14,8 +14,8 @@ <methodparam><type>string</type><parameter>mimetype</parameter></methodparam> </methodsynopsis> <para> - <function>hw_api-></function> cr&eacute;e un nouvel objet de contenu &agrave; partir de la cha&icirc;ne - <parameter>content</parameter>. Le type MIME utilis&eacute; est + Creates a new content object from the string + <parameter>content</parameter>. The mimetype is set to <parameter>mimetype</parameter>. </para> </refsect1> Index: phpdoc/en/reference/hwapi/functions/hwapi-object-assign.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-object-assign.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-object-assign.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-object-assign.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-object-assign.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-object-assign"> <refnamediv> <refname>hw_api_object->assign</refname> - <refpurpose>Clone un objet</refpurpose> + <refpurpose>Clones object</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -13,7 +13,7 @@ <methodparam><type>array</type><parameter>parameter</parameter></methodparam> </methodsynopsis> <para> - <function>hw_api_object->assign</function> clone les attributs d'un objet. + Clones the attributes of an object. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-object-attreditable.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-object-attreditable.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-object-attreditable.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-object-attreditable.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-object-attreditable.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-object-attreditable"> <refnamediv> <refname>hw_api_object->attreditable</refname> - <refpurpose>V&eacute;rifie si un attribut est &eacute;ditable</refpurpose> + <refpurpose>Checks whether an attribute is editable</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -13,8 +13,6 @@ <methodparam><type>array</type><parameter>parameter</parameter></methodparam> </methodsynopsis> <para> - <function>hw_api_object->attreditable</function> v&eacute;rifie si un - attribut est &eacute;ditable. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-object-count.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-object-count.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-object-count.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-object-count.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-object-count.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-object-count"> <refnamediv> <refname>hw_api_object->count</refname> - <refpurpose>Retourne le nombre d'attributs</refpurpose> + <refpurpose>Returns number of attributes</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -13,7 +13,6 @@ <methodparam><type>array</type><parameter>parameter</parameter></methodparam> </methodsynopsis> <para> - <function>hw_api_object->count</function> retourne le nombre d'attributs. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-object-insert.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-object-insert.xml:1.4 phpdoc/en/reference/hwapi/functions/hwapi-object-insert.xml:1.5 --- phpdoc/en/reference/hwapi/functions/hwapi-object-insert.xml:1.4 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-object-insert.xml Mon Jun 2 13:00:51 2003 @@ -1,26 +1,23 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-object-insert"> <refnamediv> <refname>hw_api_object->insert</refname> - <refpurpose>Ins&egrave;re un nouvel attribut HyperWave</refpurpose> + <refpurpose>Inserts new attribute</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> - <type>bool</type><methodname>hw_api_object->insert</methodname> + <type>bool</type><methodname>insert</methodname> <methodparam><type>object</type><parameter>attribute</parameter></methodparam> </methodsynopsis> <para> - <function>hw_api_object->insert</function> ajoute l'attribut - <parameter>attribute</parameter> &agrave; l'objet courant. - <function>hw_api_object->insert</function> - retourne &true; en cas de succ&egrave;s, et sinon, &false;. + Adds an attribute to the object. Returns &true; on success and otherwise + &false;. </para> <para> - Voir aussi - <function>hwapi_object_remove</function>. + See also <function>hwapi_object_remove</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-object-new.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-object-new.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-object-new.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-object-new.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-object-new.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-object-new"> <refnamediv> <refname>hw_api_object</refname> - <refpurpose>Cr&eacute;e une nouvelle instance de la classe hw_api_object</refpurpose> + <refpurpose>Creates a new instance of class hw_api_object</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -13,12 +13,9 @@ <methodparam><type>array</type><parameter>parameter</parameter></methodparam> </methodsynopsis> <para> - <function>hw_api_object</function> cr&eacute;e une nouvelle instance - de la classe <classname>hw_api_object</classname>. </para> <para> - Voir aussi - <function>hwapi_lock</function>. + See also <function>hwapi_lock</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-object-remove.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-object-remove.xml:1.4 phpdoc/en/reference/hwapi/functions/hwapi-object-remove.xml:1.5 --- phpdoc/en/reference/hwapi/functions/hwapi-object-remove.xml:1.4 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-object-remove.xml Mon Jun 2 13:00:51 2003 @@ -1,26 +1,23 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-object-remove"> <refnamediv> <refname>hw_api_object->remove</refname> - <refpurpose>Supprime un attribut HyperWave</refpurpose> + <refpurpose>Removes attribute</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> - <type>bool</type><methodname>hw_api_object->remove</methodname> + <type>bool</type><methodname>remove</methodname> <methodparam><type>string</type><parameter>name</parameter></methodparam> </methodsynopsis> <para> - <function>hw_api_object->remove</function> supprime l'attribut - de nom <parameter>name</parameter> dans l'objet courant. - <function>hw_api_object->remove</function> retourne &true; en - cas de succ&egrave;s, et &false; sinon. + Removes the attribute with the given name. Returns &true; on success + and otherwise &false;. </para> <para> - Voir aussi - <function>hwapi_object_insert</function>. + See also <function>hwapi_object_insert</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-object-title.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-object-title.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-object-title.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-object-title.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-object-title.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-object-title"> <refnamediv> <refname>hw_api_object->title</refname> - <refpurpose>Retourne le titre de l'attribut</refpurpose> + <refpurpose>Returns the title attribute</refpurpose> </refnamediv> <refsect1> <title>Description</title> Index: phpdoc/en/reference/hwapi/functions/hwapi-object-value.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-object-value.xml:1.4 phpdoc/en/reference/hwapi/functions/hwapi-object-value.xml:1.5 --- phpdoc/en/reference/hwapi/functions/hwapi-object-value.xml:1.4 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-object-value.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-object-value"> <refnamediv> <refname>hw_api_object->value</refname> - <refpurpose>Retourne la valeur de l'attribut</refpurpose> + <refpurpose>Returns value of attribute</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -13,8 +13,8 @@ <methodparam><type>string</type><parameter>name</parameter></methodparam> </methodsynopsis> <para> - <function>hw_api_object->value</function> retourne la valeur de l'attribut - <parameter>name</parameter>, ou bien &false; si une erreur est survenue. + Returns the value of the attribute with the given name or &false; if an + error occured. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-object.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-object.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-object.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-object.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-object.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-object"> <refnamediv> <refname>hw_api->object</refname> - <refpurpose>Lit les informations d'attribut</refpurpose> + <refpurpose>Retrieve attribute information</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -13,22 +13,20 @@ <methodparam><type>array</type><parameter>parameter</parameter></methodparam> </methodsynopsis> <para> - <function>hw_api->object</function> lit les informations d'attributs - d'un objet de n'importe quelle version. Elle ne retournera pas le - contenu du document. Le param&egrave;tre <parameter>parameter</parameter> - est un tableau qui contient l'&eacute;l&eacute;ment obligatoire - 'objectIdentifier' et les &eacute;l&eacute;ments optionnels - 'attributeSelector' et 'version'. + This function retrieves the attribute information of an object of any + version. It will not return the document content. The parameter array + contains the required elements 'objectIdentifier' and the optional + elements 'attributeSelector' and 'version'. </para> <para> - L'objet retourn&eacute; est une instance de la classe - <classname>HW_API_Object</classname> en cas de succ&egrave;s ou - <classname>HW_API_Error</classname> en cas d'erreur. + The returned object is an instance of class + <classname>HW_API_Object</classname> on success or + <classname>HW_API_Error</classname> if an error occured. </para> <para> - Cet exemple simple lit un objet et v&eacute;rifie les erreurs. + This simple example retrieves an object and checks for errors. <example> - <title>Lit un objet Hyperwave et le v&eacute;rifie</title> + <title>Retrieve an object</title> <programlisting role="php"> <![CDATA[ <?php @@ -37,17 +35,17 @@ echo "Type: <B>"; switch($reason->type()) { case 0: - echo "Erreur"; + echo "Error"; break; case 1: - echo "Alerte"; + echo "Warning"; break; case 2: echo "Message"; break; } echo "</B><BR>\n"; - echo "Description : ".$reason->description("en")."<BR>\n"; + echo "Description: ".$reason->description("en")."<BR>\n"; } function list_attr($obj) { @@ -75,8 +73,7 @@ </example> </para> <para> - Voir aussi - <function>hwapi_content</function>. + See also <function>hwapi_content</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-objectbyanchor.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-objectbyanchor.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-objectbyanchor.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-objectbyanchor.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-objectbyanchor.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-objectbyanchor"> <refnamediv> <refname>hw_api->objectbyanchor</refname> - <refpurpose>Retourne l'objet propri&eacute;taire d'une ancre</refpurpose> + <refpurpose>Returns the object an anchor belongs to</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -13,16 +13,14 @@ <methodparam><type>array</type><parameter>parameter</parameter></methodparam> </methodsynopsis> <para> - <function>hw_api->objectbyanchor</function> retourne l'objet qui contient - une ancre donn&eacute;e. Le param&egrave;tre <parameter>parameter</parameter> est un - tableau qui contient l'&eacute;l&eacute;ment obligatoire 'objectIdentifier' et - l'&eacute;l&eacute;ment optionnel 'attributeSelector'. + This function retrieves an object the specified anchor belongs to. + The parameter array contains the required element 'objectIdentifier' and + the optional element 'attributeSelector'. </para> <para> - Voir aussi - <function>hwapi_dstofsrcanchor</function>, - <function>hwapi_srcanchors</function> et - <function>hwapi_dstanchors</function>. + See also <function>hwapi_dstofsrcanchor</function>, + <function>hwapi_srcanchors</function>, + <function>hwapi_dstanchors</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-parents.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-parents.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-parents.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-parents.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-parents.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-parents"> <refnamediv> <refname>hw_api->parents</refname> - <refpurpose>Retourne le parent d'un objet</refpurpose> + <refpurpose>Returns parents of an object</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -13,20 +13,18 @@ <methodparam><type>array</type><parameter>parameter</parameter></methodparam> </methodsynopsis> <para> - <function>hw_api->parents</function> lit le parent d'un objet. - Le parent peut &ecirc;tre filtr&eacute;s en sp&eacute;cifiant un objet de requ&ecirc;te. - Le param&egrave;tre <parameter>parameter</parameter> est un tableau qui - contient l'&eacute;l&eacute;ment obligatoire 'objectidentifier' et les - &eacute;l&eacute;ments optionnels 'attributeselector' et 'objectquery'. + Retrieves the parents of an object. The parents can be further filtered by + specifying an object query. The parameter array + contains the required elements 'objectidentifier' and the + optional elements 'attributeselector' and 'objectquery'. </para> <para> - La valeur retourn&eacute;e est un tableau d'objets de type - <classname>HW_API_Object</classname> ou + The return value is an array of objects of type + <classname>HW_API_Object</classname> or <classname>HW_API_Error</classname>. </para> <para> - Voir aussi - <function>hwapi_children</function>. + See also <function>hwapi_children</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-reason-description.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-reason-description.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-reason-description.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-reason-description.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-reason-description.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-reason-description"> <refnamediv> <refname>hw_api_reason->description</refname> - <refpurpose>Retourne la description d'une raison</refpurpose> + <refpurpose>Returns description of reason</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -13,8 +13,7 @@ <methodparam><type>void</type><parameter></parameter></methodparam> </methodsynopsis> <para> - <function>hw_api_reason->description</function> retourne la description - d'une raison. + Returns the description of a reason </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-reason-type.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-reason-type.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-reason-type.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-reason-type.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-reason-type.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-reason-type"> <refnamediv> <refname>hw_api_reason->type</refname> - <refpurpose>Retourne le type de raison</refpurpose> + <refpurpose>Returns type of reason</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -13,7 +13,7 @@ <methodparam><type>void</type><parameter></parameter></methodparam> </methodsynopsis> <para> - <function>hw_api_reason->type</function> retourne le type de raison. + Returns the type of a reason. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-remove.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-remove.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-remove.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-remove.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-remove.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-remove"> <refnamediv> <refname>hw_api->remove</refname> - <refpurpose>Efface un objet</refpurpose> + <refpurpose>Delete an object</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -13,24 +13,22 @@ <methodparam><type>array</type><parameter>parameter</parameter></methodparam> </methodsynopsis> <para> - <function>hw_api->remove</function> efface un objet avec un parent - sp&eacute;cifique. Les collections seront effac&eacute;es r&eacute;cursivement. Vous pouvez - passez un objet optionnel de requ&ecirc;te pour filtrer les objets qui - seront filtr&eacute;s. Un objet sera effac&eacute; physiquement si c'est sa derni&egrave;re - instance. Le param&egrave;tre <parameter>parameter</parameter> est un tableau - qui contient les &eacute;l&eacute;ments obligatoires 'objectidentifier' et 'parentidentifier'. - Si vous souhaitez effacer un utilisateur ou un gropue, 'parentidentifier' - peut &ecirc;tre omis. L'&eacute;l&eacute;ment optionnel 'mode' d&eacute;termine comme l'effacement - est r&eacute;alis&eacute;. En mode normal, l'objet sera effac&eacute; phyisiquement lorsque - toutes ses instances seront supprim&eacute;es. En mode physique, toutes les - instances d'un objet seront supprim&eacute;es imm&eacute;diatement. En mode - removelinks toutes les r&eacute;f&eacute;rences vers et depuis l'objet seront aussi - effac&eacute;es. En mode nonrecursive, l'effacement n'est pas r&eacute;cusrsif. - Effacer une collection qui n'est pas vide causera une erreur. + Removes an object from the specified parent. Collections + will be removed recursively. You can pass an optional object query to + remove only those objects which match the query. An object will be + deleted physically if it is the last instance. The parameter array + contains the required elements 'objectidentifier' and 'parentidentifier'. + If you want to remove a user or group 'parentidentifier' can be skiped. + The optional parameter 'mode' determines how the deletion is performed. + In normal mode the object will not be removed physically until all + instances are removed. In physical mode all instances of the object will + be deleted imediately. In removelinks mode all references + to and from the objects will be deleted as well. In nonrecursive the + deletion is not performed recursive. Removing a collection which is not + empty will cause an error. </para> <para> - Voir aussi - <function>hwapi_move</function>. + See also <function>hwapi_move</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-replace.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-replace.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-replace.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-replace.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-replace.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-replace"> <refnamediv> <refname>hw_api->replace</refname> - <refpurpose>Remplace un objet</refpurpose> + <refpurpose>Replaces an object</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -13,24 +13,21 @@ <methodparam><type>array</type><parameter>parameter</parameter></methodparam> </methodsynopsis> <para> - <function>hw_api->replace</function> remplace les attributs et le - contenu d'un bjet. Le param&egrave;tre <parameter>parameter</parameter> - est un tableau qui contient les &eacute;l&eacute;ments obligatoires - 'objectIdentifier' et 'object' et les param&egrave;tres optionnels - 'content', 'parameters', 'mode' et 'attributeSelector'. 'objectIdentifier' - contient l'objet qui doit &ecirc;tre remplac&eacute;. 'object' contient le nouvel - objet. 'content' contient le nouveau contenu. 'parameters' contient des - informations suppl&eacute;mentaires pour les documents HTML. - HTML_Language est l'abbr&eacute;vation de la langue pour le titre. - HTML_Base est l'attribut de base pour le contenu du document HTML. 'mode' - peut &ecirc;tre la combinaison de l'une des constantes suivantes : + Replaces the attributes and the content of an object The parameter array + contains the required elements 'objectIdentifier' and 'object' and + the optional parameters 'content', 'parameters', 'mode' and + 'attributeSelector'. 'objectIdentifier' contains the object to be + replaced. 'object' contains the new object. 'content' contains the new + content. 'parameters' contain extra information for HTML documents. + HTML_Language is the letter abbreviation of the language of the title. + HTML_Base sets the base attribute of the HTML document. 'mode' can be a + combination of the following flags: <variablelist> <varlistentry> <term><constant>HW_API_REPLACE_NORMAL</constant></term> <listitem> <simpara> - L'objet sur le serveur est remplac&eacute; par l'objet - pass&eacute;. + The object on the server is replace with the object passed. </simpara> </listitem> </varlistentry> @@ -79,8 +76,7 @@ </variablelist> </para> <para> - Voir aussi - <function>hwapi_insert</function>. + See also <function>hwapi_insert</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-setcommitedversion.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-setcommitedversion.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-setcommitedversion.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-setcommitedversion.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-setcommitedversion.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-setcommitedversion"> <refnamediv> <refname>hw_api->setcommitedversion</refname> - <refpurpose>Valide une version autre que la derni&egrave;re</refpurpose> + <refpurpose>Commits version other than last version</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -13,15 +13,14 @@ <methodparam><type>array</type><parameter>parameter</parameter></methodparam> </methodsynopsis> <para> - <function>hw_api->setcommitedversion</function> valide une version du document. - La version valid&eacute;e est celle qui est visible aux utilisateurs ayant un - acc&egrave;s en lecture. Par d&eacute;faut, la derni&egrave;re version est celle qui est valid&eacute;e. + Commits a version of a docuemnt. The commited version is the one which is + visible to users with read access. By default the last version is the + commited version. </para> <para> - Voir aussi - <function>hwapi_checkin</function>, - <function>hwapi_checkout</function> et - <function>hwapi_revert</function>. + See also <function>hwapi_checkin</function>, + <function>hwapi_checkout</function>, + <function>hwapi_revert</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-srcanchors.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-srcanchors.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-srcanchors.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-srcanchors.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-srcanchors.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-srcanchors"> <refnamediv> <refname>hw_api->srcanchors</refname> - <refpurpose>Retourne la liste de toutes les ancres</refpurpose> + <refpurpose>Returns a list of all source anchors</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -13,14 +13,12 @@ <methodparam><type>array</type><parameter>parameter</parameter></methodparam> </methodsynopsis> <para> - <function>hw_api->srcanchors</function> lit toutes les ancres sources d'un objet. - Le param&egrave;tre <parameter>parameter</parameter> est un tableau qui contient l'&eacute;l&eacute;ment - obligatoire 'objectIdentifier' et les &eacute;l&eacute;ments optionels - 'attributeSelector' wr 'objectQuery'. + Retrieves all source anchors of an object. The parameter array contains + the required element 'objectIdentifier' and the optional elements + 'attributeSelector' and 'objectQuery'. </para> <para> - Voir aussi - <function>hwapi_dstanchors</function>. + See also <function>hwapi_dstanchors</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-srcsofdst.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-srcsofdst.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-srcsofdst.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-srcsofdst.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-srcsofdst.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-srcsofdst"> <refnamediv> <refname>hw_api->srcsofdst</refname> - <refpurpose>Retourne les sources d'un objet de destination</refpurpose> + <refpurpose>Returns source of a destination object</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -13,16 +13,14 @@ <methodparam><type>array</type><parameter>parameter</parameter></methodparam> </methodsynopsis> <para> - <function>hw_api->srcsofdst</function> retourne les sources d'un objet - de destination. L'objet de destination peut &ecirc;tre une ancre ou un document - complet. Le param&egrave;tre <parameter>parameter</parameter> est un tableau - qui contient l'&eacute;l&eacute;ment obligatoire 'objectIdentifier' et les &eacute;l&eacute;ments optionnels - 'attributeSelector' et 'objectQuery'. La fonction retourne un tableau - d'objet ou une erreur. + Retrieves all the source anchors pointing to the specified destination. + The destination object can either be a destination anchor or a whole + document. The parameters array contains the required element + 'objectIdentifier' and the optional element 'attributeSelector' and + 'objectQuery'. The function returns an array of objects or an error. </para> <para> - Voir aussi - <function>hwapi_dstofsrcanchor</function>. + See also <function>hwapi_dstofsrcanchor</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-unlock.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-unlock.xml:1.4 phpdoc/en/reference/hwapi/functions/hwapi-unlock.xml:1.5 --- phpdoc/en/reference/hwapi/functions/hwapi-unlock.xml:1.4 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-unlock.xml Mon Jun 2 13:00:51 2003 @@ -1,34 +1,29 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-unlock"> <refnamediv> <refname>hw_api->unlock</refname> - <refpurpose>D&eacute;verrouille un objet HyperWave verrouill&eacute;</refpurpose> + <refpurpose>Unlocks a locked object</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> - <type>object</type><methodname>hw_api->unlock</methodname> + <type>object</type><methodname>unlock</methodname> <methodparam><type>array</type><parameter>parameter</parameter></methodparam> </methodsynopsis> <para> - <function>hw_api->unlock</function> d&eacute;verrouille un objet verrouill&eacute;. - Seul, l'utilisateur qui a verrouill&eacute; un objet et l'administrateur - syst&egrave;me, peuvent le d&eacute;verrouiller. Le param&egrave;tre <parameter>parameter</parameter> - est un tableau qui contient les &eacute;l&eacute;ments obligatoires de - <literal>objectIdentifier</literal> et les param&egrave;tres optionnels - de <literal>mode</literal> et <literal>objectquery</literal>. La - signification de <literal>mode</literal> est la m&ecirc;me que dans la - fonction <function>hwapi_lock</function>. + Unlocks a locked object. Only the user who has locked the object and the + system user may unlock an object. The parameter array contains the + required element 'objectIdentifier' and the optional parameters + 'mode' and 'objectquery'. The meaning of 'mode' is the same as in + function <function>hwapi_lock</function>. </para> <para> - <function>hw_api->unlock</function> retourne &true; en cas de - succ&egrave;s, et sinon, un objet d'erreur HW_API_Error. + Returns &true; on success or an object of class HW_API_Error. </para> <para> - Voir aussi - <function>hwapi_lock</function>. + See also <function>hwapi_lock</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-user.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-user.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-user.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-user.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-user.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-user"> <refnamediv> <refname>hw_api->user</refname> - <refpurpose>Retourne le propri&eacute;taire d'un objet</refpurpose> + <refpurpose>Returns the own user object</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -13,11 +13,9 @@ <methodparam><type>array</type><parameter>parameter</parameter></methodparam> </methodsynopsis> <para> - <function>hw_api->user</function> retourne le propri&eacute;taire d'un objet. </para> <para> - Voir aussi - <function>hwapi_userlist</function>. + See also <function>hwapi_userlist</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/hwapi/functions/hwapi-userlist.xml diff -u phpdoc/en/reference/hwapi/functions/hwapi-userlist.xml:1.3 phpdoc/en/reference/hwapi/functions/hwapi-userlist.xml:1.4 --- phpdoc/en/reference/hwapi/functions/hwapi-userlist.xml:1.3 Mon Jun 2 12:43:27 2003 +++ phpdoc/en/reference/hwapi/functions/hwapi-userlist.xml Mon Jun 2 13:00:51 2003 @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1' ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-userlist"> <refnamediv> <refname>hw_api->userlist</refname> - <refpurpose>Retourne la liste des utilisateurs connect&eacute;s</refpurpose> + <refpurpose>Returns a list of all logged in users</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -13,12 +13,9 @@ <methodparam><type>array</type><parameter>parameter</parameter></methodparam> </methodsynopsis> <para> - <function>hw_api->userlist</function> retourne la liste des - utilisateurs connect&eacute;s. </para> <para> - Voir aussi - <function>hwapi_user</function>. + See also <function>hwapi_user</function>. </para> </refsect1> </refentry>