MMv4 KB
 
List of available Templates for use in Template Packages
  Last Edited - 03/24/2014 3:53pm PDT
  Category Path - Shopping Cart Software Components > Administration Area > Design > FAQs & Tutorials
 
question
What templates are available for inclusion in a Template Package, and which storefront page is each one used on?

A Template Package can contain as little as one template, and up to (roughly) 35 templates. Following is a list of each template that is available, and how each one is used by the shopping cart software.



affiliate_account_login.tpl
Allows affiliates to log in to their Affiliate/Customer Account Area. For example, contains an HTML form to submit data required for an affiliate to log in to their account area.

Storefront URL: http://www.example.com/aff_login.php



affiliate_registration.tpl
Displays form non-affiliates can use to sign up for a store's Affiliate Program. For example, contains an HTML form to submit data required for affiliate account creation.

Storefront URL: http://www.example.com/aff_register.php



affiliate_tid_stats.tpl - New in MMv4
Displays analytical information for a selected affiliate Tracking ID number, such as number of hits, sales, conversion ratio and other statistics.

Storefront URL: http://www.example.com/aff_tid_stats.php



basket.tpl
Page that displays the contents of the customers cart for review during the shopping process.

Storefront URL: http://www.example.com/basket.php



category.tpl
The default template that is applied to category pages in the storefront. A category can be edited to have a different template applied to it.

Storefront URL: http://www.example.com/category.php



checkout_X.tpl - Renamed in MMv4
One or more templates that are applied to the checkout process. The checkout process may contain any number of pages. Change "X" in the name of the template with the number of the checkout step.

The checkout process starts with the checkout_1.tpl file. Then, when a checkout page is submitted, the system will automatically reload the checkout page with the checkout_2.tpl file applied to it, and so on, until the credit card field is submitted. Once a page containing a credit card field is submitted, the system will load the checkout receipt page instead.

Prior to MMv4, the checkout templates were named checkoutX.tpl. (Note the underscore that has been added between "checkout" and ".template" as of MMv4.)

Storefront URL: http://www.example.com/checkout.php



checkout_receipt.tpl
When a customer successfully submits their payment information, the checkout receipt page will be loaded.

Storefront URL: http://www.example.com/checkout_receipt.php



checkout_receipt_print.tpl
A printable version of the checkout area's receipt page.

Storefront URL: http://www.example.com/checkout_receipt_print.php



contact_form.tpl
By default, displays the company address and contact information from the Company Information section of the System Settings, as well as a form that visitors may use to send an email to the store email address specified in the System Settings.

Storefront URL: http://www.example.com/contact_form.php



contact_info.tpl - New in MMv4
It's suggested that the company information from the System Settings, or other details on how to contact your company, be included on this page.

Storefront URL: http://www.example.com/contact_info.php



customer_account_X.tpl
Each page of the customer's Account Area will have a different template applied to it. The customer Account Area may contain any number of pages, and therefore, templates. Change "X" in the template name with the number of the customer Account Area page.

The customer Account Area can be used to display a customer's order history, upcoming subscriptions, contact information, billing options, and more.

As of MMv4, affiliates are also customers, and content that was previously posted in the affiliate's Account Area has been moved to the customer's Account Area.

Storefront URL: http://www.example.com/customer.php



customer_account_login.tpl
Allows customers to log in to their Customer/Affiliate Account Area. For example, contains an HTML form to submit data required for a customer to log in to their account area.

Storefront URL: http://www.example.com/customer_login.php



customer_fetch_login.tpl
Page on which customers can submit a form to have their login information sent to the email address associated with their Customer Account.

Storefront URL: http://www.example.com/customer_fetch_login.php



customer_register.tpl - New in MMv4
Displays form non-customers can use to create a Customer Account. For example, contains an HTML form to submit data required for customer account creation.

Storefront URL: http://www.example.com/customer_register.php



download_delivery.tpl
After a customer successfully logs in to the store's Digital Delivery area, they will  automatically forwarded to this page. Use this page to list all of the Digital Objects the customer has purchased.

Storefront URL: http://www.example.com/digdel_delivery.php



download_login.tpl
This page is used to log the customer in to the store’s Digital Delivery area. After the customer successfully logs in, they will automatically be redirected to the digdel_delivery.php page, where they can access the Digital Objects that they have purchased.

Storefront URL: http://www.example.com/digdel_login.php



downsell.tpl - New in MMv4
If the customer has purchased any products with 1-Click Upsell rules, then the "checkout_special.php" page will be added prior to the checkout_receipt.php page. On the "checkout_special.php" page, the customer will be presented with an additional product that they can place an order for by clicking a button. There is also a button for the customer to click if they wish to decline the offer to purchase the additional product. If the customer declines to purchase a 1-Click upsell product, then the downsell.tpl file is applied to the next product in the chain.

Storefront URL: http://www.example.com/checkout_special.php



email_unsubscribe.tpl
This page is loaded when a customer clicks an unsubscribe link in an email message that was sent using the Modular Mailer bulk email module.

Storefront URL: http://www.example.com/email_unsubscribe.php



events.tpl
Displays all of the active, public events that are running in your store.

Storefront URL: http://www.example.com/events.php



featured_products.tpl
Displays a list of featured products. (The index.php page already has this same functionality, but a dedicated featured products page will allow the index.php page to optionally be used to display different content.)

Storefront URL: http://www.example.com/featured_products.php



gift_certificate_customize.tpl
If the customer purchases a gift certificate product in your store, this page will be prepended to the checkout process. On this page, the customer customizes the gift certificate, adding the recipient’s name and email address, their name and a custom message. If the customer isn’t purchasing any gift certificates, then this page is skipped during the checkout process.

Storefront URL: http://www.example.com/gc.php



gift_certificate_print.tpl - New in MMv4
If the customer purchases a gift certificate product in your store, a link to this page will be provided, which includes a printable version of the gift certificate.

Storefront URL: http://www.example.com/gc_print.php



index.tpl
The store's home page, often used to display new, popular or featured products.

Storefront URL: http://www.example.com/index.php



ospg_subscription_processor.tpl
This template is used by the off-site payment gateway subscription renewal page. If the store's Subscription Product Module Settings are set to allow customers to pay for subscriptions through an off-site payment gateway such as PayPal Website Payments Standard, then store-generated email message SID 204 will contain a link for customers to log in to PayPal to submit payment for their due subscription(s). The link actually leads to the ospg_subscription_processor.php page, but if the subscription is due, then the page automatically redirects to PayPal. If the subscription is not yet due, then the ospg_subscription_processor.php page does not redirect, and is displayed with the ospg_subscription_processor.tpl template applied.

Storefront URL: http://www.example.com/ospg_subscription_processor.php?id=#####



packing_slip.tpl
This template is used by the new system for printing packing slips/shipping manifests for orders. Packing slips may be printed from the Print a Packing Slip link in the Related Pages section of the Order Editor, and from the action menu at the bottom of the Search Orders page.

Storefront URL: http://www.example.com/checkout_receipt_print?selected_template=packing_slip.php



page_not_found.tpl
If a visitor attempts to view a URL that corresponds to the store's domain, but that references a page that does not exist, the visitor will be redirected to the Page Not Found page, which uses the page_not_found.tpl template.

Storefront URL: http://www.example.com/[any file path that does not actually exist]



product.tpl
The default template that is applied to product pages in the storefront. A product can be edited to have a different template applied to it.

Storefront URL: http://www.example.com/product.php



rss.tpl
This storefront page lists several RSS feeds that are available: a list of newest products, featured products and most popular products.

Storefront URL: http://www.example.com/rss.php



search_results.tpl
Displays the products that match the phrase entered in the store’s search field.

Storefront URL: http://www.example.com/search_results.php



ship_address_editor.tpl - New in MMv4
Displays all of the customer's shipping addresses, with fields to edit each or add a new one.

Storefront URL: http://www.example.com/ship_address_editor.php



sitemap_categories.tpl
Lists all of the store's active categories.

Storefront URL: http://www.example.com/sitemap_categories.php



sitemap_products.tpl
Lists all of the store's active, unhidden products.

Storefront URL: http://www.example.com/sitemap_products.php



sitemap_vendors.tpl
Lists all of the store's active vendors.

Storefront URL: http://www.example.com/sitemap_vendors.php



sitemap_webpages.tpl
Lists all of the store's active custom webpages.

Storefront URL: http://www.example.com/sitemap_webpages.php



store_closed.tpl
When a store is closed, users trying to view any storefront page will instead be redirected to the "store closed" page.

Storefront URL: http://www.example.com/store_closed.php



track_shipment.tpl
Displays a page that may be used to track a shipment. The page includes a form to submit the Tracking ID number of the shipment to track.

Storefront URL: http://www.example.com/track_shipment.php



universal.tpl - New in MMv4
Required in every Template Package.
If any of the other templates included in this list, then the universal.tpl file will be used in its place. When the universal template is used in place of a missing template, the shopping cart software will attempt to display the content that is appropriate for that particular storefront page.

At a minimum, a Template Package may contain only the universal.tpl template.

The universal template must include the {UNIVERSAL-CONTENT} QuickCode Tag in order to produce the intended results.

Storefront URL: N/A



upsell.tpl - New in MMv4
If the customer has purchased any products with 1-Click Upsell rules, then the "checkout_special.php" page will be added prior to the checkout_receipt.php page. On the "checkout_special.php" page, the customer will be presented with an additional product that they can place an order for by clicking a button. If the customer purchases a 1-Click upsell product, then the upsell.tpl file is applied to the next product in the chain.

Storefront URL: http://www.example.com/checkout_special.php



vendor.tpl - New in MMv4
The default template that is applied to vendor pages in the storefront. A vendor can be edited to have a different template applied to it.

Storefront URL: http://www.example.com/vendor.php



wish_list.tpl - New in MMv4
Storefront page on which customer's can edit their wish lists, or others can view any wish list that the customer has marked as "public".

Storefront URL: http://www.example.com/wish_list.php



deprecated templates
The following templates from previous versions of the Modular Merchant shopping cart software (version 3 or below) are no longer used in MMv4.

affiliate_account_X.tpl
There is no longer a separate Affiliate Account area. Affiliates are now customers, so the Affiliate Account Area has become a section of the Customer Account Area.

checkoutX.tpl
Renamed checkout_X.tpl

checkout_failure.tpl
When a transaction fails, the customer is no longer taken to a new page to display the failure message. The failure message is displayed on the checkout page the customer was already on.

manufacturer.tpl
Replaced by the vendor.tpl file. All references to "manufacturer" have been replaced by "vendor".
Powered by ModularKB