MediaWiki  master
Functions | Variables
README File Reference

Go to the source code of this file.

Functions

although this is appropriate
in some e g manual creation of
blank tables prior to an
import Most of the PHP scripts
need to be run from the
command line Prior to doing
ensure that the LocalSettings
php file in the directory
above points to the proper
installation Certain scripts
will require elevated access
to the database In order to
provide first create a MySQL
user with all permissions on
the wiki and then set
$wgDBadminuser and
$wgDBadminpassword in your
LocalSettings e g rebuilding
link updating the search etc
The files in the archives
directory are used to upgrade
the database schema when
updating the software Some
schema definitions for 		alternative (as yet unsupported) database management systems are stored here too.The"storage"directory contains scripts and resources useful for working with external storage clusters
 

Variables

although this is appropriate
in some 		cases
 
although this is appropriate
in some e g manual creation of
blank tables prior to an
import Most of the PHP scripts
need to be run from the
command line Prior to doing
ensure that the LocalSettings
php file in the directory
above points to the proper
installation Certain scripts
will require elevated access
to the database In order to
provide first create a MySQL
user with all permissions on
the wiki and then set
$wgDBadminuser and
$wgDBadminpassword in your
LocalSettings e g rebuilding
link updating the search etc
The files in the archives
directory are used to upgrade
the database schema when
updating the software Some
schema definitions for and are
not likely to be particularly
useful to the vast majority of
installations This directory
does contain the compressOld
which can be useful for
compacting old 		data
 
although this is appropriate
in some e g manual creation of
blank tables prior to an
import Most of the PHP scripts
need to be run from the
command line Prior to doing
ensure that the LocalSettings
php file in the directory
above points to the proper
installation Certain scripts
will require elevated access
to the database In order to
provide first create a MySQL
user with all permissions on
the wiki 		database
 
although this is appropriate
in some e g manual creation of
blank tables prior to an
import Most of the PHP scripts
need to be run from the
command line Prior to doing
ensure that the LocalSettings
php file in the directory
above points to the proper
installation Certain scripts
will require elevated access
to the database In order to
provide first create a MySQL
user with all permissions on
the wiki and then set
$wgDBadminuser and
$wgDBadminpassword in your
LocalSettings e g rebuilding
link updating the search etc
The files in the archives
directory are used to upgrade
the database schema when
updating the software Some
schema definitions for and are
not likely to be particularly
useful to the vast majority of
installations This directory
does contain the compressOld 		however
 
although this is appropriate
in some e g manual creation of
blank tables prior to an
import Most of the PHP scripts
need to be run from the
command line Prior to doing
ensure that the LocalSettings
php file in the directory
above points to the proper
installation Certain scripts
will require elevated access
to the database In order to
provide first create a MySQL
user with all permissions on
the wiki and then set
$wgDBadminuser and
$wgDBadminpassword in your
LocalSettings e g rebuilding
link updating the search 		indices
 
although this is appropriate
in some e g manual creation of
blank tables prior to an
import Most of the PHP scripts
need to be run from the
command line Prior to doing
ensure that the LocalSettings
php file in the directory
above points to the proper
installation Certain scripts
will require elevated access
to the database In order to
provide first create a MySQL
user with all permissions on
the wiki and then set
$wgDBadminuser and
$wgDBadminpassword in your
LocalSettings e g rebuilding
link updating the search etc
The files in the archives
directory are used to upgrade
the database schema when
updating the software Some
schema definitions for and are
not likely to be particularly
useful to the vast majority of
installations This directory
does contain the compressOld
which can be useful for
compacting old these should be
run from the command line Not
all scripts are 		listed
 
although this is appropriate
in some e g manual creation of
blank tables prior to an
import Most of the PHP scripts
need to be run from the
command line Prior to doing
ensure that the LocalSettings
php file in the directory
above points to the proper
installation Certain scripts
will require elevated access
to the database In order to
provide first create a MySQL
user with all permissions on
the wiki and then set
$wgDBadminuser and
$wgDBadminpassword in your
LocalSettings 		php
 
although this is appropriate
in some e g manual creation of
blank tables prior to an
import Most of the PHP scripts
need to be run from the
command line Prior to doing
ensure that the LocalSettings
php file in the directory
above points to the proper
installation Certain scripts
will require elevated access
to the database In order to
provide first create a MySQL
user with all permissions on
the wiki and then set
$wgDBadminuser and
$wgDBadminpassword in your
LocalSettings e g rebuilding
link updating the search etc
The files in the archives
directory are used to upgrade
the database schema when
updating the software Some
schema definitions for and are
not likely to be particularly
useful to the vast majority of
installations This directory
does contain the compressOld 		scripts
 
although this is appropriate
in some e g manual creation of
blank tables prior to an
import Most of the PHP scripts
need to be run from the
command line Prior to doing 		so
 
although this is appropriate
in some e g manual creation of
blank tables prior to an
import Most of the PHP scripts
need to be run from the
command line Prior to doing
ensure that the LocalSettings
php file in the directory
above points to the proper
installation Certain scripts
will require elevated access
to the database In order to
provide first create a MySQL
user with all permissions on
the wiki and then set
$wgDBadminuser and
$wgDBadminpassword in your
LocalSettings e g rebuilding
link updating the search etc
The files in the archives
directory are used to upgrade
the database schema when
updating the software Some
schema definitions for and are
not likely to be particularly
useful to the vast majority of
installations This directory
does contain the compressOld
which can be useful for
compacting old these should be
run from the command line Not
all scripts are as some are
Wikimedia 		specific
 
although this is appropriate
in some e g manual creation of
blank tables prior to an
import Most of the PHP scripts
need to be run from the
command line Prior to doing
ensure that the LocalSettings
php file in the directory
above points to the proper
installation Certain scripts
will require elevated access
to the database In order to
provide first create a MySQL
user with all permissions on
the wiki and then set
$wgDBadminuser and
$wgDBadminpassword in your
LocalSettings e g rebuilding
link 		tables
 
although this is appropriate
in some e g manual creation of
blank tables prior to an
import Most of the PHP scripts
need to be run from the
command line Prior to doing
ensure that the LocalSettings
php file in the directory
above points to the proper
installation Certain scripts
will require elevated access
to the database In order to
provide 		this
 

Function Documentation

although this is appropriate in some e g manual creation of blank tables prior to an import Most of the PHP scripts need to be run from the command line Prior to doing ensure that the LocalSettings php file in the directory above points to the proper installation Certain scripts will require elevated access to the database In order to provide first create a MySQL user with all permissions on the wiki and then set $wgDBadminuser and $wgDBadminpassword in your LocalSettings e g rebuilding link updating the search etc The files in the archives directory are used to upgrade the database schema when updating the software Some schema definitions for alternative ( as yet  unsupported)

Variable Documentation

although this is appropriate in some cases

Definition at line 1 of file README.

although this is appropriate in some e g manual creation of blank tables prior to an import Most of the PHP scripts need to be run from the command line Prior to doing ensure that the LocalSettings php file in the directory above points to the proper installation Certain scripts will require elevated access to the database In order to provide first create a MySQL user with all permissions on the wiki and then set $wgDBadminuser and $wgDBadminpassword in your LocalSettings e g rebuilding link updating the search etc The files in the archives directory are used to upgrade the database schema when updating the software Some schema definitions for and are not likely to be particularly useful to the vast majority of installations This directory does contain the compressOld which can be useful for compacting old data
Initial value:
=== Maintenance scripts ===
As noted above
Maintenance
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: maintenance.txt:39
scripts
although this is appropriate in some e g manual creation of blank tables prior to an import Most of the PHP scripts need to be run from the command line Prior to doing ensure that the LocalSettings php file in the directory above points to the proper installation Certain scripts will require elevated access to the database In order to provide first create a MySQL user with all permissions on the wiki and then set $wgDBadminuser and $wgDBadminpassword in your LocalSettings e g rebuilding link updating the search etc The files in the archives directory are used to upgrade the database schema when updating the software Some schema definitions for and are not likely to be particularly useful to the vast majority of installations This directory does contain the compressOld scripts
Definition: README:28
above
within a display generated by the Derivative if and wherever such third party notices normally appear The contents of the NOTICE file are for informational purposes only and do not modify the License You may add Your own attribution notices within Derivative Works that You alongside or as an addendum to the NOTICE text from the provided that such additional attribution notices cannot be construed as modifying the License You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for or distribution of Your or for any such Derivative Works as a provided Your and distribution of the Work otherwise complies with the conditions stated in this License Submission of Contributions Unless You explicitly state any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this without any additional terms or conditions Notwithstanding the above
Definition: APACHE-LICENSE-2.0.txt:114

Definition at line 30 of file README.

although this is appropriate in some e g manual creation of blank tables prior to an import Most of the PHP scripts need to be run from the command line Prior to doing ensure that the LocalSettings php file in the directory above points to the proper installation Certain scripts will require elevated access to the database In order to provide first create a MySQL user with all permissions on the wiki database

Definition at line 1 of file README.

although this is appropriate in some e g manual creation of blank tables prior to an import Most of the PHP scripts need to be run from the command line Prior to doing ensure that the LocalSettings php file in the directory above points to the proper installation Certain scripts will require elevated access to the database In order to provide first create a MySQL user with all permissions on the wiki and then set $wgDBadminuser and $wgDBadminpassword in your LocalSettings e g rebuilding link updating the search etc The files in the archives directory are used to upgrade the database schema when updating the software Some schema definitions for and are not likely to be particularly useful to the vast majority of installations This directory does contain the compressOld however

Definition at line 28 of file README.

Referenced by wfStreamThumb().

although this is appropriate in some e g manual creation of blank tables prior to an import Most of the PHP scripts need to be run from the command line Prior to doing ensure that the LocalSettings php file in the directory above points to the proper installation Certain scripts will require elevated access to the database In order to provide first create a MySQL user with all permissions on the wiki and then set $wgDBadminuser and $wgDBadminpassword in your LocalSettings e g rebuilding link updating the search indices

Definition at line 16 of file README.

although this is appropriate in some e g manual creation of blank tables prior to an import Most of the PHP scripts need to be run from the command line Prior to doing ensure that the LocalSettings php file in the directory above points to the proper installation Certain scripts will require elevated access to the database In order to provide first create a MySQL user with all permissions on the wiki and then set $wgDBadminuser and $wgDBadminpassword in your LocalSettings e g rebuilding link updating the search etc The files in the archives directory are used to upgrade the database schema when updating the software Some schema definitions for and are not likely to be particularly useful to the vast majority of installations This directory does contain the compressOld which can be useful for compacting old these should be run from the command line Not all scripts are listed

Definition at line 30 of file README.

although this is appropriate in some e g manual creation of blank tables prior to an import Most of the PHP scripts need to be run from the command line Prior to doing ensure that the LocalSettings php file in the directory above points to the proper installation Certain scripts will require elevated access to the database In order to provide first create a MySQL user with all permissions on the wiki and then set $wgDBadminuser and $wgDBadminpassword in your LocalSettings php
Initial value:
=== Brief explanation of files ===
A lot of the files in this directory are PHP scripts used to perform various
maintenance tasks on the wiki database
the
#define the
table suitable for use with IDatabase::select()
used
you don t have to do a grep find to see where the $wgReverseTitle variable is used
Definition: hooks.txt:117
PHP
The ContentHandler facility adds support for arbitrary content types on wiki instead of relying on wikitext for everything It was introduced in MediaWiki Each kind of and so on Built in content types as usual *javascript user provided javascript code *json simple implementation for use by etc *css user provided css code *text plain text In PHP
Definition: contenthandler.txt:5
of
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
in
null for the local wiki Added in
Definition: hooks.txt:1435
directory
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
wiki
Prior to maintenance scripts were a hodgepodge of code that had no cohesion or formal method of action Beginning maintenance scripts have been cleaned up to use a unified class Directory structure How to run a script How to write your own DIRECTORY STRUCTURE The maintenance directory of a MediaWiki installation contains several all of which have unique purposes HOW TO RUN A SCRIPT Ridiculously just call php someScript php that s in the top level maintenance directory if not default wiki
Definition: maintenance.txt:1
are
The ContentHandler facility adds support for arbitrary content types on wiki instead of relying on wikitext for everything It was introduced in MediaWiki Each kind of and so on Built in content types are
Definition: contenthandler.txt:5
scripts
although this is appropriate in some e g manual creation of blank tables prior to an import Most of the PHP scripts need to be run from the command line Prior to doing ensure that the LocalSettings php file in the directory above points to the proper installation Certain scripts will require elevated access to the database In order to provide first create a MySQL user with all permissions on the wiki and then set $wgDBadminuser and $wgDBadminpassword in your LocalSettings e g rebuilding link updating the search etc The files in the archives directory are used to upgrade the database schema when updating the software Some schema definitions for and are not likely to be particularly useful to the vast majority of installations This directory does contain the compressOld scripts
Definition: README:28
perform
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 and conversions to other media types Work shall mean the work of whether in Source or Object made available under the as indicated by a copyright notice that is included in or attached to the whether in Source or Object that is based or other modifications as a an original work of authorship For the purposes of this Derivative Works shall not include works that remain separable or merely the Work and Derivative Works thereof Contribution shall mean any work of including the original version of the Work and any modifications or additions to that Work or Derivative Works that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner For the purposes of this submitted means any form of or written communication sent to the Licensor or its including but not limited to communication on electronic mailing source code control and issue tracking systems that are managed or on behalf the Licensor for the purpose of discussing and improving the but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as Not a Contribution Contributor shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work Grant of Copyright License Subject to the terms and conditions of this each Contributor hereby grants to You a non no royalty irrevocable copyright license to prepare Derivative Works publicly publicly perform
Definition: APACHE-LICENSE-2.0.txt:49
files
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
on
We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going on
Definition: hooks.txt:86
database
The various manual files contains special mappings not included in the unihan database
Definition: README:2

Definition at line 16 of file README.

although this is appropriate in some e g manual creation of blank tables prior to an import Most of the PHP scripts need to be run from the command line Prior to doing ensure that the LocalSettings php file in the directory above points to the proper installation Certain scripts will require elevated access to the database In order to provide first create a MySQL user with all permissions on the wiki and then set $wgDBadminuser and $wgDBadminpassword in your LocalSettings e g rebuilding link updating the search etc The files in the archives directory are used to upgrade the database schema when updating the software Some schema definitions for and are not likely to be particularly useful to the vast majority of installations This directory does contain the compressOld scripts

Definition at line 28 of file README.

although this is appropriate in some e g manual creation of blank tables prior to an import Most of the PHP scripts need to be run from the command line Prior to doing so

Definition at line 1 of file README.

although this is appropriate in some e g manual creation of blank tables prior to an import Most of the PHP scripts need to be run from the command line Prior to doing ensure that the LocalSettings php file in the directory above points to the proper installation Certain scripts will require elevated access to the database In order to provide first create a MySQL user with all permissions on the wiki and then set $wgDBadminuser and $wgDBadminpassword in your LocalSettings e g rebuilding link updating the search etc The files in the archives directory are used to upgrade the database schema when updating the software Some schema definitions for and are not likely to be particularly useful to the vast majority of installations This directory does contain the compressOld which can be useful for compacting old these should be run from the command line Not all scripts are as some are Wikimedia specific

Definition at line 30 of file README.

Referenced by UpdateLogging::execute(), and CheckLanguageCLI::help().

although this is appropriate in some e g manual creation of blank tables prior to an import Most of the PHP scripts need to be run from the command line Prior to doing ensure that the LocalSettings php file in the directory above points to the proper installation Certain scripts will require elevated access to the database In order to provide first create a MySQL user with all permissions on the wiki and then set $wgDBadminuser and $wgDBadminpassword in your LocalSettings e g rebuilding link tables

Definition at line 16 of file README.

Referenced by ApiQueryBase::addTables(), ApiQueryBase::resetQueryParams(), and ApiQueryBase::select().

although this is appropriate in some e g manual creation of blank tables prior to an import Most of the PHP scripts need to be run from the command line Prior to doing ensure that the LocalSettings php file in the directory above points to the proper installation Certain scripts will require elevated access to the database In order to provide this

Definition at line 1 of file README.