image

Show a still image using a <img /> element.

The {% image %} tag is used to generate an HTML <img /> element for a media resource. The image will be automatically resized to the desired size and filters. See also the {% media %} tag for handling video.

For example:

{% image "cow.jpg" width=200 height=200 crop %}

This will generate an image tag for the image “cow.jpg” (in the files/archive directory) of 200x200 pixels. The image will be resized and cropped to the requested size. The image tag will be something like (the checksum will vary per sign key):

<img src="/image/cow.jpg%28200x200%29%28crop%29%28981E1AD8DA60381D00C094F0EE1311F5%29.jpg" width="200" height="200" />

The file argument can be one of the following:

  • filename relative to the archive folder (“cow.jpg” is always present)
  • resource id of a resource with attached file (mostly of the category “media”)
  • property list of a resource’s medium record

The following arguments/filters can be specified:

Argument Description Example
width The maximum width of the image. width=200
height The maximum height of the image. height=200
mediaclass The media class of the image. See Media classes. mediaclass=”thumb”
background The background color for transparent image parts. See ImageMagick colors for how to specify the RGB color. background=”white”
removebg Removes the image background. Accepts an optional fuzziness parameter (range 0..100). removebg removebg=50
blur Blur the image, making it less sharp. See ImageMagick blur for valid argument values. blur=”20x8”
crop

Crop the image, the resulting image will be exactly the size specified in the width and height arguments. Which part of the image will be cropped depends on the value of the crop argument.

When no argument is given to crop, it defaults to the center point of the image, unless there is a cropping center point defined in the media item. Other options are: north, north_east, east, south_east, south, south_west, west, north_west and center.

When the “crop” argument is a string of the form “+x+y”, this coordinate is taken as the ‘center of gravity’ of the crop, to assure that the given point is in view after the image is cropped. This point is given in image coordinates (unscaled), and is relative to the top left of the image, so crop="+0+0" is the same as saying crop="north_east".

crop

crop=”south”

crop=”+100+100”

extent Make the image fit the requested dimensions by adding whitespace using this procedure: Resize the image so that it fits inside the width/height box; then extent the image with a white background so that it is centered and exactly the size of the box. extent
upscale Forces the image to scale up to the requested dimensions. upscale
flip Flip the image. Left and right will be mirrored. flip
flop Flop the image. Top and bottom will be mirrored. flop
grey Make the image greyscale. grey
lossless Generate a PNG preview if the original file is a PNG, GIF or PDF. lossless
mono Make the image black and white. mono
quality Set the quality of the resulting jpeg. The quality is an integer between 0 and 100, with 100 the best quality. The default quality depends on the resulting image size. Smaller images will have a higher quality setting than bigger images. Note that images smaller than 400x400 are sharpened before jpeg compression. quality=70
link Add a <a/> tag around the generated <img/> tag. The destination depends on the value given. Just “link” without a value links to either the website property or the image page itself. When an integer is given then the link is to the page with that id. All other values are assumed to be an url. link
alt The text for the alt=”...” attribute of the <img>. alt=”A nice image”
class The text for the class=”...” attribute of the <img>. class=”figure”
use_absolute_url Ensure that the generated url contains the hostname and port use_absolute_url

See also Media classes for some options that are only available in mediaclass files.

See also

image_url, Media classes and media.

Previous topic

ifnotequal

Next topic

image_url

Versions

Actions