php-doc-en/reference/cpdf/functions/cpdf-add-outline.xml
Mehdi Achour 7218bcc708 updating protos
fixed missing params
added role to programlisting
added para arround the examples
added one example and a note about the rgb values (users notes)
WS for the See Also
using cpdf.ul; as shorthand


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@137849 c90b9560-bf6c-de11-be94-00142212c4b1
2003-08-15 14:29:05 +00:00

67 lines
2 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 -->
<refentry id="function.cpdf-add-outline">
<refnamediv>
<refname>cpdf_add_outline</refname>
<refpurpose>Adds bookmark for current page</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>cpdf_add_outline</methodname>
<methodparam><type>int</type><parameter>pdf_document</parameter></methodparam>
<methodparam><type>int</type><parameter>lastoutline</parameter></methodparam>
<methodparam><type>int</type><parameter>sublevel</parameter></methodparam>
<methodparam><type>int</type><parameter>open</parameter></methodparam>
<methodparam><type>int</type><parameter>pagenr</parameter></methodparam>
<methodparam><type>string</type><parameter>text</parameter></methodparam>
</methodsynopsis>
<para>
The <function>cpdf_add_outline</function> function adds a bookmark
with text <parameter>text</parameter> that points to the current page.
</para>
<para>
<example>
<title>Adding a page outline</title>
<programlisting role="php">
<![CDATA[
<?php
$cpdf = cpdf_open(0);
cpdf_page_init($cpdf, 1, 0, 595, 842);
cpdf_add_outline($cpdf, 0, 0, 0, 1, "Page 1");
// ...
// some drawing
// ...
cpdf_finalize($cpdf);
Header("Content-type: application/pdf");
cpdf_output_buffer($cpdf);
cpdf_close($cpdf);
?>
]]>
</programlisting>
</example>
</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
-->