View source for Manual:Code

<languages />
{{TOCright}}
<translate>
<!--T:1-->
This page describes top-level directories in the '''MediaWiki core code''' repository.

<!--T:2-->
See also the following pages in the versioned MediaWiki documentation site ([[<tvar name=1>Special:MyLanguage/Manual:mwdocgen.php</tvar>|auto-generated]] using <tvar name=2>{{ll|Doxygen}}</tvar>):

== Entry points == <!--T:3-->
</translate>
<translate><!--T:37--> The entry point files that are loaded directly are listed below.</translate>
<translate><!--T:38--> Other files might be loaded (mostly from extensions) but doing so is non-standard and might not work on all systems.</translate>

<translate><!--T:39--> Web browsing:</translate>

* {{manual|index.php}} – <translate><!--T:40--> see <tvar name=1>{{manual|Parameters to index.php}}</tvar> for more details.</translate>
* {{manual|opensearch_desc.php}} – <translate><!--T:41--> the OpenSearch API.</translate>
* {{manual|load.php}} – <translate><!--T:42--> the output point of the <tvar name=1>{{ll|ResourceLoader}}</tvar>.</translate>

API:

* {{manual|api.php}} – <translate><!--T:43--> the [[<tvar name=1>Special:MyLanguage/API:Action API</tvar>|Action API]].</translate>
* {{manual|rest.php}} – <translate><!--T:44--> the [[<tvar name=1>Special:MyLanguage/API:REST API</tvar>|REST API]].</translate>

<translate><!--T:45--> File uploads:</translate>

* {{manual|img_auth.php}} – <translate><!--T:46--> serving thumbnails and originals, for use on private wikis.</translate>
* {{manual|thumb_handler.php}} – <translate><!--T:47--> 404 handler for thumbnails, using paths like <tvar name=1><code>thumb_handler.php/a/a9/Example.jpg/120px-Example.jpg</code></tvar></translate>
* {{manual|thumb.php}} – <translate><!--T:48--> 404 handler for thumbnails, using parameters like <tvar name=1><code>thumb.php?f=Example.jpg&w=120</code></tvar></translate> 

<translate>
<!--T:4-->
See also <tvar name=5>{{ll|Manual:entry point routing}}</tvar>, and [<tvar name=url>https://doc.wikimedia.org/mediawiki-core/master/php/group__entrypoint.html</tvar> Entry points] on <tvar name=1>doc.wikimedia.org</tvar> for internal details of the code for the above entry points.
</translate>

==<code>[[git:mediawiki/core/+/master/cache/|cache/]]</code>==
<translate>
<!--T:5-->
The installer recommends users to enable the <tvar name=1>{{Wg|CacheDirectory}}</tvar> feature by making this directory writable and using it for that feature.

<!--T:6-->
This directory is empty by default.
</translate>

== <code>[[git:mediawiki/core/+/master/docs/|docs/]]</code> ==
<translate>
<!--T:7-->
Contains high-level documentation about MediaWiki, which is automatically published for each MediaWiki release (and for "master") to <tvar name=1>[https://doc.wikimedia.org/mediawiki-core/ doc.wikimedia.org]</tvar>.

<!--T:8-->
For the living version of the MediaWiki doc site, see <tvar name=1>[https://doc.wikimedia.org/mediawiki-core/master/php/ https://doc.wikimedia.org/mediawiki-core/]</tvar>.
</translate>

== <code>[[git:mediawiki/core/+/master/extensions/|extensions/]]</code> ==
<translate><!--T:9--> This is where [[<tvar name=1>Special:MyLanguage/Manual:Extensions</tvar>|MediaWiki extensions]] are installed.</translate>
<translate><!--T:10--> To install an extension, its source code is placed in a subdirectory here (typically by unpacking a [[w:Tar_(computing)|tarball]] downloaded from the extension's mediawiki.org documentation page, or by cloning the source code from Gerrit).</translate>
<translate><!--T:11--> Then, to enable the extension it must be loaded from <tvar name=1>{{ll|Manual:LocalSettings.php|LocalSettings.php}}</tvar>, typically by calling <tvar name=2><code>wfLoadExtension()</code></tvar>.</translate>

<translate><!--T:12--> The default distribution for MediaWiki (as advertised on our homepage and as packaged with Debian) also bundles a number of extensions and skins.</translate>
<translate><!--T:13--> See <tvar name=1>{{ll|Bundled extensions and skins}}</tvar>.</translate>

== <code>[[git:mediawiki/core/+/master/includes/|includes/]]</code> ==
<translate>
<!--T:14-->
This directory stores the majority of the MediaWiki source code.

<!--T:15-->
To learn about the different classes and components of MediaWiki, see [<tvar name=url>https://doc.wikimedia.org/mediawiki-core/master/php/topics.html</tvar> "Topics" on <tvar name=1>doc.wikimedia.org/mediawiki-core/</tvar>].
</translate>

== <code>[[git:mediawiki/core/+/master/images/|images/]]</code> ==
<translate><!--T:16--> This is the default directory where user-uploaded media files will be stored.</translate>
<translate><!--T:17--> It is also where the generated thumbnails are stored by default.</translate>

<translate>
<!--T:18-->
See also <tvar name=1>{{ll|Manual:Configuring file uploads}}</tvar> and <tvar name=2>{{ll|Manual:Image administration#Folders}}</tvar>.
</translate>

== <code>[[git:mediawiki/core/+/master/languages/|languages/]]</code> ==
<translate>
<!--T:20-->
This directory contains pure data and configuration for [[<tvar name="1">Special:MyLanguage/Localisation</tvar>|localization and internationalization]].

<!--T:21-->
Specifically:

<!--T:22-->
* the <tvar name=1><code>i18n/</code></tvar> subdirectory contains the interface messages used in MediaWiki core (using the [<tvar name=url>https://github.com/wikimedia/jquery.i18n#message-file-format</tvar> Banana JSON file format]).</translate>
<translate>
<!--T:24-->
* the <tvar name=1><code>messages/</code></tvar> subdirectory contains misc characteristics of MediaWiki that are localisable (but not interface messages).</translate> <translate><!--T:25--> Such as the names of <tvar name=1>{{ll|Help:Namespaces|nsp=0}}</tvar>, <tvar name=2>{{ll|Manual:Parser functions|nsp=0}}</tvar> and <tvar name=3>{{ll|special pages}}</tvar>.</translate>

== <code>[[git:mediawiki/core/+/master/maintenance/|maintenance/]]</code> ==
<translate><!--T:26--> This directory contains shell scripts for use by system administrators to perform maintenance tasks.</translate>
<translate><!--T:27--> This includes scripts for performing database schema migrations, and batch operations.</translate>
<translate><!--T:28--> See <tvar name=1>{{ll|Manual:Maintenance scripts}}</tvar> for an overview.</translate>

== <code>[[git:mediawiki/core/+/master/mw-config/|mw-config/]]</code> ==
<translate><!--T:29--> This directory is the entry point for the [[<tvar name=1>Special:MyLanguage/Manual:Config script</tvar>|Web installer]] which new administrators can use to install their wiki.</translate>
<translate><!--T:30--> It helps with configuring the wiki and creating the database schema.</translate>

== <code>[[git:mediawiki/core/+/master/resources/|resources/]]</code> ==
<translate>
<!--T:31-->
This directory contains frontend resources (JavaScript and CSS) managed by <tvar name=1>{{ll|ResourceLoader}}</tvar>.
</translate>

== <code>[[git:mediawiki/core/+/master/skins/|skins/]]</code> ==
<translate><!--T:32--> This is where [[<tvar name=1>Special:MyLanguage/Manual:Skins</tvar>|MediaWiki skins]] are installed.</translate>
<translate><!--T:33--> To install a skin, its source code is placed in a subdirectory here (typically by unpacking a tarball, or by cloning the source code from Git).</translate>
<translate><!--T:34--> Then, to enable the skin it must be loaded from <tvar name=1>{{ll|Manual:LocalSettings.php|LocalSettings.php}}</tvar>, typically by calling <tvar name=2><code>wfLoadSkin()</code></tvar>.</translate>

<translate>
<!--T:35-->
See also <tvar name=1>{{ll|Bundled extensions and skins}}</tvar>.
</translate>

== <code>[[git:mediawiki/core/+/master/tests/|tests/]]</code> ==
<translate>
<!--T:36-->
Contains unit tests, integration tests, and end-to-end tests.
</translate>

*{{ll|Manual:PHP unit testing}}
*{{ll|Manual:JavaScript unit testing}} (QUnit)
*{{ll|Selenium}}

[[Category:MediaWiki technical documentation{{#translation:}}|{{PAGENAME}}]]
[[Category:MediaWiki code{{#translation:}}|{{PAGENAME}}]]
[[Category:Entry point URLs{{#translation:}}|{{PAGENAME}}]]