Extension:Page Forms/Defining forms

Page Forms provides an entire syntax for defining forms, that makes use of tags contained within triple curly brackets. Pages that contain such syntax should always go in the "Form:" namespace (or, for non-English-language wikis, its equivalent in another language). Such pages are not called forms, but rather "form-definition pages", to distinguish them from the actual corresponding forms that users see.

It is recommended that, when starting out with Page Forms, you should not try creating form-definition pages from scratch, but rather use one of Page Forms' helper pages to create them: Special:CreateClass or Special:CreateForm - or copy from some other example, or use the Page Schemas extension. Later on, to make changes to the form, you will most likely have to edit the form definition directly, unless you make use of Page Schemas; in either case, the following documentation should be helpful.

Form markup language
Forms are defined using a set of tags that specify templates and fields within those templates. Wiki-text, and some HTML, can be freely embedded anywhere outside of the tags. The allowed tags are:

'info' tag
The  tag holds special information about the form. This tag is optional, but should be placed at the top of the form if it is present. Allowed parameters of this tag are:
 * - Indicates that this form is a partial form; see "Partial forms", below.
 * title - Sets the title for the 'FormEdit' page, if the form is being used to create a new page. By default, the page name will appear right after this title; however, you can embed the page name within the title by putting "&lt;page name&gt;" within the title value.
 * title - Sets the title for the 'FormEdit' page, if the form is being used to edit an existing page. You can similarly embed "&lt;page name&gt;" within this title value.
 * title - Sets the title for the 'RunQuery' page
 * formula - Sets a formula for automatic setting of the name of the page being added; see "Linking to forms#The one-step process".
 * - Places the form at the top, instead of the bottom, for the 'RunQuery' page
 * - Indicates that the free text in the page generated by the form should be placed within an " " tag, so that pages created by the form can be transcluded in other pages without affecting those other pages' semantic properties.

'for template' tag
The  tag specifies a template name, and declares that all of the following fields (until end template is reached) will be those of this template. The name immediately following the for template declaration is the name of the template. Allowed parameters of this tag are:
 * label text - Specifies a label to be placed in a square around the entire set of this template's fields in the form. This is especially useful if the template can have multiple instances.
 * - Specifies that the user can change the number of instances of this template in the form, allowing multiple (or zero) occurrences; see "Multiple-instance templates", below.
 * - Sets a pre-set display for all the inputs for this template; the wikitext around the input tags (if any) will simply be ignored. This parameter can currently take two values: "table" (which can be used for any template) and "spreadsheet" (which can be used only for multiple-instance templates). In both cases, the field name serves as the "label" of each input, unless a "label=" value is specified for that input. See "Spreadsheet-style editing" for more information on the "spreadsheet" option.
 * - Sets the height for the "spreadsheet" display; default is 200px.
 * number - For multiple-instance templates, sets the minimum number of allowed instances.
 * number - For multiple-instance templates, sets the maximum number of allowed instances.
 * text - For multiple-instance templates, sets the text in the "Add another" button.
 * - Specifies that only fields in the form that correspond to fields used by the template should get turned into form elements.
 * template name[field name] - Specifies that the call(s) to this template within the generated pages will get embedded within the value of some field of another template (i.e., " "). It is used in conjunction with the "holds template" parameter for the 'field' tag (see below). Note that the template to be embedded must appear after the template in which it will be embedded.

'end template' tag
The  tag ends the range of a template. There are no parameters for this tag.

'field' tag
The  tag specifies a field to be placed in a form, corresponding to a template field. The name immediately following the field declaration is the name of the template field. There are a large variety of possible parameters to this tag, some of which can only be used for certain input types.

Parameters that can be applied to any field are:
 * input type - Specifies the type of input this field will have in the form. If a field corresponds to an SMW property or Cargo field, the form will usually have the correct input type by default; otherwise the default is text. If the corresponding SMW property, or Cargo field, cannot be automatically determined, you can use the parameter "property", or the parameters "cargo table" and "cargo field", to manually specify it (see below). The allowed set of input types is different for every SMW or Cargo type; see "Input types" for the full list of options.
 * - Specifies that this field will be hidden in the form: used to preserve values in edited pages.
 * - Specifies that this field must be filled in by the user. Note:  should not be used in conjunction with  . Use of both in any field will cause the mandatory check on any field to fail when the form is saved.
 * - Specifies that this field will be editable only by admins/sysops and disabled for all other users. This parameter can also be called as " =group name", which restricts editing of the field to the specified user group.
 * default value - Specifies a default value for this field. This default only takes effect when creating a new page, not when editing existing pages. For date-related fields, default=now will set the value to the current date and possibly time. For text fields, default=current user will set the value to the username of the user adding this page. For the checkbox input type, default=yes will check the checkbox by default. (The "checkboxes" input type, on the other hand, like the "listbox" type, requires specifying the actual values, like default=Value A, Value C.) You can also include templates, parser functions, and magic words within the "default=" value.
 * class name - Specifies a CSS class that the input for this field should have.
 * property name - Specifies that the field corresponds to a certain Semantic MediaWiki property, and should thus get the corresponding input type, autocompletion, etc.
 * table name and field name - Collectively used to specify that this form field corresponds to a certain Cargo field, and should thus get the corresponding input type, autocompletion, etc.
 * - Specifies that this field contains a list of values.
 * delimiter - Specifies the delimiter character or string this field should use, if it represents a list of values; the default is ",".
 * label text - If a "display=" value is set in the tag, this parameter sets the name of the label for this field (by default, the label is the name of the field).
 * template name[coordinates field name] - Can be applied to more than one field, to specify that these set of fields collectively define an address that should be used to locate a set of coordinates. This only works if the coordinates field uses the input type "googlemaps".
 * - Specifies that this field is meant to hold a multiple-instance template, and does not have its own form input. It is used in conjunction with the "embed in field" parameter for the 'for template' tag (see above).
 * - Specifies that the value entered for this field must be unique, i.e. must not be the same as any value for the SMW property (if SMW is being used) or Cargo field (if Cargo is being used) corresponding to this template field.
 * category name - Specifies that the value entered for this field must not be the same as the name of any page in the given category.
 * namespace name - Specifies that the value entered for this field must not be the same as the name of any page in the given namespace.
 * concept name - Specifies that the value entered for this field must not be the same as the name of any page in the given SMW "concept".
 * The following parameters are input type-specific:

You may find a lot more information about the input type-specific parameters, and in general for form fields, in the Input types page.

'section' tag
The  tag specifies a textarea to be placed in a form, that corresponds to a page section. The name immediately following "section|" is the name of the section. Allowed parameters of this tag are:
 * level – Specifies the "level" of the section heading; can be 1-6, corresponding to '=' through '======' in wiki markup. See "Sections" for more information.
 * - Specifies that the section header should not get added to the page at all if the section is empty.

The following parameters, which can also be used for the "textarea" input type and the free text input, can also be used for sections. See "The free text input" section below.

'standard input' tag
The  tag is used for ten different inputs that usually appear at the bottom of every form. The text immediately after "standard input|" is the name of each input. The most notable of these inputs is 'free text', which is a textarea that holds all the non-template, non-section text in a page. The other nine are form elements such as the "Save" and "Preview" buttons; see Defining the bottom of the form for the full list.

The 'free text' input has more elaborate handling than the other standard inputs; see below for its allowed parameters.

For the other standard input types, the allowed parameters are:
 * label name - Specifies the text associated with this input on the form.
 * label name - Specifies the CSS class for this input.
 * label name - Specifies the CSS style for this input.

In addition, the 'watch' input type can take in the parameter 'checked', which checks the "Watch this page" checkbox by default.

The free text input
The "free text" input sets a textarea that holds all the non-template, non-section text in a page. The following parameters for "textarea" fields can also be used for free text inputs:
 * rows</tt>
 * cols</tt>
 * hidden</tt>
 * restricted</tt>
 * default</tt>
 * class</tt>
 * autogrow</tt>
 * editor</tt>

In addition, there is one parameter available only for the "free text" input - "preload":
 * page title - Specifies a page whose contents should be preloaded into this field.

If it is left out of the form definition, any free text in a page will be preserved in the form as a hidden field, not viewable or modifiable by the user.

Caching
You can have the set of values used for autocompletion in forms be cached, which may improve performance. To do that, add something like the following to LocalSettings.php: The timeout value is in seconds; it can take any number.

Multiple values for the same field
Page Forms supports having multiple values within a given field, and some form input types - like "checkboxes" and "listbox" - are specifically geared for fields that contain multiple values. Text and textarea fields can also support autocompletion for multiple values. If a form field is meant to hold multiple values, the corresponding template field should most likely contain a call to either #arraymap or #arraymaptemplate - see "Page Forms and templates#Multiple values for the same field". Regardless of what is contained in the template, though, the fact that a field is meant to hold multiple values can be hard-coded in the form definition by adding the parameter "list" to the tag. The parameter "delimiter=" can also be helpful, if the delimiter between values is meant to be something other than the default (a comma).

The default input type for a field with multiple values is "tokens".

Multiple-instance templates
If you add the 'multiple' parameter to a template, it will allow for multiple (or no) instances of this template in the form, and therefore in the generated page. The sample form below, for the 'Item' form, contains two such templates. If you look at the form that this definition generates, you can see that there are two buttons labeled "Add another". Clicking on either of these will create a new instance of that template and its field(s). Instances can be rearranged, by clicking on the icon on the right-hand side and dragging the instance up or down within the set.

You can rename the "Add another" button to any other text, using the " " parameter. For instance, to change the button to read "Add another occupation" for a template called "Occupation", you could have " ".

You can set the minimum and maximum number of instances users can set for such a template, using the " " and " " parameters, respectively.

If you want to semantically store all the data contained in these multiple-instance templates, it is recommended to use either the Cargo extension, the Semantic Internal Objects extension, or Semantic MediaWiki's subobjects. (If you use subobjects, you should not name them, so that each subobject gets an automatically-assigned name .)

There is a small difference between regular and embedded multiple-instance templates.
 * In the case of regular templates, every new instance of a template starts on a new line after the closing }}.
 * If the template is embedded in another template (see " " and " "), every new instance directly follows the closing }} . You cannot embed multiple-instance templates inside other (regular or embedded) multiple-instance templates.

An example of using multiple-instance templates with " " and  " " can be found here.

Spreadsheet-style editing
You can have spreadsheet-style editing of a multiple-instance template, using the jsGrid library. Every template call is displayed as one row in the "spreadsheet". To do that, just add "|display=spreadsheet" to the "for template" tag. The wikitext between the "for template" and "end template" tags will get ignored for this display; only the "field" tags are handled.

With spreadsheet-style editing, the input type=</tt> parameter for fields is handled differently. The default is text, and possible alternate values are textarea</tt>, checkbox</tt> and date</tt>. If any set of possible values is defined for this field, the display will be a dropdown.

You can also set the height of the display using the height=</tt> parameter; the default is 200px.

Defining the bottom of the form
The user inputs at the bottom of the form can be customized using the "standard input" tag. The layout, inclusion and text of each input can be modified. Each user input is defined as a "standard input" tag with its own value; the allowed values are:
 * "save" (for the "Save page" button)
 * "preview" (for the "Show preview" button)
 * "save and continue" (for the "Save and continue" button - this lets users save the page without leaving the form)
 * "changes" (for the "Show changes" button)
 * "summary" (for the "Summary" text field)
 * "minor edit" (for the "This is a minor edit" checkbox)
 * "watch" (for the "Watch this page" checkbox)
 * "cancel" (for the "Cancel" link)
 * "run query" (for the "Run query" button in query forms)

So, for example, the button for "Save page" could be specified with " ", which would place the button where it was defined, with the text on the button reading "Save this page". If no  tags are included in the form definition, the basic seven inputs ("save", "preview", "changes", "summary", "minor edit", "watch" and "cancel") will appear at the bottom of the form, just as they do for regular "Edit" pages. However, if even one such tag is included, then only those inputs which have been included will be displayed, in the order, and with the wiki-text, that they appear in in the form definition.

Sample form
Here is the source code for the 'Item' form definition page at Discourse DB:

<div id="wikiPreview" style="display: none; padding-bottom: 25px; margin-bottom: 25px; border-bottom: 1px solid #AAAAAA;">

Topic:

Position:

Stance:

Item name:

Free text:

Note the presence of both wiki-text and some limited HTML (the 'div' tag) within the code. This markup is based around the templates Item, Opinion and Reference. You can see the working form at this add data page ; the form itself is created on-the-fly from the form definition file. In the 'Items' category page, if you click on any of the pages, you can see the 'edit with form' tab on the top right-hand side. If you click on that tab, you can see this same form, this time populated with the data contained in that page.

The 'wikiPreview' div tag, by the way, is included so that, when the user hits the "Preview" button, they'll be shown the preview directly within the form page, instead of being taken to another page. It is not necessary, and can be safely removed from any form definition.

The #forminput function
Form-definition pages generated by Page Forms (i.e., by Special:CreateForm or Special:CreateClass) always include a call to the #forminput function, which provides an input for users to reach that form. #forminput is not actually a part of the form-definition syntax, though. For information on how to modify the #forminput call, see Linking to forms#The two-step process.

Turning forms into tabbed sections
If you think a form is too long for users to fill out comfortably, you can turn it into sections, with a tab interface to navigate between them, using the Header Tabs extension. If you install this extension, it is very easy to add tabs to a form: just add a top-level section wherever you want a tab to appear, of the form "=Tab 1="; and then add the tag  near the bottom of the form, right above the "standard input" declarations. You can place tab declarations between templates, or within templates, to split up the fields of a template into different tabs. You can see a simple example of a form in tabbed sections here; the form definition used to create it is here.

Such tabs can also be used, in a similar way, to display data pages themselves.

Partial forms
You can specify a form to be a partial form by adding the parameter " " to its  tag. This will make the form cover only the single or multiple templates that it contains, and not modify any part of the page before or after these templates.

A partial form is not recommended as a default form for a category or namespace, but rather as a tool to modify parts of pages after they have already been created. You can see an example of a partial form here, and you can see it in action here, by clicking on the link reading "Add or change this opinion item's references".

Reusing form elements
If you have a set of forms that all contain the same text or sections, you can avoid duplication by creating templates that are used within those forms. Simply place all the text that you want repeated within a template, and call that template within each form. If that template contains form elements (like field definitions), the characters within the form elements simply need to be HTML-escaped - replace '{' with '&amp;#123;', '|' with '&amp;#124;' and '}' with '&amp;#125;'. Or just use &lt;nowiki> around them.

Caching form definitions
When a form is displayed, the form definition is parsed twice - first to turn the wiki-text into HTML, and then to handle the SF-specific tags like "". If a form on your wiki takes a long time to display, it might be due to the first parse, which has been known to take seconds to run. You can have form definitions be cached, so the (mostly) HTML version can be retrieved directly, eliminating the first parse. To do this, add the following line to LocalSettings.php:

$wgPageFormsFormCacheType is set to null by default. If left at null, the parser cache will be used for caching. If set to one of the possible cache types (e.g. CACHE_ANYTHING), the selected cache will be used. This way it is possible to switch off the parser cache (e.g. to force re-evaluation of queries on every page load) and still cache the (rarely changed) form definitions.

Note: if any of your form definitions contain any elements that do dynamic display, such as or , these will not get displayed correctly if forms are cached, so you shouldn't use caching.

Tooltips
You can add tooltips to your form in three different ways:
 * If you have the Semantic MediaWiki extension installed, you can use the  parser function defined by Semantic MediaWiki, e.g.,  . (This parser function is not to be confused with Page Form's "  " tag.) See Help:Adding tooltips for more help.
 * Use the  parser function, defined by the SimpleTooltip extension.
 * If you have "display=table" specified within a " " tag, you can add a "tooltip=" parameter for any field in that template.