Extension:Page Forms/Creating query forms/en

Forms can also be used for querying, as opposed to adding or editing data. To do so, use the  page, which displays a form in a manner similar to , but with no associated 'target page'. Instead, when the user submits the form by hitting the "Run query" button, they see what the template looks like when displayed with the values they entered.

The template that the form uses should most likely contain one or more queries (using Semantic MediaWiki inline queries, Cargo queries, External Data queries, etc.) to query data using values that the user entered. You can see an example of a query form here.

The "Run query" button
By default, a button called "Run query" shows up at the bottom of forms if they are accessed via. You can change the location and text of this button, using the tag " " (or " ", etc.) within the form definition.

See part "standard input" tag (Defining forms manual) for more information.

Query form at top
If you add the parameter " " to the  tag, the query input field will show up at the top of the results page, instead of the bottom.

Creating links to query forms
Once a query form has been created, you can link to it using syntax that looks like this:



However, the preferred solution, because it's easier and more powerful, is to use the  parser function. A basic call to that function would look like:



Here's the complete syntax of :



These parameters are almost identical to the ones used by ; for a full explanation of the parameters, see using   (Linking to forms manual).

Embedding query forms
You can also embed a query form within another page. To do that, add the following in a page where you want the query form to appear:



You can similarly embed multiple  forms in the same page.

Preloading data in the query
In case query data needs to be pre-loaded, the  should follow the convention:



For example, like this:



The construction   might cause a problem in connection with the wiki markup, and therefore the square brackets—  and   —can be replaced with either   and , or   and  ).

Finally, make sure that the case in the query string matches the declaration in the form (e.g.,  must match   and   must match.

Alternatively, you can preload data by using the  parameter for form fields.

Displaying results automatically
The above technique will produce pre-selected values in the form, but the user will still has to press the "Run query" button to see the results of the query. If you want the results to be displayed automatically as well, you simply have to add  to the query string, like the following:



As before, the recommended way to link to such a page internally is with ; such a call would look as follows: