MMv4 KB
 
QuickCode Tag
  Last Edited - 06/27/2013 8:19am PDT
  Category Path - Glossary
 
QuickCode™ Tags: Add dynamic content to your templates
Before proceeding any further, there is one tool that we recommend learning about before designing or editing templates: QuickCode Tags. QuickCode Tags can be used in your store’s templates to personalize them for each customer, product, category, manufacturer, etc.
 
What is a QuickCode Tag?

A QuickCode Tag is a pseudo HTML tag that contains advanced HTML, PHP or JavaScript code. QuickCode Tags were developed by Modular Merchant to simplify the management of complex code in store templates.

A QuickCode Tag is formatted like this: {SAMPLE-QUICKCODE-TAG}. When viewed in a web browser, QuickCode Tags will be translated into the appropriate content. For example, {COMPANY-NAME} will display your company’s name. Many QuickCode Tags are available for displaying such things as product prices, customer information, the contents of the shopping basket, etc.

Some tags simply display text, and others perform complex operations for you, such as checking to see if a customer is logged in, or forwarding them to a different storefront page if certain criteria is met.
 
Why should I use QuickCode Tags?

Because we went through all the trouble of making them?

Actually, QuickCode Tags can greatly simplify the management of complex tasks that the shopping cart performs. They allow you to display content that is appropriate for the specific storefront page being viewed, instead of creating a separate version for every  different location the content could be displayed.

For example, you can create a single product template which includes the {PRODUCT-NAME} QuickCode Tag. When a Product Details page is viewed, the QuickCode Tag will display that product's name, no matter which product the customer is viewing. Without QuickCode Tags, you’d need to create a separate web page for every single individual product in your store!
 
Where can I use QuickCode Tags?

QuickCode Tags can be used in any of your store’s templates and in the emails generated by the shopping cart software.

Since QuickCode Tags are translated by the store software, they can’t be used on web pages that aren’t part of your store. For example, the {COMPANY-NAME} tag will display your company name on any page in your storefront, but it will not be translated on any custom-made webpage that wasn't generated by the shopping cart software.

an example of a quickcode tag
A product’s name can be displayed on the Product Details page by using the {PRODUCT-NAME} QuickCode Tag.

For example, the following HTML code:
This page contains the details for the {PRODUCT-NAME} product.

Would be displayed in your storefront as something like:
This page contains the details for the Acme Cat Food product.
 
What are QuickCode Tag Parameters?

Some QuickCode tags can include an additional bit of information called a "parameter."  A parameter is a value that will be included when the QuickCode tag is rendered in the web browser. They can be used to issue additional commands in the QuickCode Tag. 

Parameters appear in the QuickCode tag after a colon at the end of the name, but before the final curly brace.

including parameters in a quickcode tag
Products can have multiple images associated with them.  You can display a specific product image by including the number and size in the QuickCode Tag.  For example, to generate an <img> tag for the fifth medium-sized image associated with a product, you can add the following parameters to the {PRODUCT-IMAGE-TAG} QuickCode Tag:

{PRODUCT-IMAGE-TAG:5:medium}

When a customer views the page, the QuickCode will be translated into an <img> tag for the medium-sized version of the fifth image for that product.

reference: quickcode tag online glossary
There are over 650 QuickCode Tags available. A searchable list of all the available QuickCode Tags can be found in the online glossary, which includes definitions and examples on using each QuickCode Tag.

The glossary is located at: http://qc.modularmerchant.com
Powered by ModularKB