BUG#463 Strip first leading blank from preformatted text in output
[lhc/web/wiklou.git] / includes / DefaultSettings.php
index 1815178..6dc5caf 100644 (file)
@@ -1,22 +1,47 @@
 <?php
-
-# $Id$
-# DO NOT EDIT THIS FILE!
-# To customize your installation, edit "LocalSettings.php".
-# Note that since all these string interpolations are expanded
-# before LocalSettings is included, if you localize something
-# like $wgScriptPath, you must also localize everything that
-# depends on it.
+/**
+ * DO NOT EDIT THIS FILE!
+ *
+ * To customize your installation, edit "LocalSettings.php".
+ *
+ * Note that since all these string interpolations are expanded
+ * before LocalSettings is included, if you localize something
+ * like $wgScriptPath, you must also localize everything that
+ * depends on it.
+ *
+ * @version $Id$
+ * @package MediaWiki
+ */
 
 # This is not a valid entry point, perform no further processing unless MEDIAWIKI is defined
-if( defined( "MEDIAWIKI" ) ) {
+if( defined( 'MEDIAWIKI' ) ) {
 
+/**
+ * MediaWiki version number
+ * @global string $wgVersion
+ */
 $wgVersion                     = '1.4-prealpha';
 
-$wgSitename         = 'MediaWiki'; # Please customize!
-$wgMetaNamespace    = FALSE; # will be same as you set $wgSitename
-
-
+/** 
+ * Name of the site.
+ * It must be changed in LocalSettings.php
+ * @global string $wgSitename
+ */
+$wgSitename         = 'MediaWiki';
+
+/**
+ * Will be same as you set @see $wgSitename
+ * @global mixed $wgMetaNamespace
+ */
+$wgMetaNamespace    = FALSE;
+
+
+/** 
+ * URL of the server
+ * It will be automaticly build including https mode
+ * @global string $wgServer
+ */
+$wgServer = '';
 # check if server use https:
 $wgProto = (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on') ? 'https' : 'http';
 
@@ -28,18 +53,51 @@ if ( @$wgCommandLineMode ) {
 }
 unset($wgProto);
 
+
+/**
+ * The path we should point to.
+ * It might be a virtual path in case with use apache mod_rewrite for example
+ * @global string $wgScriptPath
+ */
 $wgScriptPath      = '/wiki';
 
-# Whether to support URLs like index.php/Page_title
+/**
+ * Whether to support URLs like index.php/Page_title
+ * @global bool $wgUsePathInfo
+ */
 $wgUsePathInfo         = ( strpos( php_sapi_name(), 'cgi' ) === false );
 
-# ATTN: Old installations used wiki.phtml and redirect.phtml -
-# make sure that LocalSettings.php is correctly set!
+
+/**#@+
+ * Script users will request to get articles
+ * ATTN: Old installations used wiki.phtml and redirect.phtml -
+ * make sure that LocalSettings.php is correctly set!
+ * @deprecated
+ */
+/** 
+ *     @global string $wgScript
+ */
 $wgScript           = "{$wgScriptPath}/index.php";
+/**
+ *     @global string $wgRedirectScript
+ */
 $wgRedirectScript   = "{$wgScriptPath}/redirect.php";
-
-$wgStylePath   = "{$wgScriptPath}/style";
-$wgStyleDirectory = "{$IP}/style";
+/**#@-*/
+
+
+/**#@+
+ * @global string
+ */
+/**
+ * style path as seen by users
+ * @global string $wgStylePath
+ */
+$wgStylePath   = "{$wgScriptPath}/skins";
+/**
+ * filesystem stylesheets directory
+ * @global string $wgStyleDirectory
+ */
+$wgStyleDirectory = "{$IP}/skins";
 $wgStyleSheetPath = &$wgStylePath;
 $wgStyleSheetDirectory = &$wgStyleDirectory;
 $wgArticlePath      = "{$wgScript}?title=$1";
@@ -49,21 +107,69 @@ $wgLogo                            = "{$wgUploadPath}/wiki.png";
 $wgMathPath         = "{$wgUploadPath}/math";
 $wgMathDirectory    = "{$wgUploadDirectory}/math";
 $wgTmpDirectory     = "{$wgUploadDirectory}/tmp";
+/**#@-*/
+
+
+# Email settings
+#
+/**
+ * Site admin email address
+ * Default to wikiadmin@SERVER_NAME
+ * @global string $wgEmergencyContact
+ */
 $wgEmergencyContact = 'wikiadmin@' . getenv( 'SERVER_NAME' );
+/**
+ * Password reminder email address
+ * The address we should use as sender when a user is requesting his password
+ * Default to apache@SERVER_NAME
+ * @global string $wgPasswordSender
+ */
 $wgPasswordSender      = 'Wikipedia Mail <apache@' . getenv( 'SERVER_NAME' ) . '>';
 
-# For using a direct (authenticated) SMTP server connection.
-# "host" => 'SMTP domain', "IDHost" => 'domain for MessageID', "port" => "25", "auth" => true/false, "username" => user, "password" => password
+
+/**
+ * SMTP Mode
+ * For using a direct (authenticated) SMTP server connection. 
+ * Default to false or fill an array :
+ * <code>
+ * "host" => 'SMTP domain',
+ * "IDHost" => 'domain for MessageID',
+ * "port" => "25",
+ * "auth" => true/false,
+ * "username" => user,
+ * "password" => password
+ * </code>
+ *
+ * @global mixed $wgSMTP
+ */
 $wgSMTP                                = false;
 
-# Database settings
-#
+
+/**#@+
+ * Database settings
+ */
+/** database host name or ip address */
 $wgDBserver         = 'localhost';
+/** name of the database */
 $wgDBname           = 'wikidb';
+/** */
 $wgDBconnection     = '';
+/** Database username */
 $wgDBuser           = 'wikiuser';
-$wgDBtype           = "mysql"; # "mysql" for working code and "PostgreSQL" for development/broken code
-$wgDBprefix         = ''; # Table name prefix
+/** Database type
+ * "mysql" for working code and "PostgreSQL" for development/broken code
+ */
+$wgDBtype           = "mysql";
+/** Table name prefix */
+$wgDBprefix         = ''; 
+/**#@-*/
+
+# Shared database for multiple wikis.
+# Presently used for storing a user table for single sign-on
+# The server for this database must be the same as for the main
+# database.
+# EXPERIMENTAL
+# $wgSharedDB='';
 
 # Database load balancer
 # This is a two-dimensional array, an array of server info structures
@@ -85,6 +191,9 @@ $wgDBprefix         = ''; # Table name prefix
 $wgDBservers           = false; 
 
 # Sysop SQL queries
+#   The sql user shouldn't have too many rights other the database, restrict
+#   it to SELECT only on 'cur' table for example
+#
 $wgAllowSysopQueries = false; # Dangerous if not configured properly.
 $wgDBsqluser           = 'sqluser';
 $wgDBsqlpassword       = 'sqlpass';
@@ -92,6 +201,11 @@ $wgDBpassword       = 'userpass';
 $wgSqlLogFile           = "{$wgUploadDirectory}/sqllog_mFhyRe6";
 $wgDBerrorLog          = false; # File to log MySQL errors to
 
+# wgDBminWordLen :
+#  MySQL 3.x : used to discard words that MySQL will not return any results for
+#  shorter values configure mysql directly
+#  MySQL 4.x : ignore it and configure mySQL
+# See: http://dev.mysql.com/doc/mysql/en/Fulltext_Fine-tuning.html
 $wgDBminWordLen     = 4;
 $wgDBtransactions      = false; # Set to true if using InnoDB tables
 $wgDBmysql4                    = false; # Set to true to use enhanced fulltext search
@@ -103,7 +217,8 @@ $wgBufferSQLResults     = true; # use buffered queries by default
 # Array, interwiki prefix => database name
 $wgLocalDatabases   = array();
 
-# memcached settings
+
+# Memcached settings
 # See docs/memcached.doc
 #
 $wgMemCachedDebug   = false; # Will be set to false in Setup.php, if the server isn't working
@@ -113,11 +228,45 @@ $wgMemCachedDebug   = false;
 $wgSessionsInMemcached = false;
 $wgLinkCacheMemcached = false; # Not fully tested
 
+/**
+ * Turck MMCache shared memory
+ * You can use this for persistent caching where your wiki runs on a small
+ * number of servers. Mutually exclusive with memcached. MMCache must be
+ * installed.
+ *
+ * @global bool $wgUseTurckShm Enable or disabled Turck MMCache
+ */
+$wgUseTurckShm      = false;
+
+
 # Language settings
 #
+/**
+ * Site language code
+ * Default to 'en'. Should be one of ./language/Language(.*).php
+ * @global string $wgLanguageCode
+ */
 $wgLanguageCode     = 'en';
-$wgLanguageFile     = false; # Filename of a language file generated by dumpMessages.php
-$wgInterwikiMagic      = true; # Treat language links as magic connectors, not inline links
+
+/**
+ * Languages which the user may select to display the user interface
+ * in instead of the default language. This option is currently
+ * experimental and WILL FAIL FOR MANY COMMON TASKS AND PERHAPS
+ * CORRUPT YOUR DATABASE WITH BOGUS DATA.
+ * Set to eg array( 'en', 'fr', 'zh' ) etc
+ */
+$wgUserLanguages = array();
+
+/**
+ * Filename of a language file generated by dumpMessages.php
+ * @global string|false $wgLanguageFile (default:false)
+ */
+$wgLanguageFile     = false;
+/**
+ * Treat language links as magic connectors, not inline links
+ * @global bool $wgInterwikiMagic (default:true)
+ */
+$wgInterwikiMagic      = true;
 $wgInputEncoding       = 'ISO-8859-1'; # LanguageUtf8.php normally overrides this
 $wgOutputEncoding      = 'ISO-8859-1'; # unless you set the next option to true:
 $wgUseLatin1           = false; # Enable ISO-8859-1 compatibility mode
@@ -132,26 +281,35 @@ $wgAmericanDates    = false; # Enable for English module to print dates
 $wgTranslateNumerals = true; # For Hindi and Arabic use local numerals instead
                              # of Western style (0-9) numerals in interface.
 
-$wgLocalInterwiki   = 'w';
-$wgShowIPinHeader      = true; # For non-logged in users
-$wgMaxNameChars     = 32; # Maximum number of bytes in username
-$wgInterwikiExpiry = 10800; # Expiry time for cache of interwiki table
 
 # Translation using MediaWiki: namespace
 # This will increase load times by 25-60% unless memcached is installed
+# Interface messages will be get from the database.
 $wgUseDatabaseMessages = true;
 $wgMsgCacheExpiry      = 86400;
 
-$wgExtraSubtitle       = '';
-$wgSiteSupportPage     = '';
 
 # Miscellaneous configuration settings
 #
+
+$wgLocalInterwiki   = 'w';
+$wgInterwikiExpiry = 10800; # Expiry time for cache of interwiki table
+
+$wgShowIPinHeader      = true; # For non-logged in users
+$wgMaxNameChars     = 32; # Maximum number of bytes in username
+
+$wgExtraSubtitle       = '';
+$wgSiteSupportPage     = ''; # A page where you users can receive donations
+
 $wgReadOnlyFile         = "{$wgUploadDirectory}/lock_yBgMBwiR";
 
 # The debug log file should be not be publicly accessible if it is
 # used, as it may contain private data.
 $wgDebugLogFile         = '';
+
+/**#@+
+ * @global bool
+ */
 $wgDebugRedirects              = false;
 $wgDebugRawPage         = false; # Avoid overlapping debug entries by leaving out CSS
 
@@ -177,8 +335,10 @@ $wgUseCategoryBrowser   = false;
 
 $wgEnablePersistentLC  = false;        # Obsolete, do not use
 $wgCompressedPersistentLC = true; # use gzcompressed blobs
+$wgUseOldExistenceCheck = false;  # use old prefill link method, for debugging only
 
 $wgEnableParserCache = false; # requires that php was compiled --with-zlib
+/**#@-*/
 
 # wgHitcounterUpdateFreq sets how often page counters should be
 # updated, higher values are easier on the database. A value of 1
@@ -188,22 +348,35 @@ $wgEnableParserCache = false; # requires that php was compiled --with-zlib
 
 $wgHitcounterUpdateFreq = 1;
 
-# User rights 
+# User rights
+#   It's not 100% safe, there could be security hole using that one. Use at your
+# own risks.
+
 $wgWhitelistEdit = false;   # true = user must login to edit.
 $wgWhitelistRead = false;      # Pages anonymous user may see, like: = array ( ":Main_Page", "Special:Userlogin", "Wikipedia:Help");
 $wgWhitelistAccount = array ( 'user' => 1, 'sysop' => 1, 'developer' => 1 );
+
+$wgAllowAnonymousMinor = false; # Allow anonymous users to mark changes as 'minor'
+
 $wgSysopUserBans        = false; # Allow sysops to ban logged-in users
 $wgSysopRangeBans              = false; # Allow sysops to ban IP ranges
 $wgDefaultBlockExpiry  = '24 hours'; # default expiry time
                                 # strtotime format, or "infinite" for an infinite block
 $wgAutoblockExpiry             = 86400; # Number of seconds before autoblock entries expire
+
+# Proxy scanner settings
+#
 $wgBlockOpenProxies = false; # Automatic open proxy test on edit
 $wgProxyPorts = array( 80, 81, 1080, 3128, 6588, 8000, 8080, 8888, 65506 );
 $wgProxyScriptPath = "$IP/proxy_check.php";
 $wgProxyMemcExpiry = 86400;
 $wgProxyKey = 'W1svekXc5u6lZllTZOwnzEk1nbs';
 $wgProxyList = array();  # big list of banned IP addresses, in the keys not the values
-$wgAccountCreationThrottle = 0; # Number of accounts each IP address may create, 0 to disable. Requires memcached
+
+# Number of accounts each IP address may create, 0 to disable.
+# Requires memcached
+$wgAccountCreationThrottle = 0;
+
 
 # Client-side caching:
 $wgCachePages       = true; # Allow client-side caching of pages
@@ -212,6 +385,7 @@ $wgCachePages       = true; # Allow client-side caching of pages
 # Affects both client- and server-side caching.
 $wgCacheEpoch = '20030516000000';
 
+
 # Server-side caching:
 #  This will cache static pages for non-logged-in users
 #  to reduce database traffic on public sites.
@@ -219,21 +393,36 @@ $wgCacheEpoch = '20030516000000';
 $wgUseFileCache = false;
 $wgFileCacheDirectory = "{$wgUploadDirectory}/cache";
 
+# When using the file cache, we can store the cached HTML gzipped to save disk
+# space. Pages will then also be served compressed to clients that support it.
+# THIS IS NOT COMPATIBLE with ob_gzhandler which is now enabled if supported in
+# the default LocalSettings.php! If you enable this, remove that setting first.
+#
+# Requires zlib support enabled in PHP.
+$wgUseGzip = false;
+
+
 $wgCookieExpiration = 2592000;
 
+
 # Squid-related settings
 #
+
 # Enable/disable Squid
  $wgUseSquid = false;
 # If you run Squid3 with ESI support, enable this (default:false):
  $wgUseESI = false;
 # Internal server name as known to Squid, if different
 # $wgInternalServer = 'http://yourinternal.tld:8000';
  $wgInternalServer = $wgServer;
 # Cache timeout for the squid, will be sent as s-maxage (without ESI) or 
 # Surrogate-Control (with ESI). Without ESI, you should strip out s-maxage in the Squid config.
 # 18000 seconds = 5 hours, more cache hits with 2678400 = 31 days
  $wgSquidMaxage = 18000;
 # A list of proxy servers (ips if possible) to purge on changes
 # don't specify ports here (80 is default)
 # $wgSquidServers = array('127.0.0.1');
@@ -242,17 +431,20 @@ $wgCookieExpiration = 2592000;
 $wgMaxSquidPurgeTitles = 400;
 
 
-# Set to set an explicit domain on the login cookies
-# eg, "justthis.domain.org" or ".any.subdomain.net"
+# Cookie settings:
+#   Set to set an explicit domain on the login cookies
+#   eg, "justthis.domain.org" or ".any.subdomain.net"
 $wgCookieDomain = '';
 $wgCookiePath = '/';
 $wgDisableCookieCheck = false;
 
+# Whether to allow inline image pointing to other websites
 $wgAllowExternalImages = true;
+
 $wgMiserMode = false; # Disable database-intensive features
 $wgDisableQueryPages = false; # Disable all query pages if miser mode is on, not just some
 $wgUseWatchlistCache = false; # Generate a watchlist once every hour or so
-$wgWLCacheTimeout = 3600;      # The hour or so mentioned above
+$wgWLCacheTimeout = 3600;     # The hour or so mentioned above
 
 # To use inline TeX, you need to compile 'texvc' (in the 'math' subdirectory
 # of the MediaWiki package and have latex, dvips, gs (ghostscript), and
@@ -279,15 +471,11 @@ $wgDisableUploads = true; # Uploads have to be specially set up to be secure
 $wgRemoteUploads = false; # Set to true to enable the upload _link_ while local uploads are disabled. Assumes that the special page link will be bounced to another server where uploads do work.
 $wgDisableAnonTalk = false;
 
-# We can serve pages compressed in order to save bandwidth,
-# but this will increase CPU usage.
-# Requires zlib support enabled in PHP.
-$wgUseGzip = function_exists( 'gzencode' );
-
 # Path to the GNU diff3 utility. If the file doesn't exist,
 # edit conflicts will fall back to the old behaviour (no merging).
 $wgDiff3 = '/usr/bin/diff3';
 
+
 # We can also compress text in the old revisions table. If this is set on,
 # old revisions will be compressed on page save if zlib support is available.
 # Any compressed revisions will be decompressed on load regardless of this
@@ -334,9 +522,6 @@ $wgNamespacesToBeSearchedDefault = array( -1 => 0, 0 => 1, 1 => 0,
 # If set, a bold ugly notice will show up at the top of every page.
 $wgSiteNotice = "";
 
-# Whether to allow anonymous users to set changes to 'minor'
-$wgAllowAnonymousMinor = false;
-
 ## Set $wgUseImageResize to true if you want to enable dynamic
 ## server side image resizing ("Thumbnails")
 # 
@@ -452,6 +637,7 @@ $wgDefaultSkin = 'monobook';
 $wgAllowRealName = true;
 
 # Extensions
+$wgSkinExtensionFunctions = array();
 $wgExtensionFunctions = array();
 
 # Allow user Javascript page?
@@ -482,6 +668,39 @@ $wgUseExternalDiffEngine = false;
 # Use RC Patrolling to check for vandalism
 $wgUseRCPatrol = true;
 
+# Additional namespaces. If the namespaces defined in Language.php and Namespace.php are insufficient,
+# you can create new ones here, for example, to import Help files in other languages.
+# PLEASE NOTE: Once you delete a namespace, the pages in that namespace will no longer be accessible.
+# If you rename it, then you can access them through the new namespace name.
+#
+# Custom namespaces should start at 100.
+#$wgExtraNamespaces =
+#      array(100 => "Hilfe",
+#            101 => "Hilfe_Diskussion",
+#            102 => "Aide",
+#            103 => "Discussion_Aide"
+#            );
+$wgExtraNamespaces = NULL;
+
+# Enable SOAP interface. Off by default
+# SOAP is a protocoll for remote procedure calls (RPC) using http as middleware.
+# This interface can be used by bots or special clients to receive articles from
+# a wiki.
+# Most bots use the normal HTTP interface and don't use SOAP.
+# If unsure, set to false.
+$wgEnableSOAP = false;
+
+# Limit images on image description pages to a user-selectable limit. In order to
+# reduce disk usage, limits can only be selected from a list. This is the list of
+# settings the user can choose from:
+$wgImageLimits = array (
+       array(320,240),
+       array(640,480),
+       array(800,600),
+       array(1024,768),
+       array(1280,1024),
+       array(10000,10000) );
+
 } else {
        die();
 }