View source for New Developers/Introduction to the Wikimedia Technical Ecosystem

<languages/>
<translate><!--T:1--> This page provides an overview of [<tvar name=url>https://www.wikimedia.org/</tvar> Wikimedia] software and infrastructure for new technical contributors.</translate>
<translate><!--T:115--> Its goal is to help developers understand the major areas where you can apply your technical skills to help support and grow the [[<tvar name=1>m:Special:MyLanguage/Wikimedia_movement</tvar>|Movement]].</translate>

<translate>
== Core principles and technology == <!--T:2-->

=== Open source === <!--T:3-->
</translate>
<translate><!--T:4--> The Wikimedia technical ecosystem is guided by [[w:Free and open-source software|free and open source software]] (FLOSS) principles.</translate>
<translate><!--T:126--> Contributors around the world volunteer their time to maintain and extend the technology behind Wikimedia projects.</translate>
<translate><!--T:127--> This means that the Wikimedia technical ecosystem consists of many unique projects with varying contributing guidelines, design patterns, hosting locations, and code review processes.</translate>

<translate><!--T:5--> Open source values like shared ownership and strong privacy commitments are central to Wikimedia's technical infrastructure, software, and services. For example:</translate>

* <translate><!--T:6--> For version control and code review, the Wikimedia Foundation (WMF) uses [[<tvar name="gerrit">Special:MyLanguage/Gerrit</tvar>|Git and Gerrit]]. Git is a free and open source distributed version control system, and Gerrit is a free, web-based collaborative code review tool that integrates with Git.</translate>
* <translate><!--T:7--> [[<tvar name=1>wikitech:Help:Cloud_Services_introduction</tvar>|Wikimedia Cloud Services (WMCS)]] provides cloud computing infrastructure, shared hosting (platform as a service), and data services for contributors to Wikimedia software projects. You can use these services to host your software tools for the Wikimedia movement, for free, instead of using proprietary, paid, or non-open-source services.</translate>

<translate>
<!--T:8-->
In addition to providing tools and services for technical contributors, WMF maintains [[<tvar name=1>wikitech:Wikimedia_infrastructure</tvar>|core infrastructure]] like data centers, search, networking, and global traffic routing. You don't need to learn about those in order to contribute to wiki projects, but you should know about the core software that powers Wikipedia and other wikis: MediaWiki.

=== MediaWiki === <!--T:9-->
</translate>
[[File:MediaWiki-2020-logo.svg|133x133px|right|link=]]
<translate>
<!--T:10-->
Wikimedia projects, including Wikipedia, run on the [[<tvar name="mediawiki">Special:MyLanguage/MediaWiki</tvar>|MediaWiki]] software platform. MediaWiki is free and open source software, built specifically for collecting and organising free and open knowledge. It's multilingual, extensible, customizable, and reliable. MediaWiki enables users around the world to edit, organise, maintain, and collaborate on wikis. It manages the display of content like text, photos, formatting, and revisions. MediaWiki is more than just a content management system: it also provides tools to handle spam and vandalism, and other functionality that supports community curation of freely-reusable knowledge on an open platform.
</translate>

<gallery widths="320px" heights="180px" mode="packed">
File:Here's to Engineering.webm|<translate><!--T:11--> Cool fact: [[<tvar name="wmfblog-nasa">wmfblog:2016/05/05/mediawiki-nasa/</tvar>|NASA uses MediaWiki as its wiki software.]]</translate>
</gallery>

<translate>
== Key areas where developers can contribute == <!--T:12-->

=== Develop MediaWiki, apps, and extensions === <!--T:13-->

==== MediaWiki core and extensions ==== <!--T:14-->
</translate>
<translate><!--T:15--> The MediaWiki software is developed collaboratively by people from all around the world. The Wikimedia technical community has added many key features to MediaWiki and built a large ecosystem of extensions to the core software. Due to its complexity, contributing to MediaWiki may be more challenging than other types of technical contributions. As a new contributor, focus on features and bugs that only touch a small region of code.</translate>
[[phab:maniphest/query/9otR6me9VKZa/#R|<translate><!--T:129--> Here you can find good first tasks for MediaWiki core.</translate>]]
<translate><!--T:130--> Avoid building new MediaWiki skins and extensions: every new extension adds to the software's overall maintenance burden, and can block the launch of new, crucial features.</translate>
<translate><!--T:116--> Instead, look into working on one of the many [[<tvar name=1>Special:MyLanguage/Manual:Extensions</tvar>|existing extensions]].</translate>

{{Colored box
|title=<translate><!--T:16--> Extension example: translate text and manage multilingual wikis</translate>
|content=<translate><!--T:17--> The [[<tvar name=1>Special:MyLanguage/Extension:Translate</tvar>|Translate extension]] enables localisation of MediaWiki and translation of every kind of text.</translate>

<translate>
<!--T:18-->
It supports web-based translation, proofreading, and collaboration between translators all over the world, while also making back-end integration with source code as easy as possible.
</translate>

[[File:Translate manual - Page example - 19. Documentation.png|center|thumb|522x522px|<translate><!--T:19--> Screenshot of a translation page generated by the Translate extension.</translate>]]}}

{{imbox
| text = <translate><!--T:20--> Things to know before you start:</translate>
* <translate><!--T:21--> Writing code for MediaWiki generally requires knowledge of PHP, MySQL/MariaDB, JavaScript, and CSS.</translate>
* <translate><!--T:22--> The MediaWiki codebase is large – don't be overwhelmed by it! When you're first starting, aim to write features or fix bugs that only touch a small region of code.</translate>
* <translate><!--T:23--> Follow the [[<tvar name=1>Special:MyLanguage/Development_guidelines</tvar>|MediaWiki development guidelines]] and [[<tvar name=2>Special:MyLanguage/Best_practices_for_extensions</tvar>|best practices for extensions]].</translate>
}}
<translate>
<!--T:24-->
To learn more, visit <tvar name="become-a-hacker">{{ll|How to become a MediaWiki hacker}}</tvar>.

==== Wikimedia mobile apps ==== <!--T:25-->

<!--T:26-->
Mobile apps expand the reach of Wikimedia content by allowing users to interact with Wikimedia without using a browser. There are apps for the Android, iOS, and KaiOS platforms, apps for different Wikimedia projects like Commons, Wikipedia, and Wiktionary, and apps for activities like reading, contributing, and more. Many apps have vibrant developer communities and welcome new contributors. 
</translate>
{{Colored box
|title=<translate><!--T:27--> Mobile app example: read Wikipedia without internet access</translate>
|content=<translate><!--T:28--> <tvar name="kiwix">[[meta:Kiwix|Kiwix]]</tvar> is an offline reader – it makes Wikipedia accessible to people without internet access.</translate>

<translate>
<!--T:29-->
It provides content in more than 100 languages from Wikipedia, Wikiquote, Wiktionary, and other online resources.

<!--T:30-->
Kiwix development uses Java/Kotlin (Android), Swift (iOS), Qt (desktop), NodeJS (mediawiki offliner) and C++.
</translate>

<gallery widths=385px heights=385px mode="packed">
File:KIWIX Flyer.pdf|<translate><!--T:31--> Kiwix flyer</translate>
File:Kiwix on iOS 1.png|<translate><!--T:32--> Screenshot of Kiwix on iOS</translate>
</gallery>
}}
<translate>
<!--T:33-->
To learn more, visit <tvar name="wikimedia-apps">{{ll|Wikimedia Apps}}</tvar>.

=== Customise MediaWiki through on-wiki development === <!--T:34-->

==== Templates and modules ==== <!--T:35-->

<!--T:36-->
'''Templates''' enable one piece of content to appear on multiple wiki pages ("transclusion"). Many wikis rely heavily on templates: there are thousands of them, they're used on almost every page, and they're integral to wiki functionality. You can pass parameters to templates to customise how content is handled in different contexts.
</translate>
{{Colored box
|title=<translate><!--T:37--> Template example: format blockquotes</translate>
|content=<translate><!--T:38--> The [[w:Template:Blockquote|Blockquote template]] provides formatting for block quotations, and includes preformatted attribution parameters for a quote's author and source.</translate>

<translate>
<!--T:39-->
This enables editors to use wikitext markup to easily and consistently style how block quotes display on wiki pages.</translate>

[[File:Template Blockquote example.png|center|thumb|<translate><!--T:40--> Screenshot of the <tvar name=1>Template:Blockquote</tvar> documentation showing how it works.</translate>|800x800px]]
}}

<translate>
<!--T:41-->
You don't need a developer account to edit or create a template, and they're written in wikitext. That makes templates an easy way to get started with customising wiki behavior.
</translate>

<translate><!--T:42--> '''Modules''' are similar to templates, but instead of being written in wikitext, they use the Lua programming language.</translate>
<translate><!--T:124--> While templates are part of the core MediaWiki application, support for modules is implemented by an extension called <tvar name="scribunto">{{ll|Extension:Scribunto|nsp=0}}</tvar>.</translate>

{{Colored box
|title=<translate><!--T:43--> Module example: format complex route maps</translate>
|content=<translate><!--T:44--> The [[w:Module:Routemap|Routemap module]] supports a special, complex, custom language for displaying rail maps. It is used in thousands of articles about railways in multiple languages.</translate>
<translate><!--T:117--> Using Lua enables this module to replace [[w:Wikipedia:Route diagram template|legacy route map templates]] with a faster and more mobile-friendly implementation.</translate>

[[File:Routemap example screenshot.png|center|thumb|420x420px|<translate><!--T:45--> Screenshot of an [[:ko:경인선|article using the Routemap module on Korean Wikipedia]].</translate>]][[File:Routemap markup example.png|center|thumb|517x517px|<translate><!--T:46--> Example code and rendering from [[w:Template:Routemap|Routemap documentation]].</translate>]]
}}

{{imbox
| text = <translate><!--T:47--> Things to know before you start:</translate>
* <translate><!--T:48--> Some template functionality depends on other MediaWiki extensions, CSS, and/or JavaScript that must be deployed on a given wiki in order for functions to work.</translate>
* <translate><!--T:49--> Templates are a very powerful feature of the MediaWiki software, so you should make edits to complex templates in a sandbox and include test cases to verify that they work as intended.</translate>
* <translate><!--T:50--> To lower the risk of mistakes breaking hundreds or thousands of pages, wiki projects may have policies that restrict or "[[w:Wikipedia:High-risk_templates|protect]]" edits to widely-used templates or modules.</translate>
* <translate><!--T:51--> The MediaWiki software has parameters that limit the complexity of a page, and the amount of data that can be included. This means there are some [[w:Help:Template limits|limits to what you can do with templates and modules]].</translate>
* <translate><!--T:52--> Modules should follow the [[<tvar name="coding-conventions-lua">Special:MyLanguage/Manual:Coding_conventions/Lua</tvar>|Lua coding conventions]].</translate>
}}

<translate><!--T:53--> To learn more about templates, visit <tvar name="help-templates">{{ll|Help:Templates}}</tvar>.</translate>
<translate><!--T:118--> To learn more about modules and how Lua is used on MediaWiki, visit the [[<tvar name="lua-ref">Special:MyLanguage/Extension:Scribunto/Lua reference manual</tvar>|Scribunto Lua manual]].</translate>

<translate>
====User scripts and gadgets==== <!--T:54-->
</translate>
<translate><!--T:55--> MediaWiki supports front-end customisation, or "on-wiki" development, to enhance the software's core functionality.</translate>
<translate><!--T:119--> '''User scripts''' are JavaScript and/or CSS that provide additional features on top of MediaWiki.</translate>
<translate><!--T:120--> Code lives on the wiki, and is injected from the client side on MediaWiki via user preferences.</translate>
<translate><!--T:121--> You can modify your local JavaScript and CSS to change the appearance and behavior of your own interface.</translate>
<translate><!--T:122--> Individual users can add features for themselves as long as they follow expectations and guidelines around doing so.</translate>
<translate><!--T:123--> If you build something that others can use, you can share your scripts informally, or work with a wiki community to investigate making your customisations available to other users and projects as a "gadget".</translate>

{{Colored box
|title=<translate><!--T:56--> User script example: display calculated content</translate>
|content=<translate><!--T:57--> [[<tvar name="user-script">Special:MyLanguage/ChickTech_High_School_Kickoff_2017/Tasks#Write_a_user_script_to_calculate_the_estimated_reading_time_of_an_article</tvar>|This user script]] calculates the reading time of an article and displays it on the page.</translate>

<syntaxhighlight lang="javascript" line="1">
var numWords = $("#mw-content-text > div").text().split(" ").length;
var headerWords = $("h1").text().split(" ").length;
var totalWords = numWords + headerWords;
var timeInMinutes = totalWords / 200;
var header = $("h1").text();
$("h1").text(header + " (it will take you " + timeInMinutes + " mins to read this article)");
</syntaxhighlight>

[[File:Reading_time_for_basketball_article.png|center|thumb|517x517px|<translate><!--T:58--> Screenshot of English Wikipedia article displaying reading time.</translate>]]
}}

<translate>
<!--T:59-->
'''Gadgets''' are user-generated customisations that are available for installation on a wiki, via the [[<tvar name="extension-gadgets">Special:MyLanguage/Extension:Gadgets</tvar>|Gadgets MediaWiki extension]]. Many gadgets originated as user scripts that became widely-used on their home wiki, and admins wanted to make them easier for everyone to find and use. Admins can configure which gadgets are available and enabled by default for an entire MediaWiki site or skin.</translate>

{{Colored box
|title=<translate><!--T:60--> Gadget example: help editors categorise content</translate>
|content=<translate><!--T:61--> [[w:Wikipedia:HotCat|HotCat]] helps users easily remove, change, and add categories to Wikipedia pages.</translate>

<translate>
<!--T:62-->
It has a suggestions list that proposes existing categories for auto-completion.
</translate>

[[File:Gadget_hotcats.jpg|center|thumb|517x517px|<translate><!--T:63--> Screenshot of HotCat functionality on French Wikipedia.</translate>]]
}}

{{Colored box
|title=<translate><!--T:64--> Gadget example: help moderators fix content</translate>
|content=<translate><!--T:65--> This [[<tvar name="fa-persiantools-js">:fa:مدیاویکی:Gadget-Extra-Editbuttons-persiantools.js</tvar>|gadget deployed on Persian Wikipedia]] helps content moderators fix Arabic letters, grammar, numbers, URLs, article structure, and more.</translate>

[[File:Persiantools gadget screenshot.png|alt=<translate><!--T:66--> Screenshot of gadget JavaScript from Persian Wikipedia.</translate>|center|thumb|595x595px|<translate><!--T:67--> Screenshot of gadget JavaScript from Persian Wikipedia.</translate>]]
}}

{{imbox
| text = <translate><!--T:68--> Things to know before you start:</translate>
* <translate><!--T:69--> For user scripts to work, <tvar name=1>{{ll|Manual:$wgAllowUserJs|$wgAllowUserJs}}</tvar> variable in the site's configuration file needs to be set as <tvar name=2>{{phpi|true}}</tvar>.</translate>
* <translate><!--T:70--> For gadgets to work, the <tvar name="extension-gadgets">{{ll|Extension:Gadgets|nsp=0}}</tvar> and <tvar name="extension-codeeditor">{{ll|Extension:CodeEditor|nsp=0}}</tvar> extensions must be installed.</translate>
* <translate><!--T:71--> Gadget code should follow the [[<tvar name="coding-conventions-js">Manual:Coding_conventions/JavaScript</tvar>|JavaScript coding conventions]].</translate>
* <translate><!--T:72--> Each wiki community determines how and whether to review gadget code. The process for making a gadget available to all users of a wiki is not streamlined. It requires a series of steps, including recruiting an interface administrator and providing deployment instructions to them.</translate>
* <translate><!--T:73--> On Wikimedia wikis, you must be an [[<tvar name="interfaceadmin">meta:Special:MyLanguage/Interface_administrators</tvar>|interface admin]] to edit gadgets.</translate>
}}

<translate>
<!--T:74-->
To learn more about user scripts and gadgets, visit <tvar name="gadgetkitchen">''{{ll|Gadget kitchen}}''</tvar>.

===Build tools and bots to help Wikimedia projects=== <!--T:75-->

<!--T:76-->
MediaWiki [[<tvar name="api-main-page">Special:MyLanguage/API:Main_page</tvar>|APIs]] provide direct access to the data contained in the MediaWiki database. This includes wiki content, metadata, analytics data, and more. You can use these APIs to build apps that contribute content or new functionality to the Wikimedia ecosystem. The API modules provide programmatic access to much of the same functionality provided by the MediaWiki web interface. 

==== Bots ==== <!--T:77-->
</translate>
<translate><!--T:78--> '''Bots''' are automated programs that help wiki projects by doing crucial but repetitive tasks.</translate>
<translate><!--T:128--> Bots save human effort by correcting missing or extra spaces, suggesting articles to newcomers, fixing broken links, and more.</translate>
<translate><!--T:125--> Bot automation supports Wikimedia volunteers by allowing them to spend more of their time on tasks that require human intelligence, like writing articles, finding sources, fact checking, and synthesising multiple points of view.</translate>

{{Colored box
|title=<translate><!--T:79--> Bot example: fight link rot</translate>
|content=[[File:IABot logo.svg|left|link=]]<translate><!--T:80--> [[<tvar name="iabot">metawiki:Special:MyLanguage/InternetArchiveBot</tvar>|InternetArchiveBot]] (IABot) is an advanced bot that identifies and replaces broken external links.</translate>

<translate>
<!--T:81-->
It also completes reference templates and adds links to resources, where appropriate.

<!--T:82-->
This bot is operated as a service of the Internet Archive in partnership with the Wikimedia community.

<!--T:83-->
As of October 2022, IABot is running on 150+ Wikimedia wikis.

<!--T:84-->
IABot also has a [[<tvar name="iabottoolforge">toolforge:iabot/</tvar>|browser-based interface]] (web app) that provides easy access to some of the bot's services and configuration.
</translate>
}}

<translate>
<!--T:85-->
Bots can request pages and submit edits to wikis just like how human users do the same tasks in a web browser. Because bots access pages the same way people do, they can get caught in edit conflicts, have page timeouts, or run across other unexpected complications while requesting pages or making edits. Since bots generally complete high-volume work, you should consider these situations when writing a bot.</translate>
{{imbox
| text = <translate><!--T:86--> Things to know before you start:</translate>
* <translate><!--T:87--> Each Wikimedia project has a policy that governs the creation and implementation of bots. For example, see [[w:Wikipedia:Bot policy|English Wikipedia's bot policy]]. You must understand and follow the bot guidelines established by the wiki project you're developing for.</translate>
* <translate><!--T:88--> Before creating a new bot, explore the bots that are currently active on the wiki project, and how you can contribute to them.</translate>
* <translate><!--T:89--> Multiple programming languages, like Haskell, Java, Perl, PHP, Python, and Ruby have libraries available for creating bots. <tvar name="pywikibot">{{ll|Manual:Pywikibot|nsp=0}}</tvar> is a commonly used Python package developed specifically for creating MediaWiki bots.</translate>
}}

<translate>
<!--T:90-->
To learn more about bots, visit <tvar name="creating-a-bot">{{ll|Manual:Creating a bot}}</tvar>.

====Tools==== <!--T:91-->

<!--T:92-->
'''Tools''' are software applications that help people working on Wikimedia projects. Tools can do all kinds of tasks, like help editors discover content to improve, simplify edit-a-thon planning, visualise wiki content, help fight vandalism, and much more.
</translate>

{{Colored box
|title=<translate><!--T:93--> Tool example: improve images</translate>
|content=<translate><!--T:94--> [[<tvar name="croptool">c:Commons:CropTool</tvar>|CropTool]] is a MediaWiki tool for cropping images at Wikimedia Commons and other Wikimedia sites.</translate>

<translate>
<!--T:95-->
It supports JPEG, PNG, TIFF and (animated) GIF files, and can also extract single pages from DJVU and PDF files as JPEG for cropping.</translate>

[[File:Croptool-01.png|center|thumb|517x517px|<translate><!--T:96--> Screenshot of the CropTool menu item on a wiki.</translate>]]
}}
<translate>
<!--T:97-->
The [[<tvar name="api">Special:MyLanguage/API:Main page</tvar>|MediaWiki Action API]] gives you programmatic access to content on any Wikimedia wiki. You can use the Action API to search and display wiki pages, get media files, edit pages, and manage wikis. [[<tvar name="api-client-code">Special:MyLanguage/API:Client code</tvar>|Client libraries]] implementing the MediaWiki API are available in many languages, including Python and JavaScript.</translate>

{{Colored box
|title=<translate><!--T:98--> Tool example: connect Wikipedia articles and Wikidata items</translate>
|content=<translate><!--T:99--> The [[<tvar name="duplicity">toolforge:wikidata-todo/duplicity.php</tvar>|Duplicity tool]] picks a random wiki article that doesn't have an associated Wikidata item, and offers some possible matches on Wikidata.</translate>

<translate>
<!--T:100-->
It makes it easy to add structured data to capture the topics, concepts, or entities discussed in an article.
</translate>

[[File:Duplicity wikidata tool screenshot.png|alt=<translate><!--T:101--> Screenshot of the Duplicity tool interface.</translate>|center|thumb|517x517px|<translate><!--T:102--> Screenshot of the [[<tvar name="duplicity">toolforge:wikidata-todo/duplicity.php</tvar>|Duplicity tool]] interface.</translate>]]
}}
<translate><!--T:103--> To explore more Wikimedia tools, visit [<tvar name="toolhub">https://toolhub.wikimedia.org/</tvar> Toolhub].</translate> Or, [[wikitech:Help:Toolforge|learn about hosting your tools and bots for free on Toolforge]].
{{imbox
| text = <translate><!--T:104--> Things to know before you start:</translate>
* <translate><!--T:105--> You need a [[<tvar name="developer-account">Special:MyLanguage/Developer account</tvar>|Wikimedia Developer Account]] to host tools on Toolforge, and commit code to Wikimedia's Git repositories.</translate>
* <translate><!--T:106--> Toolforge tools must be open source software licensed under an [<tvar name="opensource-licenses">https://opensource.org/licenses</tvar> OSI approved license], and all projects must follow the [[<tvar name="wikitech-cs-tou">wikitech:Wikitech:Cloud_Services_Terms_of_use</tvar>|Wikimedia Cloud Services Terms of Use]].</translate>
* <translate><!--T:107--> Take advantage of [[<tvar name="api-client-code">Special:MyLanguage/API:Client_code</tvar>|client libraries for the MediaWiki API]] in many programming languages.</translate>
}}
<translate>
==Join the Wikimedia tech community== <!--T:108-->

<!--T:109-->
A great way to find ways to contribute is to get connected to the technical community. You can meet people and discuss development work on various [[<tvar name="communication">Special:MyLanguage/Communication</tvar>|communication channels]] and at events like [[<tvar name="hackathons">Special:MyLanguage/Hackathons</tvar>|Hackathons]]. The Wikimedia Foundation also offers [[<tvar name="outreach-programs">Special:MyLanguage/Outreach programs</tvar>|outreach programs]] to mentor new developers.</translate>
[[File:Wikimedia Hackathon Prague 2019 - Group Photo - CLK (cropped).png|alt=<translate><!--T:110--> Attendees at the Wikimedia Hackathon in Prague, 2019.</translate>|center|thumb|520x520px|<translate><!--T:111--> Attendees at the Wikimedia Hackathon in Prague, 2019.</translate>]]

<translate>
==Get started as a new contributor== <!--T:112-->
</translate>
* <translate><!--T:113--> Visit the [[<tvar name="new-developers">Special:MyLanguage/New Developers</tvar>|New Developers page]] to learn more about getting started with development and contributing to Wikimedia open source.</translate>
* <translate><!--T:114--> Use the [<tvar name="dev-portal">https://developer.wikimedia.org/</tvar> Developer Portal] to find curated resources and tutorials for your area of interest.</translate>

[[Category:New contributors{{#translation:}}]]