Search Page

Last Updated: 05 Sep 2016

The Search Page is used to allow users to search within a specified set of assets. For example, if the user enters the word Squiz, it will search for the word Squiz within the assets. You can create a simple Search Page that will only search one field on the asset or a complicated Search Page that will search a number of different asset fields, asset attributes and metadata fields.

Once you have created a Search Page, you can configure its settings on its associated asset screens. The majority of these screens are the same or similar to those for a Standard Page or Asset Listing and are described in either the Asset Screens manual or the Asset Listing manual. In this manual, we will describe the DetailsSearch FieldsSearch Categories and Messages screens.

Additional Dependant Assets

The Dependant Assets of a Search Page
The dependant assets

When you create a Search Page, a number of assets are automatically created beneath it, as highlighted in the figure to the right. You can use these assets to define the layout of the Search Page.

  • Default Format: this Bodycopy is used to define the information to be shown for each asset that appears in the list of results.
  • Initial Search Page Layout: this Bodycopy is used to define the initial layout of the Search Page when the user firsts visits the page.
  • Results Page Layout: this Bodycopy is used to define the layout if results are found from the search that is being performed.
  • No Results Page Layout: this Bodycopy is used to define the layout if no results are found from the search that is being performed.

The Default Format Bodycopy is similar to the one that is created under the Asset Listing Page. For more information on this asset, refer to the Asset Listing manual.

The figure below shows how the Search Page works through the use of these dependant assets.

The Page Layout Bodycopies
The Page Layout Bodycopies of a Search Page

Details Screen

The Details screen allows you to configure the settings for the Search Page, including the parameters of the search and the display options. For more information about the Status, Future Status, Thumbnail and Details section, refer to the Details Screen chapter in the Asset Screens manual. For more information about the List Position Settings, Dynamic Parameters and Structured Root Selector Options section, refer to the Details Screen chapter in the Asset Listing manual.

Search Parameters

This section allows you to define which assets to search. The Search Parameters section is shown in the figure below.

The Search Parameters section of the Details screen
The Search Parameters section of the Details screen

The fields available are as follows:

  • Root Nodes: select which section of the system to search in for the Search Page. For example, if you want to search all assets in your site, select the Site asset. You can select multiple Root Nodes by clicking on the More… button.
  • Exclude Root Node: select whether or not to exclude the individual root node assets (as specified in the Root Nodes field) from the search results of the Search Page. If this field is enabled, only the child assets of these root nodes will be listed on search results. By default, this field is set to No.
  • Asset Types to Search for: select the types of assets to search in. For example, if you only want to search within the pages in your site, select Standard Page. To select more than one asset type, click on the More… button. An additional list will appear on the screen.
  • Search Statuses: select the Status the asset must be to be included in the Search Page. For example, if you want to search all assets that are Under Construction and Live, select both of these Statuses. To select multiple Statuses, hold down the Ctrl key on the keyboard and click on the Status in the list.
  • Exclude This Asset: select whether or not to list the asset that is currently being viewed. For example, if the Search Page is nested in the Site design, it will not list an asset if the user is currently viewing it. 
Display Options

This section allows you to change the format of the Search Page. The Display Options section is shown in the figure below.

The Display Options section of the Details screen
The Display Options section of the Details screen

The fields available in this section are as follows:

  • List Format: this option allows you to change the format of the list of results. The options available in this list are as follows:
    • Standard List: this format allows you to display the list of results on a single page, or broken up across multiple pages, for example 10 assets per page.
    • Custom Grouping: this format displays assets grouped by the grouping conditions setup on the Asset Grouping screen. For more information on this screen, refer to the Asset Group Screen chapter in the Asset Listing manual.
  • Assets Per Page: enter the number of assets to show on the results page. You can use this field to restrict the number of assets that are seen on the page or breakup the assets into a number of pages. To do this, add the keyword replacements Previous Page Link and Next Page Link to the Results Page Layout Bodycopy so that the user can navigate to the next page of the list.
  • Search Forms: this field allows you to add the search again and search in search Bodycopy to the Search Page. For more information on these Bodycopies, refer to the Default Search Bodycopy and Search In Search Bodycopy sections below.
  • Lineage Separator: enter the separator to use when showing the lineage of the asset in the list of results. This is used when you use the keyword replacement Asset Lineage or Asset Lineage Linked on the Default Format Bodycopy. By default, this is set to >.
  • Search as Public User: select whether or not the Search Page will only search the assets that have been granted Public Read Permission. In other words, the search will be performed as a Public User, even if someone is logged into the system. By default this is set to No, meaning that it will search all assets.
  • Perform Roles Check: when a search is performed and an asset is found, Squiz Matrix will check whether or not the user has permission to view it. This includes checking any Roles that have been given permission on the asset. The Perform Roles Check field allows you to turn off this check for the Roles. By doing this, you can increase the performance of the Search Page. By default, this is set to No meaning that the checks for the Roles will not be performed.
  • Perform Group Access Check: when a search is performed and an asset is found, Squiz Matrix will check whether or not the user has permission to view it. This includes checking any User Groups that have been given permission on the asset. The Perform Group Access Check field allows you to turn off this check for the User Groups. By doing this, you can increase the performance of the Search Page. By default, this is set to Yes meaning that the checks for the User Groups will be performed.
  • Show root node in lineage: select whether or not to show the root node in the lineage of an asset in the list of results. This is used when you use the keyword replacement Asset Lineage or Asset Lineage Linked on the Default Format Bodycopy. By default, this is set to No.
  • Show result asset in lineage: select whether or not to show the name of the asset in the lineage in the list of results. This is used when you use the keyword replacement Asset Lineage or Asset Lineage Linked on the Default Format Bodycopy. By default, this is set to No.
  • Search button text: enter the text to show on the search button. By default, this text is Submit. This button is shown when the keyword replacement Submit Button is used on the Search Page.
  • Reset button text: enter the text to show on the reset button. By default, this text is Reset. This button is shown when the keyword replacement Reset Button is used on the Search Page.
  • Search in search button text: enter the text to show on the search in search button. By default, this text is Search.
  • Previous page link text: enter the text that will be used for the hyperlink to the previous result page. This will be shown when you add the keyword replacement Previous Result Page Link to the Results Page Layout Bodycopy. By default, this is set to Previous.
  • Next page link text: enter the text that will be used for the hyperlink to the next result page. This will be shown when you add the keyword replacement Next Results Page Link to the Results Page Layout Bodycopy. By default, this is set to Next.
  • Page Link Format: this format defines the individual layout of items on the result page's linked page list when you are listing results over multiple pages.
  • Current Page Format: this format defines the layout of the current page number on the result page's linked page list when you are listing results over multiple pages. 
  • Hide Unlinked Navigation Text: this option allows you to hide any unlinked navigation text on the search results when you are listing results over multiple pages, i.e the Previous Page link will not appear on the first page of the results and the Next Page link will not appear on the last page of the results.
Advanced Settings

The Advanced Settings section of the Details screen is shown in the figure below.

The Advanced Settings Options section of the Details screen
The Advanced Settings section

The Form Submission URL field allows you to control where the search form is submitted. This is useful if you nest the Search Page in another page. By default, this is set to The Page's Own URL, meaning that the Search Page will submit to its own URL. The list of results will not be nested in another page and the user will be redirected to the Search Page itself. The URL, the lineage, and the menu etc will change to be the Search Page. If you set this option to The Current URL, the form is submitted to the current page you are viewing (i.e. the page in which the Search Page is nested). This means that the list of results will be shown within the original page.

Synonym Search Options

This section allows you to set up synonym searching for the Search Page. The Synonym Search Options section of the Details screen is shown in the figure below.

The Synonym Search Options section of the Details screen
The Synonym Search Options section

The fields available are as follows:

  • Thesaurus Asset: select the Thesaurus asset to use for the synonym search. By selecting a Thesaurus, the Search Page can suggest other terms that the user can search for. For example, say you created a Thesaurus that contained the term Squiz and its related terms were Matrix and CMS. On the Search Page, when the user searches for the term Squiz, the results page can say Did you mean: Matrix, CMS?. When the user clicks on one of these terms, a search will be performed using that term. To show the related terms, on the Results Page Layout Bodycopy include the keyword replacement %<field_name>_query_synonyms_message%, where <field_name> is the name of a field on the Search Fields screen. You can change the message being shown on the Messages screen. For more information on these screens, refer to the sections below.
  • Auto Synonym Search: by default, no fields will appear for this field, as shown in the figure above. Once you have selected a Thesaurus in the Thesaurus Asset field and have created fields on the Search Fields screen, the fields shown in the figure below will appear.

    The Synonym Search Options section of the Details screen with Thesaurus
    Additional fields in the Synonym Search Options section    

    This option allows you to turn on automatic synonym searching. This means that if a user enters a term into a search field that does not produce any results, the Search Page will perform the search again using the related terms that have been set up in the selected Thesaurus. For example, say you created a Thesaurus that contained the term Squiz and its related terms were Matrix and CMS . On the Search Page, the user enters Squiz into a search field but it produces no results. The Search Page will then perform the search again using the terms Matrix and CMS, as they are related to the term Squiz . If the Search Page does not find the term in the Thesaurus or does not find any related terms, it will show no results. If this option is enabled, select which search field to use in the User Search Field.
  • Use Search Field: by default, this field will not appear on the Details screen until you have selected a Thesaurus in the Thesaurus Asset field and have created fields on the Search Fields screen. This field allows you to select which search field on the Search Page to perform the automatic synonym search on. You can only select one field from the list. If a user does not enter a term into this field, the automatic synonym search will not be performed.
  • Enable Multi-Word Synonym Lookups: this option allows you to turn on multi-word synonym searching. This feature enables the use of synonym searching for more than just a single word. For example, say you created a Thesaurus that contained the terms flute player and flautist as synonyms of each other. On the Search Page, the user enters professional flute player into a search field. Any found synonyms, in this case flautist, are automatically attached to the search query. The existing search query of Professional AND flute player will become Professional AND (flute player OR flautist). Auto Synonym Search must be enabled for this option to be available.
Stored Search

This section allows you to set up parameters for the Search Page. These parameters can then be used to set up a default search and show the list of results rather than the Initial Search Page Layout. For example, say you create a Search Page with a field called Keyword and set up the parameters. You can then create a hyperlink to the Search Page from another page in the Site and pass in different terms to use in the Keyword field, for example Matrix . When the user clicks on the hyperlink, if the Show the Results page field is set to No, the Initial Search Page Layout will be shown and the Keyword field will contain the term Matrix. If, however, the Show the Results page field is set to Yes, a search will be performed using the term Matrix  and the Results Page Layout will be shown.  

The Stored Search section of the Details screen is shown in the figure below.  

The Stored Search section of the Details screen
The Stored Search section

Stored Search Options

This section allows you to select whether to show the Initial Search Page Layout or the Result Page Layout when using the fields in the Stored Search section. The Stored Search Options section of the Details screen is shown in the figure below.

The Stored Search Options section of the Details screen
The Stored Search Options section

If you have selected No, the Initial Search Page Layout will be shown when passing through parameters. If you have selected Yes, the Results Page Layout will be shown instead.

Security Enhancement

This section allows you to enhance the security of the Search Page by disabling the replacement of any keywords that may be present in a user's search field inputs. When keywords are replaced as normal, users may be able to retrieve information that they otherwise would not have permission to view and may potentially be a risk to security.

The Security Enhancement section of the Details screen is shown in the figure below.

The Security Enhancement section of the Details screen
The Security Enhancement section

To prevent keywords from being replaced in user search field inputs, select Yes in the Disable Keyword Replacements field. If this field is enabled, keywords will not be replaced in the user's search field inputs. For example, %globals_asset_attribute_xxx:100% will be output as globals_asset_attribute_xxx:100 rather than the attribute value. By default, this field is set to Yes.

Search Fields Screen

The Search Fields screen allows you to add the fields that will be used on the Search Page to perform the search.

Logical Grouping

This section allows you to select the grouping to use for the search fields. The Logical Grouping section of the Search Fields screen is shown in the figure below.

The Logical Grouping section
The Logical Grouping section 

If you select Match on ALL fields, the asset must match the information that is entered into all fields by the user. For example, say you have two fields called Name and Created Date. If the user enters a value into both of these fields, the asset must match both values before it is listed in the results. If, however, you select Match on at least ONE field, the asset only has to match one field on the Search Page. For example, it can match either the value entered into the Name field or the Created Date field to be listed in the results.

Field Configuration

This section allows you to set up the fields for the Search Page. The Field Configuration section of the Search Fields screen is shown in the figure below.

The Field Configuration section
The Field Configuration section

Once you have added a field, you need to add the keyword replacements for that field on the Initial Search Page Layout Bodycopy. The fields available in the Field Configuration section are as follows:

  • Allow Empty Searches?: select whether or not the user can perform an empty or wildcard search. In other words, if they click search without entering any values into the fields that are provided, all possible assets will be returned. By default, this is set to No.
  • Search Fields: this section allows you to add the fields for the Search Page. By default, no fields will be listed. To add a new field, enter the name of the field into the New Search Field Name and click Commit. The field will be added to the grey box, as shown in the figure below.


    The Search Fields list
    The Search Fields list    

    In the Add Data Source list, select which field on the asset to search in. The options available are as follows:
    • Include All: this option will search all standard fields, attribute fields and metadata fields for the asset.
    • Standard Asset Field: this option allows you to select a standard field to search in, for example the name of the page or the asset id. When you select this option and click Commit, an additional list will appear in the Details section, as shown in the figure below.

      The Standard Asset Field type in the Search Fields list
      The Standard Asset Field type in the Search Fields list    

      Select the field that you want to search in from the list and click Commit. The available fields include Date Asset Created, Date Asset Last Updated, Date Asset Published, Date Asset Status Last Changed, Asset ID, Asset Name, Asset Short Name and Asset Contents.
    • Asset Attribute: this option allows you to select an attribute field to search in, for example the title of the file for a MS Word Document. When you select this option and click Commit, an additional list will appear in the Details section, as shown in the figure below.

      The Asset Attribute type in the Search Fields list
      The Asset Attribute type in the Search Fields list     

      Select the asset type from the list and click Commit. An additional list will appear in the Details section, as shown in the figure below. The list of available asset types will depend on what asset types you have select in the Asset Types to Search field on the Details screen.

      The Asset Attribute Page type in the Search Fields list
      The Asset Attribute Page type in the Search Fields list      

      Select the attribute field that you want to search in, in the list provided.
    • Asset Metadata Field: this option allows you to select a metadata field to search in. When you select this option and click Commit, an asset finder field will appear in the Details section, as shown in the figure below.

      The Asset Metadata Field type in the Search Fields list
      The Asset Metadata Field type in the Search Fields list    

      Select the metadata field from the Asset Map in the field provided.
    For each field that you add, you can select multiple Data Sources in to search in. For example, you can create a field called Name that will search in the standard fields Asset Name and Asset Short Name and the attribute field Title. To add multiple Data Sources, select a new value in the Add Data Source list for the field and click Commit.

    If you select multiple Data Sources for a field, you can select to search All Words or Any Words in the Word Logic field. If you select All Words, the value that the user enters into this field must exist in all fields for the asset. For example, it must exist in the Asset Name, Asset Short Name and Title. If you select Any Words, the value has to exist in at least one field on the asset.    

    To delete a field from the Search Page, click the Delete box.

  • Exclude Fields: this field allows you to add a field to the Search Page where the user can enter terms to exclude assets from the list of results. For example, if the user entered Squiz in the exclude field, any asset that uses that term will not appear in the result list.

    By default, no fields will be listed. To add a new field, enter the name of the field into the New Search Field Name and click Commit. The field will be added to the grey box, as shown in the figure below.

    The Exclude Fields list
    The Exclude Fields list     

    In the Add Data Source list, select which field on the asset to search in. The options available are the same as those available in the Search Fields field.
Field Styles

This section allows you to change the styles of the search fields. The Field Styles section of the Search Fields screen is shown in the figure below.

The Field Styles section
The Field Styles section

The fields available are as follows:

  • Use Date Picker: select whether or not to display the JavaScript calendar styles date picker for any date field on the Search Page. By default, this is set to No.
  • Field Styles: this section allows you to customise the width and height of the boxes used for the search fields that are searching attribute fields. For example, the figure below shows the name field. This attribute field was selected for a field in the Search Fields section.

    The Field Styles field for a Name attribute
    The Field Styles field for a Name attribute    

    Enter the width and height in the fields provided.

Search Categories Screen

This screen allows you to create a list of different search criteria to use on the Search Page. For example, the user can select to search within one of three different product categories – fridges, freezers and dishwashers. Each search category can search either a different area of your Site or search assets that have a different Status, for example Under Construction as opposed to Live. The user can then select which category to use on the Search Page.

The Categories section of the Search Categories screen is shown in the figure below.

The Categories section of the Search Categories screen
The Categories section of the Search Categories screen

By default, no categories will appear on the screen. To add a new category, enter a name for the category in the Name field and click Commit. Additional fields will appear on the screen, as shown in the figure below. You can add as many categories as you want to the page.

Additional Fields on the Search Categories screen
Additional fields for a Category

The fields available for each category are as follows:

  • Delete: to delete the category, click the Delete box and click Commit.
  • Unselect Text: enter the value to show for the empty option in the list. If you, the user, select this option, it will use the settings that have been selected on the Details screen of the Search Page. This option can be left blank.
  • Options: this section allows you to add the options to the list. The user will be able to select an option to use when performing a search on the page. The fields available are as follows:
    • Name: enter the value to show in the list for this option. For example, if this option is going to search in the Folder called Freezers, enter Freezers.
    • Statuses: to select a Status to use for this category option, deselect the Use Default box. If you do not select a Status, the category will use the settings that have been selected on the Details screen of the Search Page.
    • Root Node: to select a Root Node to use for this category option, deselect the Use Default box. For example, if you are setting up a category to allow the user to search the Folder called Freezers, select the Folder. If you do not select a Root Node, the category will use the settings that have been selected on the Details screen of the Search Page.
    • Delete: to delete an option, click the Delete box and click Commit
    Once you have filled out the information for an option, click Commit. A new set of fields will appear in the Options section, where you can add a new option to the list. You can add as many options as you want.

Once you have created a category, to show it on the Search Page, you need to add the keyword replacement %<category_name>_category_chooser% to the Initial Search Page Layout Bodycopy, where <category_name> is the name that was entered when you created the category.

Messages Screen

This screen allows you to change the messages that are shown on the Search Page. The Search Results Keywords section of the Messages screen is shown in the figure below.

The Search Results Keywords section of the Messages screen
The Search Results Keywords section of the Messages screen

The fields available on this screen are as follows:

  • Spell Check: this message is shown when the keyword replacement %<field_name>_query_suggestions_message% is added to the Results Page Layout. Using the spell checker, it will suggest alternative spellings for a term the user entered in a field on the Search Page. For example, if the user misspelled a term in a field, the spell checker can suggest the correct spelling for the term. The keyword replacement %suggestions% needs to be included in the message to show the terms the spell checker has suggested.
  • Synonyms: this message is shown when the keyword replacement %<field_name>_query_synonyms_message% is added to the Results Page Layout. If synonym searching has been set up, it will suggest other terms the user can search for based on what they have entered into a field on the Search Page. The keyword replacement %suggestions% needs to be included in the message to show the terms.
  • Auto Synonym Search: If the automatic synonym search has been set up, this message is shown when the keyword replacement %<field_name>_query_synonym_search_message% is added to the Results Page Layout.

Initial Search Page Layout Bodycopy

The Initial Search Page Layout Bodycopy is used to define the initial layout of the Search Page when the user firsts the page. This includes the fields to display as well as a heading and the search button. An example of a layout that has been created in the Initial Search Page Layout Bodycopy is shown in the figure on the below.

An example Search Page layout
An example Search Page layout

To change what information is being shown, right click on the Initial Search Page Layout Bodycopy in the Asset Map and select Edit Contents. Click on the edit icon icon – the WYSIWYG Editor will appear where you can use keyword replacements and formatting to layout the information to show on the Search Page. By default, the Submit Button keyword replacement will appear in the WYSIWYG Editor.

Keyword Replacements on the Initial Search Page Layout Bodycopy

A list of keyword replacements is provided in the WYSIWYG Editor toolbar on the Edit Contents screen of the Initial Search Page Layout Bodycopy. You can use these keyword replacement in conjunction with text, images and links etc to layout what to show for the first page of the Search Page. The standard keyword replacements that are available include the following:

  • Input field for <field_name>: where <field_name> is the name of the field that was entered when it was created on the Search Fields screen. For example, if you entered the name Keyword, this will be Input field for keyword. This will show the box where the user can enter in the search criteria for the field. The format of this keyword replacement is %<field_name>_query%, for example %keyword_query%.
  • Word Logic Chooser for <field_name>: where _name> is the name of the field that was entered when it was created on the Search Fields screen. For example, if you entered the name Keyword, this will be Word Logic Chooser for keyword. 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.
  • Dropdown box for category set <category_name>: where <category_name> is the name of the category that was entered when it was created on the Search Categories screen. For example, if you entered the name Freezers, this will be Dropdown box for category set Freezer. This keyword replacement shows the list of options for the category. The user can select an option from the list to modify the search criteria being used.
  • Submit Button: this will show the submit button. This keyword replacement is required so that the user can submit the information to perform a search.
  • Results Per Page: this will show a box where the user can enter how many results per page they would like to see. For example, if the user enters 10, 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: this will show the list of root nodes that have been selected in the Structured Root Node fields on the Details screen of the Search Page.

Results Page Layout Bodycopy

The Results Page Layout Bodycopy is used to define the layout if results are found from the search that is being performed. For example, for the Search Page shown in the figure below, a heading, the number of results found, the list of results and other related terms are shown. This has been defined in the Results Page Layout Bodycopy.

An example Results Page layout
An example Results Page layout

To change what information is being shown, right click on the Results Page Layout Bodycopy in the Asset Map and select Edit Contents. Click on the edit icon icon – the WYSIWYG Editor will appear where you can use keyword replacements and formatting to layout the information to show on the Search Page. By default, the information shown in the figure below will appear in the WYSIWYG Editor.

The WYSIWYG Editor on the Results Page Layout Bodycopy
The WYSIWYG Editor on the Results Page Layout Bodycopy

Tip: If you do not include the keyword replacement Result List on the Results Page Layout Bodycopy, the list of results wil not appear.

Keyword Replacements on the Results Page Layout Bodycopy

A list of keyword replacements is provided in the WYSIWYG Editor toolbar on the Edit Contents screen of the Results Page Layout Bodycopy. You can use these keyword replacements in conjunction with text, images and links etc to layout what to show for the list of results. The standard keyword replacements that are available include the following:

  • Result List: this will show the list of results. If you do not include this keyword replacement, the results will not appear on the page.
  • Results Count: this will show the number of assets that are returned 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.
  • Result 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.
  • Sliding page list showing X page numbers at a time: 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.
  • 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: this will show 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 Links: this will show 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.

Tip: If you include the keyword replacement Initial Layout, the search fields will show on the results page. The user can then perform a search again without having to return to the initial Search Page.

Along with the keyword replacements that appear in the list, you can also use the following keyword replacements on the Results Page Layout Bodycopy:

  • %<field_name>_query_synonyms_message%: where is the name of the field that was entered when it was created on the Search Fields screen. For example, if you entered the name Keyword, this will be %keyword_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%: where<field_name> is the name of the field that was entered when it was created on the Search Fields screen. For example, if you entered the name Keyword, this will be %keyword_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%: where <field_name> is the name of the field that was entered when it was created on the Search Fields screen. For example, if you entered the name Keyword, this will be %keyword_query_suggestions_message%. This will show the message that has been entered on the Messages screen in the Spell Check field. Using the spell checker, it will suggest alternative spellings for a term the user entered into the field on the Search Page.
  • %<field_name>_query_suggestions%: where is the name of the field that was entered when it was created on the Search Fields screen. For example, if you entered the name Keyword, this will be %keyword_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%: where is the name of the field that was entered when it was created on the Search Fields screen. For example, if you entered the name Keyword, this will be %keyword_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%: where<field_name> is the name of the field that was entered when it was created on the Search Fields screen. For example, if you entered the name Keyword, this will be %keyword_query_terms%. This will show the terms the user entered into the search field.
  • %<field_name>_query%: where<field_name> is the name of the field that was entered when it was created on the Search Fields screen. For example, if you entered the name Keyword, this will be %keyword_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%: where<field_name> is the name of the field that was entered when it was created on the Search Fields screen. For example, if you entered the name Keyword, this will be %keyword_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.
  • %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.
  • %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.

No Results Page Layout

The No Results Page Layout Bodycopy is used to define the layout if there are no results found from the search that is being performed. For example, for the Search Page shown in the figure below, a heading, a message and the layout defined in the Initial Search Page Layout Bodycopy are shown. This has been defined in the No Results Page Layout Bodycopy.

An example No Results Page layout
An example No Results Page layout

To change what information is being shown, right click on the No Results Page Layout in the Asset Map and select Edit Contents. Click on the edit icon icon – the WYSIWYG Editor will appear where you can use keyword replacements and formatting to layout the information to show on the Search Page. By default, the information shown in the figure below will appear in the WYSIWYG Editor.

The WYSIWYG Editor on the No Results Page Layout Bodycopy
The WYSIWYG Editor on the No Results Page Layout Bodycopy

Keyword Replacements on the No Results Page Layout Bodycopy

A list of keyword replacements is provided in the WYSIWYG Editor tool bar on the Edit Contents screen of the No Results Page Layout Bodycopy. You can use these keyword replacements in conjunction with text, images and links etc to layout what to show for the list of results. The standard keyword replacements that are available include the following:

  • Initial Layout: this will show 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.

Default Search Bodycopy

By default, when a search is performed on the Search Page the Results Page Layout does not allow the user to search again. If the keyword replacement Initial Layout is added on the Results Page Layout Bodycopy, it will show the search fields but will also include any headings and additional text that may be included on the Initial Search Page Layout, as shown in the figure below.

An example Default Search layout
An example Default Search layout on a Results page

Instead of using the initial layout, a new Bodycopy called Default Search can be added to the Search Page. This Bodycopy can be used to layout the search fields only and included on the Initial Search Page Layout Bodycopy, Results Page Layout Bodycopy and No Results Page Layout Bodycopy. This means that any headings and additional text will not be shown unless it has been added to the Default Search Bodycopy.

Adding the Default Search Bodycopy

The Default Search Bodycopy
The Default Search Bodycopy

To add the Default Search Bodycopy, right click on the Search Page in the Asset Map and select Details. In the Search Forms field, select Customise search form and click Commit. A new Folder called Search Forms along with the Default Search Bodycopy will be added under the Search Page in the Asset Map, as highlighted in the figure to the right.

Editing the Default Search Bodycopy

To change what information is being shown, right click on the Default Search Bodycopy in the Asset Map and select Edit Contents. Click on the edit icon icon – the WYSIWYG Editor will appear where you can use keyword replacements and formatting to layout the information to show on the Search Page.

Keyword Replacements on the Default Search Bodycopy

A list of keyword replacements is provided in the WYSIWYG Editor tool bar on the Edit Contents screen of the Default Search Bodycopy. You can use these keyword replacements in conjunction with text, images and links etc to layout what to show for the list of results. The standard keyword replacements that are available include the following:

  • Input field for <field_name>: where is the name of the field that was entered when it was created on the Search Fields screen. For example, if you entered the name Keyword, this will be Input field for keyword. This will show the box where the user can enter in the search criteria for the field. The format of this keyword replacement is %<field_name>_query%, for example %keyword_query%.
  • Dropdown box for category set <category_name>: where is the name of the category that was entered when it was created on the Search Categories screen. For example, if you entered the name Freezers, this will be Dropdown box for category set Freezer. This keyword replacement shows the list of options for the category. The user can select an option from the list to modify the search criteria being used.
  • Submit Button: this will show the submit button. This keyword replacement is required so that the user can submit the information to perform a search.
Showing the Default Search Bodycopy on the Bodycopy Assets

Once you have added the Default Search Bodycopy, to show it on the Initial Search Page Layout Bodycopy, Results Page Layout Bodycopy and No Results Page Layout Bodycopy, add the keyword replacement Search Form on to each Bodycopy.

Search in Search Bodycopy

The Search in Search Bodycopy allows you to add a search again function to the Results Page Layout Bodycopy. The user can use this function to refine their search criteria. These refined results will be added to the existing results. For example, say a user searches for modules and receives 50 results. They can then refine their search by overwriting the term modules with the term matrix. The Search Page will now look for assets that have both modules and matrix in the field. The results page now shows 70 results.

Adding the Search in Search Bodycopy

The Default Search Bodycopy
The Search in Search Bodycopy

To add the Search in Search Bodycopy, right click on the Search Page in the Asset Map and select Details. In the Search Forms field, select Customise search within search form and click Commit. A new Folder called Search Forms along with the Search in Search Bodycopy will be added under the Search Page in the Asset Map, as highlighted in the figure to the right.

Editing the Search in Search Bodycopy

To change what information is being shown, right click on the Search in Search Bodycopy in the Asset Map and select Edit Contents. Click on the edit icon icon – the WYSIWYG Editor will appear where you can use keyword replacements and formatting to layout the information to show on the Search Page.

Keyword Replacements on the Search in Search Bodycopy

A list of keyword replacements is provided in the WYSIWYG Editor tool bar on the Edit Contents screen of the Search in Search Bodycopy. You can use these keyword replacements in conjunction with text, images and links etc to layout what to show for the list of results. The standard keyword replacements that are available include the following:

  • Input field for <field_name>: where is the name of the field that was entered when it was created on the Search Fields screen. For example, if you entered the name Keyword, this will be Input field for keyword. This will show the box where the user can refine the search criteria for the field. The format of this keyword replacement is %<field_name>_query%, for example %keyword_query%.
  • Dropdown box for category set <category_name>: where is the name of the category that was entered when it was created on the Search Categories screen. For example, if you entered the name Freezers, this will be Dropdown box for category set Freezer. This keyword replacement shows the 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: this will show the search in search button. This keyword replacement is required so that the user can submit the information to refine their search.
Showing the Search in Search Bodycopy on the Bodycopy Assets

Once you have added the Search in Search Bodycopy, to show it on the Results Page Layout Bodycopy, add the keyword replacement Search in Search Form.


Previous Chapter Next Chapter

Send Feedback

Noticed an error?
Want to suggest an improvement?

Let Us Know

The Latest

Let Us Know What You Think

Let us know if you spot any errors or if you have any ideas on how we can improve the Matrix Community Website.

Contact Squiz for Demo

Let us show you the true power of Squiz Matrix by giving you a personalised demonstration.