cvs: peardoc /en/pecl imagick.xml

chregu Mon Dec 17 13:42:12 2001 EDT Modified files: /peardoc/en/pecl imagick.xml Log: * some itendination and 70-char-width stuff (does anyone know of a tool, which could do that for me?) * fixed some typos

Index: peardoc/en/pecl/imagick.xml diff -u peardoc/en/pecl/imagick.xml:1.2 peardoc/en/pecl/imagick.xml:1.3 --- peardoc/en/pecl/imagick.xml:1.2 Mon Dec 17 13:29:28 2001 +++ peardoc/en/pecl/imagick.xml Mon Dec 17 13:42:12 2001 @@ -1,71 +1,93 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <reference id="packages.imagick"> - <title>Imagick Functions</title> + <title>Imagick</title> <titleabbrev>imagick</titleabbrev> <partintro> &warn.experimental; - <sect1 id="imagick.partintro"> + <sect1 id="imagick.partintro"> <title>Introduction</title> <sect2 id="imagick.intro"> - <title>About ImageMagick</title> - <para> - ImageMagick is a robust collection of tools and libraries to read, write, and manipulate an image - in many image formats (over 68 major formats) including popular formats like TIFF, JPEG, PNG, PDF, - PhotoCD, and GIF. With ImageMagick you can create images dynamically, making it suitable - for Web applications. You can also resize, rotate, sharpen, color reduce, or add - special effects to an image and save your completed work in the same or differing image format. - </para> - <note> - <para> - The above text is from the ImageMagick Website - (<ulink url="http://www.imagemagick.org/">http://www.imagemagick.org</ulink>), - therefore not everything does apply to this extension at the moment, but it will some time in the - future. Hopefully. And the link above is also a great source, if you don't understand everything here. - </para> - </note> + <title>About ImageMagick</title> + <para> + ImageMagick is a robust collection of tools and libraries to + read, write, and manipulate an image in many image formats + (over 68 major formats) including popular formats like TIFF, + JPEG, PNG, PDF, PhotoCD, and GIF. With ImageMagick you can + create images dynamically, making it suitable for Web + applications. You can also resize, rotate, sharpen, color + reduce, or add special effects to an image and save your + completed work in the same or differing image format. + </para> + <note> + <para> + The above text is from the ImageMagick Website (<ulink + url="http://www.imagemagick.org/">http://www.imagemagick.org</ulink>), + therefore not everything does apply to this extension at + the moment, but it will some time in the future. + Hopefully. And the link above is also a great source, if + you don't understand everything here. + </para> + </note> </sect2> <sect2 id="imagick.install"> <title>Installation</title> <para> - short installation note: -<itemizedlist> -<listitem><simpara>You need at least PHP 4.1 (or some of the RCs).</simpara></listitem> -<listitem><simpara>untar the imagick.tgz archive into php4/ext (Latest official release is <ulink url="http://php.chregu.tv/pear/pecl_imagick-0.0.2a.tgz">0.0.2a</ulink>, or try the <ulink url="http://php.chregu.tv/pear/imagick-cvs.tgz">cvs-snapshot </ulink>)</simpara></listitem> -<listitem><simpara>If the new directory is now called something like pecl_image-0.0.x, then you should rename it to imagick (except you only want to build it as self-contained php-module)</simpara></listitem> -<listitem><simpara>run phpize in ext/imagick</simpara></listitem> -<listitem><simpara>run ./buildconf in php4</simpara></listitem> -<listitem><simpara>run configure with --with-imagick (and your other options)</simpara></listitem> -<listitem><simpara>make; make install</simpara></listitem> -<listitem><simpara>that's it.</simpara></listitem> -</itemizedlist> -and you need the imagemagick header files to install it (and on my system i -needed also the libwmf header files...) -</para> + short installation note: + <itemizedlist> + <listitem><simpara>You need at least PHP 4.1 (or some of the RCs).</simpara></listitem> + <listitem> + <simpara> + untar the imagick.tgz archive into php4/ext (Latest + official release is <ulink + url="http://php.chregu.tv/pear/pecl_imagick-0.0.2a.tgz">0.0.2a</ulink>, + or try the <ulink + url="http://php.chregu.tv/pear/imagick-cvs.tgz">cvs-snapshot + </ulink>) + </simpara> + </listitem> + <listitem> + <simpara> + If the new directory is now called something like + pecl_image-0.0.x, then you should rename it to imagick (except you + only want to build it as self-contained php-module) + </simpara> + </listitem> + <listitem><simpara>run phpize in ext/imagick</simpara></listitem> + <listitem><simpara>run ./buildconf in php4</simpara></listitem> + <listitem> + <simpara> + run configure with --with-imagick (and your other options) + </simpara> + </listitem> + <listitem><simpara>make; make install</simpara></listitem> + <listitem><simpara>that's it.</simpara></listitem> + </itemizedlist> + and you need the imagemagick header files to install it (and on my system i + needed also the libwmf header files...) + </para> -</sect2> - <sect2 id="imagick.contact"> + </sect2> + <sect2 id="imagick.contact"> <title>Contact Information</title> -<para> -I have at the moment not very much time to further develop this extension. I will -implement more and more features in the near future, but don't expect a full-featured extension -soon. If you can't wait, you are very welcome to implement some of the features. It's -really not very hard. Just have a look at the source-code. -Or let me know, which ImageMagick feature you urgently need, and maybe -I will implement that first ... -</para> -<para> - - -If you have comments, bugfixes, enhancements or want to help developping this beast, -you can drop me a mail at - <ulink url="mailto:chregu@php.net">chregu@php.net</ulink> or - <ulink url="mailto:chregu@bitflux.ch">chregu@bitflux.ch</ulink>. -Any help is very welcome. -</para> -</sect2> - </sect1> + <para> + I have at the moment not very much time to further develop this + extension. I will implement more and more features in the near + future, but don't expect a full-featured extension soon. If you can't + wait, you are very welcome to implement some of the features. It's + really not very hard. Just have a look at the source-code. Or let me + know, which ImageMagick feature you urgently need, and maybe I will + implement that first ... + </para> + <para> + If you have comments, bugfixes, enhancements or want to help + developping this beast, you can drop me a mail at <ulink + url="mailto:chregu@php.net">chregu@php.net</ulink>. Any help is very + welcome. + </para> + </sect2> +</sect1> </partintro> @@ -127,14 +149,15 @@ on error. </para> <para> - The <parameter>filename</parameter> parameter can be either a filename on your - local filesystem or a URL (e.g. http://my.server.com/picture.gif) or an array containing - more than one string with filenames for multiple image support. The imageformat - should be recognized automatically by imagick. If <function>imagick_read</function> - does not recognize the - imageformat, you can prefix the filename with the image format abbreviation plus a : - (e.g. GIF:mygif.gif). Following imageformats are supported - with ImageMagick 5.4.0. + The <parameter>filename</parameter> parameter can be either a + filename on your local filesystem or a URL (e.g. + http://my.server.com/picture.gif) or an array containing more + than one string with filenames for multiple image support. The + imageformat should be recognized automatically by imagick. If + <function>imagick_read</function> does not recognize the + imageformat, you can prefix the filename with the image format + abbreviation plus a : (e.g. GIF:mygif.gif). Following + imageformats are supported with ImageMagick 5.4.0. </para> <para> <table> @@ -438,13 +461,13 @@ on error. </para> <para> - This is a wrapper for create, read, write/dump and free. - If output_file is "-" or Null it dumps the image to the output (mostly the browser). If you dump it to the - output, you can give a imageformat, if you want something else than the inputformat (most likely...). - - + This is a wrapper for create, read, write/dump and free. If + output_file is "-" or Null it dumps the image to the output + (mostly the browser). If you dump it to the output, you can give + a imageformat, if you want something else than the inputformat + (most likely...). </para> - <para> + <para> See also: <function>imagick_read</function>, <function>imagick_write</function>, <function>imagick_dump</function>. </para> @@ -502,9 +525,10 @@ on error. </para> <para> - Scales an image to the desired dimensions with pixelsampling. - Unlike other scaling methods, this method does not introduceany - additional color into the scaled image. + Scales an image to the desired dimensions with + pixelsampling. Unlike other scaling methods, this method + does not introduceany additional color into the scaled + image. </para> <para> See also: <function>imagick_resize</function>. @@ -570,7 +594,7 @@ <refentry id="function.list-magickinfo"> <refnamediv> - <refname>imagick_list-magickifo</refname> + <refname>imagick_list-magickinfo</refname> <refpurpose> Lists the image formats to a file </refpurpose> @@ -605,9 +629,11 @@ </funcsynopsis> &warn.experimental.func; <para> -. Positive angles rotate counter-clockwise (right-hand rule), while negative angles rotate clockwise. -Rotated images are usually larger than the originals and have 'empty' triangular corners. -Empty triangles left over from rotating the image are filled with the color defined by the pixel at location (0,0). + Positive angles rotate counter-clockwise (right-hand rule), + while negative angles rotate clockwise. Rotated images are + usually larger than the originals and have 'empty' triangular + corners. Empty triangles left over from rotating the image are + filled with the color defined by the pixel at location (0,0). </para> </refsect1> @@ -633,11 +659,15 @@ </funcsynopsis> &warn.experimental.func; <para> - Shearing slides one edge of an image along the X or Y axis, creating a parallelogram. - An X direction shear slides an edge along the X axis, while a Y direction shear slides an edge along the Y axis. - The amount of the shear is controlled by a shear angle. For X direction shears, x_shear is measured relative to the Y axis, - and similarly, for Y direction shears y_shear is measured relative to the X axis. Empty triangles left over from - shearing the image are filled with the color defined by the pixel at location (0,0). + Shearing slides one edge of an image along the X or Y axis, + creating a parallelogram. An X direction shear slides an edge + along the X axis, while a Y direction shear slides an edge + along the Y axis. The amount of the shear is controlled by a + shear angle. For X direction shears, x_shear is measured + relative to the Y axis, and similarly, for Y direction shears + y_shear is measured relative to the X axis. Empty triangles + left over from shearing the image are filled with the color + defined by the pixel at location (0,0). </para> @@ -760,8 +790,9 @@ </funcsynopsis> &warn.experimental.func; <para> - This function takes either two string with the attribute and the value, or a array with - attributes as key and the values as values... + This function takes either two string with the attribute and the + value, or a array with attributes as key and the values as + values... </para> <para> At the moment following attributes are supported: @@ -778,8 +809,8 @@ </para> <note> <para> - For a detailed list of what the attributes are, see - <ulink url="http://www.imagemagick.org/www/perl.html#seta">http://www.imagemagick.org/www/perl.html#seta</ulink> + For a detailed list of what the attributes are, see <ulink + url="http://www.imagemagick.org/www/perl.html#seta">http://www.imagemagick.org/www/perl.html#seta</ulink> </para> </note> <example>