goba Fri Apr 19 10:28:56 2002 EDT
Modified files:
/phpdoc/en/reference/cpdf reference.xml
Log:
New structure applied
Index: phpdoc/en/reference/cpdf/reference.xml
diff -u phpdoc/en/reference/cpdf/reference.xml:1.2
phpdoc/en/reference/cpdf/reference.xml:1.3
--- phpdoc/en/reference/cpdf/reference.xml:1.2 Mon Apr 15 14:56:30 2002
+++ phpdoc/en/reference/cpdf/reference.xml Fri Apr 19 10:28:56 2002
@@ -1,68 +1,67 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<reference id="ref.cpdf">
<title>ClibPDF functions</title>
<titleabbrev>ClibPDF</titleabbrev>
<partintro>
- <simpara>
- ClibPDF lets you create PDF documents with PHP. It is available for
- download from <ulink url="&url.fastio;">FastIO</ulink>, but
- requires that you purchase a license for commercial use. ClibPDF
- functionality and API are similar to <link
- linkend="ref.pdf">PDFlib</link>.
- </simpara>
- <simpara>
- This documentation should be read alongside the ClibPDF manual since it
- explains the library in much greater detail.
- </simpara>
- <simpara>
- Many functions in the native ClibPDF and the PHP module, as well
- as in <link linkend="ref.pdf">PDFlib</link>, have the same name.
- All functions except for <function>cpdf_open</function> take the
- handle for the document as their first parameter.
- </simpara>
- <simpara>
- Currently this handle is not used internally since ClibPDF does
- not support the creation of several PDF documents at the same time.
- Actually, you should not even try it, the results are unpredictable. I
- can't oversee what the consequences in a multi threaded environment
- are. According to the author of ClibPDF this will change in one of
- the next releases (current version when this was written is 1.10).
- If you need this functionality use the pdflib module.
- </simpara>
- <note>
- <simpara>
- The function <function>cpdf_set_font</function> has changed since PHP 3
- to support asian fonts. The encoding parameter is no longer an integer
- but a string.
- </simpara>
- </note>
- <simpara>
- A nice feature of ClibPDF (and <link
- linkend="ref.pdf">PDFlib</link>) is the ability to create the pdf
- document completely in memory without using temporary files. It
- also provides the ability to pass coordinates in a predefined unit
- length. (This feature can also be simulated by
- <function>pdf_translate</function> when using the <link
- linkend="ref.pdf">PDFlib</link>. functions.)
- </simpara>
- <simpara>
- Another nice feature of ClibPDF is the fact that any page can be modified
- at any time even if a new page has been already opened. The function
- <function>cpdf_set_current_page</function> allows to leave the current
- page and presume modifying an other page.
- </simpara>
- <simpara>
- Most of the functions are fairly easy to use. The most difficult part
- is probably creating a very simple PDF document at all. The following
- example should help you to get started. It creates a document
- with one page. The page contains the text "Times-Roman" in an
- outlined 30pt font. The text is underlined.
- </simpara>
- <example>
- <title>Simple ClibPDF Example</title>
- <programlisting>
+ <section id="cpdf.intro">
+ &reftitle.intro;
+ <para>
+ ClibPDF lets you create PDF documents with PHP. It is available for
+ download from <ulink url="&url.fastio;">FastIO</ulink>, but
+ requires that you purchase a license for commercial use. ClibPDF
+ functionality and API are similar to <link
+ linkend="ref.pdf">PDFlib</link>.
+ </para>
+ <para>
+ This documentation should be read alongside the ClibPDF manual since it
+ explains the library in much greater detail.
+ </para>
+ <para>
+ Many functions in the native ClibPDF and the PHP module, as well
+ as in <link linkend="ref.pdf">PDFlib</link>, have the same name.
+ All functions except for <function>cpdf_open</function> take the
+ handle for the document as their first parameter.
+ </para>
+ <ara>
+ Currently this handle is not used internally since ClibPDF does
+ not support the creation of several PDF documents at the same time.
+ Actually, you should not even try it, the results are unpredictable. I
+ can't oversee what the consequences in a multi threaded environment
+ are. According to the author of ClibPDF this will change in one of
+ the next releases (current version when this was written is 1.10).
+ If you need this functionality use the pdflib module.
+ </para>
+ <para>
+ A nice feature of ClibPDF (and <link
+ linkend="ref.pdf">PDFlib</link>) is the ability to create the pdf
+ document completely in memory without using temporary files. It
+ also provides the ability to pass coordinates in a predefined unit
+ length. (This feature can also be simulated by
+ <function>pdf_translate</function> when using the <link
+ linkend="ref.pdf">PDFlib</link> functions.)
+ </para>
+ <para>
+ Another nice feature of ClibPDF is the fact that any page can be modified
+ at any time even if a new page has been already opened. The function
+ <function>cpdf_set_current_page</function> allows to leave the current
+ page and presume modifying an other page.
+ </para>
+ <para>
+ Most of the functions are fairly easy to use. The most difficult part
+ is probably creating a very simple PDF document at all. The following
+ example should help you to get started. It creates a document
+ with one page. The page contains the text "Times-Roman" in an
+ outlined 30pt font. The text is underlined.
+ </para>
+ </section>
+
+ <section id="cpdf.examples">
+ &reftitle.examples;
+ <example>
+ <title>Simple ClibPDF Example</title>
+ <programlisting>
<![CDATA[
<?php
$cpdf = cpdf_open(0);
@@ -82,16 +81,16 @@
cpdf_close($cpdf);
?>
]]>
- </programlisting>
- </example>
- <simpara>
- The pdflib distribution contains a more complex example which creates a
- series of pages with an analog clock. Here is that example converted
- into PHP using the ClibPDF extension:
- </simpara>
- <example>
- <title>pdfclock example from pdflib 2.0 distribution</title>
- <programlisting>
+ </programlisting>
+ </example>
+ <para>
+ The pdflib distribution contains a more complex example which creates a
+ series of pages with an analog clock. Here is that example converted
+ into PHP using the ClibPDF extension:
+ </para>
+ <example>
+ <title>pdfclock example from pdflib 2.0 distribution</title>
+ <programlisting>
<![CDATA[
<?php
$radius = 200;
@@ -181,14 +180,23 @@
cpdf_close($pdf);
?>
]]>
- </programlisting>
- </example>
+ </programlisting>
+ </example>
+ </section>
+
+ <section id="cpdf.seealso">
+ &reftitle.seealso;
+ <para>
+ See also the <link linkend="ref.pdf">PDFlib</link>
+ extension documentation.
+ </para>
+ </section>
</partintro>
-
&reference.cpdf.functions;
</reference>
+
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
