cvs: phpdoc /en/reference/ps/functions ps-add-bookmark.xml ps-add-launchlink.xml ps-add-locallink.xml ps-add-note.xml ps-add-pdflink.xml
ps-add-weblink.xml ps-arc.xml ps-arcn.xml ps-begin-page.xml ps-begin-pattern.xml ps-begin-template.xml ps-circle.xml ps-clip.xml ps-close-image.xml
ps-close.xml ps-closepath-stroke.xml ps-closepath.xml ps-continue-text.xml ps-curveto.xml ps-delete.xml ps-end-page.xml ps-end-pattern.xml
ps-end-template.xml ps-fill-stroke.xml ps-fill.xml ps-findfont.xml ps-get-buffer.xml ps-get-parameter.xml ps-get-value.xml
| From: | Uwe Steinmann | Date: | Wed, 01 Mar 2006 07:42:13 +0000 |
| Subject: | cvs: phpdoc /en/reference/ps/functions ps-add-bookmark.xml ps-add-launchlink.xml ps-add-locallink.xml ps-add-note.xml ps-add-pdflink.xml ps-add-weblink.xml ps-arc.xml ps-arcn.xml ps-begin-page.xml ps-begin-pattern.xml ps-begin-template.xml ps-circle.xml ps-clip.xml ps-close-image.xml ps-close.xml ps-closepath-stroke.xml ps-closepath.xml ps-continue-text.xml ps-curveto.xml ps-delete.xml ps-end-page.xml ps-end-pattern.xml ps-end-template.xml ps-fill-stroke.xml ps-fill.xml ps-findfont.xml ps-get-buffer.xml ps-get-parameter.xml ps-get-value.xml |
||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969372162@lists.php.net to get a copy of this message | ||
steinm Wed Mar 1 07:42:13 2006 UTC
Modified files:
/phpdoc/en/reference/ps/functions ps-add-bookmark.xml
ps-add-launchlink.xml
ps-add-locallink.xml
ps-add-note.xml
ps-add-pdflink.xml
ps-add-weblink.xml ps-arc.xml
ps-arcn.xml ps-begin-page.xml
ps-begin-pattern.xml
ps-begin-template.xml
ps-circle.xml ps-clip.xml
ps-close-image.xml ps-close.xml
ps-closepath-stroke.xml
ps-closepath.xml
ps-continue-text.xml
ps-curveto.xml ps-delete.xml
ps-end-page.xml
ps-end-pattern.xml
ps-end-template.xml
ps-fill-stroke.xml ps-fill.xml
ps-findfont.xml ps-get-buffer.xml
ps-get-parameter.xml
ps-get-value.xml
Log:
- complete overhaul of manpage
- fixed list of parameters
http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-add-bookmark.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-add-bookmark.xml diff -u phpdoc/en/reference/ps/functions/ps-add-bookmark.xml:1.3 phpdoc/en/reference/ps/functions/ps-add-bookmark.xml:1.4 --- phpdoc/en/reference/ps/functions/ps-add-bookmark.xml:1.3 Fri Jun 24 13:02:26 2005 +++ phpdoc/en/reference/ps/functions/ps-add-bookmark.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-add-bookmark"> <refnamediv> @@ -22,7 +22,7 @@ bookmark will jump to the given page. </para> <para> - The bookmark has no meaning if the document is printed or viewed but it + 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> @@ -36,7 +36,8 @@ <term><parameter>psdoc</parameter></term> <listitem> <para> - + Resource identifier of the postscript file + as returned by <function>ps_new</function>. </para> </listitem> </varlistentry> @@ -44,7 +45,7 @@ <term><parameter>text</parameter></term> <listitem> <para> - + The text used for displaying the bookmark. </para> </listitem> </varlistentry> @@ -74,11 +75,9 @@ &reftitle.returnvalues; <para> The returned value is a reference for the bookmark. It is only used if - the bookmark shall be used as a parent. - </para> - <para> - Returns the identifier of the bookmark or zero in case of an error. The - identifier is a positive number. + 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. </para> </refsect1> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-add-launchlink.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-add-launchlink.xml diff -u phpdoc/en/reference/ps/functions/ps-add-launchlink.xml:1.1 phpdoc/en/reference/ps/functions/ps-add-launchlink.xml:1.2 --- phpdoc/en/reference/ps/functions/ps-add-launchlink.xml:1.1 Wed Jun 22 13:21:21 2005 +++ phpdoc/en/reference/ps/functions/ps-add-launchlink.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-add-launchlink"> <refnamediv> @@ -31,7 +31,6 @@ </para> </refsect1> -<!-- <refsect1 role="parameters"> &reftitle.parameters; <para> @@ -40,7 +39,8 @@ <term><parameter>psdoc</parameter></term> <listitem> <para> - Its description + Resource identifier of the postscript file + as returned by <function>ps_new</function>. </para> </listitem> </varlistentry> @@ -48,7 +48,7 @@ <term><parameter>llx</parameter></term> <listitem> <para> - Its description + The x-koordinate of the lower left corner. </para> </listitem> </varlistentry> @@ -56,7 +56,7 @@ <term><parameter>lly</parameter></term> <listitem> <para> - Its description + The y-koordinate of the lower left corner. </para> </listitem> </varlistentry> @@ -64,7 +64,7 @@ <term><parameter>urx</parameter></term> <listitem> <para> - Its description + The x-koordinate of the upper right corner. </para> </listitem> </varlistentry> @@ -72,7 +72,7 @@ <term><parameter>ury</parameter></term> <listitem> <para> - Its description + The y-koordinate of the upper right corner. </para> </listitem> </varlistentry> @@ -80,14 +80,14 @@ <term><parameter>filename</parameter></term> <listitem> <para> - Its description + The path of the program to be started, when the link is clicked on. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> ---> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-add-locallink.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-add-locallink.xml diff -u phpdoc/en/reference/ps/functions/ps-add-locallink.xml:1.1 phpdoc/en/reference/ps/functions/ps-add-locallink.xml:1.2 --- phpdoc/en/reference/ps/functions/ps-add-locallink.xml:1.1 Wed Jun 22 13:21:21 2005 +++ phpdoc/en/reference/ps/functions/ps-add-locallink.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-add-locallink"> <refnamediv> @@ -45,7 +45,8 @@ <term><parameter>psdoc</parameter></term> <listitem> <para> - + Resource identifier of the postscript file + as returned by <function>ps_new</function>. </para> </listitem> </varlistentry> @@ -53,7 +54,7 @@ <term><parameter>llx</parameter></term> <listitem> <para> - + The x-koordinate of the lower left corner. </para> </listitem> </varlistentry> @@ -61,7 +62,7 @@ <term><parameter>lly</parameter></term> <listitem> <para> - + The y-koordinate of the lower left corner. </para> </listitem> </varlistentry> @@ -69,7 +70,7 @@ <term><parameter>urx</parameter></term> <listitem> <para> - + The x-koordinate of the upper right corner. </para> </listitem> </varlistentry> @@ -77,7 +78,7 @@ <term><parameter>ury</parameter></term> <listitem> <para> - + The y-koordinate of the upper right corner. </para> </listitem> </varlistentry> @@ -85,7 +86,7 @@ <term><parameter>page</parameter></term> <listitem> <para> - + The number of the page displayed when clicking on the link. </para> </listitem> </varlistentry> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-add-note.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-add-note.xml diff -u phpdoc/en/reference/ps/functions/ps-add-note.xml:1.2 phpdoc/en/reference/ps/functions/ps-add-note.xml:1.3 --- phpdoc/en/reference/ps/functions/ps-add-note.xml:1.2 Wed Jun 22 13:57:20 2005 +++ phpdoc/en/reference/ps/functions/ps-add-note.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-add-note"> <refnamediv> @@ -20,9 +20,106 @@ <methodparam><type>string</type><parameter>title</parameter></methodparam> <methodparam><type>string</type><parameter>icon</parameter></methodparam> <methodparam><type>int</type><parameter>open</parameter></methodparam> - </methodsynopsis> - &warn.undocumented.func; - </refsect1> + </methodsynopsis> + <para> + Adds a note at a certain position on the page. Notes are like little + rectangular sheets with text on it, which can be place somewhere on + a page. The + are shown either folded or unfolded. If unfolded the specified icon + is used as placeholder. + </para> + <para> + The note 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> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>llx</parameter></term> + <listitem> + <para> + The x-coordinate of the lower left corner. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>lly</parameter></term> + <listitem> + <para> + The y-coordinate of the lower left corner. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>urx</parameter></term> + <listitem> + <para> + The x-coordinate of the upper right corner. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>ury</parameter></term> + <listitem> + <para> + The y-coordinate of the upper right corner. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>contents</parameter></term> + <listitem> + <para> + The text of the note. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>title</parameter></term> + <listitem> + <para> + The title of the note as displayed in the header of the note. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>icon</parameter></term> + <listitem> + <para> + The icon shown if the note is folded. This parameter can be set + to <literal>comment</literal>, <literal>insert</literal>, + <literal>note</literal>, <literal>paragraph</literal>, + <literal>newparagraph</literal>, <literal>key</literal>, or + <literal>help</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>open</parameter></term> + <listitem> + <para> + If <parameter>open</parameter> is unequal to zero the note will + be shown unfolded by the pdf viewer. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; @@ -36,6 +133,9 @@ <para> <simplelist> <member><function>ps_add_pdflink</function></member> + <member><function>ps_add_launchlink</function></member> + <member><function>ps_add_locallink</function></member> + <member><function>ps_add_weblink</function></member> </simplelist> </para> </refsect1> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-add-pdflink.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-add-pdflink.xml diff -u phpdoc/en/reference/ps/functions/ps-add-pdflink.xml:1.2 phpdoc/en/reference/ps/functions/ps-add-pdflink.xml:1.3 --- phpdoc/en/reference/ps/functions/ps-add-pdflink.xml:1.2 Mon Jul 4 04:14:33 2005 +++ phpdoc/en/reference/ps/functions/ps-add-pdflink.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-add-pdflink"> <refnamediv> @@ -36,7 +36,7 @@ it will show up if the document is converted to pdf by either Acrobat Distiller™ or Ghostview. </para> - </refsect1> + </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -46,7 +46,8 @@ <term><parameter>psdoc</parameter></term> <listitem> <para> - + Resource identifier of the postscript file + as returned by <function>ps_new</function>. </para> </listitem> </varlistentry> @@ -54,7 +55,7 @@ <term><parameter>llx</parameter></term> <listitem> <para> - + The x-coordinate of the lower left corner. </para> </listitem> </varlistentry> @@ -62,7 +63,7 @@ <term><parameter>lly</parameter></term> <listitem> <para> - + The y-coordinate of the lower left corner. </para> </listitem> </varlistentry> @@ -70,7 +71,7 @@ <term><parameter>urx</parameter></term> <listitem> <para> - + The x-coordinate of the upper right corner. </para> </listitem> </varlistentry> @@ -78,7 +79,7 @@ <term><parameter>ury</parameter></term> <listitem> <para> - + The y-coordinate of the upper right corner. </para> </listitem> </varlistentry> @@ -86,7 +87,8 @@ <term><parameter>filename</parameter></term> <listitem> <para> - + The name of the pdf document to be opened when clicking on + this link. </para> </listitem> </varlistentry> @@ -94,7 +96,7 @@ <term><parameter>page</parameter></term> <listitem> <para> - + The page number of the destination pdf document </para> </listitem> </varlistentry> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-add-weblink.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-add-weblink.xml diff -u phpdoc/en/reference/ps/functions/ps-add-weblink.xml:1.1 phpdoc/en/reference/ps/functions/ps-add-weblink.xml:1.2 --- phpdoc/en/reference/ps/functions/ps-add-weblink.xml:1.1 Wed Jun 22 13:21:21 2005 +++ phpdoc/en/reference/ps/functions/ps-add-weblink.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-add-weblink"> <refnamediv> @@ -20,8 +20,10 @@ </methodsynopsis> <para> Places a hyperlink at the given position pointing to a web page. 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 + 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> @@ -31,7 +33,6 @@ </para> </refsect1> -<!-- <refsect1 role="parameters"> &reftitle.parameters; <para> @@ -40,7 +41,8 @@ <term><parameter>psdoc</parameter></term> <listitem> <para> - + Resource identifier of the postscript file + as returned by <function>ps_new</function>. </para> </listitem> </varlistentry> @@ -48,7 +50,7 @@ <term><parameter>llx</parameter></term> <listitem> <para> - + The x-coordinate of the lower left corner. </para> </listitem> </varlistentry> @@ -56,7 +58,7 @@ <term><parameter>lly</parameter></term> <listitem> <para> - + The y-coordinate of the lower left corner. </para> </listitem> </varlistentry> @@ -64,7 +66,7 @@ <term><parameter>urx</parameter></term> <listitem> <para> - + The x-coordinate of the upper right corner. </para> </listitem> </varlistentry> @@ -72,7 +74,7 @@ <term><parameter>ury</parameter></term> <listitem> <para> - + The y-coordinate of the upper right corner. </para> </listitem> </varlistentry> @@ -80,14 +82,14 @@ <term><parameter>url</parameter></term> <listitem> <para> - + The url of the hyperlink to be opened when clicking on + this link. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> ---> <refsect1 role="returnvalues"> &reftitle.returnvalues; http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-arc.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-arc.xml diff -u phpdoc/en/reference/ps/functions/ps-arc.xml:1.2 phpdoc/en/reference/ps/functions/ps-arc.xml:1.3 --- phpdoc/en/reference/ps/functions/ps-arc.xml:1.2 Mon Jul 4 04:24:25 2005 +++ phpdoc/en/reference/ps/functions/ps-arc.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-arc"> <refnamediv> @@ -28,6 +28,63 @@ </para> </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x</parameter></term> + <listitem> + <para> + The x-coordinate of the cicle's middle point. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y</parameter></term> + <listitem> + <para> + The y-coordinate of the cicle's middle point. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>radius</parameter></term> + <listitem> + <para> + The radius of the circle + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>alpha</parameter></term> + <listitem> + <para> + The starting angle given in degrees. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>beta</parameter></term> + <listitem> + <para> + The end angle given in degrees. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-arcn.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-arcn.xml diff -u phpdoc/en/reference/ps/functions/ps-arcn.xml:1.2 phpdoc/en/reference/ps/functions/ps-arcn.xml:1.3 --- phpdoc/en/reference/ps/functions/ps-arcn.xml:1.2 Mon Jul 4 04:24:25 2005 +++ phpdoc/en/reference/ps/functions/ps-arcn.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-arcn"> <refnamediv> @@ -28,6 +28,63 @@ </para> </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x</parameter></term> + <listitem> + <para> + The x-coordinate of the cicle's middle point. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y</parameter></term> + <listitem> + <para> + The y-coordinate of the cicle's middle point. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>radius</parameter></term> + <listitem> + <para> + The radius of the circle + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>alpha</parameter></term> + <listitem> + <para> + The starting angle given in degrees. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>beta</parameter></term> + <listitem> + <para> + The end angle given in degrees. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-begin-page.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-begin-page.xml diff -u phpdoc/en/reference/ps/functions/ps-begin-page.xml:1.2 phpdoc/en/reference/ps/functions/ps-begin-page.xml:1.3 --- phpdoc/en/reference/ps/functions/ps-begin-page.xml:1.2 Thu Jul 7 10:12:01 2005 +++ phpdoc/en/reference/ps/functions/ps-begin-page.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-begin-page"> <refnamediv> @@ -34,8 +34,9 @@ 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 + the first page. If <function>ps_findfont</function> was called before, then + the + header has been output already, and the document will not have a valid bounding box. In order to prevent this, one should call <function>ps_set_info</function> to set the info field <literal>BoundingBox</literal> and possibly <literal>Orientation</literal> @@ -44,6 +45,39 @@ </para> </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>width</parameter></term> + <listitem> + <para> + The width of the page in pixel, e.g. 596 for A4 format. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>height</parameter></term> + <listitem> + <para> + The height of the page in pixel, e.g. 842 for A4 format. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-begin-pattern.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-begin-pattern.xml diff -u phpdoc/en/reference/ps/functions/ps-begin-pattern.xml:1.3 phpdoc/en/reference/ps/functions/ps-begin-pattern.xml:1.4 --- phpdoc/en/reference/ps/functions/ps-begin-pattern.xml:1.3 Fri Jun 24 09:11:45 2005 +++ phpdoc/en/reference/ps/functions/ps-begin-pattern.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-begin-pattern"> <refnamediv> @@ -19,7 +19,69 @@ <methodparam><type>int</type><parameter>painttype</parameter></methodparam> </methodsynopsis> <para> - Starts a new pattern. + 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 + <function>ps_setcolor</function> and setting the color space to + <literal>pattern</literal>. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>width</parameter></term> + <listitem> + <para> + The width of the pattern in pixel. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>height</parameter></term> + <listitem> + <para> + The height of the pattern in pixel. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x-step</parameter></term> + <listitem> + <para> + The distance in pixel of placements of the pattern in + horizontal direction. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y-step</parameter></term> + <listitem> + <para> + The distance in pixel of placements of the pattern in + vertical direction. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>painttype</parameter></term> + <listitem> + <para> + Must be 1 or 2. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> @@ -30,6 +92,53 @@ </para> </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title>Creating and using a pattern</title> + <programlisting role="php"> +<![CDATA[ +<?php +$ps = ps_new(); + +if (!ps_open_file($ps, "pattern.ps")) { + print "Cannot open PostScript file\n"; + exit; +} + +ps_set_parameter($ps, "warning", "true"); +ps_set_info($ps, "Creator", "pattern.php"); +ps_set_info($ps, "Author", "Uwe Steinmann"); +ps_set_info($ps, "Title", "Pattern example"); + + +$pspattern = ps_begin_pattern($ps, 10.0, 10.0, 10.0, 10.0, 1); +ps_setlinewidth($ps, 0.2); +ps_setcolor($ps, "stroke", "rgb", 0.0, 0.0, 1.0, 0.0); +ps_moveto($ps, 0, 0); +ps_lineto($ps, 7, 7); +ps_stroke($ps); +ps_moveto($ps, 0, 7); +ps_lineto($ps, 7, 0); +ps_stroke($ps); +ps_end_pattern($ps); + +ps_begin_page($ps, 596, 842); +ps_setcolor($ps, "both", "pattern", $pspattern, 0.0, 0.0, 0.0); +ps_rect($ps, 50, 400, 200, 200); +ps_fill($ps); +ps_end_page($ps); + +ps_close($ps); +ps_delete($ps); +?> +]]> + </programlisting> + </example> + </para> + </refsect1> + <refsect1 role="seealso"> &reftitle.seealso; <para> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-begin-template.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-begin-template.xml diff -u phpdoc/en/reference/ps/functions/ps-begin-template.xml:1.1 phpdoc/en/reference/ps/functions/ps-begin-template.xml:1.2 --- phpdoc/en/reference/ps/functions/ps-begin-template.xml:1.1 Wed Jun 22 13:21:21 2005 +++ phpdoc/en/reference/ps/functions/ps-begin-template.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-begin-template"> <refnamediv> @@ -16,7 +16,45 @@ <methodparam><type>float</type><parameter>height</parameter></methodparam> </methodsynopsis> <para> - Starts a new template. + 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 <function>ps_place_image</function>. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>width</parameter></term> + <listitem> + <para> + The width of the template in pixel. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>height</parameter></term> + <listitem> + <para> + The height of the template in pixel. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> @@ -27,6 +65,50 @@ </para> </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title>Creating and using a template</title> + <programlisting role="php"> +<![CDATA[ +<?php +$ps = ps_new(); + +if (!ps_open_file($ps, "template.ps")) { + print "Cannot open PostScript file\n"; + exit; +} + +ps_set_parameter($ps, "warning", "true"); +ps_set_info($ps, "Creator", "template.php"); +ps_set_info($ps, "Author", "Uwe Steinmann"); +ps_set_info($ps, "Title", "Template example"); + +$pstemplate = ps_begin_template($ps, 30.0, 30.0); +ps_moveto($ps, 0, 0); +ps_lineto($ps, 30, 30); +ps_moveto($ps, 0, 30); +ps_lineto($ps, 30, 0); +ps_stroke($ps); +ps_end_template($ps); + +ps_begin_page($ps, 596, 842); +ps_place_image($ps, $pstemplate, 20.0, 20.0, 1.0); +ps_place_image($ps, $pstemplate, 50.0, 30.0, 0.5); +ps_place_image($ps, $pstemplate, 70.0, 70.0, 0.6); +ps_place_image($ps, $pstemplate, 30.0, 50.0, 1.3); +ps_end_page($ps); + +ps_close($ps); +ps_delete($ps); +?> +]]> + </programlisting> + </example> + </para> + </refsect1> + <refsect1 role="seealso"> &reftitle.seealso; <para> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-circle.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-circle.xml diff -u phpdoc/en/reference/ps/functions/ps-circle.xml:1.2 phpdoc/en/reference/ps/functions/ps-circle.xml:1.3 --- phpdoc/en/reference/ps/functions/ps-circle.xml:1.2 Thu Jul 7 10:12:02 2005 +++ phpdoc/en/reference/ps/functions/ps-circle.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-circle"> <refnamediv> @@ -28,6 +28,47 @@ </para> </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x</parameter></term> + <listitem> + <para> + The x-coordinate of the cicle's middle point. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y</parameter></term> + <listitem> + <para> + The y-coordinate of the cicle's middle point. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>radius</parameter></term> + <listitem> + <para> + The radius of the circle + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-clip.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-clip.xml diff -u phpdoc/en/reference/ps/functions/ps-clip.xml:1.1 phpdoc/en/reference/ps/functions/ps-clip.xml:1.2 --- phpdoc/en/reference/ps/functions/ps-clip.xml:1.1 Wed Jun 22 13:21:21 2005 +++ phpdoc/en/reference/ps/functions/ps-clip.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-clip"> <refnamediv> @@ -15,6 +15,24 @@ </methodsynopsis> <para> 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. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-close-image.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-close-image.xml diff -u phpdoc/en/reference/ps/functions/ps-close-image.xml:1.2 phpdoc/en/reference/ps/functions/ps-close-image.xml:1.3 --- phpdoc/en/reference/ps/functions/ps-close-image.xml:1.2 Fri Jun 24 13:24:33 2005 +++ phpdoc/en/reference/ps/functions/ps-close-image.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-close-image"> <refnamediv> @@ -14,7 +14,37 @@ <methodparam><type>resource</type><parameter>psdoc</parameter></methodparam> <methodparam><type>int</type><parameter>imageid</parameter></methodparam> </methodsynopsis> - &warn.undocumented.func; + <para> + Closes an image and frees its resources. Once an image is closed + it cannot be used anymore. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>imageid</parameter></term> + <listitem> + <para> + Resource identifier of the image as returned by + <function>ps_open_image</function> or + <function>ps_open_image_file</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> </refsect1> <refsect1 role="returnvalues"> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-close.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-close.xml diff -u phpdoc/en/reference/ps/functions/ps-close.xml:1.1 phpdoc/en/reference/ps/functions/ps-close.xml:1.2 --- phpdoc/en/reference/ps/functions/ps-close.xml:1.1 Wed Jun 22 13:21:21 2005 +++ phpdoc/en/reference/ps/functions/ps-close.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-close"> <refnamediv> @@ -17,9 +17,30 @@ Closes the PostScript document. </para> <para> - This function outputs a last line into the PostScript document, which is a - PostScript comment containing the number of pages. It also writes the - bookmark tree. + This function writes the trailor of the PostScript document. + It also writes the bookmark tree. <function>ps_close</function> does + not free any resources, which is done by <function>ps_delete</function>. + </para> + <para> + This function is also called by <function>ps_delete</function> if it + has not been called before. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-closepath-stroke.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-closepath-stroke.xml diff -u phpdoc/en/reference/ps/functions/ps-closepath-stroke.xml:1.1 phpdoc/en/reference/ps/functions/ps-closepath-stroke.xml:1.2 --- phpdoc/en/reference/ps/functions/ps-closepath-stroke.xml:1.1 Wed Jun 22 13:21:21 2005 +++ phpdoc/en/reference/ps/functions/ps-closepath-stroke.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-closepath-stroke"> <refnamediv> @@ -19,6 +19,23 @@ </para> </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-closepath.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-closepath.xml diff -u phpdoc/en/reference/ps/functions/ps-closepath.xml:1.1 phpdoc/en/reference/ps/functions/ps-closepath.xml:1.2 --- phpdoc/en/reference/ps/functions/ps-closepath.xml:1.1 Wed Jun 22 13:21:21 2005 +++ phpdoc/en/reference/ps/functions/ps-closepath.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-closepath"> <refnamediv> @@ -14,7 +14,25 @@ <methodparam><type>resource</type><parameter>psdoc</parameter></methodparam> </methodsynopsis> <para> - Connects the last point with first point of a path. + Connects the last point with the first point of a path. The resulting + path can be used for stroking, filling, clipping, etc.. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-continue-text.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-continue-text.xml diff -u phpdoc/en/reference/ps/functions/ps-continue-text.xml:1.2 phpdoc/en/reference/ps/functions/ps-continue-text.xml:1.3 --- phpdoc/en/reference/ps/functions/ps-continue-text.xml:1.2 Fri Jun 24 13:02:26 2005 +++ phpdoc/en/reference/ps/functions/ps-continue-text.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-continue-text"> <refnamediv> @@ -15,14 +15,39 @@ <methodparam><type>string</type><parameter>text</parameter></methodparam> </methodsynopsis> <para> - Output a text one line below the last outputted line. The line spacing is + Output a text one line below the last line. The line spacing is taken from the value "leading" which must be set with - <function>ps_set_value</function> in points. The actual position of the + <function>ps_set_value</function>. 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 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>text</parameter></term> + <listitem> + <para> + The text to output. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> @@ -35,6 +60,8 @@ <para> <simplelist> <member><function>ps_show</function></member> + <member><function>ps_show_xy</function></member> + <member><function>ps_show_boxed</function></member> </simplelist> </para> </refsect1> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-curveto.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-curveto.xml diff -u phpdoc/en/reference/ps/functions/ps-curveto.xml:1.1 phpdoc/en/reference/ps/functions/ps-curveto.xml:1.2 --- phpdoc/en/reference/ps/functions/ps-curveto.xml:1.1 Wed Jun 22 13:21:21 2005 +++ phpdoc/en/reference/ps/functions/ps-curveto.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-curveto"> <refnamediv> @@ -20,7 +20,73 @@ <methodparam><type>float</type><parameter>y3</parameter></methodparam> </methodsynopsis> <para> - Draws a curve described by the three given points. + Add a section of a cubic Bézier curve described by the three given control + points to the current path. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x1</parameter></term> + <listitem> + <para> + x-coordinate of first control point. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y1</parameter></term> + <listitem> + <para> + y-coordinate of first control point. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x2</parameter></term> + <listitem> + <para> + x-coordinate of second control point. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y2</parameter></term> + <listitem> + <para> + y-coordinate of second control point. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x3</parameter></term> + <listitem> + <para> + x-coordinate of third control point. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y3</parameter></term> + <listitem> + <para> + y-coordinate of third control point. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-delete.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-delete.xml diff -u phpdoc/en/reference/ps/functions/ps-delete.xml:1.2 phpdoc/en/reference/ps/functions/ps-delete.xml:1.3 --- phpdoc/en/reference/ps/functions/ps-delete.xml:1.2 Sun Jul 10 17:08:50 2005 +++ phpdoc/en/reference/ps/functions/ps-delete.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-delete"> <refnamediv> @@ -18,9 +18,25 @@ closed before with <function>ps_close</function>. You should in any case close the file with <function>ps_close</function> before, because <function>ps_close</function> not just closes the file but also outputs a - last line containing the PostScript comment with the number of pages in the - document. Without this comment, a PostScript viewer may not show the number - of pages properly. + trailor containing PostScript comments like the number of pages in the + document and adding the bookmark hierarchy. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-end-page.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-end-page.xml diff -u phpdoc/en/reference/ps/functions/ps-end-page.xml:1.1 phpdoc/en/reference/ps/functions/ps-end-page.xml:1.2 --- phpdoc/en/reference/ps/functions/ps-end-page.xml:1.1 Wed Jun 22 13:21:21 2005 +++ phpdoc/en/reference/ps/functions/ps-end-page.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-end-page"> <refnamediv> @@ -15,6 +15,26 @@ </methodsynopsis> <para> Ends a page which was started with <function>ps_begin_page</function>. + 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.. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-end-pattern.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-end-pattern.xml diff -u phpdoc/en/reference/ps/functions/ps-end-pattern.xml:1.2 phpdoc/en/reference/ps/functions/ps-end-pattern.xml:1.3 --- phpdoc/en/reference/ps/functions/ps-end-pattern.xml:1.2 Sun Jul 10 17:15:34 2005 +++ phpdoc/en/reference/ps/functions/ps-end-pattern.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-end-pattern"> <refnamediv> @@ -15,6 +15,25 @@ </methodsynopsis> <para> Ends a pattern which was started with <function>ps_begin_pattern</function>. + Once a pattern has been ended, it can be used like a color to fill + areas. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-end-template.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-end-template.xml diff -u phpdoc/en/reference/ps/functions/ps-end-template.xml:1.1 phpdoc/en/reference/ps/functions/ps-end-template.xml:1.2 --- phpdoc/en/reference/ps/functions/ps-end-template.xml:1.1 Wed Jun 22 13:21:21 2005 +++ phpdoc/en/reference/ps/functions/ps-end-template.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-end-template"> <refnamediv> @@ -15,6 +15,24 @@ </methodsynopsis> <para> Ends a template which was started with <function>ps_begin_template</function>. + Once a template has been ended, it can be used like an image. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-fill-stroke.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-fill-stroke.xml diff -u phpdoc/en/reference/ps/functions/ps-fill-stroke.xml:1.1 phpdoc/en/reference/ps/functions/ps-fill-stroke.xml:1.2 --- phpdoc/en/reference/ps/functions/ps-fill-stroke.xml:1.1 Wed Jun 22 13:21:21 2005 +++ phpdoc/en/reference/ps/functions/ps-fill-stroke.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-fill-stroke"> <refnamediv> @@ -19,6 +19,23 @@ </para> </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-fill.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-fill.xml diff -u phpdoc/en/reference/ps/functions/ps-fill.xml:1.1 phpdoc/en/reference/ps/functions/ps-fill.xml:1.2 --- phpdoc/en/reference/ps/functions/ps-fill.xml:1.1 Wed Jun 22 13:21:21 2005 +++ phpdoc/en/reference/ps/functions/ps-fill.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-fill"> <refnamediv> @@ -19,6 +19,23 @@ </para> </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-findfont.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-findfont.xml diff -u phpdoc/en/reference/ps/functions/ps-findfont.xml:1.4 phpdoc/en/reference/ps/functions/ps-findfont.xml:1.5 --- phpdoc/en/reference/ps/functions/ps-findfont.xml:1.4 Sun Jul 10 17:28:42 2005 +++ phpdoc/en/reference/ps/functions/ps-findfont.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-findfont"> <refnamediv> @@ -26,6 +26,24 @@ <function>ps_findfont</function> between pages will make that font available for all following pages. </para> + <para> + The name of the afm file must be + <parameter>fontname</parameter><literal>.afm</literal>. If the font + shall be embedded the file + <parameter>fontname</parameter><literal>.pfb</literal> containing + the font outline must be present as well. + </para> + <para> + Calling <function>ps_findfont</function> 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 + of <function>ps_begin_page</function> which now comes after + <function>ps_findfont</function>. Consequently the BoundingBox has not + been set and a warning will be issued when <function>ps_findfont</function> + is called. In order to prevent this situation, one should call + <function>ps_set_parameter</function> to set the BoundingBox before + <function>ps_findfont</function> is called. + </para> </refsect1> <refsect1 role="parameters"> @@ -36,7 +54,8 @@ <term><parameter>psdoc</parameter></term> <listitem> <para> - + Resource identifier of the postscript file + as returned by <function>ps_new</function>. </para> </listitem> </varlistentry> @@ -44,7 +63,7 @@ <term><parameter>fontname</parameter></term> <listitem> <para> - + The name of the font. </para> </listitem> </varlistentry> @@ -74,7 +93,8 @@ <term><parameter>embed</parameter></term> <listitem> <para> - + If set to a value >0 the font will be embedded into the document. This + requires the font outline (.pfb file) to be present. </para> </listitem> </varlistentry> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-get-buffer.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-get-buffer.xml diff -u phpdoc/en/reference/ps/functions/ps-get-buffer.xml:1.2 phpdoc/en/reference/ps/functions/ps-get-buffer.xml:1.3 --- phpdoc/en/reference/ps/functions/ps-get-buffer.xml:1.2 Sun Jul 10 20:13:07 2005 +++ phpdoc/en/reference/ps/functions/ps-get-buffer.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-get-buffer"> <refnamediv> @@ -13,10 +13,33 @@ <type>string</type><methodname>ps_get_buffer</methodname> <methodparam><type>resource</type><parameter>psdoc</parameter></methodparam> </methodsynopsis> - <para>Not yet implemented</para> + <para>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. + </para> &warn.undocumented.func; </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="seealso"> &reftitle.seealso; <para> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-get-parameter.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-get-parameter.xml diff -u phpdoc/en/reference/ps/functions/ps-get-parameter.xml:1.2 phpdoc/en/reference/ps/functions/ps-get-parameter.xml:1.3 --- phpdoc/en/reference/ps/functions/ps-get-parameter.xml:1.2 Sun Jul 10 20:13:07 2005 +++ phpdoc/en/reference/ps/functions/ps-get-parameter.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-get-parameter"> <refnamediv> @@ -16,17 +16,126 @@ <methodparam choice="opt"><type>float</type><parameter>modifier</parameter></methodparam> </methodsynopsis> <para> - Gets several parameters which were set by - <function>ps_set_parameter</function>. Parameters are by definition string + Gets several parameters which were directly set by + <function>ps_set_parameter</function> 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 <function>ps_set_parameter</function>. </para> + <para> + The parameter <parameter>name</parameter> can have the following values. + </para> + <para> + <variablelist> + <varlistentry> + <term><literal>fontname</literal></term> + <listitem> + <para> + The name of the currently active font or the font whose + identifier is passed in parameter <parameter>modifier</parameter>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>fontencoding</literal></term> + <listitem> + <para> + The encoding of the currently active font. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>dottedversion</literal></term> + <listitem> + <para> + The version of the underlying pslib library in the format + <major>.<minor>.<subminor> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>scope</literal></term> + <listitem> + <para> + The current drawing scope. Can be object, document, null, page, + pattern, path, template, prolog, font, glyph. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>ligaturedisolvechar</literal></term> + <listitem> + <para> + The character which disolves a ligature. If your are using a font + which contains the ligature `ff' and `|' is the char to disolve the + ligature, then `f|f' will result in two `f' instead of the ligature `ff'. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>imageencoding</literal></term> + <listitem> + <para> + The encoding used for encoding images. Can be either + <literal>hex</literal> or <literal>85</literal>. hex encoding + uses two bytes in the postscript file each byte in the image. + 85 stand for Ascii85 encoding. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>linenumbermode</literal></term> + <listitem> + <para> + Set to <literal>paragraph</literal> if lines are numbered + within a paragraph or <literal>box</literal> if they are + numbered within the surounding box. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>name</parameter></term> + <listitem> + <para> + Name of the parameter. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>modifier</parameter></term> + <listitem> + <para> + 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. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - Returns the value of the parameter or &false;. + Returns the value of the parameter or &false; in case of an error. </para> </refsect1> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-get-value.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-get-value.xml diff -u phpdoc/en/reference/ps/functions/ps-get-value.xml:1.1 phpdoc/en/reference/ps/functions/ps-get-value.xml:1.2 --- phpdoc/en/reference/ps/functions/ps-get-value.xml:1.1 Wed Jun 22 13:21:22 2005 +++ phpdoc/en/reference/ps/functions/ps-get-value.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-get-value"> <refnamediv> @@ -18,6 +18,237 @@ <para>Gets several values which were set by <function>ps_set_value</function>. Parameters are by definition float values. </para> + <para> + The parameter <parameter>name</parameter> can have the following values. + </para> + <para> + <variablelist> + <varlistentry> + <term><literal>fontsize</literal></term> + <listitem> + <para> + The size of the currently active font or the font whose + identifier is passed in parameter <parameter>modifier</parameter>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>font</literal></term> + <listitem> + <para> + The currently active font itself. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>imagewidth</literal></term> + <listitem> + <para> + The width of the image whose id is passed in the parameter + <parameter>modifier</parameter>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>imageheight</literal></term> + <listitem> + <para> + The height of the image whose id is passed in the parameter + <parameter>modifier</parameter>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>capheight</literal></term> + <listitem> + <para> + The height of a capital M in the currently active font or the font + whose identifier is passed in parameter + <parameter>modifier</parameter>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>ascender</literal></term> + <listitem> + <para> + The ascender of the currently active font or the font + whose identifier is passed in parameter + <parameter>modifier</parameter>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>descender</literal></term> + <listitem> + <para> + The descender of the currently active font or the font + whose identifier is passed in parameter + <parameter>modifier</parameter>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>italicangle</literal></term> + <listitem> + <para> + The italicangle of the currently active font or the font + whose identifier is passed in parameter + <parameter>modifier</parameter>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>underlineposition</literal></term> + <listitem> + <para> + The underlineposition of the currently active font or the font + whose identifier is passed in parameter + <parameter>modifier</parameter>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>underlinethickness</literal></term> + <listitem> + <para> + The underlinethickness of the currently active font or the font + whose identifier is passed in parameter + <parameter>modifier</parameter>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>textx</literal></term> + <listitem> + <para> + The current x-position for text output. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>texty</literal></term> + <listitem> + <para> + The current y-position for text output. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>textrendering</literal></term> + <listitem> + <para> + The current mode for text rendering. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>textrise</literal></term> + <listitem> + <para> + The space by which text is risen above the base line. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>leading</literal></term> + <listitem> + <para> + The distance between text lines in points. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>wordspacing</literal></term> + <listitem> + <para> + The space between words as a multiple of the width of a space char. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>charspacing</literal></term> + <listitem> + <para> + The space between chars. If charspacing is != 0.0 ligatures will + always be disolved. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>hyphenminchars</literal></term> + <listitem> + <para> + Minimum number of chars hyphenated at the end of a word. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>parindent</literal></term> + <listitem> + <para> + Indention of the first n line in a paragraph. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>numindentlines</literal></term> + <listitem> + <para> + Number of line in a paragraph to indent if parindent != 0.0. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>parskip</literal></term> + <listitem> + <para> + Distance between paragraphs. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>linenumberspace</literal></term> + <listitem> + <para> + Overall space in front of each line for the line number. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>linenumbersep</literal></term> + <listitem> + <para> + Space between the line and the line number. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>major</literal></term> + <listitem> + <para> + The major version number of pslib. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>minor</literal></term> + <listitem> + <para> + The minor version number of pslib. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>subminor</literal>, <literal>revision</literal></term> + <listitem> + <para> + The subminor version number of pslib. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> </refsect1> <refsect1 role="parameters"> @@ -28,7 +259,8 @@ <term><parameter>psdoc</parameter></term> <listitem> <para> - + Resource identifier of the postscript file + as returned by <function>ps_new</function>. </para> </listitem> </varlistentry> @@ -36,7 +268,7 @@ <term><parameter>name</parameter></term> <listitem> <para> - + Name of the value. </para> </listitem> </varlistentry> @@ -46,7 +278,7 @@ <para> The parameter <parameter>modifier</parameter> specifies the resource for which the value is to be retrieved. This can be the id of a font or - an image. It must be 0.0 if not used. + an image. </para> </listitem> </varlistentry>
http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-add-bookmark.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-add-bookmark.xml diff -u phpdoc/en/reference/ps/functions/ps-add-bookmark.xml:1.3 phpdoc/en/reference/ps/functions/ps-add-bookmark.xml:1.4 --- phpdoc/en/reference/ps/functions/ps-add-bookmark.xml:1.3 Fri Jun 24 13:02:26 2005 +++ phpdoc/en/reference/ps/functions/ps-add-bookmark.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-add-bookmark"> <refnamediv> @@ -22,7 +22,7 @@ bookmark will jump to the given page. </para> <para> - The bookmark has no meaning if the document is printed or viewed but it + 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> @@ -36,7 +36,8 @@ <term><parameter>psdoc</parameter></term> <listitem> <para> - + Resource identifier of the postscript file + as returned by <function>ps_new</function>. </para> </listitem> </varlistentry> @@ -44,7 +45,7 @@ <term><parameter>text</parameter></term> <listitem> <para> - + The text used for displaying the bookmark. </para> </listitem> </varlistentry> @@ -74,11 +75,9 @@ &reftitle.returnvalues; <para> The returned value is a reference for the bookmark. It is only used if - the bookmark shall be used as a parent. - </para> - <para> - Returns the identifier of the bookmark or zero in case of an error. The - identifier is a positive number. + 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. </para> </refsect1> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-add-launchlink.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-add-launchlink.xml diff -u phpdoc/en/reference/ps/functions/ps-add-launchlink.xml:1.1 phpdoc/en/reference/ps/functions/ps-add-launchlink.xml:1.2 --- phpdoc/en/reference/ps/functions/ps-add-launchlink.xml:1.1 Wed Jun 22 13:21:21 2005 +++ phpdoc/en/reference/ps/functions/ps-add-launchlink.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-add-launchlink"> <refnamediv> @@ -31,7 +31,6 @@ </para> </refsect1> -<!-- <refsect1 role="parameters"> &reftitle.parameters; <para> @@ -40,7 +39,8 @@ <term><parameter>psdoc</parameter></term> <listitem> <para> - Its description + Resource identifier of the postscript file + as returned by <function>ps_new</function>. </para> </listitem> </varlistentry> @@ -48,7 +48,7 @@ <term><parameter>llx</parameter></term> <listitem> <para> - Its description + The x-koordinate of the lower left corner. </para> </listitem> </varlistentry> @@ -56,7 +56,7 @@ <term><parameter>lly</parameter></term> <listitem> <para> - Its description + The y-koordinate of the lower left corner. </para> </listitem> </varlistentry> @@ -64,7 +64,7 @@ <term><parameter>urx</parameter></term> <listitem> <para> - Its description + The x-koordinate of the upper right corner. </para> </listitem> </varlistentry> @@ -72,7 +72,7 @@ <term><parameter>ury</parameter></term> <listitem> <para> - Its description + The y-koordinate of the upper right corner. </para> </listitem> </varlistentry> @@ -80,14 +80,14 @@ <term><parameter>filename</parameter></term> <listitem> <para> - Its description + The path of the program to be started, when the link is clicked on. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> ---> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-add-locallink.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-add-locallink.xml diff -u phpdoc/en/reference/ps/functions/ps-add-locallink.xml:1.1 phpdoc/en/reference/ps/functions/ps-add-locallink.xml:1.2 --- phpdoc/en/reference/ps/functions/ps-add-locallink.xml:1.1 Wed Jun 22 13:21:21 2005 +++ phpdoc/en/reference/ps/functions/ps-add-locallink.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-add-locallink"> <refnamediv> @@ -45,7 +45,8 @@ <term><parameter>psdoc</parameter></term> <listitem> <para> - + Resource identifier of the postscript file + as returned by <function>ps_new</function>. </para> </listitem> </varlistentry> @@ -53,7 +54,7 @@ <term><parameter>llx</parameter></term> <listitem> <para> - + The x-koordinate of the lower left corner. </para> </listitem> </varlistentry> @@ -61,7 +62,7 @@ <term><parameter>lly</parameter></term> <listitem> <para> - + The y-koordinate of the lower left corner. </para> </listitem> </varlistentry> @@ -69,7 +70,7 @@ <term><parameter>urx</parameter></term> <listitem> <para> - + The x-koordinate of the upper right corner. </para> </listitem> </varlistentry> @@ -77,7 +78,7 @@ <term><parameter>ury</parameter></term> <listitem> <para> - + The y-koordinate of the upper right corner. </para> </listitem> </varlistentry> @@ -85,7 +86,7 @@ <term><parameter>page</parameter></term> <listitem> <para> - + The number of the page displayed when clicking on the link. </para> </listitem> </varlistentry> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-add-note.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-add-note.xml diff -u phpdoc/en/reference/ps/functions/ps-add-note.xml:1.2 phpdoc/en/reference/ps/functions/ps-add-note.xml:1.3 --- phpdoc/en/reference/ps/functions/ps-add-note.xml:1.2 Wed Jun 22 13:57:20 2005 +++ phpdoc/en/reference/ps/functions/ps-add-note.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-add-note"> <refnamediv> @@ -20,9 +20,106 @@ <methodparam><type>string</type><parameter>title</parameter></methodparam> <methodparam><type>string</type><parameter>icon</parameter></methodparam> <methodparam><type>int</type><parameter>open</parameter></methodparam> - </methodsynopsis> - &warn.undocumented.func; - </refsect1> + </methodsynopsis> + <para> + Adds a note at a certain position on the page. Notes are like little + rectangular sheets with text on it, which can be place somewhere on + a page. The + are shown either folded or unfolded. If unfolded the specified icon + is used as placeholder. + </para> + <para> + The note 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> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>llx</parameter></term> + <listitem> + <para> + The x-coordinate of the lower left corner. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>lly</parameter></term> + <listitem> + <para> + The y-coordinate of the lower left corner. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>urx</parameter></term> + <listitem> + <para> + The x-coordinate of the upper right corner. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>ury</parameter></term> + <listitem> + <para> + The y-coordinate of the upper right corner. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>contents</parameter></term> + <listitem> + <para> + The text of the note. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>title</parameter></term> + <listitem> + <para> + The title of the note as displayed in the header of the note. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>icon</parameter></term> + <listitem> + <para> + The icon shown if the note is folded. This parameter can be set + to <literal>comment</literal>, <literal>insert</literal>, + <literal>note</literal>, <literal>paragraph</literal>, + <literal>newparagraph</literal>, <literal>key</literal>, or + <literal>help</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>open</parameter></term> + <listitem> + <para> + If <parameter>open</parameter> is unequal to zero the note will + be shown unfolded by the pdf viewer. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; @@ -36,6 +133,9 @@ <para> <simplelist> <member><function>ps_add_pdflink</function></member> + <member><function>ps_add_launchlink</function></member> + <member><function>ps_add_locallink</function></member> + <member><function>ps_add_weblink</function></member> </simplelist> </para> </refsect1> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-add-pdflink.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-add-pdflink.xml diff -u phpdoc/en/reference/ps/functions/ps-add-pdflink.xml:1.2 phpdoc/en/reference/ps/functions/ps-add-pdflink.xml:1.3 --- phpdoc/en/reference/ps/functions/ps-add-pdflink.xml:1.2 Mon Jul 4 04:14:33 2005 +++ phpdoc/en/reference/ps/functions/ps-add-pdflink.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-add-pdflink"> <refnamediv> @@ -36,7 +36,7 @@ it will show up if the document is converted to pdf by either Acrobat Distiller™ or Ghostview. </para> - </refsect1> + </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -46,7 +46,8 @@ <term><parameter>psdoc</parameter></term> <listitem> <para> - + Resource identifier of the postscript file + as returned by <function>ps_new</function>. </para> </listitem> </varlistentry> @@ -54,7 +55,7 @@ <term><parameter>llx</parameter></term> <listitem> <para> - + The x-coordinate of the lower left corner. </para> </listitem> </varlistentry> @@ -62,7 +63,7 @@ <term><parameter>lly</parameter></term> <listitem> <para> - + The y-coordinate of the lower left corner. </para> </listitem> </varlistentry> @@ -70,7 +71,7 @@ <term><parameter>urx</parameter></term> <listitem> <para> - + The x-coordinate of the upper right corner. </para> </listitem> </varlistentry> @@ -78,7 +79,7 @@ <term><parameter>ury</parameter></term> <listitem> <para> - + The y-coordinate of the upper right corner. </para> </listitem> </varlistentry> @@ -86,7 +87,8 @@ <term><parameter>filename</parameter></term> <listitem> <para> - + The name of the pdf document to be opened when clicking on + this link. </para> </listitem> </varlistentry> @@ -94,7 +96,7 @@ <term><parameter>page</parameter></term> <listitem> <para> - + The page number of the destination pdf document </para> </listitem> </varlistentry> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-add-weblink.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-add-weblink.xml diff -u phpdoc/en/reference/ps/functions/ps-add-weblink.xml:1.1 phpdoc/en/reference/ps/functions/ps-add-weblink.xml:1.2 --- phpdoc/en/reference/ps/functions/ps-add-weblink.xml:1.1 Wed Jun 22 13:21:21 2005 +++ phpdoc/en/reference/ps/functions/ps-add-weblink.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-add-weblink"> <refnamediv> @@ -20,8 +20,10 @@ </methodsynopsis> <para> Places a hyperlink at the given position pointing to a web page. 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 + 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> @@ -31,7 +33,6 @@ </para> </refsect1> -<!-- <refsect1 role="parameters"> &reftitle.parameters; <para> @@ -40,7 +41,8 @@ <term><parameter>psdoc</parameter></term> <listitem> <para> - + Resource identifier of the postscript file + as returned by <function>ps_new</function>. </para> </listitem> </varlistentry> @@ -48,7 +50,7 @@ <term><parameter>llx</parameter></term> <listitem> <para> - + The x-coordinate of the lower left corner. </para> </listitem> </varlistentry> @@ -56,7 +58,7 @@ <term><parameter>lly</parameter></term> <listitem> <para> - + The y-coordinate of the lower left corner. </para> </listitem> </varlistentry> @@ -64,7 +66,7 @@ <term><parameter>urx</parameter></term> <listitem> <para> - + The x-coordinate of the upper right corner. </para> </listitem> </varlistentry> @@ -72,7 +74,7 @@ <term><parameter>ury</parameter></term> <listitem> <para> - + The y-coordinate of the upper right corner. </para> </listitem> </varlistentry> @@ -80,14 +82,14 @@ <term><parameter>url</parameter></term> <listitem> <para> - + The url of the hyperlink to be opened when clicking on + this link. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> ---> <refsect1 role="returnvalues"> &reftitle.returnvalues; http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-arc.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-arc.xml diff -u phpdoc/en/reference/ps/functions/ps-arc.xml:1.2 phpdoc/en/reference/ps/functions/ps-arc.xml:1.3 --- phpdoc/en/reference/ps/functions/ps-arc.xml:1.2 Mon Jul 4 04:24:25 2005 +++ phpdoc/en/reference/ps/functions/ps-arc.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-arc"> <refnamediv> @@ -28,6 +28,63 @@ </para> </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x</parameter></term> + <listitem> + <para> + The x-coordinate of the cicle's middle point. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y</parameter></term> + <listitem> + <para> + The y-coordinate of the cicle's middle point. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>radius</parameter></term> + <listitem> + <para> + The radius of the circle + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>alpha</parameter></term> + <listitem> + <para> + The starting angle given in degrees. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>beta</parameter></term> + <listitem> + <para> + The end angle given in degrees. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-arcn.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-arcn.xml diff -u phpdoc/en/reference/ps/functions/ps-arcn.xml:1.2 phpdoc/en/reference/ps/functions/ps-arcn.xml:1.3 --- phpdoc/en/reference/ps/functions/ps-arcn.xml:1.2 Mon Jul 4 04:24:25 2005 +++ phpdoc/en/reference/ps/functions/ps-arcn.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-arcn"> <refnamediv> @@ -28,6 +28,63 @@ </para> </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x</parameter></term> + <listitem> + <para> + The x-coordinate of the cicle's middle point. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y</parameter></term> + <listitem> + <para> + The y-coordinate of the cicle's middle point. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>radius</parameter></term> + <listitem> + <para> + The radius of the circle + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>alpha</parameter></term> + <listitem> + <para> + The starting angle given in degrees. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>beta</parameter></term> + <listitem> + <para> + The end angle given in degrees. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-begin-page.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-begin-page.xml diff -u phpdoc/en/reference/ps/functions/ps-begin-page.xml:1.2 phpdoc/en/reference/ps/functions/ps-begin-page.xml:1.3 --- phpdoc/en/reference/ps/functions/ps-begin-page.xml:1.2 Thu Jul 7 10:12:01 2005 +++ phpdoc/en/reference/ps/functions/ps-begin-page.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-begin-page"> <refnamediv> @@ -34,8 +34,9 @@ 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 + the first page. If <function>ps_findfont</function> was called before, then + the + header has been output already, and the document will not have a valid bounding box. In order to prevent this, one should call <function>ps_set_info</function> to set the info field <literal>BoundingBox</literal> and possibly <literal>Orientation</literal> @@ -44,6 +45,39 @@ </para> </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>width</parameter></term> + <listitem> + <para> + The width of the page in pixel, e.g. 596 for A4 format. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>height</parameter></term> + <listitem> + <para> + The height of the page in pixel, e.g. 842 for A4 format. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-begin-pattern.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-begin-pattern.xml diff -u phpdoc/en/reference/ps/functions/ps-begin-pattern.xml:1.3 phpdoc/en/reference/ps/functions/ps-begin-pattern.xml:1.4 --- phpdoc/en/reference/ps/functions/ps-begin-pattern.xml:1.3 Fri Jun 24 09:11:45 2005 +++ phpdoc/en/reference/ps/functions/ps-begin-pattern.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-begin-pattern"> <refnamediv> @@ -19,7 +19,69 @@ <methodparam><type>int</type><parameter>painttype</parameter></methodparam> </methodsynopsis> <para> - Starts a new pattern. + 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 + <function>ps_setcolor</function> and setting the color space to + <literal>pattern</literal>. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>width</parameter></term> + <listitem> + <para> + The width of the pattern in pixel. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>height</parameter></term> + <listitem> + <para> + The height of the pattern in pixel. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x-step</parameter></term> + <listitem> + <para> + The distance in pixel of placements of the pattern in + horizontal direction. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y-step</parameter></term> + <listitem> + <para> + The distance in pixel of placements of the pattern in + vertical direction. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>painttype</parameter></term> + <listitem> + <para> + Must be 1 or 2. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> @@ -30,6 +92,53 @@ </para> </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title>Creating and using a pattern</title> + <programlisting role="php"> +<![CDATA[ +<?php +$ps = ps_new(); + +if (!ps_open_file($ps, "pattern.ps")) { + print "Cannot open PostScript file\n"; + exit; +} + +ps_set_parameter($ps, "warning", "true"); +ps_set_info($ps, "Creator", "pattern.php"); +ps_set_info($ps, "Author", "Uwe Steinmann"); +ps_set_info($ps, "Title", "Pattern example"); + + +$pspattern = ps_begin_pattern($ps, 10.0, 10.0, 10.0, 10.0, 1); +ps_setlinewidth($ps, 0.2); +ps_setcolor($ps, "stroke", "rgb", 0.0, 0.0, 1.0, 0.0); +ps_moveto($ps, 0, 0); +ps_lineto($ps, 7, 7); +ps_stroke($ps); +ps_moveto($ps, 0, 7); +ps_lineto($ps, 7, 0); +ps_stroke($ps); +ps_end_pattern($ps); + +ps_begin_page($ps, 596, 842); +ps_setcolor($ps, "both", "pattern", $pspattern, 0.0, 0.0, 0.0); +ps_rect($ps, 50, 400, 200, 200); +ps_fill($ps); +ps_end_page($ps); + +ps_close($ps); +ps_delete($ps); +?> +]]> + </programlisting> + </example> + </para> + </refsect1> + <refsect1 role="seealso"> &reftitle.seealso; <para> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-begin-template.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-begin-template.xml diff -u phpdoc/en/reference/ps/functions/ps-begin-template.xml:1.1 phpdoc/en/reference/ps/functions/ps-begin-template.xml:1.2 --- phpdoc/en/reference/ps/functions/ps-begin-template.xml:1.1 Wed Jun 22 13:21:21 2005 +++ phpdoc/en/reference/ps/functions/ps-begin-template.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-begin-template"> <refnamediv> @@ -16,7 +16,45 @@ <methodparam><type>float</type><parameter>height</parameter></methodparam> </methodsynopsis> <para> - Starts a new template. + 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 <function>ps_place_image</function>. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>width</parameter></term> + <listitem> + <para> + The width of the template in pixel. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>height</parameter></term> + <listitem> + <para> + The height of the template in pixel. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> @@ -27,6 +65,50 @@ </para> </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title>Creating and using a template</title> + <programlisting role="php"> +<![CDATA[ +<?php +$ps = ps_new(); + +if (!ps_open_file($ps, "template.ps")) { + print "Cannot open PostScript file\n"; + exit; +} + +ps_set_parameter($ps, "warning", "true"); +ps_set_info($ps, "Creator", "template.php"); +ps_set_info($ps, "Author", "Uwe Steinmann"); +ps_set_info($ps, "Title", "Template example"); + +$pstemplate = ps_begin_template($ps, 30.0, 30.0); +ps_moveto($ps, 0, 0); +ps_lineto($ps, 30, 30); +ps_moveto($ps, 0, 30); +ps_lineto($ps, 30, 0); +ps_stroke($ps); +ps_end_template($ps); + +ps_begin_page($ps, 596, 842); +ps_place_image($ps, $pstemplate, 20.0, 20.0, 1.0); +ps_place_image($ps, $pstemplate, 50.0, 30.0, 0.5); +ps_place_image($ps, $pstemplate, 70.0, 70.0, 0.6); +ps_place_image($ps, $pstemplate, 30.0, 50.0, 1.3); +ps_end_page($ps); + +ps_close($ps); +ps_delete($ps); +?> +]]> + </programlisting> + </example> + </para> + </refsect1> + <refsect1 role="seealso"> &reftitle.seealso; <para> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-circle.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-circle.xml diff -u phpdoc/en/reference/ps/functions/ps-circle.xml:1.2 phpdoc/en/reference/ps/functions/ps-circle.xml:1.3 --- phpdoc/en/reference/ps/functions/ps-circle.xml:1.2 Thu Jul 7 10:12:02 2005 +++ phpdoc/en/reference/ps/functions/ps-circle.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-circle"> <refnamediv> @@ -28,6 +28,47 @@ </para> </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x</parameter></term> + <listitem> + <para> + The x-coordinate of the cicle's middle point. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y</parameter></term> + <listitem> + <para> + The y-coordinate of the cicle's middle point. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>radius</parameter></term> + <listitem> + <para> + The radius of the circle + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-clip.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-clip.xml diff -u phpdoc/en/reference/ps/functions/ps-clip.xml:1.1 phpdoc/en/reference/ps/functions/ps-clip.xml:1.2 --- phpdoc/en/reference/ps/functions/ps-clip.xml:1.1 Wed Jun 22 13:21:21 2005 +++ phpdoc/en/reference/ps/functions/ps-clip.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-clip"> <refnamediv> @@ -15,6 +15,24 @@ </methodsynopsis> <para> 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. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-close-image.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-close-image.xml diff -u phpdoc/en/reference/ps/functions/ps-close-image.xml:1.2 phpdoc/en/reference/ps/functions/ps-close-image.xml:1.3 --- phpdoc/en/reference/ps/functions/ps-close-image.xml:1.2 Fri Jun 24 13:24:33 2005 +++ phpdoc/en/reference/ps/functions/ps-close-image.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-close-image"> <refnamediv> @@ -14,7 +14,37 @@ <methodparam><type>resource</type><parameter>psdoc</parameter></methodparam> <methodparam><type>int</type><parameter>imageid</parameter></methodparam> </methodsynopsis> - &warn.undocumented.func; + <para> + Closes an image and frees its resources. Once an image is closed + it cannot be used anymore. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>imageid</parameter></term> + <listitem> + <para> + Resource identifier of the image as returned by + <function>ps_open_image</function> or + <function>ps_open_image_file</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> </refsect1> <refsect1 role="returnvalues"> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-close.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-close.xml diff -u phpdoc/en/reference/ps/functions/ps-close.xml:1.1 phpdoc/en/reference/ps/functions/ps-close.xml:1.2 --- phpdoc/en/reference/ps/functions/ps-close.xml:1.1 Wed Jun 22 13:21:21 2005 +++ phpdoc/en/reference/ps/functions/ps-close.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-close"> <refnamediv> @@ -17,9 +17,30 @@ Closes the PostScript document. </para> <para> - This function outputs a last line into the PostScript document, which is a - PostScript comment containing the number of pages. It also writes the - bookmark tree. + This function writes the trailor of the PostScript document. + It also writes the bookmark tree. <function>ps_close</function> does + not free any resources, which is done by <function>ps_delete</function>. + </para> + <para> + This function is also called by <function>ps_delete</function> if it + has not been called before. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-closepath-stroke.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-closepath-stroke.xml diff -u phpdoc/en/reference/ps/functions/ps-closepath-stroke.xml:1.1 phpdoc/en/reference/ps/functions/ps-closepath-stroke.xml:1.2 --- phpdoc/en/reference/ps/functions/ps-closepath-stroke.xml:1.1 Wed Jun 22 13:21:21 2005 +++ phpdoc/en/reference/ps/functions/ps-closepath-stroke.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-closepath-stroke"> <refnamediv> @@ -19,6 +19,23 @@ </para> </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-closepath.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-closepath.xml diff -u phpdoc/en/reference/ps/functions/ps-closepath.xml:1.1 phpdoc/en/reference/ps/functions/ps-closepath.xml:1.2 --- phpdoc/en/reference/ps/functions/ps-closepath.xml:1.1 Wed Jun 22 13:21:21 2005 +++ phpdoc/en/reference/ps/functions/ps-closepath.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-closepath"> <refnamediv> @@ -14,7 +14,25 @@ <methodparam><type>resource</type><parameter>psdoc</parameter></methodparam> </methodsynopsis> <para> - Connects the last point with first point of a path. + Connects the last point with the first point of a path. The resulting + path can be used for stroking, filling, clipping, etc.. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-continue-text.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-continue-text.xml diff -u phpdoc/en/reference/ps/functions/ps-continue-text.xml:1.2 phpdoc/en/reference/ps/functions/ps-continue-text.xml:1.3 --- phpdoc/en/reference/ps/functions/ps-continue-text.xml:1.2 Fri Jun 24 13:02:26 2005 +++ phpdoc/en/reference/ps/functions/ps-continue-text.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-continue-text"> <refnamediv> @@ -15,14 +15,39 @@ <methodparam><type>string</type><parameter>text</parameter></methodparam> </methodsynopsis> <para> - Output a text one line below the last outputted line. The line spacing is + Output a text one line below the last line. The line spacing is taken from the value "leading" which must be set with - <function>ps_set_value</function> in points. The actual position of the + <function>ps_set_value</function>. 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 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>text</parameter></term> + <listitem> + <para> + The text to output. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> @@ -35,6 +60,8 @@ <para> <simplelist> <member><function>ps_show</function></member> + <member><function>ps_show_xy</function></member> + <member><function>ps_show_boxed</function></member> </simplelist> </para> </refsect1> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-curveto.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-curveto.xml diff -u phpdoc/en/reference/ps/functions/ps-curveto.xml:1.1 phpdoc/en/reference/ps/functions/ps-curveto.xml:1.2 --- phpdoc/en/reference/ps/functions/ps-curveto.xml:1.1 Wed Jun 22 13:21:21 2005 +++ phpdoc/en/reference/ps/functions/ps-curveto.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-curveto"> <refnamediv> @@ -20,7 +20,73 @@ <methodparam><type>float</type><parameter>y3</parameter></methodparam> </methodsynopsis> <para> - Draws a curve described by the three given points. + Add a section of a cubic Bézier curve described by the three given control + points to the current path. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x1</parameter></term> + <listitem> + <para> + x-coordinate of first control point. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y1</parameter></term> + <listitem> + <para> + y-coordinate of first control point. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x2</parameter></term> + <listitem> + <para> + x-coordinate of second control point. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y2</parameter></term> + <listitem> + <para> + y-coordinate of second control point. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x3</parameter></term> + <listitem> + <para> + x-coordinate of third control point. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y3</parameter></term> + <listitem> + <para> + y-coordinate of third control point. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-delete.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-delete.xml diff -u phpdoc/en/reference/ps/functions/ps-delete.xml:1.2 phpdoc/en/reference/ps/functions/ps-delete.xml:1.3 --- phpdoc/en/reference/ps/functions/ps-delete.xml:1.2 Sun Jul 10 17:08:50 2005 +++ phpdoc/en/reference/ps/functions/ps-delete.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-delete"> <refnamediv> @@ -18,9 +18,25 @@ closed before with <function>ps_close</function>. You should in any case close the file with <function>ps_close</function> before, because <function>ps_close</function> not just closes the file but also outputs a - last line containing the PostScript comment with the number of pages in the - document. Without this comment, a PostScript viewer may not show the number - of pages properly. + trailor containing PostScript comments like the number of pages in the + document and adding the bookmark hierarchy. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-end-page.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-end-page.xml diff -u phpdoc/en/reference/ps/functions/ps-end-page.xml:1.1 phpdoc/en/reference/ps/functions/ps-end-page.xml:1.2 --- phpdoc/en/reference/ps/functions/ps-end-page.xml:1.1 Wed Jun 22 13:21:21 2005 +++ phpdoc/en/reference/ps/functions/ps-end-page.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-end-page"> <refnamediv> @@ -15,6 +15,26 @@ </methodsynopsis> <para> Ends a page which was started with <function>ps_begin_page</function>. + 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.. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-end-pattern.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-end-pattern.xml diff -u phpdoc/en/reference/ps/functions/ps-end-pattern.xml:1.2 phpdoc/en/reference/ps/functions/ps-end-pattern.xml:1.3 --- phpdoc/en/reference/ps/functions/ps-end-pattern.xml:1.2 Sun Jul 10 17:15:34 2005 +++ phpdoc/en/reference/ps/functions/ps-end-pattern.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-end-pattern"> <refnamediv> @@ -15,6 +15,25 @@ </methodsynopsis> <para> Ends a pattern which was started with <function>ps_begin_pattern</function>. + Once a pattern has been ended, it can be used like a color to fill + areas. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-end-template.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-end-template.xml diff -u phpdoc/en/reference/ps/functions/ps-end-template.xml:1.1 phpdoc/en/reference/ps/functions/ps-end-template.xml:1.2 --- phpdoc/en/reference/ps/functions/ps-end-template.xml:1.1 Wed Jun 22 13:21:21 2005 +++ phpdoc/en/reference/ps/functions/ps-end-template.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-end-template"> <refnamediv> @@ -15,6 +15,24 @@ </methodsynopsis> <para> Ends a template which was started with <function>ps_begin_template</function>. + Once a template has been ended, it can be used like an image. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-fill-stroke.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-fill-stroke.xml diff -u phpdoc/en/reference/ps/functions/ps-fill-stroke.xml:1.1 phpdoc/en/reference/ps/functions/ps-fill-stroke.xml:1.2 --- phpdoc/en/reference/ps/functions/ps-fill-stroke.xml:1.1 Wed Jun 22 13:21:21 2005 +++ phpdoc/en/reference/ps/functions/ps-fill-stroke.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-fill-stroke"> <refnamediv> @@ -19,6 +19,23 @@ </para> </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-fill.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-fill.xml diff -u phpdoc/en/reference/ps/functions/ps-fill.xml:1.1 phpdoc/en/reference/ps/functions/ps-fill.xml:1.2 --- phpdoc/en/reference/ps/functions/ps-fill.xml:1.1 Wed Jun 22 13:21:21 2005 +++ phpdoc/en/reference/ps/functions/ps-fill.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-fill"> <refnamediv> @@ -19,6 +19,23 @@ </para> </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-findfont.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-findfont.xml diff -u phpdoc/en/reference/ps/functions/ps-findfont.xml:1.4 phpdoc/en/reference/ps/functions/ps-findfont.xml:1.5 --- phpdoc/en/reference/ps/functions/ps-findfont.xml:1.4 Sun Jul 10 17:28:42 2005 +++ phpdoc/en/reference/ps/functions/ps-findfont.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-findfont"> <refnamediv> @@ -26,6 +26,24 @@ <function>ps_findfont</function> between pages will make that font available for all following pages. </para> + <para> + The name of the afm file must be + <parameter>fontname</parameter><literal>.afm</literal>. If the font + shall be embedded the file + <parameter>fontname</parameter><literal>.pfb</literal> containing + the font outline must be present as well. + </para> + <para> + Calling <function>ps_findfont</function> 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 + of <function>ps_begin_page</function> which now comes after + <function>ps_findfont</function>. Consequently the BoundingBox has not + been set and a warning will be issued when <function>ps_findfont</function> + is called. In order to prevent this situation, one should call + <function>ps_set_parameter</function> to set the BoundingBox before + <function>ps_findfont</function> is called. + </para> </refsect1> <refsect1 role="parameters"> @@ -36,7 +54,8 @@ <term><parameter>psdoc</parameter></term> <listitem> <para> - + Resource identifier of the postscript file + as returned by <function>ps_new</function>. </para> </listitem> </varlistentry> @@ -44,7 +63,7 @@ <term><parameter>fontname</parameter></term> <listitem> <para> - + The name of the font. </para> </listitem> </varlistentry> @@ -74,7 +93,8 @@ <term><parameter>embed</parameter></term> <listitem> <para> - + If set to a value >0 the font will be embedded into the document. This + requires the font outline (.pfb file) to be present. </para> </listitem> </varlistentry> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-get-buffer.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-get-buffer.xml diff -u phpdoc/en/reference/ps/functions/ps-get-buffer.xml:1.2 phpdoc/en/reference/ps/functions/ps-get-buffer.xml:1.3 --- phpdoc/en/reference/ps/functions/ps-get-buffer.xml:1.2 Sun Jul 10 20:13:07 2005 +++ phpdoc/en/reference/ps/functions/ps-get-buffer.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-get-buffer"> <refnamediv> @@ -13,10 +13,33 @@ <type>string</type><methodname>ps_get_buffer</methodname> <methodparam><type>resource</type><parameter>psdoc</parameter></methodparam> </methodsynopsis> - <para>Not yet implemented</para> + <para>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. + </para> &warn.undocumented.func; </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="seealso"> &reftitle.seealso; <para> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-get-parameter.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-get-parameter.xml diff -u phpdoc/en/reference/ps/functions/ps-get-parameter.xml:1.2 phpdoc/en/reference/ps/functions/ps-get-parameter.xml:1.3 --- phpdoc/en/reference/ps/functions/ps-get-parameter.xml:1.2 Sun Jul 10 20:13:07 2005 +++ phpdoc/en/reference/ps/functions/ps-get-parameter.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-get-parameter"> <refnamediv> @@ -16,17 +16,126 @@ <methodparam choice="opt"><type>float</type><parameter>modifier</parameter></methodparam> </methodsynopsis> <para> - Gets several parameters which were set by - <function>ps_set_parameter</function>. Parameters are by definition string + Gets several parameters which were directly set by + <function>ps_set_parameter</function> 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 <function>ps_set_parameter</function>. </para> + <para> + The parameter <parameter>name</parameter> can have the following values. + </para> + <para> + <variablelist> + <varlistentry> + <term><literal>fontname</literal></term> + <listitem> + <para> + The name of the currently active font or the font whose + identifier is passed in parameter <parameter>modifier</parameter>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>fontencoding</literal></term> + <listitem> + <para> + The encoding of the currently active font. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>dottedversion</literal></term> + <listitem> + <para> + The version of the underlying pslib library in the format + <major>.<minor>.<subminor> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>scope</literal></term> + <listitem> + <para> + The current drawing scope. Can be object, document, null, page, + pattern, path, template, prolog, font, glyph. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>ligaturedisolvechar</literal></term> + <listitem> + <para> + The character which disolves a ligature. If your are using a font + which contains the ligature `ff' and `|' is the char to disolve the + ligature, then `f|f' will result in two `f' instead of the ligature `ff'. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>imageencoding</literal></term> + <listitem> + <para> + The encoding used for encoding images. Can be either + <literal>hex</literal> or <literal>85</literal>. hex encoding + uses two bytes in the postscript file each byte in the image. + 85 stand for Ascii85 encoding. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>linenumbermode</literal></term> + <listitem> + <para> + Set to <literal>paragraph</literal> if lines are numbered + within a paragraph or <literal>box</literal> if they are + numbered within the surounding box. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>psdoc</parameter></term> + <listitem> + <para> + Resource identifier of the postscript file + as returned by <function>ps_new</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>name</parameter></term> + <listitem> + <para> + Name of the parameter. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>modifier</parameter></term> + <listitem> + <para> + 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. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - Returns the value of the parameter or &false;. + Returns the value of the parameter or &false; in case of an error. </para> </refsect1> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/ps/functions/ps-get-value.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/ps/functions/ps-get-value.xml diff -u phpdoc/en/reference/ps/functions/ps-get-value.xml:1.1 phpdoc/en/reference/ps/functions/ps-get-value.xml:1.2 --- phpdoc/en/reference/ps/functions/ps-get-value.xml:1.1 Wed Jun 22 13:21:22 2005 +++ phpdoc/en/reference/ps/functions/ps-get-value.xml Wed Mar 1 07:42:13 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 --> <refentry id="function.ps-get-value"> <refnamediv> @@ -18,6 +18,237 @@ <para>Gets several values which were set by <function>ps_set_value</function>. Parameters are by definition float values. </para> + <para> + The parameter <parameter>name</parameter> can have the following values. + </para> + <para> + <variablelist> + <varlistentry> + <term><literal>fontsize</literal></term> + <listitem> + <para> + The size of the currently active font or the font whose + identifier is passed in parameter <parameter>modifier</parameter>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>font</literal></term> + <listitem> + <para> + The currently active font itself. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>imagewidth</literal></term> + <listitem> + <para> + The width of the image whose id is passed in the parameter + <parameter>modifier</parameter>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>imageheight</literal></term> + <listitem> + <para> + The height of the image whose id is passed in the parameter + <parameter>modifier</parameter>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>capheight</literal></term> + <listitem> + <para> + The height of a capital M in the currently active font or the font + whose identifier is passed in parameter + <parameter>modifier</parameter>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>ascender</literal></term> + <listitem> + <para> + The ascender of the currently active font or the font + whose identifier is passed in parameter + <parameter>modifier</parameter>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>descender</literal></term> + <listitem> + <para> + The descender of the currently active font or the font + whose identifier is passed in parameter + <parameter>modifier</parameter>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>italicangle</literal></term> + <listitem> + <para> + The italicangle of the currently active font or the font + whose identifier is passed in parameter + <parameter>modifier</parameter>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>underlineposition</literal></term> + <listitem> + <para> + The underlineposition of the currently active font or the font + whose identifier is passed in parameter + <parameter>modifier</parameter>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>underlinethickness</literal></term> + <listitem> + <para> + The underlinethickness of the currently active font or the font + whose identifier is passed in parameter + <parameter>modifier</parameter>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>textx</literal></term> + <listitem> + <para> + The current x-position for text output. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>texty</literal></term> + <listitem> + <para> + The current y-position for text output. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>textrendering</literal></term> + <listitem> + <para> + The current mode for text rendering. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>textrise</literal></term> + <listitem> + <para> + The space by which text is risen above the base line. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>leading</literal></term> + <listitem> + <para> + The distance between text lines in points. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>wordspacing</literal></term> + <listitem> + <para> + The space between words as a multiple of the width of a space char. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>charspacing</literal></term> + <listitem> + <para> + The space between chars. If charspacing is != 0.0 ligatures will + always be disolved. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>hyphenminchars</literal></term> + <listitem> + <para> + Minimum number of chars hyphenated at the end of a word. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>parindent</literal></term> + <listitem> + <para> + Indention of the first n line in a paragraph. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>numindentlines</literal></term> + <listitem> + <para> + Number of line in a paragraph to indent if parindent != 0.0. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>parskip</literal></term> + <listitem> + <para> + Distance between paragraphs. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>linenumberspace</literal></term> + <listitem> + <para> + Overall space in front of each line for the line number. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>linenumbersep</literal></term> + <listitem> + <para> + Space between the line and the line number. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>major</literal></term> + <listitem> + <para> + The major version number of pslib. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>minor</literal></term> + <listitem> + <para> + The minor version number of pslib. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>subminor</literal>, <literal>revision</literal></term> + <listitem> + <para> + The subminor version number of pslib. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> </refsect1> <refsect1 role="parameters"> @@ -28,7 +259,8 @@ <term><parameter>psdoc</parameter></term> <listitem> <para> - + Resource identifier of the postscript file + as returned by <function>ps_new</function>. </para> </listitem> </varlistentry> @@ -36,7 +268,7 @@ <term><parameter>name</parameter></term> <listitem> <para> - + Name of the value. </para> </listitem> </varlistentry> @@ -46,7 +278,7 @@ <para> The parameter <parameter>modifier</parameter> specifies the resource for which the value is to be retrieved. This can be the id of a font or - an image. It must be 0.0 if not used. + an image. </para> </listitem> </varlistentry>