[%# # IMPORTANT NOTE # This documentation is generated automatically from source # templates. Any changes you make here may be lost. # # The 'docsrc' documentation source bundle is available for download # from http://www.template-toolkit.org/docs.html and contains all # the source templates, XML files, scripts, etc., from which the # documentation for the Template Toolkit is built. -%] [% META book = 'Modules' page = 'Plugin_Image' %] [% WRAPPER toc; PROCESS tocitem title ="SYNOPSIS" subs = []; PROCESS tocitem title ="DESCRIPTION" subs = []; PROCESS tocitem title ="CATCHING ERRORS" subs = []; PROCESS tocitem title ="USING Image::Info" subs = []; PROCESS tocitem title ="AUTHOR" subs = []; PROCESS tocitem title ="VERSION" subs = []; PROCESS tocitem title ="COPYRIGHT" subs = []; PROCESS tocitem title ="SEE ALSO" subs = []; END %] [% WRAPPER section title="SYNOPSIS" -%]

        [% tt_start_tag %] USE Image(filename) [% tt_end_tag %]
        [% tt_start_tag %] Image.width [% tt_end_tag %]
        [% tt_start_tag %] Image.height [% tt_end_tag %]
        [% tt_start_tag %] Image.size.join(', ') [% tt_end_tag %]
        [% tt_start_tag %] Image.attr [% tt_end_tag %]
        [% tt_start_tag %] Image.tag [% tt_end_tag %]

[%- END %] [% WRAPPER section title="DESCRIPTION" -%]

This plugin provides an interface to the Image::Info or Image::Size modules for determining the size of image files.

You can specify the plugin name as either 'Image' or 'image'. The plugin object created will then have the same name. The file name of the image should be specified as a positional or named argument.

        [% tt_start_tag %] # all these are valid, take your pick [% tt_end_tag %]
        [% tt_start_tag %] USE Image('foo.gif') [% tt_end_tag %]
        [% tt_start_tag %] USE image('bar.gif') [% tt_end_tag %]
        [% tt_start_tag %] USE Image 'ping.gif' [% tt_end_tag %]
        [% tt_start_tag %] USE image(name='baz.gif') [% tt_end_tag %]
        [% tt_start_tag %] USE Image name='pong.gif' [% tt_end_tag %]

A "root" parameter can be used to specify the location of the image file:

        [% tt_start_tag %] USE Image(root='/path/to/root', name='images/home.png') [% tt_end_tag %]
        # image path: /path/to/root/images/home.png
        # img src: images/home.png

In cases where the image path and image url do not match up, specify the file name directly:

        [% tt_start_tag %] USE Image(file='/path/to/home.png', name='/images/home.png') [% tt_end_tag %]

The "alt" parameter can be used to specify an alternate name for the image, for use in constructing an XHTML element (see the tag() method below).

        [% tt_start_tag %] USE Image('home.png', alt="Home") [% tt_end_tag %]

You can also provide an alternate name for an Image plugin object.

        [% tt_start_tag %] USE img1 = image 'foo.gif' [% tt_end_tag %]
        [% tt_start_tag %] USE img2 = image 'bar.gif' [% tt_end_tag %]

The 'name' method returns the image file name.

        [% tt_start_tag %] img1.name [% tt_end_tag %]     # foo.gif

The 'width' and 'height' methods return the width and height of the image, respectively. The 'size' method returns a reference to a 2 element list containing the width and height.

        [% tt_start_tag %] USE image 'foo.gif' [% tt_end_tag %]
        width: [% tt_start_tag %] image.width [% tt_end_tag %]
        height: [% tt_start_tag %] image.height [% tt_end_tag %]
        size: [% tt_start_tag %] image.size.join(', ') [% tt_end_tag %]

The 'modtime' method returns the ctime of the file in question, suitable for use with date.format:

        [% tt_start_tag %] USE image 'foo.gif' [% tt_end_tag %]
        [% tt_start_tag %] USE date [% tt_end_tag %]
        [% tt_start_tag %] date.format(image.modtime, "%B, %e %Y") [% tt_end_tag %]

The 'attr' method returns the height and width as HTML/XML attributes.

        [% tt_start_tag %] USE image 'foo.gif' [% tt_end_tag %]
        [% tt_start_tag %] image.attr [% tt_end_tag %]

Typical output:

        width="60" height="20"

The 'tag' method returns a complete XHTML tag referencing the image.

        [% tt_start_tag %] USE image 'foo.gif' [% tt_end_tag %]
        [% tt_start_tag %] image.tag [% tt_end_tag %]

Typical output:

        <img src="foo.gif" width="60" height="20" alt="" />

You can provide any additional attributes that should be added to the XHTML tag.

        [% tt_start_tag %] USE image 'foo.gif' [% tt_end_tag %]
        [% tt_start_tag %] image.tag(class="logo" alt="Logo") [% tt_end_tag %]

Typical output:

        <img src="foo.gif" width="60" height="20" alt="Logo" class="logo" />

Note that the 'alt' attribute is mandatory in a strict XHTML 'img' element (even if it's empty) so it is always added even if you don't explicitly provide a value for it. You can do so as an argument to the 'tag' method, as shown in the previous example, or as an argument

        [% tt_start_tag %] USE image('foo.gif', alt='Logo') [% tt_end_tag %]

[%- END %] [% WRAPPER section title="CATCHING ERRORS" -%]

If the image file cannot be found then the above methods will throw an 'Image' error. You can enclose calls to these methods in a TRY...CATCH block to catch any potential errors.

        [% tt_start_tag %] TRY;
             image.width;
           CATCH;
             error;      # print error
           END
        [% tt_end_tag %]

[%- END %] [% WRAPPER section title="USING Image::Info" -%]

At run time, the plugin tries to load Image::Info in preference to Image::Size. If Image::Info is found, then some additional methods are available, in addition to 'size', 'width', 'height', 'attr', and 'tag'. These additional methods are named after the elements that Image::Info retrieves from the image itself; see [% ttlink('Image::Info') -%] for more details -- the types of methods available depend on the type of image. These additional methods will always include the following:

- file_media_type

  This is the MIME type that is appropriate for the given file format. The corresponding value is a string like: "image/png" or "image/jpeg".

- file_ext

  The is the suggested file name extention for a file of the given file format. The value is a 3 letter, lowercase string like "png", "jpg".

- color_type

  The value is a short string describing what kind of values the pixels encode. The value can be one of the following:

        Gray
        GrayA
        RGB
        RGBA
        CMYK
        YCbCr
        CIELab

  These names can also be prefixed by "Indexed-" if the image is composed of indexes into a palette. Of these, only "Indexed-RGB" is likely to occur.

  (It is similar to the TIFF field PhotometricInterpretation, but this name was found to be too long, so we used the PNG inpired term instead.)

- resolution

  The value of this field normally gives the physical size of the image on screen or paper. When the unit specifier is missing then this field denotes the squareness of pixels in the image.

  The syntax of this field is:

         <res> <unit>
         <xres> "/" <yres> <unit>
         <xres> "/" <yres>

  The <res>, <xres> and <yres> fields are numbers. The <unit> is a string like `'dpi'`, `'dpm'` or `'dpcm'` (denoting "dots per inch/cm/meter).

- SamplesPerPixel

  This says how many channels there are in the image. For some image formats this number might be higher than the number implied from the `'color_type'`.

- BitsPerSample

  This says how many bits are used to encode each of samples. The value is a reference to an array containing numbers. The number of elements in the array should be the same as `'SamplesPerPixel'`.

- Comment

  Textual comments found in the file. The value is a reference to an array if there are multiple comments found.

- Interlace

  If the image is interlaced, then this tell which interlace method is used.

- Compression

  This tell which compression algorithm is used.

- Gamma

  A number.

[%- END %] [% WRAPPER section title="AUTHOR" -%]

Andy Wardley <abw@wardley.org>

[% ttlink('http://wardley.org/', 'http://wardley.org/') -%]

[%- END %] [% WRAPPER section title="VERSION" -%]

1.21, distributed as part of the Template Toolkit version 2.19, released on 27 April 2007.

[%- END %] [% WRAPPER section title="COPYRIGHT" -%]

      Copyright (C) 1996-2007 Andy Wardley.  All Rights Reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

[%- END %] [% WRAPPER section title="SEE ALSO" -%]

[% ttlink('Template::Plugin', 'Template::Plugin') -%]

[%- END %]