From 04e007443b95d48a34167b958c600844964162ab Mon Sep 17 00:00:00 2001
From: Daniel Beckham <danbeck@php.net>
Date: Thu, 17 May 2001 22:40:32 +0000
Subject: [PATCH] clarified analog clock description and reference to CLibPDF,
 fixed return type of PDF_findfont, put PDF_open_memory_image in aphanumeric
 order and converted some of the function names from pdf_ to PDF_

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@47729 c90b9560-bf6c-de11-be94-00142212c4b1
---
 functions/pdf.xml | 173 ++++++++++++++++++++++++++--------------------
 1 file changed, 97 insertions(+), 76 deletions(-)

diff --git a/functions/pdf.xml b/functions/pdf.xml
index b17464c5f4..877a22d474 100644
--- a/functions/pdf.xml
+++ b/functions/pdf.xml
@@ -293,12 +293,11 @@ readfile($filename);
     </para>
     <para>
      The PDFlib distribution contains a more complex example which
-     creates a page with an analog clock. Here we use
-     the in memory creation feature of PDFlib, so we don't need
-     any tmp-files.  This example
-     converted into PHP using PDFlib looks as the following (you
-     can see the same example in the documentation for the
-     <link linkend="ref.cpdf">clibpdf module)</link>:
+     creates a page with an analog clock. Here we use the in memory
+     creation feature of PDFlib to alleviate the need to use temporary
+     files. The example, converted to PHP from the PDFlib example, is
+     as follows: (The same example is available in the <link
+     linkend="ref.cpdf">CLibPDF</link> documentation.)
     </para>
     <para>
      <example>
@@ -536,7 +535,7 @@ PDF_delete($pdf);
 
   <refentry id="function.pdf-add-outline">
    <refnamediv>
-    <refname>pdf_add_outline</refname>
+    <refname>PDF_add_outline</refname>
     <refpurpose>Deprecated: Adds bookmark for current page</refpurpose>
    </refnamediv>
    <refsect1>
@@ -1151,7 +1150,7 @@ PDF_delete($pdf);
     <title>Description</title>
     <funcsynopsis>
      <funcprototype>
-      <funcdef>void <function>PDF_findfont</function></funcdef>
+      <funcdef>int <function>PDF_findfont</function></funcdef>
       <paramdef>int <parameter>pdf object</parameter></paramdef>
       <paramdef>string <parameter>fontname</parameter></paramdef>
       <paramdef>string <parameter>encoding^</parameter></paramdef>
@@ -1165,6 +1164,25 @@ PDF_delete($pdf);
        "macroman", "winansi", "host", or a user-defined encoding name,
        or the name of a CMap.
     </para>
+   <para>
+    <function>PDF_findfont</function> returns a font handle or false
+    on error.
+   </para>
+   <para>
+    <example>
+     <title><function>PDF_findfont</function> example</title>
+     <programlisting role="php">
+&lt;php
+
+$font = pdf_findfont($pdf, "Times New Roman", "winansi", 1);
+if ($font) {
+    pdf_setfont($pdf, $font, 10);
+}
+
+?&gt;
+     </programlisting>
+    </example>
+   </para>
    </refsect1>
   </refentry>
 
@@ -1470,7 +1488,7 @@ PDF_delete($pdf);
 
   <refentry id="function.pdf-open">
    <refnamediv>
-    <refname>pdf_open</refname>
+    <refname>PDF_open</refname>
     <refpurpose>Deprecated: Open a new pdf object</refpurpose>
    </refnamediv>
    <refsect1>
@@ -1656,6 +1674,47 @@ echo $data;
    </refsect1>
   </refentry>
 
+ <refentry id="function.pdf-open-memory-image">
+  <refnamediv>
+   <refname>PDF_open_memory_image</refname>
+   <refpurpose>Opens an image created with PHP's image functions</refpurpose>
+  </refnamediv>
+  <refsect1>
+   <title>Description</title>
+   <funcsynopsis>
+    <funcprototype>
+     <funcdef>int <function>PDF_open_memory_image</function></funcdef>
+     <paramdef>int <parameter>pdf object</parameter></paramdef>
+     <paramdef>int <parameter>image</parameter></paramdef>
+    </funcprototype>
+   </funcsynopsis>
+   <para>
+    The <function>PDF_open_memory_image</function> function takes
+    an image created with the PHP's image functions and makes it available
+    for the pdf object. The function returns a pdf
+    image identifier.
+    
+    <example>
+     <title>Including a memory image</title>
+     <programlisting>
+&lt;?php
+$im = ImageCreate(100, 100);
+$col = ImageColorAllocate($im, 80, 45, 190);
+ImageFill($im, 10, 10, $col);
+$pim = PDF_open_memory_image($pdf, $im);
+ImageDestroy($im);
+PDF_place_image($pdf, $pim, 100, 100, 1);
+PDF_close_image($pdf, $pim);
+?>
+     </programlisting>
+    </example></para>
+   <para>
+    See also <function>PDF_close_image</function>,
+    <function>PDF_place_image</function>.</para>
+  </refsect1>
+ </refentry>
+
+
   <refentry id="function.pdf-open-pdi">
     <refnamediv>
       <refname>PDF_open_pdi</refname>
@@ -1963,28 +2022,31 @@ echo $data;
    </refsect1>
   </refentry>
 
-  <refentry id="function.pdf-setfont">
-   <refnamediv>
-    <refname>PDF_setfont</refname>
-    <refpurpose>Set the current font</refpurpose>
-   </refnamediv>
-   <refsect1>
-    <title>Description</title>
-    <funcsynopsis>
-     <funcprototype>
-      <funcdef>void <function>PDF_setfont</function></funcdef>
-      <paramdef>int <parameter>pdf object</parameter></paramdef>
-      <paramdef>int <parameter>font</parameter></paramdef>
-      <paramdef>double <parameter>size</parameter></paramdef>
-     </funcprototype>
-    </funcsynopsis>
-    <para>
-      Set the current font in the given size, using a
-      <parameter>font</parameter> handle returned by
-      <function>PDF_findfont</function>
-    </para>
-   </refsect1>
-  </refentry>
+ <refentry id="function.pdf-setfont">
+  <refnamediv>
+   <refname>PDF_setfont</refname>
+   <refpurpose>Set the current font</refpurpose>
+  </refnamediv>
+  <refsect1>
+   <title>Description</title>
+   <funcsynopsis>
+    <funcprototype>
+     <funcdef>void <function>PDF_setfont</function></funcdef>
+     <paramdef>int <parameter>pdf object</parameter></paramdef>
+     <paramdef>int <parameter>font</parameter></paramdef>
+     <paramdef>double <parameter>size</parameter></paramdef>
+    </funcprototype>
+   </funcsynopsis>
+   <para>
+    Set the current font in the given size, using a
+    <parameter>font</parameter> handle returned by
+    <function>PDF_findfont</function>
+   </para>
+   <para>
+    See Also: <function>PDF_findfont</function>.
+   </para>
+  </refsect1>
+ </refentry>
 
   <refentry id="function.pdf-setgray">
    <refnamediv>
@@ -2351,7 +2413,7 @@ echo $data;
 
   <refentry id="function.pdf-set-duration">
    <refnamediv>
-    <refname>pdf_set_duration</refname>
+    <refname>PDF_set_duration</refname>
     <refpurpose>Deprecated: Sets duration between pages</refpurpose>
    </refnamediv>
    <refsect1>
@@ -2505,7 +2567,7 @@ echo $data;
 
   <refentry id="function.pdf-set-text-rise">
    <refnamediv>
-    <refname>pdf_set_text_rise</refname>
+    <refname>PDF_set_text_rise</refname>
     <refpurpose>Deprecated: Sets the text rise</refpurpose>
    </refnamediv>
    <refsect1>
@@ -2521,7 +2583,7 @@ echo $data;
 
   <refentry id="function.pdf-set-transition">
    <refnamediv>
-    <refname>pdf_set_text_matrix</refname>
+    <refname>PDF_set_text_matrix</refname>
     <refpurpose>Deprecated: Sets the text matrix</refpurpose>
    </refnamediv>
    <refsect1>
@@ -2555,7 +2617,7 @@ echo $data;
 
   <refentry id="function.pdf-set-word-spacing">
    <refnamediv>
-    <refname>pdf_set_word_spacing</refname>
+    <refname>PDF_set_word_spacing</refname>
     <refpurpose>Depriciated: Sets spacing between words</refpurpose>
    </refnamediv>
    <refsect1>
@@ -2725,47 +2787,6 @@ echo $data;
    </refsect1>
   </refentry>
 
-  <refentry id="function.pdf-open-memory-image">
-   <refnamediv>
-    <refname>PDF_open_memory_image</refname>
-    <refpurpose>Opens an image created with PHP's image functions</refpurpose>
-   </refnamediv>
-   <refsect1>
-    <title>Description</title>
-    <funcsynopsis>
-     <funcprototype>
-      <funcdef>int <function>PDF_open_memory_image</function></funcdef>
-      <paramdef>int <parameter>pdf object</parameter></paramdef>
-      <paramdef>int <parameter>image</parameter></paramdef>
-     </funcprototype>
-    </funcsynopsis>
-    <para>
-     The <function>PDF_open_memory_image</function> function takes
-     an image created with the PHP's image functions and makes it available
-     for the pdf object. The function returns a pdf
-     image identifier.
-
-     <example>
-      <title>Including a memory image</title>
-      <programlisting>
-&lt;?php
-$im = ImageCreate(100, 100);
-$col = ImageColorAllocate($im, 80, 45, 190);
-ImageFill($im, 10, 10, $col);
-$pim = PDF_open_memory_image($pdf, $im);
-ImageDestroy($im);
-PDF_place_image($pdf, $pim, 100, 100, 1);
-PDF_close_image($pdf, $pim);
-?>
-     </programlisting>
-    </example></para>
-
-    <para>
-     See also <function>PDF_close_image</function>,
-              <function>PDF_place_image</function>.</para>
-   </refsect1>
-  </refentry>
-
  </reference>
 
 <!-- Keep this comment at the end of the file