cvs: peardoc /en/pecl ps.xml
| From: | Uwe Steinmann | Date: | Thu, 22 Apr 2004 05:45:59 +0000 |
| Subject: | cvs: peardoc /en/pecl ps.xml | ||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-3690@lists.php.net to get a copy of this message | ||
steinm Thu Apr 22 01:45:59 2004 EDT
Modified files:
/peardoc/en/pecl ps.xml
Log:
- many cleanups like removing empty 'Return value' sections and
not existing functions
http://cvs.php.net/diff.php/peardoc/en/pecl/ps.xml?r1=1.1&r2=1.2&ty=u Index: peardoc/en/pecl/ps.xml diff -u peardoc/en/pecl/ps.xml:1.1 peardoc/en/pecl/ps.xml:1.2 --- peardoc/en/pecl/ps.xml:1.1 Wed Apr 21 14:04:53 2004 +++ peardoc/en/pecl/ps.xml Thu Apr 22 01:45:59 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Author: Uwe Steinmann <steinm@php.net> --> <reference id="pecl.ps"> <title>PostScript document creation</title> @@ -115,6 +115,18 @@ <para> </para> </sect2> + <sect2 id="pecl.bcompiler.contact"> + <title>Contact Information</title> + <para> + ...... + </para> + <para> + If you have comments, bugfixes, enhancements for either this extension + or pslib then please drop me a mail <ulink + url="mailto:steinm@php.net">steinm@php.net</ulink>. Any help is very + welcome. + </para> + </sect2> </sect1> @@ -129,7 +141,7 @@ <title>Description</title> <funcsynopsis> <funcprototype> - <funcdef>bool <function>ps_add_bookmark</function></funcdef> + <funcdef>int <function>ps_add_bookmark</function></funcdef> <paramdef>resource <parameter>psdoc</parameter></paramdef> <paramdef>string <parameter>text</parameter></paramdef> <paramdef>int <parameter>parent</parameter></paramdef> @@ -138,15 +150,26 @@ </funcprototype> </funcsynopsis> - <para>Adds a bookmark for the current page. Bookmarks usually appear - in PDF-Viewers left of the page in hierachical tree. + <para>Adds a bookmark for the current page. Bookmarks usually appear + in PDF-Viewers left of the page in a hierachical tree. Clicking on a bookmark will jump to the given page.</para> - <para>The bookmark has no meaning if the document is printed or + <para>The parameter <parameter>parent</parameter> is another bookmark + which is used as the parent of the new bookmark. If + <parameter>open</parameter> is unequal to zero the bookmark will + be shown open by the pdf viewer.</para> + <para>The bookmark has no meaning if the document is printed or viewed but it will be used if the document is converted to pdf by either - Acrobat Distiller™ or Ghostview.</para> + Acrobat Distiller™ or Ghostview.</para> + <para>The returned value is a reference for the bookmark. It is only + used if the bookmark shall be used as a parent.</para> </refsect1> <refsect1> + <title>Return value</title> + <para>Returns the identifier of the bookmark or zero in case of an error. + The identifier is a positiv number.</para> + </refsect1> + <refsect1> <title>See also</title> <para><function>ps_add_launchlink</function>, <function>ps_add_pdflink</function>, <function>ps_add_weblink</function></para> @@ -176,7 +199,7 @@ </funcsynopsis> <para>Places a hyperlink at the given position pointing to a file program - which is being started when click on. The hyperlink start is + which is being started when clicked on. The hyperlink start 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. </para> @@ -215,20 +238,21 @@ </funcprototype> </funcsynopsis> - <para>Places a hyperlink at the given position pointing to a page + <para>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 parameter <parameter>dest</parameter> determines how - the document is being viewed. It can be 'fitpage', 'fitwidth', - 'fitheight', or 'fitbbox'.</para> - <para>The hyperlink start 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. + given page. The first page in a document has number 1. + The parameter <parameter>dest</parameter> determines how + the document is being viewed. It can be 'fitpage', 'fitwidth', + 'fitheight', or 'fitbbox'.</para> + <para>The hyperlink start is + a rectangle with its lower left corner at (<parameter>llx</parameter>, + <parameter>lly</parameter>) and its upper right + corner at (<parameter>urx</parameter>, <parameter>ury</parameter>). + The rectangle has by default a thin blue border. </para> - <para>The hyperlink will not be visible if the document is printed or + <para>The hyperlink will not be visible if the document is printed or viewed but it will show up if the document is converted to pdf by either - Acrobat Distiller™ or Ghostview.</para> - + Acrobat Distiller™ or Ghostview.</para> </refsect1> <refsect1> <title>See also</title> @@ -261,10 +285,6 @@ </refsect1> <refsect1> - <title>RETURN VALUE</title> - <para></para> - </refsect1> - <refsect1> <title>See also</title> <para><function>ps_add_pdflink</function></para> @@ -295,19 +315,20 @@ </funcprototype> </funcsynopsis> - <para>Places a hyperlink at the given position pointing to a second + <para>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 parameter <parameter>dest</parameter> determines how - the document is being viewed. It can be 'fitpage', 'fitwidth', - 'fitheight', or 'fitbbox'.</para> - <para>The hyperlink start 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. + given page. The first page in a document has number 1. + The parameter <parameter>dest</parameter> determines how + the document is being viewed. It can be 'fitpage', 'fitwidth', + 'fitheight', or 'fitbbox'.</para> + <para>The hyperlink start is a rectangle with its lower left corner at + (<parameter>llx</parameter>, <parameter>lly</parameter>) and its upper right + corner at (<parameter>urx</parameter>, <parameter>ury</parameter>). The + rectangle has by default a thin blue border. </para> - <para>The hyperlink will not be visible if the document is printed or + <para>The hyperlink will not be visible if the document is printed or viewed but it will show up if the document is converted to pdf by either - Acrobat Distiller™ or Ghostview.</para> + Acrobat Distiller™ or Ghostview.</para> </refsect1> <refsect1> @@ -381,17 +402,13 @@ <para>Draws a portion of a circle with at middle point at (<parameter>x</parameter>, <parameter>y</parameter>). The arc starts at an angle of <parameter>alpha</parameter> and ends at an angle of - <parameter>beta</parameter>. It it draws clockwise. + <parameter>beta</parameter>. It is draws clockwise. The subpath added to the current path starts on the arc at angle <parameter>beta</parameter> and ends on the arc at angle <parameter>alpha</parameter>.</para> </refsect1> <refsect1> - <title>RETURN VALUE</title> - <para></para> - </refsect1> - <refsect1> <title>See also</title> <para><function>ps_arc</function></para> @@ -431,10 +448,6 @@ </refsect1> <refsect1> - <title>RETURN VALUE</title> - <para></para> - </refsect1> - <refsect1> <title>See also</title> <para><function>ps_arcn</function></para> @@ -460,29 +473,28 @@ </funcprototype> </funcsynopsis> - <para>Starts a new page. Though the parameters <parameter>width</parameter> + <para>Starts a new page. Though the parameters <parameter>width</parameter> and <parameter>height</parameter> imply a different page size for each - page, this is not possible in PostScript. The first call of - <function>ps_</function> will set - the page size for the whole document. Consecutive calls will have no - effect, except for creating a new page. The situation is different - if you indent to convert the PostScript 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. - </para> - <para>Each page is encapsulated into save/restore. This means, that most + page, this is not possible in PostScript. The first call of + <function>ps_begin_page</function> will set + the page size for the whole document. Consecutive calls will have no + effect, except for creating a new page. The situation is different + if you indent to convert the PostScript 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. + </para> + <para>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. - This affects font loading. A font loaded within a page will not - be available on other pages. Instead of reloading the font with - ps_findfont() on any page, one should rather call ps_findfont() before - the first page is begun; especially if the font is to be embedded.</para> - <para>If there is up to the first call of <function>ps_</function> no call of - <function>ps_findfont</function>, then the header of the PostScript document will be - output and the bounding box will be set to the size of the first page. - If <function>ps_findfont</function> was called before the header has been output already, - the document will not have a valid bounding box. In order to prevent - this, one should set the info field 'BoundingBox' and possibly - `Orientation' before any <function>ps_findfont</function> or <function>ps_begin_page</function> calls.</para> + </para> + <para>If there is up to the first call of + <function>ps_begin_page</function> no call of + <function>ps_findfont</function>, then the header of the PostScript + document will be output and the bounding box will be set to the size of the + first page. If <function>ps_findfont</function> was called before the + header has been output already, the document will not have a valid bounding + box. In order to prevent this, one should set the info field 'BoundingBox' + and possibly `Orientation' before any <function>ps_findfont</function> or + <function>ps_begin_page</function> calls.</para> </refsect1> <refsect1> @@ -495,34 +507,6 @@ <refentry> <refnamediv> - <refname>ps_boot</refname> - - <refpurpose>Initialize library</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_boot</function></funcdef> - <paramdef>void <parameter></parameter></paramdef> - </funcprototype> - </funcsynopsis> - - <para>Does some initialization. Currently it only binds to a textdomain - for gettext and sets locale for LC_CTYPE. Setting LC_CTYPE is needed - for propper hyphenation.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_shutdown</function>, setlocale(3)</para> - - </refsect1> -</refentry> - -<refentry> - <refnamediv> <refname>ps_circle</refname> <refpurpose>Draws a circle</refpurpose> @@ -540,23 +524,21 @@ </funcprototype> </funcsynopsis> - <para>Draws a circle with its middle point at - (<parameter>x</parameter>, <parameter>y</parameter>). The circle - starts and ends at position (x+radius, y). 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 circle as a subpath. If the last drawing operation - does not end in point (x+radius, y) then there will be a gab in the - path.</para> + <para>Draws a circle with its middle point at + (<parameter>x</parameter>, <parameter>y</parameter>). The circle starts + and ends at position + (<parameter>x</parameter>+<parameter>radius</parameter>, + <parameter>y</parameter>). 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 + circle as a subpath. If the last drawing operation does not end in point + (<parameter>x</parameter>+<parameter>radius</parameter>, + <parameter>y</parameter>) then there will be a gab in the path.</para> </refsect1> <refsect1> - <title>RETURN VALUE</title> - <para></para> - </refsect1> - <refsect1> <title>See also</title> - <para><function>ps_arc</function></para> + <para><function>ps_arc</function>, <function>ps_arcn</function></para> </refsect1> </refentry> @@ -577,7 +559,7 @@ </funcprototype> </funcsynopsis> - <para>Takes the current path and uses it define the border of clipping + <para>Takes the current path and uses it to define the border of a clipping area.</para> </refsect1> @@ -692,7 +674,7 @@ </para> <para>This function outputs a last line into the PostScript document, which is a PostScript comment containing - the number of pages.</para> + the number of pages. It also writes the bookmark tree.</para> </refsect1> <refsect1> @@ -720,13 +702,12 @@ </funcprototype> </funcsynopsis> - <para>Output a text one line below the last outputed line. The text - must be null terminated. + <para>Output a text one line below the last outputed line. The line spacing is taken from the value "leading" which must be - set with <function><function>ps_set_value</function></function> in points. - The actual position of the text is determined - by the values "textx" and "texty" which can be requested with - <function><function>ps_get_value</function></function></para> + set with <function>ps_set_value</function> in points. + The actual position of the text is determined + by the values "textx" and "texty" which can be requested with + <function>ps_get_value</function></para> </refsect1> <refsect1> @@ -763,13 +744,9 @@ </refsect1> <refsect1> - <title>RETURN VALUE</title> - <para></para> - </refsect1> - <refsect1> <title>See also</title> - <para><function>ps_line</function></para> + <para><function>ps_lineto</function></para> </refsect1> </refentry> @@ -837,7 +814,7 @@ <refnamediv> <refname>ps_fill</refname> - <refpurpose>Fill the current path</refpurpose> + <refpurpose>Fills the current path</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -914,10 +891,11 @@ characters. A font which is loaded within a page will only be available on that page. Fonts which are to be used in the complete document has to be loaded before the first call of <function>ps_begin_page</function>. Calling - <function>ps_</function> between pages will make that font available for all + <function>ps_findfont</function> between pages will make that font available for all following pages.</para> - <para>ps_ will try to load the file passed in the parameter - <parameter>encoding</parameter>. Encoding files are of the same + <para><function>ps_findfont</function> will try to load the file passed + in the parameter + <parameter>encoding</parameter>. Encoding files are of the same syntax as those used by <command>dvips(1)</command>. The contain a font encoding vector (which is currently not used but must be present) and a list of extra ligatures to extend the @@ -927,9 +905,9 @@ </refsect1> <refsect1> - <title>RETURN VALUE</title> + <title>Return value</title> <para>Returns the identifier of the font or zero in case of an error. - The identifier is positiv number.</para> + The identifier is a positiv number.</para> </refsect1> <refsect1> <title>See also</title> @@ -959,10 +937,6 @@ </refsect1> <refsect1> - <title>RETURN VALUE</title> - <para></para> - </refsect1> - <refsect1> <title>See also</title> <para><function>ps_open_file</function></para> @@ -972,68 +946,6 @@ <refentry> <refnamediv> - <refname>ps_get_majorversion</refname> - - <refpurpose>returns the major version number of the PostScript library</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ps_get_majorversion</function></funcdef> - <paramdef>void <parameter></parameter></paramdef> - </funcprototype> - </funcsynopsis> - - <para>This function can be used to retrieve the major version number of - the PostScript library.</para> - - </refsect1> - <refsect1> - <title>RETURN VALUE</title> - <para>Returns major version as integer.</para> - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_get_minorversion</function>, <function>ps_get_subminorversion</function></para> - - </refsect1> -</refentry> - -<refentry> - <refnamediv> - <refname>ps_get_minorversion</refname> - - <refpurpose>returns the minor version number of the PostScript library</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ps_get_minorversion</function></funcdef> - <paramdef>void <parameter></parameter></paramdef> - </funcprototype> - </funcsynopsis> - - <para>This function can be used to retrieve the minor version number of - the PostScript library.</para> - - </refsect1> - <refsect1> - <title>RETURN VALUE</title> - <para>Returns minor version as integer.</para> - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_get_majorversion</function>, <function>ps_get_subminorversion</function></para> - - </refsect1> -</refentry> - -<refentry> - <refnamediv> <refname>ps_get_parameter</refname> <refpurpose>Gets certain parameters</refpurpose> @@ -1049,50 +961,19 @@ </funcprototype> </funcsynopsis> - <para>Gets several parameters which were set by <function>ps_set_parameters</function>. + <para>Gets several parameters which were set by <function>ps_set_parameter</function>. Parameters are by definition string values. This function cannot be used - to retrieve resources which were also set by <function>ps_set_parameters</function>.</para> + to retrieve resources which were also set by <function>ps_set_parameter</function>.</para> </refsect1> <refsect1> - <title>RETURN VALUE</title> - <para></para> + <title>Return value</title> + <para>Returns the value of the parameter or FALSE.</para> </refsect1> <refsect1> <title>See also</title> - <para><function>ps_set_parameters</function></para> - - </refsect1> -</refentry> - -<refentry> - <refnamediv> - <refname>ps_get_subminorversion</refname> - - <refpurpose>returns the subminor version number of the PostScript library</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ps_get_subminorversion</function></funcdef> - <paramdef>void <parameter></parameter></paramdef> - </funcprototype> - </funcsynopsis> - - <para>This function can be used to retrieve the subminor version number of - the PostScript library.</para> - - </refsect1> - <refsect1> - <title>RETURN VALUE</title> - <para>Returns subminor version as integer.</para> - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_get_minorversion</function>, <function>ps_get_majorversion</function></para> + <para><function>ps_set_parameter</function></para> </refsect1> </refentry> @@ -1120,8 +1001,8 @@ </refsect1> <refsect1> - <title>RETURN VALUE</title> - <para></para> + <title>Return value</title> + <para>Returns the value of the parameter or FALSE.</para> </refsect1> <refsect1> <title>See also</title> @@ -1141,7 +1022,7 @@ <title>Description</title> <funcsynopsis> <funcprototype> - <funcdef>int <function>ps_hyphenate</function></funcdef> + <funcdef>bool <function>ps_hyphenate</function></funcdef> <paramdef>resource <parameter>psdoc</parameter></paramdef> <paramdef>string <parameter>text</parameter></paramdef> <paramdef>string <parameter>*hyphens</parameter></paramdef> @@ -1149,21 +1030,18 @@ </funcprototype> </funcsynopsis> - <para>Hyphenates the passed word. <parameter>text</parameter> should not + <para>Hyphenates the passed word. <parameter>text</parameter> should not contain any non alpha characters. Possible positions for breaks are - returned in <parameter>hyphens</parameter>.</para> - <para>This function requires the locale category LC_CTYPE to be set - propperly. ps_boot() usually does it by using the enviroment variables. + returned in <parameter>hyphens</parameter>.</para> + <para>This function requires the locale category LC_CTYPE to be set + propperly. This is done when the extension is initialized by using the + enviroment variables. </para> - <para>ps_hyphenate() evaluates the value hyphenminchars and the parameter + <para>ps_hyphenate() evaluates the value hyphenminchars and the parameter hyphendict.</para> </refsect1> <refsect1> - <title>RETURN VALUE</title> - <para>Returns -1 in case of an error, and otherwise 0.</para> - </refsect1> - <refsect1> <title>See also</title> <para><function>ps_boot</function>, <function>ps_show_boxed</function>, locale(1)</para> @@ -1189,7 +1067,8 @@ </funcprototype> </funcsynopsis> - <para>Draws a line from the current point to the given coordinates. + <para>Adds a straight line from the current point to the given coordinates + to the current path. Use <function>ps_moveto</function> to set the starting point of the line.</para> </refsect1> @@ -1248,17 +1127,13 @@ </funcprototype> </funcsynopsis> - <para>Creates a new document instance. It does not create the file on disk - or in memory. It just sets up everything. You may pass your own error - handler and memory management functions. If you pass NULL values the - internal default handler and functions will be used. In such case you - may as well call <function>ps_new</function>.</para> + <para>Creates a new document instance. It does not create the file on disk + or in memory. It just sets up everything.</para> </refsect1> <refsect1> - <title>RETURN VALUE</title> - <para>Pointer to new instance of PostScript document or NULL on - failure.</para> + <title>Return value</title> + <para>Resource of PostScript document or FALSE on failure.</para> </refsect1> <refsect1> <title>See also</title> @@ -1278,9 +1153,9 @@ <title>Description</title> <funcsynopsis> <funcprototype> - <funcdef>int <function>ps_open_file</function></funcdef> + <funcdef>bool <function>ps_open_file</function></funcdef> <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>string <parameter>filename</parameter></paramdef> + <paramdef>string <parameter><optional>filename</optional></parameter></paramdef> </funcprototype> </funcsynopsis> @@ -1292,10 +1167,6 @@ </refsect1> <refsect1> - <title>RETURN VALUE</title> - <para>Returns -1 in case of an error and 0 otherwise.</para> - </refsect1> - <refsect1> <title>See also</title> <para><function>ps_close</function></para> @@ -1327,7 +1198,7 @@ </refsect1> <refsect1> - <title>RETURN VALUE</title> + <title>Return value</title> <para>Returns identifier of image or zero in case of an error. The identifier is a positiv number greater 0.</para> </refsect1> @@ -1370,7 +1241,7 @@ </refsect1> <refsect1> - <title>RETURN VALUE</title> + <title>Return value</title> <para>Returns identifier of image or zero in case of an error. The identifier is a positiv number greater 0.</para> </refsect1> @@ -1444,10 +1315,6 @@ </refsect1> <refsect1> - <title>RETURN VALUE</title> - <para></para> - </refsect1> - <refsect1> <title>See also</title> <para><function>ps_cirle</function>, <function>ps_arc</function>, <function>ps_lineto</function></para> @@ -1694,7 +1561,7 @@ </refsect1> <refsect1> - <title>BUG</title> + <title>Bugs</title> <para>The second parameter is currently not evaluated. The color is always set for filling and drawing just as if 'both' where passed.</para> @@ -1859,7 +1726,7 @@ <title>Description</title> <funcsynopsis> <funcprototype> - <funcdef>bool <function>ps_</function></funcdef> + <funcdef>bool <function>ps_setlinecap</function></funcdef> <paramdef>resource <parameter>psdoc</parameter></paramdef> <paramdef>int <parameter>type</parameter></paramdef> @@ -1950,7 +1817,7 @@ </funcprototype> </funcsynopsis> - <para>If two lines join in small angle and the line join is set + <para>If two lines join in a small angle and the line join is set to 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.</para> @@ -1968,7 +1835,7 @@ <title>Description</title> <funcsynopsis> <funcprototype> - <funcdef>int <function>ps_set_parameter</function></funcdef> + <funcdef>bool <function>ps_set_parameter</function></funcdef> <paramdef>resource <parameter>psdoc</parameter></paramdef> <paramdef>string <parameter>name</parameter></paramdef> <paramdef>string <parameter>value</parameter></paramdef> @@ -1981,10 +1848,6 @@ </refsect1> <refsect1> - <title>RETURN VALUE</title> - <para></para> - </refsect1> - <refsect1> <title>See also</title> <para><function>ps_get_parameters</function>, <function>ps_set_value</function></para> @@ -2033,7 +1896,7 @@ <title>Description</title> <funcsynopsis> <funcprototype> - <funcdef>int <function>ps_set_value</function></funcdef> + <funcdef>bool <function>ps_set_value</function></funcdef> <paramdef>resource <parameter>psdoc</parameter></paramdef> <paramdef>string <parameter>name</parameter></paramdef> <paramdef>float <parameter>value</parameter></paramdef> @@ -2070,10 +1933,6 @@ </refsect1> <refsect1> - <title>RETURN VALUE</title> - <para></para> - </refsect1> - <refsect1> <title>See also</title> <para><function>ps_get_value</function>, <function>ps_set_parameter</function></para> @@ -2101,8 +1960,8 @@ <para>Output a text at the current text position. The function will issue an error if no font was set before with <function>ps_setfont</function>.</para> - <para>ps_() evaluates the following parameters and values as - as set by <function>ps_set_parameter</function> and <function>ps_set_value</function>.</para> + <para>ps_show() evaluates the following parameters and values as + set by <function>ps_set_parameter</function> and <function>ps_set_value</function>.</para> <variablelist> <varlistentry> <term>charspacing (value)</term> @@ -2210,12 +2069,12 @@ </refsect1> <refsect1> - <title>USED PARAMETERS</title> + <title>Used parameters</title> - <para>The output of <function>ps_</function> can be configured + <para>The output of <function>ps_show_boxed</function> can be configured with several parameters and values which must be set with either - <function><function>ps_set_parameter</function></function> or - <function><function>ps_set_value</function></function>. Beside the parameters and values + <function>ps_set_parameter</function> or + <function>ps_set_value</function>. Beside the parameters and values which affect text output the following parameters and values are evaluated.</para> <variablelist> @@ -2335,19 +2194,19 @@ </variablelist> </refsect1> <refsect1> - <title>HYPHENATION</title> + <title>Hyphenation</title> <para>Text is hyphenated if the parameter "hyphenation" is set to true and a valid hyphenation dictory is set. pslib does not ship its own hyphenation dictionary but uses one from openoffice, scribus or koffice. You can find their dictionaries for different languages in one of the - following directories if the software + following directories if the software is installed: /usr/share/apps/koffice/hyphdicts/, - /usr/lib/scribus/dicts/, or /usr/lib/openoffice/share/dict/ooo. + /usr/lib/scribus/dicts/, or /usr/lib/openoffice/share/dict/ooo/. Currently scribus appears to have the most complete hyphenation dictionaries.</para> </refsect1> <refsect1> - <title>RETURN VALUE</title> + <title>Return value</title> <para>Number of charactes that could not be written.</para> </refsect1> <refsect1> @@ -2399,7 +2258,7 @@ <title>Description</title> <funcsynopsis> <funcprototype> - <funcdef>float <function>ps_</function></funcdef> + <funcdef>float <function>ps_stringwidth</function></funcdef> <paramdef>resource <parameter>psdoc</parameter></paramdef> <paramdef>string <parameter>text</parameter></paramdef> <paramdef>int <parameter>fontid</parameter></paramdef> @@ -2416,7 +2275,7 @@ </refsect1> <refsect1> - <title>RETURN VALUE</title> + <title>Return value</title> <para>Width of a string in points.</para> </refsect1> <refsect1> @@ -2446,16 +2305,16 @@ </funcprototype> </funcsynopsis> - <para>This function is identical to <function><function>ps_stringwidth2</function></function> + <para>This function is identical to <function>ps_stringwidth</function> but has an extra parameter <parameter>dimension</parameter> which, if not - NULL, will be used to return further dimensions of the string.</para> - <para>dimension[0] contains the width as returned by the function. + NULL, will be used to return further dimensions of the string.</para> + <para>dimension[0] contains the width as returned by the function. dimension[1] contains the maximum descender and dimension[2] the maximum - ascender of the string.</para> + ascender of the string.</para> </refsect1> <refsect1> - <title>RETURN VALUE</title> + <title>Return value</title> <para>Width of a string in points.</para> </refsect1> <refsect1>
http://cvs.php.net/diff.php/peardoc/en/pecl/ps.xml?r1=1.1&r2=1.2&ty=u Index: peardoc/en/pecl/ps.xml diff -u peardoc/en/pecl/ps.xml:1.1 peardoc/en/pecl/ps.xml:1.2 --- peardoc/en/pecl/ps.xml:1.1 Wed Apr 21 14:04:53 2004 +++ peardoc/en/pecl/ps.xml Thu Apr 22 01:45:59 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Author: Uwe Steinmann <steinm@php.net> --> <reference id="pecl.ps"> <title>PostScript document creation</title> @@ -115,6 +115,18 @@ <para> </para> </sect2> + <sect2 id="pecl.bcompiler.contact"> + <title>Contact Information</title> + <para> + ...... + </para> + <para> + If you have comments, bugfixes, enhancements for either this extension + or pslib then please drop me a mail <ulink + url="mailto:steinm@php.net">steinm@php.net</ulink>. Any help is very + welcome. + </para> + </sect2> </sect1> @@ -129,7 +141,7 @@ <title>Description</title> <funcsynopsis> <funcprototype> - <funcdef>bool <function>ps_add_bookmark</function></funcdef> + <funcdef>int <function>ps_add_bookmark</function></funcdef> <paramdef>resource <parameter>psdoc</parameter></paramdef> <paramdef>string <parameter>text</parameter></paramdef> <paramdef>int <parameter>parent</parameter></paramdef> @@ -138,15 +150,26 @@ </funcprototype> </funcsynopsis> - <para>Adds a bookmark for the current page. Bookmarks usually appear - in PDF-Viewers left of the page in hierachical tree. + <para>Adds a bookmark for the current page. Bookmarks usually appear + in PDF-Viewers left of the page in a hierachical tree. Clicking on a bookmark will jump to the given page.</para> - <para>The bookmark has no meaning if the document is printed or + <para>The parameter <parameter>parent</parameter> is another bookmark + which is used as the parent of the new bookmark. If + <parameter>open</parameter> is unequal to zero the bookmark will + be shown open by the pdf viewer.</para> + <para>The bookmark has no meaning if the document is printed or viewed but it will be used if the document is converted to pdf by either - Acrobat Distiller™ or Ghostview.</para> + Acrobat Distiller™ or Ghostview.</para> + <para>The returned value is a reference for the bookmark. It is only + used if the bookmark shall be used as a parent.</para> </refsect1> <refsect1> + <title>Return value</title> + <para>Returns the identifier of the bookmark or zero in case of an error. + The identifier is a positiv number.</para> + </refsect1> + <refsect1> <title>See also</title> <para><function>ps_add_launchlink</function>, <function>ps_add_pdflink</function>, <function>ps_add_weblink</function></para> @@ -176,7 +199,7 @@ </funcsynopsis> <para>Places a hyperlink at the given position pointing to a file program - which is being started when click on. The hyperlink start is + which is being started when clicked on. The hyperlink start 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. </para> @@ -215,20 +238,21 @@ </funcprototype> </funcsynopsis> - <para>Places a hyperlink at the given position pointing to a page + <para>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 parameter <parameter>dest</parameter> determines how - the document is being viewed. It can be 'fitpage', 'fitwidth', - 'fitheight', or 'fitbbox'.</para> - <para>The hyperlink start 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. + given page. The first page in a document has number 1. + The parameter <parameter>dest</parameter> determines how + the document is being viewed. It can be 'fitpage', 'fitwidth', + 'fitheight', or 'fitbbox'.</para> + <para>The hyperlink start is + a rectangle with its lower left corner at (<parameter>llx</parameter>, + <parameter>lly</parameter>) and its upper right + corner at (<parameter>urx</parameter>, <parameter>ury</parameter>). + The rectangle has by default a thin blue border. </para> - <para>The hyperlink will not be visible if the document is printed or + <para>The hyperlink will not be visible if the document is printed or viewed but it will show up if the document is converted to pdf by either - Acrobat Distiller™ or Ghostview.</para> - + Acrobat Distiller™ or Ghostview.</para> </refsect1> <refsect1> <title>See also</title> @@ -261,10 +285,6 @@ </refsect1> <refsect1> - <title>RETURN VALUE</title> - <para></para> - </refsect1> - <refsect1> <title>See also</title> <para><function>ps_add_pdflink</function></para> @@ -295,19 +315,20 @@ </funcprototype> </funcsynopsis> - <para>Places a hyperlink at the given position pointing to a second + <para>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 parameter <parameter>dest</parameter> determines how - the document is being viewed. It can be 'fitpage', 'fitwidth', - 'fitheight', or 'fitbbox'.</para> - <para>The hyperlink start 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. + given page. The first page in a document has number 1. + The parameter <parameter>dest</parameter> determines how + the document is being viewed. It can be 'fitpage', 'fitwidth', + 'fitheight', or 'fitbbox'.</para> + <para>The hyperlink start is a rectangle with its lower left corner at + (<parameter>llx</parameter>, <parameter>lly</parameter>) and its upper right + corner at (<parameter>urx</parameter>, <parameter>ury</parameter>). The + rectangle has by default a thin blue border. </para> - <para>The hyperlink will not be visible if the document is printed or + <para>The hyperlink will not be visible if the document is printed or viewed but it will show up if the document is converted to pdf by either - Acrobat Distiller™ or Ghostview.</para> + Acrobat Distiller™ or Ghostview.</para> </refsect1> <refsect1> @@ -381,17 +402,13 @@ <para>Draws a portion of a circle with at middle point at (<parameter>x</parameter>, <parameter>y</parameter>). The arc starts at an angle of <parameter>alpha</parameter> and ends at an angle of - <parameter>beta</parameter>. It it draws clockwise. + <parameter>beta</parameter>. It is draws clockwise. The subpath added to the current path starts on the arc at angle <parameter>beta</parameter> and ends on the arc at angle <parameter>alpha</parameter>.</para> </refsect1> <refsect1> - <title>RETURN VALUE</title> - <para></para> - </refsect1> - <refsect1> <title>See also</title> <para><function>ps_arc</function></para> @@ -431,10 +448,6 @@ </refsect1> <refsect1> - <title>RETURN VALUE</title> - <para></para> - </refsect1> - <refsect1> <title>See also</title> <para><function>ps_arcn</function></para> @@ -460,29 +473,28 @@ </funcprototype> </funcsynopsis> - <para>Starts a new page. Though the parameters <parameter>width</parameter> + <para>Starts a new page. Though the parameters <parameter>width</parameter> and <parameter>height</parameter> imply a different page size for each - page, this is not possible in PostScript. The first call of - <function>ps_</function> will set - the page size for the whole document. Consecutive calls will have no - effect, except for creating a new page. The situation is different - if you indent to convert the PostScript 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. - </para> - <para>Each page is encapsulated into save/restore. This means, that most + page, this is not possible in PostScript. The first call of + <function>ps_begin_page</function> will set + the page size for the whole document. Consecutive calls will have no + effect, except for creating a new page. The situation is different + if you indent to convert the PostScript 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. + </para> + <para>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. - This affects font loading. A font loaded within a page will not - be available on other pages. Instead of reloading the font with - ps_findfont() on any page, one should rather call ps_findfont() before - the first page is begun; especially if the font is to be embedded.</para> - <para>If there is up to the first call of <function>ps_</function> no call of - <function>ps_findfont</function>, then the header of the PostScript document will be - output and the bounding box will be set to the size of the first page. - If <function>ps_findfont</function> was called before the header has been output already, - the document will not have a valid bounding box. In order to prevent - this, one should set the info field 'BoundingBox' and possibly - `Orientation' before any <function>ps_findfont</function> or <function>ps_begin_page</function> calls.</para> + </para> + <para>If there is up to the first call of + <function>ps_begin_page</function> no call of + <function>ps_findfont</function>, then the header of the PostScript + document will be output and the bounding box will be set to the size of the + first page. If <function>ps_findfont</function> was called before the + header has been output already, the document will not have a valid bounding + box. In order to prevent this, one should set the info field 'BoundingBox' + and possibly `Orientation' before any <function>ps_findfont</function> or + <function>ps_begin_page</function> calls.</para> </refsect1> <refsect1> @@ -495,34 +507,6 @@ <refentry> <refnamediv> - <refname>ps_boot</refname> - - <refpurpose>Initialize library</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_boot</function></funcdef> - <paramdef>void <parameter></parameter></paramdef> - </funcprototype> - </funcsynopsis> - - <para>Does some initialization. Currently it only binds to a textdomain - for gettext and sets locale for LC_CTYPE. Setting LC_CTYPE is needed - for propper hyphenation.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_shutdown</function>, setlocale(3)</para> - - </refsect1> -</refentry> - -<refentry> - <refnamediv> <refname>ps_circle</refname> <refpurpose>Draws a circle</refpurpose> @@ -540,23 +524,21 @@ </funcprototype> </funcsynopsis> - <para>Draws a circle with its middle point at - (<parameter>x</parameter>, <parameter>y</parameter>). The circle - starts and ends at position (x+radius, y). 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 circle as a subpath. If the last drawing operation - does not end in point (x+radius, y) then there will be a gab in the - path.</para> + <para>Draws a circle with its middle point at + (<parameter>x</parameter>, <parameter>y</parameter>). The circle starts + and ends at position + (<parameter>x</parameter>+<parameter>radius</parameter>, + <parameter>y</parameter>). 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 + circle as a subpath. If the last drawing operation does not end in point + (<parameter>x</parameter>+<parameter>radius</parameter>, + <parameter>y</parameter>) then there will be a gab in the path.</para> </refsect1> <refsect1> - <title>RETURN VALUE</title> - <para></para> - </refsect1> - <refsect1> <title>See also</title> - <para><function>ps_arc</function></para> + <para><function>ps_arc</function>, <function>ps_arcn</function></para> </refsect1> </refentry> @@ -577,7 +559,7 @@ </funcprototype> </funcsynopsis> - <para>Takes the current path and uses it define the border of clipping + <para>Takes the current path and uses it to define the border of a clipping area.</para> </refsect1> @@ -692,7 +674,7 @@ </para> <para>This function outputs a last line into the PostScript document, which is a PostScript comment containing - the number of pages.</para> + the number of pages. It also writes the bookmark tree.</para> </refsect1> <refsect1> @@ -720,13 +702,12 @@ </funcprototype> </funcsynopsis> - <para>Output a text one line below the last outputed line. The text - must be null terminated. + <para>Output a text one line below the last outputed line. The line spacing is taken from the value "leading" which must be - set with <function><function>ps_set_value</function></function> in points. - The actual position of the text is determined - by the values "textx" and "texty" which can be requested with - <function><function>ps_get_value</function></function></para> + set with <function>ps_set_value</function> in points. + The actual position of the text is determined + by the values "textx" and "texty" which can be requested with + <function>ps_get_value</function></para> </refsect1> <refsect1> @@ -763,13 +744,9 @@ </refsect1> <refsect1> - <title>RETURN VALUE</title> - <para></para> - </refsect1> - <refsect1> <title>See also</title> - <para><function>ps_line</function></para> + <para><function>ps_lineto</function></para> </refsect1> </refentry> @@ -837,7 +814,7 @@ <refnamediv> <refname>ps_fill</refname> - <refpurpose>Fill the current path</refpurpose> + <refpurpose>Fills the current path</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -914,10 +891,11 @@ characters. A font which is loaded within a page will only be available on that page. Fonts which are to be used in the complete document has to be loaded before the first call of <function>ps_begin_page</function>. Calling - <function>ps_</function> between pages will make that font available for all + <function>ps_findfont</function> between pages will make that font available for all following pages.</para> - <para>ps_ will try to load the file passed in the parameter - <parameter>encoding</parameter>. Encoding files are of the same + <para><function>ps_findfont</function> will try to load the file passed + in the parameter + <parameter>encoding</parameter>. Encoding files are of the same syntax as those used by <command>dvips(1)</command>. The contain a font encoding vector (which is currently not used but must be present) and a list of extra ligatures to extend the @@ -927,9 +905,9 @@ </refsect1> <refsect1> - <title>RETURN VALUE</title> + <title>Return value</title> <para>Returns the identifier of the font or zero in case of an error. - The identifier is positiv number.</para> + The identifier is a positiv number.</para> </refsect1> <refsect1> <title>See also</title> @@ -959,10 +937,6 @@ </refsect1> <refsect1> - <title>RETURN VALUE</title> - <para></para> - </refsect1> - <refsect1> <title>See also</title> <para><function>ps_open_file</function></para> @@ -972,68 +946,6 @@ <refentry> <refnamediv> - <refname>ps_get_majorversion</refname> - - <refpurpose>returns the major version number of the PostScript library</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ps_get_majorversion</function></funcdef> - <paramdef>void <parameter></parameter></paramdef> - </funcprototype> - </funcsynopsis> - - <para>This function can be used to retrieve the major version number of - the PostScript library.</para> - - </refsect1> - <refsect1> - <title>RETURN VALUE</title> - <para>Returns major version as integer.</para> - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_get_minorversion</function>, <function>ps_get_subminorversion</function></para> - - </refsect1> -</refentry> - -<refentry> - <refnamediv> - <refname>ps_get_minorversion</refname> - - <refpurpose>returns the minor version number of the PostScript library</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ps_get_minorversion</function></funcdef> - <paramdef>void <parameter></parameter></paramdef> - </funcprototype> - </funcsynopsis> - - <para>This function can be used to retrieve the minor version number of - the PostScript library.</para> - - </refsect1> - <refsect1> - <title>RETURN VALUE</title> - <para>Returns minor version as integer.</para> - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_get_majorversion</function>, <function>ps_get_subminorversion</function></para> - - </refsect1> -</refentry> - -<refentry> - <refnamediv> <refname>ps_get_parameter</refname> <refpurpose>Gets certain parameters</refpurpose> @@ -1049,50 +961,19 @@ </funcprototype> </funcsynopsis> - <para>Gets several parameters which were set by <function>ps_set_parameters</function>. + <para>Gets several parameters which were set by <function>ps_set_parameter</function>. Parameters are by definition string values. This function cannot be used - to retrieve resources which were also set by <function>ps_set_parameters</function>.</para> + to retrieve resources which were also set by <function>ps_set_parameter</function>.</para> </refsect1> <refsect1> - <title>RETURN VALUE</title> - <para></para> + <title>Return value</title> + <para>Returns the value of the parameter or FALSE.</para> </refsect1> <refsect1> <title>See also</title> - <para><function>ps_set_parameters</function></para> - - </refsect1> -</refentry> - -<refentry> - <refnamediv> - <refname>ps_get_subminorversion</refname> - - <refpurpose>returns the subminor version number of the PostScript library</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ps_get_subminorversion</function></funcdef> - <paramdef>void <parameter></parameter></paramdef> - </funcprototype> - </funcsynopsis> - - <para>This function can be used to retrieve the subminor version number of - the PostScript library.</para> - - </refsect1> - <refsect1> - <title>RETURN VALUE</title> - <para>Returns subminor version as integer.</para> - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_get_minorversion</function>, <function>ps_get_majorversion</function></para> + <para><function>ps_set_parameter</function></para> </refsect1> </refentry> @@ -1120,8 +1001,8 @@ </refsect1> <refsect1> - <title>RETURN VALUE</title> - <para></para> + <title>Return value</title> + <para>Returns the value of the parameter or FALSE.</para> </refsect1> <refsect1> <title>See also</title> @@ -1141,7 +1022,7 @@ <title>Description</title> <funcsynopsis> <funcprototype> - <funcdef>int <function>ps_hyphenate</function></funcdef> + <funcdef>bool <function>ps_hyphenate</function></funcdef> <paramdef>resource <parameter>psdoc</parameter></paramdef> <paramdef>string <parameter>text</parameter></paramdef> <paramdef>string <parameter>*hyphens</parameter></paramdef> @@ -1149,21 +1030,18 @@ </funcprototype> </funcsynopsis> - <para>Hyphenates the passed word. <parameter>text</parameter> should not + <para>Hyphenates the passed word. <parameter>text</parameter> should not contain any non alpha characters. Possible positions for breaks are - returned in <parameter>hyphens</parameter>.</para> - <para>This function requires the locale category LC_CTYPE to be set - propperly. ps_boot() usually does it by using the enviroment variables. + returned in <parameter>hyphens</parameter>.</para> + <para>This function requires the locale category LC_CTYPE to be set + propperly. This is done when the extension is initialized by using the + enviroment variables. </para> - <para>ps_hyphenate() evaluates the value hyphenminchars and the parameter + <para>ps_hyphenate() evaluates the value hyphenminchars and the parameter hyphendict.</para> </refsect1> <refsect1> - <title>RETURN VALUE</title> - <para>Returns -1 in case of an error, and otherwise 0.</para> - </refsect1> - <refsect1> <title>See also</title> <para><function>ps_boot</function>, <function>ps_show_boxed</function>, locale(1)</para> @@ -1189,7 +1067,8 @@ </funcprototype> </funcsynopsis> - <para>Draws a line from the current point to the given coordinates. + <para>Adds a straight line from the current point to the given coordinates + to the current path. Use <function>ps_moveto</function> to set the starting point of the line.</para> </refsect1> @@ -1248,17 +1127,13 @@ </funcprototype> </funcsynopsis> - <para>Creates a new document instance. It does not create the file on disk - or in memory. It just sets up everything. You may pass your own error - handler and memory management functions. If you pass NULL values the - internal default handler and functions will be used. In such case you - may as well call <function>ps_new</function>.</para> + <para>Creates a new document instance. It does not create the file on disk + or in memory. It just sets up everything.</para> </refsect1> <refsect1> - <title>RETURN VALUE</title> - <para>Pointer to new instance of PostScript document or NULL on - failure.</para> + <title>Return value</title> + <para>Resource of PostScript document or FALSE on failure.</para> </refsect1> <refsect1> <title>See also</title> @@ -1278,9 +1153,9 @@ <title>Description</title> <funcsynopsis> <funcprototype> - <funcdef>int <function>ps_open_file</function></funcdef> + <funcdef>bool <function>ps_open_file</function></funcdef> <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>string <parameter>filename</parameter></paramdef> + <paramdef>string <parameter><optional>filename</optional></parameter></paramdef> </funcprototype> </funcsynopsis> @@ -1292,10 +1167,6 @@ </refsect1> <refsect1> - <title>RETURN VALUE</title> - <para>Returns -1 in case of an error and 0 otherwise.</para> - </refsect1> - <refsect1> <title>See also</title> <para><function>ps_close</function></para> @@ -1327,7 +1198,7 @@ </refsect1> <refsect1> - <title>RETURN VALUE</title> + <title>Return value</title> <para>Returns identifier of image or zero in case of an error. The identifier is a positiv number greater 0.</para> </refsect1> @@ -1370,7 +1241,7 @@ </refsect1> <refsect1> - <title>RETURN VALUE</title> + <title>Return value</title> <para>Returns identifier of image or zero in case of an error. The identifier is a positiv number greater 0.</para> </refsect1> @@ -1444,10 +1315,6 @@ </refsect1> <refsect1> - <title>RETURN VALUE</title> - <para></para> - </refsect1> - <refsect1> <title>See also</title> <para><function>ps_cirle</function>, <function>ps_arc</function>, <function>ps_lineto</function></para> @@ -1694,7 +1561,7 @@ </refsect1> <refsect1> - <title>BUG</title> + <title>Bugs</title> <para>The second parameter is currently not evaluated. The color is always set for filling and drawing just as if 'both' where passed.</para> @@ -1859,7 +1726,7 @@ <title>Description</title> <funcsynopsis> <funcprototype> - <funcdef>bool <function>ps_</function></funcdef> + <funcdef>bool <function>ps_setlinecap</function></funcdef> <paramdef>resource <parameter>psdoc</parameter></paramdef> <paramdef>int <parameter>type</parameter></paramdef> @@ -1950,7 +1817,7 @@ </funcprototype> </funcsynopsis> - <para>If two lines join in small angle and the line join is set + <para>If two lines join in a small angle and the line join is set to 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.</para> @@ -1968,7 +1835,7 @@ <title>Description</title> <funcsynopsis> <funcprototype> - <funcdef>int <function>ps_set_parameter</function></funcdef> + <funcdef>bool <function>ps_set_parameter</function></funcdef> <paramdef>resource <parameter>psdoc</parameter></paramdef> <paramdef>string <parameter>name</parameter></paramdef> <paramdef>string <parameter>value</parameter></paramdef> @@ -1981,10 +1848,6 @@ </refsect1> <refsect1> - <title>RETURN VALUE</title> - <para></para> - </refsect1> - <refsect1> <title>See also</title> <para><function>ps_get_parameters</function>, <function>ps_set_value</function></para> @@ -2033,7 +1896,7 @@ <title>Description</title> <funcsynopsis> <funcprototype> - <funcdef>int <function>ps_set_value</function></funcdef> + <funcdef>bool <function>ps_set_value</function></funcdef> <paramdef>resource <parameter>psdoc</parameter></paramdef> <paramdef>string <parameter>name</parameter></paramdef> <paramdef>float <parameter>value</parameter></paramdef> @@ -2070,10 +1933,6 @@ </refsect1> <refsect1> - <title>RETURN VALUE</title> - <para></para> - </refsect1> - <refsect1> <title>See also</title> <para><function>ps_get_value</function>, <function>ps_set_parameter</function></para> @@ -2101,8 +1960,8 @@ <para>Output a text at the current text position. The function will issue an error if no font was set before with <function>ps_setfont</function>.</para> - <para>ps_() evaluates the following parameters and values as - as set by <function>ps_set_parameter</function> and <function>ps_set_value</function>.</para> + <para>ps_show() evaluates the following parameters and values as + set by <function>ps_set_parameter</function> and <function>ps_set_value</function>.</para> <variablelist> <varlistentry> <term>charspacing (value)</term> @@ -2210,12 +2069,12 @@ </refsect1> <refsect1> - <title>USED PARAMETERS</title> + <title>Used parameters</title> - <para>The output of <function>ps_</function> can be configured + <para>The output of <function>ps_show_boxed</function> can be configured with several parameters and values which must be set with either - <function><function>ps_set_parameter</function></function> or - <function><function>ps_set_value</function></function>. Beside the parameters and values + <function>ps_set_parameter</function> or + <function>ps_set_value</function>. Beside the parameters and values which affect text output the following parameters and values are evaluated.</para> <variablelist> @@ -2335,19 +2194,19 @@ </variablelist> </refsect1> <refsect1> - <title>HYPHENATION</title> + <title>Hyphenation</title> <para>Text is hyphenated if the parameter "hyphenation" is set to true and a valid hyphenation dictory is set. pslib does not ship its own hyphenation dictionary but uses one from openoffice, scribus or koffice. You can find their dictionaries for different languages in one of the - following directories if the software + following directories if the software is installed: /usr/share/apps/koffice/hyphdicts/, - /usr/lib/scribus/dicts/, or /usr/lib/openoffice/share/dict/ooo. + /usr/lib/scribus/dicts/, or /usr/lib/openoffice/share/dict/ooo/. Currently scribus appears to have the most complete hyphenation dictionaries.</para> </refsect1> <refsect1> - <title>RETURN VALUE</title> + <title>Return value</title> <para>Number of charactes that could not be written.</para> </refsect1> <refsect1> @@ -2399,7 +2258,7 @@ <title>Description</title> <funcsynopsis> <funcprototype> - <funcdef>float <function>ps_</function></funcdef> + <funcdef>float <function>ps_stringwidth</function></funcdef> <paramdef>resource <parameter>psdoc</parameter></paramdef> <paramdef>string <parameter>text</parameter></paramdef> <paramdef>int <parameter>fontid</parameter></paramdef> @@ -2416,7 +2275,7 @@ </refsect1> <refsect1> - <title>RETURN VALUE</title> + <title>Return value</title> <para>Width of a string in points.</para> </refsect1> <refsect1> @@ -2446,16 +2305,16 @@ </funcprototype> </funcsynopsis> - <para>This function is identical to <function><function>ps_stringwidth2</function></function> + <para>This function is identical to <function>ps_stringwidth</function> but has an extra parameter <parameter>dimension</parameter> which, if not - NULL, will be used to return further dimensions of the string.</para> - <para>dimension[0] contains the width as returned by the function. + NULL, will be used to return further dimensions of the string.</para> + <para>dimension[0] contains the width as returned by the function. dimension[1] contains the maximum descender and dimension[2] the maximum - ascender of the string.</para> + ascender of the string.</para> </refsect1> <refsect1> - <title>RETURN VALUE</title> + <title>Return value</title> <para>Width of a string in points.</para> </refsect1> <refsect1>