Extension:CommunityConfiguration

From mediawiki.org
MediaWiki extensions manual
CommunityConfiguration
Release status: experimental
Implementation Special page
Author(s) Martin Urbanec, Sergio Gimeno, Cynthia Simiyu
MediaWiki >= 1.42.0
License GNU General Public License 3.0 or later
Download
README
  • $wgCommunityConfigurationValidators
  • $wgCommunityConfigurationBugReportingToolURL
  • $wgCommunityConfigurationProviders
  • $wgCommunityConfigurationStores
  • $wgCommunityConfigurationProviderClasses
Quarterly downloads 2 (Ranked 140th)
Translate the CommunityConfiguration extension if it is available at translatewiki.net
Issues Open tasks · Report a bug

The CommunityConfiguration extension provides a mechanism for communities to configure the exposed settings from extensions installed in a wiki.

Current status is under development. See more information about the project in Community configuration 2.0.

Installation[edit]

  • Download and move the extracted CommunityConfiguration folder to your extensions/ directory.
    Developers and code contributors should install the extension from Git instead, using:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/CommunityConfiguration
  • Add the following code at the bottom of your LocalSettings.php file:
    wfLoadExtension( 'CommunityConfiguration' );
    
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Glossary[edit]

The following terms are used across technical documentation and Phabricator issues. However they are not definitive and subject to change.

  • Configuration variable/option/setting: A specific piece of configuration
  • Configuration page: A place to store the configuration in; as of now, it is a JSON page in the MediaWiki namespace
  • Schema: Defines what variables can be present in a configuration page and the format of the variables
  • Editing form: An HTML form that allows to modify the configuration of a registered provider
  • Configuration provider: Consists of a configuration page and matching schema.

Configuration parameters[edit]

Configuration settings in extension.json
parameter default comment
$wgCommunityConfigurationBugReportingTool null The URL to use for links targetting the bug report tool for the extension

See also[edit]