docs/scripts.txt

   1 scripts.txt
   2
   3 MediaWiki primary scripts are in the root directory of the software. Users
   4 should only use these scripts to access the wiki. There are also some .php that
   5 aren't primary scripts but helper files and won't work if they are accessed
   6 directly by the web.
   7
   8 Primary scripts:
   9
  10   index.php
  11     Main access point. It handles the most of requests.
  12     See http://www.mediawiki.org/wiki/Manual:Index.php
  13
  14   api.php
  15     Script to provide an API for bots to fetch content and informations about
  16     the site and also modify it. See http://www.mediawiki.org/wiki/API
  17     for more informations.
  18
  19   img_auth.php
  20     Script that only serve images to logged in users. To configure the wiki
  21     to use that script, see http://www.mediawiki.org/wiki/Manual:Image_Authorisation.
  22
  23   opensearch_desc.php
  24     Returns a OpenSearch description document (see http://www.opensearch.org/)
  25     that points to the search engines of the wiki.
  26
  27   profileinfo.php
  28     Allow users to see the profiling information that are stored in the
  29     database.
  30
  31     To save the profiling information in the database (required to use this
  32     script), you have to modify StartProfiler.php to use the Profiler class and
  33     not the stub profiler which is enabled by default.
  34     You will also need to set $wgProfileToDatabase to true in LocalSettings.php
  35     to force the profiler to save the informations in the database and apply the
  36     maintenance/archives/patch-profiling.sql patch to the database.
  37
  38     To enable the profileinfo.php itself, you'll need to create the
  39     AdminSettings.php file (see AdminSettings.sample for more information) and
  40     set $wgEnableProfileInfo to true in that file. See also
  41     http://www.mediawiki.org/wiki/How_to_debug#Profiling.
  42
  43   redirect.php
  44     Script that only redirect to the article passed in the wpDropdown parameter
  45     of the request. Used by the nostalgia skin to access special pages with the
  46     dropdown box at the top of the page.
  47
  48   thumb.php
  49     Script used to resize images if it is configured to be done when the web
  50     browser requests the image and not when generating the page. This script can
  51     be used as a 404 handler to generate image thumbs when they don't exist.
  52
  53   trackback.php
  54     Allow to add a new trackback to the database. This script returns XML
  55     and require a POST request to work, thus it should only be accessed by some
  56     specific programs and won't work with normal web browsers.
  57
  58 There is also a file with a .php5 extension for each script. They can be used if
  59 the web server needs a .php5 to run the file with the PHP 5 engine and runs .php
  60 scripts with PHP 4. To use these files, you have to modify $wgScriptExtension to
  61 '.php5' is LocalSettings.php but it is already done by the config script if you
  62 used the config/index.php5 script.
  63