Extension:CollabPads

**MediaWiki extensions manual**
CollabPads; Release status: stable
Author(s)	Hallo Welt! GmbH
Maintainer(s)	Hallo Welt! GmbH
Latest version	see GitHub latest tag
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)
Database changes	Yes
	Parameters $wgCollabPadsBackendServiceURL;
	Added rights collabpadsessions-admin;
	Hooks used BSArticleInfoSkip; BSSaferEditMessageData; BeforePageDisplay; BlueSpiceDiscoveryTemplateDataProviderAfterInit; ChangeTagsListActive; ContribsPager::getQueryInfo; ContributionsLineEnding; EnhancedChangesListModifyBlockLineData; EnhancedChangesListModifyLineData; GetPreferences; LastEditInfo; ListDefinedTags; LoadExtensionSchemaUpdates; MediaWikiPerformAction; PageHistoryLineEnding; RecentChange_save; SkinTemplateNavigation::Universal; SpecialContributions::formatRow::flags; getUserPermissionsErrors;
Licence	GNU General Public License 3.0 only
Download	Download extension ; Git [?]: Browse repository (GitHub); Gerrit code review; Git commit log; Download source tarball;
	Translate the CollabPads extension if it is available at translatewiki.net

Translate this page

CollabPads allows multiple users to edit a wiki page simultaneously. All changes are visible to all editors in real-time. This is useful to prevent edit conflicts on a page, for co-authoring instant documents such as meeting minutes, or for drafting or brainstorming sessions, to only name a few use cases.

Requirements

This extension requires MongoDB to store and synchronize the collaborative editing state between participants.

Usage / features

This extension enables collaborative editing of pages
Changes are managed in a collaboration session. They are only saved to the wiki page when the session is completed.
Collaboration sessions are separate from regular page edits. Non-participants see changes only when the session is finished.

Starting a collaboration session
List of participants
Leaving the session
Participant editing flag

Typical use cases

Meeting minutes: If more participants contribute in writing during live sessions, it is less likely that important points are accidentally omitted from the minutes.
Instant knowledge transfer: When multiple users edit a page at the same time, sharing ideas becomes very time-efficient.
Create drafts: Drafting new topics together is helpful for avoiding writer's block and to gain momentum when thinking about the general outline or the main ideas of the topic.
Write quick notes: Since the changes from an unsaved session are not directly visible in the wiki, making changes in "Edit together" mode are even useful for taking notes and only commiting them to the wiki once you find them useful enough to share with others.

Installation

Add the repo url (https://github.com/wikimedia/mediawiki-extensions-CollabPads

.git) as a "vcs repository" and the package name (mediawiki/CollabPads) and version to the require section of your composer.local.json. Example:

{
	"repositories": [
		{
			"type": "vcs",
			"url": "https://github.com/wikimedia/mediawiki-extensions-CollabPads
.git"
		}
	],
	"require": {
		"mediawiki/CollabPads": "CollabPads"
	}
}

Run the following command in your MediaWiki installation path

composer update --no-dev

Add the following code at the bottom of your LocalSettings.php file:

wfLoadExtension( 'CollabPads' );

Done Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

External Links

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: