Extension:Site Settings

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manualManual:Extensions
Crystal Clear action run.png
Site Settings

Release status:Extension status beta

Site Settings default screenshot.png
ImplementationTemplate:Extension#type Special page, Hook
DescriptionTemplate:Extension#description Defines a special page, "SiteSettings", that can be used to modify some of the wiki's settings from the web interface.
Author(s)Template:Extension#username Yaron Koren <yaron57@gmail.com>
Latest versionTemplate:Extension#version 0.6 (June 2014)
MediaWikiTemplate:Extension#mediawiki 1.19.* or greater
PHPTemplate:Extension#php 5.3.* or greater
Database changesTemplate:Extension#needs-updatephp Yes
LicenseTemplate:Extension#license GNU General Public License 2.0 or later
Download
README
ParametersTemplate:Extension#parameters

$wgSiteSettingsSetupMode

Added rightsTemplate:Extension#rights

sitesettings

Hooks usedTemplate:Extension#hook
LoadExtensionSchemaUpdatesManual:Hooks/LoadExtensionSchemaUpdates
PersonalUrlsManual:Hooks/PersonalUrls
UserGetRightsManual:Hooks/UserGetRights

Translate the Site Settings extension if it is available at translatewiki.net

Check usage and version matrix.

Site Settings is an extension to MediaWiki that defines a special page, "Special:SiteSettings", that lets administrators configure site-wide settings from within the wiki interface. Only users with the 'sitesettings' permission (sysops/administrators, by default) can access the page; for those users who can access it, a link to the page will also show up in their "Personal URLs", between "Talk" and "Preferences".

Code and download[edit]

You can download the Site Settings code, in .zip format, here.

You can also download the code directly via Git from the MediaWiki source code repository. From a command line, you can call the following:

git clone https://gerrit.wikimedia.org/r/p/mediawiki/extensions/SiteSettings.git

To view the code online, including version history for each file, go here.

Installation[edit]

After you've obtained an 'SiteSettings' directory (either by extracting a compressed file or downloading via Git), place this directory within the main MediaWiki 'extensions' directory. Then, in the file 'LocalSettings.php' in the main MediaWiki directory, add the following line:

include_once("$IP/extensions/SiteSettings/SiteSettings.php");

The SiteSettings extension requires its own database table, called "site_settings"; and until it is set up you will need to add the following line to LocalSettings.php, below the SiteSettings inclusion:

$wgSiteSettingsSetupMode = true;

Then, update the database by calling MediaWiki's update.php script. Once that script is run and the "site_settings" table has been created, remove the $wgSiteSettingsSetupMode line. At that point, you can start using Site Settings.

If you want to have the members of groups other than 'sysop' be able to use Special:SiteSettings, you can also add lines like the following:

$wgGroupPermissions['my-group']['sitesettings'] = true;

The Site Settings page lets administrators upload files to serve as the logo and favicon for the wiki. To get this feature working, you will need to have directories at both of the following locations:

/skins/common/images/logos/
/skins/common/images/favicon/

...and have them both be writable by the web server.

Authors[edit]

Site Settings was written by Yaron Koren, reachable at yaron57 -at- gmail.com.

Version history[edit]

Site Settings is currently at version 0.6.

The version history is:

  • 0.5 - May 13, 2014 - Initial version
  • 0.6 - June 4, 2014 - i18n messages moved into JSON files; support for many languages added

Contributing to the project[edit]

Bugs and feature requests[edit]

Send any bug reports and requests to Yaron Koren, at yaron57 -at- gmail.com.

Contributing patches to the project[edit]

If you found some bug and fixed it, or if you wrote code for a new feature, please create a patch by going to the "SiteSettings" directory, and typing:

git diff > descriptivename.patch

Then send this patch, with a description, to Yaron Koren.

See also[edit]