Author: Derick Rethans Date: 2006-01-27 15:12:02 +0100 (Fri, 27 Jan 2006) New Revision: 2062
Log: - Typo fixes. Modified: packages/ImageConversion/trunk/docs/tutorial.txt Modified: packages/ImageConversion/trunk/docs/tutorial.txt =================================================================== --- packages/ImageConversion/trunk/docs/tutorial.txt 2006-01-27 13:51:43 UTC (rev 2061) +++ packages/ImageConversion/trunk/docs/tutorial.txt 2006-01-27 14:12:02 UTC (rev 2062) @@ -12,9 +12,9 @@ colorspace, adding a swirl effect) and to convert between different MIME types of images (so called conversions). Filters and conversions are collected in "transformations", which can be globally configured and accessed from anywhere -in the program. Conversions and filters can be performed through different -handlers (currently supported PHP's GD extension and the external ImageMagick -program). Image conversion is capable to select a fitting handler +in the application. Conversions and filters can be performed through different +handlers (currently supported are PHP's GD extension and the external ImageMagick +program). ImageConversion is capable to select a fitting handler automatically, while you can select handlers to be prioritized. Class overview @@ -36,15 +36,6 @@ that only these MIME types are output. -Installation -============ - -This tutorial assumes that you have set-up an eZ components environment. For -information on how to do this, please refer to the `Components Introduction`_. - -.. _`Components Introduction`: http://ez.no/community/articles/an_introduction_to_ez_components - - Usage ===== @@ -59,7 +50,7 @@ First the settings for the ezcImageConverter are defined (line 7-12), using the ezcImageConverterSettings struct. Whenever an ezcImageConverter is -instantiated, it needs to know, which handlers are available. The order in the +instantiated, it needs to know which handlers are available. The order in the array of ezcImageHandlerSettings defines the priority of the handlers. In this case, the ezcImageConverter will check if a given filter or conversion can be performed by the GD handler. If not, it will check the ImageMagick handler. On @@ -69,14 +60,14 @@ ezcImageConverter. The first parameter to ezcImageConverter::createTransformation() defines the name of the transformation, the second parameter would usually contain filters, which are -not used here. Instead just 1 output MIME type is defined as the third +not used here. Instead just one output MIME type is defined as the third parameter, which makes this transformation only return images of the type "image/jpeg". -On the lines 21-24 you see, how the transformation is applied. The first +On the lines 21-24 you see how the transformation is applied. The first parameter to ezcImageConverter::transform() contains the name of the -transformation to apply. The second on gives the file to transform, while the -third one specifies the filename to save the transformed image to. Beside +transformation to apply. The second one gives the file to transform, while the +third one specifies the filename to save the transformed image to. Besides exceptions of the type ezcBaseFileException, the ezcImageTransformation::transform() method may only throw exceptions of the type ezcImageTransformationException, which we catch here to print out some error message. @@ -104,7 +95,7 @@ :literal: After instantiating the ezcImageConverter, a definition for filters to apply in -a conversion is created. Only 1 filter is contained in this example. Each +a conversion is created. Only one filter is contained in this example. Each filter definition must be an instance of ezcImageFilter. The first parameter to the constructor of ezcImageFilter (ezcImageFilter::__construct()) is the name of the filter to use. The second parameter is an array of settings for the @@ -172,8 +163,8 @@ type "image/png" to the allowed output types of the transformation, too (line 43). -In the transformation definition we define 3 filters, this time. Note, that the -order of the filter is important, here. The first filter is "scale" again, +In the transformation definition we define 3 filters. Note, that the +order of the filters is important here. The first filter is "scale" again, after which the colorspace of the image is reduced to grey scale. The last filter adds a 5 pixel border with a grey value near to white to the image. -- svn-components mailing list [email protected] http://lists.ez.no/mailman/listinfo/svn-components
