Modular Merchant
QuickCode™ Glossary
{PRODUCT-FIELD-DESCRIPTION}
QuickCode Tag Glossary Home
See also:
Knowledge Base
Articles in this category:
{COMPOSITE-PRODUCT-IMAGE-SWAP}

{DIGITAL-SAMPLE-BLOCK-BEGIN}

{DIGITAL-SAMPLE-BLOCK-END}

{DIGITAL-SAMPLE-FILE}

{DIGITAL-SAMPLE-NAME}

{IF-BASKET-CONTAINS-SUBSCRIPTION-PRODUCTS-BEGIN}

{IF-DIGITAL-FILE-ELIGIBLE-BEGIN}

{IF-DIGITAL-FILE-ELIGIBLE-END}

{IF-DIGITAL-FILE-RELEASED-BEGIN}

{IF-DIGITAL-FILE-RELEASED-END}

{IF-DIGITAL-SAMPLE-BEGIN}

{IF-DIGITAL-SAMPLE-END}

{IF-PRODUCT-ATTRIBUTE-DESCRIPTION-BEGIN}

{IF-PRODUCT-ATTRIBUTE-DESCRIPTION-END}

{IF-PRODUCT-ATTRIBUTES-BEGIN}

{IF-PRODUCT-ATTRIBUTES-END}

{IF-PRODUCT-FIELD-DESCRIPTION-BEGIN}

{IF-PRODUCT-FIELD-DESCRIPTION-END}

{IF-PRODUCT-IN-ORDER-BEGIN}

{IF-PRODUCT-IN-ORDER-END}

{IF-PRODUCT-IN-SUBSCRIPTION-BEGIN}

{IF-PRODUCT-IN-SUBSCRIPTION-END}

{IF-PRODUCT-MSRP-SAVINGS-BEGIN}

{IF-PRODUCT-MSRP-SAVINGS-END}

{IF-PRODUCT-USES-STOCK-BEGIN}

{IF-PRODUCT-USES-STOCK-END}

{IF-RESULT-BEGIN}

{IF-RESULT-END}

{LIST-CATEGORIES}

{NEWEST-PRODUCT-BLOCK-BEGIN}

{NEWEST-PRODUCT-BLOCK-END}

{PRODUCT-ACTIVE}

{PRODUCT-ADD-TO-BASKET-BUTTON}

{PRODUCT-ATTRIBUTE-DESCRIPTION}

{PRODUCT-ATTRIBUTE-TITLE}

{PRODUCT-ATTRIBUTE-VALUE}

{PRODUCT-BREADCRUMB-LINKS}

{PRODUCT-FIELD-DESCRIPTION}

{PRODUCT-FIELD-TITLE}

{PRODUCT-FIELD-VALUES}

{PRODUCT-FIELD}

{PRODUCT-IMAGE-CAPTION}

{PRODUCT-IMAGE-TAG}

{PRODUCT-IMAGE-URL}

{PRODUCT-IN-SUBSCRIPTION-SUMMARY}

{PRODUCT-LINE-PRICE}

{PRODUCT-LONG-DESCRIPTION}

{PRODUCT-MODIFIER-MENUS}

{PRODUCT-MODIFIER-PRICE-ADJUSTMENT}

{PRODUCT-MODIFIER-VERSION}

{PRODUCT-MSRP-SAVINGS}

{PRODUCT-MSRP}

{PRODUCT-NAME}

{PRODUCT-ORIGINAL-PRICE}

{PRODUCT-PART-NUMBER}

{PRODUCT-PRICE-ORIGINAL}

{PRODUCT-PRICE-SUFFIX}

{PRODUCT-PRICE}

{PRODUCT-QUANTITY-FIELD}

{PRODUCT-REBILL-TERM-TEXT}

{PRODUCT-SHORT-DESCRIPTION}

{PRODUCT-SID}

{PRODUCT-STATUS}

{PRODUCT-UNITS-IN-STOCK}

{PRODUCT-UNITS-IN-STOCK}

{PRODUCT-WEIGHT}

{RECENTLY-VIEWED-PRODUCT-BLOCK-BEGIN}

{RECENTLY-VIEWED-PRODUCT-BLOCK-END}

{RELATED-PRODUCT-BLOCK-BEGIN}

{RELATED-PRODUCT-BLOCK-END}

{SUBCATEGORY-ACTIVE}

{VENDOR-ATTRIBUTE-TITLE}

{XSELL-BLOCK-BEGIN}

{XSELL-BLOCK-END}

Products > {PRODUCT-FIELD-DESCRIPTION}
<< {PRODUCT-BREADCRUMB-LINKS} {PRODUCT-FIELD-TITLE} >>
{PRODUCT-FIELD-DESCRIPTION} Updated: 07/16/2013

The {PRODUCT-FIELD-DESCRIPTION} QuickCode Tag may be used to display the public description assigned to a product field.

{PRODUCT-FIELD-DESCRIPTION} may be placed between {IF-PRODUCT-FIELD-DESCRIPTION-BEGIN} and {IF-PRODUCT-FIELD-DESCRIPTION-END}, which in turn are placed between {PRODUCT-FIELD-BLOCK-BEGIN} and {PRODUCT-FIELD-BLOCK-END}. With this approach, public descriptions are shown for any product fields that have a public description, without leaving blank spaces or other formatting flaws for product fields that do not have a public description.

Alternatively, {PRODUCT-FIELD-DESCRIPTION} may be placed outside {PRODUCT-FIELD-BLOCK-BEGIN} and {PRODUCT-FIELD-BLOCK-END}, with a specific product field SID number given as a parameter. With this approach, the public descriptions of individual product fields may be displayed at different locations on the page, rather than displaying all product fields in one block.

Assigning a public description to a product field is as simple as typing the description text into the Public Description option in the Product Field Editor, and then clicking the Save Changes to this Product Field button.

Once the product field has been created and configured, including any desired public description, the product field may be assigned to one or more products. Assigning a product field to a product allows the product field to capture input relevant to that product when the product is included in an order. To assign a product field to a product, in the Product Fields section of the Product Editor:

  1. Click the Assign Fields to this product link
  2. Search for the product field in the Search Product Fields popup window
  3. Click the Select button next to the desired product field in the Search Results section
  4. Close the Search Product Fields popup window
  5. Click the blue Save Changes button at the bottom of the Product Editor page
Requirements / Prerequisites

The {PRODUCT-FIELD-DESCRIPTION} QuickCode Tag must either:
Be placed between {IF-PRODUCT-FIELD-DESCRIPTION-BEGIN} and {IF-PRODUCT-FIELD-DESCRIPTION-END}, which in turn are placed between {PRODUCT-FIELD-BLOCK-BEGIN} and {PRODUCT-FIELD-BLOCK-END}
-or-
Include the SID number of a specific product field as a parameter value.

The product field SID parameter is explained in the Customization section below.

Example of Use

1. Assign the public description "This is a public description" to product field SID 2:

Example

2. Do not assign a public description to product field SID 4.

3. Assign product field SID 2 and product field SID 4 to product SID 123:

Example

4. Add the following to the product template (product.tpl):

5. Product SID 123's storefront product detail page will display the following:

Example
Field SID 2
This is a public description.


PF4

Customization

{PRODUCT-FIELD-DESCRIPTION:X}

To display the public description of a specific product field, add the SID number of the product field to the {PRODUCT-FIELD-DESCRIPTION} QuickCode Tag.

For instance, to display the public description of product field SID 2{PRODUCT-FIELD-DESCRIPTION} would become {PRODUCT-FIELD-DESCRIPTION:2}.

When the product field SID number parameter is used, {PRODUCT-FIELD-DESCRIPTION} should not be placed between {IF-PRODUCT-FIELD-DESCRIPTION-BEGIN} and {IF-PRODUCT-FIELD-DESCRIPTION-END}, or  {PRODUCT-FIELD-BLOCK-BEGIN} and {PRODUCT-FIELD-BLOCK-END}. Instead, to display several different product field descriptions, {PRODUCT-FIELD-DESCRIPTION:X} would be added to the template for each product field.

The public description of the specified product field will only be displayed in the storefront if:

  1. The specified product field has a public description.
  2. The specified product field is Active.
  3. The specified product field is not Internal Only.
  4. The specified product field has been assigned to the product which is currently shown.

1. Assign the public description "This is a public description." to product field SID 2:

Example

2. Assign the public description "This is another public description." to product field SID 4.

3. Assign product field SID 2 and product field SID 4 to product SID 123:

Example

4. Add the following to the product template (product.tpl):

Example
{PRODUCT-FIELD-TITLE:2}: {PRODUCT-FIELD-DESCRIPTION:2}
Here is a block of some other content...


{PRODUCT-FIELD-TITLE:4}: {PRODUCT-FIELD-DESCRIPTION:4}

5. Product SID 123's storefront product detail page will display the following:

Example
Field SID 2: This is a public description.
Here is a block of some other content...


PF4: This is another public description.

Source Code Source Code Updated:
When a web page using a template that contains this QuickCode Tag is viewed in the storefront, the {PRODUCT-FIELD-DESCRIPTION} QuickCode Tag is changed into the source code below prior to the web page being displayed.
LOG IN TO ADD COMMENTS
  Copyright © 2001 - 2024 Modular Merchant™. All rights reserved.
Modular Merchant | Privacy Policy | Legal Statement | Terms of Service | Contact Us | Site Map