BlueSpice Helpdesk - User contributions [en]

Manual:Extension/CognitiveProcessDesigner

2026-08-13T07:51:26Z

Bhuber:

{{DISPLAYTITLE:BPMN diagrams (Business process modeling)}}

'''Business Process Model and Notation (BPMN)''' is a graphical representation for specifying business processes. BlueSpice provides an intuitive GUI (graphical user interface) for creating BPMN diagrams. The feature is based on the open source project [https://bpmn.io/ bpmn.io]. The [[Manual:Extension|extension]] [[Reference:Forms|Forms]] is used to facilitate the input of information for each element.

== How to start ==
To get to the BPMN editor, you can choose between 3 options:

# The '''Entrypoint ''Processes''''' in the main navigation. Note that administrators can deactivate this link in the [[Manual:Extension/BlueSpiceConfigManager#BlueSpiceDiscovery|configuration manager.]] On the Processes page, you can click the link '''New Process''' in the page tools panel.
# The link '''Processes''' in the '''Overview''' section of the '''Global actions''' menu.
# The menu item '''New process''' of the '''plus-icon''' button in the header bar.

Select one of these links to open the BPMN editor.

== Creating a diagram ==
{{Textbox|boxtype=note|header=Note:|text=All process pages are created in the BlueSpice default namespace '''Process'''.|icon=yes}}
To [[Manual:Create|create]] the diagram:

#'''Enter''' a process name.[[File:CPD new process.png|alt=Dialog with process name Post-sales.|center|thumb|350x350px|New process dialog.]]
#'''Click''' ''Done''. The BPMN editor opens. At this point, the diagram contains a start event. You cannot save the diagram until the diagram meets the minimum requirements for saving.
Before continuing with the diagram, let's look at the functionality of the BPMN editor.

== Features of the editor ==
The editor includes the following elements:
[[File:CPD editor.png|alt=7 highlighted user interface elements of the editor|center|thumb|750x750px|The BPMN editor]]
{| class="wikitable" style="width: 100%;"
|+Functionality of the BPMN editor
!Element
!Functionality
!Description
|-
|1
|Cancel
|Leaves the edit mode without saving any changes.
|-
|2
|Center diagram
|Centers the diagram on the page in view mode.
|-
|3
|Save changes
|Saves the diagram and any [[wiki pages]] that need to be created.
|-
|4
|Toolbar
|Contains all commands for editing a diagram.
|-
|5
|Start event
|The start event is already added to the diagram. You still need to add the required label.
|-
|6
|Toggle linting overlays
|Shows errors and warnings. You need to click this button if your diagram cannot be saved.
|-
|7
|bpmn.io info
|Link to the bpmn.io website. Unless you are interested in the technical background of the editor, you can ignore this button.
|}

==Adding the diagram shapes==
Each diagram needs a start event and an end event. There are many additional useful elements to create a meaningful business process diagram.

The main elements of a BPMN diagram are:

* '''events''' (such as the start or end event),
* '''activities''' (mainly different types of tasks), and
* '''gateways''' (decision points between different paths).
{{Textbox|boxtype=important|header=Info about the shapes:|text=If you are not familiar with BPMN, you can refer to the [https://camunda.com/bpmn/reference/ Camunda BPMN 2.0 Symbol Reference].

Note that not all symbols are integrated in the BlueSpice BPMN editor. For example, it is not possible to add sub-processes at this time.|icon=yes}}

The most basic diagram you can save has a start event with a label and a connected end event with a label.
[[File:cpd most basic diagram.png|alt=Diagram with a labelled start event connected to a labelled end event|center|thumb|200x200px|this diagram can be saved]]

To add a shape, click the predecessor shape. Select a symbol to append the next shape.

[[File:CPD editor appending shapes.png|alt=selected exclusive gateway that is actively appending a new task|center|thumb|450x450px|appending a shape]]

{{Textbox|boxtype=note|header=Note|text=A diagram with at least a missing label will throw an error and the Save-button will remain disabled.|icon=yes}}
=== Types of shapes ===
From the toolbar, you can drag-and-drop the shapes onto the diagram. You can see the name of a shape by hovering over it:
[[File:cpd toolbar shapes.png|alt=BPMN shapes toolbar|center|thumb|349x349px|available shapes]]
{| class="wikitable" style="width: 100%;"
|+Shapes overview
!Shape
!Description
|-
|Start event
|Acts as a process trigger; indicated by a single narrow border, and can only be ''Catch'', so is shown with an open (outline) icon.
Note: An Event is represented with a circle and denotes something that ''happens'' (compared with an activity, which is something that is ''done''). Icons within the circle denote the type of event (e.g., an envelope representing a message, or a clock representing time). Events are also classified as '''Catching''' (for example, if catching an incoming message starts a process) or '''Throwing''' (such as throwing a completion message when a process ends).
|-
|Immediate/boundary event
|An event that occurs in the middle of the process between activities ''(represented by a thin double line)''. For example, a task could flow to an event that throws a message across to another pool, where a subsequent event waits to catch the response before continuing.
|-
|End event
|Represents the result of a process; indicated by a single thick or bold border, and can only ''Throw'', so is shown with a solid icon.
|-
|Gateway
|A gateway is represented with a diamond shape and determines forking and merging of paths, depending on the conditions expressed.
|-
|Task
|A task represents a single unit of work that is not or cannot be broken down to a further level of business process detail. It is referred to as an atomic activity. A task is the lowest level activity illustrated on a process diagram. A set of tasks may represent a high-level procedure.
|-
|Data object reference
|Data objects may represent for example documents used in a process, both in physical and digital form. They look like a page with folded top right corner.
They are generally available as long as the process instance is live.
|-
|Data store reference
|To store information in a more permanent way you need Data Stores.
They are commonly used to represent IT systems and applications, but also plain old manila folders or archive would be suitable.

You can show how certain steps of a process use the data (either Data Objects or Data Stores) by using a Data Association arrow (dotted line with arrowhead). They are NOT a part of the process flow.
|-
|Pool / participant
|A pool represents major participants in a process, typically separating different organisations. A pool contains one or more lanes (like a real swimming pool). A pool can be open (i.e., showing internal detail) when it is depicted as a large rectangle showing one or more lanes, or collapsed (i.e., hiding internal detail) when it is depicted as an empty rectangle stretching the width or height of the diagram.
|-
|Group
|A Group is a so-called Artifact and represented with a rounded-corner rectangle and dashed lines. The group is used to group different activities but does not affect the flow in the diagram. It is purely a visual element.
|}

See also: [[wikipedia:Business_Process_Model_and_Notation#Elements|https://en.wikipedia.org/wiki/Business''Process_Model_and_Notation#Elements'']]

=== Shape actions ===
When a shape is active, it shows its associated possible commands.
[[File:cpd shape actions.png|alt=active email task with its command symbols visible|center|thumb|200x200px|shape commands]]
{| class="wikitable"
|+Shape actions
!Action
!Description
|-
|Append end event
|Adds an end event with a connector after the shape.
|-
|Append gateway
|Adds a gateway with a connector after the shape.
|-
|Append task
|Adds a task with a connector after the shape.
|-
|Append intermediate/boundary event
|Adds an intermediate/boundary event with a connector after the shape.
|-
|Add text annotation
|Adds an annotation to the shape. The annotation line and bounding box can be resized and repositioned.
|-
|Change element
|Allows to set a more specific shape type.
|-
|Delete
|Deletes the shape.
|-
|Set color
|Sets the fill color of the shape. For line objects, the outline is colored.
|-
|Connect to other element
|Adds a connector to an existing shape. It cannot be used if no endpoint for the connection exists.
|}

=== Toolbar ===
From the toolbar, you can drag-and-drop the shapes onto the diagram. You can see the name of a tool by hovering over it:
[[File:cpd toolbar tools.png|alt=Selected hand tool with the action information displayed|center|thumb|160x160px|available tools]]
{| class="wikitable"
|+Tools overview
!Tool
!Description
|-
|Hand tool
|When activated, tyou can freely navigate the canvas without accidently moving elements under the cursor.
|-
|Lasso tool
|When activated, you can select multiple shapes at the same time. Objects are only included in the selection if the entire object is part of the selection. Hold the <code>Shift</code>-key to add or remove individal objects.
|-
|Create/remove space tool
|When activated, you can add or remove space horizontally or vertically.
If the results of the actions are not as intended, you can press <code>Ctrl</code>+<code>Z</code> multiple times to undo the changes.
|-
|Global connect tool
|When activated, you can connect a shape with a distant shape. The tool does not stay activated. If you want to use it again, you need to select it again.
|}
== Saving the diagram ==
{{Textbox|boxtype=important|header=Important|text=All diagrams are saved and maintained in the "Process" namespace.
<br>
You can [[#Embedding_a_process_diagram_in_a_wiki_page|embed a diagram in any wiki page.]]|icon=yes}}
When your diagram is complete, you can save it. You cannot save if one or more of the following issues exist:

* Not every shape has a label
* The start or end event is missing

To find the issues, click on the linting button at the bottom of the diagram. It will highlight the problems in the diagram. For example, a missing end event can trigger multiple errors:
[[File:CPD errors.png|alt=error messages caused by a missing end event|center|thumb|650x650px|errors before saving]]
After correcting the errors, you can save the diagram. The save-dialog will ask if you want to create all description pages. You do not have to do this or you can do this at a later time.

=== Unique label requirements ===
The label of an event or a task is used to create its description pages. Therefore, each of these shapes requires a unique label.

=== Unique label requirements for gateways{{Bsvs|bsvTo=5.1.1}} ===
Starting with Bluespice 5.1.1, this requirement is not applied to gateways and in general to shapes that do not produce wiki pages. Therefore, it is possible to use yes/no gateway labels multiple times in a diagram.

== Renaming a shape ==
To rename the label for a shape, double-click the shape and change the label. If a shape with the same name already exists, the system automatically creates a unique name for the shape by appending a number. When you rename a shape, the associated page is also renamed (if the page already existed previously).

== Creating the wiki pages ==
If you decide to describe your shapes in more detail with individual wiki pages, you need to activate the checkbox in the save dialog:
[[File:CPD save description pages.png|alt=save dialog with checkbox for description pages checked|center|thumb|380x380px|creating description pages]]
The next dialog lists all pages that were created.
[[File:CPD list of description pages.png|alt=list of description pages|center|thumb|400x400px|confirmation page]]
{{Textbox|boxtype=important|header=Important!|text=Description pages are only created for start and end events and for the different "task" types (e.g., User task, Script task,...). The type "Call activity" (also listed under task types) does not produce a description page.|icon=yes}}
The colored outlines of the shapes of the diagram now indicate that the shapes are interactive and link to the description pages:
[[File:CPD interactive diagram.png|alt=finished diagram of post-sales process in view mode|center|thumb|650x650px|interactive diagram]]
Clicking on any such shape opens its wiki page:
[[File:CPD shape description page.png|alt=wiki page for the shape "send training info" with highlighted page elements|center|thumb|650x650px|elements of a shape description page]]
{| class="wikitable" style="width: 100%;"
|+Elements of a description page
!Element
!Functionality
!Description
|-
|1
|Breadcrumb
|Shows the location path of the description page (as [[Manual:Subpage|subpage]] of the process page).
|-
|2
|Incoming connections
|Label for the connections that precede this step.
|-
|3
|Outgoing connections
|Label for the connections that follow this step.
|-
|4
|Page flow
|Links to the preceding and succeeding description pages.
|-
|5
|BPMN task description
|Placeholder template that indicates that a custom description can be added below the connections info. To replace the template with a real description, you can simply switch into page editing mode like any other wiki page. If you add content to this page, the placeholder template is no longer needed and you can simply remove it from the page.
|}

== Embedding a process diagram in a wiki page ==
BPMN diagrams cannot be created on a wiki page itself, but you can embed a diagram by using the related [[Manual:Extension/ContentDroplets|Content droplet]].

On any wiki page, open the Content droplets dialog in the visual editor toolbar.
[[File:VE droplets menu icon.png|alt=partial visual editor with highlighted droplet icon|center|thumb|200x200px|Content droplets menu item]]

[[Search]] for the term "process":
[[File:CPD droplet.png|alt=content droplets dialog showing the filtered result for the Process droplet|center|thumb|650x650px|content droplet "Process"]]

Select the droplet and click ''Insert''. Provide the name of the process and click ''Save'':
[[File:PDC droplet inspector.png|alt=selected process "Post-sales" in the inspector dialog|center|thumb|300x300px|droplet inspector]]
If the toggle-switch to show the toolbar is activated, a select menu above the diagram is displayed. It allows to:

[[File:cpd toolbar.png|alt=opened BPMN menu with 5 menu options|center|thumb|208x208px|BPMN toolbar]]
* '''Go to the diagram page:''' The diagram can only be edited directly in the process namespace.
* '''Download diagram as SVG:''' You can save a copy of the diagram locally in SVG-format.
* '''Center diagram:''' If you have a large diagram that requires repositioning on the page while viewing it, it can be reset to show the beginning of the diagram from top left again.
* '''Show raw XML:''' Switches to the XML source of the diagram.
* '''Show diagram:''' Switches back to the diagram after viewing the raw XML.

== Special considerations ==

* Page names of process pages:
** The length of page titles for wiki pages is limited to approximately 255 characters. In extreme cases, this can cause a memory error when creating activity pages. For example, if the process name itself is very long and an activity with a long name is located in a swim lane with a long name.
** Slashes in activity names are not permitted, as they are used to create the subpage path.
* Expandable sub-processes are not possible (although a call activity can be created).
* Wiki pages are only created for the standard activity. When switching to a special activity (e.g., a manual activity), no page is created.

* {{translation}}

Templates download

2026-06-30T14:53:48Z

Bhuber:

<ul class="tabs">
<li class="current">[[Startpage templates download|Templates]]</li>
<li>[[Page templates download|Page Templates]]</li>
<li>[[Startpage templates download|Startpage templates]]</li>
</ul>
{{Messagebox|boxtype=note|icon=|Note text=These templates use extensions which are included in BlueSpice pro, but not in BlueSpice. These extensions are noted for each template:
* [[Reference:Page_Forms|Page Forms (PF)]]
* [[Reference:Semantic_MediaWiki|Semantic MediaWiki (SMW)]]
* [[Reference:TemplateData|TemplateData (TD)]]|bgcolor=}}
__NOTOC__
<div class="cards">

<div>
==[[Templates download/Calendar|Calendar]]==
<div class="box">
<div class="screenshot">[[File:calendar.png|500x500px|alt=Calendar template|link=Templates download/Calendar]]</div>
<div class="text">[[Templates download/Calendar|Simple event calendar]] (SMW, PF)</div>
</div>
</div>

<div>
==[[Templates download/Collapsible|Collapsible]]==
<div class="box">
<div class="screenshot">[[File:collapsible.png|500x500px|alt=Collapsible page sections|link=Templates download/Collapsible]]</div>
<div class="text">[[Templates download/Collapsible|Collapsible sections]] (PF)</div>
</div>
</div>

<div>
==[[Templates download/Employee|Employee]]==
<div class="box">
<div class="screenshot">[[File:Employees gallery.png|500x500px|alt=Screenshot of the employees gallery|link=Templates download/Employee]]</div>
<div class="text">[[Templates download/Employee|Employees gallery]] (TD)</div>
</div>
</div>

<div>
==[[Templates download/IMS Documents|IMS Documents]]==
<div class="box">
<div class="screenshot">[[File:HW-IMS.png|400x400px|alt=Process descriptions overview page|link=Templates download/IMS Documents]]</div>
<div class="text">[[Templates download/IMS Documents|Document control templates]] (SMW, PF)</div>
</div>
</div>

<div>
==[[Templates download/Risk management|Incidents & Risks]]==
<div class="box">
<div class="screenshot">[[File:RM-riskentry.png|500x500px|alt=Risk entry screenshot|link=Templates download/Risk management]]</div>
<div class="text">[[Templates download/Risk management|Risk registry and incident reports]] (SMW, PF)</div>
</div>
</div>

<div>
==[[Templates download/Meetingtype|Meeting Types]]==
<div class="box">
<div class="screenshot">[[File:Template_Meetingtype_types.png|460x460px|alt=Meeting types|link=Templates download/Meetingtype]]</div>
<div class="text">[[Templates download/Meetingtype|Banner for meeting minutes page templates]]</div>
</div>
</div>

<div>
==[[Templates download/Minutes for teams|Minutes]]==
<div class="box">
<div class="screenshot">[[File:HW-Minutes-en.png|460x460px|alt=Main meeting minutes template|link=Templates download/Minutes for teams]]</div>
<div class="text">[[Templates download/Minutes for teams|Teams-based main template]] (TD)</div>
</div>
</div>

<div>
==[[Templates download/New|New]]==
<div class="box">
<div class="screenshot">[[File:Template_New_View.png|460x460px|alt=Template new view|link=Templates download/New]]</div>
<div class="text">[[Templates download/New|Marking new page content]] (SMW, TD)</div>
</div>
</div>

<div>
==[[Templates download/PortalFlex|Portal]]==
<div class="box">
<div class="screenshot">[[File:HW-PortalFlex-Combo.png|400x400px|alt=Portal page template|link=Templates download/PortalFlex]]</div>
<div class="text">[[Templates download/PortalFlex|Forms-based portal page]] (PF)</div>
</div>
</div>

<div>
==[[Templates download/Process map|Process Map]]==
<div class="box">
<div class="screenshot">[[File:HW-process map text-based.png|800x800px|alt=Text-based process map|link=Templates download/Process map]]</div>
<div class="text">[[Templates download/Process map|Text-based process map]] (TD)</div>
</div>
</div>

<div>
==[[Templates download/Profile Gallery|Profile Gallery]]==
<div class="box">
<div class="screenshot">[[File:HW-Profilegallery.png|800x800px|alt=Gallery with 5 profile images|link=Templates download/Profile Gallery]]</div>
<div class="text">[[Templates download/Profile Gallery|Department-based profile pictures]] (SMW,TD)</div>
</div>
</div>

<div>
==[[Templates download/Project|Project]]==
<div class="box">
<div class="screenshot">[[File:Template_Download_Projects-Projectstartpage.png|300x300px|link=Templates download/Project]]</div>
<div class="text">[[Templates download/Project|Template for a project namespace]] (SMW, PF)</div>
</div>
</div>

<div>
==[[Templates download/SVG|SVG]]==
<div class="box">
<div class="screenshot">[[File:svg-animated.gif|300x300px|link=Templates download/SVG]]</div>
<div class="text">[[Templates download/SVG|Embedded interactive SVG]] (TD, Widgets)</div>
</div>
</div>

<div>
==[[Templates download/Taskboard|Taskboard]]==
<div class="box">
<div class="screenshot">[[File:Template_Download_Taskboard_Style_1.png|alt=view of taskboard style 1|link=Templates download/Taskboard|460x460px]]</div>
<div class="text">[[Templates download/Taskboard|Taskboard]] (SMW, TD)</div>
</div>
</div>

<div>
==[[Templates download/TOClimit|TOC Limit]]==
<div class="box">
<div class="screenshot">[[File:template-download-TOClimit.png|alt=TOC limit template|link=Templates download/TOClimit|460x460px]]</div>
<div class="text">[[Templates download/TOClimit|Limit heading levels in TOC]] (TD)</div>
</div>
</div>

<div>
==[[Templates download/Trainingpage|Training Page]]==
<div class="box">
<div class="screenshot">[[File:HW-Training-en.png|alt=Training page for internal trainings|link=Templates download/Trainingpage|460x460px]]</div>
<div class="text">[[Templates download/Trainingpage|Self-directed trainings]] (TD, SMW)</div>
</div>
</div>

<div>
==[[Templates download/Transclusion|Section Transclusion]]==
<div class="box">
<div class="screenshot">[[File:HW-transclusion.png|alt=Transcluded page section|link=Templates download/Transclusion|460x460px]]</div>
<div class="text">[[Templates download/Transclusion|Transclude a page section]] (TD)</div>
</div>
</div>
<div class="emptycard"></div>
</div>

[[de:Vorlagen Download]]

Manual:Login

2026-06-30T12:18:17Z

Bhuber:

==Login==
While public wikis usually don't require you to log in to read their content, most company wikis are log-in based, especially if you want to contribute articles. Unless your wiki has a comfort-sign on solution installed, you will see a login screen before you can access the wiki.

When logging in for the first time, you usually have to change your password and [[Manual:Extension/BlueSpicePrivacy|confirm the privacy policy and the terms of use]] .
<br />
[[File:Manual:BlueSpice_Login_Screen_en.png|center|450x258px|A typical BlueSpice Login screen|border]]
<br />By the way: if you want to stay logged in for a while, just check the box ''Keep me logged in''. That way you don't need to re-enter your data every time you visit the wiki. Your login is stored in a browser cookie on your system. If you delete your browser cookies, you have to provide your login information next time you want to use the wiki.

== After logging in ==
Once you're logged in, you can access the wiki pages. Ideally, the wiki administrators have granted you editing rights, so you can start working on the wiki content right away. You'll learn [[Manual:Create pages|how to create pages]] in the next chapter.

<br />
[[en:{{FULLPAGENAME}}]]
[[de:Login]]

Sandbox5.2.5

2026-06-23T09:40:17Z

Bhuber:

'''''this is a test page. <small>Can</small> I <sub>edit</sub> and <span class="col-purple">work</span> with the visual editor without any issues?'''''
{| class="wikitable sortable mw-collapsible bs-exportable filterable mw-sticky-header"
|+
!This
!is
!A
!TABLE
|-
| style="" class="col-green-bg" |does
|it
|work
|AS
|-
|intended?
|
|
|
|-
|
|
| style="border-bottom-width:3px;border-bottom-color:#cd41cb;border-bottom-style:dotted;" |
|
|-
|
| style="border-right-width:3px;border-right-color:#cd41cb;border-right-style:dotted;" |
| style="border-left-width:3px;border-right-width:3px;border-top-width:3px;border-bottom-width:3px;border-left-color:#cd41cb;border-right-color:#cd41cb;border-top-color:#cd41cb;border-bottom-color:#cd41cb;border-left-style:dotted;border-right-style:dotted;border-top-style:dotted;border-bottom-style:dotted;" |
| style="border-left-width:3px;border-left-color:#cd41cb;border-bottom-color:#0060df;border-left-style:dotted;" |
|-
|
|
| style="border-top-width:3px;border-right-color:#0060df;border-top-color:#cd41cb;border-top-style:dotted;" |
| style="border-left-color:#0060df;border-right-color:#0060df;border-top-color:#0060df;border-bottom-color:#0060df;" |
|}
<drawio filename="Sandbox5_2_5-47669447" /><math>\arccos\log_{\tan}</math>

File:Sandbox5 2 5-47669447.svg

2026-06-23T09:39:53Z

Bhuber: DrawioEditor

Sandbox5.2.5

2026-06-23T09:39:29Z

Bhuber:

Sandbox5.2.5

2026-06-23T09:38:46Z

Bhuber: Created page with "'''''this is a test page. <small>Can</small> I <sub>edit</sub> and <span class="col-purple">work</span> with the visual editor without any issues?''''' {| class="wikitable sortable mw-collapsible bs-exportable filterable mw-sticky-header" |+ !This !is !A !TABLE |- | style="" class="col-green-bg" |does |it |work |AS |- |intended? | | | |- | | | style="border-bottom-width:3px;border-bottom-color:#cd41cb;border-bottom-style:dotted;" | | |- | | style="border-right-width:3p..."

Manual:Extension/Forms

2026-06-03T13:07:24Z

Bhuber:

The '''Forms''' extension allows formatting a wiki page or a user dialog as a form. It is also used in conjunction with the [[Reference:Workflows|Workflows]] extension where it provides input forms for workflow data.

==Introduction==
To create a checklist as a form, for example, the following steps are necessary:

# '''Create the checklist form definition.'''
# '''Create checklist instances directly from the form definition page.'''

As an example, we are creating the first fields for an event where food-related hygiene information has to be tracked.
[[File:checklist-event-screenshot.png|alt=Event checklist example|center|thumb|550x550px|Event checklist example]]

==Create a checklist form==

# '''Create''' the page ''Checklist Event Hygiene.form''.[[File:Extension Forms create form.png|center|thumb|400x400px|alt=Create-page dialog|Creating a new form]]This opens the Form editor.[[File:Extension Forms form editor.png|alt=elements of the form editor dialog|center|thumb|700x700px|Form editor]]
# '''Add''' a form section:
##'''Select''' the ''Section label'' element under ''Form Elements > Other'' (see screenshot annotation 2) and, holding down the left mouse button, drag it into the interactive form editor field below.
## '''Click''' anywhere in the ''Section label'' line. The field inspector opens.
## '''Enter''' the ''Name''. This is saved as a field ID in the database and should therefore not contain any special characters.
## '''Enter''' the ''Title'' for the section label. This is displayed as the visible label for the text field.[[File:Extension Forms add section header.png|alt=Section label element inspector|center|thumb|700x700px|Adding the first section header]]
# '''Create''' the form fields for the Event section. Here we add a text box as an example.
## '''Drag''' the ''Text'' element from ''Form elements > Inputs'' under the section heading.
## '''Click''' anywhere in the ''text field'' line. The field inspector opens.
## '''Enter''' the ''Name''. This is used as the database ID for this field and should therefore not contain any special characters.
## '''Enter''' the ''Label''. This is displayed as the visible label for the text field.
## '''Add''' more form elements.
# '''Click''' ''Save''. The form is now available in the main namespace as ''EventChecklistHygiene.form''. [[File:Manual:Checklist-view.png|alt=Saved form|center|thumb|650x650px|Saved form]]<br />
To continue editing the form, switch to page edit mode (1).

== Add more form elements ==
Now you can add more fields: [[Manual:Extension/Forms/Form elements and settings|View all form elements that you can add to your forms.]]

==Create a checklist instance==
To create a checklist from the form:

# '''Enter''' an event name
# '''Fill out''' the form fields.
# '''Click''' ''Submit''.The checklist is now saved in the wiki and can be edited further.
==Alternative Target: E-mail==
Instead of creating a wiki page when the form is saved, you can send the form content to an E-Mail account. ('''Note:''' The E-Mail recipient has to be configured on the server by a server admin to be available to forms):
[[File:Manual:image.png|alt=Email target|center|thumb|650x650px|Email target]]

*'''Target type:''' Email
*'''Recipient:''' Possible recipients must have been configured on the server for security reasons. Example:
<syntaxhighlight lang="php" line="1">
$wgFormsTargetEMailRecipients = [
'Marketing' => "marketing@example.com",
'Administration' => 'WikiSysop'
];
</syntaxhighlight>

* '''Subject:''' Existing form fields can be used as variables here. The value is taken from the form.

* '''Content:''' As in the subject, existing form fields can also be used as variables here. The value is taken from the form.

[[mediawikiwiki:Help:Magic_words#Localisation|Localization messages]] in combination with form fields can also be used as subject or email body:<syntaxhighlight lang="wikitext" line="1">
{{int:Mailsubject| {{{name}}}|{{{surname}}} }}
</syntaxhighlight>

==Alternative Target: Template==
Instead of creating a standard wiki page or sending the form content via E-Mail, a [[Manual:Templates|Template]] can be used as the target for a form. In this case, the submitted form data is used to create a new wiki page based on an existing template structure, and form values are inserted into the template placeholders.
*'''Prerequisites''': Before a Template target can be used, a corresponding template page must already exist in the wiki. The template serves as the structural basis for the generated page. Form fields are mapped to placeholders defined in the template.
[[File:Manual:Template Target.jpg|alt=selecting Template as target for forms|center|thumb|550x550px|Template Target]]
*'''Target type''': Template
*'''Template''': Name of the existing template used for page generation
*'''Predefined title''': optional default title for the newly created page or to predefine a page path (e.g., to create all generated pages as subpages under a specific parent page) <br>
<br>It is recommended to use identical or clearly related naming for the form and the template to improve maintainability and make configuration dependencies easier to identify. This is typically used to generate standardized, human-readable wiki pages, while JSON-based targets are more commonly used when the output is intended for structured data processing.

==Adjust the styling==

===Common.css===
To style individual elements in the form, go to the styling tab in the options dialog. There, you can enter a css class name. The styling is then defined on the ''MediaWiki:Common.css'' page (admin rights are required).

To style the section heading:

#'''Open''' the styling tab in the options menu of the Event heading field.
#'''Add''' a new CSS class and enter a selector name (''CSS Classes'' field), e.g. ''frm-sectionhd''.[[File:Manual:forms-css-class-en.png|alt=Add a css class|center|thumb|650x650px|Add a css class]]
#'''Paste''' the following style declarations into the ''MediaWiki:Common.css'' page, e.g.:<syntaxhighlight lang="css">
.frm-sectionhd {
border-bottom: 1px solid #a6a6a7;
background:#f1f3f9;
padding:6px;
margin:30px 0;
}
</syntaxhighlight>[[File:Manual:forms-css-class-view-en.png|alt=Section label with customized styling|center|thumb|650x650px|Section label with customized styling]]

If you do not have permission to view this page, you can enter style information directly for each element in the form via inline styling.

===Inline styling===
Without access to ''MediaWiki:Common.css'', the style information can be entered directly in the form. However, with many recurring style declarations this is not efficient in contrast to the definition of CSS classes in ''MediaWiki:Common.css''.

As an example, let's apply the previous section heading example directly as inline styling. To do this, open the options menu of the ''ech-event'' form element again. Enter the following statement in the ''Styling'' field and save the change:<syntaxhighlight lang="css">
border-bottom: 1px solid #a6a6a7; background:#f1f3f9; padding:6px;margin:30px 0;
</syntaxhighlight>
[[File:Manual:forms-css-inlinestyling-en.png|alt=Inline styling of a form element|center|thumb|650x650px|Inline styling of a form element]]
{{translation}}

Manual:Extension/Forms/5.1.1

2026-06-03T12:21:21Z

Bhuber:

The '''Forms''' extension allows formatting a wiki page or a user dialog as a form. It is also used in conjunction with the [[Reference:Workflows|Workflows]] extension where it provides input forms for workflow data.

==Introduction==
To create a checklist as a form, for example, the following steps are necessary:

# '''Create and save the checklist form''' via the ''Special:Form_editor'' special page. The form serves as a template for all checklists that are created with it.
# '''Create and save checklist instances''' via the special page ''Special:Create_form_instance''.

Optionally, the styling of the form can be adjusted.

As an example, we are creating a small checklist for an event where food-related hygiene information has to be tracked.
[[File:checklist-event-screenshot.png|alt=Event checklist example|center|thumb|550x550px|Event checklist example]]

==Create a checklist form==

# '''Define''' the main properties of the form:
## '''Open''' the ''Special:Form editor'' page.
## '''Enter''' a name for the new form, e.g. ''EventChecklistHygiene''. This name is used as a unique identifier for the database. Therefore, do not use any special characters (apart from the hyphen "-").
## '''Enter''' a title, e.g. Event Checklist. This is displayed as the display title instead of the form name if you activate the Display title checkbox. [[File:Manual:Checklist-form properties.png|alt=Form properties|center|thumb|750x750px|Form properties]]
# '''Add''' a form section:
##'''Select''' the ''Section label'' element under ''Form Elements > Other'' and, holding down the left mouse button, drag it into the interactive form editor field below.
## '''Click''' the section heading radio button. The editing dialog opens.
## '''Enter''' a field name. This is saved as a field ID in the database and should therefore not contain any special characters.
## '''Enter''' the title for the heading. This is used as the display title in the form.[[File:Manual:Checklist-form element-section label.png|alt=Create section label|center|thumb|750x750px|Create section label]]
# '''Create''' the form fields for the Event section. Here we add a text box as an example.
## '''Drag''' the ''Text'' element under the section heading while holding down the left mouse button.
## '''Click''' the text box radio button.
## '''Enter''' a name. This is used as the database ID for this field and should therefore not contain any special characters.
## '''Enter''' a label. This is displayed as the label for the text field.
## '''Add''' more form elements.
# '''Click''' Submit at the bottom of the page to save the form. The form is now stored in the main namespace as ''EventChecklistHygiene.form''. [[File:Manual:Checklist-view.png|alt=Saved form|center|thumb|650x650px|Saved form]]<br />To continue editing the form, switch to the editing mode of the page (1).

==Create a checklist instance==
To use the form, create your first checklist.

# '''Open''' the page ''Special:Edit_with_form''.
# '''Choose''' the form ''EventChecklistHygiene''.
# '''Fill out''' the form fields.
# '''Click''' ''Submit''.[[File:Manual:Checklist-create instance.png|alt=Create a checklist instance|center|thumb|650x650px|Create a checklist instance]]

The checklist is now saved in the wiki and can be edited further.
==Send email==
The form can also send an Email after being saved:
[[File:Manual:image.png|alt=Email target|center|thumb|650x650px|Email target]]

*'''Target type:''' Email
*'''Recipient:''' Possible recipients must have been configured on the server for security reasons. Example:
<syntaxhighlight lang="php">
$wgFormsTargetEMailRecipients = [
'Marketing' => "marketing@example.com",
'Administration' => 'WikiSysop'
];
</syntaxhighlight>

* '''Subject:''' Existing form fields can be used as variables here. The value is taken from the form.

* '''Content:''' As in the subject, existing form fields can also be used as variables here. The value is taken from the form.

[[mediawikiwiki:Help:Magic_words#Localisation|Localization messages]] in combination with form fields can also be used as subject or email body:<syntaxhighlight lang="text">
{{int:Mailsubject| {{{name}}}|{{{surname}}} }}
</syntaxhighlight>

==Adjust the styling==

===Common.css===
To style individual elements in the form, go to the styling tab in the options dialog. There, you can enter a css class name. The styling is then defined on the ''MediaWiki:Common.css'' page (admin rights are required).

To style the section heading:

#'''Open''' the styling tab in the options menu of the Event heading field.
#'''Add''' a new CSS class and enter a selector name (''CSS Classes'' field), e.g. ''frm-sectionhd''.[[File:Manual:forms-css-class-en.png|alt=Add a css class|center|thumb|650x650px|Add a css class]]
#'''Paste''' the following style declarations into the ''MediaWiki:Common.css'' page, e.g.:<syntaxhighlight lang="css">
border-bottom: 1px solid #a6a6a7; background:#f1f3f9; padding:6px;margin:30px 0;
</syntaxhighlight>[[File:Manual:forms-css-class-view-en.png|alt=Section label with customized styling|center|thumb|650x650px|Section label with customized styling]]

If you do not have permission to view this page, you can enter style information directly for each element in the form via inline styling.

===Inline styling===
Without access to ''MediaWiki:Common.css'', the style information can be entered directly in the form. However, with many recurring style declarations this is not efficient in contrast to the definition of CSS classes in ''MediaWiki:Common.css''.

As an example, let's apply the previous section heading example directly as inline styling. To do this, open the options menu of the ''ech-event'' form element again. Enter the following statement in the ''Styling'' field and save the change:<syntaxhighlight lang="css">
border-bottom: 1px solid #a6a6a7; background:#f1f3f9; padding:6px;margin:30px 0;
</syntaxhighlight>
[[File:Manual:forms-css-inlinestyling-en.png|alt=Inline styling of a form element|center|thumb|650x650px|Inline styling of a form element]]
{{translation}}

Manual:Extension/Forms/Form elements and settings

2026-06-02T07:42:47Z

Bhuber:

== Form elements ==
It is possible to add the following form fields to your form:

=== Inputs ===
{| class="wikitable compact" style="width: 100%;"
!Field
!Input type
!Functionality
|-
|Book
|book
|auto-complete field that finds pages in the namespace "Book"
|-
|Text
|text
|standard text field
|-
|Textarea
|textarea
|multi-line text field
|-
|Wikitext input
|wikitext
|multi-line text field that expects Wikitext syntax
|-
|Category multiselect
|category_multiselect
|token field to add one or more categories to the page; values are separated with the <code>enter</code>-key
|-
|Checkbox
|checkbox
|single checkbox
|-
|Menu tag multiselect
|menutag_multiselect
|multiple-value input; values are separated with the <code>enter</code>-key
|-
|Checkbox multiselect
|checkbox_multiselect
|checkbox group (allows selecting multiple values in the group)
|-
|Dropdown
|dropdown
|dropdown list with predefined options
|-
|Number
|number
|integer field
|-
|Radio button
|radio
|single radio button (usually not used in a manually completed form)
|-
|Radio group
|radio_multiselect
|radio buttons for toggling a selection (allows selecting only one value in the group)
|-
|File chooser
|select_file
|selects a file in the wiki
|-
|Title input
|title
|auto-complete field for wiki pages
|-
|Combo box
|combobox
|combines a ''text input field'' and a ''dropdown list''. Users can select a predefined value or type their own.
|-
|Password input
|password
|sets a password with a password and password-repeat field. This is not used in forms for the target types <code>JSON on wikipage</code>, <code>Template</code> or <code>Email</code>, as the password is stored in plain text.
|-
|Tag input
|tag
|token field to add multiple values; values are separated with the <code>enter</code>-key
|-
|Date
|date
|same as ''Date picker''
|-
|Title input
|title
|selects page titles in the wiki
|-
|User input
|user_picker
|username that exists in the wiki
|-
|Group input
|group_picker
|group name that exists in the wiki
|-
|Group multiselect
|group_multiselect
|multiple group names
|-
|User multiselect
|user_multiselect
|multiple user names
|-
|Title multiseslect
|title_multiselect
|multiple page titles
|-
|Date picker
|date_picker
|calendar widget
|-
|Percent
|percent
|integer value
|}

=== Other ===
{| class="wikitable compact" style="width: 100%;"
!Element
!Input type
!Description
|-
|Static Wikitext
|static_wikitext
|non-editable text
|-
|Button
|button
|triggers an action (requires a defined event listener)
|-
|Message banner
|message
|message that can be shown anywhere in the form;
the type that is set (notice, error, warning, success) provides the visual formatting
|-
|Partial form import
|form_input
|adds form fields from another form
|-
|Icon
|icon
| -
|-
|Indicator
|indicator
| -
|-
|Label
|label
| -
|-
|[[Manual:Extension/Forms/Progress bar|Progress bar]]
|progress_bar
|visual representation of the number of completed steps in a form such as a checklist
|-
|Section label
|section_label
|a heading to a form section
|-
|HR
|hr
|a visual separator line
|}

=== Input field options ===
Each input field has a combination of any of these options:
{| class="wikitable compact" style="width: 100%;"
|+main
!Type
!Field
!Functionality
|-
| rowspan="6" |(all)
|Name
|field name stored in the database (avoid special characters)
|-
|Label
|text label shown to users
|-
|Help
|creates a tooltip pop-up next to the label
|-
|No layout
|hides the label
|-
|Show on
|mode in which this field is visible
|-
|Editable on
|sets when the field value can be edited
|-
|Book
|Return property
|?
|}
{| class="wikitable compact"
|+styling
!Type
!Field
!Functionality
|-
| rowspan="2" |(all)
|CSS Classes
|add individual CSS-classes for use on ''MediaWiki:Common.css''
- the class is set on the form field itself and does not include the label; multiple classes can be set together or you can add them separately
|-
|Style
|define an inline style that affects only this field. The style is applied to the wrapper and includes the label and the field
|-
| rowspan="2" |Textarea, Wikitext input
|Number of rows
|used for textareas
|-
|Placeholder
|text that is displayed before the user is typing a value (has no effect, if there is also a default value set)
|-
|Radio group
|No default value
|ensures that there is no pre-selected radio-button if a default would not make sense
|-
|Radio group, Checkbox multiselect
|Horizontal layout
|aligns multiselect checkboxes or radio groups horizontally
|-
| rowspan="3" |Button
|Icon
|displays an icon before the text, (e.g. a bootstrap-icon like <code>bi bi-calendar</code>)
|-
|Indicator
|displays an icon after the text (e.g. a bootstrap-icon like <code>bi bi-arrow-right</code>)
|-
|Framed
|when deactivated, the button looks like text only (and can be styled via CSS classes, e.g. <code>btn button-warning</code>)
|}
{| class="wikitable compact"
|+other
!Type
!Fieldset
!Field
!Functionality
|-
| rowspan="6" |(all)
| rowspan="2" |Custom widget properties
|Key
|
|-
|Value
|
|-
| rowspan="2" |Listeners
|Event
|event that is supported by [https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.html OO.ui widgets], such as ''change, enter, focus, blur''
|-
|Callback
|function that is called when the event occurs (can be declared in MediaWiki:Common.js for example
|-
| rowspan="2" |
|Default value /
Selected by default
|value that is used if the user does not provide a value; field type "checkbox" has option "Selected by default" instead
|-
|Required
|form cannot be submitted without this field having a value
|-
|Password
|
|Password strength
|weak: <br>
medium: <br>strong:
|-
| rowspan="2" |Tag
|
|Input position
|inline:
outline:
|-
|
|Allow arbitrary
|It is possible to add values other than the allowed values (only necessary if allowed values are defined)
|}

== Form Settings ==

=== Appearance ===
{| class="wikitable compact"
!Field
!Functionality
|-
|Title
|display title for the form
|-
|Display title
|shows the form title above each form instance
|-
|Display form name
|displays the name fo the form with label ''Form used'' as first form element
|}

=== Behaviour ===
{| class="wikitable compact"
!Field
!Functionality
|-
|Categories
|adds categories to each form instance; values are separated with the <code>enter</code>-key
|-
|Seal after creation
|form instances cannot be edited after the initial save
|-
|Enable intermediate saving
|form instances show both a <code>Save</code> and a <code>Save & Close</code> button;
the <code>Save</code> button saves the form values and keeps the form in edit-mode.
|}

=== Infrastructure ===
{| class="wikitable compact"
!Field
!Functionality
|-
|Resource loader dependencies
|
|-
|Keep track of revisions
|
|-
|Includable
|extends form
|-
|Abstract
|
|-
|Partial
|
|}

=== Target ===
{| class="wikitable compact"
!Field
!Functionality
|-
|Target type
|
|-
|Predefined page title for pages created using this form
|use the field name to insert the value from a form field;
for example: if you have a field with the name <code>company_name</code>, you can use <code><nowiki>{{company_name}}</nowiki></code> as page name or part of the page name.
|}

=== Listeners ===
{| class="wikitable compact"
!Field
!Functionality
|-
|Event
|each listener reacts to one of these events:

* ''initCompleteForm:'' object is initialized
* ''parseComplete:'' JSON/schema/config fully processed
* ''renderComplete:'' UI fully rendered in DOM
* ''beforeSubmitData:'' Right before submission
|-
|Callback
|calls a function when the event occurs;
see the [[Manual:Extension/Forms/Progress bar|progress bar]] example.
|}{{translation}}
__FORCETOC__

Manual:Extension/Forms/Form elements and settings

2026-06-02T07:33:56Z

Bhuber:

== Form elements ==
It is possible to add the following form fields to your form:

=== Inputs ===
{| class="wikitable compact" style="width: 100%;"
!Field
!Input type
!Functionality
|-
|Book
|book
|auto-complete field that finds pages in the namespace "Book"
|-
|Text
|text
|standard text field
|-
|Textarea
|textarea
|multi-line text field
|-
|Wikitext input
|wikitext
|multi-line text field that expects Wikitext syntax
|-
|Category multiselect
|category_multiselect
|token field to add one or more categories to the page; values are separated with the <code>enter</code>-key
|-
|Checkbox
|checkbox
|single checkbox
|-
|Menu tag multiselect
|menutag_multiselect
|multiple-value input; values are separated with the <code>enter</code>-key
|-
|Checkbox multiselect
|checkbox_multiselect
|checkbox group (allows selecting multiple values in the group)
|-
|Dropdown
|dropdown
|dropdown list with predefined options
|-
|Number
|number
|integer field
|-
|Radio button
|radio
|single radio button (usually not used in a manually completed form)
|-
|Radio group
|radio_multiselect
|radio buttons for toggling a selection (allows selecting only one value in the group)
|-
|File chooser
|select_file
|selects a file in the wiki
|-
|Title input
|title
|auto-complete field for wiki pages
|-
|Combo box
|combobox
|combines a ''text input field'' and a ''dropdown list''. Users can select a predefined value or type their own.
|-
|Password input
|password
|sets a password with a password and password-repeat field. This is not used in forms for the target types <code>JSON on wikipage</code>, <code>Template</code> or <code>Email</code>, as the password is stored in plain text.
|-
|Tag input
|tag
|token field to add multiple values; values are separated with the <code>enter</code>-key
|-
|Date
|date
|same as ''Date picker''
|-
|Title input
|title
|selects page titles in the wiki
|-
|User input
|user_picker
|username that exists in the wiki
|-
|Group input
|group_picker
|group name that exists in the wiki
|-
|Group multiselect
|group_multiselect
|multiple group names
|-
|User multiselect
|user_multiselect
|multiple user names
|-
|Title multiseslect
|title_multiselect
|multiple page titles
|-
|Date picker
|date_picker
|calendar widget
|-
|Percent
|percent
|integer value
|}

=== Other ===
{| class="wikitable compact" style="width: 100%;"
!Element
!Input type
!Description
|-
|Static Wikitext
|static_wikitext
|non-editable text
|-
|Button
|button
|triggers an action (requires a defined event listener)
|-
|Message banner
|message
|message that can be shown anywhere in the form;
the type that is set (notice, error, warning, success) provides the visual formatting
|-
|Partial form import
|form_input
|adds form fields from another form
|-
|Icon
|icon
| -
|-
|Indicator
|indicator
| -
|-
|Label
|label
| -
|-
|[[Manual:Extension/Forms/Progress bar|Progress bar]]
|progress_bar
|visual representation of the number of completed steps in a form such as a checklist
|-
|Section label
|section_label
|a heading to a form section
|-
|HR
|hr
|a visual separator line
|}

=== Input field options ===
Each input field has a combination of any of these options:
{| class="wikitable compact" style="width: 100%;"
|+main
!Type
!Field
!Functionality
|-
| rowspan="6" |(all)
|Name
|field name stored in the database (avoid special characters)
|-
|Label
|text label shown to users
|-
|Help
|creates a tooltip pop-up next to the label
|-
|No layout
|hides the label
|-
|Show on
|mode in which this field is visible
|-
|Editable on
|sets when the field value can be edited
|-
|Book
|Return property
|?
|}
{| class="wikitable compact"
|+styling
!Type
!Field
!Functionality
|-
| rowspan="2" |(all)
|CSS Classes
|add individual CSS-classes for use on ''MediaWiki:Common.css''
- the class is set on the form field itself and does not include the label; multiple classes can be set together or you can add them separately
|-
|Style
|define an inline style that affects only this field. The style is applied to the wrapper and includes the label and the field
|-
| rowspan="2" |Textarea, Wikitext input
|Number of rows
|used for textareas
|-
|Placeholder
|text that is displayed before the user is typing a value (has no effect, if there is also a default value set)
|-
|Radio group
|No default value
|ensures that there is no pre-selected radio-button if a default would not make sense
|-
|Radio group, Checkbox multiselect
|Horizontal layout
|aligns multiselect checkboxes or radio groups horizontally
|-
| rowspan="3" |Button
|Icon
|displays an icon before the text, (e.g. a bootstrap-icon like <code>bi bi-calendar</code>)
|-
|Indicator
|displays an icon after the text (e.g. a bootstrap-icon like <code>bi bi-arrow-right</code>)
|-
|Framed
|when deactivated, the button looks like text only (and can be styled via CSS classes, e.g. <code>btn button-warning</code>)
|}
{| class="wikitable compact"
|+other
!Type
!Fieldset
!Field
!Functionality
|-
| rowspan="6" |(all)
| rowspan="2" |Custom widget properties
|Key
|
|-
|Value
|
|-
| rowspan="2" |Listeners
|Event
|event that is supported by [https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.html OO.ui widgets], such as ''change, enter, focus, blur''
|-
|Callback
|function that is called when the event occurs (can be declared in MediaWiki:Common.js for example
|-
| rowspan="2" |
|Default value /
Selected by default
|value that is used if the user does not provide a value; field type "checkbox" has option "Selected by default" instead
|-
|Required
|form cannot be submitted without this field having a value
|-
|Password
|
|Password strength
|weak: <br>
medium: <br>
strong:
|-
| rowspan="2" |Tag
|
|Input position
|inline:
outline:
|-
|
|Allow arbitrary
|It is possible to add values other than the allowed values (only necessary if allowed values are defined)
|}

== Form Settings ==

=== Appearance ===
{| class="wikitable compact"
!Field
!Functionality
|-
|Title
|display title for the form
|-
|Display title
|shows the form title above each form instance
|-
|Display form name
|displays the name fo the form with label ''Form used'' as first form element
|}

=== Behaviour ===
{| class="wikitable compact"
!Field
!Functionality
|-
|Categories
|adds categories to each form instance; values are separated with the <code>enter</code>-key
|-
|Seal after creation
|form instances cannot be edited after the initial save
|-
|Enable intermediate saving
|form instances show both a <code>Save</code> and a <code>Save & Close</code> button;
the <code>Save</code> button saves the form values and keeps the form in edit-mode.
|}

=== Infrastructure ===
{| class="wikitable compact"
!Field
!Functionality
|-
|Resource loader dependencies
|
|-
|Keep track of revisions
|
|-
|Includable
|extends form
|-
|Abstract
|
|-
|Partial
|
|}

=== Target ===
{| class="wikitable compact"
!Field
!Functionality
|-
|Target type
|
|-
|Predefined page title for pages created using this form
|use the field name to insert the value from a form field;
for example: if you have a field with the name <code>company_name</code>, you can use <code><nowiki>{{company_name}}</nowiki></code> as page name or part of the page name.
|}

=== Listeners ===
{| class="wikitable compact"
!Field
!Functionality
|-
|Event
|each listener reacts to one of these events:

* ''initCompleteForm:'' object is initialized
* ''parseComplete:'' JSON/schema/config fully processed
* ''renderComplete:'' UI fully rendered in DOM
* ''beforeSubmitData:'' Right before submission
|-
|Callback
|calls a function when the event occurs;
see the [[Manual:Extension/Forms/Progress bar|progress bar]] example.
|}{{translation}}
__FORCETOC__

Manual:Extension/Forms/Form elements and settings

2026-06-02T07:33:16Z

Bhuber:

== Form elements ==
It is possible to add the following form fields to your form:

=== Inputs ===
{| class="wikitable compact" style="width: 100%;"
!Field
!Type
!Functionality
|-
|Book
|book
|auto-complete field that finds pages in the namespace "Book"
|-
|Text
|text
|standard text field
|-
|Textarea
|textarea
|multi-line text field
|-
|Wikitext input
|wikitext
|multi-line text field that expects Wikitext syntax
|-
|Category multiselect
|category_multiselect
|token field to add one or more categories to the page; values are separated with the <code>enter</code>-key
|-
|Checkbox
|checkbox
|single checkbox
|-
|Menu tag multiselect
|menutag_multiselect
|multiple-value input; values are separated with the <code>enter</code>-key
|-
|Checkbox multiselect
|checkbox_multiselect
|checkbox group (allows selecting multiple values in the group)
|-
|Dropdown
|dropdown
|dropdown list with predefined options
|-
|Number
|number
|integer field
|-
|Radio button
|radio
|single radio button (usually not used in a manually completed form)
|-
|Radio group
|radio_multiselect
|radio buttons for toggling a selection (allows selecting only one value in the group)
|-
|File chooser
|select_file
|selects a file in the wiki
|-
|Title input
|title
|auto-complete field for wiki pages
|-
|Combo box
|combobox
|combines a ''text input field'' and a ''dropdown list''. Users can select a predefined value or type their own.
|-
|Password input
|password
|sets a password with a password and password-repeat field. This is not used in forms for the target types <code>JSON on wikipage</code>, <code>Template</code> or <code>Email</code>, as the password is stored in plain text.
|-
|Tag input
|tag
|token field to add multiple values; values are separated with the <code>enter</code>-key
|-
|Date
|date
|same as ''Date picker''
|-
|Title input
|title
|selects page titles in the wiki
|-
|User input
|user_picker
|username that exists in the wiki
|-
|Group input
|group_picker
|group name that exists in the wiki
|-
|Group multiselect
|group_multiselect
|multiple group names
|-
|User multiselect
|user_multiselect
|multiple user names
|-
|Title multiseslect
|title_multiselect
|multiple page titles
|-
|Date picker
|date_picker
|calendar widget
|-
|Percent
|percent
|integer value
|}

=== Other ===
{| class="wikitable compact" style="width: 100%;"
!Element
!Type
!Description
|-
|Static Wikitext
|static_wikitext
|non-editable text
|-
|Button
|button
|triggers an action (requires a defined event listener)
|-
|Message banner
|message
|message that can be shown anywhere in the form;
the type that is set (notice, error, warning, success) provides the visual formatting
|-
|Partial form import
|form_input
|adds form fields from another form
|-
|Icon
|icon
| -
|-
|Indicator
|indicator
| -
|-
|Label
|label
| -
|-
|[[Manual:Extension/Forms/Progress bar|Progress bar]]
|progress_bar
|visual representation of the number of completed steps in a form such as a checklist
|-
|Section label
|section_label
|a heading to a form section
|-
|HR
|hr
|a visual separator line
|}

=== Input field options ===
Each input field has a combination of any of these options:
{| class="wikitable compact" style="width: 100%;"
|+main
!Type
!Field
!Functionality
|-
| rowspan="6" |(all)
|Name
|field name stored in the database (avoid special characters)
|-
|Label
|text label shown to users
|-
|Help
|creates a tooltip pop-up next to the label
|-
|No layout
|hides the label
|-
|Show on
|mode in which this field is visible
|-
|Editable on
|sets when the field value can be edited
|-
|Book
|Return property
|?
|}
{| class="wikitable compact"
|+styling
!Type
!Field
!Functionality
|-
| rowspan="2" |(all)
|CSS Classes
|add individual CSS-classes for use on ''MediaWiki:Common.css''
- the class is set on the form field itself and does not include the label; multiple classes can be set together or you can add them separately
|-
|Style
|define an inline style that affects only this field. The style is applied to the wrapper and includes the label and the field
|-
| rowspan="2" |Textarea, Wikitext input
|Number of rows
|used for textareas
|-
|Placeholder
|text that is displayed before the user is typing a value (has no effect, if there is also a default value set)
|-
|Radio group
|No default value
|ensures that there is no pre-selected radio-button if a default would not make sense
|-
|Radio group, Checkbox multiselect
|Horizontal layout
|aligns multiselect checkboxes or radio groups horizontally
|-
| rowspan="3" |Button
|Icon
|displays an icon before the text, (e.g. a bootstrap-icon like <code>bi bi-calendar</code>)
|-
|Indicator
|displays an icon after the text (e.g. a bootstrap-icon like <code>bi bi-arrow-right</code>)
|-
|Framed
|when deactivated, the button looks like text only (and can be styled via CSS classes, e.g. <code>btn button-warning</code>)
|}
{| class="wikitable compact"
|+other
!Type
!Fieldset
!Field
!Functionality
|-
| rowspan="6" |(all)
| rowspan="2" |Custom widget properties
|Key
|
|-
|Value
|
|-
| rowspan="2" |Listeners
|Event
|event that is supported by [https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.html OO.ui widgets], such as ''change, enter, focus, blur''
|-
|Callback
|function that is called when the event occurs (can be declared in MediaWiki:Common.js for example
|-
| rowspan="2" |
|Default value /
Selected by default
|value that is used if the user does not provide a value; field type "checkbox" has option "Selected by default" instead
|-
|Required
|form cannot be submitted without this field having a value
|-
|Password
|
|Password strength
|weak: <br>
medium: <br>
strong:
|-
| rowspan="2" |Tag
|
|Input position
|inline:
outline:
|-
|
|Allow arbitrary
|It is possible to add values other than the allowed values (only necessary if allowed values are defined)
|}

== Form Settings ==

=== Appearance ===
{| class="wikitable compact"
!Field
!Functionality
|-
|Title
|display title for the form
|-
|Display title
|shows the form title above each form instance
|-
|Display form name
|displays the name fo the form with label ''Form used'' as first form element
|}

=== Behaviour ===
{| class="wikitable compact"
!Field
!Functionality
|-
|Categories
|adds categories to each form instance; values are separated with the <code>enter</code>-key
|-
|Seal after creation
|form instances cannot be edited after the initial save
|-
|Enable intermediate saving
|form instances show both a <code>Save</code> and a <code>Save & Close</code> button;
the <code>Save</code> button saves the form values and keeps the form in edit-mode.
|}

=== Infrastructure ===
{| class="wikitable compact"
!Field
!Functionality
|-
|Resource loader dependencies
|
|-
|Keep track of revisions
|
|-
|Includable
|extends form
|-
|Abstract
|
|-
|Partial
|
|}

=== Target ===
{| class="wikitable compact"
!Field
!Functionality
|-
|Target type
|
|-
|Predefined page title for pages created using this form
|use the field name to insert the value from a form field;
for example: if you have a field with the name <code>company_name</code>, you can use <code><nowiki>{{company_name}}</nowiki></code> as page name or part of the page name.
|}

=== Listeners ===
{| class="wikitable compact"
!Field
!Functionality
|-
|Event
|each listener reacts to one of these events:

* ''initCompleteForm:'' object is initialized
* ''parseComplete:'' JSON/schema/config fully processed
* ''renderComplete:'' UI fully rendered in DOM
* ''beforeSubmitData:'' Right before submission
|-
|Callback
|calls a function when the event occurs;
see the [[Manual:Extension/Forms/Progress bar|progress bar]] example.
|}{{translation}}
__FORCETOC__

Manual:Extension/Forms

2026-06-01T14:39:31Z

Bhuber:

The '''Forms''' extension allows formatting a wiki page or a user dialog as a form. It is also used in conjunction with the [[Reference:Workflows|Workflows]] extension where it provides input forms for workflow data.

==Introduction==
To create a checklist as a form, for example, the following steps are necessary:

# '''Create the checklist form definition.'''
# '''Create checklist instances directly from the form definition page.'''

As an example, we are creating the first fields for an event where food-related hygiene information has to be tracked.
[[File:checklist-event-screenshot.png|alt=Event checklist example|center|thumb|550x550px|Event checklist example]]

==Create a checklist form==

# '''Create''' the page ''Checklist Event Hygiene.form''.[[File:Extension Forms create form.png|center|thumb|400x400px|alt=Create-page dialog|Creating a new form]]This opens the Form editor.[[File:Extension Forms form editor.png|alt=elements of the form editor dialog|center|thumb|700x700px|Form editor]]
# '''Add''' a form section:
##'''Select''' the ''Section label'' element under ''Form Elements > Other'' (see screenshot annotation 2) and, holding down the left mouse button, drag it into the interactive form editor field below.
## '''Click''' anywhere in the ''Section label'' line. The field inspector opens.
## '''Enter''' the ''Name''. This is saved as a field ID in the database and should therefore not contain any special characters.
## '''Enter''' the ''Title'' for the section label. This is displayed as the visible label for the text field.[[File:Extension Forms add section header.png|alt=Section label element inspector|center|thumb|700x700px|Adding the first section header]]
# '''Create''' the form fields for the Event section. Here we add a text box as an example.
## '''Drag''' the ''Text'' element from ''Form elements > Inputs'' under the section heading.
## '''Click''' anywhere in the ''text field'' line. The field inspector opens.
## '''Enter''' the ''Name''. This is used as the database ID for this field and should therefore not contain any special characters.
## '''Enter''' the ''Label''. This is displayed as the visible label for the text field.
## '''Add''' more form elements.
# '''Click''' ''Save''. The form is now available in the main namespace as ''EventChecklistHygiene.form''. [[File:Manual:Checklist-view.png|alt=Saved form|center|thumb|650x650px|Saved form]]<br />
To continue editing the form, switch to page edit mode (1).

== Add more form elements ==
Now you can add more fields: [[Manual:Extension/Forms/Form elements and settings|View all form elements that you can add to your forms.]]

==Create a checklist instance==
To create a checklist from the form:

# '''Enter''' an event name
# '''Fill out''' the form fields.
# '''Click''' ''Submit''.The checklist is now saved in the wiki and can be edited further.
==Alternative Target: E-mail==
Instead of creating a wiki page when the form is saved, you can send the form content to an E-Mail account. ('''Note:''' The E-Mail recipient has to be configured on the server by a server admin to be available to forms):
[[File:Manual:image.png|alt=Email target|center|thumb|650x650px|Email target]]

*'''Target type:''' Email
*'''Recipient:''' Possible recipients must have been configured on the server for security reasons. Example:
<syntaxhighlight lang="text">
$wgFormsTargetEMailRecipients = [

'Marketing' => "marketing@example.com",

'Administration' => 'WikiSysop'

];
</syntaxhighlight>

* '''Subject:''' Existing form fields can be used as variables here. The value is taken from the form.

* '''Content:''' As in the subject, existing form fields can also be used as variables here. The value is taken from the form.

[[mediawikiwiki:Help:Magic_words#Localisation|Localization messages]] in combination with form fields can also be used as subject or email body:<syntaxhighlight lang="text">
{{int:Mailsubject| {{{name}}}|{{{surname}}} }}
</syntaxhighlight>

==Alternative Target: Template==
Instead of creating a standard wiki page or sending the form content via E-Mail, a [[Manual:Templates|Template]] can be used as the target for a form. In this case, the submitted form data is used to create a new wiki page based on an existing template structure, and form values are inserted into the template placeholders.
*'''Prerequisites''': Before a Template target can be used, a corresponding template page must already exist in the wiki. The template serves as the structural basis for the generated page. Form fields are mapped to placeholders defined in the template.
[[File:Manual:Template Target.jpg|alt=selecting Template as target for forms|center|thumb|550x550px|Template Target]]
*'''Target type''': Template
*'''Template''': Name of the existing template used for page generation
*'''Predefined title''': optional default title for the newly created page or to predefine a page path (e.g., to create all generated pages as subpages under a specific parent page) <br>
<br>It is recommended to use identical or clearly related naming for the form and the template to improve maintainability and make configuration dependencies easier to identify. This is typically used to generate standardized, human-readable wiki pages, while JSON-based targets are more commonly used when the output is intended for structured data processing.

==Adjust the styling==

===Common.css===
To style individual elements in the form, go to the styling tab in the options dialog. There, you can enter a css class name. The styling is then defined on the ''MediaWiki:Common.css'' page (admin rights are required).

To style the section heading:

#'''Open''' the styling tab in the options menu of the Event heading field.
#'''Add''' a new CSS class and enter a selector name (''CSS Classes'' field), e.g. ''frm-sectionhd''.[[File:Manual:forms-css-class-en.png|alt=Add a css class|center|thumb|650x650px|Add a css class]]
#'''Paste''' the following style declarations into the ''MediaWiki:Common.css'' page, e.g.:<syntaxhighlight lang="css">
.frm-sectionhd {
border-bottom: 1px solid #a6a6a7;
background:#f1f3f9;
padding:6px;
margin:30px 0;
}
</syntaxhighlight>[[File:Manual:forms-css-class-view-en.png|alt=Section label with customized styling|center|thumb|650x650px|Section label with customized styling]]

If you do not have permission to view this page, you can enter style information directly for each element in the form via inline styling.

===Inline styling===
Without access to ''MediaWiki:Common.css'', the style information can be entered directly in the form. However, with many recurring style declarations this is not efficient in contrast to the definition of CSS classes in ''MediaWiki:Common.css''.

As an example, let's apply the previous section heading example directly as inline styling. To do this, open the options menu of the ''ech-event'' form element again. Enter the following statement in the ''Styling'' field and save the change:<syntaxhighlight lang="css">
border-bottom: 1px solid #a6a6a7; background:#f1f3f9; padding:6px;margin:30px 0;
</syntaxhighlight>
[[File:Manual:forms-css-inlinestyling-en.png|alt=Inline styling of a form element|center|thumb|650x650px|Inline styling of a form element]]
{{translation}}

File:Manual:Template Target.jpg

2026-06-01T14:38:49Z

Bhuber:

Template Target

Manual:Extension/Forms

2026-06-01T12:48:17Z

Bhuber:

The '''Forms''' extension allows formatting a wiki page or a user dialog as a form. It is also used in conjunction with the [[Reference:Workflows|Workflows]] extension where it provides input forms for workflow data.

==Introduction==
To create a checklist as a form, for example, the following steps are necessary:

# '''Create the checklist form definition.'''
# '''Create checklist instances directly from the form definition page.'''

As an example, we are creating the first fields for an event where food-related hygiene information has to be tracked.
[[File:checklist-event-screenshot.png|alt=Event checklist example|center|thumb|550x550px|Event checklist example]]

==Create a checklist form==

# '''Create''' the page ''Checklist Event Hygiene.form''.[[File:Extension Forms create form.png|center|thumb|400x400px|alt=Create-page dialog|Creating a new form]]This opens the Form editor.[[File:Extension Forms form editor.png|alt=elements of the form editor dialog|center|thumb|700x700px|Form editor]]
# '''Add''' a form section:
##'''Select''' the ''Section label'' element under ''Form Elements > Other'' (see screenshot annotation 2) and, holding down the left mouse button, drag it into the interactive form editor field below.
## '''Click''' anywhere in the ''Section label'' line. The field inspector opens.
## '''Enter''' the ''Name''. This is saved as a field ID in the database and should therefore not contain any special characters.
## '''Enter''' the ''Title'' for the section label. This is displayed as the visible label for the text field.[[File:Extension Forms add section header.png|alt=Section label element inspector|center|thumb|700x700px|Adding the first section header]]
# '''Create''' the form fields for the Event section. Here we add a text box as an example.
## '''Drag''' the ''Text'' element from ''Form elements > Inputs'' under the section heading.
## '''Click''' anywhere in the ''text field'' line. The field inspector opens.
## '''Enter''' the ''Name''. This is used as the database ID for this field and should therefore not contain any special characters.
## '''Enter''' the ''Label''. This is displayed as the visible label for the text field.
## '''Add''' more form elements.
# '''Click''' ''Save''. The form is now available in the main namespace as ''EventChecklistHygiene.form''. [[File:Manual:Checklist-view.png|alt=Saved form|center|thumb|650x650px|Saved form]]<br />
To continue editing the form, switch to page edit mode (1).

== Add more form elements ==
Now you can add more fields: [[Manual:Extension/Forms/Form elements and settings|View all form elements that you can add to your forms.]]

==Create a checklist instance==
To create a checklist from the form:

# '''Enter''' an event name
# '''Fill out''' the form fields.
# '''Click''' ''Submit''.The checklist is now saved in the wiki and can be edited further.
==Alternative Target: E-mail==
Instead of creating a wiki page when the form is saved, you can send the form content to an E-Mail account. ('''Note:''' The E-Mail recipient has to be configured on the server by a server admin to be available to forms):
[[File:Manual:image.png|alt=Email target|center|thumb|650x650px|Email target]]

*'''Target type:''' Email
*'''Recipient:''' Possible recipients must have been configured on the server for security reasons. Example:
<syntaxhighlight lang="text">
$wgFormsTargetEMailRecipients = [

'Marketing' => "marketing@example.com",

'Administration' => 'WikiSysop'

];
</syntaxhighlight>

* '''Subject:''' Existing form fields can be used as variables here. The value is taken from the form.

* '''Content:''' As in the subject, existing form fields can also be used as variables here. The value is taken from the form.

[[mediawikiwiki:Help:Magic_words#Localisation|Localization messages]] in combination with form fields can also be used as subject or email body:<syntaxhighlight lang="text">
{{int:Mailsubject| {{{name}}}|{{{surname}}} }}
</syntaxhighlight>

==Alternative Target: Template==
Instead of creating a standard wiki page or sending the form content via E-Mail, a [[Manual:Templates|Template]] can be used as the target for a form. In this case, the submitted form data is used to create a new wiki page based on an existing template structure, and form values are inserted into the template placeholders.
*'''Prerequisites''': Before a Template target can be used, a corresponding template page must already exist in the wiki. The template serves as the structural basis for the generated page. Form fields are mapped to placeholders defined in the template.

*'''Target type''': Template
*'''Template''': Name of the existing template used for page generation
*'''Predefined title''': optional default title for the newly created page or to predefine a page path (e.g., to create all generated pages as subpages under a specific parent page) <br>
<br>
It is recommended to use identical or clearly related naming for the form and the template to improve maintainability and make configuration dependencies easier to identify. This is typically used to generate standardized, human-readable wiki pages, while JSON-based targets are more commonly used when the output is intended for structured data processing.

==Adjust the styling==

===Common.css===
To style individual elements in the form, go to the styling tab in the options dialog. There, you can enter a css class name. The styling is then defined on the ''MediaWiki:Common.css'' page (admin rights are required).

To style the section heading:

#'''Open''' the styling tab in the options menu of the Event heading field.
#'''Add''' a new CSS class and enter a selector name (''CSS Classes'' field), e.g. ''frm-sectionhd''.[[File:Manual:forms-css-class-en.png|alt=Add a css class|center|thumb|650x650px|Add a css class]]
#'''Paste''' the following style declarations into the ''MediaWiki:Common.css'' page, e.g.:<syntaxhighlight lang="css">
.frm-sectionhd {
border-bottom: 1px solid #a6a6a7;
background:#f1f3f9;
padding:6px;
margin:30px 0;
}
</syntaxhighlight>[[File:Manual:forms-css-class-view-en.png|alt=Section label with customized styling|center|thumb|650x650px|Section label with customized styling]]

If you do not have permission to view this page, you can enter style information directly for each element in the form via inline styling.

===Inline styling===
Without access to ''MediaWiki:Common.css'', the style information can be entered directly in the form. However, with many recurring style declarations this is not efficient in contrast to the definition of CSS classes in ''MediaWiki:Common.css''.

As an example, let's apply the previous section heading example directly as inline styling. To do this, open the options menu of the ''ech-event'' form element again. Enter the following statement in the ''Styling'' field and save the change:<syntaxhighlight lang="css">
border-bottom: 1px solid #a6a6a7; background:#f1f3f9; padding:6px;margin:30px 0;
</syntaxhighlight>
[[File:Manual:forms-css-inlinestyling-en.png|alt=Inline styling of a form element|center|thumb|650x650px|Inline styling of a form element]]
{{translation}}

Manual:Extension/Forms

2026-06-01T12:44:45Z

Bhuber:

The '''Forms''' extension allows formatting a wiki page or a user dialog as a form. It is also used in conjunction with the [[Reference:Workflows|Workflows]] extension where it provides input forms for workflow data.

==Introduction==
To create a checklist as a form, for example, the following steps are necessary:

# '''Create the checklist form definition.'''
# '''Create checklist instances directly from the form definition page.'''

As an example, we are creating the first fields for an event where food-related hygiene information has to be tracked.
[[File:checklist-event-screenshot.png|alt=Event checklist example|center|thumb|550x550px|Event checklist example]]

==Create a checklist form==

# '''Create''' the page ''Checklist Event Hygiene.form''.[[File:Extension Forms create form.png|center|thumb|400x400px|alt=Create-page dialog|Creating a new form]]This opens the Form editor.[[File:Extension Forms form editor.png|alt=elements of the form editor dialog|center|thumb|700x700px|Form editor]]
# '''Add''' a form section:
##'''Select''' the ''Section label'' element under ''Form Elements > Other'' (see screenshot annotation 2) and, holding down the left mouse button, drag it into the interactive form editor field below.
## '''Click''' anywhere in the ''Section label'' line. The field inspector opens.
## '''Enter''' the ''Name''. This is saved as a field ID in the database and should therefore not contain any special characters.
## '''Enter''' the ''Title'' for the section label. This is displayed as the visible label for the text field.[[File:Extension Forms add section header.png|alt=Section label element inspector|center|thumb|700x700px|Adding the first section header]]
# '''Create''' the form fields for the Event section. Here we add a text box as an example.
## '''Drag''' the ''Text'' element from ''Form elements > Inputs'' under the section heading.
## '''Click''' anywhere in the ''text field'' line. The field inspector opens.
## '''Enter''' the ''Name''. This is used as the database ID for this field and should therefore not contain any special characters.
## '''Enter''' the ''Label''. This is displayed as the visible label for the text field.
## '''Add''' more form elements.
# '''Click''' ''Save''. The form is now available in the main namespace as ''EventChecklistHygiene.form''. [[File:Manual:Checklist-view.png|alt=Saved form|center|thumb|650x650px|Saved form]]<br />
To continue editing the form, switch to page edit mode (1).

== Add more form elements ==
Now you can add more fields: [[Manual:Extension/Forms/Form elements and settings|View all form elements that you can add to your forms.]]

==Create a checklist instance==
To create a checklist from the form:

# '''Enter''' an event name
# '''Fill out''' the form fields.
# '''Click''' ''Submit''.The checklist is now saved in the wiki and can be edited further.
==Alternative Target: E-mail==
Instead of creating a wiki page when the form is saved, you can send the form content to an E-Mail account. ('''Note:''' The E-Mail recipient has to be configured on the server by a server admin to be available to forms):
[[File:Manual:image.png|alt=Email target|center|thumb|650x650px|Email target]]

*'''Target type:''' Email
*'''Recipient:''' Possible recipients must have been configured on the server for security reasons. Example:
<syntaxhighlight lang="text">
$wgFormsTargetEMailRecipients = [

'Marketing' => "marketing@example.com",

'Administration' => 'WikiSysop'

];
</syntaxhighlight>

* '''Subject:''' Existing form fields can be used as variables here. The value is taken from the form.

* '''Content:''' As in the subject, existing form fields can also be used as variables here. The value is taken from the form.

[[mediawikiwiki:Help:Magic_words#Localisation|Localization messages]] in combination with form fields can also be used as subject or email body:<syntaxhighlight lang="text">
{{int:Mailsubject| {{{name}}}|{{{surname}}} }}
</syntaxhighlight>

==Alternative Target: Template==
Instead of creating a standard wiki page or sending the form content via E-Mail, a Template can be used as the target for a form. In this case, the submitted form data is used to create a new wiki page based on an existing template structure, and form values are inserted into the template placeholders.
*'''Prerequisites''': Before a Template target can be used, a corresponding template page must already exist in the wiki. The template serves as the structural basis for the generated page. Form fields are mapped to placeholders defined in the template.

*'''Target type''': Template
*'''Template''': Name of the existing template used for page generation
*'''Predefined title''': optional default title for the newly created page or to predefine a page path (e.g., to create all generated pages as subpages under a specific parent page) <br>
<br>
It is recommended to use identical or clearly related naming for the form and the template to improve maintainability and make configuration dependencies easier to identify. This is typically used to generate standardized, human-readable wiki pages, while JSON-based targets are more commonly used when the output is intended for structured data processing.

==Adjust the styling==

===Common.css===
To style individual elements in the form, go to the styling tab in the options dialog. There, you can enter a css class name. The styling is then defined on the ''MediaWiki:Common.css'' page (admin rights are required).

To style the section heading:

#'''Open''' the styling tab in the options menu of the Event heading field.
#'''Add''' a new CSS class and enter a selector name (''CSS Classes'' field), e.g. ''frm-sectionhd''.[[File:Manual:forms-css-class-en.png|alt=Add a css class|center|thumb|650x650px|Add a css class]]
#'''Paste''' the following style declarations into the ''MediaWiki:Common.css'' page, e.g.:<syntaxhighlight lang="css">
.frm-sectionhd {
border-bottom: 1px solid #a6a6a7;
background:#f1f3f9;
padding:6px;
margin:30px 0;
}
</syntaxhighlight>[[File:Manual:forms-css-class-view-en.png|alt=Section label with customized styling|center|thumb|650x650px|Section label with customized styling]]

If you do not have permission to view this page, you can enter style information directly for each element in the form via inline styling.

===Inline styling===
Without access to ''MediaWiki:Common.css'', the style information can be entered directly in the form. However, with many recurring style declarations this is not efficient in contrast to the definition of CSS classes in ''MediaWiki:Common.css''.

As an example, let's apply the previous section heading example directly as inline styling. To do this, open the options menu of the ''ech-event'' form element again. Enter the following statement in the ''Styling'' field and save the change:<syntaxhighlight lang="css">
border-bottom: 1px solid #a6a6a7; background:#f1f3f9; padding:6px;margin:30px 0;
</syntaxhighlight>
[[File:Manual:forms-css-inlinestyling-en.png|alt=Inline styling of a form element|center|thumb|650x650px|Inline styling of a form element]]
{{translation}}

Manual:Extension/Forms

2026-06-01T12:23:37Z

Bhuber:

The '''Forms''' extension allows formatting a wiki page or a user dialog as a form. It is also used in conjunction with the [[Reference:Workflows|Workflows]] extension where it provides input forms for workflow data.

==Introduction==
To create a checklist as a form, for example, the following steps are necessary:

# '''Create the checklist form definition.'''
# '''Create checklist instances directly from the form definition page.'''

As an example, we are creating the first fields for an event where food-related hygiene information has to be tracked.
[[File:checklist-event-screenshot.png|alt=Event checklist example|center|thumb|550x550px|Event checklist example]]

==Create a checklist form==

# '''Create''' the page ''Checklist Event Hygiene.form''.[[File:Extension Forms create form.png|center|thumb|400x400px|alt=Create-page dialog|Creating a new form]]This opens the Form editor.[[File:Extension Forms form editor.png|alt=elements of the form editor dialog|center|thumb|700x700px|Form editor]]
# '''Add''' a form section:
##'''Select''' the ''Section label'' element under ''Form Elements > Other'' (see screenshot annotation 2) and, holding down the left mouse button, drag it into the interactive form editor field below.
## '''Click''' anywhere in the ''Section label'' line. The field inspector opens.
## '''Enter''' the ''Name''. This is saved as a field ID in the database and should therefore not contain any special characters.
## '''Enter''' the ''Title'' for the section label. This is displayed as the visible label for the text field.[[File:Extension Forms add section header.png|alt=Section label element inspector|center|thumb|700x700px|Adding the first section header]]
# '''Create''' the form fields for the Event section. Here we add a text box as an example.
## '''Drag''' the ''Text'' element from ''Form elements > Inputs'' under the section heading.
## '''Click''' anywhere in the ''text field'' line. The field inspector opens.
## '''Enter''' the ''Name''. This is used as the database ID for this field and should therefore not contain any special characters.
## '''Enter''' the ''Label''. This is displayed as the visible label for the text field.
## '''Add''' more form elements.
# '''Click''' ''Save''. The form is now available in the main namespace as ''EventChecklistHygiene.form''. [[File:Manual:Checklist-view.png|alt=Saved form|center|thumb|650x650px|Saved form]]<br />
To continue editing the form, switch to page edit mode (1).

== Add more form elements ==
Now you can add more fields: [[Manual:Extension/Forms/Form elements and settings|View all form elements that you can add to your forms.]]

==Create a checklist instance==
To create a checklist from the form:

# '''Enter''' an event name
# '''Fill out''' the form fields.
# '''Click''' ''Submit''.The checklist is now saved in the wiki and can be edited further.
==Alternative Target: E-mail==
Instead of creating a wiki page when the form is saved, you can send the form content to an E-Mail account. ('''Note:''' The E-Mail recipient has to be configured on the server by a server admin to be available to forms):
[[File:Manual:image.png|alt=Email target|center|thumb|650x650px|Email target]]

*'''Target type:''' Email
*'''Recipient:''' Possible recipients must have been configured on the server for security reasons. Example:
<syntaxhighlight lang="text">
$wgFormsTargetEMailRecipients = [

'Marketing' => "marketing@example.com",

'Administration' => 'WikiSysop'

];
</syntaxhighlight>

* '''Subject:''' Existing form fields can be used as variables here. The value is taken from the form.

* '''Content:''' As in the subject, existing form fields can also be used as variables here. The value is taken from the form.

[[mediawikiwiki:Help:Magic_words#Localisation|Localization messages]] in combination with form fields can also be used as subject or email body:<syntaxhighlight lang="text">
{{int:Mailsubject| {{{name}}}|{{{surname}}} }}
</syntaxhighlight>

==Alternative Target: Template==
Instead of creating a standard wiki page or sending the form content via E-Mail, a Template can be used as the target for a form. In this case, the submitted form data is used to create a new wiki page based on an existing template structure. The template defines the layout and placeholders for the resulting page.
*'''Prerequisites''': Before a Template target can be used, a corresponding template page must already exist in the wiki. The template serves as the structural basis for the generated page. Form fields are mapped to placeholders defined in the template.

*'''Target type''': Template
*'''Template''': Name of the existing template used for page generation
*'''Predefined title''': optional default title for the newly created page or to predefine a page path (e.g., to create all generated pages as subpages under a specific parent page)

==Adjust the styling==

===Common.css===
To style individual elements in the form, go to the styling tab in the options dialog. There, you can enter a css class name. The styling is then defined on the ''MediaWiki:Common.css'' page (admin rights are required).

To style the section heading:

#'''Open''' the styling tab in the options menu of the Event heading field.
#'''Add''' a new CSS class and enter a selector name (''CSS Classes'' field), e.g. ''frm-sectionhd''.[[File:Manual:forms-css-class-en.png|alt=Add a css class|center|thumb|650x650px|Add a css class]]
#'''Paste''' the following style declarations into the ''MediaWiki:Common.css'' page, e.g.:<syntaxhighlight lang="css">
.frm-sectionhd {
border-bottom: 1px solid #a6a6a7;
background:#f1f3f9;
padding:6px;
margin:30px 0;
}
</syntaxhighlight>[[File:Manual:forms-css-class-view-en.png|alt=Section label with customized styling|center|thumb|650x650px|Section label with customized styling]]

If you do not have permission to view this page, you can enter style information directly for each element in the form via inline styling.

===Inline styling===
Without access to ''MediaWiki:Common.css'', the style information can be entered directly in the form. However, with many recurring style declarations this is not efficient in contrast to the definition of CSS classes in ''MediaWiki:Common.css''.

As an example, let's apply the previous section heading example directly as inline styling. To do this, open the options menu of the ''ech-event'' form element again. Enter the following statement in the ''Styling'' field and save the change:<syntaxhighlight lang="css">
border-bottom: 1px solid #a6a6a7; background:#f1f3f9; padding:6px;margin:30px 0;
</syntaxhighlight>
[[File:Manual:forms-css-inlinestyling-en.png|alt=Inline styling of a form element|center|thumb|650x650px|Inline styling of a form element]]
{{translation}}

Manual:Extension/Forms/Progress bar

2026-06-01T09:39:30Z

Bhuber:

The progress bar shows a calculated progress value based on selected options in a form. In this example, it is applied to a checklist, but it can also be used for other use cases.

== Adding a progress bar ==
This example shows one possible implementation of a progress bar for a checklist.
[[File:Extension Forms Progress bar example.png|alt=checklist with two sets of checkbox groups for onboarding tasks|center|thumb|550x550px|Example of a progress bar for checklist items]]
To recreate this form, the following components are required:

# '''Provide the JavaScript logic''' in ''MediaWiki:Common.js''
# '''Define''' matching checkbox field and option '''syntax'''
# '''Add an event listener''' in the form properties

=== Provide the logic in ''MediaWiki:Common.js'' ===
Add the following JavaScript function to [https://en.wiki.bluespice.com/wiki/Manual:The_concept_of_namespaces#Namespace_.22MediaWiki.22 ''MediaWiki:Common.js'']:<syntaxhighlight lang="javascript" line="1">
/*Extension:Forms - Add a progress bar for checkbox items */
function CalcProgress( data ) {
var dfd = $.Deferred();
var checked = 0;
var ItemCheckboxes = this.$element.find( 'input[value^=check]' );
var total = ItemCheckboxes.length;
if ( total < 1 ) {
dfd.resolve( data );
return dfd.promise();
}

var items = this.getItems();
for( var name in data ) {
if ( !name.startsWith( 'checkbox_multi-' ) ) {
continue;
}
var checkedCheckboxes = data[name];
for ( var i = 0; i < checkedCheckboxes.length; i++ ) {
checked++;
}
}
data.progress = ( 100 * checked ) / total;
dfd.resolve( data );

return dfd.promise();
}

</syntaxhighlight>On line 5, you define the prefix for each checkbox that should be included in the progress count:<syntaxhighlight lang="javascript">
input[value^=check]
</syntaxhighlight>This means that the ''data'' value for your checkboxes needs to start with ''check'' and refers to the ''data'' value defined in each checkbox option:
[[File:Manual:checkbox data value check.jpg|thumb|center|Data definition in form, here starting with "check-"]]

On line 14, you define the included fields to only those that have the prefix of ''checkbox_multi''in their name.<syntaxhighlight lang="javascript">
if ( !name.startsWith( 'checkbox_multi-' ) ) {
</syntaxhighlight>

Based on this implementation example, a checkbox option is included in the progress calculation only if the ''field'' name starts with ''checkbox_multi-'' and the option's ''data'' value starts with ''check''.

If you use different prefixes for your field names or option values, you need to update the JavaScript code accordingly.

=== Apply the syntax to the checklist items ===
Here is a <code>checkbox_multiselect</code> field that has the correct name-prefix and the correct data-prefix. This field is therefore included in the count and all three options of the field count towards the progress:<syntaxhighlight lang="javascript">
{
"name": "checkbox_multi-workplace_setup",
"label": "Workplace setup",
...
"options": [
{
"data": "check-equipment",
"label": "Provide equipment (laptop, phone)"
},
{
"data": "check-access",
"label": "Grant access to required systems"
},
{
"data": "check-intro",
"label": "Meet the team"
}
],
"type": "checkbox_multiselect"
}

</syntaxhighlight>

=== Create an event listener in the form properties ===
To connect your form to the JavaScript function, you need to create the [https://en.wiki.bluespice.com/wiki/Manual:Extension/Forms/Form_elements_and_settings#Listeners listener] in the form properties:
[[File:Extension Forms Progress bar listener.png|center|thumb|650x650px|Adding the listener to the form properties]]
To add the listener:

# '''Open''' the form properties.
# '''Click''' on ''Listeners''.
# '''Select''' the event <code>beforeSubmitData</code> and enter the name of your JavaScript function. In our example, it is <code>CalcProgress</code>.
<br>
<br>
The <code>beforeSubmitData</code> event is triggered when the form is saved. As a result, changes to checkbox selections are not reflected immediately while editing. The progress bar is updated only after the form has been saved.<br>

=== Complete implementation example ===
This example relies on the JavaScript logic above (especially the required naming conventions). It also defines a page naming pattern in the JSON configuration below. Each checklist is saved as a separate wiki page under the ''ExampleChecklist/'' prefix, using the checklist name as part of the page title.

To use this example, save a new form (e.g. ''ExampleChecklist.form'') and copy the following configuration into the definition source:<syntaxhighlight lang="json">
{
"title": "Example Progress Bar",
"showTitle": true,
"showFormName": false,
"buttonsFloat": false,
"categories": [],
"sealAfterCreation": false,
"enableProgressSave": false,
"enableEditSummary": false,
"rlDependencies": [],
"useFormRevs": false,
"includable": false,
"extends": "",
"abstract": false,
"partial": false,
"target": {
"type": "json-on-wikipage",
"predefined_title": "ExampleChecklist/{{checklistname}}"
},
"show_target_afterAction": false,
"listeners": {
"beforeSubmitData": "jscb:CalcProgress"
},
"lang": "json",
"items": [
{
"name": "checklistname",
"label": "Checklist name",
"help": "",
"noLayout": false,
"showOn": [
"create"
],
"editableOn": [
"create"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"type": "text"
},
{
"name": "progress",
"label": "Progress",
"help": "",
"noLayout": true,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "margin:1em auto!important; max-width:100%",
"widgetCustomProps": {
"widget_progress": "0"
},
"widget_listeners": [],
"type": "progress_bar"
},
{
"name": "checkbox_multi-getting_started",
"label": "Getting started",
"help": "",
"noLayout": false,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"horizontal": false,
"options": [
{
"data": "check-profile",
"label": "Provide personal and role information"
},
{
"data": "check-documents",
"label": "Submit required documents"
},
{
"data": "check-intro",
"label": "Review introduction materials"
}
],
"type": "checkbox_multiselect"
},
{
"name": "checkbox_multi-workplace_setup",
"label": "Workplace setup",
"help": "",
"noLayout": false,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"horizontal": false,
"options": [
{
"data": "check-equipment",
"label": "Provide equipment (laptop, phone)"
},
{
"data": "check-access",
"label": "Grant access to required systems"
},
{
"data": "check-intro",
"label": "Meet the team"
}
],
"type": "checkbox_multiselect"
}
]
}

</syntaxhighlight>

Manual:Extension/Forms/Progress bar

2026-06-01T09:33:50Z

Bhuber:

The progress bar shows a calculated progress value based on selected options in a form. In this example, it is applied to a checklist, but it can also be used for other use cases.

== Adding a progress bar ==
This example shows one possible implementation of a progress bar for a checklist.
[[File:Extension Forms Progress bar example.png|alt=checklist with two sets of checkbox groups for onboarding tasks|center|thumb|550x550px|Example of a progress bar for checklist items]]
To recreate this form, the following components are required:

# '''Provide the JavaScript logic''' in ''MediaWiki:Common.js''
# '''Define''' matching checkbox field and option '''syntax'''
# '''Add an event listener''' in the form properties

=== Provide the logic in ''MediaWiki:Common.js'' ===
Add the following JavaScript function to [https://en.wiki.bluespice.com/wiki/Manual:The_concept_of_namespaces#Namespace_.22MediaWiki.22 ''MediaWiki:Common.js'']:<syntaxhighlight lang="javascript" line="1">
/*Extension:Forms - Add a progress bar for checkbox items */
function CalcProgress( data ) {
var dfd = $.Deferred();
var checked = 0;
var ItemCheckboxes = this.$element.find( 'input[value^=check]' );
var total = ItemCheckboxes.length;
if ( total < 1 ) {
dfd.resolve( data );
return dfd.promise();
}

var items = this.getItems();
for( var name in data ) {
if ( !name.startsWith( 'checkbox_multi-' ) ) {
continue;
}
var checkedCheckboxes = data[name];
for ( var i = 0; i < checkedCheckboxes.length; i++ ) {
checked++;
}
}
data.progress = ( 100 * checked ) / total;
dfd.resolve( data );

return dfd.promise();
}

</syntaxhighlight>On line 5, you define the prefix for each checkbox that should be included in the progress count:<syntaxhighlight lang="javascript">
input[value^=check]
</syntaxhighlight>This means that the ''data'' value for your checkboxes needs to start with ''check'' and refers to the ''data'' value defined in each checkbox option:
[[File:Manual:checkbox data value check.jpg|thumb|center|Data definition in form, here starting with "check-"]]

On line 14, you define the included fields to only those that have the prefix of ''checkbox_multi''in their name.<syntaxhighlight lang="javascript">
if ( !name.startsWith( 'checkbox_multi-' ) ) {
</syntaxhighlight>

Based on this implementation example, a checkbox option is included in the progress calculation only if the ''field'' name starts with ''checkbox_multi-'' and the option's ''data'' value starts with ''check''.

If you use different prefixes for your field names or option values, you need to update the JavaScript code accordingly.

=== Apply the syntax to the checklist items ===
Here is a <code>checkbox_multiselect</code> field that has the correct name-prefix and the correct data-prefix. This field is therefore included in the count and all three options of the field count towards the progress:<syntaxhighlight lang="javascript">
{
"name": "checkbox_multi-workplace_setup",
"label": "Workplace setup",
...
"options": [
{
"data": "check-equipment",
"label": "Provide equipment (laptop, phone)"
},
{
"data": "check-access",
"label": "Grant access to required systems"
},
{
"data": "check-intro",
"label": "Meet the team"
}
],
"type": "checkbox_multiselect"
}

</syntaxhighlight>

=== Create an event listener in the form properties ===
To connect your form to the JavaScript function, you need to create the [https://en.wiki.bluespice.com/wiki/Manual:Extension/Forms/Form_elements_and_settings#Listeners listener] in the form properties:
[[File:Extension Forms Progress bar listener.png|center|thumb|650x650px|Adding the listener to the form properties]]
To add the listener:

# '''Open''' the form properties.
# '''Click''' on ''Listeners''.
# '''Select''' the event <code>beforeSubmitData</code> and enter the name of your JavaScript function. In our example, it is <code>CalcProgress</code>.
<br>
<br>
The <code>beforeSubmitData</code> event is triggered when the form is saved. As a result, changes to checkbox selections are not reflected immediately while editing. The progress bar is updated only after the form has been saved.<br>

=== Complete implementation example ===
This example relies on the JavaScript logic above (especially the required naming conventions). It also uses a page naming pattern defined in the JSON configuration below. Each checklist is saved as a separate wiki page under the ''ExampleChecklist/'' prefix, using the checklist name as part of the page title.

To use this example, save a new form (e.g. ''ExampleChecklist.form'') and copy the following configuration into the definition source:<syntaxhighlight lang="json">
{
"title": "Example Progress Bar",
"showTitle": true,
"showFormName": false,
"buttonsFloat": false,
"categories": [],
"sealAfterCreation": false,
"enableProgressSave": false,
"enableEditSummary": false,
"rlDependencies": [],
"useFormRevs": false,
"includable": false,
"extends": "",
"abstract": false,
"partial": false,
"target": {
"type": "json-on-wikipage",
"predefined_title": "ExampleChecklist/{{checklistname}}"
},
"show_target_afterAction": false,
"listeners": {
"beforeSubmitData": "jscb:CalcProgress"
},
"lang": "json",
"items": [
{
"name": "checklistname",
"label": "Checklist name",
"help": "",
"noLayout": false,
"showOn": [
"create"
],
"editableOn": [
"create"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"type": "text"
},
{
"name": "progress",
"label": "Progress",
"help": "",
"noLayout": true,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "margin:1em auto!important; max-width:100%",
"widgetCustomProps": {
"widget_progress": "0"
},
"widget_listeners": [],
"type": "progress_bar"
},
{
"name": "checkbox_multi-getting_started",
"label": "Getting started",
"help": "",
"noLayout": false,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"horizontal": false,
"options": [
{
"data": "check-profile",
"label": "Provide personal and role information"
},
{
"data": "check-documents",
"label": "Submit required documents"
},
{
"data": "check-intro",
"label": "Review introduction materials"
}
],
"type": "checkbox_multiselect"
},
{
"name": "checkbox_multi-workplace_setup",
"label": "Workplace setup",
"help": "",
"noLayout": false,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"horizontal": false,
"options": [
{
"data": "check-equipment",
"label": "Provide equipment (laptop, phone)"
},
{
"data": "check-access",
"label": "Grant access to required systems"
},
{
"data": "check-intro",
"label": "Meet the team"
}
],
"type": "checkbox_multiselect"
}
]
}

</syntaxhighlight>

Manual:Extension/Forms/Progress bar

2026-06-01T09:17:37Z

Bhuber:

The progress bar shows a calculated progress value based on selected options in a form. In this example, it is applied to a checklist, but it can also be used for other use cases.

== Adding a progress bar ==
This example shows one possible implementation of a progress bar for a checklist.
[[File:Extension Forms Progress bar example.png|alt=checklist with two sets of checkbox groups for onboarding tasks|center|thumb|550x550px|Example of a progress bar for checklist items]]
To recreate this form, the following components are required:

# '''Provide the JavaScript logic''' in ''MediaWiki:Common.js''
# '''Define''' matching checkbox field and option '''syntax'''
# '''Add an event listener''' in the form properties

=== Provide the logic in ''MediaWiki:Common.js'' ===
Add the following JavaScript function to [https://en.wiki.bluespice.com/wiki/Manual:The_concept_of_namespaces#Namespace_.22MediaWiki.22 ''MediaWiki:Common.js'']:<syntaxhighlight lang="javascript" line="1">
/*Extension:Forms - Add a progress bar for checkbox items */
function CalcProgress( data ) {
var dfd = $.Deferred();
var checked = 0;
var ItemCheckboxes = this.$element.find( 'input[value^=check]' );
var total = ItemCheckboxes.length;
if ( total < 1 ) {
dfd.resolve( data );
return dfd.promise();
}

var items = this.getItems();
for( var name in data ) {
if ( !name.startsWith( 'checkbox_multi-' ) ) {
continue;
}
var checkedCheckboxes = data[name];
for ( var i = 0; i < checkedCheckboxes.length; i++ ) {
checked++;
}
}
data.progress = ( 100 * checked ) / total;
dfd.resolve( data );

return dfd.promise();
}

</syntaxhighlight>On line 5, you define the prefix for each checkbox that should be included in the progress count:<syntaxhighlight lang="javascript">
input[value^=check]
</syntaxhighlight>This means that the ''data'' value for your checkboxes needs to start with ''check'' and refers to the ''data'' value defined in each checkbox option:
[[File:Manual:checkbox data value check.jpg|thumb|center|Data definition in form, here starting with "check-"]]

On line 14, you define the included fields to only those that have the prefix of ''checkbox_multi''in their name.<syntaxhighlight lang="javascript">
if ( !name.startsWith( 'checkbox_multi-' ) ) {
</syntaxhighlight>

Based on this implementation example, a checkbox option is included in the progress calculation only if the ''field'' name starts with ''checkbox_multi-'' and the option's ''data'' value starts with ''check''.

If you use different prefixes for your field names or option values, you need to update the JavaScript code accordingly.

=== Apply the syntax to the checklist items ===
Here is a <code>checkbox_multiselect</code> field that has the correct name-prefix and the correct data-prefix. This field is therefore included in the count and all three options of the field count towards the progress:<syntaxhighlight lang="javascript">
{
"name": "checkbox_multi-workplace_setup",
"label": "Workplace setup",
...
"options": [
{
"data": "check-equipment",
"label": "Provide equipment (laptop, phone)"
},
{
"data": "check-access",
"label": "Grant access to required systems"
},
{
"data": "check-intro",
"label": "Meet the team"
}
],
"type": "checkbox_multiselect"
}

</syntaxhighlight>

=== Create an event listener in the form properties ===
To connect your form to the JavaScript function, you need to create the [https://en.wiki.bluespice.com/wiki/Manual:Extension/Forms/Form_elements_and_settings#Listeners listener] in the form properties:
[[File:Extension Forms Progress bar listener.png|center|thumb|650x650px|Adding the listener to the form properties]]
To add the listener:

# '''Open''' the form properties.
# '''Click''' on ''Listeners''.
# '''Select''' the event <code>beforeSubmitData</code> and enter the name of your JavaScript function. In our example, it is <code>CalcProgress</code>.
<br>
<br>
The <code>beforeSubmitData</code> event is triggered when the form is saved. As a result, changes to checkbox selections are not reflected immediately while editing. The progress bar is updated only after the form has been saved.<br>
<br>
This example relies on the JavaScript logic above (especially the required naming conventions). To test it, save a new form (e.g. ''ExampleChecklist.form'') and copy the following configuration into the definition source:<syntaxhighlight lang="json">
{
"title": "Example Progress Bar",
"showTitle": true,
"showFormName": false,
"buttonsFloat": false,
"categories": [],
"sealAfterCreation": false,
"enableProgressSave": false,
"enableEditSummary": false,
"rlDependencies": [],
"useFormRevs": false,
"includable": false,
"extends": "",
"abstract": false,
"partial": false,
"target": {
"type": "json-on-wikipage",
"predefined_title": "ExampleChecklist/{{checklistname}}"
},
"show_target_afterAction": false,
"listeners": {
"beforeSubmitData": "jscb:CalcProgress"
},
"lang": "json",
"items": [
{
"name": "checklistname",
"label": "Checklist name",
"help": "",
"noLayout": false,
"showOn": [
"create"
],
"editableOn": [
"create"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"type": "text"
},
{
"name": "progress",
"label": "Progress",
"help": "",
"noLayout": true,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "margin:1em auto!important; max-width:100%",
"widgetCustomProps": {
"widget_progress": "0"
},
"widget_listeners": [],
"type": "progress_bar"
},
{
"name": "checkbox_multi-getting_started",
"label": "Getting started",
"help": "",
"noLayout": false,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"horizontal": false,
"options": [
{
"data": "check-profile",
"label": "Provide personal and role information"
},
{
"data": "check-documents",
"label": "Submit required documents"
},
{
"data": "check-intro",
"label": "Review introduction materials"
}
],
"type": "checkbox_multiselect"
},
{
"name": "checkbox_multi-workplace_setup",
"label": "Workplace setup",
"help": "",
"noLayout": false,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"horizontal": false,
"options": [
{
"data": "check-equipment",
"label": "Provide equipment (laptop, phone)"
},
{
"data": "check-access",
"label": "Grant access to required systems"
},
{
"data": "check-intro",
"label": "Meet the team"
}
],
"type": "checkbox_multiselect"
}
]
}

</syntaxhighlight>

Manual:Extension/Forms/Progress bar

2026-06-01T09:11:52Z

Bhuber:

The progress bar shows a calculated progress value based on selected options in a form. In this example, it is applied to a checklist, but it can also be used for other use cases.

== Adding a progress bar ==
This example shows one possible implementation of a progress bar for a checklist.
[[File:Extension Forms Progress bar example.png|alt=checklist with two sets of checkbox groups for onboarding tasks|center|thumb|550x550px|Example of a progress bar for checklist items]]
To recreate this form, the following compontents are required:

# '''Provide the JavaScript logic''' in ''MediaWiki:Common.js''
# '''Define''' matching checkbox field and option '''syntax'''
# '''Create an event listener''' in the form properties

=== Provide the logic in ''MediaWiki:Common.js'' ===
Add the following JavaScript function to [https://en.wiki.bluespice.com/wiki/Manual:The_concept_of_namespaces#Namespace_.22MediaWiki.22 ''MediaWiki:Common.js'']:<syntaxhighlight lang="javascript" line="1">
/*Extension:Forms - Add a progress bar for checkbox items */
function CalcProgress( data ) {
var dfd = $.Deferred();
var checked = 0;
var ItemCheckboxes = this.$element.find( 'input[value^=check]' );
var total = ItemCheckboxes.length;
if ( total < 1 ) {
dfd.resolve( data );
return dfd.promise();
}

var items = this.getItems();
for( var name in data ) {
if ( !name.startsWith( 'checkbox_multi-' ) ) {
continue;
}
var checkedCheckboxes = data[name];
for ( var i = 0; i < checkedCheckboxes.length; i++ ) {
checked++;
}
}
data.progress = ( 100 * checked ) / total;
dfd.resolve( data );

return dfd.promise();
}

</syntaxhighlight>On line 5, you define the prefix for each checkbox that should be included in the progress count:<syntaxhighlight lang="javascript">
input[value^=check]
</syntaxhighlight>This means that the "data" value for your checkboxes needs to start with "check". This corresponds to the "data" value defined in each checkbox option:
[[File:Manual:checkbox data value check.jpg|thumb|center|Data definition in form, here starting with "check-"]]

On line 14, you define the included fields to only those that have the prefix of "checkbox_multi" in their name.<syntaxhighlight lang="javascript">
if ( !name.startsWith( 'checkbox_multi-' ) ) {
</syntaxhighlight>

Based on this implementation example, a checkbox option is included in the progress calculation only if the "field" name starts with "checkbox_multi-" and the option's "data" value starts with "check."

If you use different prefixes for your field names or option values, you need to update the JavaScript code accordingly.

=== Apply the syntax to the checklist items ===
Here is a <code>checkbox_multiselect</code> field that has the correct name-prefix and the correct data-prefix. This field is therefore included in the count and all three options of the field count towards the progress:<syntaxhighlight lang="javascript">
{
"name": "checkbox_multi-workplace_setup",
"label": "Workplace setup",
...
"options": [
{
"data": "check-equipment",
"label": "Provide equipment (laptop, phone)"
},
{
"data": "check-access",
"label": "Grant access to required systems"
},
{
"data": "check-intro",
"label": "Meet the team"
}
],
"type": "checkbox_multiselect"
}

</syntaxhighlight>

=== Create an event listener in the form properties ===
To connect your form to the JavaScript function, you need to create the [https://en.wiki.bluespice.com/wiki/Manual:Extension/Forms/Form_elements_and_settings#Listeners listener] in the form properties:
[[File:Extension Forms Progress bar listener.png|center|thumb|650x650px|Adding the listener to the form properties]]
To add the listener:

# '''Open''' the form properties.
# '''Click''' on ''Listeners''.
# '''Select''' the event <code>beforeSubmitData</code> and enter the name of your JavaScript function. In our example, it is <code>CalcProgress</code>.
<br>
<br>
The <code>beforeSubmitData</code> event is triggered when the form is saved. As a result, changes to checkbox selections are not reflected immediately while editing. The progress bar is updated only after the form has been saved.<br>
<br>
This example relies on the JavaScript logic above (especially the required naming conventions). To test it, save a new form (e.g. ''ExampleChecklist.form'') and copy the following configuration into the definition source:<syntaxhighlight lang="json">
{
"title": "Example Progress Bar",
"showTitle": true,
"showFormName": false,
"buttonsFloat": false,
"categories": [],
"sealAfterCreation": false,
"enableProgressSave": false,
"enableEditSummary": false,
"rlDependencies": [],
"useFormRevs": false,
"includable": false,
"extends": "",
"abstract": false,
"partial": false,
"target": {
"type": "json-on-wikipage",
"predefined_title": "ExampleChecklist/{{checklistname}}"
},
"show_target_afterAction": false,
"listeners": {
"beforeSubmitData": "jscb:CalcProgress"
},
"lang": "json",
"items": [
{
"name": "checklistname",
"label": "Checklist name",
"help": "",
"noLayout": false,
"showOn": [
"create"
],
"editableOn": [
"create"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"type": "text"
},
{
"name": "progress",
"label": "Progress",
"help": "",
"noLayout": true,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "margin:1em auto!important; max-width:100%",
"widgetCustomProps": {
"widget_progress": "0"
},
"widget_listeners": [],
"type": "progress_bar"
},
{
"name": "checkbox_multi-getting_started",
"label": "Getting started",
"help": "",
"noLayout": false,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"horizontal": false,
"options": [
{
"data": "check-profile",
"label": "Provide personal and role information"
},
{
"data": "check-documents",
"label": "Submit required documents"
},
{
"data": "check-intro",
"label": "Review introduction materials"
}
],
"type": "checkbox_multiselect"
},
{
"name": "checkbox_multi-workplace_setup",
"label": "Workplace setup",
"help": "",
"noLayout": false,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"horizontal": false,
"options": [
{
"data": "check-equipment",
"label": "Provide equipment (laptop, phone)"
},
{
"data": "check-access",
"label": "Grant access to required systems"
},
{
"data": "check-intro",
"label": "Meet the team"
}
],
"type": "checkbox_multiselect"
}
]
}

</syntaxhighlight>

Manual:Extension/Forms/Progress bar

2026-06-01T09:10:33Z

Bhuber:

The progress bar shows a calculated progress value based on selected options in a form. In this example, it is applied to a checklist, but it can also be used for other use cases.

== Adding a progress bar ==
This example shows one possible implementation of a progress bar for a checklist.
[[File:Extension Forms Progress bar example.png|alt=checklist with two sets of checkbox groups for onboarding tasks|center|thumb|550x550px|Example of a progress bar for checklist items]]
To recreate this form, the following compontents are required:

# '''Provide the JavaScript logic''' in ''MediaWiki:Common.js''
# '''Define''' matching checkbox field and option '''syntax'''
# '''Create an event listener''' in the form properties

=== Provide the logic in ''MediaWiki:Common.js'' ===
Add the following JavaScript function to [https://en.wiki.bluespice.com/wiki/Manual:The_concept_of_namespaces#Namespace_.22MediaWiki.22 ''MediaWiki:Common.js'']:<syntaxhighlight lang="javascript" line="1">
/*Extension:Forms - Add a progress bar for checkbox items */
function CalcProgress( data ) {
var dfd = $.Deferred();
var checked = 0;
var ItemCheckboxes = this.$element.find( 'input[value^=check]' );
var total = ItemCheckboxes.length;
if ( total < 1 ) {
dfd.resolve( data );
return dfd.promise();
}

var items = this.getItems();
for( var name in data ) {
if ( !name.startsWith( 'checkbox_multi-' ) ) {
continue;
}
var checkedCheckboxes = data[name];
for ( var i = 0; i < checkedCheckboxes.length; i++ ) {
checked++;
}
}
data.progress = ( 100 * checked ) / total;
dfd.resolve( data );

return dfd.promise();
}

</syntaxhighlight>On line 5, you define the prefix for each checkbox that should be included in the progress count:<syntaxhighlight lang="javascript">
input[value^=check]
</syntaxhighlight>This means that the "data" value for your checkboxes needs to start with "check". This corresponds to the "data" value defined in each checkbox option:
[[File:Manual:checkbox data value check.jpg|thumb|center|Data definition in form, here starting with "check-"]]

On line 14, you define the included fields to only those that have the prefix of "checkbox_multi" in their name.<syntaxhighlight lang="javascript">
if ( !name.startsWith( 'checkbox_multi-' ) ) {
</syntaxhighlight>

Based on this implementation example, a checkbox option is included in the progress calculation only if the "field" name starts with "checkbox_multi-" and the option's "data" value starts with "check."

If you use different prefixes for your field names or option values, you need to update the JavaScript code accordingly.

=== Apply the syntax to the checklist items ===
Here is a <code>checkbox_multiselect</code> field that has the correct name-prefix and the correct data-prefix. This field is therefore included in the count and all three options of the field count towards the progress:<syntaxhighlight lang="javascript">
{
"name": "checkbox_multi-workplace_setup",
"label": "Workplace setup",
...
"options": [
{
"data": "check-equipment",
"label": "Provide equipment (laptop, phone)"
},
{
"data": "check-access",
"label": "Grant access to required systems"
},
{
"data": "check-intro",
"label": "Meet the team"
}
],
"type": "checkbox_multiselect"
}

</syntaxhighlight>

=== Create an event listener in the form properties ===
To connect your form to the JavaScript function, you need to create the [https://en.wiki.bluespice.com/wiki/Manual:Extension/Forms/Form_elements_and_settings#Listeners listener] in the form properties:
[[File:Extension Forms Progress bar listener.png|center|thumb|650x650px|Adding the listener to the form properties]]
To add the listener:

# '''Open''' the form properties.
# '''Click''' on ''Listeners''.
# '''Select''' the event <code>beforeSubmitData</code> and enter the name of your JavaScript function. In our example, it is <code>CalcProgress</code>.
<br>
<br>
The <code>beforeSubmitData</code> event is triggered when the form is saved. As a result, changes to checkbox selections are not reflected immediately while editing. The progress bar is updated only after the form has been saved.<br>
<br>
This example relies on the JavaScript logic above (especially the required naming conventions). To test it, save a new form (e.g. ExampleChecklist.form) and copy the following configuration into the definition source:<syntaxhighlight lang="json">
{
"title": "Example Progress Bar",
"showTitle": true,
"showFormName": false,
"buttonsFloat": false,
"categories": [],
"sealAfterCreation": false,
"enableProgressSave": false,
"enableEditSummary": false,
"rlDependencies": [],
"useFormRevs": false,
"includable": false,
"extends": "",
"abstract": false,
"partial": false,
"target": {
"type": "json-on-wikipage",
"predefined_title": "ExampleChecklist/{{checklistname}}"
},
"show_target_afterAction": false,
"listeners": {
"beforeSubmitData": "jscb:CalcProgress"
},
"lang": "json",
"items": [
{
"name": "checklistname",
"label": "Checklist name",
"help": "",
"noLayout": false,
"showOn": [
"create"
],
"editableOn": [
"create"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"type": "text"
},
{
"name": "progress",
"label": "Progress",
"help": "",
"noLayout": true,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "margin:1em auto!important; max-width:100%",
"widgetCustomProps": {
"widget_progress": "0"
},
"widget_listeners": [],
"type": "progress_bar"
},
{
"name": "checkbox_multi-getting_started",
"label": "Getting started",
"help": "",
"noLayout": false,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"horizontal": false,
"options": [
{
"data": "check-profile",
"label": "Provide personal and role information"
},
{
"data": "check-documents",
"label": "Submit required documents"
},
{
"data": "check-intro",
"label": "Review introduction materials"
}
],
"type": "checkbox_multiselect"
},
{
"name": "checkbox_multi-workplace_setup",
"label": "Workplace setup",
"help": "",
"noLayout": false,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"horizontal": false,
"options": [
{
"data": "check-equipment",
"label": "Provide equipment (laptop, phone)"
},
{
"data": "check-access",
"label": "Grant access to required systems"
},
{
"data": "check-intro",
"label": "Meet the team"
}
],
"type": "checkbox_multiselect"
}
]
}

</syntaxhighlight>

Manual:Extension/Forms/Progress bar

2026-06-01T09:09:44Z

Bhuber:

The progress bar shows a calculated progress value based on selected options in a form. In this example, it is applied to a checklist, but it can also be used for other use cases.

== Adding a progress bar ==
This example shows one possible implementation of a progress bar for a checklist.
[[File:Extension Forms Progress bar example.png|alt=checklist with two sets of checkbox groups for onboarding tasks|center|thumb|550x550px|Example of a progress bar for checklist items]]
For this, we need to set up the following components:

# '''Provide the JavaScript logic''' in ''MediaWiki:Common.js''
# '''Define''' matching checkbox field and option '''syntax'''
# '''Create an event listener''' in the form properties

=== Provide the logic in ''MediaWiki:Common.js'' ===
Add the following JavaScript function to [https://en.wiki.bluespice.com/wiki/Manual:The_concept_of_namespaces#Namespace_.22MediaWiki.22 ''MediaWiki:Common.js'']:<syntaxhighlight lang="javascript" line="1">
/*Extension:Forms - Add a progress bar for checkbox items */
function CalcProgress( data ) {
var dfd = $.Deferred();
var checked = 0;
var ItemCheckboxes = this.$element.find( 'input[value^=check]' );
var total = ItemCheckboxes.length;
if ( total < 1 ) {
dfd.resolve( data );
return dfd.promise();
}

var items = this.getItems();
for( var name in data ) {
if ( !name.startsWith( 'checkbox_multi-' ) ) {
continue;
}
var checkedCheckboxes = data[name];
for ( var i = 0; i < checkedCheckboxes.length; i++ ) {
checked++;
}
}
data.progress = ( 100 * checked ) / total;
dfd.resolve( data );

return dfd.promise();
}

</syntaxhighlight>On line 5, you define the prefix for each checkbox that should be included in the progress count:<syntaxhighlight lang="javascript">
input[value^=check]
</syntaxhighlight>This means that the "data" value for your checkboxes needs to start with "check". This corresponds to the "data" value defined in each checkbox option:
[[File:Manual:checkbox data value check.jpg|thumb|center|Data definition in form, here starting with "check-"]]

On line 14, you define the included fields to only those that have the prefix of "checkbox_multi" in their name.<syntaxhighlight lang="javascript">
if ( !name.startsWith( 'checkbox_multi-' ) ) {
</syntaxhighlight>

Based on this implementation example, a checkbox option is included in the progress calculation only if the "field" name starts with "checkbox_multi-" and the option's "data" value starts with "check."

If you use different prefixes for your field names or option values, you need to update the JavaScript code accordingly.

=== Apply the syntax to the checklist items ===
Here is a <code>checkbox_multiselect</code> field that has the correct name-prefix and the correct data-prefix. This field is therefore included in the count and all three options of the field count towards the progress:<syntaxhighlight lang="javascript">
{
"name": "checkbox_multi-workplace_setup",
"label": "Workplace setup",
...
"options": [
{
"data": "check-equipment",
"label": "Provide equipment (laptop, phone)"
},
{
"data": "check-access",
"label": "Grant access to required systems"
},
{
"data": "check-intro",
"label": "Meet the team"
}
],
"type": "checkbox_multiselect"
}

</syntaxhighlight>

=== Create an event listener in the form properties ===
To connect your form to the JavaScript function, you need to create the [https://en.wiki.bluespice.com/wiki/Manual:Extension/Forms/Form_elements_and_settings#Listeners listener] in the form properties:
[[File:Extension Forms Progress bar listener.png|center|thumb|650x650px|Adding the listener to the form properties]]
To add the listener:

# '''Open''' the form properties.
# '''Click''' on ''Listeners''.
# '''Select''' the event <code>beforeSubmitData</code> and enter the name of your JavaScript function. In our example, it is <code>CalcProgress</code>.
<br>
<br>
The <code>beforeSubmitData</code> event is triggered when the form is saved. As a result, changes to checkbox selections are not reflected immediately while editing. The progress bar is updated only after the form has been saved.<br>
<br>
This example relies on the JavaScript logic above (especially the required naming conventions). To test it, save a new form (e.g. ExampleChecklist.form) and copy the following configuration into the definition source:<syntaxhighlight lang="json">
{
"title": "Example Progress Bar",
"showTitle": true,
"showFormName": false,
"buttonsFloat": false,
"categories": [],
"sealAfterCreation": false,
"enableProgressSave": false,
"enableEditSummary": false,
"rlDependencies": [],
"useFormRevs": false,
"includable": false,
"extends": "",
"abstract": false,
"partial": false,
"target": {
"type": "json-on-wikipage",
"predefined_title": "ExampleChecklist/{{checklistname}}"
},
"show_target_afterAction": false,
"listeners": {
"beforeSubmitData": "jscb:CalcProgress"
},
"lang": "json",
"items": [
{
"name": "checklistname",
"label": "Checklist name",
"help": "",
"noLayout": false,
"showOn": [
"create"
],
"editableOn": [
"create"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"type": "text"
},
{
"name": "progress",
"label": "Progress",
"help": "",
"noLayout": true,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "margin:1em auto!important; max-width:100%",
"widgetCustomProps": {
"widget_progress": "0"
},
"widget_listeners": [],
"type": "progress_bar"
},
{
"name": "checkbox_multi-getting_started",
"label": "Getting started",
"help": "",
"noLayout": false,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"horizontal": false,
"options": [
{
"data": "check-profile",
"label": "Provide personal and role information"
},
{
"data": "check-documents",
"label": "Submit required documents"
},
{
"data": "check-intro",
"label": "Review introduction materials"
}
],
"type": "checkbox_multiselect"
},
{
"name": "checkbox_multi-workplace_setup",
"label": "Workplace setup",
"help": "",
"noLayout": false,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"horizontal": false,
"options": [
{
"data": "check-equipment",
"label": "Provide equipment (laptop, phone)"
},
{
"data": "check-access",
"label": "Grant access to required systems"
},
{
"data": "check-intro",
"label": "Meet the team"
}
],
"type": "checkbox_multiselect"
}
]
}

</syntaxhighlight>

Manual:Extension/Forms/Progress bar

2026-06-01T09:09:09Z

Bhuber:

The progress bar shows a calculated progress value based on selected options in a form. In this example, it is applied to a checklist, but it can also be used for other use cases.

== Adding a progress bar ==
We add a progress bar to a checklist to show completion status. This example demonstrates one way to implement it using checkbox selections in a form.
[[File:Extension Forms Progress bar example.png|alt=checklist with two sets of checkbox groups for onboarding tasks|center|thumb|550x550px|Example of a progress bar for checklist items]]
For this, we need to set up the following components:

# '''Provide the JavaScript logic''' in ''MediaWiki:Common.js''
# '''Define''' matching checkbox field and option '''syntax'''
# '''Create an event listener''' in the form properties

=== Provide the logic in ''MediaWiki:Common.js'' ===
Add the following JavaScript function to [https://en.wiki.bluespice.com/wiki/Manual:The_concept_of_namespaces#Namespace_.22MediaWiki.22 ''MediaWiki:Common.js'']:<syntaxhighlight lang="javascript" line="1">
/*Extension:Forms - Add a progress bar for checkbox items */
function CalcProgress( data ) {
var dfd = $.Deferred();
var checked = 0;
var ItemCheckboxes = this.$element.find( 'input[value^=check]' );
var total = ItemCheckboxes.length;
if ( total < 1 ) {
dfd.resolve( data );
return dfd.promise();
}

var items = this.getItems();
for( var name in data ) {
if ( !name.startsWith( 'checkbox_multi-' ) ) {
continue;
}
var checkedCheckboxes = data[name];
for ( var i = 0; i < checkedCheckboxes.length; i++ ) {
checked++;
}
}
data.progress = ( 100 * checked ) / total;
dfd.resolve( data );

return dfd.promise();
}

</syntaxhighlight>On line 5, you define the prefix for each checkbox that should be included in the progress count:<syntaxhighlight lang="javascript">
input[value^=check]
</syntaxhighlight>This means that the "data" value for your checkboxes needs to start with "check". This corresponds to the "data" value defined in each checkbox option:
[[File:Manual:checkbox data value check.jpg|thumb|center|Data definition in form, here starting with "check-"]]

On line 14, you define the included fields to only those that have the prefix of "checkbox_multi" in their name.<syntaxhighlight lang="javascript">
if ( !name.startsWith( 'checkbox_multi-' ) ) {
</syntaxhighlight>

Based on this implementation example, a checkbox option is included in the progress calculation only if the "field" name starts with "checkbox_multi-" and the option's "data" value starts with "check."

If you use different prefixes for your field names or option values, you need to update the JavaScript code accordingly.

=== Apply the syntax to the checklist items ===
Here is a <code>checkbox_multiselect</code> field that has the correct name-prefix and the correct data-prefix. This field is therefore included in the count and all three options of the field count towards the progress:<syntaxhighlight lang="javascript">
{
"name": "checkbox_multi-workplace_setup",
"label": "Workplace setup",
...
"options": [
{
"data": "check-equipment",
"label": "Provide equipment (laptop, phone)"
},
{
"data": "check-access",
"label": "Grant access to required systems"
},
{
"data": "check-intro",
"label": "Meet the team"
}
],
"type": "checkbox_multiselect"
}

</syntaxhighlight>

=== Create an event listener in the form properties ===
To connect your form to the JavaScript function, you need to create the [https://en.wiki.bluespice.com/wiki/Manual:Extension/Forms/Form_elements_and_settings#Listeners listener] in the form properties:
[[File:Extension Forms Progress bar listener.png|center|thumb|650x650px|Adding the listener to the form properties]]
To add the listener:

# '''Open''' the form properties.
# '''Click''' on ''Listeners''.
# '''Select''' the event <code>beforeSubmitData</code> and enter the name of your JavaScript function. In our example, it is <code>CalcProgress</code>.
<br>
<br>
The <code>beforeSubmitData</code> event is triggered when the form is saved. As a result, changes to checkbox selections are not reflected immediately while editing. The progress bar is updated only after the form has been saved.<br>
<br>
This example relies on the JavaScript logic above (especially the required naming conventions). To test it, save a new form (e.g. ExampleChecklist.form) and copy the following configuration into the definition source:<syntaxhighlight lang="json">
{
"title": "Example Progress Bar",
"showTitle": true,
"showFormName": false,
"buttonsFloat": false,
"categories": [],
"sealAfterCreation": false,
"enableProgressSave": false,
"enableEditSummary": false,
"rlDependencies": [],
"useFormRevs": false,
"includable": false,
"extends": "",
"abstract": false,
"partial": false,
"target": {
"type": "json-on-wikipage",
"predefined_title": "ExampleChecklist/{{checklistname}}"
},
"show_target_afterAction": false,
"listeners": {
"beforeSubmitData": "jscb:CalcProgress"
},
"lang": "json",
"items": [
{
"name": "checklistname",
"label": "Checklist name",
"help": "",
"noLayout": false,
"showOn": [
"create"
],
"editableOn": [
"create"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"type": "text"
},
{
"name": "progress",
"label": "Progress",
"help": "",
"noLayout": true,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "margin:1em auto!important; max-width:100%",
"widgetCustomProps": {
"widget_progress": "0"
},
"widget_listeners": [],
"type": "progress_bar"
},
{
"name": "checkbox_multi-getting_started",
"label": "Getting started",
"help": "",
"noLayout": false,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"horizontal": false,
"options": [
{
"data": "check-profile",
"label": "Provide personal and role information"
},
{
"data": "check-documents",
"label": "Submit required documents"
},
{
"data": "check-intro",
"label": "Review introduction materials"
}
],
"type": "checkbox_multiselect"
},
{
"name": "checkbox_multi-workplace_setup",
"label": "Workplace setup",
"help": "",
"noLayout": false,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"horizontal": false,
"options": [
{
"data": "check-equipment",
"label": "Provide equipment (laptop, phone)"
},
{
"data": "check-access",
"label": "Grant access to required systems"
},
{
"data": "check-intro",
"label": "Meet the team"
}
],
"type": "checkbox_multiselect"
}
]
}

</syntaxhighlight>

Manual:Extension/Forms/Progress bar

2026-06-01T08:28:35Z

Bhuber:

The progress bar is useful to count completed checklist items, for example. It calculates completion based on selected options.

== Adding a progress bar ==
We add a progress bar to a checklist that shows how many tasks have been completed.
[[File:Extension Forms Progress bar example.png|alt=checklist with two sets of checkbox groups for onboarding tasks|center|thumb|550x550px|Example of a progress bar for checklist items]]
For this, we need to set up the following components:

# '''Provide the logic''' in ''MediaWiki:Common.js''
# '''Apply the syntax''' to the checklist items
# '''Create an event listener''' in the form properties

=== Provide the logic in ''MediaWiki:Common.js'' ===
Add the following JavaScript function to [https://en.wiki.bluespice.com/wiki/Manual:The_concept_of_namespaces#Namespace_.22MediaWiki.22 ''MediaWiki:Common.js'']:<syntaxhighlight lang="javascript" line="1">
/*Extension:Forms - Add a progress bar for checkbox items */
function CalcProgress( data ) {
var dfd = $.Deferred();
var checked = 0;
var ItemCheckboxes = this.$element.find( 'input[value^=check]' );
var total = ItemCheckboxes.length;
if ( total < 1 ) {
dfd.resolve( data );
return dfd.promise();
}

var items = this.getItems();
for( var name in data ) {
if ( !name.startsWith( 'checkbox_multi-' ) ) {
continue;
}
var checkedCheckboxes = data[name];
for ( var i = 0; i < checkedCheckboxes.length; i++ ) {
checked++;
}
}
data.progress = ( 100 * checked ) / total;
dfd.resolve( data );

return dfd.promise();
}

</syntaxhighlight>On line 5, you define the prefix for each checkbox that should be included in the progress count:<syntaxhighlight lang="javascript">
input[value^=check]
</syntaxhighlight>This means that the "data" value for your checkboxes needs to start with "check". You can verify this in the definition source of your form:
[[File:Manual:checkbox data value check.jpg|thumb|center|Data definition in form, here starting with "check-"]]

On line 14, you define the included fields to only those that have the prefix of "checkbox_multi" in their name.<syntaxhighlight lang="javascript">
if ( !name.startsWith( 'checkbox_multi-' ) ) {
</syntaxhighlight>

=== Apply the syntax to the checklist items ===
Here is a <code>checkbox_multiselect</code> field that has the correct name-prefix and the correct data-prefix. This field is therefore included in the count and all three options of the field count towards the progress:<syntaxhighlight lang="javascript">
{
"name": "checkbox_multi-workplace_setup",
"label": "Workplace setup",
...
"options": [
{
"data": "check-equipment",
"label": "Provide equipment (laptop, phone)"
},
{
"data": "check-access",
"label": "Grant access to required systems"
},
{
"data": "check-intro",
"label": "Meet the team"
}
],
"type": "checkbox_multiselect"
}

</syntaxhighlight>

=== Create an event listener in the form properties ===
To connect your form to the JavaScript function, you need to create the [https://en.wiki.bluespice.com/wiki/Manual:Extension/Forms/Form_elements_and_settings#Listeners listener] in the form properties:
[[File:Extension Forms Progress bar listener.png|center|thumb|650x650px|Adding the listener to the form properties]]
To add the listener:

# '''Open''' the form properties.
# '''Click''' on ''Listeners''.
# '''Select''' the event <code>beforeSubmitData</code> and enter the name of your JavaScript function. In our example, it is <code>CalcProgress</code>.
<br>
<br>
The <code>beforeSubmitData</code> event is triggered when the form is saved. As a result, changes to checkbox selections are not reflected immediately while editing the form. The progress bar is updated only after the form has been saved.<br>
If you want to test this example, you can save an empty example form (e.g., ''ExampleChecklist.form'') and copy the following into the definition source:<syntaxhighlight lang="json">
{
"title": "Example Progress Bar",
"showTitle": true,
"showFormName": false,
"buttonsFloat": false,
"categories": [],
"sealAfterCreation": false,
"enableProgressSave": false,
"enableEditSummary": false,
"rlDependencies": [],
"useFormRevs": false,
"includable": false,
"extends": "",
"abstract": false,
"partial": false,
"target": {
"type": "json-on-wikipage",
"predefined_title": "ExampleChecklist/{{checklistname}}"
},
"show_target_afterAction": false,
"listeners": {
"beforeSubmitData": "jscb:CalcProgress"
},
"lang": "json",
"items": [
{
"name": "checklistname",
"label": "Checklist name",
"help": "",
"noLayout": false,
"showOn": [
"create"
],
"editableOn": [
"create"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"type": "text"
},
{
"name": "progress",
"label": "Progress",
"help": "",
"noLayout": true,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "margin:1em auto!important; max-width:100%",
"widgetCustomProps": {
"widget_progress": "0"
},
"widget_listeners": [],
"type": "progress_bar"
},
{
"name": "checkbox_multi-getting_started",
"label": "Getting started",
"help": "",
"noLayout": false,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"horizontal": false,
"options": [
{
"data": "check-profile",
"label": "Provide personal and role information"
},
{
"data": "check-documents",
"label": "Submit required documents"
},
{
"data": "check-intro",
"label": "Review introduction materials"
}
],
"type": "checkbox_multiselect"
},
{
"name": "checkbox_multi-workplace_setup",
"label": "Workplace setup",
"help": "",
"noLayout": false,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"horizontal": false,
"options": [
{
"data": "check-equipment",
"label": "Provide equipment (laptop, phone)"
},
{
"data": "check-access",
"label": "Grant access to required systems"
},
{
"data": "check-intro",
"label": "Meet the team"
}
],
"type": "checkbox_multiselect"
}
]
}

</syntaxhighlight>

Manual:Extension/Forms/Progress bar

2026-06-01T08:20:37Z

Bhuber:

The progress bar is useful to count completed checklist items, for example. It calculates completion based on selected options.

== Adding a progress bar ==
We add a progress bar to a checklist that shows how many tasks have been completed.
[[File:Extension Forms Progress bar example.png|alt=checklist with two sets of checkbox groups for onboarding tasks|center|thumb|550x550px|Example of a progress bar for checklist items]]
For this, we need to set up the following components:

# '''Provide the logic''' in ''MediaWiki:Common.js''
# '''Apply the syntax''' to the checklist items
# '''Create an event listener''' in the form properties

=== Provide the logic in ''MediaWiki:Common.js'' ===
Add the following JavaScript function to [https://en.wiki.bluespice.com/wiki/Manual:The_concept_of_namespaces#Namespace_.22MediaWiki.22 ''MediaWiki:Common.js'']:<syntaxhighlight lang="javascript" line="1">
/*Extension:Forms - Add a progress bar for checkbox items */
function CalcProgress( data ) {
var dfd = $.Deferred();
var checked = 0;
var ItemCheckboxes = this.$element.find( 'input[value^=check]' );
var total = ItemCheckboxes.length;
if ( total < 1 ) {
dfd.resolve( data );
return dfd.promise();
}

var items = this.getItems();
for( var name in data ) {
if ( !name.startsWith( 'checkbox_multi-' ) ) {
continue;
}
var checkedCheckboxes = data[name];
for ( var i = 0; i < checkedCheckboxes.length; i++ ) {
checked++;
}
}
data.progress = ( 100 * checked ) / total;
dfd.resolve( data );

return dfd.promise();
}

</syntaxhighlight>On line 5, you define the prefix for each checkbox that should be included in the progress count:<syntaxhighlight lang="javascript">
input[value^=check]
</syntaxhighlight>This means that the "data" value for your checkboxes needs to start with "check". You can verify this in the definition source of your form:
[[File:Manual:checkbox data value check.jpg|thumb|center|Data definition in form, here starting with "check-"]]

On line 14, you define the included fields to only those that have the prefix of "checkbox_multi" in their name.<syntaxhighlight lang="javascript">
if ( !name.startsWith( 'checkbox_multi-' ) ) {
</syntaxhighlight>

=== Apply the syntax to the checklist items ===
Here is a <code>checkbox_multiselect</code> field that has the correct name-prefix and the correct data-prefix. This field is therefore included in the count and all three options of the field count towards the progress:<syntaxhighlight lang="javascript">
{
"name": "checkbox_multi-workplace_setup",
"label": "Workplace setup",
...
"options": [
{
"data": "check-equipment",
"label": "Provide equipment (laptop, phone)"
},
{
"data": "check-access",
"label": "Grant access to required systems"
},
{
"data": "check-intro",
"label": "Meet the team"
}
],
"type": "checkbox_multiselect"
}

</syntaxhighlight>

=== Create an event listener in the form properties ===
To connect your form to the JavaScript function, you need to create the [https://en.wiki.bluespice.com/wiki/Manual:Extension/Forms/Form_elements_and_settings#Listeners listener] in the form properties:
[[File:Extension Forms Progress bar listener.png|center|thumb|650x650px|Adding the listener to the form properties]]
To add the listener:

# '''Open''' the form properties.
# '''Click''' on ''Listeners''.
# '''Select''' the event <code>beforeSubmitData</code> and enter the name of your JavaScript function. In our example, it is <code>CalcProgress</code>.
<br>
<br>
The progress value is calculated when the form data is submitted through the <code>beforeSubmitData</code> event. Changes to checkboxes are therefore not reflected immediately while editing but only after submitting the changes (i.e., saving). <br>
If you want to test this example, you can save an empty example form (e.g., ''ExampleChecklist.form'') and copy the following into the definition source:<syntaxhighlight lang="json">
{
"title": "Example Progress Bar",
"showTitle": true,
"showFormName": false,
"buttonsFloat": false,
"categories": [],
"sealAfterCreation": false,
"enableProgressSave": false,
"enableEditSummary": false,
"rlDependencies": [],
"useFormRevs": false,
"includable": false,
"extends": "",
"abstract": false,
"partial": false,
"target": {
"type": "json-on-wikipage",
"predefined_title": "ExampleChecklist/{{checklistname}}"
},
"show_target_afterAction": false,
"listeners": {
"beforeSubmitData": "jscb:CalcProgress"
},
"lang": "json",
"items": [
{
"name": "checklistname",
"label": "Checklist name",
"help": "",
"noLayout": false,
"showOn": [
"create"
],
"editableOn": [
"create"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"type": "text"
},
{
"name": "progress",
"label": "Progress",
"help": "",
"noLayout": true,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "margin:1em auto!important; max-width:100%",
"widgetCustomProps": {
"widget_progress": "0"
},
"widget_listeners": [],
"type": "progress_bar"
},
{
"name": "checkbox_multi-getting_started",
"label": "Getting started",
"help": "",
"noLayout": false,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"horizontal": false,
"options": [
{
"data": "check-profile",
"label": "Provide personal and role information"
},
{
"data": "check-documents",
"label": "Submit required documents"
},
{
"data": "check-intro",
"label": "Review introduction materials"
}
],
"type": "checkbox_multiselect"
},
{
"name": "checkbox_multi-workplace_setup",
"label": "Workplace setup",
"help": "",
"noLayout": false,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"horizontal": false,
"options": [
{
"data": "check-equipment",
"label": "Provide equipment (laptop, phone)"
},
{
"data": "check-access",
"label": "Grant access to required systems"
},
{
"data": "check-intro",
"label": "Meet the team"
}
],
"type": "checkbox_multiselect"
}
]
}

</syntaxhighlight>

Manual:Extension/Forms/Progress bar

2026-06-01T08:15:54Z

Bhuber:

The progress bar is useful to count completed checklist items, for example.

== Adding a progress bar ==
We add a progress bar to a checklist that shows how many tasks habe been completed.
[[File:Extension Forms Progress bar example.png|alt=checklist with two sets of checkbox groups for onboarding tasks|center|thumb|550x550px|Example of a progress bar for checklist items]]
For this, we need to set up the following components:

# '''Provide the logic''' in ''MediaWiki:Common.js''
# '''Apply the syntax''' to the checklist items
# '''Create an event listener''' in the form properties

=== Provide the logic in ''MediaWiki:Common.js'' ===
Add the following JavasScript function to [https://en.wiki.bluespice.com/wiki/Manual:The_concept_of_namespaces#Namespace_.22MediaWiki.22 ''MediaWiki:Common.js'']:<syntaxhighlight lang="javascript" line="1">
/*Extension:Forms - Add a progress bar for checkbox items */
function CalcProgress( data ) {
var dfd = $.Deferred();
var checked = 0;
var ItemCheckboxes = this.$element.find( 'input[value^=check]' );
var total = ItemCheckboxes.length;
if ( total < 1 ) {
dfd.resolve( data );
return dfd.promise();
}

var items = this.getItems();
for( var name in data ) {
if ( !name.startsWith( 'checkbox_multi-' ) ) {
continue;
}
var checkedCheckboxes = data[name];
for ( var i = 0; i < checkedCheckboxes.length; i++ ) {
checked++;
}
}
data.progress = ( 100 * checked ) / total;
dfd.resolve( data );

return dfd.promise();
}

</syntaxhighlight>On line 5, you define the prefix for each checkbox that should be included in the progress count:<syntaxhighlight lang="javascript">
input[value^=check]
</syntaxhighlight>This means that the "data" value for your checkboxes needs to start with "check". You can verify this in the definition source of your form:
[[File:Manual:checkbox data value check.jpg|thumb|center|Data definition in form, here starting with "check-"]]

On line 14, you define the included fields to only those that have the prefix of "checkbox_multi" in their name.<syntaxhighlight lang="javascript">
if ( !name.startsWith( 'checkbox_multi-' ) ) {
</syntaxhighlight>

=== Apply the syntax to the checklist items ===
Here is a <code>checkbox_multiselect</code> field that has the correct name-prefix and the correct data-prefix. This field is therefore included in the count and all three options of the field count towards the progress:<syntaxhighlight lang="javascript">
{
"name": "checkbox_multi-workplace_setup",
"label": "Workplace setup",
...
"options": [
{
"data": "check-equipment",
"label": "Provide equipment (laptop, phone)"
},
{
"data": "check-access",
"label": "Grant access to required systems"
},
{
"data": "check-intro",
"label": "Meet the team"
}
],
"type": "checkbox_multiselect"
}

</syntaxhighlight>

=== Create an event listener in the form properties ===
To connect your form to the JavaScript function, you need to create the [https://en.wiki.bluespice.com/wiki/Manual:Extension/Forms/Form_elements_and_settings#Listeners listener] in the form properties:
[[File:Extension Forms Progress bar listener.png|center|thumb|650x650px|Adding the listener to the form properties]]
To add the listener:

# '''Open''' the form properties.
# '''Click''' on ''Listeners''.
# '''Select''' the event <code>beforeSubmitData</code> and enter the name of your JavaScript function. In our example, it is <code>CalcProgress</code>.
<br>
<br>
The progress value is calculated when the form data is submitted through the <code>beforeSubmitData</code> event. Changes to checkboxes are therefore not reflected immediately while editing but only after submitting the changes (i.e., saving). <br>
If you want to test this example, you can save an empty example form (e.g., ''ExampleChecklist.form'') and copy the following into the definition source:<syntaxhighlight lang="json">
{
"title": "Example Progress Bar",
"showTitle": true,
"showFormName": false,
"buttonsFloat": false,
"categories": [],
"sealAfterCreation": false,
"enableProgressSave": false,
"enableEditSummary": false,
"rlDependencies": [],
"useFormRevs": false,
"includable": false,
"extends": "",
"abstract": false,
"partial": false,
"target": {
"type": "json-on-wikipage",
"predefined_title": "ExampleChecklist/{{checklistname}}"
},
"show_target_afterAction": false,
"listeners": {
"beforeSubmitData": "jscb:CalcProgress"
},
"lang": "json",
"items": [
{
"name": "checklistname",
"label": "Checklist name",
"help": "",
"noLayout": false,
"showOn": [
"create"
],
"editableOn": [
"create"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"type": "text"
},
{
"name": "progress",
"label": "Progress",
"help": "",
"noLayout": true,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "margin:1em auto!important; max-width:100%",
"widgetCustomProps": {
"widget_progress": "0"
},
"widget_listeners": [],
"type": "progress_bar"
},
{
"name": "checkbox_multi-getting_started",
"label": "Getting started",
"help": "",
"noLayout": false,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"horizontal": false,
"options": [
{
"data": "check-profile",
"label": "Provide personal and role information"
},
{
"data": "check-documents",
"label": "Submit required documents"
},
{
"data": "check-intro",
"label": "Review introduction materials"
}
],
"type": "checkbox_multiselect"
},
{
"name": "checkbox_multi-workplace_setup",
"label": "Workplace setup",
"help": "",
"noLayout": false,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"horizontal": false,
"options": [
{
"data": "check-equipment",
"label": "Provide equipment (laptop, phone)"
},
{
"data": "check-access",
"label": "Grant access to required systems"
},
{
"data": "check-intro",
"label": "Meet the team"
}
],
"type": "checkbox_multiselect"
}
]
}

</syntaxhighlight>

Manual:Extension/Forms/Progress bar

2026-06-01T08:13:50Z

Bhuber:

The progress bar is useful to count completed checklist items, for example.

== Adding a progress bar ==
We add a progress bar to a checklist that shows how many tasks habe been completed.
[[File:Extension Forms Progress bar example.png|alt=checklist with two sets of checkbox groups for onboarding tasks|center|thumb|550x550px|Example of a progress bar for checklist items]]
For this, we need to set up the following components:

# '''Provide the logic''' in ''MediaWiki:Common.js''
# '''Apply the syntax''' to the checklist items
# '''Create an event listener''' in the form properties

=== Provide the logic in ''MediaWiki:Common.js'' ===
Add the following JavasScript function to [https://en.wiki.bluespice.com/wiki/Manual:The_concept_of_namespaces#Namespace_.22MediaWiki.22 ''MediaWiki:Common.js'']:<syntaxhighlight lang="javascript" line="1">
/*Extension:Forms - Add a progress bar for checkbox items */
function CalcProgress( data ) {
var dfd = $.Deferred();
var checked = 0;
var ItemCheckboxes = this.$element.find( 'input[value^=check]' );
var total = ItemCheckboxes.length;
if ( total < 1 ) {
dfd.resolve( data );
return dfd.promise();
}

var items = this.getItems();
for( var name in data ) {
if ( !name.startsWith( 'checkbox_multi-' ) ) {
continue;
}
var checkedCheckboxes = data[name];
for ( var i = 0; i < checkedCheckboxes.length; i++ ) {
checked++;
}
}
data.progress = ( 100 * checked ) / total;
dfd.resolve( data );

return dfd.promise();
}

</syntaxhighlight>On line 5, you define the prefix for each checkbox that should be included in the progress count:<syntaxhighlight lang="javascript">
input[value^=check]
</syntaxhighlight>This means that the "data" value for your checkboxes needs to start with "check". You can verify this in the definition source of your form:
[[File:Manual:checkbox data value check.jpg|thumb|center|Data definition in form, here starting with "check-"]]

On line 14, you define the included fields to only those that have the prefix of "checkbox_multi" in their name.<syntaxhighlight lang="javascript">
if ( !name.startsWith( 'checkbox_multi-' ) ) {
</syntaxhighlight>

=== Apply the syntax to the checklist items ===
Here is a <code>checkbox_multiselect</code> field that has the correct name-prefix and the correct data-prefix. This field is therefore included in the count and all three options of the field count towards the progress:<syntaxhighlight lang="javascript">
{
"name": "checkbox_multi-workplace_setup",
"label": "Workplace setup",
...
"options": [
{
"data": "check-equipment",
"label": "Provide equipment (laptop, phone)"
},
{
"data": "check-access",
"label": "Grant access to required systems"
},
{
"data": "check-intro",
"label": "Meet the team"
}
],
"type": "checkbox_multiselect"
}

</syntaxhighlight>

=== Create an event listener in the form properties ===
To connect your form to the JavaScript function, you need to create the [https://en.wiki.bluespice.com/wiki/Manual:Extension/Forms/Form_elements_and_settings#Listeners listener] in the form properties:
[[File:Extension Forms Progress bar listener.png|center|thumb|650x650px|Adding the listener to the form properties]]
To add the listener:

# '''Open''' the form properties.
# '''Click''' on ''Listeners''.
# '''Select''' the event <code>beforeSubmitData</code> and enter the name of your JavaScript function. In our example, it is <code>CalcProgress</code>.

If you want to test this example, you can save an empty example form (e.g., ''ExampleChecklist.form'') and copy the following into the definition source:<syntaxhighlight lang="json">
{
"title": "Example Progress Bar",
"showTitle": true,
"showFormName": false,
"buttonsFloat": false,
"categories": [],
"sealAfterCreation": false,
"enableProgressSave": false,
"enableEditSummary": false,
"rlDependencies": [],
"useFormRevs": false,
"includable": false,
"extends": "",
"abstract": false,
"partial": false,
"target": {
"type": "json-on-wikipage",
"predefined_title": "ExampleChecklist/{{checklistname}}"
},
"show_target_afterAction": false,
"listeners": {
"beforeSubmitData": "jscb:CalcProgress"
},
"lang": "json",
"items": [
{
"name": "checklistname",
"label": "Checklist name",
"help": "",
"noLayout": false,
"showOn": [
"create"
],
"editableOn": [
"create"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"type": "text"
},
{
"name": "progress",
"label": "Progress",
"help": "",
"noLayout": true,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "margin:1em auto!important; max-width:100%",
"widgetCustomProps": {
"widget_progress": "0"
},
"widget_listeners": [],
"type": "progress_bar"
},
{
"name": "checkbox_multi-getting_started",
"label": "Getting started",
"help": "",
"noLayout": false,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"horizontal": false,
"options": [
{
"data": "check-profile",
"label": "Provide personal and role information"
},
{
"data": "check-documents",
"label": "Submit required documents"
},
{
"data": "check-intro",
"label": "Review introduction materials"
}
],
"type": "checkbox_multiselect"
},
{
"name": "checkbox_multi-workplace_setup",
"label": "Workplace setup",
"help": "",
"noLayout": false,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"horizontal": false,
"options": [
{
"data": "check-equipment",
"label": "Provide equipment (laptop, phone)"
},
{
"data": "check-access",
"label": "Grant access to required systems"
},
{
"data": "check-intro",
"label": "Meet the team"
}
],
"type": "checkbox_multiselect"
}
]
}

</syntaxhighlight>

Manual:Extension/Forms/Progress bar

2026-06-01T08:01:55Z

Bhuber:

The progress bar is useful to count completed checklist items, for example.

== Adding a progress bar ==
We add a progress bar to a checklist that shows how many tasks habe been completed.
[[File:Extension Forms Progress bar example.png|alt=checklist with two sets of checkbox groups for onboarding tasks|center|thumb|550x550px|Example of a progress bar for checklist items]]
For this, we need to set up the following components:

# '''Provide the logic''' in ''MediaWiki:Common.js''
# '''Apply the syntax''' to the checklist items
# '''Create an event listener''' in the form properties

=== Provide the logic in ''MediaWiki:Common.js'' ===
Add the following JavasScript function to [https://en.wiki.bluespice.com/wiki/Manual:The_concept_of_namespaces#Namespace_.22MediaWiki.22|''MediaWiki:Common.js'']:<syntaxhighlight lang="javascript" line="1">
/*Extension:Forms - Add a progress bar for checkbox items */
function CalcProgress( data ) {
var dfd = $.Deferred();
var checked = 0;
var ItemCheckboxes = this.$element.find( 'input[value^=check]' );
var total = ItemCheckboxes.length;
if ( total < 1 ) {
dfd.resolve( data );
return dfd.promise();
}

var items = this.getItems();
for( var name in data ) {
if ( !name.startsWith( 'checkbox_multi-' ) ) {
continue;
}
var checkedCheckboxes = data[name];
for ( var i = 0; i < checkedCheckboxes.length; i++ ) {
checked++;
}
}
data.progress = ( 100 * checked ) / total;
dfd.resolve( data );

return dfd.promise();
}

</syntaxhighlight>On line 5, you define the prefix for each checkbox that should be included in the progress count:<syntaxhighlight lang="javascript">
input[value^=check]
</syntaxhighlight>This means that the "data" value for your checkboxes needs to start with "check". You can verify this in the definition source of your form:
[[File:Manual:checkbox data value check.jpg|thumb|center|Data definition in form, here starting with "check-"]]

On line 14, you define the included fields to only those that have the prefix of "checkbox_multi" in their name.<syntaxhighlight lang="javascript">
if ( !name.startsWith( 'checkbox_multi-' ) ) {
</syntaxhighlight>

=== Apply the syntax to the checklist items ===
Here is a <code>checkbox_multiselect</code> field that has the correct name-prefix and the correct data-prefix. This field is therefore included in the count and all three options of the field count towards the progress:<syntaxhighlight lang="javascript">
{
"name": "checkbox_multi-workplace_setup",
"label": "Workplace setup",
...
"options": [
{
"data": "check-equipment",
"label": "Provide equipment (laptop, phone)"
},
{
"data": "check-access",
"label": "Grant access to required systems"
},
{
"data": "check-intro",
"label": "Meet the team"
}
],
"type": "checkbox_multiselect"
}

</syntaxhighlight>

=== Create an event listener in the form properties ===
To connect your form to the JavaScript function, you need to create the listener in the form properties:
[[File:Extension Forms Progress bar listener.png|center|thumb|650x650px|Adding the listener to the form properties]]
To add the listener:

# '''Open''' the form properties.
# '''Click''' on ''Listeners''.
# '''Select''' the event <code>beforeSubmitData</code> and enter the name of your JavaScript function. In our example, it is <code>CalcProgress</code>.

If you want to test this example, you can save an empty example form (e.g., ''ExampleChecklist.form'') and copy the following into the definition source:<syntaxhighlight lang="json">
{
"title": "Example Progress Bar",
"showTitle": true,
"showFormName": false,
"buttonsFloat": false,
"categories": [],
"sealAfterCreation": false,
"enableProgressSave": false,
"enableEditSummary": false,
"rlDependencies": [],
"useFormRevs": false,
"includable": false,
"extends": "",
"abstract": false,
"partial": false,
"target": {
"type": "json-on-wikipage",
"predefined_title": "ExampleChecklist/{{checklistname}}"
},
"show_target_afterAction": false,
"listeners": {
"beforeSubmitData": "jscb:CalcProgress"
},
"lang": "json",
"items": [
{
"name": "checklistname",
"label": "Checklist name",
"help": "",
"noLayout": false,
"showOn": [
"create"
],
"editableOn": [
"create"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"type": "text"
},
{
"name": "progress",
"label": "Progress",
"help": "",
"noLayout": true,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "margin:1em auto!important; max-width:100%",
"widgetCustomProps": {
"widget_progress": "0"
},
"widget_listeners": [],
"type": "progress_bar"
},
{
"name": "checkbox_multi-getting_started",
"label": "Getting started",
"help": "",
"noLayout": false,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"horizontal": false,
"options": [
{
"data": "check-profile",
"label": "Provide personal and role information"
},
{
"data": "check-documents",
"label": "Submit required documents"
},
{
"data": "check-intro",
"label": "Review introduction materials"
}
],
"type": "checkbox_multiselect"
},
{
"name": "checkbox_multi-workplace_setup",
"label": "Workplace setup",
"help": "",
"noLayout": false,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"horizontal": false,
"options": [
{
"data": "check-equipment",
"label": "Provide equipment (laptop, phone)"
},
{
"data": "check-access",
"label": "Grant access to required systems"
},
{
"data": "check-intro",
"label": "Meet the team"
}
],
"type": "checkbox_multiselect"
}
]
}

</syntaxhighlight>

Manual:Extension/Forms/Progress bar

2026-06-01T08:01:37Z

Bhuber:

The progress bar is useful to count completed checklist items, for example.

== Adding a progress bar ==
We add a progress bar to a checklist that shows how many tasks habe been completed.
[[File:Extension Forms Progress bar example.png|alt=checklist with two sets of checkbox groups for onboarding tasks|center|thumb|550x550px|Example of a progress bar for checklist items]]
For this, we need to set up the following components:

# '''Provide the logic''' in ''MediaWiki:Common.js''
# '''Apply the syntax''' to the checklist items
# '''Create an event listener''' in the form properties

=== Provide the logic in ''MediaWiki:Common.js'' ===
Add the following JavasScript function to [[https://en.wiki.bluespice.com/wiki/Manual:The_concept_of_namespaces#Namespace_.22MediaWiki.22|''MediaWiki:Common.js'']]:<syntaxhighlight lang="javascript" line="1">
/*Extension:Forms - Add a progress bar for checkbox items */
function CalcProgress( data ) {
var dfd = $.Deferred();
var checked = 0;
var ItemCheckboxes = this.$element.find( 'input[value^=check]' );
var total = ItemCheckboxes.length;
if ( total < 1 ) {
dfd.resolve( data );
return dfd.promise();
}

var items = this.getItems();
for( var name in data ) {
if ( !name.startsWith( 'checkbox_multi-' ) ) {
continue;
}
var checkedCheckboxes = data[name];
for ( var i = 0; i < checkedCheckboxes.length; i++ ) {
checked++;
}
}
data.progress = ( 100 * checked ) / total;
dfd.resolve( data );

return dfd.promise();
}

</syntaxhighlight>On line 5, you define the prefix for each checkbox that should be included in the progress count:<syntaxhighlight lang="javascript">
input[value^=check]
</syntaxhighlight>This means that the "data" value for your checkboxes needs to start with "check". You can verify this in the definition source of your form:
[[File:Manual:checkbox data value check.jpg|thumb|center|Data definition in form, here starting with "check-"]]

On line 14, you define the included fields to only those that have the prefix of "checkbox_multi" in their name.<syntaxhighlight lang="javascript">
if ( !name.startsWith( 'checkbox_multi-' ) ) {
</syntaxhighlight>

=== Apply the syntax to the checklist items ===
Here is a <code>checkbox_multiselect</code> field that has the correct name-prefix and the correct data-prefix. This field is therefore included in the count and all three options of the field count towards the progress:<syntaxhighlight lang="javascript">
{
"name": "checkbox_multi-workplace_setup",
"label": "Workplace setup",
...
"options": [
{
"data": "check-equipment",
"label": "Provide equipment (laptop, phone)"
},
{
"data": "check-access",
"label": "Grant access to required systems"
},
{
"data": "check-intro",
"label": "Meet the team"
}
],
"type": "checkbox_multiselect"
}

</syntaxhighlight>

=== Create an event listener in the form properties ===
To connect your form to the JavaScript function, you need to create the listener in the form properties:
[[File:Extension Forms Progress bar listener.png|center|thumb|650x650px|Adding the listener to the form properties]]
To add the listener:

# '''Open''' the form properties.
# '''Click''' on ''Listeners''.
# '''Select''' the event <code>beforeSubmitData</code> and enter the name of your JavaScript function. In our example, it is <code>CalcProgress</code>.

If you want to test this example, you can save an empty example form (e.g., ''ExampleChecklist.form'') and copy the following into the definition source:<syntaxhighlight lang="json">
{
"title": "Example Progress Bar",
"showTitle": true,
"showFormName": false,
"buttonsFloat": false,
"categories": [],
"sealAfterCreation": false,
"enableProgressSave": false,
"enableEditSummary": false,
"rlDependencies": [],
"useFormRevs": false,
"includable": false,
"extends": "",
"abstract": false,
"partial": false,
"target": {
"type": "json-on-wikipage",
"predefined_title": "ExampleChecklist/{{checklistname}}"
},
"show_target_afterAction": false,
"listeners": {
"beforeSubmitData": "jscb:CalcProgress"
},
"lang": "json",
"items": [
{
"name": "checklistname",
"label": "Checklist name",
"help": "",
"noLayout": false,
"showOn": [
"create"
],
"editableOn": [
"create"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"type": "text"
},
{
"name": "progress",
"label": "Progress",
"help": "",
"noLayout": true,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "margin:1em auto!important; max-width:100%",
"widgetCustomProps": {
"widget_progress": "0"
},
"widget_listeners": [],
"type": "progress_bar"
},
{
"name": "checkbox_multi-getting_started",
"label": "Getting started",
"help": "",
"noLayout": false,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"horizontal": false,
"options": [
{
"data": "check-profile",
"label": "Provide personal and role information"
},
{
"data": "check-documents",
"label": "Submit required documents"
},
{
"data": "check-intro",
"label": "Review introduction materials"
}
],
"type": "checkbox_multiselect"
},
{
"name": "checkbox_multi-workplace_setup",
"label": "Workplace setup",
"help": "",
"noLayout": false,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"horizontal": false,
"options": [
{
"data": "check-equipment",
"label": "Provide equipment (laptop, phone)"
},
{
"data": "check-access",
"label": "Grant access to required systems"
},
{
"data": "check-intro",
"label": "Meet the team"
}
],
"type": "checkbox_multiselect"
}
]
}

</syntaxhighlight>

Manual:Extension/Forms/Progress bar

2026-06-01T07:39:17Z

Bhuber:

The progress bar is useful to count completed checklist items, for example.

== Adding a progress bar ==
We add a progress bar to a checklist that shows how many tasks habe been completed.
[[File:Extension Forms Progress bar example.png|alt=checklist with two sets of checkbox groups for onboarding tasks|center|thumb|550x550px|Example of a progress bar for checklist items]]
For this, we need to set up the following components:

# '''Provide the logic''' in ''MediaWiki:Common.js''
# '''Apply the syntax''' to the checklist items
# '''Create an event listener''' in the form properties

=== Provide the logic in ''MediaWiki:Common.js'' ===
Add the following JavasScript function to ''MediaWiki:Common.js'':<syntaxhighlight lang="javascript" line="1">
/*Extension:Forms - Add a progress bar for checkbox items */
function CalcProgress( data ) {
var dfd = $.Deferred();
var checked = 0;
var ItemCheckboxes = this.$element.find( 'input[value^=check]' );
var total = ItemCheckboxes.length;
if ( total < 1 ) {
dfd.resolve( data );
return dfd.promise();
}

var items = this.getItems();
for( var name in data ) {
if ( !name.startsWith( 'checkbox_multi-' ) ) {
continue;
}
var checkedCheckboxes = data[name];
for ( var i = 0; i < checkedCheckboxes.length; i++ ) {
checked++;
}
}
data.progress = ( 100 * checked ) / total;
dfd.resolve( data );

return dfd.promise();
}

</syntaxhighlight>On line 5, you define the prefix for each checkbox that should be included in the progress count:<syntaxhighlight lang="javascript">
input[value^=check]
</syntaxhighlight>This means that the "data" value for your checkboxes needs to start with "check". You can verify this in the definition source of your form:
[[File:Manual:checkbox data value check.jpg|thumb|center|Data definition in form, here starting with "check-"]]

On line 14, you define the included fields to only those that have the prefix of "checkbox_multi" in their name.<syntaxhighlight lang="javascript">
if ( !name.startsWith( 'checkbox_multi-' ) ) {
</syntaxhighlight>

=== Apply the syntax to the checklist items ===
Here is a <code>checkbox_multiselect</code> field that has the correct name-prefix and the correct data-prefix. This field is therefore included in the count and all three options of the field count towards the progress:<syntaxhighlight lang="javascript">
{
"name": "checkbox_multi-workplace_setup",
"label": "Workplace setup",
...
"options": [
{
"data": "check-equipment",
"label": "Provide equipment (laptop, phone)"
},
{
"data": "check-access",
"label": "Grant access to required systems"
},
{
"data": "check-intro",
"label": "Meet the team"
}
],
"type": "checkbox_multiselect"
}

</syntaxhighlight>

=== Create an event listener in the form properties ===
To connect your form to the JavaScript function, you need to create the listener in the form properties:
[[File:Extension Forms Progress bar listener.png|center|thumb|650x650px|Adding the listener to the form properties]]
To add the listener:

# '''Open''' the form properties.
# '''Click''' on ''Listeners''.
# '''Select''' the event <code>beforeSubmitData</code> and enter the name of your JavaScript function. In our example, it is <code>CalcProgress</code>.

If you want to test this example, you can save an empty example form (e.g., ''ExampleChecklist.form'') and copy the following into the definition source:<syntaxhighlight lang="json">
{
"title": "Example Progress Bar",
"showTitle": true,
"showFormName": false,
"buttonsFloat": false,
"categories": [],
"sealAfterCreation": false,
"enableProgressSave": false,
"enableEditSummary": false,
"rlDependencies": [],
"useFormRevs": false,
"includable": false,
"extends": "",
"abstract": false,
"partial": false,
"target": {
"type": "json-on-wikipage",
"predefined_title": "ExampleChecklist/{{checklistname}}"
},
"show_target_afterAction": false,
"listeners": {
"beforeSubmitData": "jscb:CalcProgress"
},
"lang": "json",
"items": [
{
"name": "checklistname",
"label": "Checklist name",
"help": "",
"noLayout": false,
"showOn": [
"create"
],
"editableOn": [
"create"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"type": "text"
},
{
"name": "progress",
"label": "Progress",
"help": "",
"noLayout": true,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "margin:1em auto!important; max-width:100%",
"widgetCustomProps": {
"widget_progress": "0"
},
"widget_listeners": [],
"type": "progress_bar"
},
{
"name": "checkbox_multi-getting_started",
"label": "Getting started",
"help": "",
"noLayout": false,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"horizontal": false,
"options": [
{
"data": "check-profile",
"label": "Provide personal and role information"
},
{
"data": "check-documents",
"label": "Submit required documents"
},
{
"data": "check-intro",
"label": "Review introduction materials"
}
],
"type": "checkbox_multiselect"
},
{
"name": "checkbox_multi-workplace_setup",
"label": "Workplace setup",
"help": "",
"noLayout": false,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"horizontal": false,
"options": [
{
"data": "check-equipment",
"label": "Provide equipment (laptop, phone)"
},
{
"data": "check-access",
"label": "Grant access to required systems"
},
{
"data": "check-intro",
"label": "Meet the team"
}
],
"type": "checkbox_multiselect"
}
]
}

</syntaxhighlight>

Manual:Extension/Forms/Progress bar

2026-06-01T07:38:57Z

Bhuber:

The progress bar is useful to count completed checklist items, for example.

== Adding a progress bar ==
We add a progress bar to a checklist that shows how many tasks habe been completed.
[[File:Extension Forms Progress bar example.png|alt=checklist with two sets of checkbox groups for onboarding tasks|center|thumb|550x550px|Example of a progress bar for checklist items]]
For this, we need to set up the following components:

# '''Provide the logic''' in ''MediaWiki:Common.js''
# '''Apply the syntax''' to the checklist items
# '''Create an event listener''' in the form properties

=== Provide the logic in ''MediaWiki:Common.js'' ===
Add the following JavasScript function to ''MediaWiki:Common.js'':<syntaxhighlight lang="javascript" line="1">
/*Extension:Forms - Add a progress bar for checkbox items */
function CalcProgress( data ) {
var dfd = $.Deferred();
var checked = 0;
var ItemCheckboxes = this.$element.find( 'input[value^=check]' );
var total = ItemCheckboxes.length;
if ( total < 1 ) {
dfd.resolve( data );
return dfd.promise();
}

var items = this.getItems();
for( var name in data ) {
if ( !name.startsWith( 'checkbox_multi-' ) ) {
continue;
}
var checkedCheckboxes = data[name];
for ( var i = 0; i < checkedCheckboxes.length; i++ ) {
checked++;
}
}
data.progress = ( 100 * checked ) / total;
dfd.resolve( data );

return dfd.promise();
}

</syntaxhighlight>On line 5, you define the prefix for each checkbox that should be included in the progress count:<syntaxhighlight lang="javascript">
input[value^=check]
</syntaxhighlight>This means that the "data" value for your checkboxes needs to start with "check". You can verify this in the definition source of your form:
[[File:Manual:checkbox data value check.jpg|thumb|center|data definition in form, here starting with "check-"]]

On line 14, you define the included fields to only those that have the prefix of "checkbox_multi" in their name.<syntaxhighlight lang="javascript">
if ( !name.startsWith( 'checkbox_multi-' ) ) {
</syntaxhighlight>

=== Apply the syntax to the checklist items ===
Here is a <code>checkbox_multiselect</code> field that has the correct name-prefix and the correct data-prefix. This field is therefore included in the count and all three options of the field count towards the progress:<syntaxhighlight lang="javascript">
{
"name": "checkbox_multi-workplace_setup",
"label": "Workplace setup",
...
"options": [
{
"data": "check-equipment",
"label": "Provide equipment (laptop, phone)"
},
{
"data": "check-access",
"label": "Grant access to required systems"
},
{
"data": "check-intro",
"label": "Meet the team"
}
],
"type": "checkbox_multiselect"
}

</syntaxhighlight>

=== Create an event listener in the form properties ===
To connect your form to the JavaScript function, you need to create the listener in the form properties:
[[File:Extension Forms Progress bar listener.png|center|thumb|650x650px|Adding the listener to the form properties]]
To add the listener:

# '''Open''' the form properties.
# '''Click''' on ''Listeners''.
# '''Select''' the event <code>beforeSubmitData</code> and enter the name of your JavaScript function. In our example, it is <code>CalcProgress</code>.

If you want to test this example, you can save an empty example form (e.g., ''ExampleChecklist.form'') and copy the following into the definition source:<syntaxhighlight lang="json">
{
"title": "Example Progress Bar",
"showTitle": true,
"showFormName": false,
"buttonsFloat": false,
"categories": [],
"sealAfterCreation": false,
"enableProgressSave": false,
"enableEditSummary": false,
"rlDependencies": [],
"useFormRevs": false,
"includable": false,
"extends": "",
"abstract": false,
"partial": false,
"target": {
"type": "json-on-wikipage",
"predefined_title": "ExampleChecklist/{{checklistname}}"
},
"show_target_afterAction": false,
"listeners": {
"beforeSubmitData": "jscb:CalcProgress"
},
"lang": "json",
"items": [
{
"name": "checklistname",
"label": "Checklist name",
"help": "",
"noLayout": false,
"showOn": [
"create"
],
"editableOn": [
"create"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"type": "text"
},
{
"name": "progress",
"label": "Progress",
"help": "",
"noLayout": true,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "margin:1em auto!important; max-width:100%",
"widgetCustomProps": {
"widget_progress": "0"
},
"widget_listeners": [],
"type": "progress_bar"
},
{
"name": "checkbox_multi-getting_started",
"label": "Getting started",
"help": "",
"noLayout": false,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"horizontal": false,
"options": [
{
"data": "check-profile",
"label": "Provide personal and role information"
},
{
"data": "check-documents",
"label": "Submit required documents"
},
{
"data": "check-intro",
"label": "Review introduction materials"
}
],
"type": "checkbox_multiselect"
},
{
"name": "checkbox_multi-workplace_setup",
"label": "Workplace setup",
"help": "",
"noLayout": false,
"showOn": [
"create",
"edit",
"view"
],
"editableOn": [
"create",
"edit"
],
"widget_classes": [],
"style": "",
"widgetCustomProps": [],
"widget_listeners": [],
"value": "",
"required": false,
"horizontal": false,
"options": [
{
"data": "check-equipment",
"label": "Provide equipment (laptop, phone)"
},
{
"data": "check-access",
"label": "Grant access to required systems"
},
{
"data": "check-intro",
"label": "Meet the team"
}
],
"type": "checkbox_multiselect"
}
]
}

</syntaxhighlight>

File:Manual:checkbox data value check.jpg

2026-06-01T07:37:36Z

Bhuber:

visual form editor checkbox data value check

Manual:Extension/Forms/Form elements and settings

2026-06-01T06:52:39Z

Bhuber:

== Form elements ==
It is possible to add the following form fields to your form:

=== Inputs ===
{| class="wikitable compact" style="width: 100%;"
!Field
!Functionality
|-
|Book
|auto-complete field that finds pages in the namespace "Book"
|-
|Text
|standard text field
|-
|Textarea
|multi-line text field
|-
|Wikitext input
|multi-line text field that expects Wikitext syntax
|-
|Category multiselect
|token field to add one or more categories to the page; values are separated with the <code>enter</code>-key
|-
|Checkbox
|single checkbox
|-
|Menu tag multiselect
|multiple-value input; values are separated with the <code>enter</code>-key
|-
|Checkbox multiselect
|checkbox group (allows selecting multiple values in the group)
|-
|Dropdown
|dropdown list with predefined options
|-
|Number
|integer field
|-
|Radio button
|single radio button (usually not used in a manually completed form)
|-
|Radio group
|radio buttons for toggling a selection (allows selecting only one value in the group)
|-
|File chooser
|selects a file in the wiki
|-
|Title input
|auto-complete field for wiki pages
|-
|Combo box
|combines a ''text input field'' and a ''dropdown list''. Users can select a predefined value or type their own.
|-
|Password input
|sets a password with a password and password-repeat field. This is not used in forms for the target types <code>JSON on wikipage</code>, <code>Template</code> or <code>Email</code>, as the password is stored in plain text.
|-
|Tag input
|token field to add multiple values; values are separated with the <code>enter</code>-key
|-
|Date
|same as ''Date picker''
|-
|Title input
|selects page titles in the wiki
|-
|User input
|username that exists in the wiki
|-
|Group input
|group name that exists in the wiki
|-
|Group multiselect
|multiple group names
|-
|User multiselect
|multiple user names
|-
|Title multiseslect
|multiple page titles
|-
|Date picker
|calendar widget
|-
|Percent
|integer value
|}

=== Other ===
{| class="wikitable compact" style="width: 100%;"
!Element
!Description
|-
|Static Wikitext
|non-editable text
|-
|Button
|triggers an action (requires a defined event listener)
|-
|Message banner
|message that can be shown anywhere in the form;
the type that is set (notice, error, warning, success) provides the visual formatting
|-
|Partial form import
|adds form fields from another form
|-
|Icon
| -
|-
|Indicator
| -
|-
|Label
| -
|-
|[[Manual:Extension/Forms/Progress bar|Progress bar]]
|visual representation of the number of completed steps in a form such as a checklist
|-
|Section label
|a heading to a form section
|-
|HR
|a visual separator line
|}

=== Input field options ===
Each input field has a combination of any of these options:
{| class="wikitable compact" style="width: 100%;"
|+main
!Type
!Field
!Functionality
|-
| rowspan="6" |(all)
|Name
|field name stored in the database (avoid special characters)
|-
|Label
|text label shown to users
|-
|Help
|creates a tooltip pop-up next to the label
|-
|No layout
|hides the label
|-
|Show on
|mode in which this field is visible
|-
|Editable on
|sets when the field value can be edited
|-
|Book
|Return property
|?
|}
{| class="wikitable compact"
|+styling
!Type
!Field
!Functionality
|-
| rowspan="2" |(all)
|CSS Classes
|add individual CSS-classes for use on ''MediaWiki:Common.css''
- the class is set on the form field itself and does not include the label; multiple classes can be set together or you can add them separately
|-
|Style
|define an inline style that affects only this field. The style is applied to the wrapper and includes the label and the field
|-
| rowspan="2" |Textarea, Wikitext input
|Number of rows
|used for textareas
|-
|Placeholder
|text that is displayed before the user is typing a value (has no effect, if there is also a default value set)
|-
|Radio group
|No default value
|ensures that there is no pre-selected radio-button if a default would not make sense
|-
|Radio group, Checkbox multiselect
|Horizontal layout
|aligns multiselect checkboxes or radio groups horizontally
|-
| rowspan="3" |Button
|Icon
|displays an icon before the text, (e.g. a bootstrap-icon like <code>bi bi-calendar</code>)
|-
|Indicator
|displays an icon after the text (e.g. a bootstrap-icon like <code>bi bi-arrow-right</code>)
|-
|Framed
|when deactivated, the button looks like text only (and can be styled via CSS classes, e.g. <code>btn button-warning</code>)
|}
{| class="wikitable compact"
|+other
!Type
!Fieldset
!Field
!Functionality
|-
| rowspan="6" |(all)
| rowspan="2" |Custom widget properties
|Key
|
|-
|Value
|
|-
| rowspan="2" |Listeners
|Event
|event that is supported by [https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.html OO.ui widgets], such as ''change, enter, focus, blur''
|-
|Callback
|function that is called when the event occurs (can be declared in MediaWiki:Common.js for example
|-
| rowspan="2" |
|Default value /
Selected by default
|value that is used if the user does not provide a value; field type "checkbox" has option "Selected by default" instead
|-
|Required
|form cannot be submitted without this field having a value
|-
|Password
|
|Password strength
|weak: <br>
medium: <br>
strong:
|-
| rowspan="2" |Tag
|
|Input position
|inline:
outline:
|-
|
|Allow arbitrary
|It is possible to add values other than the allowed values (only necessary if allowed values are defined)
|}

== Form Settings ==

=== Appearance ===
{| class="wikitable compact"
!Field
!Functionality
|-
|Title
|display title for the form
|-
|Display title
|shows the form title above each form instance
|-
|Display form name
|displays the name fo the form with label ''Form used'' as first form element
|}

=== Behaviour ===
{| class="wikitable compact"
!Field
!Functionality
|-
|Categories
|adds categories to each form instance; values are separated with the <code>enter</code>-key
|-
|Seal after creation
|form instances cannot be edited after the initial save
|-
|Enable intermediate saving
|form instances show both a <code>Save</code> and a <code>Save & Close</code> button;
the <code>Save</code> button saves the form values and keeps the form in edit-mode.
|}

=== Infrastructure ===
{| class="wikitable compact"
!Field
!Functionality
|-
|Resource loader dependencies
|
|-
|Keep track of revisions
|
|-
|Includable
|extends form
|-
|Abstract
|
|-
|Partial
|
|}

=== Target ===
{| class="wikitable compact"
!Field
!Functionality
|-
|Target type
|
|-
|Predefined page title for pages created using this form
|use the field name to insert the value from a form field;
for example: if you have a field with the name <code>company_name</code>, you can use <code><nowiki>{{company_name}}</nowiki></code> as page name or part of the page name.
|}

=== Listeners ===
{| class="wikitable compact"
!Field
!Functionality
|-
|Event
|each listener reacts to one of these events:

* ''initCompleteForm:'' object is initialized
* ''parseComplete:'' JSON/schema/config fully processed
* ''renderComplete:'' UI fully rendered in DOM
* ''beforeSubmitData:'' Right before submission
|-
|Callback
|calls a function when the event occurs;
see the [[Manual:Extension/Forms/Progress bar|progress bar]] example.
|}{{translation}}
__FORCETOC__

Startpage templates download/Startpage SME

2026-04-30T09:14:25Z

Bhuber:

<div class="downloadarea">
<span class="getButton">[[Media:Startpage SME.zip|Download]]</span>

[[File:Startpage SME.png|350x350px]]
</div>This template provides a good starting layout for the homepage of the wiki for a small or medium-sized company.

{{Templateimport|Startpage SME}}

==Pages included in the import==
The xml import creates the following files in your wiki:

*Help:Startpage SME
*Help:Startpage SME/Bannerbox
*Help:Startpage SME/Contact
*Help:Startpage SME/Iconnav
*Help:Startpage SME/Minutes
*Help:Startpage SME/New Employees
*Help:Startpage SME/News
*Help:Startpage SME/Recent Changes
*Template:Employee
*Template:Employee/styles.css

{{Manual:Startpage templates}}

===Included sections===
{| class="wikitable" style="width: 100%;" data-ve-attributes="{"style":"width: 100%;"}"
! style="width:200px;" data-ve-attributes="{"style":"width:200px;"}" |Section
! Subpage
!Content type
!Description
|-
| style="width:200px;" data-ve-attributes="{"style":"width:200px;"}" | Bannerbox
| Bannerbox
|Template
|The bannerbox parameters are described on the [[Templates download/Banner|Banner template download page]]. '''Note:''' Starting with BlueSpice 4.3, an identical template "Bannerbox" is already preloaded.
|-
| Iconnav
| Iconnav
|Template
| The icon nav uses FontAwesome icons out of the box. The parameters and links to the icon libraries are described on the [[Templates download/Image cards|Image cards download page]]. '''Note:''' Up to BlueSpice 4.2, those are not included as an extension. In this case they have to be replaced with Bootstrap Icons or an external reference to FontAwesome has to be added to MediaWiki:Common.css (if allowed by the security policies of the company).
|-
| style="width:200px;" data-ve-attributes="{"style":"width:200px;"}" |News
|News
|Timeline parser function
|Simple wiki table. To add or remove news, just edit the table.
|-
| style="width:200px;" data-ve-attributes="{"style":"width:200px;"}" |Contacts
|Contact
|Text,

<code><nowiki><profileimage></nowiki></code>-tag
|Content can be edited directly on the page. Double-click on the profile image tag to change the user name for the contact avatar.
|-
|Minutes
|Minutes
|<code><nowiki><inputbox></nowiki></code>-tag, <code><nowiki><dpl></nowiki></code>- tag, subpages query
|The meeting minutes are created via an [[Manual:Extension/InputBox|InputBox]]. They are created as subpages of a ''Minutes'' page in the main namespace.
|-
|Recent Changes
|Recent Changes
|<code><nowiki><smartlist></nowiki></code>-tag
|The [[Manual:Extension/BlueSpiceSmartList|smartlist]] tag is used by default. You can choose any other way of [[Page lists|creating page lists]].
|-
| style="width:200px;" data-ve-attributes="{"style":"width:200px;"}" |New Employees
|New Employees
|Template
|Employees can be shown with their user images or custom uploaded images. Links go to the profile page or, alternatively, to a custom wiki page. The template paramaters are described on the [[Templates download/Employee|Employees]] download page.
|}

Startpage templates download/Startpage SME

2026-04-30T09:14:14Z

Bhuber:

<div class="downloadarea">
<span class="getButton">[[Media:Startpage SME.zip|Download]]</span>

[[File:Startpage SME.png|350x350px]]
</div>This template provides a good starting layout for the homepage of the wiki for a small or medium-sized company.
==Importing the template==
{{Templateimport|Startpage SME}}

==Pages included in the import==
The xml import creates the following files in your wiki:

*Help:Startpage SME
*Help:Startpage SME/Bannerbox
*Help:Startpage SME/Contact
*Help:Startpage SME/Iconnav
*Help:Startpage SME/Minutes
*Help:Startpage SME/New Employees
*Help:Startpage SME/News
*Help:Startpage SME/Recent Changes
*Template:Employee
*Template:Employee/styles.css

{{Manual:Startpage templates}}

===Included sections===
{| class="wikitable" style="width: 100%;" data-ve-attributes="{"style":"width: 100%;"}"
! style="width:200px;" data-ve-attributes="{"style":"width:200px;"}" |Section
! Subpage
!Content type
!Description
|-
| style="width:200px;" data-ve-attributes="{"style":"width:200px;"}" | Bannerbox
| Bannerbox
|Template
|The bannerbox parameters are described on the [[Templates download/Banner|Banner template download page]]. '''Note:''' Starting with BlueSpice 4.3, an identical template "Bannerbox" is already preloaded.
|-
| Iconnav
| Iconnav
|Template
| The icon nav uses FontAwesome icons out of the box. The parameters and links to the icon libraries are described on the [[Templates download/Image cards|Image cards download page]]. '''Note:''' Up to BlueSpice 4.2, those are not included as an extension. In this case they have to be replaced with Bootstrap Icons or an external reference to FontAwesome has to be added to MediaWiki:Common.css (if allowed by the security policies of the company).
|-
| style="width:200px;" data-ve-attributes="{"style":"width:200px;"}" |News
|News
|Timeline parser function
|Simple wiki table. To add or remove news, just edit the table.
|-
| style="width:200px;" data-ve-attributes="{"style":"width:200px;"}" |Contacts
|Contact
|Text,

<code><nowiki><profileimage></nowiki></code>-tag
|Content can be edited directly on the page. Double-click on the profile image tag to change the user name for the contact avatar.
|-
|Minutes
|Minutes
|<code><nowiki><inputbox></nowiki></code>-tag, <code><nowiki><dpl></nowiki></code>- tag, subpages query
|The meeting minutes are created via an [[Manual:Extension/InputBox|InputBox]]. They are created as subpages of a ''Minutes'' page in the main namespace.
|-
|Recent Changes
|Recent Changes
|<code><nowiki><smartlist></nowiki></code>-tag
|The [[Manual:Extension/BlueSpiceSmartList|smartlist]] tag is used by default. You can choose any other way of [[Page lists|creating page lists]].
|-
| style="width:200px;" data-ve-attributes="{"style":"width:200px;"}" |New Employees
|New Employees
|Template
|Employees can be shown with their user images or custom uploaded images. Links go to the profile page or, alternatively, to a custom wiki page. The template paramaters are described on the [[Templates download/Employee|Employees]] download page.
|}

Startpage templates download

2026-04-30T09:06:46Z

Bhuber:

<ul class="tabs">
<li>[[Templates download|Templates]]</li>
<li>[[Page templates download|Page Templates]]</li>
<li class="current">Startpage templates</li>
</ul>

See also the general instructions for using the [[Manual:Start page templates|Start page templates]].

__NOTOC__
<div class="cards startpages">

<div>
==[[Startpage templates download/Startpage Management System|Startpage Management System]]==
<div class="box">
<div class="screenshot">[[File:Startpage Management System.png|alt=Screenshot of the "Startpage Management System"|500x500px|link=Startpage templates download/Startpage Management System]]</div>
<div class="text">[[Startpage templates download/Startpage Management System|For management systems]]</div>
</div>
</div>
<div>
==[[Startpage templates download/Startpage SME|Startpage SME]]==
<div class="box">
<div class="screenshot">[[File:Startpage SME.png|alt=Screenshot of the "Startpage SME"|500x500px|link=Startpage templates download/Startpage SME]]</div>
<div class="text">[[Startpage templates download/Startpage SME|For small and medium-sized enterprises]]</div>
</div>
</div>


</div>

File:Startpage SME.zip

2026-04-30T09:06:03Z

Bhuber: Bhuber uploaded a new version of File:Startpage SME.zip

Templates download/Transclusion

2026-04-28T14:12:55Z

Bhuber:

<div class="downloadarea">
<span class="getButton">[[Media:HW-sectiontransclusion.zip|Download]]</span>

[[File:HW-transclusion.png|450x450px]]
</div>This template allows to include a section from a wiki page on another page. It can be styled as a colored box.

== Importing the template ==
The import file is included in the archive file ''HW-transclusion-en.zip''. Unpack the zip file first.

On the page ''Special:Import'' follow these steps:

#'''Select file''' and choose ''HW-sectiontransclusion.xml''.
#'''Enter''' an Interwiki prefix. Since this field is required, simply add ''hw'' (for hallowelt).
#'''Keep''' the selection ''Import to default locations''.
#'''Click''' ''Upload file...'' .

The template is now available in your wiki.

==Pages included in the import==
The xml import creates the following files in your wiki:

*Template:Transclusion
*Template:Transclusion/styles.css

==Using the template==

#Add the template from the [[Manual:Extension/VisualEditor|VisualEditor]] insert-dialog.
#Fill in the form fields as needed.
{{Messagebox|boxtype=note|Note text=If, after importin the template to your wiki, the input fields are not displayed when you first integrate it into a wiki page, you need to open the template in the template namespace, make a change (e.g. insert spaces) and save the template. The input fields should now be displayed correctly.}}

<br />
{| class="contenttable-blue" style="width:950px;"
|+ style="box-sizing: inherit; padding-top: 8px; padding-bottom: 8px; color: rgb(119, 119, 119); text-align: left;" |
! style="background-color:rgb(239, 243, 249);text-align:inherit;box-sizing:inherit;padding:4px;border:1px solid rgb(177, 185, 207);color:rgb(62, 83, 137);" |Input field
! style="background-color:rgb(239, 243, 249);text-align:inherit;box-sizing:inherit;padding:4px;border:1px solid rgb(177, 185, 207);color:rgb(62, 83, 137);" |Description
|- style="box-sizing: inherit; border: 1px solid rgb(177, 185, 207); border-spacing: 0px; border-collapse: collapse; padding: 10px;"
| style="box-sizing:inherit;padding:10px;border:1px solid rgb(177, 185, 207);border-spacing:0px;border-collapse:collapse;" |Page to transclude into this document
| style="box-sizing:inherit;padding:10px;border:1px solid rgb(177, 185, 207);border-spacing:0px;border-collapse:collapse;" |Page name of the page containing the section (including the namespace prefix if the page is not in the main namespace).
|- style="box-sizing: inherit; border: 1px solid rgb(177, 185, 207); border-spacing: 0px; border-collapse: collapse; padding: 10px;"
| style="box-sizing:inherit;padding:10px;border:1px solid rgb(177, 185, 207);border-spacing:0px;border-collapse:collapse;" |Page section
| style="box-sizing:inherit;padding:10px;border:1px solid rgb(177, 185, 207);border-spacing:0px;border-collapse:collapse;" |Heading of the section you want to transclude. If a section contains sub-headings, these are included up to the next heading at the same level of the section.
|- style="box-sizing: inherit; border: 1px solid rgb(177, 185, 207); border-spacing: 0px; border-collapse: collapse; padding: 10px;"
| style="box-sizing:inherit;padding:10px;border:1px solid rgb(177, 185, 207);border-spacing:0px;border-collapse:collapse;" |Color style
| style="box-sizing:inherit;padding:10px;border:1px solid rgb(177, 185, 207);border-spacing:0px;border-collapse:collapse;" |If you want to apply a background color, you can select one here. Choices are: blue, green, grey, red, yellow
|- style="box-sizing: inherit; border: 1px solid rgb(177, 185, 207); border-spacing: 0px; border-collapse: collapse; padding: 10px;"
| style="box-sizing:inherit;padding:10px;border:1px solid rgb(177, 185, 207);border-spacing:0px;border-collapse:collapse;" |Background
| style="box-sizing:inherit;padding:10px;border:1px solid rgb(177, 185, 207);border-spacing:0px;border-collapse:collapse;" |If you don't like any of the color styles, you can [https://www.w3schools.com/colors/colors_picker.asp enter your own color in hex format] (e.g. # cce6ff).
|- style="box-sizing: inherit; border: 1px solid rgb(177, 185, 207); border-spacing: 0px; border-collapse: collapse; padding: 10px;"
| style="box-sizing:inherit;padding:10px;border:1px solid rgb(177, 185, 207);border-spacing:0px;border-collapse:collapse;" |Border
| style="box-sizing:inherit;padding:10px;border:1px solid rgb(177, 185, 207);border-spacing:0px;border-collapse:collapse;" |Creates a border color. Apply only when you use a custom background color instead of the color style (which already uses its own border color).
|- style="box-sizing: inherit; border: 1px solid rgb(177, 185, 207); border-spacing: 0px; border-collapse: collapse; padding: 10px;"
| style="box-sizing:inherit;padding:10px;border:1px solid rgb(177, 185, 207);border-spacing:0px;border-collapse:collapse;" |Padding
| style="box-sizing:inherit;padding:10px;border:1px solid rgb(177, 185, 207);border-spacing:0px;border-collapse:collapse;" |Distance from box to box content. Default value: 20px. You can set this to any other pixel-value or simple enter 0 for now padding.
|}
__NOTOC__

Templates download

2026-04-28T13:52:58Z

Bhuber:

<ul class="tabs">
<li class="current">[[Startpage templates download|Templates]]</li>
<li>[[Page templates download|Page Templates]]</li>
<li>[[Startpage templates download|Startpage templates]]</li>
</ul>
{{Messagebox|boxtype=note|icon=|Note text=These templates use extensions which are included in BlueSpice pro, but not in BlueSpice. These extensions are noted for each template:
* [[Reference:Page_Forms|Page Forms (PF)]]
* [[Reference:Semantic_MediaWiki|Semantic MediaWiki (SMW)]]
* [[Reference:TemplateData|TemplateData (TD)]]|bgcolor=}}
__NOTOC__
<div class="cards">

<div>
==[[Templates download/Calendar|Calendar]]==
<div class="box">
<div class="screenshot">[[File:calendar.png|500x500px|alt=Calendar template|link=Templates download/Calendar]]</div>
<div class="text">[[Templates download/Calendar|Simple event calendar]] (SMW, PF)</div>
</div>
</div>

<div>
==[[Templates download/Collapsible|Collapsible]]==
<div class="box">
<div class="screenshot">[[File:collapsible.png|500x500px|alt=Collapsible page sections|link=Templates download/Collapsible]]</div>
<div class="text">[[Templates download/Collapsible|Collapsible sections]] (PF)</div>
</div>
</div>

<div>
==[[Templates download/Employee|Employee]]==
<div class="box">
<div class="screenshot">[[File:Employees gallery.png|500x500px|alt=Screenshot of the employees gallery|link=Templates download/Employee]]</div>
<div class="text">[[Templates download/Employee|Employees gallery]] (TD)</div>
</div>
</div>

<div>
==[[Templates download/IMS Documents|IMS Documents]]==
<div class="box">
<div class="screenshot">[[File:HW-IMS.png|400x400px|alt=Process descriptions overview page|link=Templates download/IMS Documents]]</div>
<div class="text">[[Templates download/IMS Documents|Document control templates]] (SMW, PF)</div>
</div>
</div>

<div>
==[[Templates download/Risk management|Incidents & Risks]]==
<div class="box">
<div class="screenshot">[[File:RM-riskentry.png|500x500px|alt=Risk entry screenshot|link=Templates download/Risk management]]</div>
<div class="text">[[Templates download/Risk management|Risk registry and incident reports]] (SMW, PF)</div>
</div>
</div>

<div>
==[[Templates download/Meetingtype|Meeting Types]]==
<div class="box">
<div class="screenshot">[[File:Template_Meetingtype_types.png|460x460px|alt=Meeting types|link=Templates download/Meetingtype]]</div>
<div class="text">[[Templates download/Meetingtype|Banner for meeting minutes page templates]]</div>
</div>
</div>

<div>
==[[Templates download/Minutes for teams|Minutes]]==
<div class="box">
<div class="screenshot">[[File:HW-Minutes-en.png|460x460px|alt=Main meeting minutes template|link=Templates download/Minutes for teams]]</div>
<div class="text">[[Templates download/Minutes for teams|Teams-based main template]] (TD)</div>
</div>
</div>

<div>
==[[Templates download/New|New]]==
<div class="box">
<div class="screenshot">[[File:Template_New_View.png|460x460px|alt=Template new view|link=Templates download/New]]</div>
<div class="text">[[Templates download/New|Marking new page content]] (SMW, TD)</div>
</div>
</div>

<div>
==[[Templates download/PortalFlex|Portal]]==
<div class="box">
<div class="screenshot">[[File:HW-PortalFlex-Combo.png|400x400px|alt=Portal page template|link=Templates download/PortalFlex]]</div>
<div class="text">[[Templates download/PortalFlex|Forms-based portal page]] (PF)</div>
</div>
</div>

<div>
==[[Templates download/Process map|Process map]]==
<div class="box">
<div class="screenshot">[[File:HW-process map text-based.png|800x800px|alt=Text-based process map|link=Templates download/Process map]]</div>
<div class="text">[[Templates download/Process map|Text-based process map]] (TD)</div>
</div>
</div>

<div>
==[[Templates download/Project|Project]]==
<div class="box">
<div class="screenshot">[[File:Template_Download_Projects-Projectstartpage.png|300x300px|link=Templates download/Project]]</div>
<div class="text">[[Templates download/Project|Template for a project namespace]] (SMW, PF)</div>
</div>
</div>

<div>
==[[Templates download/SVG|SVG]]==
<div class="box">
<div class="screenshot">[[File:svg-animated.gif|300x300px|link=Templates download/SVG]]</div>
<div class="text">[[Templates download/SVG|Embedded interactive SVG]] (TD, Widgets)</div>
</div>
</div>

<div>
==[[Templates download/Taskboard|Taskboard]]==
<div class="box">
<div class="screenshot">[[File:Template_Download_Taskboard_Style_1.png|alt=view of taskboard style 1|link=Templates download/Taskboard|460x460px]]</div>
<div class="text">[[Templates download/Taskboard|Taskboard]] (SMW, TD)</div>
</div>
</div>

<div>
==[[Templates download/TOClimit|TOC limit]]==
<div class="box">
<div class="screenshot">[[File:template-download-TOClimit.png|alt=TOC limit template|link=Templates download/TOClimit|460x460px]]</div>
<div class="text">[[Templates download/TOClimit|Limit heading levels in TOC]] (TD)</div>
</div>
</div>

<div>
==[[Templates download/Trainingpage|Training page]]==
<div class="box">
<div class="screenshot">[[File:HW-Training-en.png|alt=Training page for internal trainings|link=Templates download/Trainingpage|460x460px]]</div>
<div class="text">[[Templates download/Trainingpage|Self-directed trainings]] (TD)</div>
</div>
</div>

<div>
==[[Templates download/Transclusion|Section transclusion]]==
<div class="box">
<div class="screenshot">[[File:HW-transclusion.png|alt=Transcluded page section|link=Templates download/Transclusion|460x460px]]</div>
<div class="text">[[Templates download/Transclusion|Transclude a page section]] (TD)</div>
</div>
</div>
<div class="emptycard"></div>
</div>

[[de:Vorlagen Download]]

Templates download

2026-04-28T13:47:49Z

Bhuber:

<ul class="tabs">
<li class="current">[[Startpage templates download|Templates]]</li>
<li>[[Page templates download|Page Templates]]</li>
<li>[[Startpage templates download|Startpage templates]]</li>
</ul>
{{Messagebox|boxtype=note|icon=|Note text=These templates use extensions which are included in BlueSpice pro, but not in BlueSpice. These extensions are noted for each template:
* [[Reference:Page_Forms|Page Forms (PF)]]
* [[Reference:Semantic_MediaWiki|Semantic MediaWiki (SMW)]]
* [[Reference:TemplateData|TemplateData (TD)]]|bgcolor=}}
__NOTOC__
<div class="cards">

<div>
==[[Templates download/Calendar|Calendar]]==
<div class="box">
<div class="screenshot">[[File:calendar.png|500x500px|alt=Calendar template|link=Templates download/Calendar]]</div>
<div class="text">[[Templates download/Calendar|Simple event calendar]] (SMW, PF)</div>
</div>
</div>

<div>
==[[Templates download/Collapsible|Collapsible]]==
<div class="box">
<div class="screenshot">[[File:collapsible.png|500x500px|alt=Collapsible page sections|link=Templates download/Collapsible]]</div>
<div class="text">[[Templates download/Collapsible|Collapsible sections]] (PF)</div>
</div>
</div>

<div>
==[[Templates download/Employee|Employee]]==
<div class="box">
<div class="screenshot">[[File:Employees gallery.png|500x500px|alt=Screenshot of the employees gallery|link=Templates download/Employee]]</div>
<div class="text">[[Templates download/Employee|Employees gallery]] (TD)</div>
</div>
</div>

<div>
==[[Templates download/IMS Documents|IMS Documents]]==
<div class="box">
<div class="screenshot">[[File:HW-IMS.png|400x400px|alt=Process descriptions overview page|link=Templates download/IMS Documents]]</div>
<div class="text">[[Templates download/IMS Documents|Document control templates]] (SMW, PF)</div>
</div>
</div>

<div>
==[[Templates download/Risk management|Incidents & Risks]]==
<div class="box">
<div class="screenshot">[[File:RM-riskentry.png|500x500px|alt=Risk entry screenshot|link=Templates download/Risk management]]</div>
<div class="text">[[Templates download/Risk management|Risk registry and incident reports]] (SMW, PF)</div>
</div>
</div>

<div>
==[[Templates download/Meetingtype|Meeting Types]]==
<div class="box">
<div class="screenshot">[[File:Template_Meetingtype_types.png|460x460px|alt=Meeting types|link=Templates download/Meetingtype]]</div>
<div class="text">[[Templates download/Meetingtype|Banner for meeting minutes page templates]]</div>
</div>
</div>

<div>
==[[Templates download/Minutes for teams|Minutes]]==
<div class="box">
<div class="screenshot">[[File:HW-Minutes-en.png|460x460px|alt=Main meeting minutes template|link=Templates download/Minutes for teams]]</div>
<div class="text">[[Templates download/Minutes for teams|Teams-based main template]] (TD)</div>
</div>
</div>

<div>
==[[Templates download/New|New]]==
<div class="box">
<div class="screenshot">[[File:Template_New_View.png|460x460px|alt=Template new view|link=Templates download/New]]</div>
<div class="text">[[Templates download/New|Marking new page content]] (SMW, TD)</div>
</div>
</div>

<div>
==[[Templates download/PortalFlex|Portal]]==
<div class="box">
<div class="screenshot">[[File:HW-PortalFlex-Combo.png|400x400px|alt=Portal page template|link=Templates download/PortalFlex]]</div>
<div class="text">[[Templates download/PortalFlex|Forms-based portal page]] (PF)</div>
</div>
</div>

<div>
==[[Templates download/Process map|Process map]]==
<div class="box">
<div class="screenshot">[[File:HW-process map text-based.png|800x800px|alt=Text-based process map|link=Templates download/Process map]]</div>
<div class="text">[[Templates download/Process map|Text-based process map]] (TD)</div>
</div>
</div>

<div>
==[[Templates download/Project|Project]]==
<div class="box">
<div class="screenshot">[[File:Template_Download_Projects-Projectstartpage.png|300x300px|link=Templates download/Project]]</div>
<div class="text">[[Templates download/Project|Template for a project namespace]] (SMW, PF)</div>
</div>
</div>

<div>
==[[Templates download/SVG|SVG]]==
<div class="box">
<div class="screenshot">[[File:svg-animated.gif|300x300px|link=Templates download/SVG]]</div>
<div class="text">[[Templates download/SVG|Embedded interactive SVG]] (TD, Widgets)</div>
</div>
</div>

<div>
==[[Templates download/Taskboard|Taskboard]]==
<div class="box">
<div class="screenshot">[[File:Template_Download_Taskboard_Style_1.png|alt=view of taskboard style 1|link=Templates download/Taskboard|460x460px]]</div>
<div class="text">[[Templates download/Taskboard|Taskboard]] (SMW, TD)</div>
</div>
</div>

<div>
==[[Templates download/TOClimit|TOC limit]]==
<div class="box">
<div class="screenshot">[[File:template-download-TOClimit.png|alt=TOC limit template|link=Templates download/TOClimit|460x460px]]</div>
<div class="text">[[Templates download/TOClimit|Limit heading levels in TOC]] (TD)</div>
</div>
</div>

<div>
==[[Templates download/Transclusion|Section transclusion]]==
<div class="box">
<div class="screenshot">[[File:HW-transclusion.png|alt=Transcluded page section|link=Templates download/Transclusion|460x460px]]</div>
<div class="text">[[Templates download/Transclusion|Transclude a page section]] (TD)</div>
</div>
</div>
<div class="emptycard"></div>
</div>

[[de:Vorlagen Download]]

Templates download/Taskboard

2026-04-28T13:45:29Z

Bhuber:

<div class="downloadarea">
<span class="getButton">[[Media:HW-Taskboard-en.zip|Download]]</span>

[[File:Template Download Taskboard Style 1.png|alt=Screenshot of a taskboard|450x450px]]
</div>This template creates task boards with up to five columns.

{{Templateimport|HW-Taskboard-en}}

==Create a taskboard==
'''To create a taskboard'''
#'''Create''' an empty wiki page.
#'''Select''' ''Insert'' in the editor toolbar, then choose ''Template''.
#'''Insert''' the ''Taskboard'' template .[[File:Template Download Taskboard-insert.png|center|mini|400x400px]]
#'''Click''' ''Add''.
#'''Click''' ''Insert'' in the dialog box.
{{Textbox|boxtype=important|header=Important!|text=Ignore the options shown in the dialog box. The task board will be defined via a form in the next step.|icon=yes}}
#'''Save''' the page with the empty template. The page will appear blank.<br />
# '''Click''' the edit icon (pencil) on the saved page. The form for creating the task board opens.
# '''Enter''' the topics for your task board columns and activate the corresponding checkbox. A column is only displayed if it is activated. [[File:Template Download Taskboard-settings.png|alternativtext=Form for defining the task board|center|mini|500x500px|Define task board]]
Additional optional settings:
## Background color for each column header
## Color scheme (optionally set to "soft")
## Card color (optionally set to "white")
# '''Save''' the task board. You can now start adding content.

==Create Task Cards==
'''To create a task card:'''
# '''Click''' the plus button in the desired column.
# '''Enter''' the ''task''. <br>Keep the text short, as it will be used to generate the name of a subpage of the task board. The following special characters are not allowed: <code># < > [ ] | { }</code>.
# Optionally, '''enter''' a short description of the task in the ''Content'' field. This will be displayed on the task board. You can add more detailed information later on the task page itself.
# '''Save''' the task. It will be created as a subpage of the task board. Click the task board name to return to the board. Your task will now appear in the corresponding column.
<gallery widths="480" heights="400">
File:Template Download Taskboard Style 1.png|alternativtext=Taskboard mit 5 Spalten und 8 Aufgaben|Task board
File:Template Download Taskboard style 2.png|alternativtext=Style variation of task board with 5 columns and 8 tasks|Style variation
</gallery>

== Task priority and sorting ==
You can assign a priority to each task:

* high: The card is highlighted with a red border and marked with an upward arrow..
* normal: The card has no special formatting.
* low: The card is marked with a downward arrow.

Tasks are sorted first by priority (high, normal, low) and then by last modified date (most recent first).

==Move Tasks==
To move a task to another column, open the task page and select the corresponding topic.

== Pages included in the import==

The xml import creates the following files in your wiki:

* Template:Taskboard
* Template:Taskboard/Infobox
* Template:Taskboard/TaskCard
* Template:Taskboard/addButton
* Template:Taskboard/ask
* Template:Taskboard/colors
* Template:Taskboard/styles.css
* Form:Taskboard
* Form:Taskboard/Infobox
* Property:Taskboard
* Property:Taskboard/Content
* Property:Taskboard/Priority
* Property:Taskboard/Status
* Property:Taskboard/Topic

__NOTOC__

Templates download/Taskboard

2026-04-28T13:43:22Z

Bhuber:

<div class="downloadarea">
<span class="getButton">[[Media:HW-Taskboard-en.zip|Download]]</span>

[[File:Template Download Taskboard Style 1.png|alt=Screenshot of a taskboard|450x450px]]
</div>This template creates task boards with up to five columns.

{{Templateimport|namezip=HW-Taskboard-en|namexml=HW-Taskboard-en}}

==Create a taskboard==
'''To create a taskboard'''
#'''Create''' an empty wiki page.
#'''Select''' ''Insert'' in the editor toolbar, then choose ''Template''.
#'''Insert''' the ''Taskboard'' template .[[File:Template Download Taskboard-insert.png|center|mini|400x400px]]
#'''Click''' ''Add''.
#'''Click''' ''Insert'' in the dialog box.
{{Textbox|boxtype=important|header=Important!|text=Ignore the options shown in the dialog box. The task board will be defined via a form in the next step.|icon=yes}}
#'''Save''' the page with the empty template. The page will appear blank.<br />
# '''Click''' the edit icon (pencil) on the saved page. The form for creating the task board opens.
# '''Enter''' the topics for your task board columns and activate the corresponding checkbox. A column is only displayed if it is activated. [[File:Template Download Taskboard-settings.png|alternativtext=Form for defining the task board|center|mini|500x500px|Define task board]]
Additional optional settings:
## Background color for each column header
## Color scheme (optionally set to "soft")
## Card color (optionally set to "white")
# '''Save''' the task board. You can now start adding content.

==Create Task Cards==
'''To create a task card:'''
# '''Click''' the plus button in the desired column.
# '''Enter''' the ''task''. <br>Keep the text short, as it will be used to generate the name of a subpage of the task board. The following special characters are not allowed: <code># < > [ ] | { }</code>.
# Optionally, '''enter''' a short description of the task in the ''Content'' field. This will be displayed on the task board. You can add more detailed information later on the task page itself.
# '''Save''' the task. It will be created as a subpage of the task board. Click the task board name to return to the board. Your task will now appear in the corresponding column.
<gallery widths="480" heights="400">
File:Template Download Taskboard Style 1.png|alternativtext=Taskboard mit 5 Spalten und 8 Aufgaben|Task board
File:Template Download Taskboard style 2.png|alternativtext=Style variation of task board with 5 columns and 8 tasks|Style variation
</gallery>

== Task priority and sorting ==
You can assign a priority to each task:

* high: The card is highlighted with a red border and marked with an upward arrow..
* normal: The card has no special formatting.
* low: The card is marked with a downward arrow.

Tasks are sorted first by priority (high, normal, low) and then by last modified date (most recent first).

==Move Tasks==
To move a task to another column, open the task page and select the corresponding topic.

== Pages included in the import==

The xml import creates the following files in your wiki:

* Template:Taskboard
* Template:Taskboard/Infobox
* Template:Taskboard/TaskCard
* Template:Taskboard/addButton
* Template:Taskboard/ask
* Template:Taskboard/colors
* Template:Taskboard/styles.css
* Form:Taskboard
* Form:Taskboard/Infobox
* Property:Taskboard
* Property:Taskboard/Content
* Property:Taskboard/Priority
* Property:Taskboard/Status
* Property:Taskboard/Topic

__NOTOC__

Templates download

2026-04-28T12:19:02Z

Bhuber:

<ul class="tabs">
<li class="current">[[Startpage templates download|Templates]]</li>
<li>[[Page templates download|Page Templates]]</li>
<li>[[Startpage templates download|Startpage templates]]</li>
</ul>
{{Messagebox|boxtype=note|icon=|Note text=These templates use extensions which are included in BlueSpice pro, but not in BlueSpice. These extensions are noted for each template:
* [[Reference:Page_Forms|Page Forms (PF)]]
* [[Reference:Semantic_MediaWiki|Semantic MediaWiki (SMW)]]
* [[Reference:TemplateData|TemplateData (TD)]]|bgcolor=}}
__NOTOC__
<div class="cards">

<div>
==[[Templates download/Calendar|Calendar]]==
<div class="box">
<div class="screenshot">[[File:calendar.png|500x500px|alt=Calendar template|link=Templates download/Calendar]]</div>
<div class="text">[[Templates download/Calendar|Simple event calendar]] (SMW, PF)</div>
</div>
</div>

<div>
==[[Templates download/Collapsible|Collapsible]]==
<div class="box">
<div class="screenshot">[[File:collapsible.png|500x500px|alt=Collapsible page sections|link=Templates download/Collapsible]]</div>
<div class="text">[[Templates download/Collapsible|Collapsible sections]] (PF)</div>
</div>
</div>

<div>
==[[Templates download/Employee|Employee]]==
<div class="box">
<div class="screenshot">[[File:Employees gallery.png|500x500px|alt=Screenshot of the employees gallery|link=Templates download/Employee]]</div>
<div class="text">[[Templates download/Employee|Employees gallery]] (TD)</div>
</div>
</div>

<div>
==[[Templates download/IMS Documents|IMS Documents]]==
<div class="box">
<div class="screenshot">[[File:HW-IMS.png|400x400px|alt=Process descriptions overview page|link=Templates download/IMS Documents]]</div>
<div class="text">[[Templates download/IMS Documents|Document control templates]] (SMW, PF)</div>
</div>
</div>

<div>
==[[Templates download/Risk management|Incidents & Risks]]==
<div class="box">
<div class="screenshot">[[File:RM-riskentry.png|500x500px|alt=Risk entry screenshot|link=Templates download/Risk management]]</div>
<div class="text">[[Templates download/Risk management|Risk registry and incident reports]] (SMW, PF)</div>
</div>
</div>

<div>
==[[Templates download/Meetingtype|Meeting Types]]==
<div class="box">
<div class="screenshot">[[File:Template_Meetingtype_types.png|460x460px|alt=Meeting types|link=Templates download/Meetingtype]]</div>
<div class="text">[[Templates download/Meetingtype|Banner for meeting minutes page templates]]</div>
</div>
</div>

<div>
==[[Templates download/Minutes for teams|Minutes]]==
<div class="box">
<div class="screenshot">[[File:HW-Minutes-en.png|460x460px|alt=Main meeting minutes template|link=Templates download/Minutes for teams]]</div>
<div class="text">[[Templates download/Minutes for teams|Teams-based main template]] (TD)</div>
</div>
</div>

<div>
==[[Templates download/New|New]]==
<div class="box">
<div class="screenshot">[[File:Template_New_View.png|460x460px|alt=Template new view|link=Templates download/New]]</div>
<div class="text">[[Templates download/New|Marking new page content]] (SMW, TD)</div>
</div>
</div>

<div>
==[[Templates download/PortalFlex|Portal]]==
<div class="box">
<div class="screenshot">[[File:HW-PortalFlex-Combo.png|400x400px|alt=Portal page template|link=Templates download/PortalFlex]]</div>
<div class="text">[[Templates download/PortalFlex|Forms-based portal page]] (PF)</div>
</div>
</div>

<div>
==[[Templates download/Process map|Process map]]==
<div class="box">
<div class="screenshot">[[File:HW-process map text-based.png|800x800px|alt=Text-based process map|link=Templates download/Process map]]</div>
<div class="text">[[Templates download/Process map|Text-based process map]] (TD)</div>
</div>
</div>

<div>
==[[Templates download/Project|Project]]==
<div class="box">
<div class="screenshot">[[File:Template_Download_Projects-Projectstartpage.png|300x300px|link=Templates download/Project]]</div>
<div class="text">[[Templates download/Project|Template for a project namespace]] (SMW, PF)</div>
</div>
</div>

<div>
==[[Templates download/SVG|SVG]]==
<div class="box">
<div class="screenshot">[[File:svg-animated.gif|300x300px|link=Templates download/SVG]]</div>
<div class="text">[[Templates download/SVG|Embedded interactive SVG]] (TD, Widgets)</div>
</div>
</div>

<div>
==[[Templates download/TOClimit|TOC limit]]==
<div class="box">
<div class="screenshot">[[File:template-download-TOClimit.png|alt=TOC limit template|link=Templates download/TOClimit|460x460px]]</div>
<div class="text">[[Templates download/TOClimit|Limit heading levels in TOC]] (TD)</div>
</div>
</div>

<div>
==[[Templates download/Transclusion|Section transclusion]]==
<div class="box">
<div class="screenshot">[[File:HW-transclusion.png|alt=Transcluded page section|link=Templates download/Transclusion|460x460px]]</div>
<div class="text">[[Templates download/Transclusion|Transclude a page section]] (TD)</div>
</div>
</div>
<div class="emptycard"></div>
</div>

[[de:Vorlagen Download]]

Templates download/Project

2026-04-28T12:16:20Z

Bhuber:

<div class="downloadarea">
<span class="getButton">[[Media:HW-Projects.zip|Download]]</span>

[[File:Template Download Projects-Projectstartpage.png|alt=Screenshot of a project start page|450x450px]]
</div>This template allows small projects to be documented in the wiki.

{{Templateimport|namezip=HW-Projects|namexml=HW-Projects|namespacehint=Project|namespacehint=Project}}
==Create a project==
To create a project:
#'''Go''' to the page <code>Project:Main Page</code>.
#'''Enter''' a project name in the input field for new projects.
#'''Click''' ''New Project''.
[[File:Template Download Projects-Projectstartpage.png|alternativtext=Project main page with input field for a new project|center|mini|650x650px|Create a project]]

The project data entry form opens.

Fill in the form fields. All fields are optional.
{| class="wikitable"
|+
!Field
!Description
|-
!Projectmanagement
|Username
|-
!Projectteam
|Multiple selection of usernames
|-
!Project ID
|Custom ID number
|-
!Status
|Selection of the current project status (planned, active, completed, cancelled)
|}

== Edit the project page ==
[[File:Template Download Projects Project page.png|alternativtext=Project page with default content after page creation and four highlighted editing options|center|mini|850x850px|Project page]]
'''The project's main page offers four editing options:'''

# Edit page: Here you can edit your project information below the template using the visual editor.
# Edit project data: Here you can update the project data (e.g., the status) via the form.
# Create new subpages for supporting project informatoin (referred to here as "Documents").
# Create new subpages for logs.

==Create new subpages for "Documents"==
'''To create project-related documents as subpages:'''

# '''Click''' ''Create Page'' in the "Documents" box. A form opens with the prefilled path "Document".
# '''Click''' ''Save Page'' without making any changes.
The newly created overview page for documents opens. From there, you can create additional subpages using the input field.

=== Page templates for documents===
DSince pages of the generic type “Document” can contain a wide variety of information, no default page template is generated. However, if you have enabled the “Page templates” feature for the “Project” namespace in the namespace management, you can provide your own templates via the [[Manual:Extension/BlueSpicePageTemplates|page template managemer]].

== Create new Minutes==
'''To create project-related minutes or meetingn notes as subpages:'''

# '''Click''' ''Create Page'' in the "Minutes/Meeting Notes" box. A form opens with the prefilled path "Minutes/Meeting notes".
# '''Click''' ''Save Page'' without making any changes.

The newly created overview page for logs opens. From there, you can create additional subpages using the input field.

=== Page templates for minutes ===
By default, the page template “Template:PT Minutes” is loaded for minutes. You can customize this template according to your needs.

== Navigation ==
[[File:Template Download projects breadcrumb.png|alternativtext=Example of a breadcrumb navigation in the "Project" namespace|center|mini|550x550px|Breadcrumb navigation]]

'''Use the breadcrumb navigation to quickly jump to:'''

* the project's main page by clicking the project name.
* the overview of all projects by clicking the colored namespace label.

== Pages included in the import==
The xml import creates the following files in your wiki:

*Project:Main Page
*Project:Tools
*Template:Projectinfo
*Template:Projectinfo/styles.css
*Template:Projectinfo/Document
*Template:Projectinfo/Documents
*Template:Projectinfo/List format
*Template:Projectinfo/Recent Changes
*Template:Projectinfo/Subpagename
*Template:PT Minutes
*Template:TOClimit
*TemplateTOClimit/styles.css
*Form:Projectinfo
*Form:Projectinfo/Document
*Form:Projectinfo/Documents
*Property:Is Project
*Property:Project/Management
*Property:Project/Status
*Property:Project/Team
__NOTOC__

Template:Templateimport

2026-04-28T12:10:27Z

Bhuber:

<templatestyles src="Templateimport/styles.css" />
<div class="templateimport">
== Importing the template ==
The import file is included in the archive file ''{{{1|}}}.zip''. Unpack the zip file first.

{{#if:{{{namespacehint|}}}|{{Textbox|boxtype=important|header=Prerequisite:|text=Before importing the template into your wiki, make sure that you have created the [[Manual:Extension/BlueSpiceNamespaceManager|namespace]] "{{{namespacehint|}}}".|icon=yes}} }}

On the page ''Special:Import'' follow these steps:

#'''Select file''' and choose ''{{{1|}}}.xml''.
#'''Enter''' an Interwiki prefix. Since this field is required, simply add ''hw'' (for hallowelt).
#'''Keep''' the selection ''Import to default locations''.
#'''Click''' ''Upload file...'' .

The template is now available in your wiki.</div>
<noinclude>
<templatedata>
{
"params": {
"1": {
"label": "name of xml (needs to be the same as the zip file).",
"required": true
}
},
"paramOrder": [
"1"
]
}
</templatedata>
</noinclude>

Template:Templateimport

2026-04-28T12:10:01Z

Bhuber:

<templatestyles src="Vorlagenimport/styles.css" />
<div class="templateimport">
== Importing the template ==
The import file is included in the archive file ''{{{1|}}}.zip''. Unpack the zip file first.

{{#if:{{{namespacehint|}}}|{{Textbox|boxtype=important|header=Prerequisite:|text=Before importing the template into your wiki, make sure that you have created the [[Manual:Extension/BlueSpiceNamespaceManager|namespace]] "{{{namespacehint|}}}".|icon=yes}} }}

On the page ''Special:Import'' follow these steps:

#'''Select file''' and choose ''{{{1|}}}.xml''.
#'''Enter''' an Interwiki prefix. Since this field is required, simply add ''hw'' (for hallowelt).
#'''Keep''' the selection ''Import to default locations''.
#'''Click''' ''Upload file...'' .

The template is now available in your wiki.</div>
<noinclude>
<templatedata>
{
"params": {
"1": {
"label": "name of xml (needs to be the same as the zip file).",
"required": true
}
},
"paramOrder": [
"1"
]
}
</templatedata>
</noinclude>

Template:Templateimport/styles.css

2026-04-28T12:08:45Z

Bhuber: Created page with ".templateimport .cd-textbox { display: flex; clear: none; width:auto; }"

.templateimport .cd-textbox {
display: flex;
clear: none;
width:auto;
}

Templates download/Project

2026-04-28T12:07:59Z

Bhuber:

<div class="downloadarea">
<span class="getButton">[[Media:HW-Projects.zip|Download]]</span>

[[File:Template Download Projects-Projectstartpage.png|alt=Screenshot of a project start page|450x450px]]
</div>This template allows small projects to be documented in the wiki.

{{Templateimport|namezip=HW-Projects|namexml=HW-Projects|namespacehint=Project|namespacehint=Project}}

==Create a project==
To create a project:
#'''Go''' to the page <code>Project:Main page</code>.
#'''Enter''' a project name in the input field for new projects.
#'''Click''' ''New Project''.
[[File:Template Download Projects-Projectstartpage.png|alternativtext=Project main page with input field for a new project|center|mini|650x650px|Create a project]]

The project data entry form opens.

Fill in the form fields. All fields are optional.
{| class="wikitable"
|+
!field
!description
|-
!Projectmanagement
|Username
|-
!Projectteam
|Multiple selection of usernames
|-
!Project ID
|Custom ID number
|-
!Status
|Selection of the current project status (planned, active, completed, cancelled)
|}

== Edit the project page ==
[[File:Template Download Projects Project page.png|alternativtext=Project page with default content after page creation and four highlighted editing options|center|mini|850x850px|Project page]]
'''The project's main page offers four editing options:'''

# Edit page: Here you can edit your project information below the template using the visual editor.
# Edit project data: Here you can update the project data (e.g., the status) via the form.
# Create new subpages for supporting project informatoin (referred to here as "Documents").
# Create new subpages for logs.

==Create new subpages for "Documents"==
'''To create project-related documents as subpages:'''

# '''Click''' ''Create Page'' in the "Documents" box. A form opens with the prefilled path "Document".
# '''Click''' ''Save Page'' without making any changes.
The newly created overview page for documents opens. From there, you can create additional subpages using the input field.

=== Page templates for documents===
DSince pages of the generic type “Document” can contain a wide variety of information, no default page template is generated. However, if you have enabled the “Page templates” feature for the “Project” namespace in the namespace management, you can provide your own templates via the [[Manual:Extension/BlueSpicePageTemplates|page template managemer]].

== Create new Minutes==
'''To create project-related minutes or meetingn notes as subpages:'''

# '''Click''' ''Create Page'' in the "Minutes/Meeting Notes" box. A form opens with the prefilled path "Minutes/Meeting notes".
# '''Click''' ''Save Page'' without making any changes.

The newly created overview page for logs opens. From there, you can create additional subpages using the input field.

=== Page templates for minutes ===
By default, the page template “Template:PT Minutes” is loaded for minutes. You can customize this template according to your needs.

== Navigation ==
[[File:Template Download projects breadcrumb.png|alternativtext=Example of a breadcrumb navigation in the "Project" namespace|center|mini|550x550px|Breadcrumb navigation]]

'''Use the breadcrumb navigation to quickly jump to:'''

* the project's main page by clicking the project name.
* the overview of all projects by clicking the colored namespace label.

== Pages included in the import==
The xml import creates the following files in your wiki:

*Project:Main page
*Project:Tools
*Template:Projectinfo
*Template:Projectinfo/styles.css
*Template:Projectinfo/Dokument
*Template:Projectinfo/Dokumente
*Template:Projectinfo/Letzte Änderungen
*Template:Projectinfo/Listenformat
*Template:Projectinfo/Subpagename
*Template:PT Minutes
*Template:TOClimit
*TemplateTOClimit/styles.css
*Form:Projectinfo
*Form:Projectinfo/Document
*Form:Projectinfo/Documents
*Property:Is Project
*Property:Project/Management
*Property:Project/Status
*Property:Project/Team
__NOTOC__

Template:Templateimport

2026-04-28T12:07:35Z

Bhuber:

== Importing the template ==
The import file is included in the archive file ''{{{1|}}}.zip''. Unpack the zip file first.

{{#if:{{{namespacehint|}}}|{{Textbox|boxtype=important|header=Prerequisite:|text=Before importing the template into your wiki, make sure that you have created the [[Manual:Extension/BlueSpiceNamespaceManager|namespace]] "{{{namespacehint|}}}".|icon=yes}} }}

On the page ''Special:Import'' follow these steps:

#'''Select file''' and choose ''{{{1|}}}.xml''.
#'''Enter''' an Interwiki prefix. Since this field is required, simply add ''hw'' (for hallowelt).
#'''Keep''' the selection ''Import to default locations''.
#'''Click''' ''Upload file...'' .

The template is now available in your wiki.
<noinclude>
<templatedata>
{
"params": {
"1": {
"label": "name of xml (needs to be the same as the zip file).",
"required": true
}
},
"paramOrder": [
"1"
]
}
</templatedata>
</noinclude>