User:SPage (WMF)/Sandbox



This is a high-level overview of MediaWiki development, including links to the key documents, resources and tools available to MediaWiki developers. It is written for skilled LAMP developers who have experience using MediaWiki.


 * For an introductory guide to developing MediaWiki, read howto>Special:MyLanguage/How to become a MediaWiki hacker|how to become a MediaWiki hacker.


 * For help installing or customizing MediaWiki, visit the .
 * For help using MediaWiki, visit the .

Overview
MediaWiki is developed in an open source style using the PHP programming language primarily for the LAMP platform. Core development is largely coordinated online.

The main developer list is wikitech-l. The main developer IRC channels are #mediawiki and #wikimedia-dev. Read the Developers article to get a sense for who the people on the mailing lists and IRC channels are.
 * Development discussion happens on various mailing lists and IRC channels.

Read the gerrit>Special:MyLanguage/Gerrit|Git article for an overview of how the MediaWiki developers use Git. Read the wikitech:Help:Access article if you'd like access.
 * Source code is managed using the Git revision control system.


 * Code review is performed on , see this tutorial to get set up with git and gerrit in order to submit patches.


 * Developers extending or interfacing with MediaWiki (instead working on the core code) have several convenient extension points, including the api>Special:MyLanguage/API:Main page|API, the Hooks system and skins>Special:MyLanguage/Manual:Skins|Skins – see the ext>#Extending MediaWiki|#Extending MediaWiki section of this page for an overview.

Key documents


Code, development and style

 * Development policy – an overview of key development policies.


 * man>Special:MyLanguage/Manual:Coding conventions|Coding conventions – learn how to write PHP code in the MediaWiki style.


 * Security for developers – learn how to help keep MediaWiki secure.


 * Pre-commit checklist – read this checklist before committing code.


 * Code review guide – a guide for reviewers of commits to the MediaWiki source code.


 * Requests for Comment (RfC) – read about or suggest new features for the MediaWiki ecosystem

Debugging and testing

 * Bugs – an overview of bug tracking in the MediaWiki project.


 * man>Special:MyLanguage/Manual:How to debug|How to debug – a guide to debugging MediaWiki.


 * man>Special:MyLanguage/Manual:Errors and symptoms|Manual:Errors and symptoms – an overview of common MediaWiki errors and their correlating symptoms.


 * Selenium Framework – learn to write UI tests for MediaWiki using Selenium.


 * man>Special:MyLanguage/Manual:Unit testing|Unit testing – learn to write unit tests for MediaWiki using PHPUnit.


 * <tvar|security></> – security issues are reported to [mailto:security@wikimedia.org security@wikimedia.org].

<div style="-moz-column-width: 25em; -webkit-column-width: 25em; column-width: 25em; -moz-column-count: 2; -webkit-column-count: 2; column-count: 2;">

Architecture

 * man>Special:MyLanguage/Manual:Code</>|Manual:Code – an overview of the key parts of MediaWiki's source code.


 * man>Special:MyLanguage/Manual:Database layout</>|Database layout – an overview of MediaWiki's database schemas.


 * man>Special:MyLanguage/Manual:Global object variables</>|Global object variables – a partial list of key global variables.


 * 1>Special:MyLanguage/Localisation</>|Localisation – learn about MediaWiki's internationalisation system.


 * man>Special:MyLanguage/Manual:Contents</>|Manual namespace on this wiki – documentation for developers.


 * [//doc.wikimedia.org/mediawiki-core/master/php/html/ MediaWiki Class Reference] – technical documentation generated from the MediaWiki source code. (Note: The class reference is a large, slow-to-load page.)


 * mvl>Special:MyLanguage/Category:MediaWiki Virtual Library (MVL)</>|MediaWiki Virtual Library – manuals, guides, collections of selected articles.

Sub-systems

 * api>Special:MyLanguage/API:Main page</>|API – MediaWiki's API provides direct, high-level access to the data contained in the MediaWiki databases


 * ContentHandler – MediaWiki's framework for supporting custom types of page content.


 * Database access – an overview of using databases in MediaWiki, including a brief guide to the database abstraction layer.


 * Job queue – MediaWiki's framework for processing long-running tasks asynchronously.


 * Messages API – MediaWiki's framework for providing localized application messages with PHP or JavaScript.

Extending MediaWiki
MediaWiki has been designed to allow for modification without changing the "core code". This makes it easy to update to a new version of MediaWiki without having to manually merge in old extension code changes. There are six main extension points that allow developers to change or extend what MediaWiki can do. The extension points are:


 * api>Special:MyLanguage/API:Main page</>|API – access the data and metadata of MediaWiki instances through a powerful web API


 * Hooks – every time a given event happens, do something.


 * Parser Functions – create a new command like:


 * Skins – change the look and feel of MediaWiki.


 * Special Pages – add a new special page.


 * Tag Extensions – create a new tag like:

Help for extension developers

 * Manual:Developing extensions – a guide to developing extensions.
 * Project:WikiProject Extensions
 * Extensions FAQ
 * See Category:Extensions, for a list of extensions.
 * Manual:$wgExtensionFunctions – use to defer setup (or run other callbacks) for extensions until after the MediaWiki core is setup.
 * Extension:BoilerPlate - a blank extension template

Help for skin developers

 * Manual:Skinning – instructions on how to create a skin for MediaWiki.
 * Manual:Skin configuration – a guide to configuring skins for a wiki.

Help for library code reuse

 * Manual:Developing libraries – a guide to packaging third-party libraries for use with MediaWiki

Third-party wiki uses

 * enterprise>Special:MyLanguage/Enterprise hub</>|Enterprise hub - For glossary>Special:MyLanguage/Manual:Glossary#Enterprise</>|Enterprise wikis


 * <tvar|Academic></> - For glossary>Special:MyLanguage/Manual:Glossary#Academic wikis</>|Academic wikis