cvs: phpdoc /en/reference/pdf reference.xml

betz Wed Aug 7 06:00:31 2002 EDT Modified files: /phpdoc/en/reference/pdf reference.xml Log: new structure applied Index: phpdoc/en/reference/pdf/reference.xml diff -u phpdoc/en/reference/pdf/reference.xml:1.2 phpdoc/en/reference/pdf/reference.xml:1.3 --- phpdoc/en/reference/pdf/reference.xml:1.2 Mon Apr 15 17:57:13 2002 +++ phpdoc/en/reference/pdf/reference.xml Wed Aug 7 06:00:29 2002 @@ -1,23 +1,16 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <reference id="ref.pdf"> <title>PDF functions </title> <titleabbrev>PDF</titleabbrev> <partintro> <section id="pdf.intro"> - <title>Introduction</title> + &reftitle.intro; <simpara> The PDF functions in PHP can create PDF files using the PDFlib library created by <ulink url="&url.pdflib.merz;">Thomas - Merz</ulink>. PDFlib is available for download at <ulink - url="&url.pdf;">&url.pdf;</ulink>, but requires that you purchase - a license for commercial use. The <ulink - url="&url.jpeg;">JPEG</ulink> and <ulink - url="&url.tiff;">TIFF</ulink> libraries are required to compile - this extension. Please see the <link - linkend="install.configure.with-pdflib">PDFlib installation</link> - section for more information about compiling PDF support into PHP. + Merz</ulink>. </simpara> <simpara> The documentation in this section is only meant to be an overview @@ -39,22 +32,58 @@ PDFlib for a more thorough explanation of the coordinate system used. </simpara> - <simpara> - Please note that most of the PDF functions require a - <parameter>pdf object</parameter> as it's first parameter. Please - see the examples below for more information. - </simpara> - <note> + <simpara> + Please note that most of the PDF functions require a + <parameter>pdf object</parameter> as it's first parameter. Please + see the <link linkend="pdf.examples">examples</link> below for more + information. + </simpara> + </section> + + <section id="pdf.requirenments"> + &reftitle.required; + <para> + PDFlib is available for download at <ulink + url="&url.pdf;">&url.pdf;</ulink>, but requires that you purchase + a license for commercial use. The <ulink + url="&url.jpeg;">JPEG</ulink> and <ulink + url="&url.tiff;">TIFF</ulink> libraries are required to compile + this extension. + </para> + <section id="pdf.install.pdflib"> + <title>PDFlib 3.x Installation Hints</title> + <simpara> + When using version 3.x of PDFlib, you should configure PDFlib + with the option <literal>--enable-shared-pdflib</literal>. + </simpara> + </section> + <section id="pdf.oldlibs.hints"> + <title>Issues with older versions of PDFlib</title> + <simpara> + Any version of PHP 4 after March 9, 2000 does not support versions + of PDFlib older than 3.0. + </simpara> + <simpara> + PDFlib 3.0 or greater is supported by PHP 3.0.19 and later. + </simpara> + </section> + </section> + + <section id="pdf.installation"> + &reftitle.install; <para> - An alternative PHP module for PDF document creation based on - <ulink url="&url.cpdf;">FastIO's</ulink> ClibPDF is - available. Please see the <link linkend="ref.cpdf">ClibPDF</link> - section for details. Note that <link - linkend="ref.cpdf">ClibPDF</link> has a slightly different API - compared to PDFlib. + Please see the <link + linkend="install.configure.with-pdflib">PDFlib installation</link> + section for more information about compiling PDF support into PHP. </para> - </note> </section> + + <section id="pdf.configuration"> + &reftitle.runtime; + &no.config; + </section> + + <section id="pdf.oldlibs.confusion"> <title>Confusion with old PDFlib versions</title> <simpara> @@ -176,12 +205,12 @@ <row> <entry><function>pdf_open</function></entry> <entry><function>pdf_new</function> plus an subsequent call - of <function>pdf_open_file</function></entry> + of <function>pdf_open_file</function></entry> </row> <row> <entry><function>pdf_set_font</function></entry> <entry><function>pdf_findfont</function> plus an subsequent call - of <function>pdf_setfont</function></entry> + of <function>pdf_setfont</function></entry> </row> <row> <entry><function>pdf_set_duration</function></entry> @@ -225,25 +254,9 @@ </table> </para> </section> - <section id="pdf.install.pdflib"> - <title>PDFlib 3.x Installation Hints</title> - <simpara> - When using version 3.x of PDFlib, you should configure PDFlib - with the option <literal>--enable-shared-pdflib</literal>. - </simpara> - </section> - <section id="pdf.oldlibs.hints"> - <title>Issues with older versions of PDFlib</title> - <simpara> - Any version of PHP 4 after March 9, 2000 does not support versions - of PDFlib older than 3.0. - </simpara> - <simpara> - PDFlib 3.0 or greater is supported by PHP 3.0.19 and later. - </simpara> - </section> + <section id="pdf.examples"> - <title>Examples</title> + &reftitle.examples; <simpara> Most of the functions are fairly easy to use. The most difficult part is probably creating a very simple PDF document at all. The following @@ -420,6 +433,21 @@ </example> </para> </section> + + <section id="pdf.seealso"> + &reftitle.seealso; + <note> + <para> + An alternative PHP module for PDF document creation based on + <ulink url="&url.cpdf;">FastIO's</ulink> ClibPDF is + available. Please see the <link linkend="ref.cpdf">ClibPDF</link> + section for details. Note that <link + linkend="ref.cpdf">ClibPDF</link> has a slightly different API + compared to PDFlib. + </para> + </note> + </section> + </partintro> &reference.pdf.functions;