Jump to content

Extension:Checklists

From mediawiki.org
MediaWiki extensions manual
Checklists
Release status: stable
Description This extension defines a checkbox item
Author(s) Hallo Welt! GmbH
Maintainer(s) Hallo Welt! GmbH
Latest version -
Compatibility policy For every MediaWiki release that is a Long Term Support release there is a corresponding branch in the extension.
MediaWiki 1.43 (LTS)
Licence GNU General Public License 3.0 only
Download
Translate the Checklists extension if it is available at translatewiki.net
 Community Forum

This extension provides persistent, interactive checklist items on a wiki page.

Features

[edit]
  • Checklist items are embedded directly in the page content and edited using standard wiki markup.
  • Changes to checklist states are recorded in the page history if they were made in view-mode.
  • Modification of checklist states can be restricted using a dedicated user right.

Usage

[edit]

As checklist item will be considered:

  • A line that starts with [] (or [x] for checked items) and ends with a new line. Therefore, the text of the checkbox item is everything after [] until the new line.

Compatibility with other extensions

[edit]

This extension is used in combination with Extension:AtMentions and Extension:DateTimeTools in Extension:SimpleTasks to add task assignment and due date functionality.


Installation

[edit]
{
	"repositories": [
		{
			"type": "vcs",
			"url": "https://github.com/wikimedia/mediawiki-extensions-Checklists.git"
		}
	],
	"require": {
		"mediawiki/Checklists": "dev-REL1_43"
	}
}
  • Run the following command in your MediaWiki installation path
composer update --no-dev
wfLoadExtension( 'Checklists' );
  • Yes Done Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
[edit]
Bluespice icon

This extension was originally made for BlueSpice . BlueSpice is a MediaWiki distribution for enterprises and organizations. It enhances MediaWiki, in particular in the areas of quality management, process support, administration, editing and security. This extension is bundled with BlueSpice pro.

BlueSpice: