diff --git a/reference/ps/book.xml b/reference/ps/book.xml index ae6d2cba9413..980cf08fbafe 100644 --- a/reference/ps/book.xml +++ b/reference/ps/book.xml @@ -1,37 +1,35 @@ - - + PostScript document creation PS - + &reftitle.intro; - + This module allows to create PostScript documents. It has many similarities with the pdf extension. Actually the API is almost identical and one can in many cases just replace the prefix of each function from pdf_ to ps_. This also works for functions which has no meaning in the PostScript document (like adding hyperlinks) but will have an effect if the document is converted to PDF. - - Documents created by this extension are sometimes even superior + + Documents created by this extension are sometimes even superior to documents created with the pdf extension, because pslib's text rendering functions can handle kerning, hyphenation and ligatures which results in much better output of boxed text. - + - + &reference.ps.setup; &reference.ps.constants; &reference.ps.reference; - - diff --git a/reference/ps/configure.xml b/reference/ps/configure.xml index 63b384c73267..b2074fe2762f 100644 --- a/reference/ps/configure.xml +++ b/reference/ps/configure.xml @@ -1,14 +1,12 @@ -
+
&reftitle.install; - + &pecl.info; &url.pecl.package;ps. - +
- - - + ps_add_bookmark Add bookmark to current page @@ -16,79 +16,74 @@ intparent0 intopen0 - + Adds a bookmark for the current page. Bookmarks usually appear in PDF-Viewers left of the page in a hierarchical tree. Clicking on a bookmark will jump to the given page. - + &ps.note.visible; &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - text - - - The text used for displaying the bookmark. - - - - - parent - - - A bookmark previously created by this function which - is used as the parent of the new bookmark. - - - - - open - - - If open is unequal to zero the bookmark will - be shown open by the pdf viewer. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + text + + + The text used for displaying the bookmark. + + + + + parent + + + A bookmark previously created by this function which + is used as the parent of the new bookmark. + + + + + open + + + If open is unequal to zero the bookmark will + be shown open by the pdf viewer. + + + + &reftitle.returnvalues; - + The returned value is a reference for the bookmark. It is only used if the bookmark shall be used as a parent. The value is greater zero if the function succeeds. In case of an error zero will be returned. - + &reftitle.seealso; - - - ps_add_launchlink - ps_add_pdflink - ps_add_weblink - - + + ps_add_launchlink + ps_add_pdflink + ps_add_weblink + - - diff --git a/reference/ps/functions/ps-add-launchlink.xml b/reference/ps/functions/ps-add-launchlink.xml index ff860b67f92a..967f9b0ec95d 100644 --- a/reference/ps/functions/ps-add-launchlink.xml +++ b/reference/ps/functions/ps-add-launchlink.xml @@ -1,7 +1,7 @@ - + ps_add_launchlink Adds link which launches file @@ -18,92 +18,87 @@ floatury stringfilename - + Places a hyperlink at the given position pointing to a file program which is being started when clicked on. The hyperlink's source position is a rectangle with its lower left corner at (llx, lly) and its upper right corner at (urx, ury). The rectangle has by default a thin blue border. - + &ps.note.visible; &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - llx - - - The x-coordinate of the lower left corner. - - - - - lly - - - The y-coordinate of the lower left corner. - - - - - urx - - - The x-coordinate of the upper right corner. - - - - - ury - - - The y-coordinate of the upper right corner. - - - - - filename - - - The path of the program to be started, when the link is clicked on. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + llx + + + The x-coordinate of the lower left corner. + + + + + lly + + + The y-coordinate of the lower left corner. + + + + + urx + + + The x-coordinate of the upper right corner. + + + + + ury + + + The y-coordinate of the upper right corner. + + + + + filename + + + The path of the program to be started, when the link is clicked on. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_add_locallink - ps_add_pdflink - ps_add_weblink - - + + ps_add_locallink + ps_add_pdflink + ps_add_weblink + - - diff --git a/reference/ps/functions/ps-add-locallink.xml b/reference/ps/functions/ps-add-locallink.xml index 99ca817bd315..9eeb6a15312a 100644 --- a/reference/ps/functions/ps-add-locallink.xml +++ b/reference/ps/functions/ps-add-locallink.xml @@ -1,7 +1,7 @@ - + ps_add_locallink Adds link to a page in the same document @@ -19,107 +19,102 @@ intpage stringdest - + Places a hyperlink at the given position pointing to a page in the same document. Clicking on the link will jump to the given page. The first page in a document has number 1. - - + + The hyperlink's source position is a rectangle with its lower left corner at (llx, lly) and its upper right corner at (urx, ury). The rectangle has by default a thin blue border. - + &ps.note.visible; &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - llx - - - The x-coordinate of the lower left corner. - - - - - lly - - - The y-coordinate of the lower left corner. - - - - - urx - - - The x-coordinate of the upper right corner. - - - - - ury - - - The y-coordinate of the upper right corner. - - - - - page - - - The number of the page displayed when clicking on the link. - - - - - dest - - - The parameter dest determines how the document - is being viewed. It can be fitpage, - fitwidth, fitheight, or - fitbbox. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + llx + + + The x-coordinate of the lower left corner. + + + + + lly + + + The y-coordinate of the lower left corner. + + + + + urx + + + The x-coordinate of the upper right corner. + + + + + ury + + + The y-coordinate of the upper right corner. + + + + + page + + + The number of the page displayed when clicking on the link. + + + + + dest + + + The parameter dest determines how the document + is being viewed. It can be fitpage, + fitwidth, fitheight, or + fitbbox. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_add_launchlink - ps_add_pdflink - ps_add_weblink - - + + ps_add_launchlink + ps_add_pdflink + ps_add_weblink + - - diff --git a/reference/ps/functions/ps-add-note.xml b/reference/ps/functions/ps-add-note.xml index 36d345428afd..d9ecbd4e17c3 100644 --- a/reference/ps/functions/ps-add-note.xml +++ b/reference/ps/functions/ps-add-note.xml @@ -1,7 +1,7 @@ - + ps_add_note Adds note to current page @@ -21,122 +21,117 @@ stringicon intopen - + Adds a note at a certain position on the page. Notes are like little rectangular sheets with text on it, which can be placed anywhere on a page. They are shown either folded or unfolded. If folded, the specified icon is used as a placeholder. - + &ps.note.visible; &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - llx - - - The x-coordinate of the lower left corner. - - - - - lly - - - The y-coordinate of the lower left corner. - - - - - urx - - - The x-coordinate of the upper right corner. - - - - - ury - - - The y-coordinate of the upper right corner. - - - - - contents - - - The text of the note. - - - - - title - - - The title of the note as displayed in the header of the note. - - - - - icon - - - The icon shown if the note is folded. This parameter can be set - to comment, insert, - note, paragraph, - newparagraph, key, or - help. - - - - - open - - - If open is unequal to zero the note will - be shown unfolded after opening the document with a pdf viewer. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + llx + + + The x-coordinate of the lower left corner. + + + + + lly + + + The y-coordinate of the lower left corner. + + + + + urx + + + The x-coordinate of the upper right corner. + + + + + ury + + + The y-coordinate of the upper right corner. + + + + + contents + + + The text of the note. + + + + + title + + + The title of the note as displayed in the header of the note. + + + + + icon + + + The icon shown if the note is folded. This parameter can be set + to comment, insert, + note, paragraph, + newparagraph, key, or + help. + + + + + open + + + If open is unequal to zero the note will + be shown unfolded after opening the document with a pdf viewer. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_add_pdflink - ps_add_launchlink - ps_add_locallink - ps_add_weblink - - + + ps_add_pdflink + ps_add_launchlink + ps_add_locallink + ps_add_weblink + - - diff --git a/reference/ps/functions/ps-add-pdflink.xml b/reference/ps/functions/ps-add-pdflink.xml index c5243bf37a5c..61bc5a196283 100644 --- a/reference/ps/functions/ps-add-pdflink.xml +++ b/reference/ps/functions/ps-add-pdflink.xml @@ -1,7 +1,7 @@ - + ps_add_pdflink Adds link to a page in a second pdf document @@ -20,116 +20,111 @@ intpage stringdest - + Places a hyperlink at the given position pointing to a second pdf document. Clicking on the link will branch to the document at the given page. The first page in a document has number 1. - - + + The hyperlink's source position is a rectangle with its lower left corner at (llx, lly) and its upper right corner at (urx, ury). The rectangle has by default a thin blue border. - + &ps.note.visible; &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - llx - - - The x-coordinate of the lower left corner. - - - - - lly - - - The y-coordinate of the lower left corner. - - - - - urx - - - The x-coordinate of the upper right corner. - - - - - ury - - - The y-coordinate of the upper right corner. - - - - - filename - - - The name of the pdf document to be opened when clicking on - this link. - - - - - page - - - The page number of the destination pdf document - - - - - dest - - - The parameter dest determines how the document - is being viewed. It can be fitpage, - fitwidth, fitheight, or - fitbbox. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + llx + + + The x-coordinate of the lower left corner. + + + + + lly + + + The y-coordinate of the lower left corner. + + + + + urx + + + The x-coordinate of the upper right corner. + + + + + ury + + + The y-coordinate of the upper right corner. + + + + + filename + + + The name of the pdf document to be opened when clicking on + this link. + + + + + page + + + The page number of the destination pdf document + + + + + dest + + + The parameter dest determines how the document + is being viewed. It can be fitpage, + fitwidth, fitheight, or + fitbbox. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_add_launchlink - ps_add_locallink - ps_add_weblink - - + + ps_add_launchlink + ps_add_locallink + ps_add_weblink + - - diff --git a/reference/ps/functions/ps-add-weblink.xml b/reference/ps/functions/ps-add-weblink.xml index 16078990f7ba..1a45bf590279 100644 --- a/reference/ps/functions/ps-add-weblink.xml +++ b/reference/ps/functions/ps-add-weblink.xml @@ -1,7 +1,7 @@ - + ps_add_weblink Adds link to a web location @@ -18,94 +18,89 @@ floatury stringurl - - Places a hyperlink at the given position pointing to a web page. The + + Places a hyperlink at the given position pointing to a web page. The hyperlink's source position is a rectangle with its lower left corner at (llx, lly) and its upper right corner at (urx, ury). The rectangle has by default a thin blue border. - + &ps.note.visible; &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - llx - - - The x-coordinate of the lower left corner. - - - - - lly - - - The y-coordinate of the lower left corner. - - - - - urx - - - The x-coordinate of the upper right corner. - - - - - ury - - - The y-coordinate of the upper right corner. - - - - - url - - - The url of the hyperlink to be opened when clicking on - this link, e.g. http://www.php.net. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + llx + + + The x-coordinate of the lower left corner. + + + + + lly + + + The y-coordinate of the lower left corner. + + + + + urx + + + The x-coordinate of the upper right corner. + + + + + ury + + + The y-coordinate of the upper right corner. + + + + + url + + + The url of the hyperlink to be opened when clicking on + this link, e.g. http://www.php.net. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_add_launchlink - ps_add_locallink - ps_add_pdflink - - + + ps_add_launchlink + ps_add_locallink + ps_add_pdflink + - - diff --git a/reference/ps/functions/ps-arc.xml b/reference/ps/functions/ps-arc.xml index 0d0bc013af1e..05a6c44bad0a 100644 --- a/reference/ps/functions/ps-arc.xml +++ b/reference/ps/functions/ps-arc.xml @@ -1,7 +1,7 @@ - + ps_arc Draws an arc counterclockwise @@ -18,7 +18,7 @@ floatalpha floatbeta - + Draws a portion of a circle with at middle point at (x, y). The arc starts at an angle of alpha and ends at an angle of @@ -26,83 +26,78 @@ ps_arcn to draw clockwise). The subpath added to the current path starts on the arc at angle alpha and ends on the arc at angle beta. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - x - - - The x-coordinate of the circle's middle point. - - - - - y - - - The y-coordinate of the circle's middle point. - - - - - radius - - - The radius of the circle - - - - - alpha - - - The start angle given in degrees. - - - - - beta - - - The end angle given in degrees. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + x + + + The x-coordinate of the circle's middle point. + + + + + y + + + The y-coordinate of the circle's middle point. + + + + + radius + + + The radius of the circle + + + + + alpha + + + The start angle given in degrees. + + + + + beta + + + The end angle given in degrees. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_arcn - - + + ps_arcn + - - diff --git a/reference/ps/functions/ps-arcn.xml b/reference/ps/functions/ps-arcn.xml index 0a6e8346713f..3d486b3b0f60 100644 --- a/reference/ps/functions/ps-arcn.xml +++ b/reference/ps/functions/ps-arcn.xml @@ -1,7 +1,7 @@ - + ps_arcn Draws an arc clockwise @@ -18,7 +18,7 @@ floatalpha floatbeta - + Draws a portion of a circle with at middle point at (x, y). The arc starts at an angle of alpha and ends at an angle of @@ -26,83 +26,78 @@ ps_arc to draw counterclockwise). The subpath added to the current path starts on the arc at angle beta and ends on the arc at angle alpha. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - x - - - The x-coordinate of the circle's middle point. - - - - - y - - - The y-coordinate of the circle's middle point. - - - - - radius - - - The radius of the circle - - - - - alpha - - - The starting angle given in degrees. - - - - - beta - - - The end angle given in degrees. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + x + + + The x-coordinate of the circle's middle point. + + + + + y + + + The y-coordinate of the circle's middle point. + + + + + radius + + + The radius of the circle + + + + + alpha + + + The starting angle given in degrees. + + + + + beta + + + The end angle given in degrees. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_arc - - + + ps_arc + - - diff --git a/reference/ps/functions/ps-begin-page.xml b/reference/ps/functions/ps-begin-page.xml index 084c18edf18d..5cd83f5ba83b 100644 --- a/reference/ps/functions/ps-begin-page.xml +++ b/reference/ps/functions/ps-begin-page.xml @@ -1,7 +1,7 @@ - + ps_begin_page Start a new page @@ -15,7 +15,7 @@ floatwidth floatheight - + Starts a new page. Although the parameters width and height imply a different page size for each page, this is not possible in PostScript. The first call of @@ -25,8 +25,8 @@ document into PDF. This function places pdfmarks into the document which can set the size for each page indiviually. The resulting PDF document will have different page sizes. - - + + Though PostScript does not know different page sizes, pslib places a bounding box for each page into the document. This size is evaluated by some PostScript viewers and will have precedence over the BoundingBox @@ -34,12 +34,12 @@ you set a BoundingBox whose lower left corner is not (0, 0), because the bounding box of the page will always have a lower left corner (0, 0) and overwrites the global setting. - - + + Each page is encapsulated into save/restore. This means, that most of the settings made on one page will not be retained on the next page. - - + + If there is up to the first call of ps_begin_page no call of ps_findfont, then the header of the PostScript document will be output and the bounding box will be set to the size of @@ -51,69 +51,64 @@ BoundingBox and possibly Orientation before any ps_findfont or ps_begin_page calls. - + - + Up to version 0.2.6 of pslib, this function will always overwrite the BoundingBox and Orientation, if it has been set before with ps_set_info and ps_findfont has not been called before. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - width - - - The width of the page in pixel, e.g. 596 for A4 format. - - - - - height - - - The height of the page in pixel, e.g. 842 for A4 format. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + width + + + The width of the page in pixel, e.g. 596 for A4 format. + + + + + height + + + The height of the page in pixel, e.g. 842 for A4 format. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_end_page - ps_findfont - ps_set_info - - + + ps_end_page + ps_findfont + ps_set_info + - - diff --git a/reference/ps/functions/ps-begin-pattern.xml b/reference/ps/functions/ps-begin-pattern.xml index 15d85e9f9d78..b38814e16741 100644 --- a/reference/ps/functions/ps-begin-pattern.xml +++ b/reference/ps/functions/ps-begin-pattern.xml @@ -1,7 +1,7 @@ - + ps_begin_pattern Start a new pattern @@ -18,86 +18,83 @@ floatystep intpainttype - + Starts a new pattern. A pattern is like a page containing e.g. a drawing which can be used for filling areas. It is used like a color by calling ps_setcolor and setting the color space to pattern. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - width - - - The width of the pattern in pixel. - - - - - height - - - The height of the pattern in pixel. - - - - - x-step - - - The distance in pixel of placements of the pattern in - horizontal direction. - - - - - y-step - - - The distance in pixel of placements of the pattern in - vertical direction. - - - - - painttype - - - Must be 1 or 2. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + width + + + The width of the pattern in pixel. + + + + + height + + + The height of the pattern in pixel. + + + + + x-step + + + The distance in pixel of placements of the pattern in + horizontal direction. + + + + + y-step + + + The distance in pixel of placements of the pattern in + vertical direction. + + + + + painttype + + + Must be 1 or 2. + + + + &reftitle.returnvalues; - + The identifier of the pattern &return.falseforfailure;. - + &reftitle.examples; - - - Creating and using a pattern - + + Creating and using a pattern + ]]> - - - + + &reftitle.seealso; - - - ps_end_pattern - ps_setcolor - ps_shading_pattern - - + + ps_end_pattern + ps_setcolor + ps_shading_pattern + - - diff --git a/reference/ps/functions/ps-begin-template.xml b/reference/ps/functions/ps-begin-template.xml index b131a6767321..7edf77c25843 100644 --- a/reference/ps/functions/ps-begin-template.xml +++ b/reference/ps/functions/ps-begin-template.xml @@ -1,7 +1,7 @@ - + ps_begin_template Start a new template @@ -15,62 +15,59 @@ floatwidth floatheight - + Starts a new template. A template is called a form in the postscript language. It is created similar to a pattern but used like an image. Templates are often used for drawings which are placed several times through out the document, e.g. like a company logo. All drawing functions may be used within a template. The template will not be drawn until it is placed by ps_place_image. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - width - - - The width of the template in pixel. - - - - - height - - - The height of the template in pixel. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + width + + + The width of the template in pixel. + + + + + height + + + The height of the template in pixel. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.examples; - - - Creating and using a template - + + Creating and using a template + ]]> - - - + + &reftitle.seealso; - - - ps_end_template - - + + ps_end_template + - - diff --git a/reference/ps/functions/ps-circle.xml b/reference/ps/functions/ps-circle.xml index 530ba9a240a2..8edfd8b84e08 100644 --- a/reference/ps/functions/ps-circle.xml +++ b/reference/ps/functions/ps-circle.xml @@ -1,7 +1,7 @@ - + ps_circle Draws a circle @@ -16,7 +16,7 @@ floaty floatradius - + Draws a circle with its middle point at (x, y). The circle starts and ends at position (x+radius, @@ -25,68 +25,63 @@ as a subpath. If the last drawing operation does not end in point (x+radius, y) then there will be a gap in the path. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - x - - - The x-coordinate of the circle's middle point. - - - - - y - - - The y-coordinate of the circle's middle point. - - - - - radius - - - The radius of the circle - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + x + + + The x-coordinate of the circle's middle point. + + + + + y + + + The y-coordinate of the circle's middle point. + + + + + radius + + + The radius of the circle + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_arc - ps_arcn - - + + ps_arc + ps_arcn + - - diff --git a/reference/ps/functions/ps-clip.xml b/reference/ps/functions/ps-clip.xml index 5d293e96db11..e5c009a94950 100644 --- a/reference/ps/functions/ps-clip.xml +++ b/reference/ps/functions/ps-clip.xml @@ -1,7 +1,7 @@ - + ps_clip Clips drawing to current path @@ -13,46 +13,41 @@ boolps_clip resourcepsdoc - + Takes the current path and uses it to define the border of a clipping area. Everything drawn outside of that area will not be visible. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_closepath - - + + ps_closepath + - - diff --git a/reference/ps/functions/ps-close-image.xml b/reference/ps/functions/ps-close-image.xml index 608452b68383..34dd31b50685 100644 --- a/reference/ps/functions/ps-close-image.xml +++ b/reference/ps/functions/ps-close-image.xml @@ -1,7 +1,7 @@ - + ps_close_image Closes image and frees memory @@ -14,57 +14,52 @@ resourcepsdoc intimageid - + Closes an image and frees its resources. Once an image is closed it cannot be used anymore. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - imageid - - - Resource identifier of the image as returned by - ps_open_image or - ps_open_image_file. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + imageid + + + Resource identifier of the image as returned by + ps_open_image or + ps_open_image_file. + + + + &reftitle.returnvalues; - + Returns &null; on success&return.falseforfailure;. - + &reftitle.seealso; - - - ps_open_image - ps_open_image_file - - + + ps_open_image + ps_open_image_file + - - diff --git a/reference/ps/functions/ps-close.xml b/reference/ps/functions/ps-close.xml index b9d02100786c..e311563a03a1 100644 --- a/reference/ps/functions/ps-close.xml +++ b/reference/ps/functions/ps-close.xml @@ -1,7 +1,7 @@ - + ps_close Closes a PostScript document @@ -13,55 +13,50 @@ boolps_close resourcepsdoc - + Closes the PostScript document. - - + + This function writes the trailer of the PostScript document. It also writes the bookmark tree. ps_close does not free any resources, which is done by ps_delete. - - + + This function is also called by ps_delete if it has not been called before. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_open_file - ps_delete - - + + ps_open_file + ps_delete + - - diff --git a/reference/ps/functions/ps-closepath-stroke.xml b/reference/ps/functions/ps-closepath-stroke.xml index 19d9c632222e..0ac75a8433ed 100644 --- a/reference/ps/functions/ps-closepath-stroke.xml +++ b/reference/ps/functions/ps-closepath-stroke.xml @@ -1,7 +1,7 @@ - + ps_closepath_stroke Closes and strokes path @@ -13,46 +13,41 @@ boolps_closepath_stroke resourcepsdoc - + Connects the last point with first point of a path and draws the resulting closed line. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_closepath - - + + ps_closepath + - - diff --git a/reference/ps/functions/ps-closepath.xml b/reference/ps/functions/ps-closepath.xml index b3638daa344b..d00fca9f465c 100644 --- a/reference/ps/functions/ps-closepath.xml +++ b/reference/ps/functions/ps-closepath.xml @@ -1,7 +1,7 @@ - + ps_closepath Closes path @@ -13,47 +13,42 @@ boolps_closepath resourcepsdoc - + Connects the last point with the first point of a path. The resulting path can be used for stroking, filling, clipping, etc.. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_clip - ps_closepath_stroke - - + + ps_clip + ps_closepath_stroke + - - diff --git a/reference/ps/functions/ps-continue-text.xml b/reference/ps/functions/ps-continue-text.xml index 2bf1aded0d62..dcc9e4fe929b 100644 --- a/reference/ps/functions/ps-continue-text.xml +++ b/reference/ps/functions/ps-continue-text.xml @@ -1,7 +1,7 @@ - + ps_continue_text Continue text in next line @@ -14,59 +14,54 @@ resourcepsdoc stringtext - + Output a text one line below the last line. The line spacing is taken from the value "leading" which must be set with ps_set_value. The actual position of the text is determined by the values "textx" and "texty" which can be requested with ps_get_value - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - text - - - The text to output. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + text + + + The text to output. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_show - ps_show_xy - ps_show_boxed - - + + ps_show + ps_show_xy + ps_show_boxed + - - diff --git a/reference/ps/functions/ps-curveto.xml b/reference/ps/functions/ps-curveto.xml index 453127f2702e..b2503f67691a 100644 --- a/reference/ps/functions/ps-curveto.xml +++ b/reference/ps/functions/ps-curveto.xml @@ -1,7 +1,7 @@ - + ps_curveto Draws a curve @@ -19,94 +19,89 @@ floatx3 floaty3 - + Add a section of a cubic Bézier curve described by the three given control points to the current path. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - x1 - - - x-coordinate of first control point. - - - - - y1 - - - y-coordinate of first control point. - - - - - x2 - - - x-coordinate of second control point. - - - - - y2 - - - y-coordinate of second control point. - - - - - x3 - - - x-coordinate of third control point. - - - - - y3 - - - y-coordinate of third control point. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + x1 + + + x-coordinate of first control point. + + + + + y1 + + + y-coordinate of first control point. + + + + + x2 + + + x-coordinate of second control point. + + + + + y2 + + + y-coordinate of second control point. + + + + + x3 + + + x-coordinate of third control point. + + + + + y3 + + + y-coordinate of third control point. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_lineto - - + + ps_lineto + - - diff --git a/reference/ps/functions/ps-delete.xml b/reference/ps/functions/ps-delete.xml index 40ec9eefcd74..f5d3aed28c16 100644 --- a/reference/ps/functions/ps-delete.xml +++ b/reference/ps/functions/ps-delete.xml @@ -1,7 +1,7 @@ - + ps_delete Deletes all resources of a PostScript document @@ -13,50 +13,45 @@ boolps_delete resourcepsdoc - + Mainly frees memory used by the document. Also closes a file, if it was not closed before with ps_close. You should in any case close the file with ps_close before, because ps_close not just closes the file but also outputs a trailor containing PostScript comments like the number of pages in the document and adding the bookmark hierarchy. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_close - - + + ps_close + - - diff --git a/reference/ps/functions/ps-end-page.xml b/reference/ps/functions/ps-end-page.xml index 496fc9dc6e4c..69978ad3741e 100644 --- a/reference/ps/functions/ps-end-page.xml +++ b/reference/ps/functions/ps-end-page.xml @@ -1,7 +1,7 @@ - + ps_end_page End a page @@ -13,48 +13,43 @@ boolps_end_page resourcepsdoc - + Ends a page which was started with ps_begin_page. Ending a page will leave the current drawing context, which e.g. requires to reload fonts if they were loading within the page, and to set many other drawing parameters like the line width, or color. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_begin_page - - + + ps_begin_page + - - diff --git a/reference/ps/functions/ps-end-pattern.xml b/reference/ps/functions/ps-end-pattern.xml index 6ee2ab204205..7e665a62b69d 100644 --- a/reference/ps/functions/ps-end-pattern.xml +++ b/reference/ps/functions/ps-end-pattern.xml @@ -1,7 +1,7 @@ - + ps_end_pattern End a pattern @@ -13,47 +13,42 @@ boolps_end_pattern resourcepsdoc - + Ends a pattern which was started with ps_begin_pattern. Once a pattern has been ended, it can be used like a color to fill areas. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_begin_pattern - - + + ps_begin_pattern + - - diff --git a/reference/ps/functions/ps-end-template.xml b/reference/ps/functions/ps-end-template.xml index 72fadedca6b7..2651b1864f15 100644 --- a/reference/ps/functions/ps-end-template.xml +++ b/reference/ps/functions/ps-end-template.xml @@ -1,7 +1,7 @@ - + ps_end_template End a template @@ -13,46 +13,41 @@ boolps_end_template resourcepsdoc - + Ends a template which was started with ps_begin_template. Once a template has been ended, it can be used like an image. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_begin_template - - + + ps_begin_template + - - diff --git a/reference/ps/functions/ps-fill-stroke.xml b/reference/ps/functions/ps-fill-stroke.xml index c81d44da87d8..b272583cd731 100644 --- a/reference/ps/functions/ps-fill-stroke.xml +++ b/reference/ps/functions/ps-fill-stroke.xml @@ -1,7 +1,7 @@ - + ps_fill_stroke Fills and strokes the current path @@ -11,49 +11,44 @@ &reftitle.description; boolps_fill_stroke - resourcepsdoc + resourcepsdoc - + Fills and draws the path constructed with previously called drawing functions like ps_lineto. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_fill - ps_stroke - - + + ps_fill + ps_stroke + - - diff --git a/reference/ps/functions/ps-fill.xml b/reference/ps/functions/ps-fill.xml index b263334d975c..0999c9f86577 100644 --- a/reference/ps/functions/ps-fill.xml +++ b/reference/ps/functions/ps-fill.xml @@ -1,7 +1,7 @@ - + ps_fill Fills the current path @@ -13,47 +13,42 @@ boolps_fill resourcepsdoc - + Fills the path constructed with previously called drawing functions like ps_lineto. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_fill_stroke - ps_stroke - - + + ps_fill_stroke + ps_stroke + - - diff --git a/reference/ps/functions/ps-findfont.xml b/reference/ps/functions/ps-findfont.xml index 288334c5bb07..57d965dcdbc6 100644 --- a/reference/ps/functions/ps-findfont.xml +++ b/reference/ps/functions/ps-findfont.xml @@ -1,7 +1,7 @@ - + ps_findfont Loads a font @@ -16,7 +16,7 @@ stringencoding boolembed&false; - + Loads a font for later use. Before text is output with a loaded font it must be set with ps_setfont. This function needs the adobe font metric file in order to calculate the space used up by the @@ -25,15 +25,15 @@ loaded before the first call of ps_begin_page. Calling ps_findfont between pages will make that font available for all following pages. - - + + The name of the afm file must be fontname.afm. If the font shall be embedded the file fontname.pfb containing the font outline must be present as well. - - + + Calling ps_findfont before the first page requires to output the postscript header which includes the BoundingBox for the whole document. Usually the BoundingBox is set with the first call @@ -43,84 +43,79 @@ is called. In order to prevent this situation, one should call ps_set_parameter to set the BoundingBox before ps_findfont is called. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - fontname - - - The name of the font. - - - - - encoding - - - ps_findfont will try to load the file passed in - the parameter encoding. Encoding files are of - the same syntax as those used by dvips(1). They - contain a font encoding vector (which is currently not used but must be - present) and a list of extra ligatures to extend the list of ligatures - derived from the afm file. - - - encoding can be &null; or the empty string if - the default encoding (TeXBase1) shall be used. - - - If the encoding is set to builtin then there - will be no reencoding and the font specific encoding will be used. This - is very useful with symbol fonts. - - - - - embed - - - If set to a value >0 the font will be embedded into the document. This - requires the font outline (.pfb file) to be present. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + fontname + + + The name of the font. + + + + + encoding + + + ps_findfont will try to load the file passed in + the parameter encoding. Encoding files are of + the same syntax as those used by dvips(1). They + contain a font encoding vector (which is currently not used but must be + present) and a list of extra ligatures to extend the list of ligatures + derived from the afm file. + + + encoding can be &null; or the empty string if + the default encoding (TeXBase1) shall be used. + + + If the encoding is set to builtin then there + will be no reencoding and the font specific encoding will be used. This + is very useful with symbol fonts. + + + + + embed + + + If set to a value >0 the font will be embedded into the document. This + requires the font outline (.pfb file) to be present. + + + + &reftitle.returnvalues; - + Returns the identifier of the font or zero in case of an error. The identifier is a positive number. - + &reftitle.seealso; - - - ps_begin_page - ps_setfont - - + + ps_begin_page + ps_setfont + - - diff --git a/reference/ps/functions/ps-get-buffer.xml b/reference/ps/functions/ps-get-buffer.xml index 1c37fb54b348..0ee77304a2dd 100644 --- a/reference/ps/functions/ps-get-buffer.xml +++ b/reference/ps/functions/ps-get-buffer.xml @@ -1,7 +1,7 @@ - + ps_get_buffer Fetches the full buffer containig the generated PS data @@ -13,43 +13,38 @@ stringps_get_buffer resourcepsdoc - This function is not implemented yet. It will always return an empty + This function is not implemented yet. It will always return an empty string. The idea for a later implementation is to write the contents of the postscript file into an internal buffer if in memory creation is requested, and retrieve the buffer content with this function. Currently, documents created in memory are send to the browser without buffering. - + &warn.undocumented.func; &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + &reftitle.seealso; - - - ps_open_file - - + + ps_open_file + - - diff --git a/reference/ps/functions/ps-get-parameter.xml b/reference/ps/functions/ps-get-parameter.xml index 39cd9947fbaa..a567d484d860 100644 --- a/reference/ps/functions/ps-get-parameter.xml +++ b/reference/ps/functions/ps-get-parameter.xml @@ -1,7 +1,7 @@ - + ps_get_parameter Gets certain parameters @@ -15,178 +15,171 @@ stringname floatmodifier - + Gets several parameters which were directly set by ps_set_parameter or indirectly by one of the other functions. Parameters are by definition string values. This function cannot be used to retrieve resources which were also set by ps_set_parameter. - - + + The parameter name can have the following values. - - - - - fontname - - - The name of the currently active font or the font whose - identifier is passed in parameter modifier. - - - - - fontencoding - - - The encoding of the currently active font. - - - - - dottedversion - - - The version of the underlying pslib library in the format - <major>.<minor>.<subminor> - - - - - scope - - - The current drawing scope. Can be object, document, null, page, - pattern, path, template, prolog, font, glyph. - - - - - ligaturedisolvechar - - - The character which dissolves a ligature. If your are using a font - which contains the ligature `ff' and `|' is the char to dissolve the - ligature, then `f|f' will result in two `f' instead of the ligature `ff'. - - - - - imageencoding - - - The encoding used for encoding images. Can be either - hex or 85. hex encoding - uses two bytes in the postscript file each byte in the image. - 85 stand for Ascii85 encoding. - - - - - linenumbermode - - - Set to paragraph if lines are numbered - within a paragraph or box if they are - numbered within the surrounding box. - - - - - linebreak - - - Only used if text is output with ps_show_boxed. - If set to &true; a carriage return will add a line - break. - - - - - parbreak - - - Only used if text is output with ps_show_boxed. - If set to &true; a carriage return will start - a new paragraph. - - - - - hyphenation - - - Only used if text is output with ps_show_boxed. - If set to &true; the paragraph will be hyphenated - if a hypen dictionary is set and exists. - - - - - hyphendict - - - Filename of the dictionary used for hyphenation pattern. - - - - - + + + + fontname + + + The name of the currently active font or the font whose + identifier is passed in parameter modifier. + + + + + fontencoding + + + The encoding of the currently active font. + + + + + dottedversion + + + The version of the underlying pslib library in the format + <major>.<minor>.<subminor> + + + + + scope + + + The current drawing scope. Can be object, document, null, page, + pattern, path, template, prolog, font, glyph. + + + + + ligaturedisolvechar + + + The character which dissolves a ligature. If your are using a font + which contains the ligature `ff' and `|' is the char to dissolve the + ligature, then `f|f' will result in two `f' instead of the ligature `ff'. + + + + + imageencoding + + + The encoding used for encoding images. Can be either + hex or 85. hex encoding + uses two bytes in the postscript file each byte in the image. + 85 stand for Ascii85 encoding. + + + + + linenumbermode + + + Set to paragraph if lines are numbered + within a paragraph or box if they are + numbered within the surrounding box. + + + + + linebreak + + + Only used if text is output with ps_show_boxed. + If set to &true; a carriage return will add a line + break. + + + + + parbreak + + + Only used if text is output with ps_show_boxed. + If set to &true; a carriage return will start + a new paragraph. + + + + + hyphenation + + + Only used if text is output with ps_show_boxed. + If set to &true; the paragraph will be hyphenated + if a hypen dictionary is set and exists. + + + + + hyphendict + + + Filename of the dictionary used for hyphenation pattern. + + + + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - name - - - Name of the parameter. - - - - - modifier - - - An identifier needed if a parameter of a resource is requested, - e.g. the size of an image. In such a case the resource id is - passed. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + name + + + Name of the parameter. + + + + + modifier + + + An identifier needed if a parameter of a resource is requested, + e.g. the size of an image. In such a case the resource id is + passed. + + + + &reftitle.returnvalues; - + Returns the value of the parameter &return.falseforfailure;. - + &reftitle.seealso; - - - ps_set_parameter - - + + ps_set_parameter + - - diff --git a/reference/ps/functions/ps-get-value.xml b/reference/ps/functions/ps-get-value.xml index 798acdcb17ef..2b5674f1fc15 100644 --- a/reference/ps/functions/ps-get-value.xml +++ b/reference/ps/functions/ps-get-value.xml @@ -1,7 +1,7 @@ - + ps_get_value Gets certain values @@ -15,294 +15,287 @@ stringname floatmodifier - Gets several values which were set by + Gets several values which were set by ps_set_value. Values are by definition float values. - - + + The parameter name can have the following values. - - - - - fontsize - - - The size of the currently active font or the font whose - identifier is passed in parameter modifier. - - - - - font - - - The currently active font itself. - - - - - imagewidth - - - The width of the image whose id is passed in the parameter - modifier. - - - - - imageheight - - - The height of the image whose id is passed in the parameter - modifier. - - - - - capheight - - - The height of a capital M in the currently active font or the font - whose identifier is passed in parameter - modifier. - - - - - ascender - - - The ascender of the currently active font or the font - whose identifier is passed in parameter - modifier. - - - - - descender - - - The descender of the currently active font or the font - whose identifier is passed in parameter - modifier. - - - - - italicangle - - - The italicangle of the currently active font or the font - whose identifier is passed in parameter - modifier. - - - - - underlineposition - - - The underlineposition of the currently active font or the font - whose identifier is passed in parameter - modifier. - - - - - underlinethickness - - - The underlinethickness of the currently active font or the font - whose identifier is passed in parameter - modifier. - - - - - textx - - - The current x-position for text output. - - - - - texty - - - The current y-position for text output. - - - - - textrendering - - - The current mode for text rendering. - - - - - textrise - - - The space by which text is risen above the base line. - - - - - leading - - - The distance between text lines in points. - - - - - wordspacing - - - The space between words as a multiple of the width of a space char. - - - - - charspacing - - - The space between chars. If charspacing is != 0.0 ligatures will - always be dissolved. - - - - - hyphenminchars - - - Minimum number of chars hyphenated at the end of a word. - - - - - parindent - - - Indention of the first n line in a paragraph. - - - - - numindentlines - - - Number of line in a paragraph to indent if parindent != 0.0. - - - - - parskip - - - Distance between paragraphs. - - - - - linenumberspace - - - Overall space in front of each line for the line number. - - - - - linenumbersep - - - Space between the line and the line number. - - - - - major - - - The major version number of pslib. - - - - - minor - - - The minor version number of pslib. - - - - - subminor, revision - - - The subminor version number of pslib. - - - - - + + + + fontsize + + + The size of the currently active font or the font whose + identifier is passed in parameter modifier. + + + + + font + + + The currently active font itself. + + + + + imagewidth + + + The width of the image whose id is passed in the parameter + modifier. + + + + + imageheight + + + The height of the image whose id is passed in the parameter + modifier. + + + + + capheight + + + The height of a capital M in the currently active font or the font + whose identifier is passed in parameter + modifier. + + + + + ascender + + + The ascender of the currently active font or the font + whose identifier is passed in parameter + modifier. + + + + + descender + + + The descender of the currently active font or the font + whose identifier is passed in parameter + modifier. + + + + + italicangle + + + The italicangle of the currently active font or the font + whose identifier is passed in parameter + modifier. + + + + + underlineposition + + + The underlineposition of the currently active font or the font + whose identifier is passed in parameter + modifier. + + + + + underlinethickness + + + The underlinethickness of the currently active font or the font + whose identifier is passed in parameter + modifier. + + + + + textx + + + The current x-position for text output. + + + + + texty + + + The current y-position for text output. + + + + + textrendering + + + The current mode for text rendering. + + + + + textrise + + + The space by which text is risen above the base line. + + + + + leading + + + The distance between text lines in points. + + + + + wordspacing + + + The space between words as a multiple of the width of a space char. + + + + + charspacing + + + The space between chars. If charspacing is != 0.0 ligatures will + always be dissolved. + + + + + hyphenminchars + + + Minimum number of chars hyphenated at the end of a word. + + + + + parindent + + + Indention of the first n line in a paragraph. + + + + + numindentlines + + + Number of line in a paragraph to indent if parindent != 0.0. + + + + + parskip + + + Distance between paragraphs. + + + + + linenumberspace + + + Overall space in front of each line for the line number. + + + + + linenumbersep + + + Space between the line and the line number. + + + + + major + + + The major version number of pslib. + + + + + minor + + + The minor version number of pslib. + + + + + subminor, revision + + + The subminor version number of pslib. + + + + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - name - - - Name of the value. - - - - - modifier - - - The parameter modifier specifies the resource - for which the value is to be retrieved. This can be the id of a font or - an image. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + name + + + Name of the value. + + + + + modifier + + + The parameter modifier specifies the resource + for which the value is to be retrieved. This can be the id of a font or + an image. + + + + &reftitle.returnvalues; - + Returns the value of the parameter or &false;. - + &reftitle.seealso; - - - ps_set_value - - + + ps_set_value + - - diff --git a/reference/ps/functions/ps-hyphenate.xml b/reference/ps/functions/ps-hyphenate.xml index 306de72fcf9b..35cb774789d6 100644 --- a/reference/ps/functions/ps-hyphenate.xml +++ b/reference/ps/functions/ps-hyphenate.xml @@ -1,7 +1,7 @@ - + ps_hyphenate Hyphenates a word @@ -14,61 +14,58 @@ resourcepsdoc stringtext - + Hyphenates the passed word. ps_hyphenate evaluates the value hyphenminchars (set by ps_set_value) and the parameter hyphendict (set by ps_set_parameter). hyphendict must be set before calling this function. - - + + This function requires the locale category LC_CTYPE to be set properly. This is done when the extension is initialized by using the environment variables. On Unix systems read the man page of locale for more information. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - text - - - text should not contain any non alpha - characters. Possible positions for breaks are returned in an array of - interger numbers. Each number is the position of the char in - text after which a hyphenation can take place. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + text + + + text should not contain any non alpha + characters. Possible positions for breaks are returned in an array of + interger numbers. Each number is the position of the char in + text after which a hyphenation can take place. + + + + &reftitle.returnvalues; - + An array of integers indicating the position of possible breaks in the text &return.falseforfailure;. - + &reftitle.examples; - - - Hyphennate a text - + + Hyphennate a text + ]]> - - &example.outputs; - + + &example.outputs; + - - - + + &reftitle.seealso; - - - - ps_show_boxed - locale(1) - - + + + ps_show_boxed + locale(1) + - - diff --git a/reference/ps/functions/ps-include-file.xml b/reference/ps/functions/ps-include-file.xml index 3c9b9cf71778..b23d9199cbc5 100644 --- a/reference/ps/functions/ps-include-file.xml +++ b/reference/ps/functions/ps-include-file.xml @@ -1,6 +1,6 @@ - + ps_include_file Reads an external file with raw PostScript code @@ -13,44 +13,41 @@ resourcepsdoc stringfile - + &warn.undocumented.func; - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - file - - - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + file + + + + + + &reftitle.returnvalues; - + &return.success; - + - - diff --git a/reference/ps/functions/ps-lineto.xml b/reference/ps/functions/ps-lineto.xml index 4b4870db50dc..d9db9903720a 100644 --- a/reference/ps/functions/ps-lineto.xml +++ b/reference/ps/functions/ps-lineto.xml @@ -1,7 +1,7 @@ - + ps_lineto Draws a line @@ -15,59 +15,56 @@ floatx floaty - + Adds a straight line from the current point to the given coordinates to the current path. Use ps_moveto to set the starting point of the line. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - x - - - x-coordinate of the end point of the line. - - - - - y - - - y-coordinate of the end point of the line. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + x + + + x-coordinate of the end point of the line. + + + + + y + + + y-coordinate of the end point of the line. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.examples; - - - Drawing a rectangle - + + Drawing a rectangle + ]]> - - - + + &reftitle.seealso; - - - ps_moveto - - + + ps_moveto + - - diff --git a/reference/ps/functions/ps-makespotcolor.xml b/reference/ps/functions/ps-makespotcolor.xml index 10bcfe6c6cb1..16e2f7a40fe0 100644 --- a/reference/ps/functions/ps-makespotcolor.xml +++ b/reference/ps/functions/ps-makespotcolor.xml @@ -1,7 +1,7 @@ - + ps_makespotcolor Create spot color @@ -15,54 +15,51 @@ stringname intreserved0 - + Creates a spot color from the current fill color. The fill color must be defined in rgb, cmyk or gray colorspace. The spot color name can be an arbitrary name. A spot color can be set as any color with ps_setcolor. When the document is not printed but displayed by an postscript viewer the given color in the specified color space is use. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - name - - - Name of the spot color, e.g. Pantone 5565. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + name + + + Name of the spot color, e.g. Pantone 5565. + + + + &reftitle.returnvalues; - + The id of the new spot color or 0 in case of an error. - + &reftitle.examples; - - - Creating and using a spot color - + + Creating and using a spot color + ]]> - - - This example creates the spot color "PANTONE 5565 C" which - is a darker green (olive) and fills a rectangle with 50% intensity. - - - + + + This example creates the spot color "PANTONE 5565 C" which + is a darker green (olive) and fills a rectangle with 50% intensity. + + &reftitle.seealso; - - - ps_setcolor - - + + ps_setcolor + - - diff --git a/reference/ps/functions/ps-moveto.xml b/reference/ps/functions/ps-moveto.xml index 2d92d0c74bfe..b05753e76bcf 100644 --- a/reference/ps/functions/ps-moveto.xml +++ b/reference/ps/functions/ps-moveto.xml @@ -1,7 +1,7 @@ - + ps_moveto Sets current point @@ -15,64 +15,59 @@ floatx floaty - + Sets the current point to new coordinates. If this is the first call of ps_moveto after a previous path has been ended then it will start a new path. If this function is called in the middle of a path it will just set the current point and start a subpath. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - x - - - x-coordinate of the point to move to. - - - - - y - - - y-coordinate of the point to move to. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + x + + + x-coordinate of the point to move to. + + + + + y + + + y-coordinate of the point to move to. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_lineto - - + + ps_lineto + - - diff --git a/reference/ps/functions/ps-new.xml b/reference/ps/functions/ps-new.xml index 53ee4ef7ced3..3eb9399abbe4 100644 --- a/reference/ps/functions/ps-new.xml +++ b/reference/ps/functions/ps-new.xml @@ -1,7 +1,7 @@ - + ps_new Creates a new PostScript document object @@ -11,14 +11,14 @@ &reftitle.description; resourcefalseps_new - + - + Creates a new document instance. It does not create the file on disk or in memory, it just sets up everything. ps_new is usually followed by a call of ps_open_file to actually create the postscript document. - + @@ -28,22 +28,19 @@ &reftitle.returnvalues; - + Resource of PostScript document&return.falseforfailure;. The return value is passed to all other functions as the first argument. - + &reftitle.seealso; - - - ps_delete - - + + ps_delete + - - diff --git a/reference/ps/functions/ps-open-file.xml b/reference/ps/functions/ps-open-file.xml index 3faa89323da4..300727b351d4 100644 --- a/reference/ps/functions/ps-open-file.xml +++ b/reference/ps/functions/ps-open-file.xml @@ -1,7 +1,7 @@ - + ps_open_file Opens a file for output @@ -14,56 +14,51 @@ resourcepsdoc stringfilename - + Creates a new file on disk and writes the PostScript document into it. The file will be closed when ps_close is called. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - filename - - - The name of the postscript file. - If filename is not passed the document will be - created in memory and all output will go straight to the browser. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + filename + + + The name of the postscript file. + If filename is not passed the document will be + created in memory and all output will go straight to the browser. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_close - - + + ps_close + - - diff --git a/reference/ps/functions/ps-open-image-file.xml b/reference/ps/functions/ps-open-image-file.xml index 148d53dc22b8..364422bf28e9 100644 --- a/reference/ps/functions/ps-open-image-file.xml +++ b/reference/ps/functions/ps-open-image-file.xml @@ -1,7 +1,7 @@ - + ps_open_image_file Opens image from file @@ -17,81 +17,76 @@ stringstringparam intintparam0 - + Loads an image for later use. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - type - - - The type of the image. Possible values are png, - jpeg, or eps. - - - - - filename - - - The name of the file containing the image data. - - - - - stringparam - - - Not used. - - - - - intparam - - - Not used. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + type + + + The type of the image. Possible values are png, + jpeg, or eps. + + + + + filename + + + The name of the file containing the image data. + + + + + stringparam + + + Not used. + + + + + intparam + + + Not used. + + + + &reftitle.returnvalues; - + Returns identifier of image or zero in case of an error. The identifier is a positive number greater than 0. - + &reftitle.seealso; - - - ps_open_image - ps_place_image - ps_close_image - - + + ps_open_image + ps_place_image + ps_close_image + - - diff --git a/reference/ps/functions/ps-open-image.xml b/reference/ps/functions/ps-open-image.xml index 9aafc5aa84ff..00b96784ca22 100644 --- a/reference/ps/functions/ps-open-image.xml +++ b/reference/ps/functions/ps-open-image.xml @@ -1,7 +1,7 @@ - + ps_open_image Reads an image for later placement @@ -22,127 +22,121 @@ intbpc stringparams - + Reads an image which is already available in memory. The parameter source is currently not evaluated and assumed to be memory. The image data is a sequence of pixels starting in th upper left corner and ending in the lower right corner. Each pixel consists of components color components, and each component has bpc bits. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - type - - - The type of the image. Possible values are png, - jpeg, or eps. - - - - - source - - - Not used. - - - - - data - - - The image data. - - - - - length - - - The length of the image data. - - - - - width - - - The width of the image. - - - - - height - - - The height of the image. - - - - - components - - - The number of components for each pixel. This can be - 1 (gray scale images), 3 (rgb images), or 4 (cmyk, rgba images). - - - - - bpc - - - Number of bits per component (quite often 8). - - - - - params - - - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + type + + + The type of the image. Possible values are png, + jpeg, or eps. + + + + + source + + + Not used. + + + + + data + + + The image data. + + + + + length + + + The length of the image data. + + + + + width + + + The width of the image. + + + + + height + + + The height of the image. + + + + + components + + + The number of components for each pixel. This can be + 1 (gray scale images), 3 (rgb images), or 4 (cmyk, rgba images). + + + + + bpc + + + Number of bits per component (quite often 8). + + + + + params + + + + + + &reftitle.returnvalues; - + Returns identifier of image or zero in case of an error. The identifier is a positive number greater than 0. - + &reftitle.seealso; - - - ps_open_image_file - ps_place_image - ps_close_image - - + + ps_open_image_file + ps_place_image + ps_close_image + - - - diff --git a/reference/ps/functions/ps-open-memory-image.xml b/reference/ps/functions/ps-open-memory-image.xml index f34fabf29625..3e4d5365c935 100644 --- a/reference/ps/functions/ps-open-memory-image.xml +++ b/reference/ps/functions/ps-open-memory-image.xml @@ -1,6 +1,6 @@ - + ps_open_memory_image Takes an GD image and returns an image for placement in a PS document @@ -13,37 +13,34 @@ resourcepsdoc intgd - + &warn.undocumented.func; - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - gd - - - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + gd + + + + + + - - diff --git a/reference/ps/functions/ps-place-image.xml b/reference/ps/functions/ps-place-image.xml index dd4ed8d32808..c3a000063f20 100644 --- a/reference/ps/functions/ps-place-image.xml +++ b/reference/ps/functions/ps-place-image.xml @@ -1,7 +1,7 @@ - + ps_place_image Places image on the page @@ -17,84 +17,79 @@ floaty floatscale - + Places a formerly loaded image on the page. The image can be scaled. If the image shall be rotated as well, you will have to rotate the coordinate system before with ps_rotate. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - imageid - - - The resource identifier of the image as returned by - ps_open_image or - ps_open_image_file. - - - - - x - - - x-coordinate of the lower left corner of the image. - - - - - y - - - y-coordinate of the lower left corner of the image. - - - - - scale - - - The scaling factor for the image. A scale of 1.0 will result - in a resolution of 72 dpi, because each pixel is equivalent to - 1 point. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + imageid + + + The resource identifier of the image as returned by + ps_open_image or + ps_open_image_file. + + + + + x + + + x-coordinate of the lower left corner of the image. + + + + + y + + + y-coordinate of the lower left corner of the image. + + + + + scale + + + The scaling factor for the image. A scale of 1.0 will result + in a resolution of 72 dpi, because each pixel is equivalent to + 1 point. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_open_image - ps_open_image_file - - + + ps_open_image + ps_open_image_file + - - diff --git a/reference/ps/functions/ps-rect.xml b/reference/ps/functions/ps-rect.xml index 5fc6f1ea50b2..e04734cb46b5 100644 --- a/reference/ps/functions/ps-rect.xml +++ b/reference/ps/functions/ps-rect.xml @@ -1,7 +1,7 @@ - + ps_rect Draws a rectangle @@ -17,84 +17,79 @@ floatwidth floatheight - + Draws a rectangle with its lower left corner at (x, y). The rectangle starts and ends in its lower left corner. If this function is called outside a path it will start a new path. If it is called within a path it will add the rectangle as a subpath. If the last drawing operation does not end in the lower left corner then there will be a gap in the path. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - x - - - x-coordinate of the lower left corner of the rectangle. - - - - - y - - - y-coordinate of the lower left corner of the rectangle. - - - - - width - - - The width of the image. - - - - - height - - - The height of the image. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + x + + + x-coordinate of the lower left corner of the rectangle. + + + + + y + + + y-coordinate of the lower left corner of the rectangle. + + + + + width + + + The width of the image. + + + + + height + + + The height of the image. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_arc - ps_cirle - ps_lineto - - + + ps_arc + ps_cirle + ps_lineto + - - diff --git a/reference/ps/functions/ps-restore.xml b/reference/ps/functions/ps-restore.xml index 590e3d2dfe93..02dc86909c64 100644 --- a/reference/ps/functions/ps-restore.xml +++ b/reference/ps/functions/ps-restore.xml @@ -1,7 +1,7 @@ - + ps_restore Restore previously save context @@ -13,49 +13,44 @@ boolps_restore resourcepsdoc - + Restores a previously saved graphics context. Any call of ps_save must be accompanied by a call to ps_restore. All coordinate transformations, line style settings, color settings, etc. are being restored to the state before the call of ps_save. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_save - - + + ps_save + - - diff --git a/reference/ps/functions/ps-rotate.xml b/reference/ps/functions/ps-rotate.xml index 6d954e21aa2c..32ccc8586f2c 100644 --- a/reference/ps/functions/ps-rotate.xml +++ b/reference/ps/functions/ps-rotate.xml @@ -1,7 +1,7 @@ - + ps_rotate Sets rotation factor @@ -14,49 +14,46 @@ resourcepsdoc floatrot - + Sets the rotation of the coordinate system. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - rot - - - Angle of rotation in degree. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + rot + + + Angle of rotation in degree. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.examples; - - - Rotation of the coordinate system - + + Rotation of the coordinate system + ]]> - - - The above example illustrates a very common way of rotating a - graphic (in this case just a rectangle) by simply rotating the - coordinate system. Since the graphic's coordinate system assumes - (0,0) to be the origin, the page coordinate system is also translated - to place the graphics not on the edge of the page. Pay attention - to the order of ps_translate and - ps_rotate. In the above case the rectancle is - rotated around the point (100, 100) in the untranslated coordinate - system. Switching the two statements has a completely - different result. - - - In order to output the following text at the original position, all - modifications of the coordinate system are encapsulated in - ps_save and ps_restore. - - - + + + The above example illustrates a very common way of rotating a + graphic (in this case just a rectangle) by simply rotating the + coordinate system. Since the graphic's coordinate system assumes + (0,0) to be the origin, the page coordinate system is also translated + to place the graphics not on the edge of the page. Pay attention + to the order of ps_translate and + ps_rotate. In the above case the rectancle is + rotated around the point (100, 100) in the untranslated coordinate + system. Switching the two statements has a completely + different result. + + + In order to output the following text at the original position, all + modifications of the coordinate system are encapsulated in + ps_save and ps_restore. + + &reftitle.seealso; - - - ps_scale - ps_translate - - + + ps_scale + ps_translate + - - diff --git a/reference/ps/functions/ps-save.xml b/reference/ps/functions/ps-save.xml index f9f170d845d6..cc11c40d4f54 100644 --- a/reference/ps/functions/ps-save.xml +++ b/reference/ps/functions/ps-save.xml @@ -1,7 +1,7 @@ - + ps_save Save current context @@ -13,47 +13,42 @@ boolps_save resourcepsdoc - + Saves the current graphics context, containing colors, translation and rotation settings and some more. A saved context can be restored with ps_restore. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_restore - - + + ps_restore + - - diff --git a/reference/ps/functions/ps-scale.xml b/reference/ps/functions/ps-scale.xml index 5f7bfdb1d42e..e28e4cfcc78c 100644 --- a/reference/ps/functions/ps-scale.xml +++ b/reference/ps/functions/ps-scale.xml @@ -1,7 +1,7 @@ - + ps_scale Sets scaling factor @@ -15,62 +15,57 @@ floatx floaty - + Sets horizontal and vertical scaling of the coordinate system. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - x - - - Scaling factor in horizontal direction. - - - - - y - - - Scaling factor in vertical direction. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + x + + + Scaling factor in horizontal direction. + + + + + y + + + Scaling factor in vertical direction. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_rotate - ps_translate - - + + ps_rotate + ps_translate + - - diff --git a/reference/ps/functions/ps-set-border-color.xml b/reference/ps/functions/ps-set-border-color.xml index 9bfc127ef2f9..f925b0509e52 100644 --- a/reference/ps/functions/ps-set-border-color.xml +++ b/reference/ps/functions/ps-set-border-color.xml @@ -1,7 +1,7 @@ - + ps_set_border_color Sets color of border for annotations @@ -16,75 +16,70 @@ floatgreen floatblue - + Links added with one of the functions ps_add_weblink, ps_add_pdflink, etc. will be displayed with a surounded rectangle when the postscript document is converted to pdf and viewed in a pdf viewer. This rectangle is not visible in the postscript document. This function sets the color of the rectangle's border line. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - red - - - The red component of the border color. - - - - - green - - - The green component of the border color. - - - - - blue - - - The blue component of the border color. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + red + + + The red component of the border color. + + + + + green + + + The green component of the border color. + + + + + blue + + + The blue component of the border color. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_set_border_dash - ps_set_border_style - - + + ps_set_border_dash + ps_set_border_style + - - diff --git a/reference/ps/functions/ps-set-border-dash.xml b/reference/ps/functions/ps-set-border-dash.xml index 5d0d7eae9206..f358dad1222c 100644 --- a/reference/ps/functions/ps-set-border-dash.xml +++ b/reference/ps/functions/ps-set-border-dash.xml @@ -1,7 +1,7 @@ - + ps_set_border_dash Sets length of dashes for border of annotations @@ -15,7 +15,7 @@ floatblack floatwhite - + Links added with one of the functions ps_add_weblink, ps_add_pdflink, etc. will be displayed with a surounded rectangle when the postscript document is converted to @@ -23,60 +23,55 @@ the postscript document. This function sets the length of the black and white portion of a dashed border line. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - black - - - The length of the dash. - - - - - white - - - The length of the gap between dashes. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + black + + + The length of the dash. + + + + + white + + + The length of the gap between dashes. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_set_border_color - ps_set_border_style - - + + ps_set_border_color + ps_set_border_style + - - diff --git a/reference/ps/functions/ps-set-border-style.xml b/reference/ps/functions/ps-set-border-style.xml index e1c439a6edf1..d4cdfdf30e6e 100644 --- a/reference/ps/functions/ps-set-border-style.xml +++ b/reference/ps/functions/ps-set-border-style.xml @@ -1,7 +1,7 @@ - + ps_set_border_style Sets border style of annotations @@ -15,68 +15,63 @@ stringstyle floatwidth - + Links added with one of the functions ps_add_weblink, ps_add_pdflink, etc. will be displayed with a surounded rectangle when the postscript document is converted to pdf and viewed in a pdf viewer. This rectangle is not visible in the postscript document. This function sets the appearance and width of the border line. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - style - - - style can be solid or - dashed. - - - - - width - - - The line width of the border. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + style + + + style can be solid or + dashed. + + + + + width + + + The line width of the border. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_set_border_color - ps_set_border_dash - - + + ps_set_border_color + ps_set_border_dash + - - diff --git a/reference/ps/functions/ps-set-info.xml b/reference/ps/functions/ps-set-info.xml index 691470c1fa03..210ba165094d 100644 --- a/reference/ps/functions/ps-set-info.xml +++ b/reference/ps/functions/ps-set-info.xml @@ -1,7 +1,7 @@ - + ps_set_info Sets information fields of document @@ -15,94 +15,89 @@ stringkey stringval - + Sets certain information fields of the document. This fields will be shown as a comment in the header of the PostScript file. If the document is converted to pdf this fields will also be used for the document information. - - + + The BoundingBox is usually set to the value given to the first page. This only works if ps_findfont has not been called before. In such cases the BoundingBox would be left unset unless you set it explicitly with this function. - - + + This function will have no effect anymore when the header of the postscript file has been already written. It must be called before the first page or the first call of ps_findfont. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - key - - - The name of the information field to set. The values which can be - set are Keywords, Subject, - Title, Creator, - Author, BoundingBox, and - Orientation. Be aware that some of them has a - meaning to PostScript viewers. - - - - - value - - - The value of the information field. The field - Orientation can be set to either - Portrait or Landscape. The - BoundingBox is a string consisting of four numbers. - The first two numbers are the coordinates of the lower left corner of - the page. The last two numbers are the coordinates of the upper - right corner. - - - - Up to version 0.2.6 of pslib, the BoundingBox and Orientation - will be overwritten by ps_begin_page, - unless ps_findfont has been called before. - - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + key + + + The name of the information field to set. The values which can be + set are Keywords, Subject, + Title, Creator, + Author, BoundingBox, and + Orientation. Be aware that some of them has a + meaning to PostScript viewers. + + + + + value + + + The value of the information field. The field + Orientation can be set to either + Portrait or Landscape. The + BoundingBox is a string consisting of four numbers. + The first two numbers are the coordinates of the lower left corner of + the page. The last two numbers are the coordinates of the upper + right corner. + + + + Up to version 0.2.6 of pslib, the BoundingBox and Orientation + will be overwritten by ps_begin_page, + unless ps_findfont has been called before. + + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_findfont - ps_begin_page - - + + ps_findfont + ps_begin_page + - - diff --git a/reference/ps/functions/ps-set-parameter.xml b/reference/ps/functions/ps-set-parameter.xml index dd263eb897e2..bc861a528fde 100644 --- a/reference/ps/functions/ps-set-parameter.xml +++ b/reference/ps/functions/ps-set-parameter.xml @@ -1,7 +1,7 @@ - + ps_set_parameter Sets certain parameters @@ -15,63 +15,58 @@ stringname stringvalue - + Sets several parameters which are used by many functions. Parameters are by definition string values. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - name - - - For a list of possible names see ps_get_parameter. - - - - - value - - - The value of the parameter. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + name + + + For a list of possible names see ps_get_parameter. + + + + + value + + + The value of the parameter. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_get_parameters - ps_set_value - - + + ps_get_parameters + ps_set_value + - - diff --git a/reference/ps/functions/ps-set-text-pos.xml b/reference/ps/functions/ps-set-text-pos.xml index dd42dd48f27c..5a68aeef1af2 100644 --- a/reference/ps/functions/ps-set-text-pos.xml +++ b/reference/ps/functions/ps-set-text-pos.xml @@ -1,7 +1,7 @@ - + ps_set_text_pos Sets position for text output @@ -15,65 +15,62 @@ floatx floaty - + Set the position for the next text output. You may alternatively set the x and y value separately by calling ps_set_value and choosing textx respectively texty as the value name. - - + + If you want to output text at a certain position it is more convenient to use ps_show_xy instead of setting the text position and calling ps_show. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - x - - - x-coordinate of the new text position. - - - - - y - - - y-coordinate of the new text position. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + x + + + x-coordinate of the new text position. + + + + + y + + + y-coordinate of the new text position. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.examples; - - - Placing text at a given position - + + Placing text at a given position + ]]> - - - + + &reftitle.seealso; - - - ps_set_value - ps_show - - + + ps_set_value + ps_show + - - diff --git a/reference/ps/functions/ps-set-value.xml b/reference/ps/functions/ps-set-value.xml index be58ad777cfa..3a05f9ddfef4 100644 --- a/reference/ps/functions/ps-set-value.xml +++ b/reference/ps/functions/ps-set-value.xml @@ -1,7 +1,7 @@ - + ps_set_value Sets certain values @@ -15,105 +15,100 @@ stringname floatvalue - + Sets several values which are used by many functions. Parameters are by definition float values. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - name - - - The name can be one of the following: - - - textrendering - - - The way how text is shown. - - - - - textx - - - The x coordinate for text output. - - - - - texty - - - The y coordinate for text output. - - - - - wordspacing - - - The distance between words relative to the width of a space. - - - - - leading - - - The distance between lines in pixels. - - - - - - - - - value - - - The value of the parameter. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + name + + + The name can be one of the following: + + + textrendering + + + The way how text is shown. + + + + + textx + + + The x coordinate for text output. + + + + + texty + + + The y coordinate for text output. + + + + + wordspacing + + + The distance between words relative to the width of a space. + + + + + leading + + + The distance between lines in pixels. + + + + + + + + + value + + + The value of the parameter. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_get_value - ps_set_parameter - - + + ps_get_value + ps_set_parameter + - - diff --git a/reference/ps/functions/ps-setcolor.xml b/reference/ps/functions/ps-setcolor.xml index 8e4c79710816..fc4bde60615a 100644 --- a/reference/ps/functions/ps-setcolor.xml +++ b/reference/ps/functions/ps-setcolor.xml @@ -1,7 +1,7 @@ - + ps_setcolor Sets current color @@ -19,106 +19,103 @@ floatc3 floatc4 - + Sets the color for drawing, filling, or both. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - type - - - The parameter type can be - both, fill, or - fillstroke. - - - - - colorspace - - - The colorspace should be one of gray, - rgb, cmyk, - spot, pattern. Depending on the - colorspace either only the first, the first three or all parameters - will be used. - - - - - c1 - - - Depending on the colorspace this is either the red component (rgb), - the cyan component (cmyk), the gray value (gray), the identifier of - the spot color or the identifier of the pattern. - - - - - c2 - - - Depending on the colorspace this is either the green component (rgb), - the magenta component (cmyk). - - - - - c3 - - - Depending on the colorspace this is either the blue component (rgb), - the yellow component (cmyk). - - - - - c4 - - - This must only be set in cmyk colorspace and specifies the black - component. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + type + + + The parameter type can be + both, fill, or + fillstroke. + + + + + colorspace + + + The colorspace should be one of gray, + rgb, cmyk, + spot, pattern. Depending on the + colorspace either only the first, the first three or all parameters + will be used. + + + + + c1 + + + Depending on the colorspace this is either the red component (rgb), + the cyan component (cmyk), the gray value (gray), the identifier of + the spot color or the identifier of the pattern. + + + + + c2 + + + Depending on the colorspace this is either the green component (rgb), + the magenta component (cmyk). + + + + + c3 + + + Depending on the colorspace this is either the blue component (rgb), + the yellow component (cmyk). + + + + + c4 + + + This must only be set in cmyk colorspace and specifies the black + component. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.notes; - + The second parameter is currently not always evaluated. The color is sometimes set for filling and drawing just as if fillstroke were passed. - + - - + ps_setdash Sets appearance of a dashed line @@ -15,61 +15,56 @@ floaton floatoff - + Sets the length of the black and white portions of a dashed line. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - on - - - The length of the dash. - - - - - off - - - The length of the gap between dashes. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + on + + + The length of the dash. + + + + + off + + + The length of the gap between dashes. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_setpolydash - - + + ps_setpolydash + - - diff --git a/reference/ps/functions/ps-setflat.xml b/reference/ps/functions/ps-setflat.xml index 0e07c0e42ce0..96375d89d81d 100644 --- a/reference/ps/functions/ps-setflat.xml +++ b/reference/ps/functions/ps-setflat.xml @@ -1,7 +1,7 @@ - + ps_setflat Sets flatness @@ -14,44 +14,41 @@ resourcepsdoc floatvalue - + &warn.undocumented.func; - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - value - - - The value must be between 0.2 and 1. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + value + + + The value must be between 0.2 and 1. + + + + &reftitle.returnvalues; - + &return.success; - + - - diff --git a/reference/ps/functions/ps-setfont.xml b/reference/ps/functions/ps-setfont.xml index 5c2d452d2dc2..7f36b7c73f26 100644 --- a/reference/ps/functions/ps-setfont.xml +++ b/reference/ps/functions/ps-setfont.xml @@ -1,7 +1,7 @@ - + ps_setfont Sets font to use for following output @@ -15,64 +15,59 @@ intfontid floatsize - + Sets a font, which has to be loaded before with ps_findfont. Outputting text without setting a font results in an error. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - fontid - - - The font identifier as returned by ps_findfont. - - - - - size - - - The size of the font. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + fontid + + + The font identifier as returned by ps_findfont. + + + + + size + + + The size of the font. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_findfont - ps_set_text_pos for an example. - - + + ps_findfont + ps_set_text_pos for an example. + - - diff --git a/reference/ps/functions/ps-setgray.xml b/reference/ps/functions/ps-setgray.xml index 20e59e6d4f6c..c0600bd7d63f 100644 --- a/reference/ps/functions/ps-setgray.xml +++ b/reference/ps/functions/ps-setgray.xml @@ -1,7 +1,7 @@ - + ps_setgray Sets gray value @@ -14,54 +14,49 @@ resourcepsdoc floatgray - + Sets the gray value for all following drawing operations. - + - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - gray - - - The value must be between 0 (white) and 1 (black). - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + gray + + + The value must be between 0 (white) and 1 (black). + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_setcolor - - + + ps_setcolor + - - diff --git a/reference/ps/functions/ps-setlinecap.xml b/reference/ps/functions/ps-setlinecap.xml index 4fec1ecf2c01..84527d4eea21 100644 --- a/reference/ps/functions/ps-setlinecap.xml +++ b/reference/ps/functions/ps-setlinecap.xml @@ -1,7 +1,7 @@ - + ps_setlinecap Sets appearance of line ends @@ -14,58 +14,53 @@ resourcepsdoc inttype - + Sets how line ends look like. - + - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - type - - - The type of line ends. Possible values are - PS_LINECAP_BUTT, - PS_LINECAP_ROUND, or - PS_LINECAP_SQUARED. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + type + + + The type of line ends. Possible values are + PS_LINECAP_BUTT, + PS_LINECAP_ROUND, or + PS_LINECAP_SQUARED. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_setlinejoin - ps_setlinewidth - ps_setmiterlimit - - + + ps_setlinejoin + ps_setlinewidth + ps_setmiterlimit + - - diff --git a/reference/ps/functions/ps-setlinejoin.xml b/reference/ps/functions/ps-setlinejoin.xml index f645a31597d0..afc6fcf3af86 100644 --- a/reference/ps/functions/ps-setlinejoin.xml +++ b/reference/ps/functions/ps-setlinejoin.xml @@ -1,7 +1,7 @@ - + ps_setlinejoin Sets how contected lines are joined @@ -14,58 +14,53 @@ resourcepsdoc inttype - + Sets how lines are joined. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - type - - - The way lines are joined. Possible values are - PS_LINEJOIN_MITER, - PS_LINEJOIN_ROUND, or - PS_LINEJOIN_BEVEL. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + type + + + The way lines are joined. Possible values are + PS_LINEJOIN_MITER, + PS_LINEJOIN_ROUND, or + PS_LINEJOIN_BEVEL. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_setlinecap - ps_setlinewidth - ps_setmiterlimit - - + + ps_setlinecap + ps_setlinewidth + ps_setmiterlimit + - - diff --git a/reference/ps/functions/ps-setlinewidth.xml b/reference/ps/functions/ps-setlinewidth.xml index 1d6a667f1b7e..55492a91a5d5 100644 --- a/reference/ps/functions/ps-setlinewidth.xml +++ b/reference/ps/functions/ps-setlinewidth.xml @@ -1,7 +1,7 @@ - + ps_setlinewidth Sets width of a line @@ -14,55 +14,50 @@ resourcepsdoc floatwidth - + Sets the line width for all following drawing operations. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - width - - - The width of lines in points. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + width + + + The width of lines in points. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_setlinecap - ps_setlinejoin - ps_setmiterlimit - - + + ps_setlinecap + ps_setlinejoin + ps_setmiterlimit + - - diff --git a/reference/ps/functions/ps-setmiterlimit.xml b/reference/ps/functions/ps-setmiterlimit.xml index 17fe1f6914a5..dba641f1bc8a 100644 --- a/reference/ps/functions/ps-setmiterlimit.xml +++ b/reference/ps/functions/ps-setmiterlimit.xml @@ -1,7 +1,7 @@ - + ps_setmiterlimit Sets the miter limit @@ -14,60 +14,55 @@ resourcepsdoc floatvalue - + If two lines join in a small angle and the line join is set to PS_LINEJOIN_MITER, then the resulting spike will be very long. The miter limit is the maximum ratio of the miter length (the length of the spike) and the line width. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - value - - - The maximum ratio between the miter length and the line width. Larger - values (> 10) will result in very long spikes when two lines meet - in a small angle. Keep the default unless you know what you are doing. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + value + + + The maximum ratio between the miter length and the line width. Larger + values (> 10) will result in very long spikes when two lines meet + in a small angle. Keep the default unless you know what you are doing. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_setlinecap - ps_setlinejoin - ps_setlinewidth - - + + ps_setlinecap + ps_setlinejoin + ps_setlinewidth + - - diff --git a/reference/ps/functions/ps-setoverprintmode.xml b/reference/ps/functions/ps-setoverprintmode.xml index a8adec213324..9e8ea2533d92 100644 --- a/reference/ps/functions/ps-setoverprintmode.xml +++ b/reference/ps/functions/ps-setoverprintmode.xml @@ -1,6 +1,6 @@ - + ps_setoverprintmode Sets overprint mode @@ -13,43 +13,40 @@ resourcepsdoc intmode - + &warn.undocumented.func; - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - mode - - - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + mode + + + + + + &reftitle.returnvalues; - + &return.success; - + - - diff --git a/reference/ps/functions/ps-setpolydash.xml b/reference/ps/functions/ps-setpolydash.xml index a48b24805e3d..7f40bcdd5b54 100644 --- a/reference/ps/functions/ps-setpolydash.xml +++ b/reference/ps/functions/ps-setpolydash.xml @@ -1,7 +1,7 @@ - + ps_setpolydash Sets appearance of a dashed line @@ -14,52 +14,49 @@ resourcepsdoc floatarr - + Sets the length of the black and white portions of a dashed line. ps_setpolydash is used to set more complicated dash patterns. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - arr - - - arr is a list of length elements alternately for - the black and white portion. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + arr + + + arr is a list of length elements alternately for + the black and white portion. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.examples; - - - Drawing a dashed line - + + Drawing a dashed line + ]]> - - - This example draws a line with a 10 and 2 points long line, and - gaps of 5 points inbetween. - - - + + + This example draws a line with a 10 and 2 points long line, and + gaps of 5 points inbetween. + + &reftitle.seealso; - - - ps_setdash - - + + ps_setdash + - - diff --git a/reference/ps/functions/ps-shading-pattern.xml b/reference/ps/functions/ps-shading-pattern.xml index ca47ee5fd561..249877824f57 100644 --- a/reference/ps/functions/ps-shading-pattern.xml +++ b/reference/ps/functions/ps-shading-pattern.xml @@ -1,7 +1,7 @@ - + ps_shading_pattern Creates a pattern based on a shading @@ -15,65 +15,60 @@ intshadingid stringoptlist - + Creates a pattern based on a shading, which has to be created before with ps_shading. Shading patterns can be used like regular patterns. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - shadingid - - - The identifier of a shading previously created with - ps_shading. - - - - - optlist - - - This argument is not currently used. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + shadingid + + + The identifier of a shading previously created with + ps_shading. + + + + + optlist + + + This argument is not currently used. + + + + &reftitle.returnvalues; - + The identifier of the pattern &return.falseforfailure;. - + &reftitle.seealso; - - - ps_shading - ps_shfill - - + + ps_shading + ps_shfill + - - diff --git a/reference/ps/functions/ps-shading.xml b/reference/ps/functions/ps-shading.xml index 6e611f556d88..75cf52096017 100644 --- a/reference/ps/functions/ps-shading.xml +++ b/reference/ps/functions/ps-shading.xml @@ -1,7 +1,7 @@ - + ps_shading Creates a shading for later use @@ -23,94 +23,89 @@ floatc4 stringoptlist - + Creates a shading, which can be used by ps_shfill or ps_shading_pattern. - - + + The color of the shading can be in any color space except for pattern. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - type - - - The type of shading can be either radial or - axial. Each shading starts with the current fill - color and ends with the given color values passed in the parameters - c1 to c4 - (see ps_setcolor for their meaning). - - - - - x0, x1, y0, y1 - - - The coordinates x0, y0, - x1, y1 are the start and - end point of the shading. If the type of shading is - radial the two points are the middle points of - a starting and ending circle. - - - - - c1, c2, c3, c4 - - - See ps_setcolor for their meaning. - - - - - optlist - - - If the shading is of type radial the - optlist must also contain the parameters - r0 and r1 with the radius of the - start and end circle. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + type + + + The type of shading can be either radial or + axial. Each shading starts with the current fill + color and ends with the given color values passed in the parameters + c1 to c4 + (see ps_setcolor for their meaning). + + + + + x0, x1, y0, y1 + + + The coordinates x0, y0, + x1, y1 are the start and + end point of the shading. If the type of shading is + radial the two points are the middle points of + a starting and ending circle. + + + + + c1, c2, c3, c4 + + + See ps_setcolor for their meaning. + + + + + optlist + + + If the shading is of type radial the + optlist must also contain the parameters + r0 and r1 with the radius of the + start and end circle. + + + + &reftitle.returnvalues; - + Returns the identifier of the pattern &return.falseforfailure;. - + &reftitle.seealso; - - - ps_shading_pattern - ps_shfill - - + + ps_shading_pattern + ps_shfill + - - diff --git a/reference/ps/functions/ps-shfill.xml b/reference/ps/functions/ps-shfill.xml index 394cdbd843d9..cc152c8c10b3 100644 --- a/reference/ps/functions/ps-shfill.xml +++ b/reference/ps/functions/ps-shfill.xml @@ -1,7 +1,7 @@ - + ps_shfill Fills an area with a shading @@ -14,58 +14,53 @@ resourcepsdoc intshadingid - + Fills an area with a shading, which has to be created before with ps_shading. This is an alternative way to creating a pattern from a shading ps_shading_pattern and using the pattern as the filling color. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - shadingid - - - The identifier of a shading previously created with - ps_shading. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + shadingid + + + The identifier of a shading previously created with + ps_shading. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_shading - ps_shading_pattern - - + + ps_shading + ps_shading_pattern + - - diff --git a/reference/ps/functions/ps-show-boxed.xml b/reference/ps/functions/ps-show-boxed.xml index ed7887b6969b..69569330bdcb 100644 --- a/reference/ps/functions/ps-show-boxed.xml +++ b/reference/ps/functions/ps-show-boxed.xml @@ -1,7 +1,7 @@ - + ps_show_boxed Output text in a box @@ -20,13 +20,13 @@ stringhmode stringfeature - + Outputs a text in a given box. The lower left corner of the box is at (left, bottom). Line breaks will be inserted where needed. Multiple spaces are treated as one. Tabulators are treated as spaces. - - + + The text will be hyphenated if the parameter hyphenation is set to &true; and the parameter hyphendict contains a valid @@ -41,85 +41,83 @@ indenting of the first m paragraphs set the value parindentskip to a positive number. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - text - - - The text to be output into the given box. - - - - - left - - - x-coordinate of the lower left corner of the box. - - - - - bottom - - - y-coordinate of the lower left corner of the box. - - - - - width - - - Width of the box. - - - - - height - - - Height of the box. - - - - - hmode - - - The parameter hmode can be justify, - fulljustify, right, left, or center. - The difference of justify and fulljustify just affects the last line of the box. In - fulljustify mode the last line will be left and right justified unless - this is also the last line of paragraph. In justify mode it will always - be left justified. - - - - - feature - - - - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + text + + + The text to be output into the given box. + + + + + left + + + x-coordinate of the lower left corner of the box. + + + + + bottom + + + y-coordinate of the lower left corner of the box. + + + + + width + + + Width of the box. + + + + + height + + + Height of the box. + + + + + hmode + + + The parameter hmode can be justify, + fulljustify, right, left, or center. + The difference of justify and fulljustify just affects the last line of the box. In + fulljustify mode the last line will be left and right justified unless + this is also the last line of paragraph. In justify mode it will always + be left justified. + + + + + feature + + + + + + + Used parameters @@ -133,121 +131,121 @@ leading (value) - Distance between baselines of two consecutive lines. + Distance between baselines of two consecutive lines. linebreak (parameter) - + Set to &true; if you want a carriage return to start a new line instead of treating it as a space. Defaults to &false;. - + parbreak (parameter) - + Set to &true; if you want a carriage return on a single line to start a new paragraph instead of treating it as a space. Defaults to &true;. - + hyphenation (parameter) - + Set to &true; in order to turn hyphenation on. This requires a dictionary to be set with the parameter hyphendict. Defaults to &false;. - + hyphendict (parameter) - + Filename of the dictionary used for hyphenation pattern (see below). - + hyphenminchar (value) - + The number of chars which must at least be left over before or after the hyphen. This implies that only words of at least two times this value will be hyphenated. The default value is three. Setting a value of zero will result in the default value. - + parindent (value) - + Set the amount of space in pixel for indenting the first m lines of a paragraph. m can be set with the value numindentlines. - + parskip (value) - + Set the amount of extra space in pixel between paragraphs. Defaults to 0 which will result in a normal line distance. - + numindentlines (value) - + Number of lines from the start of the paragraph which will be indented. Defaults to 1. - + parindentskip (value) - + Number of paragraphs in the box whose first lines will not be indented. This defaults to 0. This is useful for paragraphs right after a section heading or text being continued in a second box. In both case one would set this to 1. - + linenumbermode (parameter) - + Set how lines are to be numbered. Possible values are box for numbering lines in the whole box or paragraph to number lines within each paragraph. - + linenumberspace (value) - + The space for the column left of the numbered line containing the line number. The line number will be right justified into this column. Defaults to 20. - + linenumbersep (value) - + The space between the column with line numbers and the line itself. Defaults to 5. - + @@ -281,21 +279,18 @@ &reftitle.returnvalues; - + Number of characters that could not be written. - + &reftitle.seealso; - - - ps_continue_text - - + + ps_continue_text + - - diff --git a/reference/ps/functions/ps-show-xy.xml b/reference/ps/functions/ps-show-xy.xml index 2ff14292bca2..ec00f327aa37 100644 --- a/reference/ps/functions/ps-show-xy.xml +++ b/reference/ps/functions/ps-show-xy.xml @@ -1,7 +1,7 @@ - + ps_show_xy Output text at given position @@ -16,70 +16,65 @@ floatx floaty - + Output a text at the given text position. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - text - - - The text to be output. - - - - - x - - - x-coordinate of the lower left corner of the box surrounding the text. - - - - - y - - - y-coordinate of the lower left corner of the box surrounding the text. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + text + + + The text to be output. + + + + + x + + + x-coordinate of the lower left corner of the box surrounding the text. + + + + + y + + + y-coordinate of the lower left corner of the box surrounding the text. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_continue_text - ps_show - - + + ps_continue_text + ps_show + - - diff --git a/reference/ps/functions/ps-show-xy2.xml b/reference/ps/functions/ps-show-xy2.xml index 1e197c82ca37..ab9f3058ec0c 100644 --- a/reference/ps/functions/ps-show-xy2.xml +++ b/reference/ps/functions/ps-show-xy2.xml @@ -1,6 +1,6 @@ - + ps_show_xy2 Output text at position @@ -16,19 +16,18 @@ floatxcoor floatycoor - + &warn.undocumented.func; - + &reftitle.returnvalues; - + &return.success; - + - - diff --git a/reference/ps/functions/ps-show.xml b/reference/ps/functions/ps-show.xml index de397b263ec1..6c72476f6c00 100644 --- a/reference/ps/functions/ps-show.xml +++ b/reference/ps/functions/ps-show.xml @@ -1,7 +1,7 @@ - + ps_show Output text @@ -14,72 +14,72 @@ resourcepsdoc stringtext - + Output a text at the current text position. The text position can be set by storing the x and y coordinates into the values textx and texty with the function ps_set_value. The function will issue an error if a font was not set before with ps_setfont. - - + + ps_show evaluates the following parameters and values as set by ps_set_parameter and ps_set_value. - + charspacing (value) - + Distance between two consecutive glyphs. If this value is unequal to zero then all ligatures will be resolved. Values less than zero are allowed. - + kerning (parameter) - + Setting this parameter to "false" will turn off kerning. Kerning is turned on by default. - + ligatures (parameter) - - Setting this parameter to "false" will turn off the use of ligatures. + + Setting this parameter to "false" will turn off the use of ligatures. Ligatures are turned on by default. - + underline (parameter) - + Setting this parameter to "true" will turn on underlining. Underlining is turned off by default. - + overline (parameter) - + Setting this parameter to "true" will turn on overlining. Overlining is turned off by default. - + strikeout (parameter) - - + + Setting this parameter to "true" will turn on striking out. Striking out is turned off by default. - + @@ -87,48 +87,43 @@ &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - text - - - The text to be output. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + text + + + The text to be output. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_continue_text - ps_show_xy - ps_setfont - - + + ps_continue_text + ps_show_xy + ps_setfont + - - diff --git a/reference/ps/functions/ps-show2.xml b/reference/ps/functions/ps-show2.xml index a00dd68c00bf..b7c445e133a9 100644 --- a/reference/ps/functions/ps-show2.xml +++ b/reference/ps/functions/ps-show2.xml @@ -1,6 +1,6 @@ - + ps_show2 Output a text at current position @@ -14,52 +14,49 @@ stringtext intlen - + Output text at the current position. Do not print more than len characters. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - text - - - The text to be output. - - - - - len - - - The maximum number of characters to print. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + text + + + The text to be output. + + + + + len + + + The maximum number of characters to print. + + + + &reftitle.returnvalues; - + &return.success; - + - - diff --git a/reference/ps/functions/ps-string-geometry.xml b/reference/ps/functions/ps-string-geometry.xml index f052af4a2a23..8da2ac635557 100644 --- a/reference/ps/functions/ps-string-geometry.xml +++ b/reference/ps/functions/ps-string-geometry.xml @@ -1,7 +1,7 @@ - + ps_string_geometry Gets geometry of a string @@ -16,77 +16,72 @@ intfontid0 floatsize0.0 - + This function is similar to ps_stringwidth but returns an array of dimensions containing the width, ascender, and descender of the text. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - text - - - The text for which the geometry is to be calculated. - - - - - fontid - - - The identifier of the font to be used. If not font is specified - the current font will be used. - - - - - size - - - The size of the font. If no size is specified the current size - is used. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + text + + + The text for which the geometry is to be calculated. + + + + + fontid + + + The identifier of the font to be used. If not font is specified + the current font will be used. + + + + + size + + + The size of the font. If no size is specified the current size + is used. + + + + &reftitle.returnvalues; - + An array of the dimensions of a string. The element 'width' contains the width of the string as returned by ps_stringwidth. The element 'descender' contains the maximum descender and 'ascender' the maximum ascender of the string. - + &reftitle.seealso; - - - ps_continue_text - ps_stringwidth - - + + ps_continue_text + ps_stringwidth + - - diff --git a/reference/ps/functions/ps-stringwidth.xml b/reference/ps/functions/ps-stringwidth.xml index 5572b113003f..3a0c6d359f7b 100644 --- a/reference/ps/functions/ps-stringwidth.xml +++ b/reference/ps/functions/ps-stringwidth.xml @@ -1,12 +1,12 @@ - + ps_stringwidth Gets width of a string - + &reftitle.description; @@ -16,75 +16,70 @@ intfontid0 floatsize0.0 - + Calculates the width of a string in points if it was output in the given font and font size. This function needs an Adobe font metrics file to calculate the precise width. If kerning is turned on, it will be taken into account. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - text - - - The text for which the width is to be calculated. - - - - - fontid - - - The identifier of the font to be used. If not font is specified - the current font will be used. - - - - - size - - - The size of the font. If no size is specified the current size - is used. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + text + + + The text for which the width is to be calculated. + + + + + fontid + + + The identifier of the font to be used. If not font is specified + the current font will be used. + + + + + size + + + The size of the font. If no size is specified the current size + is used. + + + + &reftitle.returnvalues; - + Width of a string in points. - + &reftitle.seealso; - - - ps_string_geometry - - + + ps_string_geometry + - - diff --git a/reference/ps/functions/ps-stroke.xml b/reference/ps/functions/ps-stroke.xml index 865b995873ec..99b4eb510b8d 100644 --- a/reference/ps/functions/ps-stroke.xml +++ b/reference/ps/functions/ps-stroke.xml @@ -1,7 +1,7 @@ - + ps_stroke Draws the current path @@ -13,48 +13,43 @@ boolps_stroke resourcepsdoc - + Draws the path constructed with previously called drawing functions like ps_lineto. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_closepath_stroke - ps_fill - ps_fill_stroke - - + + ps_closepath_stroke + ps_fill + ps_fill_stroke + - - diff --git a/reference/ps/functions/ps-symbol-name.xml b/reference/ps/functions/ps-symbol-name.xml index 4807c2df2fc5..f7c635389c4f 100644 --- a/reference/ps/functions/ps-symbol-name.xml +++ b/reference/ps/functions/ps-symbol-name.xml @@ -1,7 +1,7 @@ - + ps_symbol_name Gets name of a glyph @@ -15,65 +15,60 @@ intord intfontid0 - + This function needs an Adobe font metrics file to know which glyphs are available. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - ord - - - The parameter ord is the position of the glyph - in the font encoding vector. - - - - - fontid - - - The identifier of the font to be used. If not font is specified - the current font will be used. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + ord + + + The parameter ord is the position of the glyph + in the font encoding vector. + + + + + fontid + + + The identifier of the font to be used. If not font is specified + the current font will be used. + + + + &reftitle.returnvalues; - + The name of a glyph in the given font. - + &reftitle.seealso; - - - ps_symbol - ps_symbol_width - - + + ps_symbol + ps_symbol_width + - - diff --git a/reference/ps/functions/ps-symbol-width.xml b/reference/ps/functions/ps-symbol-width.xml index 84872d6af29f..8a61e27b8183 100644 --- a/reference/ps/functions/ps-symbol-width.xml +++ b/reference/ps/functions/ps-symbol-width.xml @@ -1,7 +1,7 @@ - + ps_symbol_width Gets width of a glyph @@ -16,74 +16,69 @@ intfontid0 floatsize0.0 - + Calculates the width of a glyph in points if it was output in the given font and font size. This function needs an Adobe font metrics file to calculate the precise width. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - ord - - - The position of the glyph in the font encoding vector. - - - - - fontid - - - The identifier of the font to be used. If not font is specified - the current font will be used. - - - - - size - - - The size of the font. If no size is specified the current size - is used. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + ord + + + The position of the glyph in the font encoding vector. + + + + + fontid + + + The identifier of the font to be used. If not font is specified + the current font will be used. + + + + + size + + + The size of the font. If no size is specified the current size + is used. + + + + &reftitle.returnvalues; - + The width of a glyph in points. - + &reftitle.seealso; - - - ps_symbol - ps_symbol_name - - + + ps_symbol + ps_symbol_name + - - diff --git a/reference/ps/functions/ps-symbol.xml b/reference/ps/functions/ps-symbol.xml index 978e94dc2b8d..f2dfb222e092 100644 --- a/reference/ps/functions/ps-symbol.xml +++ b/reference/ps/functions/ps-symbol.xml @@ -1,7 +1,7 @@ - + ps_symbol Output a glyph @@ -14,56 +14,51 @@ resourcepsdoc intord - + Output the glyph at position ord in the font encoding vector of the current font. The font encoding for a font can be set when loading the font with ps_findfont. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - ord - - - The position of the glyph in the font encoding vector. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + ord + + + The position of the glyph in the font encoding vector. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; - - - ps_symbol_name - ps_symbol_width - - + + ps_symbol_name + ps_symbol_width + - - diff --git a/reference/ps/functions/ps-translate.xml b/reference/ps/functions/ps-translate.xml index 5c4521bfec63..27a084a04d35 100644 --- a/reference/ps/functions/ps-translate.xml +++ b/reference/ps/functions/ps-translate.xml @@ -1,7 +1,7 @@ - + ps_translate Sets translation @@ -15,57 +15,54 @@ floatx floaty - + Sets a new initial point of the coordinate system. - + &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - x - - - x-coordinate of the origin of the translated coordinate system. - - - - - y - - - y-coordinate of the origin of the translated coordinate system. - - - - - + + + psdoc + + + Resource identifier of the postscript file + as returned by ps_new. + + + + + x + + + x-coordinate of the origin of the translated coordinate system. + + + + + y + + + y-coordinate of the origin of the translated coordinate system. + + + + &reftitle.returnvalues; - + &return.success; - + &reftitle.examples; - - - Translation of the coordinate system - + + Translation of the coordinate system + ]]> - - The above example demonstrates two possible ways to place - a graphic (in this case just a rectangle) at any position on the page, - while the graphic itself uses its own coordinate system. The trick is - to change the origin of the current coordinate system before drawing - the rectangle. The translation has to be undone after the graphic has - been drawn. - - - On the second page a slightly different and more elegant approach is - applied. Instead of undoing the translation with a second call of - ps_translate the graphics context is saved before - modifying the coordinate system and restored after drawing the rectangle. - - - + + The above example demonstrates two possible ways to place + a graphic (in this case just a rectangle) at any position on the page, + while the graphic itself uses its own coordinate system. The trick is + to change the origin of the current coordinate system before drawing + the rectangle. The translation has to be undone after the graphic has + been drawn. + + + On the second page a slightly different and more elegant approach is + applied. Instead of undoing the translation with a second call of + ps_translate the graphics context is saved before + modifying the coordinate system and restored after drawing the rectangle. + + &reftitle.seealso; - - - ps_scale - ps_rotate - - + + ps_scale + ps_rotate + - - diff --git a/reference/ps/reference.xml b/reference/ps/reference.xml index fca9882f3f1c..864a03af1344 100644 --- a/reference/ps/reference.xml +++ b/reference/ps/reference.xml @@ -1,18 +1,17 @@ - - + PS &Functions;
Contact Information - + If you have comments, bugfixes, enhancements for either this extension or pslib then please drop me a mail steinm@php.net. Any help is very welcome. - +
@@ -20,7 +19,6 @@ &reference.ps.entities.functions; - - - + &reftitle.setup;
&reftitle.required; - + You need at least pslib >= 0.1.12. The ps library (pslib) is available at &url.pslib;. - +
@@ -21,15 +20,14 @@
&reftitle.resources; - + This extension defines a PostScript document resource returned by ps_new. - +
- -