Keyword Replacements
Last Updated: 06 May 2016
This chapter outlines the keyword replacements that can be used on the Search Page and Search List assets within Squiz Matrix.
Bookmarks to the headings on this page:
Search Page
The following keyword replacements can be used on a Search Page.
In the following keywords, <field_name> refers to the name of the field that was entered when it was created on the Search Fields screen, and <category_name> refers to the name of the category that was entered when it was created on the Search Categories screen.
Please note that the following keyword replacement formats are reserved for specific purposes within Squiz Matrix:
- %begin_*%
- %else_*%
- %end_*%
- %globals_*%
Using these formats as your search field or search category names will create conflicts and throw an error.
Initial Search Page Layout Bodycopy
| Keyword Replacement | Information shown |
|---|---|
| %<field_name>_query% | The box where the user can enter in the search criteria for the field. |
| %<field_name>_query_logic% | A list allowing the user to specify the logic to be applied to the terms entered into the search field. The user can specify that either all or any of the words entered into the field can be matched. This should only be used for text fields. |
| %<category_name>_category_chooser% | A list of options for the category. The user can select an option from the list to modify the search criteria being used. |
| %submit_button% | The submit button. This is required so that the user can submit the information to perform a search. |
| %results_per_page% | A box where the user can enter how many results per page they would like to see. For example, if the user enters10, they will see 10 assets in the list of results. If you have included the previous and next hyperlinks on the Results Page Layout Bodycopy, they will be able to navigate to the next set of results. |
| %structured_root_node% | The list of root nodes that have been selected in the Structured Root Node fields on the Details screen of the Search Page. |
| %search_form% | The layout that has been defined in the Default Search Bodycopy. This will include the search fields. |
Results Page Layout Bodycopy
| Keyword Replacement | Information shown |
|---|---|
| %result_list% | The list of results. If you do not include this keyword replacement, the results will not appear on the page. |
| %result_count% | The number of assets that are return in the list of results. |
| %current_result_page% | If you have split the list of results over a number of pages, this will show the number of the page the user is currently viewing. |
| %total_result_pages% | If you have split the list of results over a number of pages, this will show the total number of pages. |
| %results_page_index% | If you have split the list of results over a number of pages, this will show a hyperlink to each page in the list. |
| %page_list_X% | If you have split the list of results over a number of pages, this will show a sliding list of page numbers that are hyperlinked. The number of pages it shows at once is defined in X. For example, if you enter 3 for the X value of the keyword replacements, it will show "1 2 3". When you click on 3, it will "slide" along the list of pages and show "2 3 4". |
| %current_result_page_start% | If you have split the list of results over a number of pages, this will show the position number of the first asset on the page. For example, if the user is viewing the first 10 assets in the list, then it will be 1. When they view the next page of results, it will be 11. |
| %current_result_page_end% | If you have split the list of results over a number of pages, this will show the position number of the last asset on the page. For example, if the user is viewing the first 10 assets in the list, then it will be 10. When they view the next page of results it will be 20. |
| %previous_result_page_link% | If you have split the list of results over a number of pages, this will show a link to the previous page of results. You can change the wording of this link in the Previous page link text field on the Details screen of the Search Page. |
| %next_result_page_link% | If you have split the list of results over a number of pages, this will show a link to the next page of results. You can change the wording of this link in the Next page link text field on the Details screen of the Search Page. |
| %previous_result_page_href% | If you have split the list of results over a number of pages, this will show a href to the previous page of results. |
| %next_result_page_href% | If you have split the list of assets over a number of pages, this will show a href to the next page of assets. |
| %initial_layout% | The layout that has been defined in the Initial Search Page Layout Bodycopy. By adding this keyword replacement, the user can perform the search again without having to go back to the initial Search Page. |
| %category_list_linked% | Each option in the category as a hyperlink. When a user clicks on the hyperlink, the search is performed again for the selected category. |
| %initial_result_count% | If you are using the Proxy Asset Type search, this will show the initial count of matching assets before the proxy assets are returned. |
| %search_form% | The layout that has been defined in the Default Search Bodycopy. This will include the search fields. |
| %search_in_search_form% | The layout that have been defined in the Search in Search Bodycopy. |
| %search_in_search_button% | The button to allow the user to redefine their search through the search in search layout. |
| %<field_name>_query_synonyms_message% | If synonym searching has been set up, this will show the message that has been entered on the Messages screen in the Synonyms field. It will show other terms the user can search for based on what they have entered into the field. Each term will be hyperlinked. When a user clicks on the hyperlink, the search is performed again using that term. |
| %<field_name>_query_synonyms% | If synonym searching has been set up, this will show other terms the user can search for based on what they have entered into the field. Each term will be hyperlinked. When a user clicks on the hyperlink, the search is performed again using that term. |
| %<field_name>_query_suggestions_message% | This will show the message that has been entered on the Messages screen in the Spell Check field. It will suggest alternative spellings for a term the user entered into the field on the Search Page. It will use the spellchecker to do this. |
| %<field_name>_query_suggestions% | This will suggest alternative spellings for a term the user entered into the field on the Search Page. It will use the spell checker to do this. |
| %<field_name>_query_synonym_search_message% | If automatic synonym searching has been set up, this will show the message that has been entered in the Messages screen in the Auto Synonym Search field. |
| %<field_name>_query_terms% | This will show the terms the user entered into the search field. |
| %<field_name>_query% | This will show the box where the user can change the search criteria for the field and perform the search again. |
| %<field_name>_query_logic% | This will show a list allowing the user to specify the logic to be applied to the terms entered into the search field. The user can specify that either all or any of the words entered into the field can be matched. This should only be used for text fields. |
No Results Page Layout Bodycopy
| Keyword Replacement | Information shown |
|---|---|
| %initial_layout% | The layout that has been defined in the Initial Search Page Layout Bodycopy. By adding this keyword replacement, the user can perform the search again without having to go back to the initial Search Page. |
| %search_form% | The layout that has been defined in the Default Search Bodycopy. This will include the search fields. |
Default Search Bodycopy
| Keyword Replacement | Information shown |
|---|---|
| %<field_name>_query% | The box where the user can enter in the search criteria for the field. |
| %<category_name>_category_chooser% | A list of options for the category. The user can select an option from the list to modify the search criteria being used. |
| %submit_button% | The submit button. This is required so that the user can submit the information to perform a search. |
Search In Search Bodycopy
| Keyword Replacement | Information shown |
|---|---|
| %<field_name>_query% | The box where the user can enter in the search criteria for the field. |
| %<category_name>_category_chooser% | A list of options for the category. The user can select an option from the list to modify the search criteria being used. |
| %search_in_search_button% | The button to allow the user to redefine their search. |
Default Format Bodycopy
| Keyword Replacement | Information shown |
|---|---|
| %score% | The score the asset received based on the search criteria. |
Search List
The following keyword replacements can be used on a Search List.
| Keyword Replacement | Information shown |
|---|---|
| %search_term% | The term that is hyperlinked to the Search Page. When the user clicks on the hyperlink, the Search Page will show the list of results for that term. |
| %number_of_occurrences% | The number of results that will be shown for the term. |