BlueSpice Helpdesk - Recent changes [en]

Manual:Admin Manual Introduction

Margit.link-rodrigue — Thu, 11 Jun 2026 14:20:03 GMT

← Older revision		Revision as of 14:20, 11 June 2026
Line 1:		Line 1:
	~~<bookshelf src="Book:Admin manual" />~~
	[[File:Manual:illustration-admin.png\|alt=illustration collage admin theme\|right\|450x450px]]		[[File:Manual:illustration-admin.png\|alt=illustration collage admin theme\|right\|450x450px]]
	==Wiki administration made easy==		==Wiki administration made easy==

Reference:UnifiedTaskOverview

Margit.link-rodrigue — Thu, 11 Jun 2026 13:11:40 GMT

← Older revision		Revision as of 13:11, 11 June 2026
Line 1:		Line 1:
	{{~~BSExtensionInfobox~~		{{BSExtensionInfo
	\|desc=Provides the special page "My tasks"		\|desc=Provides the special page "My tasks"
	\|status=stable		\|status=stable
Line 7:		Line 7:
	\|compatible=MediaWiki		\|compatible=MediaWiki
	\|category=Personalization		\|category=Personalization
	}}		\|features=
	The new overview page “My Tasks” (Special:My_tasks) allows users to view their upcoming tasks in the wiki. The special page can be reached via the [[Manual:Extension/BlueSpiceDiscovery#Header bar\|user menu]] under ''Personal Tools> Tasks''.		The new overview page “My Tasks” (Special:My_tasks) allows users to view their upcoming tasks in the wiki. The special page can be reached via the [[Manual:Extension/BlueSpiceDiscovery#Header bar\|user menu]] under ''Personal Tools> Tasks''.

Line 15:		Line 15:
	*Each task card leads to the wiki page that is linked to the task.		*Each task card leads to the wiki page that is linked to the task.
	[[File:my tasks.png\|alt=Special page "My tasks"\|center\|thumb\|650x650px\|Special page "My tasks"]]		[[File:my tasks.png\|alt=Special page "My tasks"\|center\|thumb\|650x650px\|Special page "My tasks"]]
			}}

Reference:StandardDialogs

Margit.link-rodrigue — Thu, 11 Jun 2026 12:58:45 GMT

← Older revision		Revision as of 12:58, 11 June 2026
(One intermediate revision by the same user not shown)
Line 1:		Line 1:
	{{~~BSExtensionInfobox~~		{{BSExtensionInfo
	\|~~desc~~=~~Provides dialog user interfaces for common page actions.~~		\|removed=No
	\|status=stable		\|status=stable
	\|developer=Hallo Welt!		\|developer=Hallo Welt!
Line 7:		Line 7:
	\|compatible=BlueSpice		\|compatible=BlueSpice
	\|category=Skinning		\|category=Skinning
			\|features=This extension provides dialogs for various actions, including:

			* Delete
			* Move
			* Protect
			* Refresh
			* New page
			* New subpage
			\|desc=Provides dialog user interfaces for common page actions.
	\|license=GPL v3+		\|license=GPL v3+
	}}		}}

Manual:Extension

Margit.link-rodrigue — Wed, 10 Jun 2026 10:28:25 GMT

Blanked the page

← Older revision		Revision as of 10:28, 10 June 2026
Line 1:		Line 1:
	~~{{Special:PrefixIndex/{{FULLPAGENAME}}/ \|hideredirects=1 \|stripprefix=1}}~~

MediaWiki:Hf-nsheader-Manual

Margit.link-rodrigue — Wed, 10 Jun 2026 10:27:47 GMT

← Older revision		Revision as of 10:27, 10 June 2026
(12 intermediate revisions by the same user not shown)
Line 1:		Line 1:
	<!-- {{WCAGNoteForEditors}} -->		<!-- {{WCAGNoteForEditors}} -->
	~~<!-- {{#ifeq:\|Extension\|~~<div class="hf-navbox">		<div class="hf-navbox">
	<div class="hf-nav" aria-role="navigation" aria-label="~~Unterseiten~~" >{{#ifeq:{{SUBPAGENAME}}\|{{PAGENAME}}\|\| ← [[{{NAMESPACE}}:{{BASEPAGENAME}}\|{{BASEPAGENAME}}]]}}		<div class="hf-nav" aria-role="navigation" aria-label="subpages" >{{#ifeq:{{SUBPAGENAME}}\|{{PAGENAME}}\|\| ← [[{{NAMESPACE}}:{{BASEPAGENAME}}\|{{BASEPAGENAME}}]]}}
	<div class="hf-subpages">{{#subpages:kidsonly=yes\|default=<span class="default">~~ ~~</span>}}		<div class="hf-subpages">{{#subpages:kidsonly=yes\|default=<span class="default">no subpages</span>}}
	</div></div></div~~>}} --~~>		</div></div></div>

Manual:Extension/Forms/5.1.1

Margit.link-rodrigue — Wed, 10 Jun 2026 09:51:28 GMT

← Older revision		Revision as of 09:51, 10 June 2026
(One intermediate revision by the same user not shown)
Line 1:		Line 1:
			{{Textbox\|boxtype=note\|header=Compatibility:\|text=The instructions on this page apply to '''Bluespice 5.1.1-5.1.7'''. In version 5.1.8 it is possible to create the page name dynamically from form field variables. For these newer versions, follow the [[Manual:Extension/Forms\|5.1.8+ instructions]].\|icon=yes}}

	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.		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.

Line 85:		Line 87:
	</syntaxhighlight>		</syntaxhighlight>
	[[File:Manual:forms-css-inlinestyling-en.png\|alt=Inline styling of a form element\|center\|thumb\|650x650px\|Inline styling of a form element]]		[[File:Manual:forms-css-inlinestyling-en.png\|alt=Inline styling of a form element\|center\|thumb\|650x650px\|Inline styling of a form element]]
	~~{{translation}}~~		[[de:Handbuch:Erweiterung/Forms/5.1.1]]

Manual:Extension/Forms/Form elements and settings

Margit.link-rodrigue — Wed, 10 Jun 2026 09:30:12 GMT

← Older revision		Revision as of 09:30, 10 June 2026
Line 361:		Line 361:
	\|calls a function when the event occurs;		\|calls a function when the event occurs;
	see the [[Manual:Extension/Forms/Progress bar\|progress bar]] example.		see the [[Manual:Extension/Forms/Progress bar\|progress bar]] example.
	\|~~}{{translation}~~}		\|}
	~~__FORCETOC__~~		[[de:Handbuch:Erweiterung/Forms/Formularelemente]]

Manual:Extension/Forms

Margit.link-rodrigue — Wed, 10 Jun 2026 09:27:58 GMT

← Older revision		Revision as of 09:27, 10 June 2026
(One intermediate revision by the same user not shown)
Line 1:		Line 1:
			{{Textbox\|boxtype=note\|header=Compatibility:\|text=The instructions on this page apply to '''Bluespice 5.1.8+'''. In versions 5.1.x-5.1.7 it was not possible to create the page name dynamically from form field variables. For these versions, follow the [[/5.1.1\|5.1.1 instructions]].\|icon=yes}}

	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.		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.

Manual:Extension/PDFCreator

Margit.link-rodrigue — Wed, 10 Jun 2026 09:10:07 GMT

Show changes

File:PDF Print Example-originalCSS.pdf

Margit.link-rodrigue — Wed, 10 Jun 2026 09:07:26 GMT

Editorial Staff uploaded File:PDF Print Example-originalCSS.pdf

New page

File:PDF Print Example-customCSS.pdf

Margit.link-rodrigue — Wed, 10 Jun 2026 09:07:26 GMT

Editorial Staff uploaded File:PDF Print Example-customCSS.pdf

New page

MediaWiki:PDFCreator/StandardPDFOriginal

Margit.link-rodrigue — Wed, 10 Jun 2026 08:06:37 GMT

Update pdf template

New page

Manual:Extension/PDFCreator

Margit.link-rodrigue — Tue, 09 Jun 2026 14:30:23 GMT

← Older revision		Revision as of 14:30, 9 June 2026
Line 236:		Line 236:

	=== Adjust logo size ===		=== Adjust logo size ===
	The template does not resize the logo automatically. To scale it, you can try to add a custom height to the styles. Find the following ~~style declaration~~ and overwrite it. Alternatively, you can add this ~~declaration~~ at the end of your styles. <syntaxhighlight lang="css">		The template does not resize the logo automatically. To scale it, you can try to add a custom height to the styles. Find the following rule and overwrite it. Alternatively, you can add this rule at the end of your styles. <syntaxhighlight lang="css">
			/* Logo in Kopfzeile positionieren */
	.pdfcreator-runningheaderfix > table .pdfcreator-runningheader-logo img {		.pdfcreator-runningheaderfix > table .pdfcreator-runningheader-logo img {
	width: auto!important;		width: auto!important;
	height: ~~0.8cm~~!important;		height: 1cm!important;
			margin-top: 0.5cm;
	}		}
	</syntaxhighlight>After saving your change, do a test print. Go back to your "Styles" tab and adjust the logo height as needed.		</syntaxhighlight>After saving your change, do a test print. Go back to your "Styles" tab and adjust the logo height as needed.
Line 331:		Line 332:
	.pdfcreator-page-content pre,		.pdfcreator-page-content pre,
	.pdfcreator-page-content p {		.pdfcreator-page-content p {
	font-size:~~9pt~~;		font-size:9.5pt;
	color:#000000;		color:#000000;
	}</syntaxhighlight>		}</syntaxhighlight>
Line 345:		Line 346:

	<syntaxhighlight lang="css">		<syntaxhighlight lang="css">
			/* smaller bullet points in bullet lists */
	.pdfcreator-page-content ul {		.pdfcreator-page-content ul {
	list-style-type: none !important;		list-style-type: none !important;
Line 361:		Line 363:
	left: -1em;		left: -1em;
	font-size: 1em; /* fully controllable */		font-size: 1em; /* fully controllable */
			}
			.pdfcreator-page-content .toc ul li::before {
			content: ""; /* suppress bullet points in TOC */
			}
			</syntaxhighlight>

			=== Text in Codeblock verkleinern ===
			<syntaxhighlight lang="css">
			/* reduce font size in syntaxhighlight code blocks */
			.mw-highlight pre {
			font-size:8.5pt;
			line-height:1.5em;
	}		}
	</syntaxhighlight>		</syntaxhighlight>
Line 367:		Line 381:
	The font used for PDF export is DejaVu Sans.		The font used for PDF export is DejaVu Sans.

	It is currently not possible to specify a custom font for PDF printing (BlueSpice cloud). On-premise installations may be able to store a customer font and add a configuration on the server		It is currently not possible to specify a custom font for PDF printing (BlueSpice cloud). On-premise installations may be able to store a customer font and add a configuration on the server. The adjustment of the PDF font is expected for BlueSpice {{Bsvs\|bsvFrom=5.3}}.

	== Tips for preparing content for the PDF export ==		== Tips for preparing content for the PDF export ==

Security:Security Advisories

Rvogel1 — Mon, 08 Jun 2026 09:06:59 GMT

← Older revision		Revision as of 09:06, 8 June 2026
Line 6:		Line 6:
	! style="" \|Summary		! style="" \|Summary
	!Severity		!Severity
			\|-
			\|[[Security:Security Advisories/BSSA-2026-03\|BSSA-2026-03]]
			\|2026-06-08
			\|Security vulnerabilities in containers of the Cloudogu stack
			\|[https://nvd.nist.gov/vuln/detail/CVE-2026-31789 CVE-2026-31789], [https://nvd.nist.gov/vuln/detail/CVE-2026-43512 CVE-2026-43512], [https://nvd.nist.gov/vuln/detail/CVE-2026-7261 CVE-2026-7261]
			\|Heap buffer overflow in OpenSSL, Apache Tomcat DIGEST authentication bypass and PHP SOAP server session persistence vulnerability
			\| style="" class="col-green-bg" \|Low
	\|-		\|-
	\|[[Security:Security Advisories/BSSA-2026-02\|BSSA-2026-02]]		\|[[Security:Security Advisories/BSSA-2026-02\|BSSA-2026-02]]

Security:Security Advisories/BSSA-2026-03

Rvogel1 — Mon, 08 Jun 2026 09:02:50 GMT

← Older revision		Revision as of 09:02, 8 June 2026
Line 21:		Line 21:
	* [https://nvd.nist.gov/vuln/detail/CVE-2026-43512 CVE-2026-43512]		* [https://nvd.nist.gov/vuln/detail/CVE-2026-43512 CVE-2026-43512]
	* [https://nvd.nist.gov/vuln/detail/CVE-2026-7261 CVE-2026-7261]		* [https://nvd.nist.gov/vuln/detail/CVE-2026-7261 CVE-2026-7261]
	\|-
	~~\|Validated by~~
	~~\|RV, FS~~
	\|}		\|}

Line 32:		Line 29:
	!'''Type of vulnerability'''		!'''Type of vulnerability'''
	!'''BlueSpice 5'''		!'''BlueSpice 5'''
	~~!'''BlueSpice 4'''~~
	\|-		\|-
	\|CVE-2026-31789		\|CVE-2026-31789
	\|<code>hallowelt/bluespice-mathoid</code>, <code>hallowelt/bluespice-collabpadsbackend</code>, <code>hallowelt/mongodb</code>		\|<code>hallowelt/bluespice-mathoid</code>, <code>hallowelt/bluespice-collabpadsbackend</code>, <code>hallowelt/mongodb</code>
	\|Heap Buffer Overflow (OpenSSL, 32-bit only)		\|Heap Buffer Overflow (OpenSSL, 32-bit only)
	~~\| style="" class="col-green-bg" \|not affected~~
	\| style="" class="col-green-bg" \|not affected		\| style="" class="col-green-bg" \|not affected
	\|-		\|-
Line 43:		Line 38:
	\|<code>hallowelt/bluespice-pdfrenderer</code>, <code>hallowelt/drawio</code>		\|<code>hallowelt/bluespice-pdfrenderer</code>, <code>hallowelt/drawio</code>
	\|Authentication Bypass (Apache Tomcat DIGEST)		\|Authentication Bypass (Apache Tomcat DIGEST)
	~~\| style="" class="col-green-bg" \|not affected~~
	\| style="" class="col-green-bg" \|not affected		\| style="" class="col-green-bg" \|not affected
	\|-		\|-
Line 49:		Line 43:
	\|<code>hallowelt/bluespice</code>		\|<code>hallowelt/bluespice</code>
	\|PHP SOAP Server Session Persistence		\|PHP SOAP Server Session Persistence
	~~\| style="" class="col-green-bg" \|not affected~~
	\| style="" class="col-green-bg" \|not affected		\| style="" class="col-green-bg" \|not affected
	\|}		\|}

Security:Security Advisories/BSSA-2026-03

Rvogel1 — Mon, 08 Jun 2026 09:00:07 GMT

Created page with "{| class="wikitable" |+ ! ! |- |Date |2026-06-08 |- |Severity |reported "medium/high", BlueSpice assessment: '''not affected''' |- |Affected |Cloudogu Container Images (library present, not exploitable) |- |Fixed in |Next regular update |- |CVE | * [https://nvd.nist.gov/vuln/detail/CVE-2026-31789 CVE-2026-31789] * [https://nvd.nist.gov/vuln/detail/CVE-2026-43512 CVE-2026-43512] * [https://nvd.nist.gov/vuln/detail/CVE-2026-7261 CVE-2026-7261] |- |Validated by |RV, FS |}..."

New page

{| class="wikitable"
|+
!
!
|-
|Date
|2026-06-08
|-
|Severity
|reported "medium/high", BlueSpice assessment: '''not affected'''
|-
|Affected
|Cloudogu Container Images (library present, not exploitable)
|-
|Fixed in
|Next regular update
|-
|CVE
|
* [https://nvd.nist.gov/vuln/detail/CVE-2026-31789 CVE-2026-31789]
* [https://nvd.nist.gov/vuln/detail/CVE-2026-43512 CVE-2026-43512]
* [https://nvd.nist.gov/vuln/detail/CVE-2026-7261 CVE-2026-7261]
|-
|Validated by
|RV, FS
|}

==Problem==
{| class="wikitable"
!'''CVE'''
!'''Component'''
!'''Type of vulnerability'''
!'''BlueSpice 5'''
!'''BlueSpice 4'''
|-
|CVE-2026-31789
|<code>hallowelt/bluespice-mathoid</code>, <code>hallowelt/bluespice-collabpadsbackend</code>, <code>hallowelt/mongodb</code>
|Heap Buffer Overflow (OpenSSL, 32-bit only)
| style="" class="col-green-bg" |not affected
| style="" class="col-green-bg" |not affected
|-
|CVE-2026-43512
|<code>hallowelt/bluespice-pdfrenderer</code>, <code>hallowelt/drawio</code>
|Authentication Bypass (Apache Tomcat DIGEST)
| style="" class="col-green-bg" |not affected
| style="" class="col-green-bg" |not affected
|-
|CVE-2026-7261
|<code>hallowelt/bluespice</code>
|PHP SOAP Server Session Persistence
| style="" class="col-green-bg" |not affected
| style="" class="col-green-bg" |not affected
|}

==Impact assessment==
{| class="wikitable" style="width: 100%;"
!CVE
!Assessment
!Mitigation without update
|-
| style="vertical-align:middle;text-align:left;" |CVE-2026-31789
| style="vertical-align:middle;text-align:left;" class="col-green-bg" |Not affected. The vulnerability only applies to 32-bit platforms. Additionally, the way OpenSSL is used in the affected container images does not expose any exploitable attack surface.
| style="vertical-align:middle;text-align:left;" |No action required.
|-
| style="vertical-align:middle;text-align:left;" |CVE-2026-43512
| style="vertical-align:middle;text-align:left;" class="col-green-bg" |Not affected. Neither <code>bluespice-pdfrenderer</code> nor <code>drawio</code> use DIGEST authentication. Access to both services is anonymous by design.
| style="vertical-align:middle;text-align:left;" |No action required.
|-
| style="vertical-align:middle;text-align:left;" |CVE-2026-7261
| style="vertical-align:middle;text-align:left;" class="col-green-bg" |Not affected. BlueSpice does not use a PHP SOAP server, and the affected <code>SOAP_PERSISTENCE_SESSION</code> setting is not in use.
| style="vertical-align:middle;text-align:left;" |No action required.
|}

== Solution ==
No immediate action required. The affected libraries will be updated in the next regular release.

Manual:Extension/Forms/5.1.8

Bhuber — Wed, 03 Jun 2026 13:07:24 GMT

← Older revision		Revision as of 13:07, 3 June 2026
Line 43:		Line 43:
	*'''Target type:''' Email		*'''Target type:''' Email
	*'''Recipient:''' Possible recipients must have been configured on the server for security reasons. Example:		*'''Recipient:''' Possible recipients must have been configured on the server for security reasons. Example:
	<syntaxhighlight lang="~~text~~">		<syntaxhighlight lang="php" line="1">
	$wgFormsTargetEMailRecipients = [		$wgFormsTargetEMailRecipients = [
			'Marketing' => "marketing@example.com",
	'Marketing' => "marketing@example.com",		'Administration' => 'WikiSysop'

	'Administration' => 'WikiSysop'

	];		];
	</syntaxhighlight>		</syntaxhighlight>
Line 58:		Line 55:


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

Manual:Extension/Forms

Bhuber — Wed, 03 Jun 2026 12:21:21 GMT

← Older revision		Revision as of 12:21, 3 June 2026
Line 46:		Line 46:
	*'''Target type:''' Email		*'''Target type:''' Email
	*'''Recipient:''' Possible recipients must have been configured on the server for security reasons. Example:		*'''Recipient:''' Possible recipients must have been configured on the server for security reasons. Example:
	<syntaxhighlight lang="~~text~~">		<syntaxhighlight lang="php">
	$wgFormsTargetEMailRecipients = [		$wgFormsTargetEMailRecipients = [
			'Marketing' => "marketing@example.com",
	'Marketing' => "marketing@example.com",		'Administration' => 'WikiSysop'

	'Administration' => 'WikiSysop'

	];		];
	</syntaxhighlight>		</syntaxhighlight>

Manual:Extension/Forms/Form elements and settings

Bhuber — Tue, 02 Jun 2026 07:42:47 GMT

Show changes

Manual:Extension/Forms/5.1.8

Bhuber — Mon, 01 Jun 2026 14:39:31 GMT

← Older revision		Revision as of 14:39, 1 June 2026
Line 66:		Line 66:
	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.		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.		*'''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		*'''Target type''': Template
	*'''Template''': Name of the existing template used for page generation		*'''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>		*'''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>		<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.
	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==		==Adjust the styling==

File:Manual:Template Target.jpg

Bhuber — Mon, 01 Jun 2026 14:38:49 GMT

Bettina Huber uploaded File:Manual:Template Target.jpg

New page

Template Target

Manual:Extension/Forms/5.1.8

Bhuber — Mon, 01 Jun 2026 12:48:17 GMT

← Older revision		Revision as of 12:48, 1 June 2026
(2 intermediate revisions by the same user not shown)
Line 62:		Line 62:
	</syntaxhighlight>		</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==		==Adjust the styling==

Manual:Extension/Forms/Progress bar

Bhuber — Mon, 01 Jun 2026 09:39:30 GMT

← Older revision		Revision as of 09:39, 1 June 2026
(7 intermediate revisions by the same user not shown)
Line 1:		Line 1:
	The progress bar is ~~useful~~ to ~~count completed~~ checklist ~~items~~, for ~~example. It calculates completion based on selected options~~.		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 ==		== Adding a progress bar ==
	~~We add~~ a progress bar to a checklist ~~that shows how many tasks have been completed~~.		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]]		[[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:		To recreate this form, the following components are required:

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

	=== Provide the logic in ''MediaWiki:Common.js'' ===		=== Provide the logic in ''MediaWiki:Common.js'' ===
Line 41:		Line 41:
	</syntaxhighlight>On line 5, you define the prefix for each checkbox that should be included in the progress count:<syntaxhighlight lang="javascript">		</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]		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~~:		</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-"]]		[[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">		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-' ) ) {		if ( !name.startsWith( 'checkbox_multi-' ) ) {
	</syntaxhighlight>		</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 ===		=== Apply the syntax to the checklist items ===
Line 84:		Line 88:
	<br>		<br>
	<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>~~		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>
	~~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">
			=== 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",		"title": "Example Progress Bar",