cvs: phpdoc /en/reference/pdf configure.xml reference.xml /en/reference/pdf/functions pdf-activate-item.xml pdf-add-annotation.xml
pdf-add-bookmark.xml pdf-add-bookmark2.xml pdf-add-launchlink.xml pdf-add-locallink.xml pdf-add-nameddest.xml pdf-add-note.xml pdf-add-note2.xml
pdf-add-outline.xml pdf-add-pdflink.xml pdf-add-thumbnail.xml pdf-add-weblink.xml pdf-arc.xml pdf-arcn.xml pdf-attach-file.xml pdf-attach-file2.xml
pdf-begin-document.xml pdf-begin-font.xml pdf-begin-glyph.xml pdf-begin-item.xml pdf-begin-layer.xml pdf-begin-page-ext.xml pdf-begin-page.xml
pdf-begin-pattern.xml pdf-begin-template.xml pdf-circle.xml pdf-clip.xml pdf-close-image.xml pdf-close-pdi-page.xml pdf-close-pdi.xml pdf-close.xml
pdf-closepath-fill-stroke.xml pdf-closepath-stroke.xml pdf-closepath.xml pdf-concat.xml pdf-continue-text.xml pdf-create-action.xml
pdf-create-annotation.xml pdf-create-bookmark.xml pdf-create-field.xml pdf-create-fieldgroup.xml pdf-create-gstate.xml pdf-create-pvf.xml
pdf-create-textflow.xml pdf-curveto.xml pdf-define-layer.xml pdf-delete-pvf.xml pdf-delete-textflow.xml pdf-delete.xml pdf-encoding-set-char.xml
pdf-end-document.xml pdf-end-font.xml pdf-end-glyph.xml pdf-end-item.xml pdf-end-layer.xml pdf-end-page-ext.xml pdf-end-page.xml pdf-end-pattern.xml
pdf-end-template.xml pdf-endpath.xml pdf-fill-imageblock.xml pdf-fill-pdfblock.xml pdf-fill-stroke.xml pdf-fill-textblock.xml pdf-fill.xml
pdf-findfont.xml pdf-fit-image.xml pdf-fit-pdi-page.xml pdf-fit-textflow.xml pdf-fit-textline.xml pdf-get-apiname.xml pdf-get-buffer.xml
pdf-get-errmsg.xml pdf-get-errnum.xml pdf-get-font.xml pdf-get-fontname.xml pdf-get-fontsize.xml pdf-get-image-height.xml pdf-get-image-width.xml
pdf-get-majorversion.xml pdf-get-minorversion.xml pdf-get-parameter.xml pdf-get-pdi-parameter.xml pdf-get-pdi-value.xml pdf-get-value.xml
pdf-info-textflow.xml pdf-initgraphics.xml pdf-lineto.xml pdf-load-font.xml pdf-load-iccprofile.xml pdf-load-image.xml pdf-makespotcolor.xml
pdf-moveto.xml pdf-new.xml pdf-open-ccitt.xml pdf-open-file.xml pdf-open-gif.xml pdf-open-image-file.xml pdf-open-image.xml pdf-open-jpeg.xml
pdf-open-memory-image.xml pdf-open-pdi-page.xml pdf-open-pdi.xml pdf-open-png.xml pdf-open-tiff.xml pdf-open.xml pdf-place-image.xml
pdf-place-pdi-page.xml pdf-process-pdi.xml pdf-rect.xml pdf-restore.xml pdf-resume-page.xml pdf-rotate.xml pdf-save.xml pdf-scale.xml
pdf-set-border-color.xml pdf-set-border-dash.xml pdf-set-border-style.xml pdf-set-char-spacing.xml pdf-set-duration.xml pdf-set-font.xml
pdf-set-gstate.xml pdf-set-horiz-scaling.xml pdf-set-info-author.xml pdf-set-info-creator.xml pdf-set-info-keywords.xml pdf-set-info-subject.xml
pdf-set-info-title.xml pdf-set-info.xml pdf-set-layer-dependency.xml pdf-set-leading.xml pdf-set-parameter.xml pdf-set-text-matrix.xml
pdf-set-text-pos.xml pdf-set-text-rendering.xml pdf-set-text-rise.xml pdf-set-value.xml pdf-set-word-spacing.xml pdf-setcolor.xml pdf-setdash.xml
pdf-setdashpattern.xml pdf-setflat.xml pdf-setfont.xml pdf-setgray-fill.xml pdf-setgray-stroke.xml pdf-setgray.xml pdf-setlinecap.xml
pdf-setlinejoin.xml pdf-setlinewidth.xml pdf-setmatrix.xml pdf-setmiterlimit.xml pdf-setpolydash.xml pdf-setrgbcolor-fill.xml
pdf-setrgbcolor-stroke.xml pdf-setrgbcolor.xml pdf-shading-pattern.xml pdf-shading.xml pdf-shfill.xml pdf-show-boxed.xml pdf-show-xy.xml pdf-show.xml
pdf-skew.xml pdf-stringwidth.xml pdf-stroke.xml pdf-suspend-page.xml pdf-translate.xml pdf-utf16-to-utf8.xml pdf-utf8-to-utf16.xml pdf-xshow.xml

katja Thu Dec 8 08:45:08 2005 EDT Added files: /phpdoc/en/reference/pdf/functions pdf-get-errmsg.xml pdf-set-layer-dependency.xml pdf-load-image.xml pdf-load-iccprofile.xml pdf-fill-pdfblock.xml pdf-fit-textflow.xml pdf-fit-image.xml pdf-info-textflow.xml pdf-begin-document.xml pdf-create-fieldgroup.xml pdf-end-item.xml pdf-define-layer.xml pdf-create-action.xml pdf-begin-layer.xml pdf-begin-page-ext.xml pdf-create-gstate.xml pdf-delete-pvf.xml pdf-load-font.xml pdf-begin-font.xml pdf-activate-item.xml pdf-begin-glyph.xml pdf-add-note2.xml pdf-attach-file2.xml pdf-create-pvf.xml pdf-fit-textline.xml pdf-utf8-to-utf16.xml pdf-delete-textflow.xml pdf-suspend-page.xml pdf-end-document.xml pdf-get-errnum.xml pdf-encoding-set-char.xml pdf-create-field.xml pdf-add-bookmark2.xml pdf-fit-pdi-page.xml pdf-utf16-to-utf8.xml pdf-end-layer.xml pdf-shading-pattern.xml pdf-create-textflow.xml pdf-resume-page.xml pdf-setdashpattern.xml pdf-shfill.xml pdf-end-glyph.xml pdf-end-page-ext.xml pdf-shading.xml pdf-begin-item.xml pdf-add-nameddest.xml pdf-create-annotation.xml pdf-fill-textblock.xml pdf-create-bookmark.xml pdf-xshow.xml pdf-end-font.xml pdf-get-apiname.xml pdf-process-pdi.xml pdf-set-gstate.xml pdf-fill-imageblock.xml Modified files: /phpdoc/en/reference/pdf/functions pdf-set-border-style.xml pdf-delete.xml pdf-moveto.xml pdf-open-pdi.xml pdf-get-parameter.xml pdf-get-minorversion.xml pdf-circle.xml pdf-add-annotation.xml pdf-open-png.xml pdf-show-xy.xml pdf-set-leading.xml pdf-get-image-height.xml pdf-setpolydash.xml pdf-set-horiz-scaling.xml pdf-setmatrix.xml pdf-setlinecap.xml pdf-setgray-fill.xml pdf-get-pdi-value.xml pdf-save.xml pdf-add-locallink.xml pdf-fill.xml pdf-curveto.xml pdf-setdash.xml pdf-get-fontname.xml pdf-close.xml pdf-show.xml pdf-open-ccitt.xml pdf-set-duration.xml pdf-add-weblink.xml pdf-endpath.xml pdf-end-template.xml pdf-setlinewidth.xml pdf-set-info-title.xml pdf-arc.xml pdf-lineto.xml pdf-continue-text.xml pdf-stringwidth.xml pdf-set-info-subject.xml pdf-setfont.xml pdf-setgray-stroke.xml pdf-fill-stroke.xml pdf-set-parameter.xml pdf-open.xml pdf-get-image-width.xml pdf-get-buffer.xml pdf-setcolor.xml pdf-setgray.xml pdf-open-jpeg.xml pdf-add-pdflink.xml pdf-setflat.xml pdf-initgraphics.xml pdf-begin-page.xml pdf-end-page.xml pdf-rotate.xml pdf-show-boxed.xml pdf-setrgbcolor-stroke.xml pdf-closepath.xml pdf-open-gif.xml pdf-set-text-matrix.xml pdf-begin-template.xml pdf-set-value.xml pdf-set-info.xml pdf-begin-pattern.xml pdf-closepath-stroke.xml pdf-clip.xml pdf-open-tiff.xml pdf-scale.xml pdf-setrgbcolor-fill.xml pdf-translate.xml pdf-close-pdi.xml pdf-get-font.xml pdf-place-pdi-page.xml pdf-concat.xml pdf-set-info-author.xml pdf-set-word-spacing.xml pdf-add-note.xml pdf-set-text-rendering.xml pdf-add-thumbnail.xml pdf-restore.xml pdf-set-border-dash.xml pdf-setmiterlimit.xml pdf-get-fontsize.xml pdf-set-char-spacing.xml pdf-set-border-color.xml pdf-attach-file.xml pdf-get-value.xml pdf-arcn.xml pdf-open-image-file.xml pdf-add-outline.xml pdf-findfont.xml pdf-skew.xml pdf-set-text-rise.xml pdf-end-pattern.xml pdf-open-memory-image.xml pdf-stroke.xml pdf-open-image.xml pdf-rect.xml pdf-setrgbcolor.xml pdf-set-info-keywords.xml pdf-set-info-creator.xml pdf-set-font.xml pdf-new.xml pdf-close-pdi-page.xml pdf-add-launchlink.xml pdf-close-image.xml pdf-setlinejoin.xml pdf-makespotcolor.xml pdf-get-pdi-parameter.xml pdf-set-text-pos.xml pdf-add-bookmark.xml pdf-place-image.xml pdf-closepath-fill-stroke.xml pdf-open-file.xml pdf-open-pdi-page.xml pdf-get-majorversion.xml /phpdoc/en/reference/pdf configure.xml reference.xml Log: update or add pdf functions

http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-set-border-style.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-set-border-style.xml diff -u phpdoc/en/reference/pdf/functions/pdf-set-border-style.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-set-border-style.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-set-border-style.xml:1.4 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-set-border-style.xml Thu Dec 8 08:45:01 2005 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-set-border-style"> <refnamediv> <refname>pdf_set_border_style</refname> - <refpurpose>Sets style of border around links and annotations</refpurpose> + <refpurpose>Set border style of annotations [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_set_border_style</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> @@ -19,6 +19,12 @@ <parameter>style</parameter> is <parameter>solid</parameter> or <parameter>dashed</parameter>. &return.success; </para> + <para> + This function is deprecated since PDFlib version 6, use + the options <parameter>borderstyle</parameter> and + <parameter>linewidth</parameter> in + <function>pdf_create_annotation</function> instead. + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-delete.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-delete.xml diff -u phpdoc/en/reference/pdf/functions/pdf-delete.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-delete.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-delete.xml:1.4 Sat Aug 9 00:31:33 2003 +++ phpdoc/en/reference/pdf/functions/pdf-delete.xml Thu Dec 8 08:45:02 2005 @@ -1,22 +1,19 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-delete"> <refnamediv> <refname>pdf_delete</refname> - <refpurpose>Deletes a PDF object</refpurpose> + <refpurpose>Delete PDFlib object</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_delete</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> </methodsynopsis> <para> - Delete the PDF resource, and free all internal resources. &return.success; - </para> - <para> - See also <function>pdf_new</function>. + Deletes a PDFlib object, and frees all internal resources. &return.success; </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-moveto.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-moveto.xml diff -u phpdoc/en/reference/pdf/functions/pdf-moveto.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-moveto.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-moveto.xml:1.4 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-moveto.xml Thu Dec 8 08:45:02 2005 @@ -1,22 +1,22 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-moveto"> <refnamediv> <refname>pdf_moveto</refname> - <refpurpose>Sets current point</refpurpose> + <refpurpose>Set current point</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_moveto</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> <methodparam><type>float</type><parameter>x</parameter></methodparam> <methodparam><type>float</type><parameter>y</parameter></methodparam> </methodsynopsis> <para> - Set the current point to (<parameter>x</parameter>, <parameter>y</parameter>. - &return.success; + Sets the current point for graphics output to (<parameter>x</parameter>, + <parameter>y</parameter>. &return.success; </para> <note> <para> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-open-pdi.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-open-pdi.xml diff -u phpdoc/en/reference/pdf/functions/pdf-open-pdi.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-open-pdi.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-open-pdi.xml:1.4 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-open-pdi.xml Thu Dec 8 08:45:02 2005 @@ -1,24 +1,21 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-open-pdi"> <refnamediv> <refname>pdf_open_pdi</refname> - <refpurpose> - Opens a PDF file - </refpurpose> + <refpurpose>Open PDF file</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>pdf_open_pdi</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - <methodparam><type>string</type><parameter>stringparam</parameter></methodparam> - <methodparam><type>int</type><parameter>intparam</parameter></methodparam> + <methodparam><type>string</type><parameter>optlist</parameter></methodparam> </methodsynopsis> <para> - Opens an existing PDF document and prepares it for later use. + Opens a disk-based or virtual PDF document and prepares it for later use. </para> <para> See also <function>pdf_close_pdi</function>. http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-get-parameter.xml?r1=1.6&r2=1.7&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-get-parameter.xml diff -u phpdoc/en/reference/pdf/functions/pdf-get-parameter.xml:1.6 phpdoc/en/reference/pdf/functions/pdf-get-parameter.xml:1.7 --- phpdoc/en/reference/pdf/functions/pdf-get-parameter.xml:1.6 Fri Jul 22 08:09:30 2005 +++ phpdoc/en/reference/pdf/functions/pdf-get-parameter.xml Thu Dec 8 08:45:02 2005 @@ -1,23 +1,21 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-get-parameter"> <refnamediv> <refname>pdf_get_parameter</refname> - <refpurpose>Gets certain parameters</refpurpose> + <refpurpose>Get string parameter</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>pdf_get_parameter</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> <methodparam><type>string</type><parameter>key</parameter></methodparam> <methodparam><type>float</type><parameter>modifier</parameter></methodparam> </methodsynopsis> <para> - Get the contents of some PDFlib parameter with string type. - Parameter <parameter>modifier</parameter> is optional before PHP 4.3.5 - or with PDFlib less than 5. + Gets the contents of some PDFlib parameter with string type. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-get-minorversion.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-get-minorversion.xml diff -u phpdoc/en/reference/pdf/functions/pdf-get-minorversion.xml:1.3 phpdoc/en/reference/pdf/functions/pdf-get-minorversion.xml:1.4 --- phpdoc/en/reference/pdf/functions/pdf-get-minorversion.xml:1.3 Sat Aug 9 00:31:33 2003 +++ phpdoc/en/reference/pdf/functions/pdf-get-minorversion.xml Thu Dec 8 08:45:02 2005 @@ -1,24 +1,24 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.72 --> <refentry id='function.pdf-get-minorversion'> <refnamediv> <refname>pdf_get_minorversion</refname> - <refpurpose> - Returns the minor version number of the PDFlib - </refpurpose> + <refpurpose>Get minor version number [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>pdf_get_minorversion</methodname> <void/> </methodsynopsis> <para> - Returns the minor version number of the PDFlib. + Returns the minor version number of the PDFlib version. </para> <para> - See also <function>pdf_get_majorversion</function>. + This function is deprecated since PDFlib version 5, use + <function>pdf_get_value</function> with the parameter + <parameter>minor</parameter> instead. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-circle.xml?r1=1.8&r2=1.9&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-circle.xml diff -u phpdoc/en/reference/pdf/functions/pdf-circle.xml:1.8 phpdoc/en/reference/pdf/functions/pdf-circle.xml:1.9 --- phpdoc/en/reference/pdf/functions/pdf-circle.xml:1.8 Tue Aug 3 13:25:34 2004 +++ phpdoc/en/reference/pdf/functions/pdf-circle.xml Thu Dec 8 08:45:02 2005 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-circle"> <refnamediv> <refname>pdf_circle</refname> - <refpurpose>Draws a circle</refpurpose> + <refpurpose>Draw a circle</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_circle</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> @@ -16,57 +16,14 @@ <methodparam><type>float</type><parameter>r</parameter></methodparam> </methodsynopsis> <para> - Add a circle with center (<parameter>x</parameter>, + Adds a circle with center (<parameter>x</parameter>, <parameter>y</parameter>) and radius <parameter>r</parameter> - to the current page. Actual drawing of the circle is performed by + to the current path. The actual drawing of the circle is performed by the next stroke or fill operation. </para> <para> &return.success; </para> - <para> - <example> - <title><function>pdf_circle</function> example</title> - <programlisting role="php"> -<![CDATA[ -<?php -// prepare document -$pdf = pdf_new(); -pdf_open_file($pdf, ""); -pdf_begin_page($pdf, 595, 842); - -// an outlined circle -pdf_circle($pdf, 200, 700, 100); -pdf_stroke($pdf); - -// a filled circle -pdf_circle($pdf, 200, 700, 50); -pdf_fill($pdf); - -// an outlined and filled circle -pdf_setcolor($pdf, "fill", "gray", 0.3); -pdf_circle($pdf, 400, 700, 50); -pdf_fill_stroke($pdf); - -// finish document -pdf_end_page($pdf); -pdf_close($pdf); - -header("Content-type: application/pdf"); -echo pdf_get_buffer($pdf); - -pdf_delete($pdf); -?> -]]> - </programlisting> - </example> - </para> - <para> - See also: <function>pdf_arc</function>, - <function>pdf_arcn</function>, <function>pdf_curveto</function>, - <function>pdf_stroke</function>, <function>pdf_fill</function> and - <function>pdf_fill_stroke</function>. - </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-add-annotation.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-add-annotation.xml diff -u phpdoc/en/reference/pdf/functions/pdf-add-annotation.xml:1.3 phpdoc/en/reference/pdf/functions/pdf-add-annotation.xml:1.4 --- phpdoc/en/reference/pdf/functions/pdf-add-annotation.xml:1.3 Sat Aug 9 00:31:33 2003 +++ phpdoc/en/reference/pdf/functions/pdf-add-annotation.xml Thu Dec 8 08:45:02 2005 @@ -1,16 +1,15 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-add-annotation"> <refnamediv> <refname>pdf_add_annotation</refname> - <refpurpose>Deprecated: Adds annotation</refpurpose> + <refpurpose>Add annotation [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <para> - This function is deprecated, use <function>pdf_add_note</function> - instead. + This function is deprecated, use <function>pdf_create_annotation</function> with <parameter>type=Text</parameter> instead. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-open-png.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-open-png.xml diff -u phpdoc/en/reference/pdf/functions/pdf-open-png.xml:1.3 phpdoc/en/reference/pdf/functions/pdf-open-png.xml:1.4 --- phpdoc/en/reference/pdf/functions/pdf-open-png.xml:1.3 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-open-png.xml Thu Dec 8 08:45:02 2005 @@ -1,18 +1,17 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-open-png"> <refnamediv> <refname>pdf_open_png</refname> <refpurpose> - Deprecated: Opens a PNG image + Open PNG image [not supported] </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <para> - This function is deprecated, use <function>pdf_open_image</function> - instead. + This function is not supported, use <function>pdf_load_image</function>. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-show-xy.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-show-xy.xml diff -u phpdoc/en/reference/pdf/functions/pdf-show-xy.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-show-xy.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-show-xy.xml:1.4 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-show-xy.xml Thu Dec 8 08:45:02 2005 @@ -1,22 +1,22 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-show-xy"> <refnamediv> <refname>pdf_show_xy</refname> <refpurpose>Output text at given position</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_show_xy</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> <methodparam><type>string</type><parameter>text</parameter></methodparam> <methodparam><type>float</type><parameter>x</parameter></methodparam> <methodparam><type>float</type><parameter>y</parameter></methodparam> </methodsynopsis> <para> - Print <parameter>text</parameter> in the current font at ( + Prints <parameter>text</parameter> in the current font at ( <parameter>x</parameter>, <parameter>y</parameter>). &return.success; </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-set-leading.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-set-leading.xml diff -u phpdoc/en/reference/pdf/functions/pdf-set-leading.xml:1.3 phpdoc/en/reference/pdf/functions/pdf-set-leading.xml:1.4 --- phpdoc/en/reference/pdf/functions/pdf-set-leading.xml:1.3 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-set-leading.xml Thu Dec 8 08:45:02 2005 @@ -1,16 +1,17 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> + <?xml version="1.0" encoding="iso-8859-1"?> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-set-leading"> <refnamediv> <refname>pdf_set_leading</refname> - <refpurpose>Deprecated: Sets distance between text lines</refpurpose> + <refpurpose>Set distance between text lines [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <para> - This function is deprecated, use <function>pdf_set_value</function> - instead. + This function is deprecated since PDFlib version 3, use + <function>pdf_set_value</function> with the parameter + <parameter>leading</parameter> instead. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-get-image-height.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-get-image-height.xml diff -u phpdoc/en/reference/pdf/functions/pdf-get-image-height.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-get-image-height.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-get-image-height.xml:1.4 Sat Aug 9 00:31:33 2003 +++ phpdoc/en/reference/pdf/functions/pdf-get-image-height.xml Thu Dec 8 08:45:02 2005 @@ -1,16 +1,17 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-get-image-height"> <refnamediv> <refname>pdf_get_image_height</refname> - <refpurpose>Deprecated: returns height of an image</refpurpose> + <refpurpose>Get image height [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <para> - This function is deprecated, use <function>pdf_get_value</function> - instead. + This function is deprecated since PDFlib version 3, use + <function>pdf_get_value</function> with the parameter + <parameter>imageheight</parameter> instead. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-setpolydash.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-setpolydash.xml diff -u phpdoc/en/reference/pdf/functions/pdf-setpolydash.xml:1.5 phpdoc/en/reference/pdf/functions/pdf-setpolydash.xml:1.6 --- phpdoc/en/reference/pdf/functions/pdf-setpolydash.xml:1.5 Mon Aug 11 09:08:38 2003 +++ phpdoc/en/reference/pdf/functions/pdf-setpolydash.xml Thu Dec 8 08:45:02 2005 @@ -1,16 +1,16 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-setpolydash"> <refnamediv> <refname>pdf_setpolydash</refname> - <refpurpose>Deprecated: Sets complicated dash pattern</refpurpose> + <refpurpose>Set complicated dash pattern [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <para> - This function is deprecated, use <function>pdf_setdash</function> - instead. + This function is deprecated since PDFlib version 5, use + <function>pdf_setdashpattern</function> instead. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-set-horiz-scaling.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-set-horiz-scaling.xml diff -u phpdoc/en/reference/pdf/functions/pdf-set-horiz-scaling.xml:1.5 phpdoc/en/reference/pdf/functions/pdf-set-horiz-scaling.xml:1.6 --- phpdoc/en/reference/pdf/functions/pdf-set-horiz-scaling.xml:1.5 Tue Mar 2 07:50:19 2004 +++ phpdoc/en/reference/pdf/functions/pdf-set-horiz-scaling.xml Thu Dec 8 08:45:02 2005 @@ -1,16 +1,17 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-set-horiz-scaling"> <refnamediv> <refname>pdf_set_horiz_scaling</refname> - <refpurpose>Sets horizontal scaling of text [deprecated]</refpurpose> + <refpurpose>Set horizontal text scaling [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <para> - This function is deprecated, use <function>pdf_set_value</function> - instead. + This function is deprecated since PDFlib version 3, use + <function>pdf_set_value</function> with parameter + <parameter>horizscaling</parameter> instead. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-setmatrix.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-setmatrix.xml diff -u phpdoc/en/reference/pdf/functions/pdf-setmatrix.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-setmatrix.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-setmatrix.xml:1.4 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-setmatrix.xml Thu Dec 8 08:45:02 2005 @@ -1,16 +1,16 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-setmatrix"> <refnamediv> <refname>pdf_setmatrix</refname> - <refpurpose>Sets current transformation matrix</refpurpose> + <refpurpose>Set current transformation matrix</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_setmatrix</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> <methodparam><type>float</type><parameter>a</parameter></methodparam> <methodparam><type>float</type><parameter>b</parameter></methodparam> <methodparam><type>float</type><parameter>c</parameter></methodparam> @@ -19,7 +19,7 @@ <methodparam><type>float</type><parameter>f</parameter></methodparam> </methodsynopsis> <para> - Explicitly set the current transformation matrix. &return.success; + Explicitly sets the current transformation matrix. &return.success; </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-setlinecap.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-setlinecap.xml diff -u phpdoc/en/reference/pdf/functions/pdf-setlinecap.xml:1.5 phpdoc/en/reference/pdf/functions/pdf-setlinecap.xml:1.6 --- phpdoc/en/reference/pdf/functions/pdf-setlinecap.xml:1.5 Fri Jun 24 05:11:42 2005 +++ phpdoc/en/reference/pdf/functions/pdf-setlinecap.xml Thu Dec 8 08:45:02 2005 @@ -1,20 +1,21 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-setlinecap"> <refnamediv> <refname>pdf_setlinecap</refname> - <refpurpose>Sets linecap parameter</refpurpose> + <refpurpose>Set linecap parameter</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_setlinecap</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> <methodparam><type>int</type><parameter>linecap</parameter></methodparam> </methodsynopsis> <para> - Set the <parameter>linecap</parameter> parameter to a value between 0 and 2 inclusive. + Sets the <parameter>linecap</parameter> parameter to control the shape + at the end of a path with respect to stroking. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-setgray-fill.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-setgray-fill.xml diff -u phpdoc/en/reference/pdf/functions/pdf-setgray-fill.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-setgray-fill.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-setgray-fill.xml:1.4 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-setgray-fill.xml Thu Dec 8 08:45:02 2005 @@ -1,25 +1,26 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-setgray-fill"> <refnamediv> <refname>pdf_setgray_fill</refname> - <refpurpose>Sets filling color to gray value</refpurpose> + <refpurpose>Set fill color to gray [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_setgray_fill</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> - <methodparam><type>float</type><parameter>gray</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> + <methodparam><type>float</type><parameter>g</parameter></methodparam> </methodsynopsis> <para> - Set the current fill color to a gray value between 0 and 1 inclusive. + Sets the current fill color to a gray value between 0 and 1 inclusive. &return.success; </para> <note> <para> - PDFlib V4.0: Deprecated, use <function>pdf_setcolor</function> instead. + This function is deprecated since PDFlib version 4, use + <function>pdf_setcolor</function> instead. </para> </note> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-get-pdi-value.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-get-pdi-value.xml diff -u phpdoc/en/reference/pdf/functions/pdf-get-pdi-value.xml:1.5 phpdoc/en/reference/pdf/functions/pdf-get-pdi-value.xml:1.6 --- phpdoc/en/reference/pdf/functions/pdf-get-pdi-value.xml:1.5 Fri Jun 24 05:11:42 2005 +++ phpdoc/en/reference/pdf/functions/pdf-get-pdi-value.xml Thu Dec 8 08:45:02 2005 @@ -1,23 +1,23 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-get-pdi-value"> <refnamediv> <refname>pdf_get_pdi_value</refname> - <refpurpose>Gets some PDI numerical parameters</refpurpose> + <refpurpose>Get PDI numerical parameter</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>float</type><methodname>pdf_get_pdi_value</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> <methodparam><type>string</type><parameter>key</parameter></methodparam> <methodparam><type>int</type><parameter>doc</parameter></methodparam> <methodparam><type>int</type><parameter>page</parameter></methodparam> - <methodparam><type>int</type><parameter>index</parameter></methodparam> + <methodparam><type>int</type><parameter>reserved</parameter></methodparam> </methodsynopsis> <para> - Get the contents of some PDI document parameter with numerical type. + Gets the contents of a PDI document parameter with numerical type. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-save.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-save.xml diff -u phpdoc/en/reference/pdf/functions/pdf-save.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-save.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-save.xml:1.4 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-save.xml Thu Dec 8 08:45:02 2005 @@ -1,19 +1,19 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-save"> <refnamediv> <refname>pdf_save</refname> - <refpurpose>Saves the current environment</refpurpose> + <refpurpose>Save graphics state</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_save</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> </methodsynopsis> <para> - Save the current graphics state. &return.success; + Saves the current graphics state. &return.success; </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-add-locallink.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-add-locallink.xml diff -u phpdoc/en/reference/pdf/functions/pdf-add-locallink.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-add-locallink.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-add-locallink.xml:1.4 Sat Aug 9 00:31:33 2003 +++ phpdoc/en/reference/pdf/functions/pdf-add-locallink.xml Thu Dec 8 08:45:02 2005 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-add-locallink"> <refnamediv> <refname>pdf_add_locallink</refname> - <refpurpose>Add a link annotation for current page</refpurpose> + <refpurpose>Add link annotation for current page [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_add_locallink</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> @@ -29,7 +29,7 @@ <literal>fitbbox</literal>. </para> <para> - See also <function>pdf_add_launchlink</function>. + This function is deprecated since PDFlib version 6, use <function>pdf_create_action</function> with <parameter>type=GoTo</parameter> and <function>pdf_create_annotation</function> with <parameter>type=Link</parameter> instead. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-fill.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-fill.xml diff -u phpdoc/en/reference/pdf/functions/pdf-fill.xml:1.5 phpdoc/en/reference/pdf/functions/pdf-fill.xml:1.6 --- phpdoc/en/reference/pdf/functions/pdf-fill.xml:1.5 Sat Aug 9 01:01:43 2003 +++ phpdoc/en/reference/pdf/functions/pdf-fill.xml Thu Dec 8 08:45:02 2005 @@ -1,19 +1,19 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-fill"> <refnamediv> <refname>pdf_fill</refname> - <refpurpose>Fills current path</refpurpose> + <refpurpose>Fill current path</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_fill</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> </methodsynopsis> <para> - Fill the interior of the path with the current fill color. + Fills the interior of the current path with the current fill color. &return.success; </para> <para> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-curveto.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-curveto.xml diff -u phpdoc/en/reference/pdf/functions/pdf-curveto.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-curveto.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-curveto.xml:1.4 Sat Aug 9 00:31:33 2003 +++ phpdoc/en/reference/pdf/functions/pdf-curveto.xml Thu Dec 8 08:45:02 2005 @@ -1,16 +1,16 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-curveto"> <refnamediv> <refname>pdf_curveto</refname> - <refpurpose>Draws a curve</refpurpose> + <refpurpose>Draw Bezier curve</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_curveto</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> <methodparam><type>float</type><parameter>x1</parameter></methodparam> <methodparam><type>float</type><parameter>y1</parameter></methodparam> <methodparam><type>float</type><parameter>x2</parameter></methodparam> @@ -19,7 +19,7 @@ <methodparam><type>float</type><parameter>y3</parameter></methodparam> </methodsynopsis> <para> - Draw a Bezier curve from the current point, using 3 more control points. + Draws a Bezier curve from the current point, using 3 more control points. &return.success; </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-setdash.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-setdash.xml diff -u phpdoc/en/reference/pdf/functions/pdf-setdash.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-setdash.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-setdash.xml:1.4 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-setdash.xml Thu Dec 8 08:45:02 2005 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-setdash"> <refnamediv> <refname>pdf_setdash</refname> - <refpurpose>Sets dash pattern</refpurpose> + <refpurpose>Set simple dash pattern</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_setdash</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> @@ -15,7 +15,7 @@ <methodparam><type>float</type><parameter>w</parameter></methodparam> </methodsynopsis> <para> - Set the current dash pattern to <parameter>b</parameter> black + Sets the current dash pattern to <parameter>b</parameter> black and <parameter>w</parameter> white units. &return.success; </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-get-fontname.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-get-fontname.xml diff -u phpdoc/en/reference/pdf/functions/pdf-get-fontname.xml:1.3 phpdoc/en/reference/pdf/functions/pdf-get-fontname.xml:1.4 --- phpdoc/en/reference/pdf/functions/pdf-get-fontname.xml:1.3 Sat Aug 9 00:31:33 2003 +++ phpdoc/en/reference/pdf/functions/pdf-get-fontname.xml Thu Dec 8 08:45:02 2005 @@ -1,16 +1,17 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-get-fontname"> <refnamediv> <refname>pdf_get_fontname</refname> - <refpurpose>Deprecated: font handling</refpurpose> + <refpurpose>Get font name [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <para> - This function is deprecated, use <function>pdf_get_parameter</function> - instead. + This function is deprecated since PDFlib version 3, use + <function>pdf_get_parameter</function> with the parameter + <parameter>fontname</parameter> instead. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-close.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-close.xml diff -u phpdoc/en/reference/pdf/functions/pdf-close.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-close.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-close.xml:1.4 Sat Aug 9 00:31:33 2003 +++ phpdoc/en/reference/pdf/functions/pdf-close.xml Thu Dec 8 08:45:02 2005 @@ -1,23 +1,23 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-close"> <refnamediv> <refname>pdf_close</refname> - <refpurpose>Closes a pdf resource</refpurpose> + <refpurpose>Closes a pdf resource [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_close</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> </methodsynopsis> <para> Close the generated PDF file, and free all document-related resources. &return.success; </para> <para> - See also <function>pdf_new</function>. + This function is deprecated since PDFlib version 6, use <function>pdf_end_document</function> instead. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-show.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-show.xml diff -u phpdoc/en/reference/pdf/functions/pdf-show.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-show.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-show.xml:1.4 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-show.xml Thu Dec 8 08:45:02 2005 @@ -1,20 +1,20 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-show"> <refnamediv> <refname>pdf_show</refname> <refpurpose>Output text at current position</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_show</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>string</type><parameter>text</parameter></methodparam> </methodsynopsis> <para> - Print <parameter>text</parameter> in the current font and size at + Prints <parameter>text</parameter> in the current font and size at the current position. &return.success; </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-open-ccitt.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-open-ccitt.xml diff -u phpdoc/en/reference/pdf/functions/pdf-open-ccitt.xml:1.5 phpdoc/en/reference/pdf/functions/pdf-open-ccitt.xml:1.6 --- phpdoc/en/reference/pdf/functions/pdf-open-ccitt.xml:1.5 Fri Aug 13 10:10:03 2004 +++ phpdoc/en/reference/pdf/functions/pdf-open-ccitt.xml Thu Dec 8 08:45:02 2005 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-open-ccitt"> <refnamediv> <refname>pdf_open_ccitt</refname> - <refpurpose>Opens a new image file with raw CCITT data</refpurpose> + <refpurpose>Open raw CCITT image [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>pdf_open_ccitt</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> @@ -19,8 +19,12 @@ <methodparam><type>int</type><parameter>Blackls1</parameter></methodparam> </methodsynopsis> <para> - Open a raw CCITT image. - </para> + Opens a raw CCITT image. + </para> + <para>This function is deprecated since PDFlib version 5, + use <function>pdf_load_image</function> instead. + </para> + </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-set-duration.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-set-duration.xml diff -u phpdoc/en/reference/pdf/functions/pdf-set-duration.xml:1.3 phpdoc/en/reference/pdf/functions/pdf-set-duration.xml:1.4 --- phpdoc/en/reference/pdf/functions/pdf-set-duration.xml:1.3 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-set-duration.xml Thu Dec 8 08:45:02 2005 @@ -1,15 +1,16 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-set-duration"> <refnamediv> <refname>pdf_set_duration</refname> - <refpurpose>Deprecated: Sets duration between pages</refpurpose> + <refpurpose>Set duration between pages [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <para> - This function is deprecated, use <function>pdf_set_value</function> + This function is deprecated since PDFlib version 3, use + <function>pdf_set_value</function> with <parameter>duration</parameter> instead. </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-add-weblink.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-add-weblink.xml diff -u phpdoc/en/reference/pdf/functions/pdf-add-weblink.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-add-weblink.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-add-weblink.xml:1.4 Sat Aug 9 00:31:33 2003 +++ phpdoc/en/reference/pdf/functions/pdf-add-weblink.xml Thu Dec 8 08:45:02 2005 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-add-weblink"> <refnamediv> <refname>pdf_add_weblink</refname> - <refpurpose>Adds weblink for current page</refpurpose> + <refpurpose>Add weblink for current page [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_add_weblink</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> @@ -21,6 +21,8 @@ Add a weblink annotation to a target <parameter>url</parameter> on the Web. &return.success; </para> +<para>This function is deprecated since PDFlib version 6, use <function>pdf_create_action</function> with <parameter>type=URI</parameter> and <function>pdf_create_annotation</function> with +<parameter>type=Link</parameter> instead.</para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-endpath.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-endpath.xml diff -u phpdoc/en/reference/pdf/functions/pdf-endpath.xml:1.3 phpdoc/en/reference/pdf/functions/pdf-endpath.xml:1.4 --- phpdoc/en/reference/pdf/functions/pdf-endpath.xml:1.3 Sat Aug 9 00:31:33 2003 +++ phpdoc/en/reference/pdf/functions/pdf-endpath.xml Thu Dec 8 08:45:02 2005 @@ -1,17 +1,15 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-endpath"> <refnamediv> <refname>pdf_endpath</refname> - <refpurpose>Deprecated: Ends current path</refpurpose> + <refpurpose>End current path</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <para> - This function is deprecated, use one of the - <function>pdf_stroke</function>, <function>pdf_clip</function> or - <function>pdf_closepath_fill_stroke</function> functions instead. + Ends the current path without filling or stroking it. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-end-template.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-end-template.xml diff -u phpdoc/en/reference/pdf/functions/pdf-end-template.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-end-template.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-end-template.xml:1.4 Sat Aug 9 00:31:33 2003 +++ phpdoc/en/reference/pdf/functions/pdf-end-template.xml Thu Dec 8 08:45:02 2005 @@ -1,19 +1,19 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-end-template"> <refnamediv> <refname>pdf_end_template</refname> <refpurpose>Finish template</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_end_template</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> </methodsynopsis> <para> - Finish the template definition. &return.success; + Finishes a template definition. &return.success; </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-setlinewidth.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-setlinewidth.xml diff -u phpdoc/en/reference/pdf/functions/pdf-setlinewidth.xml:1.5 phpdoc/en/reference/pdf/functions/pdf-setlinewidth.xml:1.6 --- phpdoc/en/reference/pdf/functions/pdf-setlinewidth.xml:1.5 Fri Jun 24 05:11:42 2005 +++ phpdoc/en/reference/pdf/functions/pdf-setlinewidth.xml Thu Dec 8 08:45:02 2005 @@ -1,20 +1,20 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-setlinewidth"> <refnamediv> <refname>pdf_setlinewidth</refname> - <refpurpose>Sets line width</refpurpose> + <refpurpose>Set line width</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_setlinewidth</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> <methodparam><type>float</type><parameter>width</parameter></methodparam> </methodsynopsis> <para> - Sets the current linewidth to <parameter>width</parameter>. &return.success; + Sets the current line width to <parameter>width</parameter>. &return.success; </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-set-info-title.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-set-info-title.xml diff -u phpdoc/en/reference/pdf/functions/pdf-set-info-title.xml:1.3 phpdoc/en/reference/pdf/functions/pdf-set-info-title.xml:1.4 --- phpdoc/en/reference/pdf/functions/pdf-set-info-title.xml:1.3 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-set-info-title.xml Thu Dec 8 08:45:02 2005 @@ -1,17 +1,18 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id='function.pdf-set-info-title'> <refnamediv> <refname>pdf_set_info_title</refname> <refpurpose> - Deprecated: Fills the title field of the document + Fill the title document info field [deprecated] </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <para> - This function is deprecated, use <function>pdf_set_info</function> instead. + This function is deprecated since PDFlib version 3, use + <function>pdf_set_info</function> instead. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-arc.xml?r1=1.8&r2=1.9&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-arc.xml diff -u phpdoc/en/reference/pdf/functions/pdf-arc.xml:1.8 phpdoc/en/reference/pdf/functions/pdf-arc.xml:1.9 --- phpdoc/en/reference/pdf/functions/pdf-arc.xml:1.8 Tue Jan 6 07:50:51 2004 +++ phpdoc/en/reference/pdf/functions/pdf-arc.xml Thu Dec 8 08:45:02 2005 @@ -1,16 +1,16 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.65 --> <refentry id="function.pdf-arc"> <refnamediv> <refname>pdf_arc</refname> - <refpurpose>Draws an arc (counterclockwise)</refpurpose> + <refpurpose>Draw a counterclockwise circular arc segment</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_arc</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> <methodparam><type>float</type><parameter>x</parameter></methodparam> <methodparam><type>float</type><parameter>y</parameter></methodparam> <methodparam><type>float</type><parameter>r</parameter></methodparam> @@ -21,52 +21,10 @@ Add a counterclockwise circular arc from <parameter>alpha</parameter> to <parameter>beta</parameter> degrees with center (<parameter>x</parameter>; <parameter>y</parameter>) - and radius <parameter>r</parameter>. Actual drawing of the circle is performed by + and radius <parameter>r</parameter>. The actual drawing of the circle is performed by the next stroke or fill operation. </para> - <para> - <example> - <title><function>pdf_arcn</function> example</title> - <programlisting role="php"> -<![CDATA[ -<?php -// prepare document -$pdf = pdf_new(); -pdf_open_file($pdf, ""); -pdf_begin_page($pdf, 595, 842); - -// an outlined arc -pdf_arc($pdf, 200, 700, 100, 0, 90); -pdf_stroke($pdf); - -// a filled arc -pdf_arc($pdf, 200, 700, 50, 0, 90); -pdf_fill($pdf); - -// an outlined and filled arc -pdf_setcolor($pdf, "fill", "gray", 0.8); -pdf_arc($pdf, 400, 700, 50, 0, 90); -pdf_fill_stroke($pdf); - -// finish document -pdf_end_page($pdf); -pdf_close($pdf); - -header("Content-type: application/pdf"); -echo pdf_get_buffer($pdf); - -pdf_delete($pdf); -?> -]]> - </programlisting> - </example> - </para> - <para> - See also: <function>pdf_arcn</function>, - <function>pdf_circle</function>, <function>pdf_stroke</function>, - <function>pdf_fill</function> and <function>pdf_fill_stroke</function>. - </para> - </refsect1> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-lineto.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-lineto.xml diff -u phpdoc/en/reference/pdf/functions/pdf-lineto.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-lineto.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-lineto.xml:1.4 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-lineto.xml Thu Dec 8 08:45:02 2005 @@ -1,21 +1,21 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-lineto"> <refnamediv> <refname>pdf_lineto</refname> - <refpurpose>Draws a line</refpurpose> + <refpurpose>Draw a line</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_lineto</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> <methodparam><type>float</type><parameter>x</parameter></methodparam> <methodparam><type>float</type><parameter>y</parameter></methodparam> </methodsynopsis> <para> - Draw a line from the current point to (<parameter>x</parameter>, + Draws a line from the current point to (<parameter>x</parameter>, <parameter>y</parameter>). &return.success; </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-continue-text.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-continue-text.xml diff -u phpdoc/en/reference/pdf/functions/pdf-continue-text.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-continue-text.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-continue-text.xml:1.4 Sat Aug 9 00:31:33 2003 +++ phpdoc/en/reference/pdf/functions/pdf-continue-text.xml Thu Dec 8 08:45:02 2005 @@ -1,20 +1,20 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-continue-text"> <refnamediv> <refname>pdf_continue_text</refname> - <refpurpose>Outputs text in next line</refpurpose> + <refpurpose>Output text in next line</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_continue_text</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> <methodparam><type>string</type><parameter>text</parameter></methodparam> </methodsynopsis> <para> - Print <parameter>text</parameter> at the next line. &return.success; + Prints <parameter>text</parameter> at the next line. &return.success; </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-stringwidth.xml?r1=1.7&r2=1.8&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-stringwidth.xml diff -u phpdoc/en/reference/pdf/functions/pdf-stringwidth.xml:1.7 phpdoc/en/reference/pdf/functions/pdf-stringwidth.xml:1.8 --- phpdoc/en/reference/pdf/functions/pdf-stringwidth.xml:1.7 Fri Jul 22 08:09:30 2005 +++ phpdoc/en/reference/pdf/functions/pdf-stringwidth.xml Thu Dec 8 08:45:02 2005 @@ -1,39 +1,28 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-stringwidth"> <refnamediv> <refname>pdf_stringwidth</refname> - <refpurpose>Returns width of text using current font</refpurpose> + <refpurpose>Return width of text</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>float</type><methodname>pdf_stringwidth</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> <methodparam><type>string</type><parameter>text</parameter></methodparam> <methodparam><type>int</type><parameter>font</parameter></methodparam> - <methodparam><type>float</type><parameter>size</parameter></methodparam> + <methodparam><type>float</type><parameter>fontsize</parameter></methodparam> </methodsynopsis> <para> - Returns the width of <parameter>text</parameter> using the parameters - <parameter>font</parameter> and <parameter>size</parameter>. - Please note that <parameter>font</parameter> is a font handle returned - by <function>pdf_findfont</function>. - Parameters <parameter>font</parameter> and <parameter>size</parameter> - are optional before PHP 4.3.5 or with PDFlib less than 5. If they are - not specified, the font set by <function>pdf_setfont</function> is used. + Returns the width of <parameter>text</parameter> in an arbitrary font, using the parameters + <parameter>font</parameter> and <parameter>fontsize</parameter>. + <parameter>font</parameter> is a font handle returned + by <function>pdf_load_font</function>. </para> - <note> - <para> - Both the <parameter>font</parameter> and <parameter>size</parameter> - parameters must be used together. - </para> - </note> <para> - See also - <function>pdf_setfont</function> and - <function>pdf_findfont</function>. + See also <function>pdf_load_font</function>. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-set-info-subject.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-set-info-subject.xml diff -u phpdoc/en/reference/pdf/functions/pdf-set-info-subject.xml:1.3 phpdoc/en/reference/pdf/functions/pdf-set-info-subject.xml:1.4 --- phpdoc/en/reference/pdf/functions/pdf-set-info-subject.xml:1.3 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-set-info-subject.xml Thu Dec 8 08:45:02 2005 @@ -1,17 +1,18 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.72 --> <refentry id='function.pdf-set-info-subject'> <refnamediv> <refname>pdf_set_info_subject</refname> <refpurpose> - Deprecated: Fills the subject field of the document + Fill the subject document info field [deprecated] </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <para> - This function is deprecated, use <function>pdf_set_info</function> instead. + This function is deprecated since PDFlib version 3, use + <function>pdf_set_info</function> instead. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-setfont.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-setfont.xml diff -u phpdoc/en/reference/pdf/functions/pdf-setfont.xml:1.5 phpdoc/en/reference/pdf/functions/pdf-setfont.xml:1.6 --- phpdoc/en/reference/pdf/functions/pdf-setfont.xml:1.5 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-setfont.xml Thu Dec 8 08:45:02 2005 @@ -1,27 +1,26 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.48 --> <refentry id="function.pdf-setfont"> <refnamediv> <refname>pdf_setfont</refname> - <refpurpose>Set the current font</refpurpose> + <refpurpose>Set font</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_setfont</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>int</type><parameter>font</parameter></methodparam> - <methodparam><type>float</type><parameter>size</parameter></methodparam> + <methodparam><type>float</type><parameter>fontsize</parameter></methodparam> </methodsynopsis> <para> - Set the current font in the given <parameter>size</parameter>, using a - <parameter>font</parameter> handle returned by <function>pdf_findfont</function>. + Sets the current font in the specified <parameter>size</parameter>, using a + <parameter>font</parameter> handle returned by <function>pdf_load_font</function>. &return.success; </para> <para> - See also - <function>pdf_findfont</function>. + See also <function>pdf_load_font</function>. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-setgray-stroke.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-setgray-stroke.xml diff -u phpdoc/en/reference/pdf/functions/pdf-setgray-stroke.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-setgray-stroke.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-setgray-stroke.xml:1.4 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-setgray-stroke.xml Thu Dec 8 08:45:02 2005 @@ -1,27 +1,26 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-setgray-stroke"> <refnamediv> <refname>pdf_setgray_stroke</refname> - <refpurpose>Sets drawing color to gray value</refpurpose> + <refpurpose>Set stroke color to gray [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_setgray_stroke</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> - <methodparam><type>float</type><parameter>gray</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> + <methodparam><type>float</type><parameter>g</parameter></methodparam> </methodsynopsis> <para> - Set the current stroke color to a <parameter>gray</parameter> value - between 0 and 1 inclusive. &return.success; + Sets the current stroke color to a gray value between 0 and 1 inclusive. + &return.success; + </para> + <para> + This function is deprecated since PDFlib version 4, use + <function>pdf_setcolor</function> instead. </para> - <note> - <para> - PDFlib V4.0: Deprecated, use <function>pdf_setcolor</function> instead. - </para> - </note> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-fill-stroke.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-fill-stroke.xml diff -u phpdoc/en/reference/pdf/functions/pdf-fill-stroke.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-fill-stroke.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-fill-stroke.xml:1.4 Sat Aug 9 00:31:33 2003 +++ phpdoc/en/reference/pdf/functions/pdf-fill-stroke.xml Thu Dec 8 08:45:02 2005 @@ -1,19 +1,19 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-fill-stroke"> <refnamediv> <refname>pdf_fill_stroke</refname> - <refpurpose>Fills and strokes current path</refpurpose> + <refpurpose>Fill and stroke path</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_fill_stroke</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> </methodsynopsis> <para> - Fill and stroke the path with the current fill and stroke color. + Fills and strokes the current path with the current fill and stroke color. &return.success; </para> <para> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-set-parameter.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-set-parameter.xml diff -u phpdoc/en/reference/pdf/functions/pdf-set-parameter.xml:1.5 phpdoc/en/reference/pdf/functions/pdf-set-parameter.xml:1.6 --- phpdoc/en/reference/pdf/functions/pdf-set-parameter.xml:1.5 Wed Apr 14 20:43:58 2004 +++ phpdoc/en/reference/pdf/functions/pdf-set-parameter.xml Thu Dec 8 08:45:02 2005 @@ -1,21 +1,21 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-set-parameter"> <refnamediv> <refname>pdf_set_parameter</refname> - <refpurpose>Sets certain parameters</refpurpose> + <refpurpose>Set string parameter</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_set_parameter</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> <methodparam><type>string</type><parameter>key</parameter></methodparam> <methodparam><type>string</type><parameter>value</parameter></methodparam> </methodsynopsis> <para> - Sets some PDFlib parameters with string type. &return.success; + Sets some PDFlib parameter with string type. &return.success; </para> <para> See also <function>pdf_set_value</function>. http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-open.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-open.xml diff -u phpdoc/en/reference/pdf/functions/pdf-open.xml:1.3 phpdoc/en/reference/pdf/functions/pdf-open.xml:1.4 --- phpdoc/en/reference/pdf/functions/pdf-open.xml:1.3 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-open.xml Thu Dec 8 08:45:02 2005 @@ -1,16 +1,16 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-open"> <refnamediv> <refname>pdf_open</refname> - <refpurpose>Deprecated: Open a new pdf object</refpurpose> + <refpurpose>Open PDFlib object [not supported]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <para> - This function is deprecated, use <function>pdf_new</function> - plus <function>pdf_open_file</function> instead. + This function is not supported, use <function>pdf_new</function> + plus <function>pdf_open_file</function>. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-get-image-width.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-get-image-width.xml diff -u phpdoc/en/reference/pdf/functions/pdf-get-image-width.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-get-image-width.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-get-image-width.xml:1.4 Sat Aug 9 00:31:33 2003 +++ phpdoc/en/reference/pdf/functions/pdf-get-image-width.xml Thu Dec 8 08:45:02 2005 @@ -1,16 +1,17 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-get-image-width"> <refnamediv> <refname>pdf_get_image_width</refname> - <refpurpose>Deprecated: Returns width of an image</refpurpose> + <refpurpose>Get image width [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <para> - This function is deprecated, use <function>pdf_get_value</function> - instead. + This function is deprecated since PDFlib version 3, use + <function>pdf_get_value</function> with the parameter + <parameter>imagewidth</parameter> instead. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-get-buffer.xml?r1=1.6&r2=1.7&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-get-buffer.xml diff -u phpdoc/en/reference/pdf/functions/pdf-get-buffer.xml:1.6 phpdoc/en/reference/pdf/functions/pdf-get-buffer.xml:1.7 --- phpdoc/en/reference/pdf/functions/pdf-get-buffer.xml:1.6 Tue Jul 27 00:48:55 2004 +++ phpdoc/en/reference/pdf/functions/pdf-get-buffer.xml Thu Dec 8 08:45:02 2005 @@ -1,19 +1,19 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-get-buffer"> <refnamediv> <refname>pdf_get_buffer</refname> - <refpurpose>Fetch the buffer containing the generated PDF data</refpurpose> + <refpurpose>Get PDF output buffer</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>pdf_get_buffer</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> </methodsynopsis> <para> - Get the contents of the PDF output buffer. The result must be + Fetches the buffer containing the generated PDF data. The result must be used by the client before calling any other PDFlib function. </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-setcolor.xml?r1=1.8&r2=1.9&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-setcolor.xml diff -u phpdoc/en/reference/pdf/functions/pdf-setcolor.xml:1.8 phpdoc/en/reference/pdf/functions/pdf-setcolor.xml:1.9 --- phpdoc/en/reference/pdf/functions/pdf-setcolor.xml:1.8 Fri Jul 22 08:09:30 2005 +++ phpdoc/en/reference/pdf/functions/pdf-setcolor.xml Thu Dec 8 08:45:02 2005 @@ -1,17 +1,17 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-setcolor"> <refnamediv> <refname>pdf_setcolor</refname> - <refpurpose>Sets fill and stroke color</refpurpose> + <refpurpose>Set fill and stroke color</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_setcolor</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> - <methodparam><type>string</type><parameter>type</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> + <methodparam><type>string</type><parameter>fstype</parameter></methodparam> <methodparam><type>string</type><parameter>colorspace</parameter></methodparam> <methodparam><type>float</type><parameter>c1</parameter></methodparam> <methodparam><type>float</type><parameter>c2</parameter></methodparam> @@ -19,65 +19,7 @@ <methodparam><type>float</type><parameter>c4</parameter></methodparam> </methodsynopsis> <para> - Set the current color space and color. &return.success; - The parameter <parameter>type</parameter> can be <literal>fill</literal>, - <literal>stroke</literal> or <literal>both</literal> to specify that the - color is set for filling, stroking or both filling and stroking. - The parameter <parameter>colorspace</parameter> can be - <literal>gray</literal>, <literal>rgb</literal>, - <literal>cmyk</literal>, <literal>spot</literal> or - <literal>pattern</literal>. The parameters <parameter>c1</parameter>, - <parameter>c2</parameter>, <parameter>c3</parameter> and - <parameter>c4</parameter> represent the color components for the color - space specified by <parameter>colorspace</parameter>. Except as - otherwise noted, the color components are floating-point values that - range from 0 to 1. - Parameters <parameter>c2</parameter>, <parameter>c3</parameter> and - <parameter>c4</parameter> are optional before PHP 4.3.5 or with PDFlib - less than 5. - </para> - <para> - For <literal>gray</literal> only <parameter>c1</parameter> is used. - </para> - <para> - For <literal>rgb</literal> parameters <parameter>c1</parameter>, - <parameter>c2</parameter>, and <parameter>c3</parameter> specify the - red, green and blue values respectively. - <informalexample> - <programlisting role="php"> -<![CDATA[ -<?php -// Set fill and stroke colors to white. -pdf_setcolor($pdf, "both", "rgb", 1, 1, 1); -?> -]]> - </programlisting> - </informalexample> - </para> - <para> - For <literal>cmyk</literal>, parameters <parameter>c1</parameter>, - <parameter>c2</parameter>, <parameter>c3</parameter>, and - <parameter>c4</parameter> are the cyan, magenta, yellow and black - values, respectively. - <informalexample> - <programlisting role="php"> -<![CDATA[ -<?php -// Set fill and stroke colors to black. -pdf_setcolor($pdf, "both", "cmyk", 0, 0, 0, 1); -?> -]]> - </programlisting> - </informalexample> - </para> - <para> - For <literal>spot</literal>, <parameter>c1</parameter> should be - a spot color handles returned by <function>pdf_makespotcolor</function> - and <parameter>c2</parameter> is a tint value between 0 and 1. - </para> - <para> - For <literal>pattern</literal>, <parameter>c1</parameter> should be - a pattern handle returned by <function>pdf_begin_pattern</function>. + Sets the current color space and color. &return.success; </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-setgray.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-setgray.xml diff -u phpdoc/en/reference/pdf/functions/pdf-setgray.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-setgray.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-setgray.xml:1.4 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-setgray.xml Thu Dec 8 08:45:02 2005 @@ -1,24 +1,25 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-setgray"> <refnamediv> <refname>pdf_setgray</refname> - <refpurpose>Sets drawing and filling color to gray value</refpurpose> + <refpurpose>Set color to gray [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_setgray</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> - <methodparam><type>float</type><parameter>gray</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> + <methodparam><type>float</type><parameter>g</parameter></methodparam> </methodsynopsis> <para> - Set the current fill and stroke color. &return.success; + Sets the current fill and stroke color to a gray value between 0 and 1 inclusive. &return.success; </para> <note> <para> - PDFlib V4.0: Deprecated, use <function>pdf_setcolor</function> instead. + This function is deprecated since PDFlib version 4, use + <function>pdf_setcolor</function> instead. </para> </note> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-open-jpeg.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-open-jpeg.xml diff -u phpdoc/en/reference/pdf/functions/pdf-open-jpeg.xml:1.3 phpdoc/en/reference/pdf/functions/pdf-open-jpeg.xml:1.4 --- phpdoc/en/reference/pdf/functions/pdf-open-jpeg.xml:1.3 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-open-jpeg.xml Thu Dec 8 08:45:02 2005 @@ -1,16 +1,16 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-open-jpeg"> <refnamediv> <refname>pdf_open_jpeg</refname> - <refpurpose>Deprecated: Opens a JPEG image</refpurpose> + <refpurpose>Open JPEG image [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <para> - This function is deprecated, use <function>pdf_open_image</function> - instead. + This function is deprecated since PDFlib version 3, use + <function>pdf_load_image</function> instead. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-add-pdflink.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-add-pdflink.xml diff -u phpdoc/en/reference/pdf/functions/pdf-add-pdflink.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-add-pdflink.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-add-pdflink.xml:1.4 Sat Aug 9 00:31:33 2003 +++ phpdoc/en/reference/pdf/functions/pdf-add-pdflink.xml Thu Dec 8 08:45:02 2005 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-add-pdflink"> <refnamediv> <refname>pdf_add_pdflink</refname> - <refpurpose>Adds file link annotation for current page</refpurpose> + <refpurpose>Add file link annotation for current page [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_add_pdflink</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> @@ -24,8 +24,8 @@ &return.success; </para> <para> - See also <function>pdf_add_locallink</function> and - <function>pdf_add_weblink</function>. + This function is deprecated since PDFlib version 6, use <function>pdf_create_action</function> with <parameter>type=GoToR</parameter> and <function>pdf_create_annotation</function> with +<parameter>type=Link</parameter> instead. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-setflat.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-setflat.xml diff -u phpdoc/en/reference/pdf/functions/pdf-setflat.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-setflat.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-setflat.xml:1.4 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-setflat.xml Thu Dec 8 08:45:02 2005 @@ -1,20 +1,20 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-setflat"> <refnamediv> <refname>pdf_setflat</refname> - <refpurpose>Sets flatness</refpurpose> + <refpurpose>Set flatness</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_setflat</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>float</type><parameter>flatness</parameter></methodparam> </methodsynopsis> <para> - Sets the flatness to a value between 0 and 100 inclusive. &return.success; + Sets the flatness parameter. &return.success; </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-initgraphics.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-initgraphics.xml diff -u phpdoc/en/reference/pdf/functions/pdf-initgraphics.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-initgraphics.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-initgraphics.xml:1.4 Sat Aug 9 00:31:33 2003 +++ phpdoc/en/reference/pdf/functions/pdf-initgraphics.xml Thu Dec 8 08:45:02 2005 @@ -1,19 +1,19 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-initgraphics"> <refnamediv> <refname>pdf_initgraphics</refname> - <refpurpose>Resets graphic state</refpurpose> + <refpurpose>Reset graphic state</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_initgraphics</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> </methodsynopsis> <para> - Reset all implicit color and graphics state parameters to their defaults. + Reset all color and graphics state parameters to their defaults. &return.success; </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-begin-page.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-begin-page.xml diff -u phpdoc/en/reference/pdf/functions/pdf-begin-page.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-begin-page.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-begin-page.xml:1.4 Sat Aug 9 00:31:33 2003 +++ phpdoc/en/reference/pdf/functions/pdf-begin-page.xml Thu Dec 8 08:45:02 2005 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-begin-page"> <refnamediv> <refname>pdf_begin_page</refname> - <refpurpose>Starts new page</refpurpose> + <refpurpose>Start new page [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_begin_page</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> @@ -20,6 +20,9 @@ specified in points, which are 1/72 of an inch. </para> <para> + This function is deprecated since PDFlib version 6, use <function>pdf_begin_page_ext</function> instead. + </para> + <para> <table> <title>Common Page Sizes in Points</title> <tgroup cols="2"> @@ -82,9 +85,6 @@ </tgroup> </table> </para> - <para> - See also <function>pdf_end_page</function>. - </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-end-page.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-end-page.xml diff -u phpdoc/en/reference/pdf/functions/pdf-end-page.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-end-page.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-end-page.xml:1.4 Sat Aug 9 00:31:33 2003 +++ phpdoc/en/reference/pdf/functions/pdf-end-page.xml Thu Dec 8 08:45:02 2005 @@ -1,22 +1,22 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-end-page"> <refnamediv> <refname>pdf_end_page</refname> - <refpurpose>Ends a page</refpurpose> + <refpurpose>Finish page</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_end_page</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> </methodsynopsis> <para> - Finish the page. &return.success; + Finishes the page. &return.success; </para> <para> - See also <function>pdf_begin_page</function>. + See also <function>pdf_begin_page_ext</function>. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-rotate.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-rotate.xml diff -u phpdoc/en/reference/pdf/functions/pdf-rotate.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-rotate.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-rotate.xml:1.4 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-rotate.xml Thu Dec 8 08:45:02 2005 @@ -1,20 +1,20 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-rotate"> <refnamediv> <refname>pdf_rotate</refname> - <refpurpose>Sets rotation</refpurpose> + <refpurpose>Rotate coordinate system</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_rotate</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> <methodparam><type>float</type><parameter>phi</parameter></methodparam> </methodsynopsis> <para> - Rotate the coordinate system by <parameter>phi</parameter> degrees. + Rotates the coordinate system by <parameter>phi</parameter> degrees. &return.success; </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-show-boxed.xml?r1=1.7&r2=1.8&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-show-boxed.xml diff -u phpdoc/en/reference/pdf/functions/pdf-show-boxed.xml:1.7 phpdoc/en/reference/pdf/functions/pdf-show-boxed.xml:1.8 --- phpdoc/en/reference/pdf/functions/pdf-show-boxed.xml:1.7 Fri Jul 22 08:09:30 2005 +++ phpdoc/en/reference/pdf/functions/pdf-show-boxed.xml Thu Dec 8 08:45:02 2005 @@ -1,16 +1,16 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-show-boxed"> <refnamediv> <refname>pdf_show_boxed</refname> - <refpurpose>Output text in a box</refpurpose> + <refpurpose>Output text in a box [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>pdf_show_boxed</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> <methodparam><type>string</type><parameter>text</parameter></methodparam> <methodparam><type>float</type><parameter>left</parameter></methodparam> <methodparam><type>float</type><parameter>top</parameter></methodparam> @@ -19,7 +19,11 @@ <methodparam><type>string</type><parameter>mode</parameter></methodparam> <methodparam><type>string</type><parameter>feature</parameter></methodparam> </methodsynopsis> - <para> + <para>This function is deprecated since PDFlib version 6, use + <function>pdf_fit_textline</function> for single lines, or the + <function>PDF_*_textflow</function> functions for multi-line formatting instead. + </para> + <para> Format <parameter>text</parameter> in the current font and size into the supplied text box according to the requested formatting <parameter>mode</parameter>, which must be one of <literal>left</literal>, http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-setrgbcolor-stroke.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-setrgbcolor-stroke.xml diff -u phpdoc/en/reference/pdf/functions/pdf-setrgbcolor-stroke.xml:1.5 phpdoc/en/reference/pdf/functions/pdf-setrgbcolor-stroke.xml:1.6 --- phpdoc/en/reference/pdf/functions/pdf-setrgbcolor-stroke.xml:1.5 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-setrgbcolor-stroke.xml Thu Dec 8 08:45:02 2005 @@ -1,28 +1,27 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-setrgbcolor-stroke"> <refnamediv> <refname>pdf_setrgbcolor_stroke</refname> - <refpurpose>Sets drawing color to rgb color value</refpurpose> + <refpurpose>Set stroke rgb color values [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_setrgbcolor_stroke</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> - <methodparam><type>float</type><parameter>red_value</parameter></methodparam> - <methodparam><type>float</type><parameter>green_value</parameter></methodparam> - <methodparam><type>float</type><parameter>blue_value</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> + <methodparam><type>float</type><parameter>red</parameter></methodparam> + <methodparam><type>float</type><parameter>green</parameter></methodparam> + <methodparam><type>float</type><parameter>blue</parameter></methodparam> </methodsynopsis> <para> - Set the current stroke color to the supplied RGB values. &return.success; + Sets the current stroke color to the supplied RGB values. &return.success; + </para> + <para> + This function is deprecated since PDFlib version 4, use + <function>pdf_setcolor</function> instead. </para> - <note> - <para> - PDFlib V4.0: Deprecated, use <function>pdf_setcolor</function> instead. - </para> - </note> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-closepath.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-closepath.xml diff -u phpdoc/en/reference/pdf/functions/pdf-closepath.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-closepath.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-closepath.xml:1.4 Sat Aug 9 00:31:33 2003 +++ phpdoc/en/reference/pdf/functions/pdf-closepath.xml Thu Dec 8 08:45:02 2005 @@ -1,19 +1,19 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-closepath"> <refnamediv> <refname>pdf_closepath</refname> - <refpurpose>Closes path</refpurpose> + <refpurpose>Close current path</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_closepath</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> </methodsynopsis> <para> - Close the current path. &return.success; + Closes the current path. &return.success; </para> <para> See also <function>pdf_closepath_stroke</function> and http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-open-gif.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-open-gif.xml diff -u phpdoc/en/reference/pdf/functions/pdf-open-gif.xml:1.3 phpdoc/en/reference/pdf/functions/pdf-open-gif.xml:1.4 --- phpdoc/en/reference/pdf/functions/pdf-open-gif.xml:1.3 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-open-gif.xml Thu Dec 8 08:45:02 2005 @@ -1,16 +1,16 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-open-gif"> <refnamediv> <refname>pdf_open_gif</refname> - <refpurpose>Deprecated: Opens a GIF image</refpurpose> + <refpurpose>Open GIF image [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <para> - This function is deprecated, use <function>pdf_open_image</function> - instead. + This function is deprecated since PDFlib version 3, use + <function>pdf_load_image</function> instead. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-set-text-matrix.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-set-text-matrix.xml diff -u phpdoc/en/reference/pdf/functions/pdf-set-text-matrix.xml:1.3 phpdoc/en/reference/pdf/functions/pdf-set-text-matrix.xml:1.4 --- phpdoc/en/reference/pdf/functions/pdf-set-text-matrix.xml:1.3 Thu May 13 09:32:41 2004 +++ phpdoc/en/reference/pdf/functions/pdf-set-text-matrix.xml Thu Dec 8 08:45:02 2005 @@ -1,16 +1,17 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-set-text-matrix"> <refnamediv> <refname>pdf_set_text_matrix</refname> - <refpurpose>Deprecated: Sets the text matrix</refpurpose> + <refpurpose>Set text matrix [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <para> - This function is deprecated, use <function>pdf_set_parameter</function> - instead. + This function is deprecated since PDFlib version 3, use + <function>pdf_scale</function>, <function>pdf_translate</function>, + <function>pdf_rotate</function>, or <function>pdf_skew</function> instead. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-begin-template.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-begin-template.xml diff -u phpdoc/en/reference/pdf/functions/pdf-begin-template.xml:1.5 phpdoc/en/reference/pdf/functions/pdf-begin-template.xml:1.6 --- phpdoc/en/reference/pdf/functions/pdf-begin-template.xml:1.5 Sat Aug 9 00:31:33 2003 +++ phpdoc/en/reference/pdf/functions/pdf-begin-template.xml Thu Dec 8 08:45:02 2005 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-begin-template"> <refnamediv> <refname>pdf_begin_template</refname> - <refpurpose>Starts new template</refpurpose> + <refpurpose>Start template definition</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>pdf_begin_template</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> @@ -15,7 +15,7 @@ <methodparam><type>float</type><parameter>height</parameter></methodparam> </methodsynopsis> <para> - Start a new template definition. + Starts a new template definition. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-set-value.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-set-value.xml diff -u phpdoc/en/reference/pdf/functions/pdf-set-value.xml:1.5 phpdoc/en/reference/pdf/functions/pdf-set-value.xml:1.6 --- phpdoc/en/reference/pdf/functions/pdf-set-value.xml:1.5 Wed Apr 14 20:43:58 2004 +++ phpdoc/en/reference/pdf/functions/pdf-set-value.xml Thu Dec 8 08:45:02 2005 @@ -1,21 +1,21 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-set-value"> <refnamediv> <refname>pdf_set_value</refname> - <refpurpose>Sets certain numerical value</refpurpose> + <refpurpose>Set numerical parameter</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_set_value</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> <methodparam><type>string</type><parameter>key</parameter></methodparam> <methodparam><type>float</type><parameter>value</parameter></methodparam> </methodsynopsis> <para> - Set the value of some PDFlib parameter with float type. &return.success; + Sets the value of some PDFlib parameter with numerical type. &return.success; </para> <para> See also <function>pdf_set_parameter</function>. http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-set-info.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-set-info.xml diff -u phpdoc/en/reference/pdf/functions/pdf-set-info.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-set-info.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-set-info.xml:1.4 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-set-info.xml Thu Dec 8 08:45:02 2005 @@ -1,26 +1,22 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.72 --> <refentry id="function.pdf-set-info"> <refnamediv> <refname>pdf_set_info</refname> - <refpurpose>Fills a field of the document information</refpurpose> + <refpurpose>Fill document info field</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_set_info</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> <methodparam><type>string</type><parameter>key</parameter></methodparam> <methodparam><type>string</type><parameter>value</parameter></methodparam> </methodsynopsis> <para> Fill document information field <parameter>key</parameter> with <parameter>value</parameter>. &return.success; - <parameter>key</parameter> is one of <literal>Subject</literal>, - <literal>Title</literal>, <literal>Creator</literal>, - <literal>Author</literal>, <literal>Keywords</literal>, - or a user-defined key. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-begin-pattern.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-begin-pattern.xml diff -u phpdoc/en/reference/pdf/functions/pdf-begin-pattern.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-begin-pattern.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-begin-pattern.xml:1.4 Sat Aug 9 00:31:33 2003 +++ phpdoc/en/reference/pdf/functions/pdf-begin-pattern.xml Thu Dec 8 08:45:02 2005 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-begin-pattern"> <refnamediv> <refname>pdf_begin_pattern</refname> - <refpurpose>Starts new pattern</refpurpose> + <refpurpose>Start pattern definition</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>pdf_begin_pattern</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> @@ -20,7 +20,7 @@ <para> Starts a new pattern definition and returns a pattern handle. <parameter>width</parameter>, and <parameter>height</parameter> - define the bounding box for the pattern. <parameter>xstep</parameter> + define the bounding box for the pattern. <parameter>xstep</parameter> and <parameter>ystep</parameter> give the repeated pattern offsets. <parameter>painttype</parameter>=1 means that the pattern has its own colour settings whereas a value of 2 indicates that the current http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-closepath-stroke.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-closepath-stroke.xml diff -u phpdoc/en/reference/pdf/functions/pdf-closepath-stroke.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-closepath-stroke.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-closepath-stroke.xml:1.4 Sat Aug 9 00:31:33 2003 +++ phpdoc/en/reference/pdf/functions/pdf-closepath-stroke.xml Thu Dec 8 08:45:02 2005 @@ -1,23 +1,23 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-closepath-stroke"> <refnamediv> <refname>pdf_closepath_stroke</refname> - <refpurpose>Closes path and draws line along path</refpurpose> + <refpurpose>Close and stroke path</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_closepath_stroke</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> </methodsynopsis> <para> - Close the path, and stroke it. &return.success; + Closes the path, and strokes it. &return.success; </para> <para> See also <function>pdf_closepath</function> and - <function>pdf_closepath_fil_stroke</function>. + <function>pdf_closepath_fill_stroke</function>. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-clip.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-clip.xml diff -u phpdoc/en/reference/pdf/functions/pdf-clip.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-clip.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-clip.xml:1.4 Sat Aug 9 00:31:33 2003 +++ phpdoc/en/reference/pdf/functions/pdf-clip.xml Thu Dec 8 08:45:02 2005 @@ -1,19 +1,19 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-clip"> <refnamediv> <refname>pdf_clip</refname> - <refpurpose>Clips to current path</refpurpose> + <refpurpose>Clip to current path</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_clip</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> </methodsynopsis> <para> - Use the current path as clipping path. &return.success; + Uses the current path as clipping path, and terminate the path. &return.success; </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-open-tiff.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-open-tiff.xml diff -u phpdoc/en/reference/pdf/functions/pdf-open-tiff.xml:1.3 phpdoc/en/reference/pdf/functions/pdf-open-tiff.xml:1.4 --- phpdoc/en/reference/pdf/functions/pdf-open-tiff.xml:1.3 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-open-tiff.xml Thu Dec 8 08:45:02 2005 @@ -1,16 +1,16 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-open-tiff"> <refnamediv> <refname>pdf_open_tiff</refname> - <refpurpose>Deprecated: Opens a TIFF image</refpurpose> + <refpurpose>Open TIFF image [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <para> - This function is deprecated, use <function>pdf_open_image</function> - instead. + This function is deprecated since PDFlib version 3, use + <function>pdf_load_image</function> instead. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-scale.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-scale.xml diff -u phpdoc/en/reference/pdf/functions/pdf-scale.xml:1.5 phpdoc/en/reference/pdf/functions/pdf-scale.xml:1.6 --- phpdoc/en/reference/pdf/functions/pdf-scale.xml:1.5 Tue Nov 23 04:38:17 2004 +++ phpdoc/en/reference/pdf/functions/pdf-scale.xml Thu Dec 8 08:45:02 2005 @@ -1,21 +1,22 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-scale"> <refnamediv> <refname>pdf_scale</refname> - <refpurpose>Sets scaling</refpurpose> + <refpurpose>Scale coordinate system</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_scale</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> - <methodparam><type>float</type><parameter>x_scale</parameter></methodparam> - <methodparam><type>float</type><parameter>y_scale</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> + <methodparam><type>float</type><parameter>sx</parameter></methodparam> + <methodparam><type>float</type><parameter>sy</parameter></methodparam> </methodsynopsis> <para> - Scale the coordinate system. &return.success; + Scales the coordinate system by <parameter>sx</parameter> in x direction + and <parameter>sy</parameter> in y direction. &return.success; </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-setrgbcolor-fill.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-setrgbcolor-fill.xml diff -u phpdoc/en/reference/pdf/functions/pdf-setrgbcolor-fill.xml:1.5 phpdoc/en/reference/pdf/functions/pdf-setrgbcolor-fill.xml:1.6 --- phpdoc/en/reference/pdf/functions/pdf-setrgbcolor-fill.xml:1.5 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-setrgbcolor-fill.xml Thu Dec 8 08:45:02 2005 @@ -1,28 +1,27 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-setrgbcolor-fill"> <refnamediv> <refname>pdf_setrgbcolor_fill</refname> - <refpurpose>Sets filling color to rgb color value</refpurpose> + <refpurpose>Set fill rgb color values [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_setrgbcolor_fill</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> - <methodparam><type>float</type><parameter>red_value</parameter></methodparam> - <methodparam><type>float</type><parameter>green_value</parameter></methodparam> - <methodparam><type>float</type><parameter>blue_value</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> + <methodparam><type>float</type><parameter>red</parameter></methodparam> + <methodparam><type>float</type><parameter>green</parameter></methodparam> + <methodparam><type>float</type><parameter>blue</parameter></methodparam> </methodsynopsis> <para> - Set the current fill color to the supplied RGB values. &return.success; + Sets the current fill color to the supplied RGB values. &return.success; + </para> + <para> + This function is deprecated since PDFlib version 4, use + <function>pdf_setcolor</function> instead. </para> - <note> - <para> - PDFlib V4.0: Deprecated, use <function>pdf_setcolor</function> instead. - </para> - </note> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-translate.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-translate.xml diff -u phpdoc/en/reference/pdf/functions/pdf-translate.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-translate.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-translate.xml:1.4 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-translate.xml Thu Dec 8 08:45:02 2005 @@ -1,21 +1,21 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-translate"> <refnamediv> <refname>pdf_translate</refname> - <refpurpose>Sets origin of coordinate system</refpurpose> + <refpurpose>Set origin of coordinate system</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_translate</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> <methodparam><type>float</type><parameter>tx</parameter></methodparam> <methodparam><type>float</type><parameter>ty</parameter></methodparam> </methodsynopsis> <para> - Translate the origin of the coordinate system. + Translates the origin of the coordinate system. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-close-pdi.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-close-pdi.xml diff -u phpdoc/en/reference/pdf/functions/pdf-close-pdi.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-close-pdi.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-close-pdi.xml:1.4 Sat Aug 9 00:31:33 2003 +++ phpdoc/en/reference/pdf/functions/pdf-close-pdi.xml Thu Dec 8 08:45:02 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-close-pdi"> <refnamediv> @@ -8,15 +8,15 @@ Close the input PDF document </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_close_pdi</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> - <methodparam><type>int</type><parameter>dochandle</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> + <methodparam><type>int</type><parameter>doc</parameter></methodparam> </methodsynopsis> <para> - Close all open page handles, and close the input PDF document. &return.success; + Closes all open page handles, and closes the input PDF document. &return.success; </para> <para> See also <function>pdf_open_pdi</function>. http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-get-font.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-get-font.xml diff -u phpdoc/en/reference/pdf/functions/pdf-get-font.xml:1.3 phpdoc/en/reference/pdf/functions/pdf-get-font.xml:1.4 --- phpdoc/en/reference/pdf/functions/pdf-get-font.xml:1.3 Sat Aug 9 00:31:33 2003 +++ phpdoc/en/reference/pdf/functions/pdf-get-font.xml Thu Dec 8 08:45:02 2005 @@ -1,16 +1,17 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-get-font"> <refnamediv> <refname>pdf_get_font</refname> - <refpurpose>Deprecated: font handling</refpurpose> + <refpurpose>Get font [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <para> - This function is deprecated, use <function>pdf_get_value</function> - instead. + This function is deprecated since PDFlib version 3, + use <function>pdf_get_value</function> with the parameter + <parameter>font</parameter> instead. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-place-pdi-page.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-place-pdi-page.xml diff -u phpdoc/en/reference/pdf/functions/pdf-place-pdi-page.xml:1.5 phpdoc/en/reference/pdf/functions/pdf-place-pdi-page.xml:1.6 --- phpdoc/en/reference/pdf/functions/pdf-place-pdi-page.xml:1.5 Thu Oct 23 06:26:17 2003 +++ phpdoc/en/reference/pdf/functions/pdf-place-pdi-page.xml Thu Dec 8 08:45:02 2005 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-place-pdi-page"> <refnamediv> <refname>pdf_place_pdi_page</refname> - <refpurpose>Places an image on the page</refpurpose> + <refpurpose>Place PDF page [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_place_pdi_page</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> @@ -18,9 +18,13 @@ <methodparam><type>float</type><parameter>sy</parameter></methodparam> </methodsynopsis> <para> - Place a PDI page with the lower left corner at (<parameter>x</parameter>, - <parameter>y</parameter>), and scale it. &return.success; + Places a PDF page with the lower left corner at (<parameter>x</parameter>, + <parameter>y</parameter>), and scales it. &return.success; </para> + <para> + This function is deprecated since PDFlib version 5, use + <function>pdf_fit_pdi_page</function> instead. + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-concat.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-concat.xml diff -u phpdoc/en/reference/pdf/functions/pdf-concat.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-concat.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-concat.xml:1.4 Sat Aug 9 00:31:33 2003 +++ phpdoc/en/reference/pdf/functions/pdf-concat.xml Thu Dec 8 08:45:02 2005 @@ -1,16 +1,16 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-concat"> <refnamediv> <refname>pdf_concat</refname> <refpurpose>Concatenate a matrix to the CTM</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_concat</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> <methodparam><type>float</type><parameter>a</parameter></methodparam> <methodparam><type>float</type><parameter>b</parameter></methodparam> <methodparam><type>float</type><parameter>c</parameter></methodparam> @@ -19,7 +19,7 @@ <methodparam><type>float</type><parameter>f</parameter></methodparam> </methodsynopsis> <para> - Concatenate a matrix to the CTM. &return.success; + Concatenates a matrix to the current transformation matrix (CTM). &return.success; </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-set-info-author.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-set-info-author.xml diff -u phpdoc/en/reference/pdf/functions/pdf-set-info-author.xml:1.3 phpdoc/en/reference/pdf/functions/pdf-set-info-author.xml:1.4 --- phpdoc/en/reference/pdf/functions/pdf-set-info-author.xml:1.3 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-set-info-author.xml Thu Dec 8 08:45:02 2005 @@ -1,17 +1,18 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.72 --> <refentry id='function.pdf-set-info-author'> <refnamediv> <refname>pdf_set_info_author</refname> <refpurpose> - Deprecated: Fills the author field of the document - </refpurpose> + Fill the author document info field [deprecated] + </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <para> - This function is deprecated, use <function>pdf_set_info</function> instead. + This function is deprecated since PDFlib version 3, use + <function>pdf_set_info</function> instead. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-set-word-spacing.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-set-word-spacing.xml diff -u phpdoc/en/reference/pdf/functions/pdf-set-word-spacing.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-set-word-spacing.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-set-word-spacing.xml:1.4 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-set-word-spacing.xml Thu Dec 8 08:45:02 2005 @@ -1,16 +1,17 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-set-word-spacing"> <refnamediv> <refname>pdf_set_word_spacing</refname> - <refpurpose>Deprecated: Sets spacing between words</refpurpose> + <refpurpose>Set spacing between words [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <para> - This function is deprecated, use <function>pdf_set_value</function> - instead. + This function is deprecated since PDFlib version 3, use + <function>pdf_set_value</function> with the <parameter>wordspacing</parameter> + parameter instead. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-add-note.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-add-note.xml diff -u phpdoc/en/reference/pdf/functions/pdf-add-note.xml:1.5 phpdoc/en/reference/pdf/functions/pdf-add-note.xml:1.6 --- phpdoc/en/reference/pdf/functions/pdf-add-note.xml:1.5 Fri Sep 9 01:15:13 2005 +++ phpdoc/en/reference/pdf/functions/pdf-add-note.xml Thu Dec 8 08:45:02 2005 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-add-note"> <refnamediv> <refname>pdf_add_note</refname> - <refpurpose>Sets annotation for current page</refpurpose> + <refpurpose>Set annotation for current page [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_add_note</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> @@ -26,36 +26,10 @@ <literal>paragraph</literal>, <literal>newparagraph</literal>, <literal>key</literal>, or <literal>help</literal>. &return.success; </para> - <para> - <example> - <title>Adding a note to a PDF document with PDFlib</title> - <programlisting role="php"> -<![CDATA[ -<?php -$pdfdoc = pdf_new(); -if (!pdf_open_file($pdfdoc, '')) { - echo 'error!'; - exit; -} -pdf_begin_page($pdfdoc, 300, 300); -if ($font = pdf_findfont($pdfdoc, 'Times-Roman', 'host', 0)) { - pdf_setfont($pdfdoc, $font, 10); -} -pdf_set_value($pdfdoc, 'textrendering', 0); -pdf_add_note($pdfdoc, 100, 100, 180, 40, 'Note Content', 'Title', 'help', 0); -pdf_show_xy($pdfdoc, 'Example', 100, 100); -pdf_end_page($pdfdoc); -pdf_close($pdfdoc); -$data = pdf_get_buffer($pdfdoc); -header('Content-type: application/pdf'); -header('Content-disposition: inline; filename=example.pdf'); -header('Content-length: '.strlen($data)); -echo $data; -?> -]]> - </programlisting> - </example> - </para> + <para> + This function is deprecated since PDFlib version 6, use + <function>pdf_create_annotation</function> with <parameter>type=Text</parameter> instead. + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-set-text-rendering.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-set-text-rendering.xml diff -u phpdoc/en/reference/pdf/functions/pdf-set-text-rendering.xml:1.3 phpdoc/en/reference/pdf/functions/pdf-set-text-rendering.xml:1.4 --- phpdoc/en/reference/pdf/functions/pdf-set-text-rendering.xml:1.3 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-set-text-rendering.xml Thu Dec 8 08:45:02 2005 @@ -1,16 +1,17 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-set-text-rendering"> <refnamediv> <refname>pdf_set_text_rendering</refname> - <refpurpose>Deprecated: Determines how text is rendered</refpurpose> + <refpurpose>Determine text rendering [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <para> - This function is deprecated, use <function>pdf_set_value</function> - instead. + This function is deprecated since PDFlib version 3, use + <function>pdf_set_value</function> with the + <parameter>textrendering</parameter> parameter instead. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-add-thumbnail.xml?r1=1.6&r2=1.7&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-add-thumbnail.xml diff -u phpdoc/en/reference/pdf/functions/pdf-add-thumbnail.xml:1.6 phpdoc/en/reference/pdf/functions/pdf-add-thumbnail.xml:1.7 --- phpdoc/en/reference/pdf/functions/pdf-add-thumbnail.xml:1.6 Sat May 15 10:31:43 2004 +++ phpdoc/en/reference/pdf/functions/pdf-add-thumbnail.xml Thu Dec 8 08:45:02 2005 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-add-thumbnail"> <refnamediv> <refname>pdf_add_thumbnail</refname> - <refpurpose>Adds thumbnail for current page</refpurpose> + <refpurpose>Add thumbnail for current page</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_add_thumbnail</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> @@ -18,11 +18,6 @@ Thumbnail images must not be wider or higher than 106 pixels. &return.success; </para> - <para> - See also <function>pdf_open_image</function>, - <function>pdf_open_image_file</function> and - <function>pdf_open_memory_image</function>. - </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-restore.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-restore.xml diff -u phpdoc/en/reference/pdf/functions/pdf-restore.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-restore.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-restore.xml:1.4 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-restore.xml Thu Dec 8 08:45:02 2005 @@ -1,19 +1,19 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-restore"> <refnamediv> <refname>pdf_restore</refname> - <refpurpose>Restores formerly saved environment</refpurpose> + <refpurpose>Restore graphics state</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_restore</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> </methodsynopsis> <para> - Restore the most recently saved graphics state. &return.success; + Restores the most recently saved graphics state. &return.success; </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-set-border-dash.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-set-border-dash.xml diff -u phpdoc/en/reference/pdf/functions/pdf-set-border-dash.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-set-border-dash.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-set-border-dash.xml:1.4 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-set-border-dash.xml Thu Dec 8 08:45:02 2005 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-set-border-dash"> <refnamediv> <refname>pdf_set_border_dash</refname> - <refpurpose>Sets dash style of border around links and annotations</refpurpose> + <refpurpose>Set border dash style of annotations [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_set_border_dash</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> @@ -18,7 +18,9 @@ Sets the border dash style for all kinds of annotations. &return.success; </para> <para> - See also <function>pdf_setdash</function>. + This function is deprecated since PDFlib version 6, use + the option <parameter>dasharray</parameter> in + <function>pdf_create_annotation</function> instead. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-setmiterlimit.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-setmiterlimit.xml diff -u phpdoc/en/reference/pdf/functions/pdf-setmiterlimit.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-setmiterlimit.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-setmiterlimit.xml:1.4 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-setmiterlimit.xml Thu Dec 8 08:45:03 2005 @@ -1,20 +1,20 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-setmiterlimit"> <refnamediv> <refname>pdf_setmiterlimit</refname> - <refpurpose>Sets miter limit</refpurpose> + <refpurpose>Set miter limit</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_setmiterlimit</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>float</type><parameter>miter</parameter></methodparam> </methodsynopsis> <para> - Set the miter limit to a value greater than or equal to 1. &return.success; + Sets the miter limit.&return.success; </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-get-fontsize.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-get-fontsize.xml diff -u phpdoc/en/reference/pdf/functions/pdf-get-fontsize.xml:1.3 phpdoc/en/reference/pdf/functions/pdf-get-fontsize.xml:1.4 --- phpdoc/en/reference/pdf/functions/pdf-get-fontsize.xml:1.3 Sat Aug 9 00:31:33 2003 +++ phpdoc/en/reference/pdf/functions/pdf-get-fontsize.xml Thu Dec 8 08:45:03 2005 @@ -1,16 +1,17 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-get-fontsize"> <refnamediv> <refname>pdf_get_fontsize</refname> - <refpurpose>Deprecated: font handling</refpurpose> + <refpurpose>Font handling [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <para> - This function is deprecated, use <function>pdf_get_value</function> - instead. + This function is deprecated since PDFlib version 3, use + <function>pdf_get_value</function> with the parameter + <parameter>fontsize</parameter>instead. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-set-char-spacing.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-set-char-spacing.xml diff -u phpdoc/en/reference/pdf/functions/pdf-set-char-spacing.xml:1.3 phpdoc/en/reference/pdf/functions/pdf-set-char-spacing.xml:1.4 --- phpdoc/en/reference/pdf/functions/pdf-set-char-spacing.xml:1.3 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-set-char-spacing.xml Thu Dec 8 08:45:03 2005 @@ -1,16 +1,17 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-set-char-spacing"> <refnamediv> <refname>pdf_set_char_spacing</refname> - <refpurpose>Deprecated: Sets character spacing</refpurpose> + <refpurpose>Set character spacing [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <para> - This function is deprecated, use <function>pdf_set_value</function> - instead. + This function is deprecated since PDFlib version 3, use + <function>pdf_set_value</function> with parameter + <parameter>charspacing</parameter> instead. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-set-border-color.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-set-border-color.xml diff -u phpdoc/en/reference/pdf/functions/pdf-set-border-color.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-set-border-color.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-set-border-color.xml:1.4 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-set-border-color.xml Thu Dec 8 08:45:03 2005 @@ -1,23 +1,28 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-set-border-color"> <refnamediv> <refname>pdf_set_border_color</refname> - <refpurpose>Sets color of border around links and annotations</refpurpose> + <refpurpose>Set border color of annotations [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_set_border_color</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> <methodparam><type>float</type><parameter>red</parameter></methodparam> <methodparam><type>float</type><parameter>green</parameter></methodparam> <methodparam><type>float</type><parameter>blue</parameter></methodparam> </methodsynopsis> <para> - Set the border color for all kinds of annotations. &return.success; + Sets the border color for all kinds of annotations. &return.success; </para> + <para> + This function is deprecated since PDFlib version 6, use + the option <parameter>annotcolor</parameter> in + <function>pdf_create_annotation</function> instead. + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-attach-file.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-attach-file.xml diff -u phpdoc/en/reference/pdf/functions/pdf-attach-file.xml:1.5 phpdoc/en/reference/pdf/functions/pdf-attach-file.xml:1.6 --- phpdoc/en/reference/pdf/functions/pdf-attach-file.xml:1.5 Sat Aug 9 00:31:33 2003 +++ phpdoc/en/reference/pdf/functions/pdf-attach-file.xml Thu Dec 8 08:45:03 2005 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-attach-file"> <refnamediv> <refname>pdf_attach_file</refname> - <refpurpose>Adds a file attachment for current page</refpurpose> + <refpurpose>Add file attachment for current page [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_attach_file</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> @@ -26,14 +26,10 @@ <literal>graph</literal>, <literal>paperclip</literal>, <literal>pushpin</literal>, or <literal>tag</literal>. &return.success; </para> - <note> - <para> - Only the 'Full' Acrobat software will be able to display these file - attachments. All other PDF viewers will either show nothing or - display a question mark. - </para> - </note> - </refsect1> + <para> + This function is deprecated since PDFlib version 6, use <function>pdf_create_annotation</function> with <parameter>type=FileAttachment</parameter> instead. + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-get-value.xml?r1=1.6&r2=1.7&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-get-value.xml diff -u phpdoc/en/reference/pdf/functions/pdf-get-value.xml:1.6 phpdoc/en/reference/pdf/functions/pdf-get-value.xml:1.7 --- phpdoc/en/reference/pdf/functions/pdf-get-value.xml:1.6 Fri Jul 22 08:09:30 2005 +++ phpdoc/en/reference/pdf/functions/pdf-get-value.xml Thu Dec 8 08:45:03 2005 @@ -1,23 +1,21 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-get-value"> <refnamediv> <refname>pdf_get_value</refname> - <refpurpose>Gets certain numerical value</refpurpose> + <refpurpose>Get numerical parameter</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>float</type><methodname>pdf_get_value</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> <methodparam><type>string</type><parameter>key</parameter></methodparam> <methodparam><type>float</type><parameter>modifier</parameter></methodparam> </methodsynopsis> <para> - Get the contents of some PDFlib parameter with float type. - Parameter <parameter>modifier</parameter> is optional before PHP 4.3.5 - or with PDFlib less than 5. + Gets the value of some PDFlib parameter with numerical type. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-arcn.xml?r1=1.9&r2=1.10&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-arcn.xml diff -u phpdoc/en/reference/pdf/functions/pdf-arcn.xml:1.9 phpdoc/en/reference/pdf/functions/pdf-arcn.xml:1.10 --- phpdoc/en/reference/pdf/functions/pdf-arcn.xml:1.9 Tue Jan 6 07:50:51 2004 +++ phpdoc/en/reference/pdf/functions/pdf-arcn.xml Thu Dec 8 08:45:03 2005 @@ -1,16 +1,16 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> +<!-- $Revision: 1.10 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-arcn"> <refnamediv> <refname>pdf_arcn</refname> - <refpurpose>Draws an arc (clockwise)</refpurpose> + <refpurpose>Draw a clockwise circular arc segment</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_arcn</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> <methodparam><type>float</type><parameter>x</parameter></methodparam> <methodparam><type>float</type><parameter>y</parameter></methodparam> <methodparam><type>float</type><parameter>r</parameter></methodparam> @@ -18,55 +18,10 @@ <methodparam><type>float</type><parameter>beta</parameter></methodparam> </methodsynopsis> <para> - Add a clockwise circular arc from - <parameter>alpha</parameter> to <parameter>beta</parameter> degrees - with center (<parameter>x</parameter>; <parameter>y</parameter>) - and radius <parameter>r</parameter>. Actual drawing of the circle is performed by - the next stroke or fill operation. + Except for the drawing direction, this function behave exactly like + <function>pdf_arc</function>. In particular, + the angles are still measured counterclockwise from the positive x axis. </para> - <para> - <example> - <title><function>pdf_arcn</function> example</title> - <programlisting role="php"> -<![CDATA[ -<?php - -// prepare document -$pdf = pdf_new(); -pdf_open_file($pdf, ""); -pdf_begin_page($pdf, 595, 842); - -// an outlined arcn -pdf_arcn($pdf, 200, 700, 100, 0, 90); -pdf_stroke($pdf); - -// a filled arcn -pdf_arcn($pdf, 200, 700, 50, 0, 90); -pdf_fill($pdf); - -// an outlined and filled arcn -pdf_setcolor($pdf, "fill", "gray", 0.8); -pdf_arcn($pdf, 400, 700, 50, 0, 90); -pdf_fill_stroke($pdf); - -// finish document -pdf_end_page($pdf); -pdf_close($pdf); - -header("Content-type: application/pdf"); -echo pdf_get_buffer($pdf); - -pdf_delete($pdf); -?> -]]> - </programlisting> - </example> - </para> - <para> - See also: <function>pdf_arc</function>, <function>pdf_circle</function>, - <function>pdf_stroke</function>, <function>pdf_fill</function> and - <function>pdf_fillstroke</function>. - </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-open-image-file.xml?r1=1.6&r2=1.7&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-open-image-file.xml diff -u phpdoc/en/reference/pdf/functions/pdf-open-image-file.xml:1.6 phpdoc/en/reference/pdf/functions/pdf-open-image-file.xml:1.7 --- phpdoc/en/reference/pdf/functions/pdf-open-image-file.xml:1.6 Fri Jul 22 08:09:30 2005 +++ phpdoc/en/reference/pdf/functions/pdf-open-image-file.xml Thu Dec 8 08:45:03 2005 @@ -1,23 +1,23 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-open-image-file"> <refnamediv> <refname>pdf_open_image_file</refname> - <refpurpose>Reads an image from a file</refpurpose> + <refpurpose>Read image from file [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>pdf_open_image_file</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> <methodparam><type>string</type><parameter>imagetype</parameter></methodparam> <methodparam><type>string</type><parameter>filename</parameter></methodparam> <methodparam><type>string</type><parameter>stringparam</parameter></methodparam> <methodparam><type>int</type><parameter>intparam</parameter></methodparam> </methodsynopsis> <para> - Open an image file. Supported types are <literal>jpeg</literal>, + Opens an image file. Supported types are <literal>jpeg</literal>, <literal>tiff</literal>, <literal>gif</literal>, and <literal>png</literal>. <parameter>stringparam</parameter> is either empty, <literal>mask</literal>, <literal>masked</literal>, or @@ -28,6 +28,10 @@ <parameter>intparam</parameter> are optional before PHP 4.3.5 or with PDFlib less than 5. </para> + <para> + This function is deprecated since PDFlib version 5, use + <function>pdf_load_image</function> instead. + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-add-outline.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-add-outline.xml diff -u phpdoc/en/reference/pdf/functions/pdf-add-outline.xml:1.3 phpdoc/en/reference/pdf/functions/pdf-add-outline.xml:1.4 --- phpdoc/en/reference/pdf/functions/pdf-add-outline.xml:1.3 Sat Aug 9 00:31:33 2003 +++ phpdoc/en/reference/pdf/functions/pdf-add-outline.xml Thu Dec 8 08:45:03 2005 @@ -1,16 +1,15 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-add-outline"> <refnamediv> <refname>pdf_add_outline</refname> - <refpurpose>Deprecated: Adds bookmark for current page</refpurpose> + <refpurpose>Add bookmark for current page [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <para> - This function is deprecated, use <function>pdf_add_bookmark</function> - instead. + This function is deprecated, use <function>pdf_create_bookmark</function> instead. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-findfont.xml?r1=1.7&r2=1.8&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-findfont.xml diff -u phpdoc/en/reference/pdf/functions/pdf-findfont.xml:1.7 phpdoc/en/reference/pdf/functions/pdf-findfont.xml:1.8 --- phpdoc/en/reference/pdf/functions/pdf-findfont.xml:1.7 Fri Jul 22 08:09:30 2005 +++ phpdoc/en/reference/pdf/functions/pdf-findfont.xml Thu Dec 8 08:45:03 2005 @@ -1,22 +1,22 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-findfont"> <refnamediv> <refname>pdf_findfont</refname> - <refpurpose>Prepare font for later use with <function>pdf_setfont</function></refpurpose> + <refpurpose>Prepare font for later use [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>pdf_findfont</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> <methodparam><type>string</type><parameter>fontname</parameter></methodparam> <methodparam><type>string</type><parameter>encoding</parameter></methodparam> <methodparam><type>int</type><parameter>embed</parameter></methodparam> </methodsynopsis> <para> - Prepare a font for later use with <function>pdf_setfont</function>. + Search for a font and prepare it for later use with <function>pdf_setfont</function>. The metrics will be loaded, and if <parameter>embed</parameter> is nonzero, the font file will be checked, but not yet used. <parameter>encoding</parameter> is one of <literal>builtin</literal>, @@ -27,25 +27,8 @@ with PDFlib less than 5. </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"> -<![CDATA[ -<?php - -$font = pdf_findfont($pdf, "Times New Roman", "winansi", 1); -if ($font) { - pdf_setfont($pdf, $font, 10); -} - -?> -]]> - </programlisting> - </example> + This function is deprecated since PDFlib version 5, use + <function>pdf_load_font</function> instead. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-skew.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-skew.xml diff -u phpdoc/en/reference/pdf/functions/pdf-skew.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-skew.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-skew.xml:1.4 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-skew.xml Thu Dec 8 08:45:03 2005 @@ -1,21 +1,21 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-skew"> <refnamediv> <refname>pdf_skew</refname> - <refpurpose>Skews the coordinate system</refpurpose> + <refpurpose>Skew the coordinate system</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_skew</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> <methodparam><type>float</type><parameter>alpha</parameter></methodparam> <methodparam><type>float</type><parameter>beta</parameter></methodparam> </methodsynopsis> <para> - Skew the coordinate system in x and y direction by <parameter>alpha</parameter> + Skews the coordinate system in x and y direction by <parameter>alpha</parameter> and <parameter>beta</parameter> degrees. &return.success; </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-set-text-rise.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-set-text-rise.xml diff -u phpdoc/en/reference/pdf/functions/pdf-set-text-rise.xml:1.3 phpdoc/en/reference/pdf/functions/pdf-set-text-rise.xml:1.4 --- phpdoc/en/reference/pdf/functions/pdf-set-text-rise.xml:1.3 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-set-text-rise.xml Thu Dec 8 08:45:03 2005 @@ -1,16 +1,17 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-set-text-rise"> <refnamediv> <refname>pdf_set_text_rise</refname> - <refpurpose>Deprecated: Sets the text rise</refpurpose> + <refpurpose>Set text rise [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <para> - This function is deprecated, use <function>pdf_set_value</function> - instead. + This function is deprecated since PDFlib version 3, use + <function>pdf_set_value</function> with the <parameter>textrise</parameter> + parameter instead. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-end-pattern.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-end-pattern.xml diff -u phpdoc/en/reference/pdf/functions/pdf-end-pattern.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-end-pattern.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-end-pattern.xml:1.4 Sat Aug 9 00:31:33 2003 +++ phpdoc/en/reference/pdf/functions/pdf-end-pattern.xml Thu Dec 8 08:45:03 2005 @@ -1,19 +1,19 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-end-pattern"> <refnamediv> <refname>pdf_end_pattern</refname> <refpurpose>Finish pattern</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_end_pattern</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> </methodsynopsis> <para> - Finish the pattern definition. &return.success; + Finishes the pattern definition. &return.success; </para> <para> See also <function>pdf_begin_pattern</function>. http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-open-memory-image.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-open-memory-image.xml diff -u phpdoc/en/reference/pdf/functions/pdf-open-memory-image.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-open-memory-image.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-open-memory-image.xml:1.4 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-open-memory-image.xml Thu Dec 8 08:45:03 2005 @@ -1,45 +1,20 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.48 --> <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> + <refpurpose>Open image created with PHP's image functions [not supported]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>pdf_open_memory_image</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> <methodparam><type>resource</type><parameter>image</parameter></methodparam> </methodsynopsis> - <para> - The <function>pdf_open_memory_image</function> function takes - an <parameter>image</parameter> created with the PHP's image - functions and makes it available for the pdf resource. - The function returns a pdf image identifier. - <example> - <title>Including a memory image</title> - <programlisting role="php"> -<![CDATA[ -<?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> and - <function>pdf_place_image</function>. - </para> - </refsect1> + <para>This function is not supported by PDFlib GmbH.</para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-stroke.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-stroke.xml diff -u phpdoc/en/reference/pdf/functions/pdf-stroke.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-stroke.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-stroke.xml:1.4 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-stroke.xml Thu Dec 8 08:45:03 2005 @@ -1,19 +1,19 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-stroke"> <refnamediv> <refname>pdf_stroke</refname> - <refpurpose>Draws line along path</refpurpose> + <refpurpose>Stroke path</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_stroke</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> </methodsynopsis> <para> - Stroke the path with the current color and line width, and clear it. + Strokes the path with the current color and line width, and clear it. &return.success; </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-open-image.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-open-image.xml diff -u phpdoc/en/reference/pdf/functions/pdf-open-image.xml:1.5 phpdoc/en/reference/pdf/functions/pdf-open-image.xml:1.6 --- phpdoc/en/reference/pdf/functions/pdf-open-image.xml:1.5 Tue Nov 23 04:38:17 2004 +++ phpdoc/en/reference/pdf/functions/pdf-open-image.xml Thu Dec 8 08:45:03 2005 @@ -1,16 +1,16 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-open-image"> <refnamediv> <refname>pdf_open_image</refname> - <refpurpose>Versatile function for images</refpurpose> + <refpurpose>Use image data [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>pdf_open_image</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> <methodparam><type>string</type><parameter>imagetype</parameter></methodparam> <methodparam><type>string</type><parameter>source</parameter></methodparam> <methodparam><type>string</type><parameter>data</parameter></methodparam> @@ -22,13 +22,17 @@ <methodparam><type>string</type><parameter>params</parameter></methodparam> </methodsynopsis> <para> - Use image data from a variety of data sources. Supported types are + Uses image data from a variety of data sources. Supported types are <literal>jpeg</literal>, <literal>ccitt</literal>, <literal>raw</literal>. Supported sources are <literal>memory</literal>, <literal>fileref</literal>, <literal>url</literal>. <parameter>len</parameter> is only used when type is <literal>raw</literal>, <parameter>params</parameter> is only used when type is <literal>ccitt</literal>. </para> + <para> + This function is deprecated since PDFlib version 5, use virtual files + and <function>pdf_load_image</function> instead. + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-rect.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-rect.xml diff -u phpdoc/en/reference/pdf/functions/pdf-rect.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-rect.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-rect.xml:1.4 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-rect.xml Thu Dec 8 08:45:03 2005 @@ -1,23 +1,23 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-rect"> <refnamediv> <refname>pdf_rect</refname> - <refpurpose>Draws a rectangle</refpurpose> + <refpurpose>Draw rectangle</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_rect</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> <methodparam><type>float</type><parameter>x</parameter></methodparam> <methodparam><type>float</type><parameter>y</parameter></methodparam> <methodparam><type>float</type><parameter>width</parameter></methodparam> <methodparam><type>float</type><parameter>height</parameter></methodparam> </methodsynopsis> <para> - Draw a (<parameter>width</parameter> * <parameter>height</parameter>) + Draws a (<parameter>width</parameter> * <parameter>height</parameter>) rectangle at lower left (<parameter>x</parameter>, <parameter>y</parameter>). &return.success; </para> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-setrgbcolor.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-setrgbcolor.xml diff -u phpdoc/en/reference/pdf/functions/pdf-setrgbcolor.xml:1.5 phpdoc/en/reference/pdf/functions/pdf-setrgbcolor.xml:1.6 --- phpdoc/en/reference/pdf/functions/pdf-setrgbcolor.xml:1.5 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-setrgbcolor.xml Thu Dec 8 08:45:03 2005 @@ -1,29 +1,28 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-setrgbcolor"> <refnamediv> <refname>pdf_setrgbcolor</refname> - <refpurpose>Sets drawing and filling color to rgb color value</refpurpose> + <refpurpose>Set fill and stroke rgb color values [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_setrgbcolor</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> - <methodparam><type>float</type><parameter>red_value</parameter></methodparam> - <methodparam><type>float</type><parameter>green_value</parameter></methodparam> - <methodparam><type>float</type><parameter>blue_value</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> + <methodparam><type>float</type><parameter>red</parameter></methodparam> + <methodparam><type>float</type><parameter>green</parameter></methodparam> + <methodparam><type>float</type><parameter>blue</parameter></methodparam> </methodsynopsis> <para> - Set the current fill and stroke color to the supplied RGB values. + Sets the current fill and stroke color to the supplied RGB values. &return.success; </para> - <note> - <para> - PDFlib V4.0: Deprecated, use <function>pdf_setcolor</function> instead. - </para> - </note> + <para> + This function is deprecated since PDFlib version 4, use + <function>pdf_setcolor</function> instead. + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-set-info-keywords.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-set-info-keywords.xml diff -u phpdoc/en/reference/pdf/functions/pdf-set-info-keywords.xml:1.3 phpdoc/en/reference/pdf/functions/pdf-set-info-keywords.xml:1.4 --- phpdoc/en/reference/pdf/functions/pdf-set-info-keywords.xml:1.3 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-set-info-keywords.xml Thu Dec 8 08:45:03 2005 @@ -1,17 +1,18 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.72 --> <refentry id='function.pdf-set-info-keywords'> <refnamediv> <refname>pdf_set_info_keywords</refname> <refpurpose> - Deprecated: Fills the keywords field of the document + Fill the keywords document info field [deprecated] </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <para> - This function is deprecated, use <function>pdf_set_info</function> instead. + This function is deprecated since PDFlib version 3, use + <function>pdf_set_info</function> instead. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-set-info-creator.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-set-info-creator.xml diff -u phpdoc/en/reference/pdf/functions/pdf-set-info-creator.xml:1.3 phpdoc/en/reference/pdf/functions/pdf-set-info-creator.xml:1.4 --- phpdoc/en/reference/pdf/functions/pdf-set-info-creator.xml:1.3 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-set-info-creator.xml Thu Dec 8 08:45:03 2005 @@ -1,17 +1,18 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.72 --> <refentry id='function.pdf-set-info-creator'> <refnamediv> <refname>pdf_set_info_creator</refname> <refpurpose> - Deprecated: Fills the creator field of the document + Fill the creator document info field [deprecated] </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <para> - This function is deprecated, use <function>pdf_set_info</function> instead. + This function is deprecated since PDFlib version 3, use + <function>pdf_set_info</function> instead. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-set-font.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-set-font.xml diff -u phpdoc/en/reference/pdf/functions/pdf-set-font.xml:1.3 phpdoc/en/reference/pdf/functions/pdf-set-font.xml:1.4 --- phpdoc/en/reference/pdf/functions/pdf-set-font.xml:1.3 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-set-font.xml Thu Dec 8 08:45:03 2005 @@ -1,15 +1,15 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-set-font"> <refnamediv> <refname>pdf_set_font</refname> - <refpurpose>Deprecated: Selects a font face and size</refpurpose> + <refpurpose>Select font and size [not supported]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <para> - This function is deprecated, use <function>pdf_findfont</function> + This function is not supported, use <function>pdf_load_font</function> plus <function>pdf_setfont</function> instead. </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-new.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-new.xml diff -u phpdoc/en/reference/pdf/functions/pdf-new.xml:1.3 phpdoc/en/reference/pdf/functions/pdf-new.xml:1.4 --- phpdoc/en/reference/pdf/functions/pdf-new.xml:1.3 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-new.xml Thu Dec 8 08:45:03 2005 @@ -1,23 +1,20 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-new"> <refnamediv> <refname>pdf_new</refname> - <refpurpose>Creates a new pdf resource</refpurpose> + <refpurpose>Create PDFlib object</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>pdf_new</methodname> <methodparam><parameter/></methodparam> </methodsynopsis> <para> - Create a new PDF resource, using default error handling - and memory management. - </para> - <para> - See also <function>pdf_close</function>. + Creates a new PDFlib object with default settings, using PDFlib's + internal default error handling and memory allocation routines. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-close-pdi-page.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-close-pdi-page.xml diff -u phpdoc/en/reference/pdf/functions/pdf-close-pdi-page.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-close-pdi-page.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-close-pdi-page.xml:1.4 Sat Aug 9 00:31:33 2003 +++ phpdoc/en/reference/pdf/functions/pdf-close-pdi-page.xml Thu Dec 8 08:45:03 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-close-pdi-page"> <refnamediv> @@ -8,15 +8,15 @@ Close the page handle </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_close_pdi_page</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> - <methodparam><type>int</type><parameter>pagehandle</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> + <methodparam><type>int</type><parameter>page</parameter></methodparam> </methodsynopsis> <para> - Close the page handle, and free all page-related resources. &return.success; + Closes the page handle, and frees all page-related resources. &return.success; </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-add-launchlink.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-add-launchlink.xml diff -u phpdoc/en/reference/pdf/functions/pdf-add-launchlink.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-add-launchlink.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-add-launchlink.xml:1.4 Sat Aug 9 00:31:33 2003 +++ phpdoc/en/reference/pdf/functions/pdf-add-launchlink.xml Thu Dec 8 08:45:03 2005 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-add-launchlink"> <refnamediv> <refname>pdf_add_launchlink</refname> - <refpurpose>Add a launch annotation for current page</refpurpose> + <refpurpose>Add launch annotation for current page [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_add_launchlink</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> @@ -19,10 +19,10 @@ </methodsynopsis> <para> Adds a link to a web resource specified by <parameter>filename</parameter>. - &return.success; </para> <para> - See also <function>pdf_add_locallink</function>. + This function is deprecated since PDFlib version 6, use <function>pdf_create_action</function> with type=Launch and <function>create_annotation</function> with +<parameter>type=Link</parameter> instead. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-close-image.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-close-image.xml diff -u phpdoc/en/reference/pdf/functions/pdf-close-image.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-close-image.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-close-image.xml:1.4 Sat Aug 9 00:31:33 2003 +++ phpdoc/en/reference/pdf/functions/pdf-close-image.xml Thu Dec 8 08:45:03 2005 @@ -1,20 +1,20 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-close-image"> <refnamediv> <refname>pdf_close_image</refname> - <refpurpose>Closes an image</refpurpose> + <refpurpose>Close image</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>pdf_close_image</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> <methodparam><type>int</type><parameter>image</parameter></methodparam> </methodsynopsis> <para> - Close an <parameter>image</parameter> retrieved with the + Closes an <parameter>image</parameter> retrieved with the <function>pdf_open_image</function> function. </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-setlinejoin.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-setlinejoin.xml diff -u phpdoc/en/reference/pdf/functions/pdf-setlinejoin.xml:1.5 phpdoc/en/reference/pdf/functions/pdf-setlinejoin.xml:1.6 --- phpdoc/en/reference/pdf/functions/pdf-setlinejoin.xml:1.5 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-setlinejoin.xml Thu Dec 8 08:45:03 2005 @@ -1,21 +1,21 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-setlinejoin"> <refnamediv> <refname>pdf_setlinejoin</refname> - <refpurpose>Sets linejoin parameter</refpurpose> + <refpurpose>Set linejoin parameter</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_setlinejoin</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> <methodparam><type>int</type><parameter>value</parameter></methodparam> </methodsynopsis> <para> - Sets the line join parameter to a <parameter>value</parameter> between - 0 and 2 inclusive. &return.success; + Sets the <parameter>linejoin</parameter> parameter to specify the shape + at the corners of paths that are stroked. &return.success; </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-makespotcolor.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-makespotcolor.xml diff -u phpdoc/en/reference/pdf/functions/pdf-makespotcolor.xml:1.5 phpdoc/en/reference/pdf/functions/pdf-makespotcolor.xml:1.6 --- phpdoc/en/reference/pdf/functions/pdf-makespotcolor.xml:1.5 Fri Jun 24 05:11:42 2005 +++ phpdoc/en/reference/pdf/functions/pdf-makespotcolor.xml Thu Dec 8 08:45:03 2005 @@ -1,20 +1,21 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-makespotcolor"> <refnamediv> <refname>pdf_makespotcolor</refname> - <refpurpose>Makes a spotcolor</refpurpose> + <refpurpose>Make spot color</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>pdf_makespotcolor</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> <methodparam><type>string</type><parameter>spotname</parameter></methodparam> </methodsynopsis> <para> - Make a named spot color from the current color. &return.success; + Finds a built-in spot color name, or makes a named spot color from the + current fill color. &return.success; </para> <para> See also <function>pdf_setcolor</function>. http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-get-pdi-parameter.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-get-pdi-parameter.xml diff -u phpdoc/en/reference/pdf/functions/pdf-get-pdi-parameter.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-get-pdi-parameter.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-get-pdi-parameter.xml:1.4 Sat Aug 9 00:31:33 2003 +++ phpdoc/en/reference/pdf/functions/pdf-get-pdi-parameter.xml Thu Dec 8 08:45:03 2005 @@ -1,24 +1,23 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-get-pdi-parameter"> <refnamediv> <refname>pdf_get_pdi_parameter</refname> - <refpurpose>Get some PDI string parameters</refpurpose> + <refpurpose>Get PDI string parameter</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>pdf_get_pdi_parameter</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> <methodparam><type>string</type><parameter>key</parameter></methodparam> - <methodparam><type>int</type><parameter>document</parameter></methodparam> + <methodparam><type>int</type><parameter>doc</parameter></methodparam> <methodparam><type>int</type><parameter>page</parameter></methodparam> - <methodparam><type>int</type><parameter>index</parameter></methodparam> + <methodparam><type>int</type><parameter>reserved</parameter></methodparam> </methodsynopsis> <para> - Get the contents of some PDI <parameter>document</parameter> parameter - with string type. + Gets the contents of a PDI document parameter with string type. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-set-text-pos.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-set-text-pos.xml diff -u phpdoc/en/reference/pdf/functions/pdf-set-text-pos.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-set-text-pos.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-set-text-pos.xml:1.4 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-set-text-pos.xml Thu Dec 8 08:45:03 2005 @@ -1,22 +1,22 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-set-text-pos"> <refnamediv> <refname>pdf_set_text_pos</refname> - <refpurpose>Sets text position</refpurpose> + <refpurpose>Set text position</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_set_text_pos</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> <methodparam><type>float</type><parameter>x</parameter></methodparam> <methodparam><type>float</type><parameter>y</parameter></methodparam> </methodsynopsis> <para> - Set the text output position specified by <parameter>x</parameter> and - <parameter>y</parameter>. &return.success; + Sets the position for text output on the page, specified by + <parameter>x</parameter> and <parameter>y</parameter>. &return.success; </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-add-bookmark.xml?r1=1.7&r2=1.8&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-add-bookmark.xml diff -u phpdoc/en/reference/pdf/functions/pdf-add-bookmark.xml:1.7 phpdoc/en/reference/pdf/functions/pdf-add-bookmark.xml:1.8 --- phpdoc/en/reference/pdf/functions/pdf-add-bookmark.xml:1.7 Fri Jul 22 08:09:30 2005 +++ phpdoc/en/reference/pdf/functions/pdf-add-bookmark.xml Thu Dec 8 08:45:03 2005 @@ -1,65 +1,15 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-add-bookmark"> <refnamediv> <refname>pdf_add_bookmark</refname> - <refpurpose>Adds bookmark for current page</refpurpose> + <refpurpose>Add bookmark for current page [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>pdf_add_bookmark</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> - <methodparam><type>string</type><parameter>text</parameter></methodparam> - <methodparam><type>int</type><parameter>parent</parameter></methodparam> - <methodparam><type>int</type><parameter>open</parameter></methodparam> - </methodsynopsis> + <refsect1 role="description"> + &reftitle.description; <para> - Add a nested bookmark under <parameter>parent</parameter>, or a new top-level - bookmark if <parameter>parent</parameter> = 0. Returns a bookmark descriptor - which may be used as parent for subsequent nested bookmarks. - If <parameter>open</parameter> = 1, child bookmarks will be folded out, and - invisible if <parameter>open</parameter> = 0. - Parameters <parameter>parent</parameter> and <parameter>open</parameter> - are optional before PHP 4.3.5 or with PDFlib less than 5. - </para> - <para> - <example> - <title><function>pdf_add_bookmark</function> example</title> - <programlisting role="php"> -<![CDATA[ -<?php -// create a new PDF - -$pdf = pdf_new(); -pdf_open_file($pdf); -pdf_set_info($pdf, "Author", "Bob Nijman"); - -// begin a new page -pdf_begin_page($pdf, 300, 300); - -// add a top-level bookmark -$bookmark = pdf_add_bookmark($pdf, "People"); - -// add a nested bookmark -pdf_add_bookmark($pdf, "Rasmus", $bookmark); - -// and some text -pdf_set_font($pdf, "Helvetica", 20, "host"); -$text = "This is R's page"; -$width = pdf_stringwidth($pdf, $text); -pdf_set_text_pos($pdf, (300-$width)/2, 100); -pdf_show($pdf, $text); - -// close the page and the PDF -pdf_end_page($pdf); -pdf_close($pdf); - -?> -]]> - </programlisting> - </example> + This function is deprecated since PDFlib version 6, use <function>pdf_create_bookmark</function> instead. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-place-image.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-place-image.xml diff -u phpdoc/en/reference/pdf/functions/pdf-place-image.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-place-image.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-place-image.xml:1.4 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-place-image.xml Thu Dec 8 08:45:03 2005 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-place-image"> <refnamediv> <refname>pdf_place_image</refname> - <refpurpose>Places an image on the page</refpurpose> + <refpurpose>Place image on the page [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_place_image</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> @@ -17,9 +17,13 @@ <methodparam><type>float</type><parameter>scale</parameter></methodparam> </methodsynopsis> <para> - Place an image with the lower left corner at (<parameter>x</parameter>, - <parameter>y</parameter>), and scale it. &return.success; + Places an image with the lower left corner at (<parameter>x</parameter>, + <parameter>y</parameter>), and scales it. &return.success; </para> + <para> + This function is deprecated since PDFlib version 5, use + <function>pdf_fit_image</function> instead. + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-closepath-fill-stroke.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-closepath-fill-stroke.xml diff -u phpdoc/en/reference/pdf/functions/pdf-closepath-fill-stroke.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-closepath-fill-stroke.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-closepath-fill-stroke.xml:1.4 Sat Aug 9 00:31:33 2003 +++ phpdoc/en/reference/pdf/functions/pdf-closepath-fill-stroke.xml Thu Dec 8 08:45:03 2005 @@ -1,19 +1,19 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-closepath-fill-stroke"> <refnamediv> <refname>pdf_closepath_fill_stroke</refname> - <refpurpose>Closes, fills and strokes current path</refpurpose> + <refpurpose>Close, fill and stroke current path</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_closepath_fill_stroke</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> </methodsynopsis> <para> - Close the path, fill, and stroke it. &return.success; + Closes the path, fills, and strokes it. &return.success; </para> <para> See also <function>pdf_closepath</function> and http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-open-file.xml?r1=1.6&r2=1.7&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-open-file.xml diff -u phpdoc/en/reference/pdf/functions/pdf-open-file.xml:1.6 phpdoc/en/reference/pdf/functions/pdf-open-file.xml:1.7 --- phpdoc/en/reference/pdf/functions/pdf-open-file.xml:1.6 Fri Jul 22 08:09:30 2005 +++ phpdoc/en/reference/pdf/functions/pdf-open-file.xml Thu Dec 8 08:45:03 2005 @@ -1,59 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-open-file"> <refnamediv> <refname>pdf_open_file</refname> - <refpurpose>Opens a new pdf object</refpurpose> + <refpurpose>Create PDF file [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_open_file</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> <methodparam><type>string</type><parameter>filename</parameter></methodparam> </methodsynopsis> <para> - Create a new PDF file using the supplied file name. + Creates a new PDF file using the supplied file name. If <parameter>filename</parameter> is empty the PDF document will be generated in memory instead of on file. The result must be fetched by the client with the <function>pdf_get_buffer</function> function. - Parameter <parameter>filename</parameter> is optional before PHP 4.3.5 or - with PDFlib less than 5. + Parameter <parameter>filename</parameter> is optional before + PHP 4.3.5 or with PDFlib less than 5. &return.success; </para> - <para> - The following example shows how to create a pdf document in memory - and how to output it correctly. - <example> - <title>Creating a PDF document in memory</title> - <programlisting role="php"> -<![CDATA[ -<?php - -$pdf = pdf_new(); - -pdf_open_file($pdf); -pdf_begin_page($pdf, 595, 842); -pdf_set_font($pdf, "Times-Roman", 30, "host"); -pdf_set_value($pdf, "textrendering", 1); -pdf_show_xy($pdf, "A PDF document created in memory!", 50, 750); -pdf_end_page($pdf); -pdf_close($pdf); - -$data = pdf_get_buffer($pdf); - -header("Content-type: application/pdf"); -header("Content-disposition: inline; filename=test.pdf"); -header("Content-length: " . strlen($data)); - -echo $data; - -?> -]]> - </programlisting> - </example> + <para> + This function is deprecated since PDFlib version 6, use + <function>pdf_begin_document</function> instead. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-open-pdi-page.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-open-pdi-page.xml diff -u phpdoc/en/reference/pdf/functions/pdf-open-pdi-page.xml:1.4 phpdoc/en/reference/pdf/functions/pdf-open-pdi-page.xml:1.5 --- phpdoc/en/reference/pdf/functions/pdf-open-pdi-page.xml:1.4 Sat Aug 9 00:31:34 2003 +++ phpdoc/en/reference/pdf/functions/pdf-open-pdi-page.xml Thu Dec 8 08:45:03 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-open-pdi-page"> <refnamediv> @@ -8,17 +8,17 @@ Prepare a page </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>pdf_open_pdi_page</methodname> - <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> - <methodparam><type>int</type><parameter>dochandle</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> + <methodparam><type>int</type><parameter>doc</parameter></methodparam> <methodparam><type>int</type><parameter>pagenumber</parameter></methodparam> - <methodparam><type>string</type><parameter>pagelabel</parameter></methodparam> + <methodparam><type>string</type><parameter>optlist</parameter></methodparam> </methodsynopsis> <para> - Prepare a page for later use with <function>pdf_place_image</function> + Prepares a page for later use with <function>pdf_fit_pdi_page</function>. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/functions/pdf-get-majorversion.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/pdf/functions/pdf-get-majorversion.xml diff -u phpdoc/en/reference/pdf/functions/pdf-get-majorversion.xml:1.3 phpdoc/en/reference/pdf/functions/pdf-get-majorversion.xml:1.4 --- phpdoc/en/reference/pdf/functions/pdf-get-majorversion.xml:1.3 Sat Aug 9 00:31:33 2003 +++ phpdoc/en/reference/pdf/functions/pdf-get-majorversion.xml Thu Dec 8 08:45:03 2005 @@ -1,24 +1,24 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.72 --> <refentry id='function.pdf-get-majorversion'> <refnamediv> <refname>pdf_get_majorversion</refname> - <refpurpose> - Returns the major version number of the PDFlib - </refpurpose> + <refpurpose>Get major version number [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>pdf_get_majorversion</methodname> <void/> </methodsynopsis> <para> - Returns the major version number of the PDFlib. + Returns the major version number of the PDFlib version. </para> <para> - See also <function>pdf_get_minorversion</function>. + This function is deprecated since PDFlib version 5, use + <function>pdf_get_value</function> with the parameter + <parameter>major</parameter> instead. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/configure.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/pdf/configure.xml diff -u phpdoc/en/reference/pdf/configure.xml:1.2 phpdoc/en/reference/pdf/configure.xml:1.3 --- phpdoc/en/reference/pdf/configure.xml:1.2 Fri Jan 28 13:56:25 2005 +++ phpdoc/en/reference/pdf/configure.xml Thu Dec 8 08:45:05 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <section id="pdf.installation"> &reftitle.install; <para> @@ -11,16 +11,6 @@ To get these functions to work in PHP &lt; 4.3.9, you have to compile PHP with <option role="configure">--with-pdflib[=DIR]</option>. DIR is the PDFlib base install directory, defaults to <filename>/usr/local</filename>. - In addition you can specify the jpeg, tiff, and pnglibrary for PDFlib to - use, which is optional for PDFlib 4.x. - To do so add to your configure line the options - <option role="configure">--with-jpeg-dir[=DIR]</option> - <option role="configure">--with-png-dir[=DIR]</option> - <option role="configure">--with-tiff-dir[=DIR]</option>. - </para> - <para> - When using version 3.x of PDFlib, you should configure PDFlib - with the option <literal>--enable-shared-pdflib</literal>. </para> <para> As of PHP 4.3.9, you must install this extension through <ulink http://cvs.php.net/diff.php/phpdoc/en/reference/pdf/reference.xml?r1=1.18&r2=1.19&ty=u Index: phpdoc/en/reference/pdf/reference.xml diff -u phpdoc/en/reference/pdf/reference.xml:1.18 phpdoc/en/reference/pdf/reference.xml:1.19 --- phpdoc/en/reference/pdf/reference.xml:1.18 Sun Sep 4 15:39:23 2005 +++ phpdoc/en/reference/pdf/reference.xml Thu Dec 8 08:45:05 2005 @@ -1,58 +1,68 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.18 $ --> +<!-- $Revision: 1.19 $ --> <!-- Purpose: utilspec.nontext --> <!-- Membership: pecl, external --> <reference id="ref.pdf"> - <title>PDF functions </title> + <title>PDF &Functions;</title> <titleabbrev>PDF</titleabbrev> <partintro> <section id="pdf.intro"> &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>. - </simpara> - <simpara> - The documentation in this section is only meant to be an overview - of the available functions in the PDFlib library and should not be - considered an exhaustive reference. Please consult the - documentation included in the source distribution of PDFlib for - the full and detailed explanation of each function here. It - provides a very good overview of what PDFlib is capable of doing - and contains the most up-to-date documentation of all functions. - </simpara> - <simpara> + <para> + The PDF functions in PHP can create PDF files using the PDFlib + library created by <ulink url="&url.pdflib.merz;">Thomas Merz</ulink>. + </para> + <para> + The documentation in this section is only meant to be an overview + of the available functions in the PDFlib library and should not be + considered an exhaustive reference. For the full and detailed + explanation of each function, consult the PDFlib Reference Manual + which is included in all PDFlib packages distributed by PDFlib GmbH. + It provides a very good overview of what PDFlib is capable of doing + and contains the most up-to-date documentation of all functions. + </para> + <para> 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 + 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. - </simpara> - <simpara> - Please note that most of the PDF functions require a - <parameter>pdfdoc</parameter> as its first parameter. Please - see the <link linkend="pdf.examples">examples</link> below for more - information. - </simpara> + inch, but this depends on the output resolution. Please see the + PDFlib Reference Manual included in the PDFlib distribution for a more + thorough explanation of the coordinate system used. + </para> + <para> + With version 6, PDFlib offers an object oriented API for PHP 5 in + addition to the function oriented API for PHP 4. The main difference is + the following: In PHP 4, first a PDF resource has to be retrieved + with a function call like <function>$p = PDF_new();</function> + which is used as the first parameter in all further function calls, e.g. + as in <function>PDF_begin_document($p, "", "")</function>. + In PHP 5, a PDFlib object is created with + <function>$p = new PDFlib()</function> instead. This object offers + all PDFlib API functions as methods, e.g. as with + <function>$p->begin_document("", "")</function>. + In addition, exceptions have been introduced in PHP 5 which are + supported by PDFlib 6 and later as well. + </para> + <para> + Please see the <link linkend="pdf.examples">examples</link> below for + more information. + </para> <note> - <simpara> + <para> If you're interested in alternative free PDF generators that do not utilize external PDF libraries, see <link linkend="faq.using.freepdf"> this related FAQ</link>. - </simpara> + </para> </note> <note> - <simpara> + <para> This extension has been moved to <ulink url="&url.pecl;">PECL</ulink> as of PHP 4.3.9. - </simpara> + </para> </note> </section> @@ -61,401 +71,164 @@ <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. + a license for commercial use. </para> + </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> + <para> + Any version of PHP 4 after March 9, 2000 does not support versions + of PDFlib older than 3.0. + </para> + <para> + PDFlib 4.0 or greater is supported by PHP 4.3 and later. + </para> </section> &reference.pdf.configure; + &reference.pdf.ini; - <section id="pdf.configuration"> - &reftitle.runtime; - &no.config; + <section id="pdf.resources"> + &reftitle.resources; + &no.resource; </section> - - <section id="pdf.oldlibs.confusion"> - <title>Confusion with old PDFlib versions</title> - <simpara> + <section id="pdf.oldlibs"> + <title>Remarks about Deprecated PDFlib Functions</title> + <para> 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 + functions described in the PDFlib Reference Manual (PDFlib V3.0 or higher) 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 + parameters. However, with PDFlib V5.0.4 or higher all parameters + have to be specified. For compatibility reasons, + this binding for PDFlib still supports most of the deprecated 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. - </simpara> - <para> - <table> - <title>Deprecated functions and their replacements</title> - <tgroup cols="2"> - <thead> - <row> - <entry>Old function</entry> - <entry>Replacement</entry> - </row> - </thead> - <tbody> - <row> - <entry><function>pdf_put_image</function></entry> - <entry>Not needed anymore.</entry> - </row> - <row> - <entry><function>pdf_execute_image</function></entry> - <entry>Not needed anymore.</entry> - </row> - <row> - <entry><function>pdf_get_annotation</function></entry> - <entry><function>pdf_get_bookmark</function> using the same - parameters.</entry> - </row> - <row> - <entry><function>pdf_get_font</function></entry> - <entry><function>pdf_get_value</function> passing - <literal>"font"</literal> as the second parameter.</entry> - </row> - <row> - <entry><function>pdf_get_fontsize</function></entry> - <entry><function>pdf_get_value</function> passing - <literal>"fontsize"</literal> as the second parameter.</entry> - </row> - <row> - <entry><function>pdf_get_fontname</function></entry> - <entry><function>pdf_get_parameter</function> passing - <literal>"fontname"</literal> as the second parameter.</entry> - </row> - <row> - <entry><function>pdf_set_info_creator</function></entry> - <entry><function>pdf_set_info</function> passing - <literal>"Creator"</literal> as the second parameter.</entry> - </row> - <row> - <entry><function>pdf_set_info_title</function></entry> - <entry><function>pdf_set_info</function> passing - <literal>"Title"</literal> as the second parameter.</entry> - </row> - <row> - <entry><function>pdf_set_info_subject</function></entry> - <entry><function>pdf_set_info</function> passing - <literal>"Subject"</literal> as the second parameter.</entry> - </row> - <row> - <entry><function>pdf_set_info_author</function></entry> - <entry><function>pdf_set_info</function> passing - <literal>"Author"</literal> as the second parameter.</entry> - </row> - <row> - <entry><function>pdf_set_info_keywords</function></entry> - <entry><function>pdf_set_info</function> passing - <literal>"Keywords"</literal> as the second parameter.</entry> - </row> - <row> - <entry><function>pdf_set_leading</function></entry> - <entry><function>pdf_set_value</function> passing - <literal>"leading"</literal> as the second parameter.</entry> - </row> - <row> - <entry><function>pdf_set_text_rendering</function></entry> - <entry><function>pdf_set_value</function> passing - <literal>"textrendering"</literal> as the second parameter.</entry> - </row> - <row> - <entry><function>pdf_set_text_rise</function></entry> - <entry><function>pdf_set_value</function> passing - <literal>"textrise"</literal> as the second parameter.</entry> - </row> - <row> - <entry><function>pdf_set_horiz_scaling</function></entry> - <entry><function>pdf_set_value</function> passing - <literal>"horizscaling"</literal> as the second parameter.</entry> - </row> - <row> - <entry><function>pdf_set_text_matrix</function></entry> - <entry>Not available anymore</entry> - </row> - <row> - <entry><function>pdf_set_char_spacing</function></entry> - <entry><function>pdf_set_value</function> passing - <literal>"charspacing"</literal> as the second parameter.</entry> - </row> - <row> - <entry><function>pdf_set_word_spacing</function></entry> - <entry><function>pdf_set_value</function> passing - <literal>"wordspacing"</literal> as the second parameter.</entry> - </row> - <row> - <entry><function>pdf_set_transition</function></entry> - <entry><function>pdf_set_parameter</function> passing - <literal>"transition"</literal> as the second parameter.</entry> - </row> - <row> - <entry><function>pdf_open</function></entry> - <entry><function>pdf_new</function> plus an subsequent call - 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> - </row> - <row> - <entry><function>pdf_set_duration</function></entry> - <entry><function>pdf_set_value</function> passing - <literal>"duration"</literal> as the second parameter.</entry> - </row> - <row> - <entry><function>pdf_open_gif</function></entry> - <entry><function>pdf_open_image_file</function> passing - <literal>"gif"</literal> as the second parameter.</entry> - </row> - <row> - <entry><function>pdf_open_jpeg</function></entry> - <entry><function>pdf_open_image_file</function> passing - <literal>"jpeg"</literal> as the second parameter.</entry> - </row> - <row> - <entry><function>pdf_open_tiff</function></entry> - <entry><function>pdf_open_image_file</function> passing - <literal>"tiff"</literal> as the second parameter.</entry> - </row> - <row> - <entry><function>pdf_open_png</function></entry> - <entry><function>pdf_open_image_file</function> passing - <literal>"png"</literal> as the second parameter.</entry> - </row> - <row> - <entry><function>pdf_get_image_width</function></entry> - <entry><function>pdf_get_value</function> passing - <literal>"imagewidth"</literal> as the second parameter and the image - as the third parameter.</entry> - </row> - <row> - <entry><function>pdf_get_image_height</function></entry> - <entry><function>pdf_get_value</function> passing - <literal>"imageheight"</literal> as the second parameter and the - image as the third parameter.</entry> - </row> - </tbody> - </tgroup> - </table> - </para> + functions. The documentation in this section indicates old functions as + "Deprecated" and gives the replacement function to be used instead. + </para> </section> <section id="pdf.examples"> &reftitle.examples; - <simpara> + <para> Most of the functions are fairly easy to use. The most difficult part is probably creating your first PDF document. The following - example should help to get you started. - It creates <filename>test.pdf</filename> - with one page. The page contains the text "Times Roman outlined" in an - outlined, 30pt font. The text is also underlined. - </simpara> + example should help to get you started. It is developed for PHP 4 and + creates the file <filename>hello.pdf</filename> with one page. + It defines some document info field contents, loads the Helvetica-Bold + font and outputs the text "Hello world! (says PHP)". + </para> <para> <example> - <title>Creating a PDF document with PDFlib</title> + <title>Hello World example from PDFlib distribution for PHP 4</title> <programlisting role="php"> <![CDATA[ <?php -$pdf = pdf_new(); -pdf_open_file($pdf, "test.pdf"); -pdf_set_info($pdf, "Author", "Uwe Steinmann"); -pdf_set_info($pdf, "Title", "Test for PHP wrapper of PDFlib 2.0"); -pdf_set_info($pdf, "Creator", "See Author"); -pdf_set_info($pdf, "Subject", "Testing"); -pdf_begin_page($pdf, 595, 842); -pdf_add_outline($pdf, "Page 1"); -$font = pdf_findfont($pdf, "Times New Roman", "winansi", 1); -pdf_setfont($pdf, $font, 10); -pdf_set_value($pdf, "textrendering", 1); -pdf_show_xy($pdf, "Times Roman outlined", 50, 750); -pdf_moveto($pdf, 50, 740); -pdf_lineto($pdf, 330, 740); -pdf_stroke($pdf); -pdf_end_page($pdf); -pdf_close($pdf); -pdf_delete($pdf); -echo "<A HREF=getpdf.php>finished</A>"; -?> -]]> - </programlisting> - </example> +$p = PDF_new(); - The script <filename>getpdf.php</filename> just returns the pdf document. +/* open new PDF file; insert a file name to create the PDF on disk */ +if (PDF_begin_document($p, "", "") == 0) { + die("Error: " . PDF_get_errmsg($p)); +} + +PDF_set_info($p, "Creator", "hello.php"); +PDF_set_info($p, "Author", "Rainer Schaaf"); +PDF_set_info($p, "Title", "Hello world (PHP)!"); + +PDF_begin_page_ext($p, 595, 842, ""); + +$font = PDF_load_font($p, "Helvetica-Bold", "winansi", ""); + +PDF_setfont($p, $font, 24.0); +PDF_set_text_pos($p, 50, 700); +PDF_show($p, "Hello world!"); +PDF_continue_text($p, "(says PHP)"); +PDF_end_page_ext($p, ""); + +PDF_end_document($p, ""); + +$buf = PDF_get_buffer($p); +$len = strlen($buf); - <example> - <title>Outputting a precalculated PDF</title> - <programlisting role="php"> -<![CDATA[ -<?php -$len = filesize($filename); header("Content-type: application/pdf"); header("Content-Length: $len"); -header("Content-Disposition: inline; filename=foo.pdf"); -readfile($filename); +header("Content-Disposition: inline; filename=hello.pdf"); +print $buf; + +PDF_delete($p); ?> ]]> </programlisting> </example> </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 to alleviate the need to use temporary - files. The example was converted to PHP from the PDFlib example. - (The same example is available in the <link - linkend="ref.cpdf">CLibPDF</link> documentation.) + The following example comes with the PDFlib distribution for PHP 5. + It uses the new exception handling and object encapsulation features + available in PHP 5. It creates the file <filename>hello.pdf</filename> with one page. + It defines some document info field contents, loads the Helvetica-Bold + font and outputs the text "Hello world! (says PHP)". </para> <para> <example> - <title>pdfclock example from PDFlib distribution</title> + <title>Hello World example from PDFlib distribution for PHP 5</title> <programlisting role="php"> <![CDATA[ <?php -$radius = 200; -$margin = 20; -$pagecount = 10; - -$pdf = pdf_new(); - -if (!pdf_open_file($pdf, "")) { - echo error; - exit; -}; - -pdf_set_parameter($pdf, "warning", "true"); - -pdf_set_info($pdf, "Creator", "pdf_clock.php"); -pdf_set_info($pdf, "Author", "Uwe Steinmann"); -pdf_set_info($pdf, "Title", "Analog Clock"); - -while ($pagecount-- > 0) { - pdf_begin_page($pdf, 2 * ($radius + $margin), 2 * ($radius + $margin)); - - pdf_set_parameter($pdf, "transition", "wipe"); - pdf_set_value($pdf, "duration", 0.5); - - pdf_translate($pdf, $radius + $margin, $radius + $margin); - pdf_save($pdf); - pdf_setrgbcolor($pdf, 0.0, 0.0, 1.0); - - /* minute strokes */ - pdf_setlinewidth($pdf, 2.0); - for ($alpha = 0; $alpha < 360; $alpha += 6) { - pdf_rotate($pdf, 6.0); - pdf_moveto($pdf, $radius, 0.0); - pdf_lineto($pdf, $radius-$margin/3, 0.0); - pdf_stroke($pdf); - } - pdf_restore($pdf); - pdf_save($pdf); +try { + $p = new PDFlib(); - /* 5 minute strokes */ - pdf_setlinewidth($pdf, 3.0); - for ($alpha = 0; $alpha < 360; $alpha += 30) { - pdf_rotate($pdf, 30.0); - pdf_moveto($pdf, $radius, 0.0); - pdf_lineto($pdf, $radius-$margin, 0.0); - pdf_stroke($pdf); + /* open new PDF file; insert a file name to create the PDF on disk */ + if ($p->begin_document("", "") == 0) { + die("Error: " . $p->get_errmsg()); } - $ltime = getdate(); - - /* draw hour hand */ - pdf_save($pdf); - pdf_rotate($pdf,-(($ltime['minutes']/60.0)+$ltime['hours']-3.0)*30.0); - pdf_moveto($pdf, -$radius/10, -$radius/20); - pdf_lineto($pdf, $radius/2, 0.0); - pdf_lineto($pdf, -$radius/10, $radius/20); - pdf_closepath($pdf); - pdf_fill($pdf); - pdf_restore($pdf); - - /* draw minute hand */ - pdf_save($pdf); - pdf_rotate($pdf,-(($ltime['seconds']/60.0)+$ltime['minutes']-15.0)*6.0); - pdf_moveto($pdf, -$radius/10, -$radius/20); - pdf_lineto($pdf, $radius * 0.8, 0.0); - pdf_lineto($pdf, -$radius/10, $radius/20); - pdf_closepath($pdf); - pdf_fill($pdf); - pdf_restore($pdf); - - /* draw second hand */ - pdf_setrgbcolor($pdf, 1.0, 0.0, 0.0); - pdf_setlinewidth($pdf, 2); - pdf_save($pdf); - pdf_rotate($pdf, -(($ltime['seconds'] - 15.0) * 6.0)); - pdf_moveto($pdf, -$radius/5, 0.0); - pdf_lineto($pdf, $radius, 0.0); - pdf_stroke($pdf); - pdf_restore($pdf); - - /* draw little circle at center */ - pdf_circle($pdf, 0, 0, $radius/30); - pdf_fill($pdf); - - pdf_restore($pdf); + $p->set_info("Creator", "hello.php"); + $p->set_info("Author", "Rainer Schaaf"); + $p->set_info("Title", "Hello world (PHP)!"); - pdf_end_page($pdf); + $p->begin_page_ext(595, 842, ""); - # to see some difference - sleep(1); -} + $font = $p->load_font("Helvetica-Bold", "winansi", ""); -pdf_close($pdf); + $p->setfont($font, 24.0); + $p->set_text_pos(50, 700); + $p->show("Hello world!"); + $p->continue_text("(says PHP)"); + $p->end_page_ext(""); -$buf = pdf_get_buffer($pdf); -$len = strlen($buf); + $p->end_document(""); -header("Content-type: application/pdf"); -header("Content-Length: $len"); -header("Content-Disposition: inline; filename=foo.pdf"); -echo $buf; + $buf = $p->get_buffer(); + $len = strlen($buf); -pdf_delete($pdf); + header("Content-type: application/pdf"); + header("Content-Length: $len"); + header("Content-Disposition: inline; filename=hello.pdf"); + print $buf; +} +catch (PDFlibException $e) { + die("PDFlib exception occurred in hello sample:\n" . + "[" . $e->get_errnum() . "] " . $e->get_apiname() . ": " . + $e->get_errmsg() . "\n"); +} +catch (Exception $e) { + die($e); +} +$p = 0; ?> ]]> </programlisting> </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 - than PDFlib. - </para> - </note> - </section> - </partintro> -&reference.pdf.functions; + &reference.pdf.functions; </reference> <!-- Keep this comment at the end of the file http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-get-errmsg.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-get-errmsg.xml +++ phpdoc/en/reference/pdf/functions/pdf-get-errmsg.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-get-errmsg"> <refnamediv> <refname>pdf_get_errmsg</refname> <refpurpose>Get error text</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>pdf_get_errmsg</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> </methodsynopsis> <para> Gets the text of the last thrown exception or the reason for a failed function call. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-set-layer-dependency.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-set-layer-dependency.xml +++ phpdoc/en/reference/pdf/functions/pdf-set-layer-dependency.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-set-layer-dependency"> <refnamediv> <refname>pdf_set_layer_dependency</refname> <refpurpose>Define relationships among layers</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_set_layer_dependency</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>string</type><parameter>type</parameter></methodparam> <methodparam><type>string</type><parameter>optlist</parameter></methodparam> </methodsynopsis> <para> Defines hierarchical and group relationships among layers. &return.success; </para> <para> This function requires PDF 1.5.</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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-load-image.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-load-image.xml +++ phpdoc/en/reference/pdf/functions/pdf-load-image.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-load-image"> <refnamediv> <refname>pdf_load_image</refname> <refpurpose>Open image file</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>int</type><methodname>pdf_load_image</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>string</type><parameter>imagetype</parameter></methodparam> <methodparam><type>string</type><parameter>filename</parameter></methodparam> <methodparam><type>string</type><parameter>optlist</parameter></methodparam> </methodsynopsis> <para> Opens a disk-based or virtual image file subject to various options. This function returns an image handle which can be used in subsequent image-related calls. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-load-iccprofile.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-load-iccprofile.xml +++ phpdoc/en/reference/pdf/functions/pdf-load-iccprofile.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-load-iccprofile"> <refnamediv> <refname>pdf_load_iccprofile</refname> <refpurpose>Search and prepare ICC profile</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>int</type><methodname>pdf_load_iccprofile</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>string</type><parameter>profilename</parameter></methodparam> <methodparam><type>string</type><parameter>optlist</parameter></methodparam> </methodsynopsis> <para> Searches for an ICC profile, and prepares it for later use. This function returns a profile handle which can be used in subsequent calls to <function>pdf_load_image</function> or for setting profile-related parameters. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-fill-pdfblock.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-fill-pdfblock.xml +++ phpdoc/en/reference/pdf/functions/pdf-fill-pdfblock.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-fill-pdfblock"> <refnamediv> <refname>pdf_fill_pdfblock</refname> <refpurpose>Fill image block with variable data</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>int</type><methodname>pdf_fill_pdfblock</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>int</type><parameter>page</parameter></methodparam> <methodparam><type>string</type><parameter>blockname</parameter></methodparam> <methodparam><type>int</type><parameter>contents</parameter></methodparam> <methodparam><type>string</type><parameter>optlist</parameter></methodparam> </methodsynopsis> <para> Fills a PDF block with variable data according to its properties. </para> <para> This function is only available in the PDFlib Personalization Server (PPS). </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-fit-textflow.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-fit-textflow.xml +++ phpdoc/en/reference/pdf/functions/pdf-fit-textflow.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-fit-textflow"> <refnamediv> <refname>pdf_fit_textflow</refname> <refpurpose>Format textflow in rectangular area</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>pdf_fit_textflow</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>int</type><parameter>textflow</parameter></methodparam> <methodparam><type>float</type><parameter>llx</parameter></methodparam> <methodparam><type>float</type><parameter>lly</parameter></methodparam> <methodparam><type>float</type><parameter>urx</parameter></methodparam> <methodparam><type>float</type><parameter>ury</parameter></methodparam> <methodparam><type>string</type><parameter>optlist</parameter></methodparam> </methodsynopsis> <para> Formats the next portion of a textflow into a rectangular area. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-fit-image.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-fit-image.xml +++ phpdoc/en/reference/pdf/functions/pdf-fit-image.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-fit-image"> <refnamediv> <refname>pdf_fit_image</refname> <refpurpose>Place image or template</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_fit_image</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>int</type><parameter>image</parameter></methodparam> <methodparam><type>float</type><parameter>x</parameter></methodparam> <methodparam><type>float</type><parameter>y</parameter></methodparam> <methodparam><type>string</type><parameter>optlist</parameter></methodparam> </methodsynopsis> <para> Places an image or template at position (<parameter>x</parameter>, <parameter>y</parameter>) on the page, subject to various options. &return.success; </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-info-textflow.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-info-textflow.xml +++ phpdoc/en/reference/pdf/functions/pdf-info-textflow.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-info-textflow"> <refnamediv> <refname>pdf_info_textflow</refname> <refpurpose>Query textflow state</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>float</type><methodname>pdf_info_textflow</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>int</type><parameter>textflow</parameter></methodparam> <methodparam><type>string</type><parameter>keyword</parameter></methodparam> </methodsynopsis> <para> Queries the current state of a textflow. This function returns the value of some textflow parameter as requested by <parameter>keyword</parameter>. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-begin-document.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-begin-document.xml +++ phpdoc/en/reference/pdf/functions/pdf-begin-document.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-begin-document"> <refnamediv> <refname>pdf_begin_document</refname> <refpurpose>Create new PDF file</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>int</type><methodname>pdf_begin_document</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>string</type><parameter>filename</parameter></methodparam> <methodparam><type>string</type><parameter>optlist</parameter></methodparam> </methodsynopsis> <para> Creates a new PDF file subject to various options. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-create-fieldgroup.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-create-fieldgroup.xml +++ phpdoc/en/reference/pdf/functions/pdf-create-fieldgroup.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-create-fieldgroup"> <refnamediv> <refname>pdf_create_fieldgroup</refname> <refpurpose>Create form field group</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_create_fieldgroup</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>string</type><parameter>name</parameter></methodparam> <methodparam><type>string</type><parameter>optlist</parameter></methodparam> </methodsynopsis> <para> Creates a form field group subject to various options. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-end-item.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-end-item.xml +++ phpdoc/en/reference/pdf/functions/pdf-end-item.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-end-item"> <refnamediv> <refname>pdf_end_item</refname> <refpurpose>Close structure element or other content item</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_end_item</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>int</type><parameter>id</parameter></methodparam> </methodsynopsis> <para> Closes a structure element or other content item. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-define-layer.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-define-layer.xml +++ phpdoc/en/reference/pdf/functions/pdf-define-layer.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-define-layer"> <refnamediv> <refname>pdf_define_layer</refname> <refpurpose>Create layer definition</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>int</type><methodname>pdf_define_layer</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>string</type><parameter>name</parameter></methodparam> <methodparam><type>string</type><parameter>optlist</parameter></methodparam> </methodsynopsis> <para> Creates a new layer definition. This function returns a layer handle which can be used in calls to <function>pdf_begin_layer</function> and <function>set_layer_dependency</function>. </para> <para>This function requires PDF 1.5.</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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-create-action.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-create-action.xml +++ phpdoc/en/reference/pdf/functions/pdf-create-action.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-create-action"> <refnamediv> <refname>pdf_create_action</refname> <refpurpose>Create action for objects or events</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>int</type><methodname>pdf_create_action</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>string</type><parameter>type</parameter></methodparam> <methodparam><type>string</type><parameter>optlist</parameter></methodparam> </methodsynopsis> <para> Creates an action which can be applied to various objects and events. This function returns an action handle which can be used to attach actions to objects within the document. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-begin-layer.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-begin-layer.xml +++ phpdoc/en/reference/pdf/functions/pdf-begin-layer.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-begin-layer"> <refnamediv> <refname>pdf_begin_layer</refname> <refpurpose>Start layer</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_begin_layer</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>int</type><parameter>layer</parameter></methodparam> </methodsynopsis> <para> Starts a layer for subsequent output on the page. &return.success; </para> <para> This function requires PDF 1.5.</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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-begin-page-ext.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-begin-page-ext.xml +++ phpdoc/en/reference/pdf/functions/pdf-begin-page-ext.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-begin-page-ext"> <refnamediv> <refname>pdf_begin_page_ext</refname> <refpurpose>Start new page</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_begin_page_ext</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>float</type><parameter>width</parameter></methodparam> <methodparam><type>float</type><parameter>height</parameter></methodparam> <methodparam><type>string</type><parameter>optlist</parameter></methodparam> </methodsynopsis> <para> Adds a new page to the document, and specifies various options. The parameters <parameter>width</parameter> and <parameter>height</parameter> are the dimensions of the new page in points. &return.success; </para> <para> <table> <title>Common Page Sizes in Points</title> <tgroup cols="2"> <thead> <row> <entry>name</entry> <entry>size</entry> </row> </thead> <tbody> <row> <entry>A0</entry> <entry>2380&cross;3368</entry> </row> <row> <entry>A1</entry> <entry>1684&cross;2380</entry> </row> <row> <entry>A2</entry> <entry>1190&cross;1684</entry> </row> <row> <entry>A3</entry> <entry>842&cross;1190</entry> </row> <row> <entry>A4</entry> <entry>595&cross;842</entry> </row> <row> <entry>A5</entry> <entry>421&cross;595</entry> </row> <row> <entry>A6</entry> <entry>297&cross;421</entry> </row> <row> <entry>B5</entry> <entry>501&cross;709</entry> </row> <row> <entry>letter (8.5"&cross;11")</entry> <entry>612&cross;792</entry> </row> <row> <entry>legal (8.5"&cross;14")</entry> <entry>612&cross;1008</entry> </row> <row> <entry>ledger (17"&cross;11")</entry> <entry>1224&cross;792</entry> </row> <row> <entry>11"&cross;17"</entry> <entry>792&cross;1224</entry> </row> </tbody> </tgroup> </table> </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-create-gstate.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-create-gstate.xml +++ phpdoc/en/reference/pdf/functions/pdf-create-gstate.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-create-gstate"> <refnamediv> <refname>pdf_create_gstate</refname> <refpurpose>Create graphics state object</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>int</type><methodname>pdf_create_gstate</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>string</type><parameter>optlist</parameter></methodparam> </methodsynopsis> <para> Creates a graphics state object subject to various options. This function returns a gstate handle that can be used in subsequent calls to <function>pdf_set_gstate</function>. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-delete-pvf.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-delete-pvf.xml +++ phpdoc/en/reference/pdf/functions/pdf-delete-pvf.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-delete-pvf"> <refnamediv> <refname>pdf_delete_pvf</refname> <refpurpose>Delete PDFlib virtual file</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>int</type><methodname>pdf_delete_pvf</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>string</type><parameter>filename</parameter></methodparam> </methodsynopsis> <para> Deletes a named virtual file and frees its data structures (but not the contents). </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-load-font.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-load-font.xml +++ phpdoc/en/reference/pdf/functions/pdf-load-font.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-load-font"> <refnamediv> <refname>pdf_load_font</refname> <refpurpose>Search and prepare font</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>int</type><methodname>pdf_load_font</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>string</type><parameter>fontname</parameter></methodparam> <methodparam><type>string</type><parameter>encoding</parameter></methodparam> <methodparam><type>string</type><parameter>optlist</parameter></methodparam> </methodsynopsis> <para> Searches for a font and prepares it for later use. This function returns a font handle for later use with <function>pdf_setfont</function>. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-begin-font.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-begin-font.xml +++ phpdoc/en/reference/pdf/functions/pdf-begin-font.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-begin-font"> <refnamediv> <refname>pdf_begin_font</refname> <refpurpose>Start a Type 3 font definition</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_begin_font</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>string</type><parameter>filename</parameter></methodparam> <methodparam><type>float</type><parameter>a</parameter></methodparam> <methodparam><type>float</type><parameter>b</parameter></methodparam> <methodparam><type>float</type><parameter>c</parameter></methodparam> <methodparam><type>float</type><parameter>d</parameter></methodparam> <methodparam><type>float</type><parameter>e</parameter></methodparam> <methodparam><type>float</type><parameter>f</parameter></methodparam> <methodparam><type>string</type><parameter>optlist</parameter></methodparam> </methodsynopsis> <para> Starts a Type 3 font definition using the parameters <parameter>a</parameter>, <parameter>b</parameter>, <parameter>c</parameter>, <parameter>d</parameter>, <parameter>e</parameter>, and <parameter>f</parameter> as the elements of the font matrix. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-activate-item.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-activate-item.xml +++ phpdoc/en/reference/pdf/functions/pdf-activate-item.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-activate-item"> <refnamediv> <refname>pdf_activate_item</refname> <refpurpose>Activate structure element or other content item</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_activate_item</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>int</type><parameter>id</parameter></methodparam> </methodsynopsis> <para> Activates a previously created structure element or other content item. &return.success; </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-begin-glyph.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-begin-glyph.xml +++ phpdoc/en/reference/pdf/functions/pdf-begin-glyph.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-begin-glyph"> <refnamediv> <refname>pdf_begin_glyph</refname> <refpurpose>Start glyph definition for Type 3 font</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_begin_glyph</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>string</type><parameter>glyphname</parameter></methodparam> <methodparam><type>float</type><parameter>wx</parameter></methodparam> <methodparam><type>float</type><parameter>llx</parameter></methodparam> <methodparam><type>float</type><parameter>lly</parameter></methodparam> <methodparam><type>float</type><parameter>urx</parameter></methodparam> <methodparam><type>float</type><parameter>ury</parameter></methodparam> <methodparam><type>string</type><parameter>optlist</parameter></methodparam> </methodsynopsis> <para> Starts a glyph definition for a Type 3 font. The parameter <parameter>wx</parameter> is the glyph width and the parameters <parameter>llx</parameter>,<parameter>lly</parameter>, <parameter>urx</parameter> and <parameter>ury</parameter> specify the coordinates of the lower left and upper right corners of the bounding box of the glyph. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-add-note2.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-add-note2.xml +++ phpdoc/en/reference/pdf/functions/pdf-add-note2.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-add-note2"> <refnamediv> <refname>pdf_add_note2</refname> <refpurpose>Set annotation for current page [deprecated]</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <para> This function is deprecated since PDFlib version 6, use <function>pdf_create_annotation</function> with <parameter>type=Text</parameter> instead. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-attach-file2.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-attach-file2.xml +++ phpdoc/en/reference/pdf/functions/pdf-attach-file2.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-attach-file2"> <refnamediv> <refname>pdf_attach_file2</refname> <refpurpose>Add file attachment for current page [deprecated]</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <para> This function is deprecated since PDFlib version 6, use <function>pdf_create_annotation</function> with <parameter>type=FileAttachment</parameter> instead. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-create-pvf.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-create-pvf.xml +++ phpdoc/en/reference/pdf/functions/pdf-create-pvf.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-create-pvf"> <refnamediv> <refname>pdf_create_pvf</refname> <refpurpose>Create PDFlib virtual file</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_create_pvf</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>string</type><parameter>filename</parameter></methodparam> <methodparam><type>string</type><parameter>data</parameter></methodparam> <methodparam><type>string</type><parameter>optlist</parameter></methodparam> </methodsynopsis> <para> Creates a named virtual read-only file from data provided in memory. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-fit-textline.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-fit-textline.xml +++ phpdoc/en/reference/pdf/functions/pdf-fit-textline.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-fit-textline"> <refnamediv> <refname>pdf_fit_textline</refname> <refpurpose>Place single line of text</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_fit_textline</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>int</type><parameter>text</parameter></methodparam> <methodparam><type>float</type><parameter>x</parameter></methodparam> <methodparam><type>float</type><parameter>y</parameter></methodparam> <methodparam><type>string</type><parameter>optlist</parameter></methodparam> </methodsynopsis> <para> Places a single line of text at position (<parameter>x</parameter>, <parameter>y</parameter>) on the page, subject to various options. &return.success; </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-utf8-to-utf16.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-utf8-to-utf16.xml +++ phpdoc/en/reference/pdf/functions/pdf-utf8-to-utf16.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-utf8-to-utf16"> <refnamediv> <refname>pdf_utf8_to_utf16</refname> <refpurpose>Convert string from UTF-8 to UTF-16</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>pdf_utf8_to_utf16</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>string</type><parameter>utf8string</parameter></methodparam> <methodparam><type>string</type><parameter>ordering</parameter></methodparam> </methodsynopsis> <para> Converts a string from UTF-8 format to UTF-16. This function returns the converted UTF-16 string. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-delete-textflow.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-delete-textflow.xml +++ phpdoc/en/reference/pdf/functions/pdf-delete-textflow.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-delete-textflow"> <refnamediv> <refname>pdf_delete_textflow</refname> <refpurpose>Delete textflow object</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>int</type><methodname>pdf_delete_textflow</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>int</type><parameter>textflow</parameter></methodparam> </methodsynopsis> <para> Deletes a textflow and the associated data structures. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-suspend-page.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-suspend-page.xml +++ phpdoc/en/reference/pdf/functions/pdf-suspend-page.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-suspend-page"> <refnamediv> <refname>pdf_suspend_page</refname> <refpurpose>Suspend page</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_suspend_page</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>string</type><parameter>optlist</parameter></methodparam> </methodsynopsis> <para> Suspend the current page so that it can later be resumed with <function>pdf_resume_page</function>. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-end-document.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-end-document.xml +++ phpdoc/en/reference/pdf/functions/pdf-end-document.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-end-document"> <refnamediv> <refname>pdf_end_document</refname> <refpurpose>Close PDF file</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_end_document</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>string</type><parameter>optlist</parameter></methodparam> </methodsynopsis> <para> Closes the generated PDF file and applies various options. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-get-errnum.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-get-errnum.xml +++ phpdoc/en/reference/pdf/functions/pdf-get-errnum.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-get-errnum"> <refnamediv> <refname>pdf_get_errnum</refname> <refpurpose>Get error number</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>int</type><methodname>pdf_get_errnum</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> </methodsynopsis> <para> Gets the number of the last thrown exception or the reason for a failed function call. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-encoding-set-char.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-encoding-set-char.xml +++ phpdoc/en/reference/pdf/functions/pdf-encoding-set-char.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-encoding-set-char"> <refnamediv> <refname>pdf_encoding_set_char</refname> <refpurpose>Add glyph name and/or Unicode value</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_encoding_set_char</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>string</type><parameter>encoding</parameter></methodparam> <methodparam><type>int</type><parameter>slot</parameter></methodparam> <methodparam><type>string</type><parameter>glyphname</parameter></methodparam> <methodparam><type>int</type><parameter>uv</parameter></methodparam> </methodsynopsis> <para> Adds a glyph name and/or Unicode value to a custom encoding. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-create-field.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-create-field.xml +++ phpdoc/en/reference/pdf/functions/pdf-create-field.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-create-field"> <refnamediv> <refname>pdf_create_field</refname> <refpurpose>Create form field</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_create_field</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>float</type><parameter>llx</parameter></methodparam> <methodparam><type>float</type><parameter>lly</parameter></methodparam> <methodparam><type>float</type><parameter>urx</parameter></methodparam> <methodparam><type>float</type><parameter>ury</parameter></methodparam> <methodparam><type>string</type><parameter>name</parameter></methodparam> <methodparam><type>string</type><parameter>type</parameter></methodparam> <methodparam><type>string</type><parameter>optlist</parameter></methodparam> </methodsynopsis> <para> Creates a form field on the current page subject to various options. The parameters <parameter>llx</parameter>, <parameter>lly</parameter>, <parameter>urx</parameter> and <parameter>ury</parameter> specify the x and y coordinates of the lower left and upper right corners of the field rectangle. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-add-bookmark2.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-add-bookmark2.xml +++ phpdoc/en/reference/pdf/functions/pdf-add-bookmark2.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-add-bookmark2"> <refnamediv> <refname>pdf_add_bookmark2</refname> <refpurpose>Add bookmark for current page [deprecated]</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <para> This function is deprecated since PDFlib version 6, use <function>pdf_create_bookmark</function> instead. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-fit-pdi-page.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-fit-pdi-page.xml +++ phpdoc/en/reference/pdf/functions/pdf-fit-pdi-page.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-fit-pdi-page"> <refnamediv> <refname>pdf_fit_pdi_page</refname> <refpurpose>Place imported PDF page</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_fit_pdi_page</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>int</type><parameter>page</parameter></methodparam> <methodparam><type>float</type><parameter>x</parameter></methodparam> <methodparam><type>float</type><parameter>y</parameter></methodparam> <methodparam><type>string</type><parameter>optlist</parameter></methodparam> </methodsynopsis> <para> Places an imported PDF page on the page, subject to various options. &return.success; </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-utf16-to-utf8.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-utf16-to-utf8.xml +++ phpdoc/en/reference/pdf/functions/pdf-utf16-to-utf8.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-utf16-to-utf8"> <refnamediv> <refname>pdf_utf16_to_utf8</refname> <refpurpose>Convert string from UTF-16 to UTF-8</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>pdf_utf16_to_utf8</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>string</type><parameter>utf16string</parameter></methodparam> </methodsynopsis> <para> Converts a string from UTF-16 format to UTF-8. This function returns the converted UTF-8 string which will start with a BOM (\xEF\xBB\xBF). </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-end-layer.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-end-layer.xml +++ phpdoc/en/reference/pdf/functions/pdf-end-layer.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-end-layer"> <refnamediv> <refname>pdf_end_layer</refname> <refpurpose>Deactivate all active layers</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_end_layer</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> </methodsynopsis> <para> Deactivates all active layers. &return.success; </para> <para> This function requires PDF 1.5.</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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-shading-pattern.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-shading-pattern.xml +++ phpdoc/en/reference/pdf/functions/pdf-shading-pattern.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-shading-pattern"> <refnamediv> <refname>pdf_shading_pattern</refname> <refpurpose>Define shading pattern</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>int</type><methodname>pdf_shading_pattern</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>int</type><parameter>shading</parameter></methodparam> <methodparam><type>string</type><parameter>optlist</parameter></methodparam> </methodsynopsis> <para> Defines a shading pattern using a shading object. This function returns a pattern handle that can be used in subsequent calls to <function>pdf_setcolor</function>. </para> <para> This function requires PDF 1.4 or above. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-create-textflow.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-create-textflow.xml +++ phpdoc/en/reference/pdf/functions/pdf-create-textflow.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-create-textflow"> <refnamediv> <refname>pdf_create_textflow</refname> <refpurpose>Create textflow object</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>int</type><methodname>pdf_create_textflow</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>string</type><parameter>text</parameter></methodparam> <methodparam><type>string</type><parameter>optlist</parameter></methodparam> </methodsynopsis> <para> Preprocesses text for later formatting and creates a textflow object. This function returns a textflow handle which can be used in calls to <function>pdf_fit_textflow</function>, <function>pdf_info_textflow</function>, and <function>pdf_delete_textflow</function>. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-resume-page.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-resume-page.xml +++ phpdoc/en/reference/pdf/functions/pdf-resume-page.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-resume-page"> <refnamediv> <refname>pdf_resume_page</refname> <refpurpose>Resume page</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_resume_page</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>string</type><parameter>optlist</parameter></methodparam> </methodsynopsis> <para> Resumes a page to add more content to it. The page must have been suspended with <function>pdf_suspend_page</function>. It will be opened again so that more content can be added. All suspended pages must be resumed before they can be closed, even if no more content has been added. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-setdashpattern.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-setdashpattern.xml +++ phpdoc/en/reference/pdf/functions/pdf-setdashpattern.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-setdashpattern"> <refnamediv> <refname>pdf_setdashpattern</refname> <refpurpose>Set dash pattern</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_setdashpattern</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>string</type><parameter>optlist</parameter></methodparam> </methodsynopsis> <para> Sets a dash pattern defined by an option list. &return.success; </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-shfill.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-shfill.xml +++ phpdoc/en/reference/pdf/functions/pdf-shfill.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-shfill"> <refnamediv> <refname>pdf_shfill</refname> <refpurpose>Fill area with shading</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_shfill</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>int</type><parameter>shading</parameter></methodparam> </methodsynopsis> <para> Fills an area with a shading, based on a shading object. </para> <para> This function requires PDF 1.4 or above. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-end-glyph.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-end-glyph.xml +++ phpdoc/en/reference/pdf/functions/pdf-end-glyph.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-end-glyph"> <refnamediv> <refname>pdf_end_glyph</refname> <refpurpose>Terminate glyph definition for Type 3 font</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_end_glyph</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> </methodsynopsis> <para> Terminates a glyph definition for a Type 3 font. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-end-page-ext.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-end-page-ext.xml +++ phpdoc/en/reference/pdf/functions/pdf-end-page-ext.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-end-page-ext"> <refnamediv> <refname>pdf_end_page_ext</refname> <refpurpose>Finish page</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_end_page_ext</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>string</type><parameter>optlist</parameter></methodparam> </methodsynopsis> <para> Finishes a page, and applies various options. &return.success; </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-shading.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-shading.xml +++ phpdoc/en/reference/pdf/functions/pdf-shading.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-shading"> <refnamediv> <refname>pdf_shading</refname> <refpurpose>Define blend</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>int</type><methodname>pdf_shading</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>string</type><parameter>shtype</parameter></methodparam> <methodparam><type>float</type><parameter>x0</parameter></methodparam> <methodparam><type>float</type><parameter>y0</parameter></methodparam> <methodparam><type>float</type><parameter>x1</parameter></methodparam> <methodparam><type>float</type><parameter>y1</parameter></methodparam> <methodparam><type>float</type><parameter>c1</parameter></methodparam> <methodparam><type>float</type><parameter>c2</parameter></methodparam> <methodparam><type>float</type><parameter>c3</parameter></methodparam> <methodparam><type>float</type><parameter>c4</parameter></methodparam> </methodsynopsis> <para> Defines a blend from the current fill color to another color. For axial shadings, (<parameter>x0</parameter>, <parameter>y0</parameter>) and (<parameter>x1</parameter>, <parameter>y1</parameter>) are the coordinates of the starting and ending points of the shading. For radial shadings these points specify the centers of the starting and ending circles. <parameter>c1</parameter>, <parameter>c2</parameter>, <parameter>c3</parameter>, and <parameter>c4</parameter> are the color values of the shading endpoint, interpreted in the current fill color space in the same way as the color parameters in <function>pdf_setcolor</function>. </para> <para> This function returns a shading handle that can be used in subsequent calls to <function>pdf_shading_pattern</function> and <function>pdf_shfill</function>. </para> <para> This function requires PDF 1.4 or above. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-begin-item.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-begin-item.xml +++ phpdoc/en/reference/pdf/functions/pdf-begin-item.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-begin-item"> <refnamediv> <refname>pdf_begin_item</refname> <refpurpose>Open structure element or other content item</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>int</type><methodname>pdf_begin_item</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>string</type><parameter>tag</parameter></methodparam> <methodparam><type>string</type><parameter>optlist</parameter></methodparam> </methodsynopsis> <para> Opens a structure element or other content item with attributes supplied as options. This function returns an item handle which can be used in subsequent item-related calls. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-add-nameddest.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-add-nameddest.xml +++ phpdoc/en/reference/pdf/functions/pdf-add-nameddest.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-add-nameddest"> <refnamediv> <refname>pdf_add_nameddest</refname> <refpurpose>Create named destination</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_add_nameddest</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>string</type><parameter>name</parameter></methodparam> <methodparam><type>string</type><parameter>optlist</parameter></methodparam> </methodsynopsis> <para> Creates a named destination on an arbitrary page in the current document. &return.success; </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-create-annotation.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-create-annotation.xml +++ phpdoc/en/reference/pdf/functions/pdf-create-annotation.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-create-annotation"> <refnamediv> <refname>pdf_create_annotation</refname> <refpurpose>Create rectangular annotation</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_create_annotation</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>float</type><parameter>llx</parameter></methodparam> <methodparam><type>float</type><parameter>lly</parameter></methodparam> <methodparam><type>float</type><parameter>urx</parameter></methodparam> <methodparam><type>float</type><parameter>ury</parameter></methodparam> <methodparam><type>string</type><parameter>type</parameter></methodparam> <methodparam><type>string</type><parameter>optlist</parameter></methodparam> </methodsynopsis> <para> Creates a rectangular annotation on the current page. The parameters <parameter>llx</parameter>, <parameter>lly</parameter>, <parameter>urx</parameter> and <parameter>ury</parameter> specify the x and y coordinates of the lower left and upper right corners of the annotation rectangle. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-fill-textblock.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-fill-textblock.xml +++ phpdoc/en/reference/pdf/functions/pdf-fill-textblock.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-fill-textblock"> <refnamediv> <refname>pdf_fill_textblock</refname> <refpurpose>Fill text block with variable data</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>int</type><methodname>pdf_fill_textblock</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>int</type><parameter>page</parameter></methodparam> <methodparam><type>string</type><parameter>blockname</parameter></methodparam> <methodparam><type>string</type><parameter>text</parameter></methodparam> <methodparam><type>string</type><parameter>optlist</parameter></methodparam> </methodsynopsis> <para> Fills a text block with variable data according to its properties. </para> <para> This function is only available in the PDFlib Personalization Server (PPS). </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-create-bookmark.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-create-bookmark.xml +++ phpdoc/en/reference/pdf/functions/pdf-create-bookmark.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-create-bookmark"> <refnamediv> <refname>pdf_create_bookmark</refname> <refpurpose>Create bookmark</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>int</type><methodname>pdf_create_bookmark</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>string</type><parameter>text</parameter></methodparam> <methodparam><type>string</type><parameter>optlist</parameter></methodparam> </methodsynopsis> <para> Creates a bookmark subject to various options. This function returns a handle to the generated bookmark which may be used with the <parameter>parent</parameter> option in subsequent calls. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-xshow.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-xshow.xml +++ phpdoc/en/reference/pdf/functions/pdf-xshow.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-xshow"> <refnamediv> <refname>pdf_xshow</refname> <refpurpose>Output text at current position</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_xshow</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>string</type><parameter>text</parameter></methodparam> </methodsynopsis> <para> Prints <parameter>text</parameter> in the current font and size at the current position. &return.success; </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-end-font.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-end-font.xml +++ phpdoc/en/reference/pdf/functions/pdf-end-font.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-end-font"> <refnamediv> <refname>pdf_end_font</refname> <refpurpose>Terminate Type 3 font definition</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_end_font</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> </methodsynopsis> <para> Terminates a Type 3 font definition. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-get-apiname.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-get-apiname.xml +++ phpdoc/en/reference/pdf/functions/pdf-get-apiname.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-get-apiname"> <refnamediv> <refname>pdf_get_apiname</refname> <refpurpose>Get name of unsuccessfull API function</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>pdf_get_apiname</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> </methodsynopsis> <para> Gets the name of the API function which threw the last exception or failed. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-process-pdi.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-process-pdi.xml +++ phpdoc/en/reference/pdf/functions/pdf-process-pdi.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-process-pdi"> <refnamediv> <refname>pdf_process_pdi</refname> <refpurpose>Process imported PDF document</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>int</type><methodname>pdf_process_pdi</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>int</type><parameter>doc</parameter></methodparam> <methodparam><type>int</type><parameter>page</parameter></methodparam> <methodparam><type>string</type><parameter>optlist</parameter></methodparam> </methodsynopsis> <para> Processes certain elements of an imported PDF document. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-set-gstate.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-set-gstate.xml +++ phpdoc/en/reference/pdf/functions/pdf-set-gstate.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-set-gstate"> <refnamediv> <refname>pdf_set_gstate</refname> <refpurpose>Activate graphics state object</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pdf_set_gstate</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>int</type><parameter>gstate</parameter></methodparam> </methodsynopsis> <para> Activates a graphics state object. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/pdf/functions/pdf-fill-imageblock.xml?r=1.1&p=1 Index: phpdoc/en/reference/pdf/functions/pdf-fill-imageblock.xml +++ phpdoc/en/reference/pdf/functions/pdf-fill-imageblock.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 --> <refentry id="function.pdf-fill-imageblock"> <refnamediv> <refname>pdf_fill_imageblock</refname> <refpurpose>Fill image block with variable data</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>int</type><methodname>pdf_fill_imageblock</methodname> <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>int</type><parameter>page</parameter></methodparam> <methodparam><type>string</type><parameter>blockname</parameter></methodparam> <methodparam><type>int</type><parameter>image</parameter></methodparam> <methodparam><type>string</type><parameter>optlist</parameter></methodparam> </methodsynopsis> <para> Fills an image block with variable data according to its properties. </para> <para> This function is only available in the PDFlib Personalization Server (PPS). </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 -->