docs.roxen.comView this page in a printer friendly mode
DocsRoxenWebServer 5.0Web Developer ManualSearch
Copyright  2012, Roxen Internet Software
Suggestions, comments & compliments
manuals@roxen.com
 DEMO  DOCS  PIKE
 COMMUNITY  DOWNLOAD
www.roxen.com



Query Syntax
<search-form>
<search-results>
<search-control>
<search-help>

<search-form></search-form>

Provided by module: Search: Query Module

Creates a search form. When used as a single tag, the contents of the Search Query module variable will be used instead.

If an attribute is encountered that is unknown to the module, it is passed through to the <form> tag that is generated. The default is to set the action attribute to the current page, and to use method="GET", but that can be overridden by supplying other values for action and method.


Attributes

db="database profile"

The name of the database profile to use.


query-profile

The name of the query profile to use.


type

The type of search performed. Must be either one of "or" or "and".


&_.db;(provided by Search: Query Module)

Returns the name of the database profile to be used. The value is fetched from the db attribute.

Note!

If that attribute is missing, and there is exactly one database profile available, then that database profile's name is used. If there are several available database profiles, and there is no db attribute, then this entity is not set.


&_.query-profile;(provided by Search: Query Module)

Returns the name of the query profile to use. If the attribute query profile is missing then the name "Default" is assumed.


&_.type;(provided by Search: Query Module)

If the type was given to the <search-form> tag, then that value is returned. Otherwise, this entity is not set.


<search-form-db-select/>

Provided by module: Search: Query Module

Generates a select list with the available database profiles. If the enclosing scope has the entity &_.db; set, then no select list is generated. The RXML code for this tag is fetched from a Search Query module variable, so that you can alter it to some other type of input form element.


<search-form-type-select/>

Provided by module: Search: Query Module

Generates a select list to select which type of search to perform. If the enclosing scope has the entity &_.type; set, then no list is generated. The RXML code for this tag is fetched from a Search Query module variable, so that you can alter it to some other type of input form element.