<?xml version='1.0' encoding='iso-8859-1' ?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.hwapi-insertdocument">
 <refnamediv>
  <refname>hw_api->insertdocument</refname>
  <refpurpose>Inserts a new object of type document</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <classsynopsis>
   <ooclass><classname>hw_api</classname></ooclass>
   <methodsynopsis>
    <type>hw_api_object</type><methodname>insertdocument</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 with content and sets some of the attributes required
   for a document. 
  </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',
       'parentIdentifier' and 'content' and the optional elements 'mode',
       'parameter' and 'attributeSelector'. 
      </para>
      <para>
       See <function>hwapi_insert</function> for the meaning of each element.
      </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-insertcollection" /></member>
    <member><xref linkend="function.hwapi-insertanchor" /></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
-->