<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 -->
<refentry xml:id="function.ps-add-bookmark" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ps_add_bookmark</refname>
  <refpurpose>Add bookmark to current page</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>ps_add_bookmark</methodname>
   <methodparam><type>resource</type><parameter>psdoc</parameter></methodparam>
   <methodparam><type>string</type><parameter>text</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>parent</parameter><initializer>0</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>open</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   Adds a bookmark for the current page. Bookmarks usually appear in
   PDF-Viewers left of the page in a hierarchical tree. Clicking on a
   bookmark will jump to the given page.
  </para>
  &ps.note.visible;
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>psdoc</parameter></term>
     <listitem>
      <para>
       Resource identifier of the postscript file
       as returned by <function>ps_new</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>text</parameter></term>
     <listitem>
      <para>
       The text used for displaying the bookmark.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>parent</parameter></term>
     <listitem>
      <para>
       A bookmark previously created by this function which
       is used as the parent of the new bookmark.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>open</parameter></term>
     <listitem>
      <para>
       If <parameter>open</parameter> is unequal to zero the bookmark will
       be shown open by the pdf viewer.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   The returned value is a reference for the bookmark. It is only used if
   the bookmark shall be used as a parent. The value is greater zero if
   the function succeeds. In case of an error zero will
   be returned.
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ps_add_launchlink</function></member>
    <member><function>ps_add_pdflink</function></member>
    <member><function>ps_add_weblink</function></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
-->

