diff --git a/reference/pdf/functions/pdf-add-annotation.xml b/reference/pdf/functions/pdf-add-annotation.xml index a9d172fa09..ea9bded30c 100644 --- a/reference/pdf/functions/pdf-add-annotation.xml +++ b/reference/pdf/functions/pdf-add-annotation.xml @@ -1,5 +1,5 @@ - + @@ -9,11 +9,8 @@ Description - pdf_add_outline is replaced by - pdf_add_note - - - See also pdf_add_note. + This function is deprecated, use pdf_add_note + instead. diff --git a/reference/pdf/functions/pdf-add-bookmark.xml b/reference/pdf/functions/pdf-add-bookmark.xml index bbb17a3def..849e17da5e 100644 --- a/reference/pdf/functions/pdf-add-bookmark.xml +++ b/reference/pdf/functions/pdf-add-bookmark.xml @@ -1,5 +1,5 @@ - + @@ -10,7 +10,7 @@ Description intpdf_add_bookmark - intpdf_object + resourcepdfdoc stringtext intparent intopen @@ -19,7 +19,45 @@ Add a nested bookmark under parent, or a new top-level bookmark if parent = 0. Returns a bookmark descriptor which may be used as parent for subsequent nested bookmarks. - If open = 1, child bookmarks will be folded out, and invisible if open = 0. + If open = 1, child bookmarks will be folded out, and + invisible if open = 0. + + + + <function>pdf_add_bookmark</function> example + + +]]> + + diff --git a/reference/pdf/functions/pdf-add-launchlink.xml b/reference/pdf/functions/pdf-add-launchlink.xml index 64e5216d32..7775d9c65a 100644 --- a/reference/pdf/functions/pdf-add-launchlink.xml +++ b/reference/pdf/functions/pdf-add-launchlink.xml @@ -1,5 +1,5 @@ - + @@ -9,8 +9,8 @@ Description - intpdf_add_launchlink - intpdf_object + boolpdf_add_launchlink + resourcepdfdoc floatllx floatlly floaturx @@ -18,7 +18,11 @@ stringfilename - Add a launch annotation (to a target of arbitrary file type). + Adds a link to a web resource specified by filename. + &return.success; + + + See also pdf_add_locallink. diff --git a/reference/pdf/functions/pdf-add-locallink.xml b/reference/pdf/functions/pdf-add-locallink.xml index 2efa44cdce..265f20f53e 100644 --- a/reference/pdf/functions/pdf-add-locallink.xml +++ b/reference/pdf/functions/pdf-add-locallink.xml @@ -1,5 +1,5 @@ - + @@ -9,17 +9,27 @@ Description - intpdf_add_locallink - intpdf_object - floatllx - floatlly - floaturx - floatury + boolpdf_add_locallink + resourcepdfdoc + floatlowerleftx + floatlowerlefty + floatupperrightx + floatupperrighty intpage stringdest - Add a link annotation to a target within the current PDF file. + Add a link annotation to a target within the current PDF file. + &return.success; + + + dest is the zoom setting on the destination page, + it can be one of retain, fitpage, + fitwidth, fitheight or + fitbbox. + + + See also pdf_add_launchlink. diff --git a/reference/pdf/functions/pdf-add-note.xml b/reference/pdf/functions/pdf-add-note.xml index 28c3346f49..2578e1c01f 100644 --- a/reference/pdf/functions/pdf-add-note.xml +++ b/reference/pdf/functions/pdf-add-note.xml @@ -1,16 +1,16 @@ - + pdf_add_note - Add a note annotation for current page + Sets annotation for current page Description - intpdf_add_note - intpdf_object + boolpdf_add_note + resourcepdfdoc floatllx floatlly floaturx @@ -21,8 +21,10 @@ intopen - Add a note annotation. icon is one of of "comment, "insert", "note", - "paragraph", "newparagraph", "key", or "help". + Sets an annotation for the current page. icon is one of + comment, insert, note, + paragraph, newparagraph, + key, or help. &return.success; diff --git a/reference/pdf/functions/pdf-add-outline.xml b/reference/pdf/functions/pdf-add-outline.xml index b9591a139f..d6e972e13d 100644 --- a/reference/pdf/functions/pdf-add-outline.xml +++ b/reference/pdf/functions/pdf-add-outline.xml @@ -1,5 +1,5 @@ - + @@ -9,10 +9,8 @@ Description - Deprecated. - - - See pdf_add_bookmark. + This function is deprecated, use pdf_add_bookmark + instead. diff --git a/reference/pdf/functions/pdf-add-pdflink.xml b/reference/pdf/functions/pdf-add-pdflink.xml index f70bf3ae12..4a3b426cae 100644 --- a/reference/pdf/functions/pdf-add-pdflink.xml +++ b/reference/pdf/functions/pdf-add-pdflink.xml @@ -1,5 +1,5 @@ - + @@ -9,18 +9,23 @@ Description - intpdf_add_pdflink - intpdf_object - floatllx - floatlly - floaturx - floatury + boolpdf_add_pdflink + resourcepdfdoc + floatbottom_left_x + floatbottom_left_y + floatup_right_x + floatup_right_y stringfilename intpage stringdest - Add a file link annotation (to a PDF target). + Add a file link annotation (to a PDF target). + &return.success; + + + See also pdf_add_locallink and + pdf_add_weblink. diff --git a/reference/pdf/functions/pdf-add-thumbnail.xml b/reference/pdf/functions/pdf-add-thumbnail.xml index 1d5fae0659..67cbbdcd19 100644 --- a/reference/pdf/functions/pdf-add-thumbnail.xml +++ b/reference/pdf/functions/pdf-add-thumbnail.xml @@ -1,5 +1,5 @@ - + @@ -9,12 +9,13 @@ Description - intpdf_add_thumbnail - intpdf_object + boolpdf_add_thumbnail + resourcepdfdoc intimage - Add an existing image as thumbnail for the current page. + Adds an existing image as thumbnail for the current page. + &return.success; diff --git a/reference/pdf/functions/pdf-add-weblink.xml b/reference/pdf/functions/pdf-add-weblink.xml index 7c71b0194b..58f530158f 100644 --- a/reference/pdf/functions/pdf-add-weblink.xml +++ b/reference/pdf/functions/pdf-add-weblink.xml @@ -1,5 +1,5 @@ - + @@ -9,16 +9,17 @@ Description - intpdf_add_weblink - intpdf_object - floatllx - floatlly - floaturx - floatury + boolpdf_add_weblink + resourcepdfdoc + floatlowerleftx + floatlowerlefty + floatupperrightx + floatupperrighty stringurl - Add a weblink annotation to a target URL on the Web. + Add a weblink annotation to a target url on the Web. + &return.success; diff --git a/reference/pdf/functions/pdf-arc.xml b/reference/pdf/functions/pdf-arc.xml index 9dea181058..01f6d44441 100644 --- a/reference/pdf/functions/pdf-arc.xml +++ b/reference/pdf/functions/pdf-arc.xml @@ -1,5 +1,5 @@ - + @@ -9,8 +9,8 @@ Description - voidpdf_arc - resourcepdf_object + boolpdf_arc + resourcepdfdoc floatx floaty floatr @@ -18,11 +18,15 @@ floatbeta - Draw a counterclockwise circular arc from alpha to beta degrees + Draw a counterclockwise circular arc with center (x, + y) and radius r from + alpha to beta degrees. + &return.success; - - See also: pdf_arcn - + + See also pdf_arcn and + pdf_circle. + diff --git a/reference/pdf/functions/pdf-arcn.xml b/reference/pdf/functions/pdf-arcn.xml index 34b119c26a..c615f0f1ac 100644 --- a/reference/pdf/functions/pdf-arcn.xml +++ b/reference/pdf/functions/pdf-arcn.xml @@ -1,5 +1,5 @@ - + @@ -9,8 +9,8 @@ Description - voidpdf_arcn - resourcepdf_object + boolpdf_arcn + resourcepdfdoc floatx floaty floatr @@ -18,11 +18,15 @@ floatbeta - Draw a clockwise circular arc from alpha to beta degrees + Draw a clockwise circular arc with center (x, + y) and radius r from + alpha to beta degrees. + &return.success; + + + See also pdf_arc and + pdf_circle. - - See also: pdf_arc - diff --git a/reference/pdf/functions/pdf-attach-file.xml b/reference/pdf/functions/pdf-attach-file.xml index 15847da002..b2ec7e574b 100644 --- a/reference/pdf/functions/pdf-attach-file.xml +++ b/reference/pdf/functions/pdf-attach-file.xml @@ -1,16 +1,16 @@ - + pdf_attach_file - Adds a file attachement for current page + Adds a file attachment for current page Description - intpdf_attach_file - intpdf_object + boolpdf_attach_file + resourcepdfdoc floatllx floatlly floaturx @@ -22,8 +22,9 @@ stringicon - Add a file attachment annotation. icon is one of "graph, - "paperclip", "pushpin", or "tag". + Add a file attachment annotation. icon is one of + graph, paperclip, + pushpin, or tag. &return.success; diff --git a/reference/pdf/functions/pdf-begin-page.xml b/reference/pdf/functions/pdf-begin-page.xml index a4fda051bd..0601e4bc37 100644 --- a/reference/pdf/functions/pdf-begin-page.xml +++ b/reference/pdf/functions/pdf-begin-page.xml @@ -1,5 +1,5 @@ - + @@ -9,15 +9,15 @@ Description - voidpdf_begin_page - intpdf_object + boolpdf_begin_page + resourcepdfdoc floatwidth floatheight - Add a new page to the document. The width - and height are specified in points, which are - 1/72 of an inch. + Add a new page to the document. &return.success; + The width and height are + specified in points, which are 1/72 of an inch. @@ -82,6 +82,9 @@
+ + See also pdf_end_page. + diff --git a/reference/pdf/functions/pdf-begin-pattern.xml b/reference/pdf/functions/pdf-begin-pattern.xml index ee6a396c08..affc462a88 100644 --- a/reference/pdf/functions/pdf-begin-pattern.xml +++ b/reference/pdf/functions/pdf-begin-pattern.xml @@ -1,5 +1,5 @@ - + @@ -10,7 +10,7 @@ Description intpdf_begin_pattern - intpdf_object + resourcepdfdoc floatwidth floatheight floatxstep @@ -26,6 +26,9 @@ own colour settings whereas a value of 2 indicates that the current colour is used when the pattern is applied. + + See also pdf_end_pattern. + diff --git a/reference/pdf/functions/pdf-begin-template.xml b/reference/pdf/functions/pdf-begin-template.xml index 2189ba2330..3454690336 100644 --- a/reference/pdf/functions/pdf-begin-template.xml +++ b/reference/pdf/functions/pdf-begin-template.xml @@ -1,5 +1,5 @@ - + @@ -10,7 +10,7 @@ Description intpdf_begin_template - intpdf_object + resourcepdfdoc floatwidth floatheight diff --git a/reference/pdf/functions/pdf-circle.xml b/reference/pdf/functions/pdf-circle.xml index 7eb66804ec..2f26ffb6c8 100644 --- a/reference/pdf/functions/pdf-circle.xml +++ b/reference/pdf/functions/pdf-circle.xml @@ -1,5 +1,5 @@ - + @@ -9,14 +9,19 @@ Description - voidpdf_circle - intpdf_object + boolpdf_circle + resourcepdfdoc floatx floaty floatr - Draw a circle with center (x, y) and radius r. + Draw a circle with center (x, y) + and radius r. &return.success; + + + See also pdf_arc and + pdf_arcn. diff --git a/reference/pdf/functions/pdf-clip.xml b/reference/pdf/functions/pdf-clip.xml index ef1fffe5d1..d97640af33 100644 --- a/reference/pdf/functions/pdf-clip.xml +++ b/reference/pdf/functions/pdf-clip.xml @@ -1,5 +1,5 @@ - + @@ -9,11 +9,11 @@ Description - voidpdf_clip - intpdf_object + boolpdf_clip + resourcepdfdoc - Use the current path as clipping path. + Use the current path as clipping path. &return.success; diff --git a/reference/pdf/functions/pdf-close-image.xml b/reference/pdf/functions/pdf-close-image.xml index 24d37dfc32..f56daec7dd 100644 --- a/reference/pdf/functions/pdf-close-image.xml +++ b/reference/pdf/functions/pdf-close-image.xml @@ -1,5 +1,5 @@ - + @@ -10,12 +10,12 @@ Description voidpdf_close_image - intpdf_object + resourcepdfdoc intimage - Close an image retrieved with one of the - pdf_open_image* functions. + Close an image retrieved with the + pdf_open_image function. diff --git a/reference/pdf/functions/pdf-close-pdi-page.xml b/reference/pdf/functions/pdf-close-pdi-page.xml index c31012ed76..fcfb708154 100644 --- a/reference/pdf/functions/pdf-close-pdi-page.xml +++ b/reference/pdf/functions/pdf-close-pdi-page.xml @@ -1,5 +1,5 @@ - + @@ -11,12 +11,12 @@ Description - voidpdf_close_pdi_page - intpdf_object + boolpdf_close_pdi_page + resourcepdfdoc intpagehandle - Close the page handle, and free all page-related resources. + Close the page handle, and free all page-related resources. &return.success; diff --git a/reference/pdf/functions/pdf-close-pdi.xml b/reference/pdf/functions/pdf-close-pdi.xml index 61e6d815d0..4b5e442554 100644 --- a/reference/pdf/functions/pdf-close-pdi.xml +++ b/reference/pdf/functions/pdf-close-pdi.xml @@ -1,5 +1,5 @@ - + @@ -11,12 +11,15 @@ Description - voidpdf_close_pdi - intpdf_object + boolpdf_close_pdi + resourcepdfdoc intdochandle - Close all open page handles, and close the input PDF document. + Close all open page handles, and close the input PDF document. &return.success; + + + See also pdf_open_pdi. diff --git a/reference/pdf/functions/pdf-close.xml b/reference/pdf/functions/pdf-close.xml index cce2b540cd..efd0230b2d 100644 --- a/reference/pdf/functions/pdf-close.xml +++ b/reference/pdf/functions/pdf-close.xml @@ -1,19 +1,23 @@ - + pdf_close - Closes a pdf object + Closes a pdf resource Description - voidpdf_close - intpdf_object + boolpdf_close + resourcepdfdoc - Close the generated PDF file, and free all document-related resources. + Close the generated PDF file, and free all document-related resources. + &return.success; + + + See also pdf_new. diff --git a/reference/pdf/functions/pdf-closepath-fill-stroke.xml b/reference/pdf/functions/pdf-closepath-fill-stroke.xml index 07b87a2ec6..cff0b69d80 100644 --- a/reference/pdf/functions/pdf-closepath-fill-stroke.xml +++ b/reference/pdf/functions/pdf-closepath-fill-stroke.xml @@ -1,5 +1,5 @@ - + @@ -9,11 +9,15 @@ Description - voidpdf_closepath_fill_stroke - intpdf_object + boolpdf_closepath_fill_stroke + resourcepdfdoc - Close the path, fill, and stroke it. + Close the path, fill, and stroke it. &return.success; + + + See also pdf_closepath and + pdf_closepath_stroke. diff --git a/reference/pdf/functions/pdf-closepath-stroke.xml b/reference/pdf/functions/pdf-closepath-stroke.xml index 63884fa3b4..9901e0e018 100644 --- a/reference/pdf/functions/pdf-closepath-stroke.xml +++ b/reference/pdf/functions/pdf-closepath-stroke.xml @@ -1,5 +1,5 @@ - + @@ -9,11 +9,15 @@ Description - voidpdf_closepath_stroke - intpdf_object + boolpdf_closepath_stroke + resourcepdfdoc - Close the path, and stroke it. + Close the path, and stroke it. &return.success; + + + See also pdf_closepath and + pdf_closepath_fil_stroke. diff --git a/reference/pdf/functions/pdf-closepath.xml b/reference/pdf/functions/pdf-closepath.xml index 2ccd6bc5dd..559d15b909 100644 --- a/reference/pdf/functions/pdf-closepath.xml +++ b/reference/pdf/functions/pdf-closepath.xml @@ -1,5 +1,5 @@ - + @@ -9,11 +9,15 @@ Description - voidpdf_closepath - intpdf_object + boolpdf_closepath + resourcepdfdoc - Close the current path. + Close the current path. &return.success; + + + See also pdf_closepath_stroke and + pdf_closepath_fil_stroke. diff --git a/reference/pdf/functions/pdf-concat.xml b/reference/pdf/functions/pdf-concat.xml index c643d0a2f3..5f06ca7cce 100644 --- a/reference/pdf/functions/pdf-concat.xml +++ b/reference/pdf/functions/pdf-concat.xml @@ -1,5 +1,5 @@ - + @@ -9,8 +9,8 @@ Description - voidpdf_concat - intpdf_object + boolpdf_concat + resourcepdfdoc floata floatb floatc @@ -19,7 +19,7 @@ floatf - Concatenate a matrix to the CTM. + Concatenate a matrix to the CTM. &return.success; diff --git a/reference/pdf/functions/pdf-continue-text.xml b/reference/pdf/functions/pdf-continue-text.xml index da6340671a..017a4f6485 100644 --- a/reference/pdf/functions/pdf-continue-text.xml +++ b/reference/pdf/functions/pdf-continue-text.xml @@ -1,5 +1,5 @@ - + @@ -9,13 +9,12 @@ Description - voidpdf_continue_text - intpdf_object + boolpdf_continue_text + resourcepdfdoc stringtext - Print text at the next line. The spacing between lines is determined - by the leading parameter. + Print text at the next line. &return.success; diff --git a/reference/pdf/functions/pdf-curveto.xml b/reference/pdf/functions/pdf-curveto.xml index 871521da26..6de2f9bf67 100644 --- a/reference/pdf/functions/pdf-curveto.xml +++ b/reference/pdf/functions/pdf-curveto.xml @@ -1,5 +1,5 @@ - + @@ -9,8 +9,8 @@ Description - voidpdf_curveto - intpdf_object + boolpdf_curveto + resourcepdfdoc floatx1 floaty1 floatx2 @@ -19,7 +19,8 @@ floaty3 - Draw a Bezier curve from the current point, using 3 more control points. + Draw a Bezier curve from the current point, using 3 more control points. + &return.success; diff --git a/reference/pdf/functions/pdf-delete.xml b/reference/pdf/functions/pdf-delete.xml index 3f5c0bd5e6..8daff94ac0 100644 --- a/reference/pdf/functions/pdf-delete.xml +++ b/reference/pdf/functions/pdf-delete.xml @@ -1,5 +1,5 @@ - + @@ -9,11 +9,14 @@ Description - voidpdf_delete - intpdf_object + boolpdf_delete + resourcepdfdoc - Delete the PDF object, and free all internal resources. + Delete the PDF resource, and free all internal resources. &return.success; + + + See also pdf_new. diff --git a/reference/pdf/functions/pdf-end-page.xml b/reference/pdf/functions/pdf-end-page.xml index e9bdd62330..b62d3b4566 100644 --- a/reference/pdf/functions/pdf-end-page.xml +++ b/reference/pdf/functions/pdf-end-page.xml @@ -1,5 +1,5 @@ - + @@ -9,11 +9,14 @@ Description - voidpdf_end_page - intpdf_object + boolpdf_end_page + resourcepdfdoc - Finish the page. + Finish the page. &return.success; + + + See also pdf_begin_page. diff --git a/reference/pdf/functions/pdf-end-pattern.xml b/reference/pdf/functions/pdf-end-pattern.xml index 9a83566c52..fb45c13ddd 100644 --- a/reference/pdf/functions/pdf-end-pattern.xml +++ b/reference/pdf/functions/pdf-end-pattern.xml @@ -1,5 +1,5 @@ - + @@ -9,11 +9,14 @@ Description - voidpdf_end_pattern - intpdf_object + boolpdf_end_pattern + resourcepdfdoc - Finish the pattern definition. + Finish the pattern definition. &return.success; + + + See also pdf_begin_pattern. diff --git a/reference/pdf/functions/pdf-end-template.xml b/reference/pdf/functions/pdf-end-template.xml index 9dd7460e44..fc127270b1 100644 --- a/reference/pdf/functions/pdf-end-template.xml +++ b/reference/pdf/functions/pdf-end-template.xml @@ -1,5 +1,5 @@ - + @@ -9,11 +9,11 @@ Description - voidpdf_end_template - intpdf_object + boolpdf_end_template + resourcepdfdoc - Finish the template definition. + Finish the template definition. &return.success; diff --git a/reference/pdf/functions/pdf-endpath.xml b/reference/pdf/functions/pdf-endpath.xml index a62a5c1899..c3f223b91a 100644 --- a/reference/pdf/functions/pdf-endpath.xml +++ b/reference/pdf/functions/pdf-endpath.xml @@ -1,5 +1,5 @@ - + @@ -9,7 +9,9 @@ Description - Deprecated, use one of the stroke, fill, or clip functions instead. + This function is deprecated, use one of the + pdf_stroke, pdf_clip or + pdf_closepath_fill_stroke functions instead. diff --git a/reference/pdf/functions/pdf-fill-stroke.xml b/reference/pdf/functions/pdf-fill-stroke.xml index 0ccf4fbb6f..c8b9e54834 100644 --- a/reference/pdf/functions/pdf-fill-stroke.xml +++ b/reference/pdf/functions/pdf-fill-stroke.xml @@ -1,5 +1,5 @@ - + @@ -9,11 +9,15 @@ Description - voidpdf_fill_stroke - intpdf_object + boolpdf_fill_stroke + resourcepdfdoc - Fill and stroke the path with the current fill and stroke color. + Fill and stroke the path with the current fill and stroke color. + &return.success; + + + See also pdf_setcolor. diff --git a/reference/pdf/functions/pdf-findfont.xml b/reference/pdf/functions/pdf-findfont.xml index 75bdb59ab2..8a4511218a 100644 --- a/reference/pdf/functions/pdf-findfont.xml +++ b/reference/pdf/functions/pdf-findfont.xml @@ -1,5 +1,5 @@ - + @@ -10,18 +10,19 @@ Description intpdf_findfont - intpdf_object + resourcepdfdoc stringfontname stringencoding - intembed + intembed - Prepare a font for later use with pdf_setfont. - The metrics will be loaded, and if embed is nonzero, the font file - will be checked, but not yet - used. encoding is one of "builtin", - "macroman", "winansi", "host", or a user-defined encoding name, - or the name of a CMap. + Prepare a font for later use with pdf_setfont. + The metrics will be loaded, and if embed is + nonzero, the font file will be checked, but not yet used. + encoding is one of builtin, + macroman, winansi, + host, a user-defined encoding name or the name of + a CMap. pdf_findfont returns a font handle or &false; diff --git a/reference/pdf/functions/pdf-get-buffer.xml b/reference/pdf/functions/pdf-get-buffer.xml index 657de5893e..395fb411c4 100644 --- a/reference/pdf/functions/pdf-get-buffer.xml +++ b/reference/pdf/functions/pdf-get-buffer.xml @@ -1,5 +1,5 @@ - + @@ -10,7 +10,7 @@ Description stringpdf_get_buffer - intpdf_object + resourcepdfdoc Get the contents of the PDF output buffer. The result must be diff --git a/reference/pdf/functions/pdf-get-font.xml b/reference/pdf/functions/pdf-get-font.xml index e06fce7852..04f34a3bbf 100644 --- a/reference/pdf/functions/pdf-get-font.xml +++ b/reference/pdf/functions/pdf-get-font.xml @@ -1,5 +1,5 @@ - + @@ -9,10 +9,8 @@ Description - Deprecated. - - - See pdf_get_value. + This function is deprecated, use pdf_get_value + instead. diff --git a/reference/pdf/functions/pdf-get-fontname.xml b/reference/pdf/functions/pdf-get-fontname.xml index 1f1e8ceff6..36838423ff 100644 --- a/reference/pdf/functions/pdf-get-fontname.xml +++ b/reference/pdf/functions/pdf-get-fontname.xml @@ -1,5 +1,5 @@ - + @@ -9,10 +9,8 @@ Description - Deprecated. - - - See pdf_get_parameter. + This function is deprecated, use pdf_get_parameter + instead. diff --git a/reference/pdf/functions/pdf-get-fontsize.xml b/reference/pdf/functions/pdf-get-fontsize.xml index 04705bad35..1392864ad6 100644 --- a/reference/pdf/functions/pdf-get-fontsize.xml +++ b/reference/pdf/functions/pdf-get-fontsize.xml @@ -1,5 +1,5 @@ - + @@ -9,10 +9,8 @@ Description - Deprecated. - - - See pdf_get_value. + This function is deprecated, use pdf_get_value + instead. diff --git a/reference/pdf/functions/pdf-get-image-height.xml b/reference/pdf/functions/pdf-get-image-height.xml index acefd39568..edf813472c 100644 --- a/reference/pdf/functions/pdf-get-image-height.xml +++ b/reference/pdf/functions/pdf-get-image-height.xml @@ -1,21 +1,16 @@ - + pdf_get_image_height - Returns height of an image + Deprecated: returns height of an image Description - - stringpdf_get_image_height - intpdf_object - intimage - - pdf_get_image_height is deprecated, - use pdf_get_value instead. + This function is deprecated, use pdf_get_value + instead. diff --git a/reference/pdf/functions/pdf-get-image-width.xml b/reference/pdf/functions/pdf-get-image-width.xml index 95208529f0..fd35f38388 100644 --- a/reference/pdf/functions/pdf-get-image-width.xml +++ b/reference/pdf/functions/pdf-get-image-width.xml @@ -1,21 +1,16 @@ - + pdf_get_image_width - Returns width of an image + Deprecated: Returns width of an image Description - - stringpdf_get_image_width - intpdf_object - intimage - - The pdf_get_image_width is deprecated, - use pdf_get_value instead. + This function is deprecated, use pdf_get_value + instead. diff --git a/reference/pdf/functions/pdf-get-majorversion.xml b/reference/pdf/functions/pdf-get-majorversion.xml index 74591de046..beeed8f34d 100644 --- a/reference/pdf/functions/pdf-get-majorversion.xml +++ b/reference/pdf/functions/pdf-get-majorversion.xml @@ -1,5 +1,5 @@ - + @@ -17,6 +17,9 @@ Returns the major version number of the PDFlib. + + See also pdf_get_minorversion. + diff --git a/reference/pdf/functions/pdf-get-minorversion.xml b/reference/pdf/functions/pdf-get-minorversion.xml index b9a3f84552..12cbff0839 100644 --- a/reference/pdf/functions/pdf-get-minorversion.xml +++ b/reference/pdf/functions/pdf-get-minorversion.xml @@ -1,5 +1,5 @@ - + @@ -11,12 +11,15 @@ Description - intpdf_get_majorversion + intpdf_get_minorversion Returns the minor version number of the PDFlib. + + See also pdf_get_majorversion. + diff --git a/reference/pdf/functions/pdf-get-parameter.xml b/reference/pdf/functions/pdf-get-parameter.xml index c6fae9f3a6..ef0c1e14fa 100644 --- a/reference/pdf/functions/pdf-get-parameter.xml +++ b/reference/pdf/functions/pdf-get-parameter.xml @@ -1,5 +1,5 @@ - + @@ -10,7 +10,7 @@ Description stringpdf_get_parameter - intpdf_object + resourcepdfdoc stringkey floatmodifier diff --git a/reference/pdf/functions/pdf-get-pdi-parameter.xml b/reference/pdf/functions/pdf-get-pdi-parameter.xml index 4d123c6a22..1677210b35 100644 --- a/reference/pdf/functions/pdf-get-pdi-parameter.xml +++ b/reference/pdf/functions/pdf-get-pdi-parameter.xml @@ -1,5 +1,5 @@ - + @@ -10,14 +10,15 @@ Description stringpdf_get_pdi_parameter - intpdf_object + resourcepdfdoc stringkey - intdoc + intdocument intpage intindex - Get the contents of some PDI document parameter with string type. + Get the contents of some PDI document parameter + with string type. diff --git a/reference/pdf/functions/pdf-get-pdi-value.xml b/reference/pdf/functions/pdf-get-pdi-value.xml index 3aab038ba6..15a28d4b8c 100644 --- a/reference/pdf/functions/pdf-get-pdi-value.xml +++ b/reference/pdf/functions/pdf-get-pdi-value.xml @@ -1,5 +1,5 @@ - + @@ -10,7 +10,7 @@ Description stringpdf_get_pdi_value - intpdf_object + resourcepdfdoc stringkey intdoc intpage diff --git a/reference/pdf/functions/pdf-get-value.xml b/reference/pdf/functions/pdf-get-value.xml index b9942b27e5..12fa93d75e 100644 --- a/reference/pdf/functions/pdf-get-value.xml +++ b/reference/pdf/functions/pdf-get-value.xml @@ -1,5 +1,5 @@ - + @@ -10,7 +10,7 @@ Description floatpdf_get_value - intpdf_object + resourcepdfdoc stringkey floatmodifier diff --git a/reference/pdf/functions/pdf-initgraphics.xml b/reference/pdf/functions/pdf-initgraphics.xml index 2498ed5d86..9a4142b667 100644 --- a/reference/pdf/functions/pdf-initgraphics.xml +++ b/reference/pdf/functions/pdf-initgraphics.xml @@ -1,5 +1,5 @@ - + @@ -9,11 +9,12 @@ Description - voidpdf_initgraphics - intpdf_object + boolpdf_initgraphics + resourcepdfdoc - Reset all implicit color and graphics state parameters to their defaults. + Reset all implicit color and graphics state parameters to their defaults. + &return.success; diff --git a/reference/pdf/functions/pdf-lineto.xml b/reference/pdf/functions/pdf-lineto.xml index dea2e05f86..0b534c2ad2 100644 --- a/reference/pdf/functions/pdf-lineto.xml +++ b/reference/pdf/functions/pdf-lineto.xml @@ -1,5 +1,5 @@ - + @@ -9,14 +9,14 @@ Description - voidpdf_lineto - intpdf_object + boolpdf_lineto + resourcepdfdoc floatx floaty - Draw a line from the current point to (x, - y). + Draw a line from the current point to (x, + y). &return.success; diff --git a/reference/pdf/functions/pdf-makespotcolor.xml b/reference/pdf/functions/pdf-makespotcolor.xml index ca759b5bb7..7f6e67f93e 100644 --- a/reference/pdf/functions/pdf-makespotcolor.xml +++ b/reference/pdf/functions/pdf-makespotcolor.xml @@ -1,5 +1,5 @@ - + @@ -9,12 +9,15 @@ Description - voidpdf_makespotcolor - intpdf_object + boolpdf_makespotcolor + resourcepdfdoc stringspotname - Make a named spot color from the current color. + Make a named spot color from the current color. &return.success; + + + See also pdf_setcolor. diff --git a/reference/pdf/functions/pdf-moveto.xml b/reference/pdf/functions/pdf-moveto.xml index bf43ad4afc..22d0445bc4 100644 --- a/reference/pdf/functions/pdf-moveto.xml +++ b/reference/pdf/functions/pdf-moveto.xml @@ -1,5 +1,5 @@ - + @@ -9,13 +9,14 @@ Description - voidpdf_moveto - intpdf_object + boolpdf_moveto + resourcepdfdoc floatx floaty - Set the current point. + Set the current point to (x, y. + &return.success; diff --git a/reference/pdf/functions/pdf-new.xml b/reference/pdf/functions/pdf-new.xml index a679d97dd2..882ba8f2eb 100644 --- a/reference/pdf/functions/pdf-new.xml +++ b/reference/pdf/functions/pdf-new.xml @@ -1,21 +1,24 @@ - + pdf_new - Creates a new pdf object + Creates a new pdf resource Description - intpdf_new + resourcepdf_new - Create a new PDF object, using default error handling + Create a new PDF resource, using default error handling and memory management. + + See also pdf_close. + diff --git a/reference/pdf/functions/pdf-open-ccitt.xml b/reference/pdf/functions/pdf-open-ccitt.xml index 60e9054fdd..fdaefe5e7c 100644 --- a/reference/pdf/functions/pdf-open-ccitt.xml +++ b/reference/pdf/functions/pdf-open-ccitt.xml @@ -1,5 +1,5 @@ - + @@ -10,7 +10,7 @@ Description intpdf_open_CCITT - intpdf_object + resourcepdfdoc stringfilename intwidth intheight diff --git a/reference/pdf/functions/pdf-open-file.xml b/reference/pdf/functions/pdf-open-file.xml index 3be5126021..9e3f2a8050 100644 --- a/reference/pdf/functions/pdf-open-file.xml +++ b/reference/pdf/functions/pdf-open-file.xml @@ -1,5 +1,5 @@ - + @@ -9,16 +9,16 @@ Description - intpdf_open_file - intpdf_object + boolpdf_open_file + resourcepdfdoc stringfilename - Create a new PDF file using the supplied file name. - If filename is empty the PDF document - will be generated in memory instead of on file. The result - must be fetched by the client with the - pdf_get_buffer function. + Create a new PDF file using the supplied file name. + If filename is empty the PDF document + will be generated in memory instead of on file. The result + must be fetched by the client with the + pdf_get_buffer function. &return.success; The following example shows how to create a pdf document in memory diff --git a/reference/pdf/functions/pdf-open-gif.xml b/reference/pdf/functions/pdf-open-gif.xml index 5105250189..acebb929cf 100644 --- a/reference/pdf/functions/pdf-open-gif.xml +++ b/reference/pdf/functions/pdf-open-gif.xml @@ -1,5 +1,5 @@ - + @@ -9,10 +9,8 @@ Description - Deprecated. - - - See pdf_open_image, + This function is deprecated, use pdf_open_image + instead. diff --git a/reference/pdf/functions/pdf-open-image-file.xml b/reference/pdf/functions/pdf-open-image-file.xml index faafc1eedd..d57d904ea5 100644 --- a/reference/pdf/functions/pdf-open-image-file.xml +++ b/reference/pdf/functions/pdf-open-image-file.xml @@ -1,5 +1,5 @@ - + @@ -10,16 +10,18 @@ Description intpdf_open_image_file - intPDF-document + resourcepdfdoc stringimagetype stringfilename stringstringparam stringintparam - Open an image file. Supported types are "jpeg", "tiff", "gif", - and "png". stringparam is either - "", "mask", "masked", or "page". + Open an image file. Supported types are jpeg, + tiff, gif, and png. + stringparam is either , + mask, masked, or + page. intparamis either 0, the image id of the applied mask, or the page. diff --git a/reference/pdf/functions/pdf-open-image.xml b/reference/pdf/functions/pdf-open-image.xml index a11138e56d..f63a67d860 100644 --- a/reference/pdf/functions/pdf-open-image.xml +++ b/reference/pdf/functions/pdf-open-image.xml @@ -1,5 +1,5 @@ - + @@ -10,7 +10,7 @@ Description intpdf_open_image - intPDF-document + resourcePDF-document stringimagetype stringsource stringdata @@ -22,10 +22,12 @@ stringparams - Use image data from a variety of data sources. Supported types are - "jpeg", "ccitt", "raw". Supported sources are "memory", "fileref", - "url". len is only used for type="raw", params is only - used for type="ccitt". + Use image data from a variety of data sources. Supported types are + jpeg, ccitt, raw. + Supported sources are memory, fileref, + url. len is only used when type is + raw, params is only used when type + is ccitt. diff --git a/reference/pdf/functions/pdf-open-jpeg.xml b/reference/pdf/functions/pdf-open-jpeg.xml index 2a99ba493d..e19d6a13c6 100644 --- a/reference/pdf/functions/pdf-open-jpeg.xml +++ b/reference/pdf/functions/pdf-open-jpeg.xml @@ -1,5 +1,5 @@ - + @@ -9,10 +9,8 @@ Description - Deprecated. - - - See also pdf_open_image, + This function is deprecated, use pdf_open_image + instead. diff --git a/reference/pdf/functions/pdf-open-memory-image.xml b/reference/pdf/functions/pdf-open-memory-image.xml index 425d27c05d..baab09c423 100644 --- a/reference/pdf/functions/pdf-open-memory-image.xml +++ b/reference/pdf/functions/pdf-open-memory-image.xml @@ -1,5 +1,5 @@ - + @@ -10,34 +10,35 @@ Description intpdf_open_memory_image - intpdf_object - intimage + resourcepdfdoc + resourceimage The pdf_open_memory_image function takes - an image created with the PHP's image functions and makes it available - for the pdf object. The function returns a pdf - image identifier. - + an image created with the PHP's image + functions and makes it available for the pdf resource. + The function returns a pdf image identifier. Including a memory image - + ]]> - + + - See also pdf_close_image, - pdf_place_image. + See also pdf_close_image and + pdf_place_image. + diff --git a/reference/pdf/functions/pdf-open-pdi-page.xml b/reference/pdf/functions/pdf-open-pdi-page.xml index 37b03e22a0..91988c00eb 100644 --- a/reference/pdf/functions/pdf-open-pdi-page.xml +++ b/reference/pdf/functions/pdf-open-pdi-page.xml @@ -1,5 +1,5 @@ - + @@ -12,7 +12,7 @@ Description intpdf_open_pdi_page - intpdf_object + resourcepdfdoc intdochandle intpagenumber stringpagelabel diff --git a/reference/pdf/functions/pdf-open-pdi.xml b/reference/pdf/functions/pdf-open-pdi.xml index 8e0ee15206..a9229c68a8 100644 --- a/reference/pdf/functions/pdf-open-pdi.xml +++ b/reference/pdf/functions/pdf-open-pdi.xml @@ -1,5 +1,5 @@ - + @@ -12,13 +12,16 @@ Description intpdf_open_pdi - intpdf_object + resourcepdfdoc stringfilename stringstringparam intintparam - Open an existing PDF document for later use. + Opens an existing PDF document and prepares it for later use. + + + See also pdf_close_pdi. diff --git a/reference/pdf/functions/pdf-open-png.xml b/reference/pdf/functions/pdf-open-png.xml index a2bccef660..f7e383a115 100644 --- a/reference/pdf/functions/pdf-open-png.xml +++ b/reference/pdf/functions/pdf-open-png.xml @@ -1,22 +1,20 @@ - + - - pdf_open_png - - Deprecated: Opens a PNG image - - - - Description - - Deprecated. - - - See pdf_open_image. - - + + pdf_open_png + + Deprecated: Opens a PNG image + + + + Description + + This function is deprecated, use pdf_open_image + instead. + + + @@ -8,16 +8,9 @@ Description - - intpdf_open_tiff - intPDF-document - stringfilename - - Deprecated. - - - See also pdf_open_image, + This function is deprecated, use pdf_open_image + instead. diff --git a/reference/pdf/functions/pdf-open.xml b/reference/pdf/functions/pdf-open.xml index be869184c1..dab6df7a4f 100644 --- a/reference/pdf/functions/pdf-open.xml +++ b/reference/pdf/functions/pdf-open.xml @@ -1,5 +1,5 @@ - + @@ -9,13 +9,8 @@ Description - pdf_open is deprecated, use - pdf_new plus pdf_open_file - instead. - - - See also pdf_new, - pdf_open_file. + This function is deprecated, use pdf_new + plus pdf_open_file instead. diff --git a/reference/pdf/functions/pdf-place-image.xml b/reference/pdf/functions/pdf-place-image.xml index 32923dccb8..5ea3985160 100644 --- a/reference/pdf/functions/pdf-place-image.xml +++ b/reference/pdf/functions/pdf-place-image.xml @@ -1,5 +1,5 @@ - + @@ -9,16 +9,16 @@ Description - voidpdf_place_image - intpdf_object + boolpdf_place_image + resourcepdfdoc intimage floatx floaty floatscale - Place an image with the lower left corner at (x, - y), and scale it. + Place an image with the lower left corner at (x, + y), and scale it. &return.success; diff --git a/reference/pdf/functions/pdf-place-pdi-page.xml b/reference/pdf/functions/pdf-place-pdi-page.xml index fc1957dc97..ff25f3844b 100644 --- a/reference/pdf/functions/pdf-place-pdi-page.xml +++ b/reference/pdf/functions/pdf-place-pdi-page.xml @@ -1,5 +1,5 @@ - + @@ -9,8 +9,8 @@ Description - voidpdf_place_pdi_page - intpdf_object + boolpdf_place_pdi_page + resourcepdfdoc intpage floatx floaty @@ -19,7 +19,7 @@ Place a PDF page with the lower left corner at (x, - y), and scale it. + y), and scale it. &return.success; diff --git a/reference/pdf/functions/pdf-rect.xml b/reference/pdf/functions/pdf-rect.xml index 76adea18e8..5ad22f96cc 100644 --- a/reference/pdf/functions/pdf-rect.xml +++ b/reference/pdf/functions/pdf-rect.xml @@ -1,5 +1,5 @@ - + @@ -9,15 +9,17 @@ Description - voidpdf_rect - intpdf_object + boolpdf_rect + resourcepdfdoc floatx floaty floatwidth floatheight - Draw a rectangle at lower left (x, y) with width and height. + Draw a (width * height) + rectangle at lower left (x, y). + &return.success; diff --git a/reference/pdf/functions/pdf-restore.xml b/reference/pdf/functions/pdf-restore.xml index be3a628931..0d1e379066 100644 --- a/reference/pdf/functions/pdf-restore.xml +++ b/reference/pdf/functions/pdf-restore.xml @@ -1,5 +1,5 @@ - + @@ -9,11 +9,11 @@ Description - voidpdf_restore - intpdf_object + boolpdf_restore + resourcepdfdoc - Restore the most recently saved graphics state. + Restore the most recently saved graphics state. &return.success; diff --git a/reference/pdf/functions/pdf-rotate.xml b/reference/pdf/functions/pdf-rotate.xml index 00903b8e2b..10754237e6 100644 --- a/reference/pdf/functions/pdf-rotate.xml +++ b/reference/pdf/functions/pdf-rotate.xml @@ -1,5 +1,5 @@ - + @@ -9,12 +9,13 @@ Description - voidpdf_rotate - intpdf_object + boolpdf_rotate + resourcepdfdoc floatphi - Rotate the coordinate system by phi degrees. + Rotate the coordinate system by phi degrees. + &return.success; diff --git a/reference/pdf/functions/pdf-save.xml b/reference/pdf/functions/pdf-save.xml index 0046d61526..23e4dea14e 100644 --- a/reference/pdf/functions/pdf-save.xml +++ b/reference/pdf/functions/pdf-save.xml @@ -1,5 +1,5 @@ - + @@ -9,11 +9,11 @@ Description - voidpdf_save - intpdf_object + boolpdf_save + resourcepdfdoc - Save the current graphics state. + Save the current graphics state. &return.success; diff --git a/reference/pdf/functions/pdf-scale.xml b/reference/pdf/functions/pdf-scale.xml index 9aef54cd09..7967e41198 100644 --- a/reference/pdf/functions/pdf-scale.xml +++ b/reference/pdf/functions/pdf-scale.xml @@ -1,5 +1,5 @@ - + @@ -9,13 +9,13 @@ Description - voidpdf_scale - intpdf_object + boolpdf_scale + resourcepdfdoc floatx-scale floaty-scale - Scale the coordinate system. + Scale the coordinate system. &return.success; diff --git a/reference/pdf/functions/pdf-set-border-color.xml b/reference/pdf/functions/pdf-set-border-color.xml index 2e33cee4c6..b65d7d00ed 100644 --- a/reference/pdf/functions/pdf-set-border-color.xml +++ b/reference/pdf/functions/pdf-set-border-color.xml @@ -1,5 +1,5 @@ - + @@ -9,14 +9,14 @@ Description - voidpdf_set_border_color - intpdf_object + boolpdf_set_border_color + resourcepdfdoc floatred floatgreen floatblue - Set the border color for all kinds of annotations. + Set the border color for all kinds of annotations. &return.success; diff --git a/reference/pdf/functions/pdf-set-border-dash.xml b/reference/pdf/functions/pdf-set-border-dash.xml index f7fca43706..fae6d679a5 100644 --- a/reference/pdf/functions/pdf-set-border-dash.xml +++ b/reference/pdf/functions/pdf-set-border-dash.xml @@ -1,5 +1,5 @@ - + @@ -9,14 +9,16 @@ Description - voidpdf_set_border_dash - intpdf_object + boolpdf_set_border_dash + resourcepdfdoc floatblack floatwhite - Set the border dash style for all kinds of annotations. - See pdf_setdash. + Sets the border dash style for all kinds of annotations. &return.success; + + + See also pdf_setdash. diff --git a/reference/pdf/functions/pdf-set-border-style.xml b/reference/pdf/functions/pdf-set-border-style.xml index 340ac7007f..787ad52245 100644 --- a/reference/pdf/functions/pdf-set-border-style.xml +++ b/reference/pdf/functions/pdf-set-border-style.xml @@ -1,5 +1,5 @@ - + @@ -9,14 +9,15 @@ Description - voidpdf_set_border_style - intpdf_object + boolpdf_set_border_style + resourcepdfdoc stringstyle floatwidth - Set the border style for all kinds of annotations. - style is "solid" or "dashed". + Sets the border style for all kinds of annotations. + style is solid or + dashed. &return.success; diff --git a/reference/pdf/functions/pdf-set-char-spacing.xml b/reference/pdf/functions/pdf-set-char-spacing.xml index 1a462c240c..5232e45ff3 100644 --- a/reference/pdf/functions/pdf-set-char-spacing.xml +++ b/reference/pdf/functions/pdf-set-char-spacing.xml @@ -1,5 +1,5 @@ - + @@ -9,10 +9,8 @@ Description - Deprecated. - - - See also pdf_set_value, + This function is deprecated, use pdf_set_value + instead. diff --git a/reference/pdf/functions/pdf-set-duration.xml b/reference/pdf/functions/pdf-set-duration.xml index 5a9b0a138c..b98398db28 100644 --- a/reference/pdf/functions/pdf-set-duration.xml +++ b/reference/pdf/functions/pdf-set-duration.xml @@ -1,5 +1,5 @@ - + @@ -9,10 +9,8 @@ Description - Deprecated. - - - See pdf_set_value. + This function is deprecated, use pdf_set_value + instead. diff --git a/reference/pdf/functions/pdf-set-font.xml b/reference/pdf/functions/pdf-set-font.xml index 8b1c7af6e2..e07fb82385 100644 --- a/reference/pdf/functions/pdf-set-font.xml +++ b/reference/pdf/functions/pdf-set-font.xml @@ -1,5 +1,5 @@ - + @@ -9,12 +9,8 @@ Description - Deprecated. You should use pdf_findfont plus - pdf_setfont instead. - - - See pdf_findfont, - pdf_setfont. + This function is deprecated, use pdf_findfont + plus pdf_setfont instead. diff --git a/reference/pdf/functions/pdf-set-horiz-scaling.xml b/reference/pdf/functions/pdf-set-horiz-scaling.xml index aff2f5c142..70f8ca0165 100644 --- a/reference/pdf/functions/pdf-set-horiz-scaling.xml +++ b/reference/pdf/functions/pdf-set-horiz-scaling.xml @@ -1,5 +1,5 @@ - + @@ -8,16 +8,9 @@ Description - - voidpdf_set_horiz_scaling - intpdf_object - floatscale - - Deprecated. - - - See also pdf_set_value, + This function is deprecated, use pdf_set_value + instead. diff --git a/reference/pdf/functions/pdf-set-info-author.xml b/reference/pdf/functions/pdf-set-info-author.xml index c1d95d3bf0..603ba38378 100644 --- a/reference/pdf/functions/pdf-set-info-author.xml +++ b/reference/pdf/functions/pdf-set-info-author.xml @@ -1,22 +1,17 @@ - + pdf_set_info_author - Fills the author field of the document + Deprecated: Fills the author field of the document Description - - boolpdf_set_info_author - intpdfdoc - stringauthor - - This function is deprecate, use pdf_set_info instead. + This function is deprecated, use pdf_set_info instead. diff --git a/reference/pdf/functions/pdf-set-info-creator.xml b/reference/pdf/functions/pdf-set-info-creator.xml index 0c08911c7a..b36f199c2a 100644 --- a/reference/pdf/functions/pdf-set-info-creator.xml +++ b/reference/pdf/functions/pdf-set-info-creator.xml @@ -1,22 +1,17 @@ - + pdf_set_info_creator - Fills the creator field of the document + Deprecated: Fills the creator field of the document Description - - boolpdf_set_info_creator - intpdfdoc - stringcreator - - This function is deprecate, use pdf_set_info instead. + This function is deprecated, use pdf_set_info instead. diff --git a/reference/pdf/functions/pdf-set-info-keywords.xml b/reference/pdf/functions/pdf-set-info-keywords.xml index 74b74ef874..f83ab901a2 100644 --- a/reference/pdf/functions/pdf-set-info-keywords.xml +++ b/reference/pdf/functions/pdf-set-info-keywords.xml @@ -1,22 +1,17 @@ - + pdf_set_info_keywords - Fills the keywords field of the document + Deprecated: Fills the keywords field of the document Description - - boolpdf_set_info_keywords - intpdfdoc - stringkeywords - - This function is deprecate, use pdf_set_info instead. + This function is deprecated, use pdf_set_info instead. diff --git a/reference/pdf/functions/pdf-set-info-subject.xml b/reference/pdf/functions/pdf-set-info-subject.xml index 7a28fda90e..19c17da07b 100644 --- a/reference/pdf/functions/pdf-set-info-subject.xml +++ b/reference/pdf/functions/pdf-set-info-subject.xml @@ -1,22 +1,17 @@ - + pdf_set_info_subject - Fills the subject field of the document + Deprecated: Fills the subject field of the document Description - - boolpdf_set_info_subject - intpdfdoc - stringsubject - - This function is deprecate, use pdf_set_info instead. + This function is deprecated, use pdf_set_info instead. diff --git a/reference/pdf/functions/pdf-set-info-title.xml b/reference/pdf/functions/pdf-set-info-title.xml index c9ee68b3f1..1eb0e26c3e 100644 --- a/reference/pdf/functions/pdf-set-info-title.xml +++ b/reference/pdf/functions/pdf-set-info-title.xml @@ -1,22 +1,17 @@ - + pdf_set_info_title - Fills the title field of the document + Deprecated: Fills the title field of the document Description - - boolpdf_set_info_title - intpdfdoc - stringtitle - - This function is deprecate, use pdf_set_info instead. + This function is deprecated, use pdf_set_info instead. diff --git a/reference/pdf/functions/pdf-set-info.xml b/reference/pdf/functions/pdf-set-info.xml index 9a31d15e55..463d17104e 100644 --- a/reference/pdf/functions/pdf-set-info.xml +++ b/reference/pdf/functions/pdf-set-info.xml @@ -1,5 +1,5 @@ - + @@ -9,15 +9,18 @@ Description - voidpdf_set_info - intpdf_object + boolpdf_set_info + resourcepdfdoc stringkey stringvalue - Fill document information field key with value. - key is one of "Subject", "Title", "Creator", - "Author", "Keywords", or a user-defined key. + Fill document information field key with + value. &return.success; + key is one of Subject, + Title, Creator, + Author, Keywords, + or a user-defined key. diff --git a/reference/pdf/functions/pdf-set-leading.xml b/reference/pdf/functions/pdf-set-leading.xml index 5a35c7d049..253170b019 100644 --- a/reference/pdf/functions/pdf-set-leading.xml +++ b/reference/pdf/functions/pdf-set-leading.xml @@ -1,5 +1,5 @@ - + @@ -9,10 +9,8 @@ Description - Deprecated. - - - See also pdf_set_value, + This function is deprecated, use pdf_set_value + instead. diff --git a/reference/pdf/functions/pdf-set-parameter.xml b/reference/pdf/functions/pdf-set-parameter.xml index d79d48a715..a3edaec287 100644 --- a/reference/pdf/functions/pdf-set-parameter.xml +++ b/reference/pdf/functions/pdf-set-parameter.xml @@ -1,5 +1,5 @@ - + @@ -9,13 +9,13 @@ Description - voidpdf_set_parameter - intpdf_object + boolpdf_set_parameter + resourcepdfdoc stringkey stringvalue - Set some PDFlib parameter with string type. + Sets some PDFlib parameters with string type. &return.success; diff --git a/reference/pdf/functions/pdf-set-text-matrix.xml b/reference/pdf/functions/pdf-set-text-matrix.xml index 3ac66a5fdc..70453b380a 100644 --- a/reference/pdf/functions/pdf-set-text-matrix.xml +++ b/reference/pdf/functions/pdf-set-text-matrix.xml @@ -1,5 +1,5 @@ - + @@ -9,7 +9,8 @@ Description - See pdf_set_paramter. + This function is deprecated, use pdf_set_paramter + instead. diff --git a/reference/pdf/functions/pdf-set-text-pos.xml b/reference/pdf/functions/pdf-set-text-pos.xml index fc39ed8637..f3d86dc8ae 100644 --- a/reference/pdf/functions/pdf-set-text-pos.xml +++ b/reference/pdf/functions/pdf-set-text-pos.xml @@ -1,5 +1,5 @@ - + @@ -9,13 +9,14 @@ Description - voidpdf_set_text_pos - intpdf_object + boolpdf_set_text_pos + resourcepdfdoc floatx floaty - Set the text output position. + Set the text output position specified by x and + y. &return.success; diff --git a/reference/pdf/functions/pdf-set-text-rendering.xml b/reference/pdf/functions/pdf-set-text-rendering.xml index f84a492387..7c17b27c6d 100644 --- a/reference/pdf/functions/pdf-set-text-rendering.xml +++ b/reference/pdf/functions/pdf-set-text-rendering.xml @@ -1,5 +1,5 @@ - + @@ -9,10 +9,8 @@ Description - Deprecated. - - - See pdf_set_value, + This function is deprecated, use pdf_set_value + instead. diff --git a/reference/pdf/functions/pdf-set-text-rise.xml b/reference/pdf/functions/pdf-set-text-rise.xml index a275e9bf0c..4bd744b960 100644 --- a/reference/pdf/functions/pdf-set-text-rise.xml +++ b/reference/pdf/functions/pdf-set-text-rise.xml @@ -1,5 +1,5 @@ - + @@ -9,10 +9,8 @@ Description - Deprecated. - - - See pdf_set_value, + This function is deprecated, use pdf_set_value + instead. diff --git a/reference/pdf/functions/pdf-set-value.xml b/reference/pdf/functions/pdf-set-value.xml index 8c89e7d887..53636eaae6 100644 --- a/reference/pdf/functions/pdf-set-value.xml +++ b/reference/pdf/functions/pdf-set-value.xml @@ -1,5 +1,5 @@ - + @@ -9,13 +9,13 @@ Description - voidpdf_set_value - intpdf_object + boolpdf_set_value + resourcepdfdoc stringkey floatvalue - Set the value of some PDFlib parameter with float type. + Set the value of some PDFlib parameter with float type. &return.success; diff --git a/reference/pdf/functions/pdf-set-word-spacing.xml b/reference/pdf/functions/pdf-set-word-spacing.xml index 5c3010ac82..b546647707 100644 --- a/reference/pdf/functions/pdf-set-word-spacing.xml +++ b/reference/pdf/functions/pdf-set-word-spacing.xml @@ -1,18 +1,16 @@ - + pdf_set_word_spacing - Depriciated: Sets spacing between words + Deprecated: Sets spacing between words Description - Deprecated. - - - See pdf_set_value, + This function is deprecated, use pdf_set_value + instead. diff --git a/reference/pdf/functions/pdf-setcolor.xml b/reference/pdf/functions/pdf-setcolor.xml index ce0357cee6..6662c63095 100644 --- a/reference/pdf/functions/pdf-setcolor.xml +++ b/reference/pdf/functions/pdf-setcolor.xml @@ -1,5 +1,5 @@ - + @@ -9,8 +9,8 @@ Description - voidpdf_setcolor - intpdf_object + boolpdf_setcolor + resourcepdfdoc stringtype stringcolorspace floatc1 @@ -19,10 +19,11 @@ floatc4 - Set the current color space and color. The parameter - type can be "fill", "stroke", or "both" to - specify that the color is set for filling, stroking or both filling and - stroking. The parameter colorspace can be + Set the current color space and color. &return.success; + The parameter type can be fill, + stroke or both to specify that the + color is set for filling, stroking or both filling and stroking. + The parameter colorspace can be gray, rgb, cmyk, spot or pattern. The parameters c1, diff --git a/reference/pdf/functions/pdf-setdash.xml b/reference/pdf/functions/pdf-setdash.xml index 339c8008af..d465a899bd 100644 --- a/reference/pdf/functions/pdf-setdash.xml +++ b/reference/pdf/functions/pdf-setdash.xml @@ -1,5 +1,5 @@ - + @@ -9,14 +9,14 @@ Description - voidpdf_setdash - intpdf_object + boolpdf_setdash + resourcepdfdoc floatb floatw Set the current dash pattern to b black - and w white units. + and w white units. &return.success; diff --git a/reference/pdf/functions/pdf-setflat.xml b/reference/pdf/functions/pdf-setflat.xml index 9021f94063..74ff3db590 100644 --- a/reference/pdf/functions/pdf-setflat.xml +++ b/reference/pdf/functions/pdf-setflat.xml @@ -1,5 +1,5 @@ - + @@ -9,12 +9,12 @@ Description - voidpdf_setflat - intpdf_object + boolpdf_setflat + resourcepdfdoc floatflatness - Set the flatness to a value between 0 and 100 inclusive. + Sets the flatness to a value between 0 and 100 inclusive. &return.success; diff --git a/reference/pdf/functions/pdf-setfont.xml b/reference/pdf/functions/pdf-setfont.xml index b7ab38bcdf..738a6d9201 100644 --- a/reference/pdf/functions/pdf-setfont.xml +++ b/reference/pdf/functions/pdf-setfont.xml @@ -1,5 +1,5 @@ - + @@ -9,15 +9,15 @@ Description - voidpdf_setfont - intpdf_object + boolpdf_setfont + resourcepdfdoc intfont floatsize - Set the current font in the given size, using a - font handle returned by - pdf_findfont + Set the current font in the given size, using a + font handle returned by pdf_findfont. + &return.success; See also diff --git a/reference/pdf/functions/pdf-setgray-fill.xml b/reference/pdf/functions/pdf-setgray-fill.xml index 857a93884a..1fa494bc25 100644 --- a/reference/pdf/functions/pdf-setgray-fill.xml +++ b/reference/pdf/functions/pdf-setgray-fill.xml @@ -1,5 +1,5 @@ - + @@ -9,12 +9,13 @@ Description - voidpdf_setgray_fill - intpdf_object + boolpdf_setgray_fill + resourcepdfdoc floatgray Set the current fill color to a gray value between 0 and 1 inclusive. + &return.success; diff --git a/reference/pdf/functions/pdf-setgray-stroke.xml b/reference/pdf/functions/pdf-setgray-stroke.xml index 3a686306ea..8112fd1156 100644 --- a/reference/pdf/functions/pdf-setgray-stroke.xml +++ b/reference/pdf/functions/pdf-setgray-stroke.xml @@ -1,5 +1,5 @@ - + @@ -9,12 +9,13 @@ Description - voidpdf_setgray_stroke - intpdf_object + boolpdf_setgray_stroke + resourcepdfdoc floatgray - Set the current stroke color to a gray value between 0 and 1 inclusive + Set the current stroke color to a gray value + between 0 and 1 inclusive. &return.success; diff --git a/reference/pdf/functions/pdf-setgray.xml b/reference/pdf/functions/pdf-setgray.xml index c78d02ec81..a898d2ddb0 100644 --- a/reference/pdf/functions/pdf-setgray.xml +++ b/reference/pdf/functions/pdf-setgray.xml @@ -1,5 +1,5 @@ - + @@ -9,12 +9,12 @@ Description - voidpdf_setgray - intpdf_object + boolpdf_setgray + resourcepdfdoc floatgray - Set the current fill and stroke color. + Set the current fill and stroke color. &return.success; diff --git a/reference/pdf/functions/pdf-setlinecap.xml b/reference/pdf/functions/pdf-setlinecap.xml index 68e45e5791..5115b35d87 100644 --- a/reference/pdf/functions/pdf-setlinecap.xml +++ b/reference/pdf/functions/pdf-setlinecap.xml @@ -1,5 +1,5 @@ - + @@ -10,7 +10,7 @@ Description voidpdf_setlinecap - intpdf_object + resourcepdfdoc intlinecap diff --git a/reference/pdf/functions/pdf-setlinejoin.xml b/reference/pdf/functions/pdf-setlinejoin.xml index e1d1b332b2..2faef110d8 100644 --- a/reference/pdf/functions/pdf-setlinejoin.xml +++ b/reference/pdf/functions/pdf-setlinejoin.xml @@ -1,5 +1,5 @@ - + @@ -9,12 +9,13 @@ Description - voidpdf_setlinejoin - intpdf_object + boolpdf_setlinejoin + resourcepdfdoc intvalue - Set the line join parameter to a value between 0 and 2 inclusive. + Sets the line join parameter to a value between + 0 and 2 inclusive. &return.success; diff --git a/reference/pdf/functions/pdf-setlinewidth.xml b/reference/pdf/functions/pdf-setlinewidth.xml index c7c1fcf48b..855400588d 100644 --- a/reference/pdf/functions/pdf-setlinewidth.xml +++ b/reference/pdf/functions/pdf-setlinewidth.xml @@ -1,5 +1,5 @@ - + @@ -10,11 +10,11 @@ Description voidpdf_setlinewidth - intpdf_object + resourcepdfdoc floatwidth - Set the current linewidth to width. + Sets the current linewidth to width. &return.success; diff --git a/reference/pdf/functions/pdf-setmatrix.xml b/reference/pdf/functions/pdf-setmatrix.xml index b1b1d8314d..9198aaec0b 100644 --- a/reference/pdf/functions/pdf-setmatrix.xml +++ b/reference/pdf/functions/pdf-setmatrix.xml @@ -1,5 +1,5 @@ - + @@ -9,8 +9,8 @@ Description - voidpdf_setmatrix - intpdf_object + boolpdf_setmatrix + resourcepdfdoc floata floatb floatc @@ -19,7 +19,7 @@ floatf - Explicitly set the current transformation matrix. + Explicitly set the current transformation matrix. &return.success; diff --git a/reference/pdf/functions/pdf-setmiterlimit.xml b/reference/pdf/functions/pdf-setmiterlimit.xml index 44d914f4e2..c462527759 100644 --- a/reference/pdf/functions/pdf-setmiterlimit.xml +++ b/reference/pdf/functions/pdf-setmiterlimit.xml @@ -1,5 +1,5 @@ - + @@ -9,12 +9,12 @@ Description - voidpdf_setmiterlimit - intpdf_object + boolpdf_setmiterlimit + resourcepdfdoc floatmiter - Set the miter limit to a value greater than or equal to 1. + Set the miter limit to a value greater than or equal to 1. &return.success; diff --git a/reference/pdf/functions/pdf-setpolydash.xml b/reference/pdf/functions/pdf-setpolydash.xml index 20631bd20f..d18abce2f7 100644 --- a/reference/pdf/functions/pdf-setpolydash.xml +++ b/reference/pdf/functions/pdf-setpolydash.xml @@ -1,5 +1,5 @@ - + @@ -9,12 +9,13 @@ Description - voidpdf_setpolydash - intpdf_object - float *dasharray + boolpdf_setpolydash + resourcepdfdoc + floatdasharray - Set a more complicated dash pattern defined by an array. + Sets a more complicated dash pattern defined by the dasharray + parameter. &return.success; diff --git a/reference/pdf/functions/pdf-setrgbcolor-fill.xml b/reference/pdf/functions/pdf-setrgbcolor-fill.xml index 833b5a12e8..d8e052b40e 100644 --- a/reference/pdf/functions/pdf-setrgbcolor-fill.xml +++ b/reference/pdf/functions/pdf-setrgbcolor-fill.xml @@ -1,5 +1,5 @@ - + @@ -9,14 +9,14 @@ Description - voidpdf_setrgbcolor_fill - intpdf_object + boolpdf_setrgbcolor_fill + resourcepdfdoc floatred_value floatgreen_value floatblue_value - Set the current fill color to the supplied RGB values. + Set the current fill color to the supplied RGB values. &return.success; diff --git a/reference/pdf/functions/pdf-setrgbcolor-stroke.xml b/reference/pdf/functions/pdf-setrgbcolor-stroke.xml index c93951cc72..aab1ae37fd 100644 --- a/reference/pdf/functions/pdf-setrgbcolor-stroke.xml +++ b/reference/pdf/functions/pdf-setrgbcolor-stroke.xml @@ -1,5 +1,5 @@ - + @@ -9,14 +9,14 @@ Description - voidpdf_setrgbcolor_stroke - intpdf_object + boolpdf_setrgbcolor_stroke + resourcepdfdoc floatred_value floatgreen_value floatblue_value - Set the current stroke color to the supplied RGB values. + Set the current stroke color to the supplied RGB values. &return.success; diff --git a/reference/pdf/functions/pdf-setrgbcolor.xml b/reference/pdf/functions/pdf-setrgbcolor.xml index 28151dee2d..d87e44cd0f 100644 --- a/reference/pdf/functions/pdf-setrgbcolor.xml +++ b/reference/pdf/functions/pdf-setrgbcolor.xml @@ -1,5 +1,5 @@ - + @@ -9,14 +9,15 @@ Description - voidpdf_setrgbcolor - intpdf_object + boolpdf_setrgbcolor + resourcepdfdoc floatred_value floatgreen_value floatblue_value - Set the current fill and stroke color to the supplied RGB values. + Set the current fill and stroke color to the supplied RGB values. + &return.success; diff --git a/reference/pdf/functions/pdf-show-boxed.xml b/reference/pdf/functions/pdf-show-boxed.xml index 4d3ac2b902..bde675b89b 100644 --- a/reference/pdf/functions/pdf-show-boxed.xml +++ b/reference/pdf/functions/pdf-show-boxed.xml @@ -1,5 +1,5 @@ - + @@ -10,21 +10,24 @@ Description intpdf_show_boxed - intpdf_object + resourcepdfdoc stringtext floatleft floattop floatwidth floatheight - stringhmode + stringmode stringfeature - Format text in the current font and size into the supplied text box - according to the requested formatting mode, which must be one of - "left", "right", "center", "justify", or "fulljustify". - If width and height are 0, only a single line is placed at the point - (left, top) in the requested mode. + Format text in the current font and size into the + supplied text box according to the requested formatting + mode, which must be one of left, + right, center, justify + or fulljustify. + If width and height are 0, + only a single line is placed at the point (left, + top) in the requested mode. Returns the number of characters that did not fit in the specified diff --git a/reference/pdf/functions/pdf-show-xy.xml b/reference/pdf/functions/pdf-show-xy.xml index e232d064ae..6789ddc1e6 100644 --- a/reference/pdf/functions/pdf-show-xy.xml +++ b/reference/pdf/functions/pdf-show-xy.xml @@ -1,5 +1,5 @@ - + @@ -9,14 +9,15 @@ Description - voidpdf_show_xy - intpdf_object + boolpdf_show_xy + resourcepdfdoc stringtext floatx floaty - Print text in the current font at (x, y). + Print text in the current font at ( + x, y). &return.success; diff --git a/reference/pdf/functions/pdf-show.xml b/reference/pdf/functions/pdf-show.xml index f77a1607d7..ab9efda171 100644 --- a/reference/pdf/functions/pdf-show.xml +++ b/reference/pdf/functions/pdf-show.xml @@ -1,5 +1,5 @@ - + @@ -9,12 +9,13 @@ Description - voidpdf_show - intpdf_object + boolpdf_show + resourcepdfdoc stringtext - Print text in the current font and size at the current position. + Print text in the current font and size at + the current position. &return.success; diff --git a/reference/pdf/functions/pdf-skew.xml b/reference/pdf/functions/pdf-skew.xml index ddbe223db1..1154ae855f 100644 --- a/reference/pdf/functions/pdf-skew.xml +++ b/reference/pdf/functions/pdf-skew.xml @@ -1,5 +1,5 @@ - + @@ -9,14 +9,14 @@ Description - voidpdf_skew - intpdf_object + boolpdf_skew + resourcepdfdoc floatalpha floatbeta - Skew the coordinate system in x and y direction by alpha and - beta degrees. + Skew the coordinate system in x and y direction by alpha + and beta degrees. &return.success; diff --git a/reference/pdf/functions/pdf-stringwidth.xml b/reference/pdf/functions/pdf-stringwidth.xml index 72e7270b52..a76632aac0 100644 --- a/reference/pdf/functions/pdf-stringwidth.xml +++ b/reference/pdf/functions/pdf-stringwidth.xml @@ -1,5 +1,5 @@ - + @@ -10,7 +10,7 @@ Description floatpdf_stringwidth - intpdf_object + resourcepdfdoc stringtext intfont floatsize @@ -27,7 +27,7 @@ Both the font and size - parameters must used together. + parameters must be used together. diff --git a/reference/pdf/functions/pdf-stroke.xml b/reference/pdf/functions/pdf-stroke.xml index 0cb3a8f5d5..9640d0834c 100644 --- a/reference/pdf/functions/pdf-stroke.xml +++ b/reference/pdf/functions/pdf-stroke.xml @@ -1,5 +1,5 @@ - + @@ -9,11 +9,12 @@ Description - voidpdf_stroke - intpdf_object + boolpdf_stroke + resourcepdfdoc - Stroke the path with the current color and line width, and clear it. + Stroke the path with the current color and line width, and clear it. + &return.success; diff --git a/reference/pdf/functions/pdf-translate.xml b/reference/pdf/functions/pdf-translate.xml index cbfdb82cf8..df337b4d10 100644 --- a/reference/pdf/functions/pdf-translate.xml +++ b/reference/pdf/functions/pdf-translate.xml @@ -1,5 +1,5 @@ - + @@ -9,8 +9,8 @@ Description - voidpdf_translate - intpdf_object + boolpdf_translate + resourcepdfdoc floattx floatty diff --git a/reference/pdf/reference.xml b/reference/pdf/reference.xml index e274e17e89..882810a516 100644 --- a/reference/pdf/reference.xml +++ b/reference/pdf/reference.xml @@ -1,5 +1,5 @@ - + PDF functions PDF @@ -34,7 +34,7 @@ Please note that most of the PDF functions require a - pdf object as its first parameter. Please + pdfdoc as its first parameter. Please see the examples below for more information.