php-doc-en/reference/hwapi/functions/hwapi-insertanchor.xml

<?xml version='1.0' encoding='iso-8859-1' ?>
<!-- $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>Inserts a new object of type anchor</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <methodsynopsis>
     <type>object</type><methodname>insertanchor</methodname>
     <methodparam><type>array</type><parameter>parameter</parameter></methodparam>
    </methodsynopsis>
    <para>
     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>
     See also <function>hwapi_insertdocument</function>,
              <function>hwapi_insertcollection</function>,
              <function>hwapi_insert</function>.
    </para>
   </refsect1>
  </refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->