Prints details of a single campaign. The tag works globally, which means that you can use it on any page of your online store.

Kuvaus

By default, the tag doesn't print anything. The campaign details that should be printed are defined entirely in the helper attribute.

Syntaksi

{Campaign(
    id: int,
    helper: string
)}

Näkyvyys

Toimii näkyvyydessä: globaali

Näkyvyyshelper-attribuutissa: kampanja

Tags with global scope can be used on any template and in any tag.

Printing campaign details with the {Campaign} tag

The {Campaign} tag enables you to effortlessly print any campaign detail outside the campaign page. The tag itself doesn't print anything, but you can use any of the campaign tags in its helper attribute.

The example illustrates how to print basic campaign details by using the {Campaign} tag.

The relevant campaign is indicated by using the id attribute. The contents to be printed are then defined in the helper attribute.

{Campaign(
    id: 6,
    helper: {{
        <h2>{CampaignName}</h2>
        {CampaignDescription}
        {CampaignProducts(
          helper: {{
            <div><h3>{ProductName}</h3>
              {ProductListImage}
              {ProductCampaignPrice}
              {ProductAddToCart}
            </div>
          }}
        )}
    }}
)}

First, the campaign name and description are printed. The campaign products are then printed with the {CampaignProducts} tag. Note that product tags can be used within this product list because its scope has been set to product.

Attribuutit

id:

Sets the ID number of the relevant campaign.

Allowed values: integers

helper:

Defines the content and markup format of a printout.

Allowed values: the Interface and HTML markup that define the output's markup and content.

The helper attribute can be used in two ways:

  • you can indicate the desired markup directly as the attribute's value, or
  • you can indicate a reference to a file with the desired markup as the attribute's value.

    The reference should be indicated in relation to the theme's root directory.

See also detailed instructions on using the helper attribute.

after/before:

By using the after and before attributes you can define content that is output either after or before the tag's output.

Allowed values:HTML and Interface markup.

E.g.

  • before: '<p>Tämä merkkaus näkyy ennen tagin omaa sisältöä.</p>'
  • after: '<p>Tämä taas näkyy tagin oman sisällön jälkeen.</p>'

If the tag does not produce any content, neither the content of the after and before attributes will be output.

escape:

Adds an escape character before quotation marks in the output.

The attribute makes it easier to process the tag-produced content when using JavaScript.

Allowed values:true/false. The default value is false.

or:

Defines alternative content that is displayed if the tag itself does not produce any content.

Allowed values:HTML and Interface markup.

E.g. or:'Sisältöä ei löytynyt.'