Extension:CommunityConfiguration
This page is currently a draft.
|
![]() 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 | README |
|
|
Quarterly downloads | 7 (Ranked 126th) |
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 yourextensions/
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 or InitialiseSettings.php that is available through MediaWiki core config interface. The community can request a change, see Requesting wiki configuration changes. Updating requires Gerrit credentials and a deployment of a production configuration change. Some configuration must be available early in the request, and that configuration must be a server setting.
- Overridable server setting: A setting in LocalSettings.php or InitialiseSettings.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 administators, 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 administators, bureaucrats, stewards, etc.
Configuration parameters
[edit]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]- Extension:CommunityConfiguration/Developer setup
- Extension:CommunityConfiguration/Technical documentation
- Interface translations
![]() | This extension is being used on one or more Wikimedia projects. This probably means that the extension is stable and works well enough to be used by such high-traffic websites. Look for this extension's name in Wikimedia's CommonSettings.php and InitialiseSettings.php configuration files to see where it's installed. A full list of the extensions installed on a particular wiki can be seen on the wiki's Special:Version page. |