mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 02:48:56 +00:00
41744b84ad
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297058 c90b9560-bf6c-de11-be94-00142212c4b1
87 lines
2.5 KiB
XML
87 lines
2.5 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<!-- $Revision$ -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.hwapi-insertanchor">
|
|
<refnamediv>
|
|
<refname>hw_api->insertanchor</refname>
|
|
<refpurpose>Inserts a new object of type anchor</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<classsynopsis>
|
|
<ooclass><classname>hw_api</classname></ooclass>
|
|
<methodsynopsis>
|
|
<type>hw_api_object</type><methodname>insertanchor</methodname>
|
|
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
|
</methodsynopsis>
|
|
</classsynopsis>
|
|
<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.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>parameter</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
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>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><xref linkend="function.hwapi-insert" /></member>
|
|
<member><xref linkend="function.hwapi-insertdocument" /></member>
|
|
<member><xref linkend="function.hwapi-insertcollection" /></member>
|
|
</simplelist>
|
|
</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:"~/.phpdoc/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
|
|
-->
|