MediaWiki  master
README File Reference

Go to the source code of this file.

Variables

docs Directory README
 

Variable Documentation

docs Directory README
Initial value:
======================
The 'docs' directory contain various text files that should help you understand
the most important parts of the code of MediaWiki. More in-depth documentation
can be found at:
API documentation is automatically generated and updated daily at:
You can get a fresh version using 'make doc' or mwdocgen.php in the
../maintenance/ directory.
For end users
#define the
table suitable for use with IDatabase::select()
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global then executing the whole list after the page is displayed We don t do anything smart like collating updates to the same table or such because the list is almost always going to have just one item on if that
Definition: deferred.txt:11
globals txt Globals are evil The original MediaWiki code relied on globals for processing context far too often MediaWiki development since then has been a story of slowly moving context out of global variables and into objects Storing processing context in object member variables allows those objects to be reused in a much more flexible way Consider the elegance of
database rows
Definition: globals.txt:10
null for the local wiki Added in
Definition: hooks.txt:1435
The classes in this directory includes libs are considered standalone from the remainder of the MediaWiki codebase They do not call on any other portions of MediaWiki code
Definition: README:3
The most up to date schema for the tables in the database will always be tables sql in the maintenance directory
Definition: schema.txt:2
The MediaWiki class is the helper class for the index.php entry point.
Definition: MediaWiki.php:28
Having all this code related to the title reversion option in one place means that it s easier to read and understand
Definition: hooks.txt:116
Prior to version
Definition: maintenance.txt:1
Some quick notes on the file repository architecture Functionality is
Definition: README:3
and *available in your language For system and upgrade see the files RELEASE and UPGRADE *Ready to get started ** https
Definition: README:16
and(b) You must cause any modified files to carry prominent notices stating that You changed the files
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
Definition: design.txt:12
unless you explicitly specified the no dev flag during the install In this case just run composer update Otherwise follow the installation instructions in the PHPUnit Manual at
Definition: README:1
Some quick notes on the file repository architecture Functionality as driven by data model *The repository object stores configuration information about a file storage method *The file object is a process local cache of information about a particular file Thus the file object is the primary public entry point for obtaining information about files
Definition: README:3
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for and distribution as defined by Sections through of this document Licensor shall mean the copyright owner or entity authorized by the copyright owner that is granting the License Legal Entity shall mean the union of the acting entity and all other entities that control are controlled by or are under common control with that entity For the purposes of this definition control direct or to cause the direction or management of such whether by contract or including but not limited to software source documentation and configuration files Object form shall mean any form resulting from mechanical transformation or translation of a Source including but not limited to compiled object generated documentation

Definition at line 2 of file README.