Keyword Replacements

Last Updated: 17 Dec 2015

This manual lists the keyword replacements that are available in the system.

A keyword replacement allows you to show information about an asset within the content of the site. This information will be updated as the asset is updated. For example, if you use the keyword replacement %asset_name%, the name of the asset will appear. If you change the name of the asset, the information displayed will be updated.

The general format of a keyword replacement is:

%<keyword_replacement>%

When Squiz Matrix finds a term within the % symbols, it replaces the keyword replacement with the correct information. If the keyword replacement doesn't exist, it will not be replaced.

Keyword replacements can also be used to display elements of the asset within the content. For example, when you create a Custom Form, you can use keyword replacements to lay out the form.

Along with the keyword replacements for the assets, there are Global Keywords. These keywords can be used on any asset within the system, including the Design asset, and are used to show information about the current asset the user is viewing, the current site they are viewing or information from their user account if they are logged in. For example, if you wanted to show the name of the asset that the user is currently viewing within the design, you can use the global keyword %globals_asset_name%.

The returned values of all keyword replacements can be modified through the use of Keyword Modifiers. These modifiers are represented as externisions added to the existing keyword replacement. For example, if you wanted to show the first ten words from the content of a page, you can use the keyword replacement %asset_contents%, combined with the modifier maxwords to create the modified keyword of %asset_contents^maxwords:10%. This will then show the first ten words.

Please note some keyword replacement formats are reserved for specific purposes within Squiz Matrix. These include:

%begin_*%
%else_*%
%end_*%
%globals_*%

Caution should be taken when assigning field names and values that may generate automatic keywords, creating conflicts with these reserved keyword formats.