jimw Sat Apr 14 11:28:10 2001 EDT
Modified files:
/phpdoc/en/functions pdf.xml
Log:
deprecated, not depreciated, and a number of other linguistic fixups.
Index: phpdoc/en/functions/pdf.xml
diff -u phpdoc/en/functions/pdf.xml:1.42 phpdoc/en/functions/pdf.xml:1.43
--- phpdoc/en/functions/pdf.xml:1.42 Wed Mar 28 03:59:55 2001
+++ phpdoc/en/functions/pdf.xml Sat Apr 14 11:28:08 2001
@@ -7,56 +7,56 @@
<title>Introduction</title>
<simpara>
You can use the PDF functions in PHP to create PDF files if you
- have the PDF library by Thomas Merz (available at
+ have the PDF library by Thomas Merz (available at
<ulink url="&url.pdf;">&url.pdf;</ulink>;
you will also need <ulink url="&url.jpeg;">the JPEG library</ulink>
and <ulink url="&url.tiff;">the TIFF library</ulink> to
- compile this. These two libs also quite often make problems when
- configuring php. Follow the messages of configure to fix possible
- problems.
+ compile this. These two librariess can often cause problems when
+ configuring PHP, so be sure to pay attention to the output of
+ the configure script and fix any problems it reports.
</simpara>
<simpara>
- Please consult the excellent documentation for
- PDFlib shipped with the source distribution of PDFlib.
- It provides a very good overview of what PDFlib capable of doing
- and contains the full and uptodate description of all functions.
+ Please consult the documentation for PDFlib shipped with
+ the source distribution of PDFlib. It provides a very good
+ overview of what PDFlib is capable of doing and contains the full
+ and most up-to-date description of all functions.
</simpara>
<simpara>
All of the functions in PDFlib and the PHP module have the same name.
The parameters are also identical.
You should also understand some of the concepts of PDF
- or Postscript to efficiently use this module.
- All lengths and coordinates are measured in Postscript points.
+ or PostScript to efficiently use this module.
+ All lengths and coordinates are measured in PostScript points.
There are generally 72 PostScript points to an inch, but this
depends on the output resolution.
</simpara>
<simpara>
- There is another PHP module for pdf document creation based on
+ There is another PHP module for PDF document creation based on
<ulink url="&url.cpdf;">FastIO's</ulink>.
ClibPDF. It has a slightly different API. Check the
<link linkend="ref.cpdf">ClibPDF functions</link> section for
details.
</simpara>
<simpara>
- The pdf module introduces one new type of variable.
- It is called <parameter>pdf object</parameter> and
- almost all functions need <parameter>pdf object</parameter>
+ The PDF module introduces one new type of variable.
+ It is called a <parameter>pdf object</parameter> and
+ almost all functions need a <parameter>pdf object</parameter>
as its first parameter.
</simpara>
</sect1>
<sect1 id="pdf.oldlibs.confusion">
<title>Confusion with old PDFlib versions</title>
<simpara>
- Starting with php V4.0.5 the PHP extension for PDFlib is officially
- supported by PDFlib GmbH. This means, that all the functions
+ Starting with PHP 4.0.5, the PHP extension for PDFlib is officially
+ supported by PDFlib GmbH. This means that all the functions
described in the PDFlib-manual (V3.00 or greater) are supported by
- php4 with exactly the same meaning and the same parameters.
- Only the returnvalues may differ from the PDFlib manual, as we
- adoptet the PHP way to return FALSE in case of errors.
+ PHP 4 with exactly the same meaning and the same parameters.
+ Only the return values may differ from the PDFlib manual, because
+ the PHP convention of returning <literal>false</literal> was adopted.
For compatibility reasons this binding for
- PDFlib still will support the old functions, but as stated above
+ PDFlib still supports the old functions, but as stated above
they should be replaced by their new versions. PDFlib GmbH will not
- support any problems arraising from the use of these depreciated
+ support any problems arising from the use of these deprecated
functions.
</simpara>
<para>
@@ -228,22 +228,20 @@
<sect1 id="pdf.oldlibs.hints">
<title>Issues with older versions of PDFlib</title>
<simpara>
- Any version of PHP 4 after March, 9th 2000 do not support versions
+ Any version of PHP 4 after March 9, 2000 does not support versions
of PDFlib older than 3.0.
</simpara>
<simpara>
- PHP 3 on the other hand should not be used with version newer
- than 2.01. Since revision 1.61 of php3/functions/pdf.c (php 3.19)
- it is save to use PDFlib 3.0 or greater.
+ PDFlib 3.0 or greater is also supported by PHP 3.0.19 and later.
</simpara>
</sect1>
<sect1 id="pdf.examples">
<title>Examples</title>
<simpara>
Most of the functions are fairly easy to use. The most difficult part
- is probably to create a very simple pdf document at all. The following
+ is probably creating a very simple PDF document at all. The following
example should help to get started.
- It creates the file <filename>test.pdf</filename>
+ It creates <filename>test.pdf</filename>
with one page. The page contains the text "Times Roman outlined" in an
outlined, 30pt font. The text is also underlined.
</simpara>
@@ -415,7 +413,7 @@
<refentry id="function.pdf-add-annotation">
<refnamediv>
<refname>PDF_add_annotation</refname>
- <refpurpose>Deprecitad: Adds annotation</refpurpose>
+ <refpurpose>Deprecated: Adds annotation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@@ -539,7 +537,7 @@
<refsect1>
<title>Description</title>
<para>
- Depreciated.
+ Deprecated.
</para>
<para>
See <function>PDF_add_bookmark</function>.
@@ -1053,7 +1051,7 @@
<refentry id="function.pdf-endpath">
<refnamediv>
<refname>PDF_endpath</refname>
- <refpurpose>Depreciated: Ends current path</refpurpose>
+ <refpurpose>Deprecated: Ends current path</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@@ -1188,12 +1186,12 @@
<refentry id="function.pdf-get-font">
<refnamediv>
<refname>PDF_get_font</refname>
- <refpurpose>Depreciated font handling</refpurpose>
+ <refpurpose>Deprecated font handling</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>
- Depreciated.
+ Deprecated.
</para>
<para>
See <function>PDF_get_value</function>.
@@ -1204,12 +1202,12 @@
<refentry id="function.pdf-get-fontname">
<refnamediv>
<refname>PDF_get_fontname</refname>
- <refpurpose>Depreciated font handling</refpurpose>
+ <refpurpose>Deprecated font handling</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>
- Depreciated.
+ Deprecated.
</para>
<para>
See <function>PDF_get_parameter</function>.
@@ -1220,12 +1218,12 @@
<refentry id="function.pdf-get-fontsize">
<refnamediv>
<refname>PDF_get_fontsize</refname>
- <refpurpose>Depreciated font handling</refpurpose>
+ <refpurpose>Deprecated font handling</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>
- Depreciated.
+ Deprecated.
</para>
<para>
See <function>PDF_get_value</function>.
@@ -1248,7 +1246,7 @@
</funcprototype>
</funcsynopsis>
<para>
- The <function>PDF_get_image_height</function> is depreciated,
+ The <function>PDF_get_image_height</function> is deprecated,
use <function>PDF_get_value</function> instead.
</para>
</refsect1>
@@ -1269,7 +1267,7 @@
</funcprototype>
</funcsynopsis>
<para>
- The <function>PDF_get_image_width</function> is depreciated,
+ The <function>PDF_get_image_width</function> is deprecated,
use <function>PDF_get_value</function> instead.
</para>
</refsect1>
@@ -1473,7 +1471,7 @@
<refsect1>
<title>Description</title>
<para>
- The <function>PDF_open</function> is depreciated, use
+ The <function>PDF_open</function> is deprecated, use
<function>PDF_new</function> plus <function>PDF_open_file</function>
instead.
</para>
@@ -1566,12 +1564,12 @@
<refentry id="function.pdf-open-gif">
<refnamediv>
<refname>PDF_open_gif</refname>
- <refpurpose>Depreciated: Opens a GIF image</refpurpose>
+ <refpurpose>Deprecated: Opens a GIF image</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>
- Depreciated.
+ Deprecated.
</para>
<para>
See <function>PDF_open_image</function>,
@@ -1640,12 +1638,12 @@
<refentry id="function.pdf-open-jpeg">
<refnamediv>
<refname>PDF_open_jpeg</refname>
- <refpurpose>Depreciated: Opens a JPEG image</refpurpose>
+ <refpurpose>Deprecated: Opens a JPEG image</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>
- Depreciated.
+ Deprecated.
</para>
<para>
See also <function>PDF_open_image</function>,
@@ -1705,13 +1703,13 @@
<refnamediv>
<refname>PDF_open_png</refname>
<refpurpose>
- Depreciated: Opens a PNG image
+ Deprecated: Opens a PNG image
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>
- Depreciated.
+ Deprecated.
</para>
<para>
See <function>PDF_open_image</function>.
@@ -1722,7 +1720,7 @@
<refentry id="function.pdf-open-tiff">
<refnamediv>
<refname>PDF_open_tiff</refname>
- <refpurpose>Depreciated: Opens a TIFF image</refpurpose>
+ <refpurpose>Deprecated: Opens a TIFF image</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@@ -1734,7 +1732,7 @@
</funcprototype>
</funcsynopsis>
<para>
- Depreciated.
+ Deprecated.
</para>
<para>
See also <function>PDF_open_image</function>,
@@ -2002,7 +2000,7 @@
</para>
<note>
<para>
- PDFlib V4.0: Depreciated, use <function>PDF_setcolor</function> instead.
+ PDFlib V4.0: Deprecated, use <function>PDF_setcolor</function> instead.
</para>
</note>
</refsect1>
@@ -2027,7 +2025,7 @@
</para>
<note>
<para>
- PDFlib V4.0: Depreciated, use <function>PDF_setcolor</function> instead.
+ PDFlib V4.0: Deprecated, use <function>PDF_setcolor</function> instead.
</para>
</note>
</refsect1>
@@ -2052,7 +2050,7 @@
</para>
<note>
<para>
- PDFlib V4.0: Depreciated, use <function>PDF_setcolor</function> instead.
+ PDFlib V4.0: Deprecated, use <function>PDF_setcolor</function> instead.
</para>
</note>
</refsect1>
@@ -2204,7 +2202,7 @@
</para>
<note>
<para>
- PDFlib V4.0: Depreciated, use <function>PDF_setcolor</function> instead.
+ PDFlib V4.0: Deprecated, use <function>PDF_setcolor</function> instead.
</para>
</note>
</refsect1>
@@ -2231,7 +2229,7 @@
</para>
<note>
<para>
- PDFlib V4.0: Depreciated, use <function>PDF_setcolor</function> instead.
+ PDFlib V4.0: Deprecated, use <function>PDF_setcolor</function> instead.
</para>
</note>
</refsect1>
@@ -2258,7 +2256,7 @@
</para>
<note>
<para>
- PDFlib V4.0: Depreciated, use <function>PDF_setcolor</function> instead.
+ PDFlib V4.0: Deprecated, use <function>PDF_setcolor</function> instead.
</para>
</note>
</refsect1>
@@ -2333,12 +2331,12 @@
<refentry id="function.pdf-set-char-spacing">
<refnamediv>
<refname>PDF_set_char_spacing</refname>
- <refpurpose>Depreciated: Sets character spacing</refpurpose>
+ <refpurpose>Deprecated: Sets character spacing</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>
- Depreciated.
+ Deprecated.
</para>
<para>
See also <function>PDF_set_value</function>,
@@ -2354,7 +2352,7 @@
<refsect1>
<title>Description</title>
<para>
- Depreciated.
+ Deprecated.
</para>
<para>
See <function>PDF_set_value</function>.
@@ -2365,12 +2363,12 @@
<refentry id="function.pdf-set-font">
<refnamediv>
<refname>PDF_set_font</refname>
- <refpurpose>Depreciated: Selects a font face and size</refpurpose>
+ <refpurpose>Deprecated: Selects a font face and size</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>
- Depreciated. You should use <function>PDF_findfont</function> plus
+ Deprecated. You should use <function>PDF_findfont</function> plus
<function>PDF_setfont</function> instead.
</para>
<para>
@@ -2395,7 +2393,7 @@
</funcprototype>
</funcsynopsis>
<para>
- Depreciated.
+ Deprecated.
</para>
<para>
See also <function>PDF_set_value</function>,
@@ -2429,12 +2427,12 @@
<refentry id="function.pdf-set-leading">
<refnamediv>
<refname>PDF_set_leading</refname>
- <refpurpose>Depreciated: Sets distance between text lines</refpurpose>
+ <refpurpose>Deprecated: Sets distance between text lines</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>
- Depreciated.
+ Deprecated.
</para>
<para>
See also <function>PDF_set_value</function>,
@@ -2487,12 +2485,12 @@
<refentry id="function.pdf-set-text-rendering">
<refnamediv>
<refname>PDF_set_text_rendering</refname>
- <refpurpose>Depreciated: Determines how text is rendered</refpurpose>
+ <refpurpose>Deprecated: Determines how text is rendered</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>
- Depreciated.
+ Deprecated.
</para>
<para>
See <function>PDF_set_value</function>,
@@ -2508,7 +2506,7 @@
<refsect1>
<title>Description</title>
<para>
- Depreciated.
+ Deprecated.
</para>
<para>
See <function>PDF_set_value</function>,
@@ -2558,7 +2556,7 @@
<refsect1>
<title>Description</title>
<para>
- Depreciated.
+ Deprecated.
</para>
<para>
See also <function>PDF_set_value</function>,
