Directives are meta-data that appears in comments within the template code (typically at the top of the template). When present, they generate fields that merchants may fill in, allowing them to customize their web site without having to edit code.
...
Name | Value 1 | Value 2 | Description | Example |
|---|---|---|---|---|
uc:page-attribute-boolean | Name of the attribute | Default Value | A yes/no attribute that appears as a checkbox in the user interface. | ## uc:page-attribute-boolean="show-comments|true" |
uc:page-attribute-color | Name of the attribute | Default Value | An HTML color that displays as a color picker in the user interface | |
uc:page-attribute-definitionlist | Name of the attribute | A definition list allows terms/definitions or name/value pair lists to be configured | ||
uc:page-attribute-deprecated | Name of the attribute | Marks an attribute as deprecated to allow the merchant warning that it will disappear in future releases | ||
uc:page-attribute-html | Name of the attribute | Default Value | A block of HTML. The editor in the user interface is a syntax highlighting editor. | |
uc:page-attribute-integer | Name of the attribute | Default Value | A number input | |
uc:page-attribute-itemset | Name of the attribute | Default Value | A set of item ids. The input contains a an item search field to make located the items easier. | |
uc:page-attribute-multiline | Name of the attribute | A multi-line text input field. | ||
uc:page-attribute-pagecollection | Name of the attribute | Provides a rich UI widget allowing merchants to select a group of pages for whatever end is desired | ||
uc:page-attribute-rgba | Name of the attribute | Default Value | rgba color picker | |
uc:page-attribute-simplelist | Name of the attribute | A simple list allows for a series of information to be configured within an attribute. | ||
uc:page-attribute-slider | Name of the attribute | Provides a rich UI widget to allow merchants to configure a slider | ||
uc:page-attribute-string | Name of the attribute | Default Value | A single line text input field | |
| Name of the code | Instructs the editor that this page uses child images by a certain code. Imagine a catalog page that needs to list out many child pages. If the page wishes to show a particular image for each child page, it can specify the code here. When the merchant edits the child page, a placeholder will be created alerting the merchant that they need to supply that image. | ||
| Name of the code | Instructs the editor to display a deprecated warning next to a particular multimedia image, alerting the merchant that the child page's image is no longer in use. | ||
| 'true' | Instructs the editor that this page uses the default image of each child page, most likely to display a thumbnail of the children. | ||
| 'true' | Instructs the editor that the page description is used. | ||
| Name of the code | Instructs the editor that this page template uses a multimedia image given by a particular code. The editor will display a placeholder for that image to remind the merchant they need to provide an image for proper operation. | ||
| Name of the code | Instructs the editor to display a deprecated warning next to a particular multimedia image, alerting the merchant that the image is no longer in use. | ||
| 'true' | Instructs the editor that this page uses the default image, prompting the merchant to supply a default image. | ||
| Name of the code | Instructs the editor that each page in a pagecollection uses images by a certain code. Imagine a catalog page that needs to list out a collection of pages. When the merchant edits any page in the pagecollection, a placeholder will be created alerting the merchant that they need to supply that image. | ||
| Name of the code | Instructs the editor to display a deprecated warning next to a particular multimedia image, alerting the merchant that the image is no longer in use. | ||
| Name of the code | Instructs the merchant that any page found in the pagecollection needs to supply a default image. |
public static final String DIRECTIVE_THEME_ATTRIBUTE_DEPRECATED = "uc:theme-attribute-deprecated";
public static final String DIRECTIVE_THEME_ATTRIBUTE_ITEMSET = "uc:theme-attribute-itemset";
public static final String DIRECTIVE_THEME_ATTRIBUTE_STRING = "uc:theme-attribute-string";
public static final String DIRECTIVE_THEME_ATTRIBUTE_SIMPLE_LIST = "uc:theme-attribute-simplelist";
public static final String DIRECTIVE_THEME_ATTRIBUTE_DEFINITION_LIST = "uc:theme-attribute-definitionlist";
public static final String DIRECTIVE_THEME_ATTRIBUTE_MULTILINE = "uc:theme-attribute-multiline";
public static final String DIRECTIVE_THEME_ATTRIBUTE_COLOR = "uc:theme-attribute-color";
public static final String DIRECTIVE_THEME_ATTRIBUTE_RGBA = "uc:theme-attribute-rgba";
public static final String DIRECTIVE_THEME_ATTRIBUTE_BOOLEAN = "uc:theme-attribute-boolean";
public static final String DIRECTIVE_THEME_ATTRIBUTE_INTEGER = "uc:theme-attribute-integer";
public static final String DIRECTIVE_THEME_ATTRIBUTE_HTML = "uc:theme-attribute-html";
public static final String DIRECTIVE_SITE_ATTRIBUTE_DEPRECATED = "uc:site-attribute-deprecated";
public static final String DIRECTIVE_SITE_ATTRIBUTE_ITEMSET = "uc:site-attribute-itemset";
public static final String DIRECTIVE_SITE_ATTRIBUTE_STRING = "uc:site-attribute-string";
public static final String DIRECTIVE_SITE_ATTRIBUTE_SIMPLE_LIST = "uc:site-attribute-simplelist";
public static final String DIRECTIVE_SITE_ATTRIBUTE_DEFINITION_LIST = "uc:site-attribute-definitionlist";
public static final String DIRECTIVE_SITE_ATTRIBUTE_MULTILINE = "uc:site-attribute-multiline";
public static final String DIRECTIVE_SITE_ATTRIBUTE_COLOR = "uc:site-attribute-color";
public static final String DIRECTIVE_SITE_ATTRIBUTE_RGBA = "uc:site-attribute-rgba";
public static final String DIRECTIVE_SITE_ATTRIBUTE_BOOLEAN = "uc:site-attribute-boolean";
public static final String DIRECTIVE_SITE_ATTRIBUTE_INTEGER = "uc:site-attribute-integer";
public static final String DIRECTIVE_SITE_ATTRIBUTE_HTML = "uc:site-attribute-html";
/**
* item attributes will be configured at the item level using the item editor pages.
*/
public static final String DIRECTIVE_ITEM_ATTRIBUTE_DEPRECATED = "uc:item-attribute-deprecated";
public static final String DIRECTIVE_ITEM_ATTRIBUTE_STRING = "uc:item-attribute-string";
public static final String DIRECTIVE_ITEM_ATTRIBUTE_SIMPLE_LIST = "uc:item-attribute-simplelist";
public static final String DIRECTIVE_ITEM_ATTRIBUTE_DEFINITION_LIST = "uc:item-attribute-definitionlist";
public static final String DIRECTIVE_ITEM_ATTRIBUTE_MULTILINE = "uc:item-attribute-multiline";
public static final String DIRECTIVE_ITEM_ATTRIBUTE_COLOR = "uc:item-attribute-color";
public static final String DIRECTIVE_ITEM_ATTRIBUTE_RGBA = "uc:item-attribute-rgba";
public static final String DIRECTIVE_ITEM_ATTRIBUTE_BOOLEAN = "uc:item-attribute-boolean";
public static final String DIRECTIVE_ITEM_ATTRIBUTE_INTEGER = "uc:item-attribute-integer";
public static final String DIRECTIVE_ITEM_ATTRIBUTE_HTML = "uc:item-attribute-html";
public static final String DIRECTIVE_ITEM_MULTIMEDIA_DEFAULT_USED = "uc:item-multimedia-default-used";
public static final String DIRECTIVE_ITEM_MULTIMEDIA_CODE = "uc:item-multimedia-code";
public static final String DIRECTIVE_ITEM_MULTIMEDIA_CODE_DEPRECATED = "uc:item-multimedia-code-deprecated";
public static final String DIRECTIVE_BLOG_POST_ATTRIBUTE_DEPRECATED = "uc:blog-post-attribute-deprecated";
public static final String DIRECTIVE_BLOG_POST_ATTRIBUTE_STRING = "uc:blog-post-attribute-string";
public static final String DIRECTIVE_BLOG_POST_ATTRIBUTE_SIMPLE_LIST = "uc:blog-post-attribute-simplelist";
public static final String DIRECTIVE_BLOG_POST_ATTRIBUTE_DEFINITION_LIST = "uc:blog-post-attribute-definitionlist";
public static final String DIRECTIVE_BLOG_POST_ATTRIBUTE_MULTILINE = "uc:blog-post-attribute-multiline";
public static final String DIRECTIVE_BLOG_POST_ATTRIBUTE_COLOR = "uc:blog-post-attribute-color";
public static final String DIRECTIVE_BLOG_POST_ATTRIBUTE_RGBA = "uc:blog-post-attribute-rgba";
public static final String DIRECTIVE_BLOG_POST_ATTRIBUTE_BOOLEAN = "uc:blog-post-attribute-boolean";
public static final String DIRECTIVE_BLOG_POST_ATTRIBUTE_INTEGER = "uc:blog-post-attribute-integer";
public static final String DIRECTIVE_BLOG_POST_ATTRIBUTE_HTML = "uc:blog-post-attribute-html";