MySource Matrix users may be familiar with the ability to use keywords to automatically build content. This feature is particularly helpful when creating asset listings however there is a severe lack of documentation provided by Squiz (the developer) – or an inability to find such documentation.
As such, below is the full list of supported keywords for MySource Matrix.
Common Asset Keywords
| Keyword |
Output |
Version |
| %asset_assetid% |
The unique ID of the current asset. |
|
| %asset_name% |
|
|
| %asset_short_name% |
|
|
| %asset_type% |
Type code e.g. page_standard). |
|
| %asset_url% |
Full web address of the current asset. |
|
| %asset_name_linked% |
Asset name linked to asset url |
|
| %asset_href% |
“Web path” of the current asset (i.e. relative href/link). |
|
| %asset_thumbnail% |
|
|
| %asset_thumbnail_alt% |
|
|
| %asset_thumbnail_url% |
|
|
| %asset_thumbnail_caption% |
|
|
| %asset_metadata_X% |
|
|
| %metadata_field_X% |
|
|
Anywhere (global) keywords
| Keyword |
Output |
Version |
| %globals_X% |
A meta-keyword which allows you to list (nearly) any keyword for the current asset. |
3.14.5+ |
| %globals_asset_attribute_X% |
A more specific version of %globals_X% used for asset attributes. |
3.14.5+ |
| %globals_asset_attribute_X:Y% |
A more specific version of %globals_asset_attribute_X% used for listing an asset attribute for the asset ID specified in Y. |
3.14.5+ |
| %globals_icon% |
Asset Map icon of asset type X. |
3.24.0RC1+ |
| %globals_site_X% |
A meta-keyword which allows you to list (nearly) any keyword for the current site. |
3.14.5+ |
| %globals_user_X% |
A meta-keyword which allows you to list (nearly) any keyword for the current user |
3.14.5+ |
| %globals_date_X% |
Prints the current server date and time. Date and time can be formatted by replacing X with a PHP formatted server date/time, for example %globals_date_M% prints the three letter representation of the current month. |
3.20.2+ |
| %globals_get_X% |
Non-array value of a GET variable. |
3.14.5+ |
| %globals_pst_X% |
Non-array value of a POST variable. |
3.20.0+ |
| %globals_server_X% |
Value of PHP Server Variable |
3.14.5+ |
| %globals_session_X% |
Session var. from Matrix sandbox |
|
| %globals_cookie_X% |
Variable from the current user’s cookies. |
3.24.0+ |
| %globals_random% |
Random whole (integer) number. |
|
| %globals_random_X_Y% |
Randomly generated number (X to Y). For example, to generate a random number from 1 to 10 use %globals_random_1_10%. |
3.22.0+ |
| %globals_asset_charset% |
|
3.20.6+ |
| %globals_asset_languages% |
|
3.20.6+ |
| %nested_asset_X% |
|
|
| %referring_X% |
Keyword of referring asset |
|
Keyword Modifiers
| Keyword |
Output |
Version |
| %X^Y% |
Allows the modification of an existing keyword. |
3.24.1+ |
| %Y^urlencode% |
URL encoded version of X. |
3.24.1+ |
| %X^uppercase% |
UPPERCASE version of X. |
3.24.1+ |
| %X^charcount% |
Number of characters in X. |
3.24.1+ |
Less Common Asset Keywords
| Keyword |
Output |
Version |
| %asset_created_by_name% |
|
|
| %asset_created_by_assetid% |
|
|
| %asset_created_by_url% |
|
|
| %asset_published_by_name% |
|
|
| %asset_status_changed_by_name% |
|
|
| %asset_status_description% |
|
|
| %asset_status_colour% |
|
|
| %asset_thumbnail_v_X% |
|
|
| %asset_type_icon% |
Asset Map icon of the current asset. |
3.24.0RC1+ |
| %asset_updated_by_name% |
|
|
| %asset_version% |
|
|
| %asset_version_major% |
|
|
| %asset_version_minor% |
|
|
| %asset_version_micro% |
|
|
| %link_target_X% |
Keyword of the linked asset. |
3.24.1+ |
| %link_relation% |
|
3.24.1+ |
| %link_url% |
The url (or asset) that the link is pointing to |
3.24.1+ |
Date Keyword
| Keyword |
Output |
Version |
| %asset_created_X% |
PHP formatted date the asset was created |
|
| %asset_updated_X% |
PHP formatted date the asset was created |
|
| %asset_published_X% (see example below) |
PHP formatted date the asset was created |
|
| %asset_published_l%, %asset_published_j% %asset_published_F% %asset_published_Y% |
Wednesday, 5 September 2012
|
|
| %asset_created% |
|
|
| %asset_updated% |
2012-10-15 11:31:18 |
|
| %asset_created_short% |
2012-09-05 |
|
| %asset_updated_short% |
2012-10-15 |
|
| %asset_created_readable% |
05 Sep 2012 10:57am |
|
| %asset_updated_readable% |
15 Oct 2012 11:31am |
|
| %asset_created_readabledate% |
05 Sep 2012 |
|
| %asset_updated_readabledate% |
15 Oct 2012 |
|
| %asset_created_readabletime% |
10:57am |
|
| %asset_updated_readabletime% |
11:31am |
|
| %asset_created_iso8601% |
2012-09-05T10:57:18+11:00 |
|
| %asset_updated_iso8601% |
2012-10-15T11:31:18+11:00 |
|
| %asset_created_rfc2822% |
Wed, 05 Sep 2012 10:57:18 +1000 |
|
| %asset_updated_rfc2822% |
Mon, 15 Oct 2012 11:31:18 +1100 |
|
| %asset_created_ical% |
20120905T105718 |
|
| %asset_updated_ical% |
20121015T113118 |
|
| %asset_published% |
2012-09-05 10:57:24 |
|
| %asset_published_short% |
2012-09-05 |
|
| %asset_published_readable% |
05 Sep 2012 10:57am |
|
| %asset_published_readabledate% |
05 Sep 2012 |
|
| %asset_published_readabletime% |
10:57am |
|
| %asset_published_iso8601% |
2012-09-05T10:57:24+11:00 |
|
| %asset_published_rfc2822% |
Wed, 05 Sep 2012 10:57:24 +1000 |
|
| %asset_published_ical% |
20120905T105724 |
|
| %asset_status_changed% |
2012-09-05 10:57:24 |
|
| %asset_status_changed_short% |
2012-09-05 |
|
| %asset_status_changed_readable% |
05 Sep 2012 10:57am |
|
| %asset_status_changed_readabledate% |
05 Sep 2012 |
|
| %asset_status_changed_readabletime% |
10:57am |
|
| %asset_status_changed_iso8601% |
2012-09-05T10:57:24+11:00 |
|
| %asset_status_changed_rfc2822% |
Wed, 05 Sep 2012 10:57:24 +1000 |
|
| %asset_status_changed_ical% |
20120905T105724 |
|
Permission Keywords
| Keyword |
Output |
Version |
| %asset_read_permission% |
Comma separated list of the full names for users with read access. |
|
| %asset_write_permission% |
Comma separated list of the full names for users with write access. |
|
| %asset_admin_permission% |
Comma separated list of the full names for users with administrator access. |
|
| %asset_read_permission_email% |
Comma separated list of email addresses for users with read access. |
|
| %asset_write_permission_email% |
Comma separated list of email addresses for users with write access. |
|
| %asset_admin_permission_email% |
Comma separated list of email addresses for users with administrator access. |
|
| %asset_read_permission_email_linked% |
Comma separated list of linked email addresses for users with read access. |
|
| %asset_write_permission_email_linked% |
Comma separated list of linked email addresses for users with write access. |
|
| %asset_admin_permission_email_linked% |
Comma separated list of linked email addresses for users with administrator access. |
|
Asset Listing Keywords
| Keyword |
Output |
Version |
| %asset_contents% |
Asset contents with paint layout. Note: doesn’t work for shadow assets (eg. LDAP users) until 3.16.0. |
|
| %asset_contents_raw% |
Asset contents, no paint layout. Note: doesn’t work for shadow assets (eg. LDAP users) until 3.16.0. |
|
| %asset_contents_paint_X% |
Asset contents, no paint layout. |
3.22.0+ |
| %list_current_asset_id% |
|
|
| Keyword |
Output |
Version |
| %form_summary_semantic% |
|
3.22.0+ |
| %page_list% |
|
3.22.0+ |
Image Keywords
| Keyword |
Output |
Version |
| %asset_attribute_alt% |
|
|
| %asset_attribute_caption% |
|
|
| %asset_attribute_width% |
|
|
| %asset_attribute_height% |
|
|
| %asset_attribute_size% |
|
|
| %asset_attribute_title% |
|
|
| %asset_attribute_name% |
|
|
| %asset_file_size_in_bytes% |
|
|
| %asset_file_size_readable% |
|
|
| %image_width% |
Image width in pixels |
|
| %image_height% |
Image height in pixels |
|
| %image_tag% |
|
|
Image Variety Keywords
| Keyword |
Output |
Version |
| %image_v_X% |
Prints the Image Variety using an tag. |
|
| %image_v_X_url% |
|
|
| %image_v_X_width% |
Prints the Image Variety width in pixels. |
3.22.0+ |
| %image_v_X_height% |
Prints the Image Variety height in pixels. |
3.22.0+ |
File Keywords
| Keyword |
Output |
Version |
| %asset_attribute_title% |
|
|
| %asset_attribute_name% |
|
|
| %asset_file_size_in_bytes% |
|
|
| %asset_file_size_readable% |
|
|
News Item Keywords
| Keyword |
Output |
Version |
| %asset_attribute_summary% |
|
|
| %asset_attribute_body% |
|
|
| %asset_attribute_contact_name% |
|
|
| %asset_attribute_contact_phone% |
|
|
| %asset_attribute_show_headline% |
|
|
| %asset_attribute_show_summary% |
|
|
| %asset_attribute_show_body% |
|
|
| %asset_attribute_show_contact_name% |
|
|
| %asset_attribute_show_contact_phone% |
|
|
| %asset_attribute_short_name% |
|
|
| %asset_attribute_name% |
|
|
| %asset_name_linked_to_link_url% |
|
|
| %asset_attribute_link_url% |
|
|
| %asset_attribute_url_suffix% |
|
|
Paint Layout Keywords
| Keyword |
Output |
Version |
| %paint_layout% |
|
|
| %begin_X% |
If paint layout condition met |
|
| %else_X% |
If paint layout condition not met |
|
| %end_X% |
End conditional paint layout content |
|
Standard Page Keywords
| Keyword |
Output |
Version |
| %asset_attribute_short_name% |
|
|
| %asset_attribute_name% |
|
|
Search Page Keywords
| Keyword |
Output |
Version |
| %X_query% |
Input box for search terms |
|
| %X_query_logic% |
Drop down logic chooser |
|
| %X_query_terms% |
Show the search terms entered by the user |
|
| %results_per_page% |
|
|
| %structured_root_node% |
|
|
| %submit_button% |
|
|
| %result_count% |
|
|
| %initial_result_count% |
|
|
| %category_list_linked% |
|
|
| %initial_layout% |
|
|
| %next_result_page_href% |
|
|
| %previous_result_page_href% |
|
|
| %next_result_page_link% |
|
|
| %previous_result_page_link% |
|
|
| %result_page_index% |
|
|
| %total_result_pages% |
|
|
| %current_result_page% |
|
|
| %current_result_page_end% |
|
|
| %result_list% |
|
|
| %page_list_X% |
Sliding list of page numbers |
|
| %X_query_synonyms_message% |
|
|
| %X_query_synonyms% |
|
|
| %X_query_suggestions_message% |
|
|
| %X_query_suggestions% |
|
|
| %X_query_synonym_search_message% |
|
|
Single Calendar Event Keywords
| Keyword |
Output |
Version |
| %event_name% |
|
|
| %event_start_date% |
|
|
| %event_start_time_12h% |
|
|
| %event_start_time_24h% |
|
|
| %event_start_time_ical% |
|
|
| %event_end_date% |
|
|
| %event_end_time_12h% |
|
|
| %event_end_time_24h% |
|
|
| %event_short_start_time% |
|
|
| %event_short_end_time% |
|
|
| %event_end_time_ical% |
|
|
| %event_start_datetime% |
|
|
| %event_end_datetime% |
|
|
| %event_datetime_summary% |
|
|
| %event_duration% |
|
|
Tag Listing Page
| Keyword |
Output |
Version |
| %tag_size% |
The combined tag weighting across the candidate assets. |
3.24.1+ |
User
| Keyword |
Output |
Version |
| %asset_attribute_email_image% |
Prints the user’s email address as an image. |
3.22.0+ |
Reference: