List

This is a work in progress document and is subject to change.

Generate a list of content based on the type specified.

The [%list%] is a new function that replaces many other Maropost Commerce Cloud B@SE functions such as [%thumb_list%], [%content_menu%] and other functions.

Body template

While the [%thumb_list%] function takes it's body template from the thumbs directory, the [%list%] function takes it's body template from the list directory, which isn't in a theme directory by default. If you want the exact templates from your thumbs directory then you could copy /httpdocs/assets/themes/[THEME-NAME]/templates/thumb/product/*.html into /httpdocs/assets/themes/[THEME-NAME]/templates/list/product. The [%list%] type will dictate which sub directory the template comes from, e.g , [%list type:'content' template:'category'%] would have a template at /httpdocs/assets/themes/[THEME-NAME]/templates/list/content/category.template.html.

Parameters

[%list type:'content' template:'category' limit:'12' filter:'content_type=category' sort:'content_name' sort_direction:'asc'%]
    ...
[%/list%]

Filters

Filters can be used to fine-tune the results of the list function. A single filter can be used, or multiple filters can be joined using an ampersand & to further limit the results. For example [%list type:'product' filter:'min_price=100'%] will only show products that have a price higher than $100. By adding a max_price=500 filter we can limit the results to only products between $100 - $500: [%list type:'product' filter:'min_price=100&max_price=500'%] Some filters can take multiple values separated by a commaa , for example filter:'parent_sku=item2,item7' will show only child products from those parent SKUs. This is different to joining filters in that you are increasing the results by adding additional values to the same filter. Filters with multiple values can also be combined to different filters, for example: [%list type:'product' filter:'parent_sku=item2,item7&promo_current=y'%] will show all the child products that match those parent SKUs but only if they are on special.

For a full list of filters and their usage see under each list type.

Types

The list tag is consolidated into the following types:

• product
• content
• content_review

The data tags available will be dependant on the type

Type:product

For displaying different types of products and product information.

Type product example

This list function will display the 4 top selling products, using the default product template: /httpdocs/assets/themes/[THEME-NAME]/templates/list/product/template.html.

[%list type:'product' template:'' sort:'top_sellers' limit:'4'%]
     [%param *header%]
          <h3>Popular Products</h3>
          <div class="row">
     [%/param%]
     [%param *footer%]
          </div>
     [%/param%]
[%/list%]

Type:content

For displaying different content types information, e.g, brands or categories.

Type content example

This list function will display 6 items from the content type brands, using the 'brand' template: /httpdocs/assets/themes/[THEME-NAME]/templates/list/content/brand.template.html.

[%list type:'content' filter:'content_type=brand' template:'brand' limit:'6' sort:'content_name'%]
    [%param *header%]
        <hr/>
        <h2 class="text-center">Featured Brands</h2>
        <div class="row featured-brands">
    [%/param%]
    [%param *footer%]
            <div class="col-xs-12 text-center">
                <a href="[%url type:'content' id:'100'/%]">Show All Brands</a>
            </div>
        </div>
    [%/param%]
[%/list%]

Type:content_review

For displaying content page reviews.

Type content_review example

This list function will display a max of 5 content reviews, which is standard for a page that uses the default.template.html template, e.g blogs or information pages.

[%list type:'content_review' limit:'5' filter:'content_id=[@content_id@]'%]
    [%param *header%]
        <h3>Comments ([@reviews@])</h3>
    [%/param%]
    [%param *body%]
        <div itemprop="review" itemscope itemtype="http://schema.org/Review">
            <blockquote>
                <h4 itemprop="name"><i>[%nohtml%][@title@][%/nohtml%]</i></h4>
                <div>
                    <strong>[%if [@reviewname@]%]By: <span itemprop="author">[@reviewname@]</span> on [%/ if%]<meta itemprop="datePublished" content="[%FORMAT type:'date'%][@insert_date@][%/FORMAT%]">[%FORMAT type:'date'%][@insert_date@][%/FORMAT%]</strong>
                </div>
                <span itemprop="description">[%nohtml%][@review@][%/nohtml%]</span>
                [%IF [@review_response@]%]
                    <br /><br />
                    <blockquote>
                        <span class="review_response text-muted"><strong><i>[@config:website_name@] Response</i></strong><br /> [%nohtml%][@review_response@][%/nohtml%]</span>
                    </blockquote>
                [%/IF%]
            </blockquote> <hr />
        </div>
    [%/param%]
[%/list%]

[%list type:'product_review' limit:'5' filter:'sku=[@SKU@]'%]
    [%param *body%]
    <div itemprop="review" itemscope itemtype="http://schema.org/Review">
        <meta itemprop="itemReviewed" content="[@name@]">
        <blockquote>
            <h4 itemprop="name">[%nohtml%][@title@][%/nohtml%]</h4>
            <p itemprop="description">[%nohtml%][@review@][%/nohtml%]</p>
            <div itemprop="reviewRating" itemscope itemtype="http://schema.org/Rating">
                <meta itemprop="worstRating" content = "1">
                <meta itemprop="ratingValue" content = "[@score@]">
                <meta itemprop="bestRating" content = "5">
            </div>
            [%set [@data:ratings-count@] = 1 /%]
            [%while [@data:ratings-count@] <= [@data:score@]%]
                [%set [@data:ratings-count@] = [@data:ratings-count@]+1 /%]
                <i class="fa fa-star"></i>
            [%/while%]
            [%while [@data:ratings-count@] <= 5%]
                [%set [@data:ratings-count@] = [@data:ratings-count@]+1 /%]
                <i class="fa fa-star-o"></i>
            [%/while%]
            <span class="badge">[@score@]</span>
            <div>
                <small>[%if [@reviewname@]%]By: <span itemprop="author">[@reviewname@]</span> on [%/if%]<meta itemprop="datePublished" content="[%FORMAT type:'date'%][@insert_date@][%/FORMAT%]">[%FORMAT type:'date'%][@insert_date@][%/FORMAT%]</small>
            </div>
            [%if [@review_response@]%]
                <br /><br />
                <blockquote>
                    <span class="review_response text-muted"><strong><i>[@config:website_name@] Response</i></strong><br /> [%nohtml%][@review_response@][%/nohtml%]</span>
                </blockquote>
            [%/if%]
        </blockquote>
    </div>
    [%/param%]
[%/list%]

[%list filter:'store_id=[@stloc_id@]' limit:'1'%]
    [%PARAM *body%]
        <h1>[@stloc_name@]</h1>
        <hr>
        <div class="row">
        <div class="col-xs-12 col-sm-8">
            <address>
                <p>
                    [@stloc_street1@] [@stloc_street2@]<br>
                    [@stloc_city@][%if [@stloc_state@] or [@stloc_zip@]%], [@stloc_state@] [@stloc_zip@][%/if%][%if [@stloc_country@]%], [@stloc_country@][%/if%]
                </p>
                <p>
                    [%if [@stloc_phone@]%]<i class="fa fa-phone"></i> [@stloc_phone@]<br>[%/if%]
                    [%if [@stloc_fax@]%]<i class="fa fa-fax"></i> [@stloc_fax@]<br>[%/if%]
                    [%if [@stloc_email@]%]<i class="fa fa-envelope-o"></i> <a href="mailto:[@stloc_email@]">[@stloc_email@]</a><br>[%/if%]
                </p>
            </address>
            <img src="[@thumb_image@]" alt="[@stloc_name@]">
            </div>
            [%if [@stloc_lat@] and [@stloc_lng@]%]
                <div class="col-xs-12 col-sm-4">
                    <a href="https://www.google.com.au/maps/place/[%url_encode%][@stloc_street1@] [@stloc_street2@] [@stloc_city@] [@stloc_state@] [@stloc_zip@][%/url_encode%]/@[@stloc_lat@],[@stloc_lng@],15z">
                        <img src="https://maps.googleapis.com/maps/api/staticmap?center=[@stloc_lat@],[@stloc_lng@]&zoom=20&size=400x400&markers=color:blue%7Clabel:%7C[@stloc_lat@],[@stloc_lng@][%if [@config:GOOGLE_GEO_API@]%]&key=[@config:GOOGLE_GEO_API@][%/if%]" class="img-responsive" alt="[%nohtml%][@stloc_name@] [@stloc_street1@] [@stloc_street2@], [@stloc_city@], [@stloc_state@] [@stloc_zip@], [@stloc_country@][%/nohtml%]">
                    </a>
                </div>
            [%/if%]
        </div>
    [%/PARAM%]
[%/list%]