search-region

Summary

[search-region arg]

Parameter	Description	Default
arg		None
args	Alias for arg.	None
params	Alias for arg.	None
search	Alias for arg.	None
sort	Sort the cart items using options specified here	None
hide	Suppress any output text that would ordinarily be returned from this tag. (This universal parameter was introduced with Interchange version 5.5.2.)	No
interpolate	Parse Interchange tags, included in the body text, before this container tag executes.	No
reparse	Process any Interchange tags found in the text output from this tag.	Yes

The following parameters are also available to this tag:

Parameter	Description	Default
form	Arguments for use in [more-list] URIs.	None
label	Label for use with multiple simultaneously-active search objects.	current
more_template	Override the default [more-list] display template.
prefix	Override the "PREFIX" used by the various [PREFIX-*] sub-tags.	item
safe_data	Allow the "[" character to remain intact in returned data.	No

Description

Once a search has completed, there needs to be a way of presenting the output.

By default, the "search" SpecialPage is used. This is set to "results" in the Standard ecommerce demo, but any number of search pages can be specified by using the mv_search_page search parameter to set the target page for each search.

On the "results" page, some special Interchange tags are used to format the otherwise standard HTML. See the Looping tags and sub-tags category.

The basic structure of a "results" page looks like this:

[search-region]
[on-match]
Text / tags to be output if some matches are found (optional).
[/on-match]

[search-list]
Your iterating code, looped over once for each match.
[/search-list]

[no-match]
Text / tags to be output if no matches are found (optional but recommended).
[/no-match]

[more-list]
More / paging area (optional).
[/more-list]
[/search-region]

The order in which the results are displayed can be influenced by either the sort parameter, or by using the [sort] pseudo-tag.

Parameters

arg

sort

Search results can be sorted into a specific order using this parameter. This parameter expects sort options to be specified in a specific manner, as explained here.

form

You can use this to pass one or more form variables in the pagination links of a [more-list]. For example, use form="foo=bar" to include "foo=bar", as a URI argument in each of the pagination links.

Warning

Form variables, specified using this parameter, will not be available to the [cgi] tag in the initial result set. This is because the query returns the first page directly and no pagination link will have been followed.

label

If you are setting up multiple simultaneously-active search objects within a page, then this allows you to distinguish between them. The default label is "current". Most people will not need this.

more_template

Override the default display template value, used by the [more-list] sub-tag.

prefix

Setting "prefix=foo" overrides the "PREFIX" used by the various [PREFIX-*] sub-tags, and also by the [PREFIX-quote] container.

The default "prefix" is "item".

safe_data

Setting "safe_data=1" allows the [sql-data] and [sql-param] sub-tag (etc.) to return values containing the "[" character.