IMAGE

See cache function description for details.

If "if" returns false, the image is not shown!

HTML <IMG> parameters

If no alt text is specified, an empty alt text will be used.

Value can be "keepEmpty" to preserve an empty title attribute, or "useAlt" to use the alt attribute instead.

Defines the render layout for the IMAGE. The render layout is the HTML Code for the IMAGE itself. Default values include default, srcset, picture, data. Each option represents a different solution to render the HTML Code of the IMAGE. The default code renders the img-tag as a plain html tag with the different attributes.

When implementing a responsive layout you need different image sizes for the different displays and resolutions of your layout. Depending on the HTML framework, the capabilities of desired browsers and the used javascript library for progressive enhancement you can choose either one of the predefined layouts or you can define a new layout of your own by adding an additional layout key.

If you don't have a responsive HTML layout you should use the default layout.

• default renders a normal non-responsive image as a <img> tag:

  <img src="###SRC###"
       width="###WIDTH###"
       height="###HEIGHT###" ###PARAMS### ###ALTPARAMS### ###SELFCLOSINGTAGSLASH###>

  Copied!

• srcset renders an image tag pointing to a set of images for the different resolutions. They are referenced inside the srcset attribute the <img> tag for each defined resolution. Each image is actually rendered by TYPO3. Srcset is a proposed addition to HTML5 (https://www.w3.org/TR/html-srcset/).

  <img src="###SRC###"
       srcset="|*|###SRC### ###SRCSETCANDIDATE###,|*|###SRC### ###SRCSETCANDIDATE###" ###PARAMS### ###ALTPARAMS######SELFCLOSINGTAGSLASH###>

  Copied!

• picture renders a picture tag containing source tags for each resolution and an <img> tag for the default image.

  <picture>
     <source srcset="###SRC###"
             media="###MEDIAQUERY###"###SELFCLOSINGTAGSLASH###>
     <img src="###SRC###" ###PARAMS### ###ALTPARAMS######SELFCLOSINGTAGSLASH###>
  </picture>

  Copied!

• data renders an image tag containing data-keys for the different resolutions:

  <img src="###SRC###"
       data-###DATAKEY###="###SRC###" ###PARAMS### ###ALTPARAMS######SELFCLOSINGTAGSLASH###>

  Copied!

HTML code definition for the different Properties.

Definition for the HTML rendering for the named Properties. Depending on your needs you can use the existing pre-defined layoutKey or you can define your own element for your responsive layout.

Example:

picture {
  element = <picture>###SOURCECOLLECTION###<img src="###SRC###" ###PARAMS### ###ALTPARAMS### ###SELFCLOSINGTAGSLASH###></picture>
  source = <source srcset="###SRC###" media="###MEDIAQUERY###" ###SELFCLOSINGTAGSLASH###>
}

The outer element definition for the HTML rendering of the image. Possible markers are mainly all parameters which can be defined in the IMAGE object, e.g.:

• ###SRC### the file URL for the src attribute
• ###WIDTH### the width of the image for the width tag (only the width value)
• ###HEIGHT### the height of the image for the height tag (only the width value)
• ###PARAMS### additional params defined in the IMAGE object (as complete attribute)
• ###ALTPARAMS### additional alt params defined in the IMAGE object (as complete attribute)
• ###SELFCLOSINGTAGSLASH### renders the closing slash of the tag, depending on the setting of config.doctype
• ###SOURCECOLLECTION### the additional sources of the image depending on the different usage in responsive webdesign. The definition of the sources is declared inside layout.layoutKey.source

Defines the HTML code for the ###SOURCECOLLECTION### of the Properties. Possible markers in the out of the box configuration are:

• ###SRC### the file URL for the src attribute
• ###WIDTH### the width of the image for the width tag (only the width value)
• ###HEIGHT### the height of the image for the height tag (only the width value)
• ###SELFCLOSINGTAGSLASH### renders the closing slash of the tag, depending on the setting of config.doctype
• ###SRCSETCANDIDATE### is the value of the srcsetCandidate defined in each SourceCollection.DataKey
• ###MEDIAQUERY### is the value of the mediaQuery defined in each SourceCollection.DataKey
• ###DATAKEY### is the name of the dataKey defined in the sourceCollection

You can define additional markers by adding more datakeys to the collection. ###SRCSETCANDIDATE###, ###MEDIAQUERY###, ###DATAKEY### are already defined as additional datakeys in the out of the box typoscript. Thus can be overwritten by your typoscript.

For responsive images you need different image resolutions for each output device and output mode (portrait vs. landscape). sourceCollection defines the different resolutions for image rendering, normally you would define at least one sourceCollection per layout breakpoint. The amount of sourceCollections, the name and the specification for the sourceCollections will be defined by the HTML/CSS/JS code you are using. The configuration of the sourceCollection defines the size of the image which is rendered.

Each resolution should be set up as separate array in the sourceCollection. Each sourceCollection consists of different dataKey properties which you can define to suit your needs.

sourceCollection {
  small {
    width = 200

    srcsetCandidate = 600w
    mediaQuery = (max-device-width: 600px)
    dataKey = small
  }
  smallRetina {
    if.directReturn = 1

    width = 200
    pixelDensity = 2

    srcsetCandidate = 600w 2x
    mediaQuery = (max-device-width: 600px) AND (min-resolution: 192dpi)
    dataKey = smallRetina
  }
}

Definition of your image size definition depending on your responsive layout, breakpoints and display density.

Renders only if the condition is met, this is evaluated before any execution of code.

Defines the density of the rendered Image, e.g. a retina display would have a density of 2, the density is a multiplier for the image dimensions: If the pixelDensity is set to 2 and the width is set to 200 the generated image file will have a width of 400 but will be treated inside the html code as 200 pixels.

Defines the width for the html code of the image defined in this source collection. For the image file itself the width will be multiplied by dataKey.pixelDensity.

Defines the height for the html code of the image defined in this source collection. For the image file itself the height will be multiplied by dataKey.pixelDensity.

Defines the maxW for the html code of the image defined in this source collection. For the image file itself the maxW will be multiplied by dataKey.pixelDensity.

Defines the maxH for the html code of the image defined in this source collection. For the image file itself the maxH will be multiplied by dataKey.pixelDensity.

Defines the minW for the html code of the image defined in this source collection. For the image file itself the minW will be multiplied by dataKey.pixelDensity.

Defines the minH for the html code of the image defined in this source collection. For the image file itself the minH will be multiplied by dataKey.pixelDensity.

Defines the quality of the rendered images on a scale from 1-100.

You can define additional key value pairs which won't be used for setting the image size, but will be available as additional markers for the image template. See the example mediaquery.

(before ".wrap")

Note: Only active if linkWrap is not set and file is not GIFBUILDER (as it works with the original image file).

Wrap for the image tag.