MediaWiki

Extension:CommunityConfiguration

MediaWiki extensions manual
CommunityConfiguration
Release status: beta
Implementation Special page
Author(s) Martin Urbanec, Sergio Gimeno, Cynthia Simiyu, Michael Große
MediaWiki >= 1.43.0
License GNU General Public License 3.0 or later
Download
Download extension
Git [?]:

README
Parameters
  • $wgCommunityConfigurationEditorCapabilities
  • $wgCommunityConfigurationFeedbackURL
  • $wgCommunityConfigurationProviderClasses
  • $wgCommunityConfigurationProviders
  • $wgCommunityConfigurationCommonsApiURL
  • $wgCommunityConfigurationValidators
  • $wgCommunityConfigurationStores
Hooks used
Hooks provided
Quarterly downloads 9 (Ranked 128th)
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' );
  •   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 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.
  • Server setting: A setting in LocalSettings.php (InitialiseSettings.php or another configuration file on Wikimedia wikis) that is available through MediaWiki core config interface. On Wikimedia wikis, the community needs to request a change via the Requesting wiki configuration changes process, and updating requires Gerrit credentials and a deployment of a production configuration change. Some configuration must be available early in HTTP the request, and that configuration must be a server setting.
  • Overridable server setting: A setting in LocalSettings.php that is available through standard MediaWiki config interfaces and also defined in a CommunityConfiguration providers (tbd: link to providers section), usually stored in a wiki JSON page. The option can be changed on-wiki by administrators, bureaucrats, stewards, etc. Consumers of CommunityConfiguration services will get the on-wiki option, consumers of MediaWiki core config interfaces will get the server option.
  • On-wiki option: A setting only defined in a CommunityConfiguration provider, only available through CommunityConfiguration services, usually stored in a wiki JSON page. It can be changed on-wiki by administrators, bureaucrats, stewards, etc.

Configuration parameters

edit
Configuration settings in extension.json
parameter default comment
$wgCommunityConfigurationFeedbackURL null The URL to use for link to a page where feedback can be left
$wgCommunityConfigurationProviders {} The list of provider specifications the extension will use. Specified as a mapping of provider name to provider specification. Additional provider types can be defined in CommunityConfigurationProviderClasses. Extensions can register their own providers through extension.json attribute "CommunityConfiguration/Providers"

See also

edit
Retrieved from "https://www.mediawiki.org/w/index.php?title=Extension:CommunityConfiguration&oldid=6847824"