affiliateKnow what you need? Click the link to jump directly to the information about that item:
affiliate • affiliatelink • basket • body • buttons • category • category_title • category_tree • colors • countries • customer • customerlink • fonts • hdft • head • inventory • messages • mmui_messages • navbar • order • order_contents • order_customer • payment • paymentmethods • product • product_attributes • product_display • product_list • prod_ctgy_hdft • shippingmethods • states • store • tax • upsale • upsell_attr_mult
The SMT
Examples of the various ways of using each entity and the associated items, are given below. Also, see Working with Page Templates.
Remember, before an item, or any of the entities belonging to it, can be referenced on a page, the item must be assigned to the page. This does not mean that the item must appear on the page in the store.
You can also see which items are assigned to a page from the Items tab for that page. To see this screen, from the left navigation area of the administration interface, under the store name, click Pages. Locate the page you want to work with, and click the associated Edit button. To view only the assigned items, click Assigned.
When an item is assigned to a page, if there are configurable options for that item, a tab will be available at the top of the screen, after the Pages and Items tabs. Many tabs include the option to edit in either Point + Click Mode, where you select from options that are presented, or Advanced Mode, where you can edit the template for that part of the page directly. On tabs with this option, the links to Point + Click Mode and Advanced Mode will be at the bottom of the tabbed area. A good example of this is the Body Tag tab, which is present on every page.
To assign or unassign an item, click the Items tab. Select or clear the check box associated with the item, and click Update.
For instance, if you want to use the background color from the navigation bar on the Basket Contents page, the navbar item must be assigned to that page. A quick look will confirm that it is. So the entity &mvt:navbar:nav_bg; will be recognized.
On the other hand, let's say we would like to display the customer's name on the Basket Contents page. The item customer is not assigned to that page by default. If we attempt to reference the customer name, it will not be found. Assign the customer item to the Basket Contents page, then any entity from that item can be used.
affiliateComponent Module Name: MMUI Affiliate Add/Edit
Component Module Code: cmp-mmui-afae
Provides the set of fields where affiliates enter, or edit, their account information.
When this item is assigned to a page, the Affiliate Fields tab becomes available on the Edit Page screen.
The scope of the affiliate item is local (not global). This means that the layout of the fields can be changed on any page where they are used, without affecting other pages.
Putting <mvt:item name="affiliate" /> on a page will display set of fields used to enter affiliate information. For instance, the Affiliate Create page in the store is where affiliates can sign up to work with your store. Looking at the template code for that page, you can see that there are headers, and the navigation bar at the top, followed by the <mvt:item name="affiliate" /> item, and finally, the footers.
In the default store configuration, the affiliate item is assigned to the following pages:
affiliatelinkComponent Module Name: MMUI Affiliate Sign-in Link
Component Module Code: cmp-mmui-afflink
This item creates the affiliate link.
You can place this item anywhere you would like an affiliate link to appear on the page.
When this item is assigned to a page, the Affiliate Links tab becomes available on the Edit Page screen.
The scope of the affiliatelink item is global, meaning that it is used storewide. Any change will affect all store pages where it is used.
In an unmodified store, <mvt:item name="affiliatelink" />, is used on the storefront screen (SFNT) to display the affiliate link, just above the category tree. You can see this by looking at the template code for that page.
On the storefront screen (SFNT), there is an affiliate link, just above the category tree.
Let's say you want to also display a message when the affiliate is logged into the store. In the template code for that page (SFNT), just below the affiliate link, <mvt:item name="affiliatelink" />, you would check to see if the affiliate is logged in, and if so, display a short message, like this:
<mvt:if expr="l.settings:affiliatelink:affiliate_loaded">
Thank you for supporting our store.
</mvt:if>
<br><br>
The two breaks at the end are just to provide some separation between the message, and the top of the category tree, which appears just below it. You can format it any way that suits you.
In the default store configuration, the affiliatelink item is assigned to the following pages:
basketComponent Module Name: MMUI Basket Contents
Component Module Code: cmp-mmui-basket
Displays the contents of the shopper's basket, or a message, when there are no items in the basket.
When this item is assigned to a page, the Basket Contents tab becomes available on the Edit Page screen.
The scope of the basket item is local, meaning that the formatting of the Basket Contents table can be changed on each page where it is used, without affecting the formatting on other pages.
Putting <mvt:item name="basket" /> on a page will create a table displaying the contents of the basket, or a message explaining that the basket is empty.
To see real-life examples using basket entities and items, go to the Edit Page screen for the Basket Contents page (BASK), and click the Basket Contents tab. The code here constructs the part of the Basket Contents screen where the basket contents are displayed (following the header, navigation bar, and so on).
In a simple use of a basket entity, a page can display the total price of items in the shopper's basket:
Your current subtotal is: <b>&mvt:basket:formatted_total;</b>.
In the default store configuration, the basket item is assigned to the following pages:
bodyComponent Module Name: MMUI Body Tag
Component Module Code: cmp-mmui-body
Functions as the <body> tag in page templates, and contains the <body> tag settings specified in the adminstration interface.
When this item is assigned to a page, the BODY Tag tab becomes available on the Edit Page screen.
The scope of the body item is global. That is, any change to the body tag will affect all store pages.
Used in page templates as an HTML <body> tag would be used on an ordinary Web page:
<html>
<head>
head tag contents
</head><mvt:item name="body">
body tag contents
</mvt:item></html>
Let's say you want the background color of a table column to be the same color as the link color. You would specify the background color as equal to the body link color, like this:
<td align="left" valign="top" bgcolor="&mvt:body:link;">
In the default store configuration, the body item is assigned to all pages.
buttonsComponent Module Name: MMUI Buttons
Component Module Code: cmp-mmui-buttons
Provides the collection of buttons used throughout the store, including text button labels, and graphic button images.
Always used with a parameter, specifying which button to display. Using <mvt:item name="buttons" /> alone on a page will not display anything. The form to use is <mvt:item name="buttons" param="ButtonName" />. Each of the available parameters is listed below.
When this item is assigned to a page, the Buttons tab becomes available on the Edit Page screen.
The scope of buttons is global, or storewide. When the formatting or contents of any button is changed on any page where it is used, the change will appear everywhere that button appears.
Not used as a standalone item, except with parameters. Putting <mvt:item name="buttons" /> on a page will not display anything.
Each of the button parameters listed here corresponds to one of the standard buttons specified on the Edit Store / Buttons screen. Changes made on that screen, or in the buttons item code for any page template, will be reflected consistently throughout the store:
An excellent place to see buttons in action is under Category Product List Layout on the Category Display page. For instance, where the Add One To Basket button appears in the code you will see:
<mvt:item name="buttons" param="Add1ToBasket" />
In the default store configuration, the buttons item is assigned to the following pages:
categoryComponent Module Name: Standard Category Fields
Component Module Code: cmp-mv-stdcatfields
Displays some information about the current category. Also see Category Tree, and Category Title, below.
Because there is nothing to edit or format, when this item is assigned to a page, no new tab becomes available on the Edit Page screen.
The category item is generated from the contents of the store database.
Not used as a standalone item. Putting <mvt:item name="category" /> on a page will not display anything.
You are most likely to use the name of the category. For instance, on the Category Display page, the page title incorporates the name of the category:
<title>&mvt:store:name;: &mvt:category:name;</title>
In the default store configuration, the category item is assigned to the following page:
category_titleComponent Module Name: MMUI Category Title
Component Module Code: cmp_mmui_cattitle
Provides the link to the category title image, if one is used.
Because there is nothing to edit or format, when this item is assigned to a page, no new tab becomes available on the Edit Page screen.
The category_title item is generated from the contents of the store database.
Not used as a standalone item. Putting <mvt:item name="category_title" /> on a page will not display anything.
In the snippet of code below, from the Category Display page, we first check to see if there is a category title image specified for the category. If there is, it is displayed, with the name of the category used as the alternative ("alt") text. If there is no image, the category name is displayed, using the header font (specified under Edit Store / Fonts).
<mvt:if expr="NOT ISNULL l.settings:category_title:image">
<img src="&mvte:category_title:image;" alt="&mvte:category:name;" border="0">
<mvt:else>
<mvt:item name="fonts" param="hdr_font">
<b>&mvte:category:name;</b>
</mvt:item>
</mvt:if>
In the default store configuration, the category_title item is assigned to the following page:
category_treeComponent Module Name: MMUI Category Tree
Component Module Code: cmp_mmui_cattree
Creates the category tree, taking into account parent/child hierarchical relationships, category images, and display order.
The category tree, unlike the Navigation Bar for instance, cannot be edited directly. Because there is nothing to edit or format, when this item is assigned to a page, no additional new tab becomes available on the Edit Page screen.
The category_tree item is generated from the contents of the store database.
Putting <mvt:item name="category_tree" /> on a page will display the category tree. A good example of this is on the storefront page (SFNT), where the category tree appears in a table column, just below the customer and affiliate links:
<td align="left" valign="top" nowrap>
<mvt:item name="fonts" param="ctgy_font">
<mvt:item name="customerlink" />
<mvt:item name="affiliatelink" />
<mvt:item name="category_tree" />
</mvt:item>
</td>
In the default store configuration, the category_tree item is assigned to the following pages:
colorsComponent Module Name: MMUI Miscellaneous Colors
Component Module Code: cmp-mmui-colors
Provides the three store-wide colors can be referenced on that page. For details, see Edit Store / Misc. Colors.
When this item is assigned to a page, the Colors tab becomes available on the Edit Page screen.
The scope of colors is global. That is, changing the colors defined by this item on one page will affect all store pages on which they appear.
Not used as a standalone item. Putting <mvt:item name="colors" /> on a page will not display anything.
To see one of the above colors entities in a real-world example, see the page template code for the storefront page (SFNT). The table column where the category tree is displayed uses, appropriately, the category tree background color, as specified under Edit Store / Misc. Colors:
<td align="left" valign="top" bgcolor="&mvt:colors:ctgy_bg;">
In the default store configuration, the colors item is assigned to the following pages:
countriesComponent Module Name: Country Selector
Component Module Code: cmp-mv-countryselect
When the countries item is assigned to a page, it provides the store drop-down list of countries.
Because the countries selector item cannot be formatted, no new tab becomes available on the Edit Page screen. Changes to the countries listed are made only from the Countries screen. The defaults displayed initially are set when the visitor (customer, or affiliate) selects their country.
A special note of caution here... You could put <mvt:item name="countries" />, without any parameter, in page template code, and the page would display a countries drop-down list, with "<Select One>" as the default. However, the input from that drop-down list would not be saved anywhere. The parameter, in addition to displaying the default country, determines how the input will be saved--to the customer or affiliate record, or with the order.
Each of the parameters below will cause the appropriate default country to appear in the drop-down list. That is, when an affiliate or customer views their account information, they will see the country they last entered.
The BillCountry and ShipCountry parameters cause the list to default to the same country as the store owner's country--for instance, if the store owner's address is in Norway, the countries on the order screen (when ordering without a customer account) will default to Norway.
When the shopper or affiliate makes a selection, and submits the information, the parameter specifies where the country information will be saved.
Used with parameters, to request the country associated with a customer's or affiliate's address. For instance, on the Customer Create page, where a customer signs up for an account with your store, there are two Country drop-down lists, one under Ship To, and one under Bill To. The following items, used with parameters, create those drop-down lists:
<mvt:item name="countries" param="Customer_ShipCountry" />
<mvt:item name="countries" param="Customer_BillCountry" />
You can see these in action by going to Pages, then editing the Customer Create page. Click the Customer Fields tab to view the code that creates the customer input fields.
In the default store configuration, the countries item is assigned to the following pages:
customerComponent Module Name: MMUI Customer Fields
Component Module Code: cmp-mmui-custfields
Provides the set of fields where customers enter, or edit, their account information.
When this item is assigned to a page, the Customer Fields tab becomes available on the Edit Page screen.
The scope of the customer item is local (not global). That is, the layout of the customer fields can be changed on any page where they are used, without affecting other pages.
Putting <mvt:item name="customer" /> on a page will display set of fields used to enter customer information. For instance, the Customer Create page in the store is where customers can sign up for accounts with your store. Looking at the template code for that page, you can see that there are headers, a navigation bar, and so on, followed by the <mvt:item name="customer" /> item, and finally, the footers.
You can view, and edit, the layout of the customer fields on the Customer Create page from the Customer Fields tab.
In the default store configuration, the customer item is assigned to the following pages:
customerlinkComponent Module Name: MMUI Customer Sign-in Link
Component Module Code: cmp-mmui-custlink
Displays a link that goes to the screen (LOGN) where a shopper can log in, or sign up for a customer account. Once the customer is logged in, this item displays a new link, by which the customer can go to the screen (ACNT) showing their account information.
When this item is assigned to a page, the Customer Links tab becomes available on the Edit Page screen.
The scope of customerlink is global. That is, any changes to the links will be reflected on all store pages where they are displayed.
Putting <mvt:item name="customerlink" /> on a page will display the appropriate link (Login, or Account), depending on whether the customer is logged in. You can see this on the Storefront page (SFNT), just above the category tree item.
In the default store configuration, the customerlink item is assigned to the following pages:
fontsComponent Module Name: MMUI Fonts
Component Module Code: cmp-mmui-fonts
Provides the four storewide fonts that can be referenced on that page. For details, see Edit Store / Fonts.
When this item is assigned to a page, the Fonts tab becomes available on the Edit Page screen.
The scope of fonts is global. That is, any change to the four fonts here will be reflected storewide.
The fonts item can be used either with parameters, or as individual entities. When used with parameters, it effectively takes the place of an HTML fonts tag. Like the HTML fonts tag, it must be closed, and everything between the opening and closing will be formatted with the specified font.
When fonts are used in this way, the complete font specification is used. That is, the typestyle, or face, the size, and the color are all used when you specify a font using one of these four parameters.
Not used as a standalone item. Putting <mvt:item name="fonts" /> on a page will not display anything.
On the Storefront page (SFNT), in the page code, where the category tree is displayed <mvt:item name="fonts" param="ctgy_font"> insures that the affiliate link, customer link, and category tree will all be displayed in the font specified for the categories.
You can use any of these fonts throughout the store. For instance, if you want "Summer Sale!" displayed in the same font as is used for headings (hdr_font) in your store, you would do this in the page template code:
<mvt:item name="fonts"
param="hdr_font">
Summer Sale!
</mvt:item>
Each of the qualities of the body font can be used independently. For instance, the color could be used as the color for a horizontal rule, separating blocks of text, so that the text color, and line color match, like this: <hr color="="&mvte:font:body_color">.
Like the body font, any aspect of the font used for headings in the store can be used to keep design consistent throughout the store. For instance, the color might be used to highlight some body text, so that when the color of the headings is changed, the highlighted text will be changed along with it, as shown here: <font color="&mvte:font:hdr_color">.
The font face, font size, or font color from the list header font can also each be used on their own.
Finally, any quality of the category tree font can also be applied to format the contents of a page template.
On the Basket Contents page, if there are no items in the basket, a shopper will see the message "Your shopping basket is currently empty." The message is formatted in the same font as body text throughout the rest of the store. Here is how that part of the page is created:
<mvt:if expr="l.settings:basket:empty">
<mvt:item name="fonts" param="body_font">
Your shopping basket is currently empty.<br>
</mvt:item>
<mvt:exit />
In the default store configuration, the fonts item is assigned to all pages.
hdftComponent Module Name: Headers & Footers
Component Module Code: cmp-mv-hdft
Provides the page header and footer, and global header and footer. These headers and footers can be formatted using HTML, or can be entered as plain text, and use default formatting. The positions of each kind of header and footer are illustrated here, in Store Layout Elements.
When this item is assigned to a page, two new tabs become available on the Edit Page screen, the Header & Footer tab, and the Global Header & Footer tab.
The scope of edits under Header & Footer is local. That is, the page header and page footer can be changed, without affecting the page headers and page footers on other pages.
The scope of edits under Global Header & Footer is global. That is, any changes to the global header or global footer will be reflected on all store pages where they are displayed.
Not used as a standalone item. Putting <mvt:item name="hdft" /> on a page will not display anything.
Both kinds of headers and footers are used throughout the store. For instance, the global header is typically the first entry after the opening of the body item tag:
<mvt:item name="body">
<mvt:item name="hdft" param="global_header" />
...
Scrolling down, through the page template code, you will see each of the others. The global header and footer appear first and last, respectively, while the page header and footer frame the contents of the main store area.
In the default store configuration, the hdft item is assigned to all pages.
headComponent Module Name: HTML HEAD Tag Content
Component Module Code: cmp-mv-head
Provides content to go within the head tag on store pages. Note that this does not provide the head tag itself.
When this item is assigned to a page, the HEAD Tag Content tab becomes available on the Edit Page screen.
The scope of the head item is global. That is, any change to the contents of the head tag will affect all store pages on which it appears.
Putting <mvt:item name="head" /> within the existing head tag on a page will include the contents of this item in the in the existing HTML head tag. In this snippet of code, from the Product Display page template, the head item might supply a meta tag with keywords:
<head>
<title>&mvt:store:name;: &mvt:product:name;</title>
<base href="&mvt:global:basehref;">
<mvt:item name="head" />
</head>
In the default store configuration, the head item is assigned to all pages.
inventoryComponent Module Name: Inventory Settings
Component Module Code: cmp-mv-inventory
Provides the storewide default inventory settings. These can be overridden by any product-specific inventory settings.
For details on how the settings below are used, see Inventory Settings & E-mail Notification.
Because there is nothing to edit or format, when this item is assigned to a page, no new tab becomes available on the Edit Page screen.
Remember, even when there is no visible evidence of an item on the store screen, the item must still be assigned to the page before it can be used in the page template code.
The inventory item is most commonly used to check if inventory is active in the store, before displaying something on the page. For instance, in the Product List page template code (PLST), under Product List Layout, if inventory is being used in the store (that is if inventory is active), then a heading for availability information is included at the top of the list. Notice that the list heading is created as a table column, with the background color being the storewide list header background color, and the font being the storewide list header font, in bold:
<mvt:if expr="l.settings:inventory:active">
<td align="right" valign="middle" bgcolor="&mvt:colors:lhdr_bg;">
<mvt:item name="fonts" param="lhdr_font">
<b>Availability</b>
</mvt:item>
</td>
</mvt:if>
Putting <mvt:item name="inventory" /> on a page will not display anything.
These are not used on any of the standard store pages. The appropriate messages are displayed automatically by the product display item, where product information appears. Any product-specific inventory settings override the storewide default ones here.
You could use the items above, however. For instance, you might create an explanatory page to answer shoppers' question about your store. On that page you could include information about inventory messages the shopper might encounter. Here is how you might create this text in the page template so that it dynamically updates when you change the storewide out-of-stock message:
When an item is not available you will see this message:<br>
&mvt:inventory:out_long;<br>
or a shorter message:<br>
&mvt:inventory:out_short;<br>
Note that " " forces a single space, so in this case the inventory messages would be indented by three spaces. The <br> tags place line breaks at the end of each line. If the messages use tokens, such as %product_name%, those will appear in your example messages.
Remember, especially when creating customized pages from scratch, if the text you would expect to see, as a result of placing an entity on a page, does not appear, double-check that you have assigned the item to the page.
In the default store configuration, the inventory item is assigned to the following pages:
messagesComponent Module Name: Standard Validation/Error/Informational Messages
Component Module Code: cmp-mv-messages
This item displays any appropriate informational (blue) or error (red) message, depending on context.
Provides the appropriate maintenance mode message, as specified under Edit Store / Maintenance Mode. When the store is not in maintenance mode, no message is displayed. When a scheduled maintenance time approaches, the warning message is displayed. While the store is offline for maintenance, a message is displayed letting visitors know what is happening.
For details on working with these messages, see Edit Store / Maintenance Mode.
Because the message is generated based on the maintenance mode settings, when this item is assigned to a page, no new tab becomes available on the Edit Page screen. The message settings, made on the Edit Store / Maintenance Mode screen, are global--they affect all store pages where this item is used.
Putting <mvt:item name="messages" /> on a page will display the appropriate message, depending on the current state of the store, and maintenance mode settings. In the case of the Maintenance Mode page, which is displayed while the store is offline, the message makes up the entire contents of the main store area, between the headers and footers, and is displayed in the store headings font:
<tr><td align="left" valign="top">
<mvt:item name="fonts" param="hdr_font">
<mvt:item name="messages" />
</mvt:item>
</td></tr>
In the default store configuration, the messages item is assigned to the following pages:
mmui_messagesComponent Module Name: MMUI Messages
Component Module Code: cmp-mmui-messages
Provides the storefront welcome message, and the invoice thank you message, as specified under Edit Store / Messages.
For details on working with these messages, see Edit Store / Maintenance Mode.
Because the message is generated based on the store message settings, when this item is assigned to a page, no new tab becomes available on the Edit Page screen. The message settings, made on the Edit Store / Messages screen, are global--they affect all store pages where this item is used.
Not used as a standalone item. Putting <mvt:item name="mmui_messages" /> on a page will not display anything.
There are two places where this item is used in a standard store. The storefront screen (SFNT) displays the storefront welcome message:
<mvt:item name="mmui_messages" param="welcome" />
and the invoice screen (INVC) displays the invoice thank you message:
<mvt:item name="mmui_messages" param="thank" />
In the default store configuration, the mmui_messages item is assigned to the following pages:
navbarComponent Module Name: MMUI Navigation Bar
Component Module Code: cmp-mmui-navbar
Creates an HTML table containing all the components of the navigation bar.
When this item is assigned to a page, the Navigation Bar tab becomes available on the Edit Page screen.
The scope of the navbar item is global, or storewide. When the formatting or contents of the navigation bar is changed on any page where it is used, the change will appear everywhere the navigation bar appears.
You can see <mvt:item name="navbar" /> at work in most standard MIVA Merchant page templates, near the top of the body item.
In the default store configuration, the navbar item is assigned all pages except for Maintenance Mode (MNTN):
orderComponent Module Name: Standard Order Fields
Component Module Code: cmp-mv-stdorderfields
Provides the date, time, and formatted total associated with an order. Does not display anything, by itself.
The entities provided by the Standard Order Fields item, such as the formatted total amount of the order, can only be displayed on pages. There are no settings to change.
Because there is nothing to edit or format, when this item is assigned to a page, no new tab becomes available on the Edit Page screen.
Not used as a standalone item. Putting <mvt:item name="order" /> on a page will not display anything.
On Order Contents section of the Invoice page (INVC), the order total is displayed
<mvt:item name="fonts" param="lhdr_font">
<b>&mvt:order:formatted_total;</b>
</mvt:item>
In the default store configuration, the order item is assigned to the following page:
order_contentsComponent Module Name: MMUI Invoice Basket Contents
Component Module Code: cmp-mmui-invc-order
Creates an HTML table displaying all the information about the items in the customer's order including:
When this item is assigned to a page, the Order Contents tab becomes available on the Edit Page screen.
The scope of the order_contents item is local. That is, order_contents can be changed on each page where it is used, without affecting other pages.
Putting the item <mvt:item name="order_contents" /> on a page will create a table displaying the items orders, prices, shipping, tax, the order total, and so on.
In the default store configuration, the order_contents item is assigned to the following page:
order_customerComponent Module Name: MMUI Invoice Customer Information
Component Module Code: cmp-mmui-invc-custfields
Creates an HTML table displaying the customer's ship-to and bill-to information, including name, phone, e-mail address, and physical address.
When this item is assigned to a page, the Customer Information tab becomes available on the Edit Page screen.
The scope of the order_customer item is local. That is, order_customer can be changed on each page where it is used, without affecting other pages.
Putting the item <mvt:item name="order_customer" /> on a page will create an HTML table displaying the ship-to and bill-to information for the customer.
In the default store configuration, the order_customer item is assigned to the following pages:
paymentComponent Module Name: Payment Module Fields
Component Module Code: cmp-mv-paymentfields
Gets payment information from the customer, and passes that information along to the payment gateway.
Because there is nothing to edit or format, when this item is assigned to a page, no new tab becomes available on the Edit Page screen.
Used as a standalone item only on the Checkout: Payment Information page. Putting <mvt:item name="payment" /> on a page does not display anything, instead, with some payment modules it passes hidden information to the payment gateway when the form is submitted. You can see the code for this in the template for the Checkout: Payment Information page:
<form method="post"
action="&mvt:payment:url;">
<input type="hidden" name="Action"
value="AUTH">
<input type="hidden" name="Screen"
value="INVC">
<input type="hidden" name="Store_Code"
value="&mvte:global:Store_Code;">
<mvt:item
name="payment" />
Do not alter or remove this code. If you were to do so, the payment process might fail. If you accidentally delete or change this code, remember that you can always use the version history to go back to a previously-saved version. See Working with Version History for details.
A real-life example of using this item with parameters is available on the Checkout: Payment Information (OPAY) screen. Here the code creates a table with a prompt and text-entry field for the particular payment module to get each piece of input from the customer. For instance, a payment module may require the customer's first and last names, and the credit card number.
Notice that if the information entered in a given field is invalid, such as if the customer entered their name in the field for the credit card number, the prompt for that field will be displayed in red when the validity of the information is checked, and the screen is refreshed.
See the page template code for the Checkout: Payment Information screen, where the Payment Information is displayed. If a message was specified, under Payment Configuration, for the selected payment method, it will be displayed in the body font:
<mvt:if expr="NOT ISNULL l.settings:payment:message">
<mvt:item name="fonts" param="body_font">
&mvt:payment:message;<br>
</mvt:item>
</mvt:if>
In the default store configuration, the payment item is assigned to the following page:
paymentmethodsComponent Module Name: Standard Payment Selection Drop-down List
Component Module Code: cmp-mv-payselect
Provides the contents for a drop-down list that the customer uses to select a payment method from the choices offered in the store. In the default store setup this is on the Checkout: Shipping/Payment Selection page, with the prompt Pay With: just to the left of it. The methods offered in the list are those that were set up under Payment Configuration.
Because there is nothing to edit or format, when this item is assigned to a page, no new tab becomes available on the Edit Page screen.
Not used as a standalone item. Putting <mvt:item name="paymentmethods" /> on a page will not display anything. Instead, it is used to populate the drop-down list with information about each of the available payment methods. You can see this in the page template for Checkout: Shipping/Payment Selelction:
<tr><td align="left" valign="middle"
nowrap>
<mvt:item name="fonts" param="body_font">
<b>Pay With:</b>
</mvt:item>
</td><td align="left" valign="bottom">
<mvt:item name="fonts" param="body_font">
<select name="PaymentMethod">
<mvt:foreach
array="paymentmethods" iterator="method">
<option value="&mvte:method:module;:&mvte:method:code;">&mvt:method:name;</option>
</mvt:foreach>
</select>
</mvt:item>
</td></tr>
In the default store configuration, the paymentmethods item is assigned to the following pages:
productComponent Module Name: Standard Product Fields
Component Module Code: cmp-mv-stdprodfields
Provides information about a product, anywhere that product is displayed.
Because there is nothing to edit or format, when this item is assigned to a page, no new tab becomes available on the Edit Page screen.
Not used as a standalone item. Putting <mvt:item name="product" /> on a page will not display anything.
A convenient place to see several examples of product entities is in the template code for the Product Display page, under Product Display Layout. For instance, near the top of the page, the product name is shown in the store header font:
<mvt:item name="fonts"
param="hdr_font">
<b>&mvt:product:name;</b>
</mvt:item>
In another example from the same page, the product image, if there is one, is displayed. If there is no product image, a single space character is inserted:
<mvt:if expr="NOT ISNULL
l.settings:product:image">
<img src="&mvt:product:image;"
alt="&mvt:product:name;">
<mvt:else>
</mvt:if>
In the default store configuration, the product item is assigned to the following pages:
product_attributesComponent Module Name: MMUI Product Attributes
Component Module Code: cmp-mmui-attributes
Displays all of the available attribute options for a given product. The order and format (radio buttons, check boxes, etc) are as specified on the Edit Product screen, under Attributes.
Because there is nothing to edit or format, when this item is assigned to a page, no new tab becomes available on the Edit Page screen.
Not used as a standalone item, except with a parameter, as shown below. Putting <mvt:item name="product_attributes" /> on a page will not display anything.
Simply drop the following snippet of code anywhere you want the attributes for a product displayed:
<mvt:item name="product_attributes" param="product:id" />
Note that this will only work in a context where a product is already present on the page, such as the Product Display Layout area of the Product Display (PROD) screen. It will not work in places where no product information is being presented, such as on the screen where a customer would edit their account information (ACED).
In the default store configuration, the product_attributes item is assigned to the following pages:
product_displayComponent Module Name: MMUI Product Display Layout
Component Module Code: cmp-mmui-prodlayo
Creates the central area of the Product Display screen where information about the product itself is shown.
When this item is assigned to a page, the Product Display Layout tab becomes available on the Edit Page screen. By editing the template code here, you can change the layout of the information describing your products. For instance, you might prefer that product images appear to the right of the
The scope of the product_display item is local. That is, product_display can be changed on each page where it is used, without affecting other pages.
Putting <mvt:item name="product_display" /> on a page will create a table displaying whatever qualities of each product you have specified (product name, price, image, etc.).
In the default store configuration, the product_display item is assigned to the following page:
product_listComponent Module Name: MMUI Product List
Component Module Code: cmp-mmui-prodlist
Creates a table, with headings, that displays a list of products. The most obvious place this item appears is on the Product List (PLST) screen, where it provides the list of products. But it also is used to display products on the Category Display (CTGY) page, related products on the Product Display (PROD) screen, and products listed in search results on the Search (SRCH) screen.
When this item is assigned to a page, the following tabs become available:
The scope of the product_list item is local. That is, product_list can be changed on each page where it is used, without affecting other pages.
Putting <mvt:item name="product_list" /> on a page displays a list of products, formatted as a table, with headings.
In the default store configuration, the product_list item is assigned to the following pages:
prod_ctgy_hdftComponent Module Name: MMUI Product/Category Header & Footer
Component Module Code: cmp-mmui-pchdft
Places the product header or footer, or category header or footer, if there is one, on the page. These headers and footers are set up for each product and category under Edit Product / Header & Footer and Edit Category / Header & Footer.
Because there is nothing to edit or format, when this item is assigned to a page, no new tab becomes available on the Edit Page screen.
Not used as a standalone item, except with parameters, as shown below. Putting <mvt:item name="prod_ctgy_hdft" /> on a page will not display anything.
The four ways of using this item can be found in the page template code for the Product Display and Category Display pages:
<mvt:item name="prod_ctgy_hdft" param="prod_header" />
<mvt:item name="prod_ctgy_hdft" param="prod_footer" />
<mvt:item name="prod_ctgy_hdft" param="ctgy_header" />
<mvt:item name="prod_ctgy_hdft" param="ctgy_footer" />
In the default store configuration, the prod_ctgy_hdft item is assigned to the following pages:
shippingmethodsComponent Module Name: Standard Shipping Selection Drop-down List
Component Module Code: cmp-mv-shipselect
Provides the contents for a drop-down list that the customer uses to select a shipping method from the choices offered in the store. In the default store setup this is on the Checkout: Shipping/Payment Selection page, with the prompt Ship Via: just to the left of it. The methods offered in the list are those that were set up under Shipping Configuration.
Because there is nothing to edit or format, when this item is assigned to a page, no new tab becomes available on the Edit Page screen.
Not used as a standalone item. Putting <mvt:item name="shippingmethods" /> on a page will not display anything. Instead, it is used to populate the drop-down list with each of the available shipping methods. You can see this in the page template for Checkout: Shipping/Payment Selelction.
Note: The example below has been formatted for clarity, but it functionally the same as the template code you will see in your administration interface.
Here, you can see that if there is no shipping method, a comment to that effect will appear in the drop-down list, and a more detailed comment will appear just below the drop-down list. When there are shipping methods available, an option in the drop-down list will be created for each one. If the price is available for a given method, it will be displayed in the list as well.
<mvt:item name="fonts" param="body_font">
<select name="ShippingMethod">
<mvt:if expr="ISNULL l.settings:shippingmethods">
<option value="">Unable
to Calculate Shipping Costs</option>
<mvt:else>
<mvt:foreach array="shippingmethods" iterator="method">
<mvt:if
expr="NOT ISNULL l.settings:method:price">
<option
value="&mvte:method:module;:
&mvte:method:code;">&mvt:method:name;
(&mvt:method:formatted_price;)
</option>
<mvt:else>
<option
value="&mvte:method:module;:
&mvte:method:code;">&mvt:method:name;
</option>
</mvt:if>
</mvt:foreach>
</mvt:if>
</select>
<mvt:if
expr="ISNULL l.settings:shippingmethods">
<br>
<b>No valid shipping methods
are available for your order.
You will be contacted
regarding shipping when your order is processed.</b>
</mvt:if>
</mvt:item>
In the default store configuration, the shippingmethods item is assigned to the following page:
statesComponent Module Name: State Selector
Component Module Code: cmp-mv-stateselect
Provides a drop-down list containing all the states that are included in the store States list. When appropriate, such as when displaying the information for an existing customer, the appropriate parameter (below) causes the drop-down list to display the state from the existing record.
Because there is nothing to edit or format, when this item is assigned to a page, no new tab becomes available on the Edit Page screen.
Not used as a standalone item.
Note: Putting <mvt:item name="states" />, with no parameter, on a page will display a state selection drop-down list, showing the default option (usually something like Outside US, or Please Select a State). The affiliate or customer will be able to select a state, but it will not be accepted as valid input, and the screen will be displayed again, asking them to select a state.
You can see this item at work on several pages (below). On the pages where affiliates can create or edit their accounts, the states item would be used with the Affiliate_StateSelect parameter:
<mvt:item name="states" param="Affiliate_StateSelect" />
In the default store configuration, the states item is assigned to the following pages:
storeComponent Module Name: Standard Store Fields
Component Module Code: cmp-mv-stdstorefields
Provides the store information that is entered on the Edit Store screen, including the store name and contact information, weight and currency units, order minimums, maintenance mode settings, and so on.
Because there is nothing to edit or format, when this item is assigned to a page, no new tab becomes available on the Edit Page screen.
Not used as a standalone item. Putting <mvt:item name="store" /> on a page will not display anything.
This item is assigned to all pages, by default. It is used throughout the store to display the name of the store at the top of the screen:
<title>&mvt:store:name;</title>
In the default store configuration, the store item is assigned to all pages.
taxComponent Module Name: Tax Module Fields
Component Module Code: cmp-mv-taxfields
Provides the way of collecting and passing along whatever information the store tax module requires from the shopper. For each piece of information there is a prompt (such as "Please select the state where your shipping address is located"), and a field for gathering that input (such as a drop-down list). Each tax module specifies the information it is to collect. For each field there is also a flag (a yes/no, or Boolean entity) that indicates if the information is valid.
Because there is nothing to edit or format, when this item is assigned to a page, no new tab becomes available on the Edit Page screen.
Putting <mvt:item name="tax" /> on a page will carry the information about the taxes for a purchase through to following pages, but not display anything on the screen. This is done on all screens that appear between the point where a customer enters the information, and the point where it is ultimately used, when the payment is made for the purchase. This is why you will see the tax SMT item assigned to pages on which no tax information is displayed, such as the Upsell pages.
Incidentally, beyond that point where payment is made, including on the Invoice screen, tax is handled as a charge, along with shipping, so the tax item does not need to be assigned to those pages appearing later in the process.
Each tax module can have a set of one or more fields to collect and hold information from the customer. For instance, one module might require the shopper's ZIP code, while another might ask the shopper for a province name and tax rate. Each module stores this set of fields in an array.
In the example below, from the Checkout: Customer Information screen, the fields required by the tax module would be displayed one after another, as rows in a table, with the prompt in the left column, and the input field in the right column. The prompt would be displayed in red if the previous input to the field were invalid, such as if a customer entered a city name in a ZIP code field.
<mvt:foreach array="tax:fields"
iterator="field">
<tr><td align="left" valign="middle">
<mvt:item name="fonts"
param="body_font">
<mvt:if expr="l.settings:field:invalid">
<font
color="red"><b>&mvt:field:prompt;</b></font>
<mvt:else>
<b>&mvt:field:prompt;</b>
</mvt:if>
</mvt:item>
</td><td align="left" valign="middle">
<mvt:item name="fonts"
param="body_font">
<mvt:item name="tax" param="field:code"
/>
</mvt:item>
</td></tr>
</mvt:foreach>
In the snippet of code above, near the end, you can see how the input fields for the tax module are displayed. The tax item is used, with the parameter of field:code.
Because the tax component uses an array to store prompts, input fields, and validity information, the entities have a slightly different appearance. You may recall that most other entities use the form &mvt:itemname:entityname. For instance, &mvt:product:name; would display the name of the product. But in this case the entities refer to bits of information store in an array, by field. So the form here is &mvt:field:entityname. Specifically, &mvt:field:prompt would display the prompt for the field in question.
See the snippet of code, above. Notice how this entity is used to display the prompt, either in red, or normally.
In the default store configuration, the tax item is assigned to the following pages:
upsaleComponent Module Name: Upsold Product Fields
Component Module Code: cmp-mv-uslprodfields
Provides a means of displaying information about upsale products. This information includes all the usual information that any ordinary product would have (name, description, and so on - see product for details), plus
Because there is nothing to edit or format, when this item is assigned to a page, no new tab becomes available on the Edit Page screen.
Not used as a standalone item. Putting <mvt:item name="upsale" /> on a page will not display anything.
All the entities that are available with the product SMT item, such as name, image, price, and weight, are also available here. You can also use the following entities to display additional information:
Refer to the template for the Checkout: Upsell Product (Single) page, to see where the following examples are used in the store.
As discussed above, any information normally associated with a product can also be displayed for an upsale product. For instance, here is how you can display the name of the product:
<b>Special Offer:</b> &mvt:upsale:name;
In additon to the regular product information, you can show special details that apply when the product is being offered as an upsale product, such as the amount of the savings, compared to the regular price:
<b>Save &mvt:upsale:formatted_upsell_savings;</b>
In the default store configuration, the upsell item is assigned to the following pages:
upsell_attr_multComponent Module Name: MMUI Upsell Multiple Product Attributes
Component Module Code: cmp-mmui-uslmltplattr
When a customer selects upsale items from the Checkout: Upsell Product (Multiple) (OUSM) screen, and there are attributes to be specified for one or more of those products, such as size, or color, this item is used on the Upsell: Missing Product Attributes (Multiple) (UATM) page to display the options for the customer.
Because there is nothing to edit or format, when this item is assigned to a page, no new tab becomes available on the Edit Page screen.
Putting <mvt:item name="upsell_attr_mult" /> on a page will display all the attributes the shopper needs to specify, for any upsale items they selected from the Checkout: Upsell Product (Multiple) (OUSM).
In the default store configuration, the upsell_attr_mult item is assigned to the following page: