THE BIG LIST OF MYSOURCE MATRIX KEYWORDS

By On 12/08/2010 · Leave a Comment

from http://matrixsecrets.com/keywords/

Last updated: February 22, 2010

Common Asset Keywords

Keyword Output Version
%asset_assetid% The unique ID of the current asset  
%asset_name%    
%asset_short_name%    
%asset_type% Type code (eg. page_standard)  
%asset_url% Full web address of the current asset  
%asset_href% “Web path” of the current asset (ie. relative href/link)  
%asset_thumbnail% IMG tag for the thumbnail for this asset  
%asset_thumbnail_alt% ALT attribute of Thumbnail  
%asset_thumbnail_url% URL to the image for the thumbnail for this asset  
%asset_thumbnail_caption% Caption of the thumbnail for this asset  
%asset_metadata_X%    
%metadata_field_X% Insert other metadata field value  

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 aPHP 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_post_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+
%X^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+

Date Keywords

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% PHP formatted date the asset was created  
%asset_created%    
%asset_updated%    
%asset_created_short%    
%asset_updated_short%    
%asset_created_readable%    
%asset_updated_readable%    
%asset_created_readabledate%    
%asset_updated_readabledate%    
%asset_created_readabletime%    
%asset_updated_readabletime%    
%asset_created_iso8601%    
%asset_updated_iso8601%    
%asset_created_rfc2822%    
%asset_updated_rfc2822%    
%asset_created_ical%    
%asset_updated_ical%    
%asset_published%    
%asset_published_short%    
%asset_published_readable%    
%asset_published_readabledate%    
%asset_published_readabletime%    
%asset_published_iso8601%    
%asset_published_rfc2822%    
%asset_published_ical%    
%asset_status_changed%    
%asset_status_changed_short%    
%asset_status_changed_readable%    
%asset_status_changed_readabledate%    
%asset_status_changed_readabletime%    
%asset_status_changed_iso8601%    
%asset_status_changed_rfc2822%    
%asset_status_changed_ical%    

Permissions 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%    

Custom Form Keywords

Keyword Output Version
%form_summary_semantic%   3.20.0+
%page_list%   3.20.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.20.2+
%image_v_X_height% Prints the Image Variety height in pixels. 3.20.2+

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+

Design Areas

page_body

<MySource_AREA id_name="page_body" design_area="body" />

page_body (text only)

<MySource_AREA id_name="page_body" design_area="body">
  <MySource_SET name="format" value="Text" />
</MySource_AREA>

metadata

<!-- print all metadata -->
<MySource_AREA id_name="metadata_all" design_area="metadata" /> 

<!-- print a single metadata field -->
<MySource_AREA id_name="metadata_field" design_area="metadata">
  <MySource_SET name="metadata_field" value="keywords" />
</MySource_AREA>

nest_content

<MySource_AREA id_name="nested_example" design_area="nest_content">
  <MySource_SET name="type_codes" value="page" />
</MySource_AREA>

linked_css

<MySource_AREA id_name="css_main" design_area="linked_css">
  <MySource_SET name="tag_type" value="import_tag" />
  <MySource_SET name="media" value="screen" />
</MySource_AREA>

constant_button

<MySource_AREA id_name="link_section" design_area="constant_button">
  <a <MySource_PRINT var='href' />>Privacy Policy</a>
</MySource_AREA>

asset_lineageCommon breadcrumbs (ie. where you are)

<MySource_AREA id_name="breadcrumbs" design_area="asset_lineage">
  <MySource_SET name="levels_to_print"          value="0" />
  <MySource_SET name="prefix_with_home_link"    value="true" />
  <MySource_SET name="suffix_with_current_link" value="true" />
  <MySource_SET name="prefix_with_divider"      value="true" />
  <MySource_SET name="suffix_with_divider"      value="false" />
  <MySource_SET name="unwanted_asset_types"     value="user folder" />
  <MySource_SET name="reverse_lineage"          value="false" />
  <MySource_ASSET><a href="<MySource_PRINT var='asset_link' />"><MySource_PRINT var='asset_short_name' /></a></MySource_ASSET>
  <MySource_DIVIDER><span>&gt;</span></MySource_DIVIDER>
</MySource_AREA>

access_historyReal breadcrumbs (ie. where you have been)

<MySource_AREA design_area="access_history" id_name="back_to_pages">
  <MySource_ASSET><MySource_PRINT var="asset_short_name_linked" /></MySource_ASSET>
</MySource_AREA>

menu_normalMenu/navigation (3 level)

<MySource_AREA id_name="main_menu" design_area="menu_normal">
<ul><!-- BEGIN LEVEL 1 -->
<MySource_SET name="level"                    value="top" />
<MySource_SET name="show_subs"                value="on_current" />
<MySource_SET name="settings.class.normal"    value="" />
<MySource_SET name="settings.class.current"   value="current" />
<MySource_SET name="settings.class.hierarchy" value="current" />

    <MySource_ASSET>
    <lisettings.class" />">
    <MySource_PRINT var="asset_short_name_linked" />

        <ul><!-- BEGIN LEVEL 2 -->
        <MySource_SUB design_area="menu_normal">
        <MySource_SET name="show_subs"                value="on_current" />
        <MySource_SET name="settings.class.normal"    value="" />
        <MySource_SET name="settings.class.current"   value="current" />
        <MySource_SET name="settings.class.hierarchy" value="current" />

            <MySource_ASSET>
            <lisettings.class" />">
            <MySource_PRINT var="asset_short_name_linked" />

                <ul><!-- BEGIN LEVEL 3 -->
                <MySource_SUB design_area="menu_normal">
                <MySource_SET name="show_subs"                value="on_current" />
                <MySource_SET name="settings.class.normal"    value="" />
                <MySource_SET name="settings.class.current"   value="current" />
                <MySource_set name="settings.class.hierarchy" value="current" />

                    <MySource_ASSET>
                    <lisettings.class" />">
                    <mysource_print var="asset_short_name_linked" />
                    </li>
                    </MySource_asset>

                </MySource_SUB>
                </ul><!-- END LEVEL 3 -->                         

            </li>
            </MySource_ASSET>

        </MySource_SUB>
        </ul><!-- END LEVEL 2 -->

    </li>
    </MySource_ASSET>

</ul><!-- END LEVEL 1 -->
</MySource_AREA>

search_box

<!-- substitute ZZZZ for the field name associated with the Search Page -->
<!-- substitute XXXX for the asset id of the Search Page asset -->
<MySource_AREA id_name="search_form" design_area="searchbox">
    <MySource_SET var="field_name"          value="ZZZZ" />
    <MySource_SET var="search_page_assetid" value="XXXX" />
    <MySource_SET var="default_text"        value="" />
    <MySource_SET var="submit_button"       value="false" />
    <MySource_SET var="submit_image_assetid value="" />
    <MySource_PRINT var="form_start" />
        <div id="search_form">
            <MySource_PRINT var="category_list" />
            <label for="queries_ZZZZ_query">Search</label>
            <MySource_PRINT var="box" />
            <span><MySource_PRINT var="submit" /></span>
        </div>
    <MySource_PRINT var="form_end" />
</MySource_AREA>

show_if

<MySource_AREA id_name="logged_in" design_area="show_if">
    <MySource_SET name="condition" value="logged_in" />
    <!--<MySource_SET name="condition" value="simple_edit_mode" />-->
    <!--<MySource_SET name="condition" value="write_access" />-->
    <!--<MySource_SET name="condition" value="admin_access" />-->
    <!--<MySource_SET name="condition" value="server_variable" />-->
    <!--    <MySource_SET name="condition_server_variable" value="HTTP_ACCEPT_LANGUAGE" />-->
    <!--    <MySource_SET name="condition_server_variable_match" value="en" />-->
    <!--    condition_server_var: http://php.net/manual/en/reserved.variables.server.php -->
    <MySource_THEN>You are logged in</MySource_THEN>
    <MySource_ELSE>
        <p>You are not logged in</p>
        <!-- Print the login form that is otherwise hidden through print="no" -->
        <MySource_PRINT id="login_form" />
    </MySource_ELSE>
</MySource_AREA>

request_vars

<MySource_AREA id_name="vars_example" design_area="request_vars">
    <MySource_SET name="method" value="get" />
</MySource_AREA>

<!-- print a single value from the request_vars array -->
<MySource_PRINT id_name="vars_example" var="get_variable_name" />

login_form

<MySource_AREA id_name="login_form" design_area="login_form">
    <MySource_PRINT var="referer" />
    <MySource_PRINT var="system_messages" />
    <MySource_PRINT var="login_heading" />
    <MySource_LOGIN_SECTION>
        <MySource_SET name="give_username_focus" value="false" />
        <MySource_SET name="forward_www_vars"    value="true" />
        <MySource_PRINT var="form_open" />
        <div id="login">
            <MySource_PRINT id_name="__global__" var="current_user"
default="Not logged in" attr="name" />
            <MySource_PRINT var="login_message" />
            <MySource_PRINT var="username_box" />
            <MySource_PRINT var="password_box" />
            <MySource_PRINT var="submit_button" value="Login" />
        </div>
        <MySource_PRINT var="form_close" />
    </MySource_LOGIN_SECTION>
    <MySource_LOGOUT_SECTION>
        <MySource_PRINT var="form_open" />
        <div id="login">
            <MySource_PRINT id_name="__global__" var="current_user"
default="Not logged in" attr="name" />
            <MySource_PRINT var="submit_button" value="Logout" />
        </div>
        <MySource_PRINT var="form_close" />
    </MySource_LOGOUT_SECTION>
</MySource_AREA>

headLet the Calendar asset print its own CSS

<MySource_AREA design_area="head" id_name="head" />

js_calendar_navigator

<MySource_AREA id_name="cal_nav" design_area="js_calendar_navigator" /
Tagged with:
 
If you enjoyed this article, please consider sharing it!
Reddit Facebook Twitter Delicious

Leave a Reply

Your email address will not be published. Required fields are marked *

*

You may use these HTML tags and attributes: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>