diff --git a/functions/pdf.xml b/functions/pdf.xml index 8f4662c403..b17464c5f4 100644 --- a/functions/pdf.xml +++ b/functions/pdf.xml @@ -6,59 +6,64 @@ Introduction - You can use the PDF functions in PHP to create PDF files if you - have the PDF library by Thomas Merz (available at - &url.pdf;; - you will also need the JPEG library - and the TIFF library to - compile this. These two librariess can often cause problems when - configuring PHP, so be sure to pay attention to the output of - the configure script and fix any problems it reports. + The PDF functions in PHP can create PDF files using the PDFlib + library created by Thomas + Merz. PDFlib is available at &url.pdf;. The JPEG and TIFF libraries are required to compile + this extension. Please see the PDFlib installation + section for more information about compiling PDF support into PHP. - Please consult the documentation for PDFlib shipped with + Please consult the documentation for PDFlib included with the source distribution of PDFlib. It provides a very good overview of what PDFlib is capable of doing and contains the full - and most up-to-date description of all functions. + and most up-to-date documentation of all functions. - All of the functions in PDFlib and the PHP module have the same name. - The parameters are also identical. - You should also understand some of the concepts of PDF - or PostScript to efficiently use this module. - All lengths and coordinates are measured in PostScript points. - There are generally 72 PostScript points to an inch, but this - depends on the output resolution. + All of the functions in PDFlib and the PHP module have identical + function names and parameters. You will need to understand some + of the basic concepts of PDF and PostScript to efficiently use + this extension. All lengths and coordinates are measured in + PostScript points. There are generally 72 PostScript points to an + inch, but this depends on the output resolution. Please see the + PDFlib documentation included with the source distribution of + PDFlib for a more thorough explanation of the coordinate system + used. - - There is another PHP module for PDF document creation based on - FastIO's. - ClibPDF. It has a slightly different API. Check the - ClibPDF functions section for - details. - - - The PDF module introduces one new type of variable. - It is called a pdf object and - almost all functions need a pdf object - as its first parameter. - + + Please note that most of the PDF functions require a + pdf object as it's first parameter. Please + see the examples below for more information. + + + + An alternative PHP module for PDF document creation based on + FastIO's ClibPDF is + available. Please see the ClibPDF + section for details. Note that ClibPDF has a slightly different API + compared to PDFlib. + + - Confusion with old PDFlib versions - - Starting with PHP 4.0.5, the PHP extension for PDFlib is officially - supported by PDFlib GmbH. This means that all the functions - described in the PDFlib-manual (V3.00 or greater) are supported by - PHP 4 with exactly the same meaning and the same parameters. - Only the return values may differ from the PDFlib manual, because - the PHP convention of returning false was adopted. - For compatibility reasons this binding for - PDFlib still supports the old functions, but as stated above - they should be replaced by their new versions. PDFlib GmbH will not - support any problems arising from the use of these deprecated - functions. - + Confusion with old PDFlib versions + + Starting with PHP 4.0.5, the PHP extension for PDFlib is + officially supported by PDFlib GmbH. This means that all the + functions described in the PDFlib manual (V3.00 or greater) are + supported by PHP 4 with exactly the same meaning and the same + parameters. Only the return values may differ from the PDFlib + manual, because the PHP convention of returning + false was adopted. For compatibility reasons + this binding for PDFlib still supports the old functions, but they + should be replaced by their new versions. PDFlib GmbH will not + support any problems arising from the use of these deprecated + functions. + Deprecated functions and its replacements @@ -219,10 +224,10 @@ - Hints for installation of PDFlib 3.x + PDFlib 3.x Installation Hints - Since version 3.0 of PDFlib you should configure PDFlib with the option - --enable-shared-pdflib. + When using version 3.x of PDFlib, you should configure PDFlib + with the option --enable-shared-pdflib. @@ -232,7 +237,7 @@ of PDFlib older than 3.0. - PDFlib 3.0 or greater is also supported by PHP 3.0.19 and later. + PDFlib 3.0 or greater is supported by PHP 3.0.19 and later.