mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 14:28:56 +00:00
06d026fec8
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@189156 c90b9560-bf6c-de11-be94-00142212c4b1
117 lines
3.2 KiB
XML
117 lines
3.2 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.3 $ -->
|
|
<!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 -->
|
|
<refentry id="function.ps-add-bookmark">
|
|
<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></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>open</parameter></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>
|
|
<para>
|
|
The bookmark has no meaning if the document is printed or viewed but it
|
|
will be used if the document is converted to pdf by either
|
|
Acrobat Distiller™ or Ghostview.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>psdoc</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>text</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>parent</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The parameter <parameter>parent</parameter> is another bookmark 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.
|
|
</para>
|
|
<para>
|
|
Returns the identifier of the bookmark or zero in case of an error. The
|
|
identifier is a positive number.
|
|
</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:"../../../../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
|
|
-->
|
|
|