Manual:Extension/Page Forms

Page Forms allows you to enter parameter values ​​for templates via a form.

The use of the extension is documented extensively on MediaWiki.

Main features

• Definition pages in the namespace Form
  The New forms can be created using the special page Special: CreateForm. Here, users select an existing template which provides the paramaters for the form. This means that before a form is created, the required template is always created first. All created form definition pages are saved in the Form namespace. Subsequent edits to the form definition page have to be made in source editing mode.
• Application example: info boxes
  Page Forms is often used to add and edit infoboxes on a wiki page. If Semantic MediaWiki is used, the collected data in the templates can be stored and retrieved.
• Edit existing forms values via menu item
  Existing values in a template can be updated using the menu item "Edit with form" of the page edit button, for example.
• Automatic completion of fields
  Users Users are offered existing values when entering them, depending on the form input type. This reduces problems with naming ambiguities, spelling, etc.
• Free text field
  Free text on the page that is not part of the template itself can be displayed in a separate input field called "Free text" for editing directly in forms mode.

Getting Started

To make creating your first form easier, you can start with the documentation on the following pages:

• Create a form: After you have created a template, you can create the corresponding form using the Special:Create Form page. This special page supports you in creating the form. However, subsequent editing takes place directly in the form's source code.
• Form fields: Types of form fields
• Link the form to the template: Since the template exists before the form, it must subsequently be manually linked to the new form
  • within the template
  • As an additional edit link directly in the page's edit menu

BlueSpice input types

In addition to the default input types, BlueSpice offers the following additional input types:

Input type	Result	Function
bs-grid	input table	grid-based input field to combine related paramters. Table rows can be added with a "+" button. The following templates need to be created: Template for the table row plus its related columns.json page Template for the output of the grid on a wiki page
bs-usercombo	User name (with link to the profile page)	(Single selection).
bs-usertags	Comma-separated user name	Menu that allows to select existing wiki users (multiple selections possible). Note: To link to the profile page, the corresponding parameter in the template needs to be formated accordingly: {{#arraymap:{{{myParameter|}}}|,|@@@|[[User:@@@|@@@]]}}
bs-mvvisualeditor	Formatted text	Text box with simplified VisualEditor.
bsvisualeditor	-	Obsolete - replaced by bs-mvvisualeditor

bs-grid

Bs-grid provides the possibility to use table rows to collect combined values for a particular parameter:

entering grid-data for a single form field

To create the grid-based form field and its output:

1. Create the template Template:Products/Row.
   1. Define the parameters, for which to collect values. Gere we create a table row, so that we can later display the collected data as a table:

      <noinclude>Table row for the output of the product data</noinclude><includeonly>
      |-
      |{{{product|}}}
      |{{{department|}}}
      |{{{availDate|}}}
      |{{{sale|}}}
      </includeonly>
      

2. Define the grid in the page Template:Products/Row/Columns.json:

   [
   {"header":"Product name","dataIndex":"product", "flex":1, "editor":{"allowBlank":false}},
   {"header":"Department","dataIndex":"department","editor":{"xtype":"combo","typeAhead":true,"triggerAction":"all","store":[["Toddler","Toddler"],["Boys","Boys"],["Girls","Girls"],["Men","Men"],["Women","Women"]]}},
   {"xtype":"datecolumn","header":"Available from","dataIndex":"availDate","format":"d.m.Y","editor":{"xtype":"datefield","format":"d/m/y","minValue":"01/01/21"}},
   {"xtype":"checkcolumn","header":"On sale?","dataIndex":"sale","headerCheckbox":true,"stopSelection":false}
   ]
   

   Note: The syntax of this json file is produced by the Ext JS framework. Links to the documentation of the grid syntax are provided under Related info at the end of this page (JS-knowledge required).
   
3. Create the page Template:Products. It contains the output format for the data. It is also formatted as a filterable table.
   

   <noinclude>Output table for product data. 
   The parameter "productdate" is processed in the form Form:Products.
   </noinclude><includeonly>{{#default_form: Products}}
   {| class="wikitable filterable"
   |+Product overview for our current collection
   !Product name
   !Department
   !Available from
   !On sale?
   {{{productdata}}}
   |}
   </includeonly>
   

4. Create the data entry form Form:Products. The form field productdata defines the data entry type as a table (bs-grid):
   

   <noinclude>This is the form "Products".It is being used with the template Template:Products.</noinclude><includeonly>
   <div id="wikiPreview" style="display: none; padding-bottom: 25px; margin-bottom: 25px; border-bottom: 1px solid #AAAAAA;"></div>
   {{{for template|Products}}}
   Products: 
   
   {{{field|productdata|input type=bs-grid|colDef=Template:Products/Row/Columns.json|template=Products/Row}}}
   
   {{{end template}}}
   
   {{{standard input|save}}} {{{standard input|preview}}} {{{standard input|cancel}}}
   </includeonly>

   
   
5. Include the template "Products" on a wiki page.
   1. Click Insert > Template in the editor toolbar.
   2. Enter "Products.
      
      

      add the Products template to a page
   3. Click Add template.
   4. Save the page.
   5. Open the page in form-edit mode (using the drop-down menu next to the "+"-button in the top toolbar.The page open in forms mode. Enter your data in the products grid.
   6. Save the page again. The filterable products table is now shown.
      
      

      Output of the grid data for parameter productdata
      
      In source code view, the productdata parameter looks like this:

{{Products
|productdata={{Products/Row|product=Trekking pants|department=Men|availDate=30.07.2021|sale=true}}
{{Products/Row|product=Sweater|department=Boys|availDate=04.07.2021}}
{{Products/Row|product=Socks|department=Women|availDate=03.08.2021}}
}}

Special pages

Page Forms defines some special pages that are used for data input and data maintenance.

Among others, the following special pages are important for data collection:

Related info

• https://www.mediawiki.org/wiki/Extension:Page_Forms/en
• Reference:Page Forms

Technical Reference: Page Forms

---

To submit feedback about this documentation, visit our community forum.