allow turning off image path hashing. there was a feature request for that somewhere.
[lhc/web/wiklou.git] / includes / DefaultSettings.php
index b1c90fe..a07faa1 100644 (file)
 <?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' ) ) {
 
+/**
+ * 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 = '';
+
+if( isset( $_SERVER['SERVER_NAME'] ) ) {
+       $wgServerName = $_SERVER['SERVER_NAME'];
+} elseif( isset( $_SERVER['HOSTNAME'] ) ) {
+       $wgServerName = $_SERVER['HOSTNAME'];
+} else {
+       # FIXME: Fall back on... something else?
+       $wgServerName = 'localhost';
+}
 
 # check if server use https:
 $wgProto = (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on') ? 'https' : 'http';
 
-if ( @$wgCommandLineMode ) {
-       $wgServer = $wgProto.'://localhost';
-} else {
-       $wgServer           = $wgProto.'://' . $_SERVER['SERVER_NAME'];
-       if( $_SERVER['SERVER_PORT'] != 80 ) $wgServer .= ":" . $_SERVER['SERVER_PORT'];
+$wgServer = $wgProto.'://' . $wgServerName;
+if( isset( $_SERVER['SERVER_PORT'] ) && $_SERVER['SERVER_PORT'] != 80 ) {
+       $wgServer .= ":" . $_SERVER['SERVER_PORT'];
 }
 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";
-
-
-# Paths Settings
-# 
-$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";
 $wgUploadPath       = "{$wgScriptPath}/upload";
 $wgUploadDirectory     = "{$IP}/upload";
+$wgHashedUploadDirectory       = true;
 $wgLogo                                = "{$wgUploadPath}/wiki.png";
 $wgMathPath         = "{$wgUploadPath}/math";
 $wgMathDirectory    = "{$wgUploadDirectory}/math";
 $wgTmpDirectory     = "{$wgUploadDirectory}/tmp";
+$wgUploadBaseUrl    = "";
+/**#@-*/
 
 
 # Email settings
 #
-$wgEmergencyContact = 'wikiadmin@' . getenv( 'SERVER_NAME' );
-$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
+/**
+ * Site admin email address
+ * Default to wikiadmin@SERVER_NAME
+ * @global string $wgEmergencyContact
+ */
+$wgEmergencyContact = 'wikiadmin@' . $wgServerName;
+
+/**
+ * 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@' . $wgServerName . '>';
+
+
+/**
+ * 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";
+/** Search type
+ * "MyISAM" for MySQL native full text search, "Tsearch2" for PostgreSQL
+ * based search engine
+ */
+$wgSearchType      = "MyISAM";
+/** Table name prefix */
+$wgDBprefix         = ''; 
+/** Database schema
+ * on some databases this allows separate 
+ * logical namespace for application data
+ */
+$wgDBschema        = 'mediawiki';
+/**#@-*/
+
+
 
 # Shared database for multiple wikis.
 # Presently used for storing a user table for single sign-on
@@ -138,17 +251,36 @@ $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.
+/**
+ * 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
+
+/**
+ * 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
@@ -184,10 +316,15 @@ $wgExtraSubtitle  = '';
 $wgSiteSupportPage     = ''; # A page where you users can receive donations
 
 $wgReadOnlyFile         = "{$wgUploadDirectory}/lock_yBgMBwiR";
+$wgUseData = false ;
 
 # 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
 
@@ -216,6 +353,7 @@ $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
@@ -404,10 +542,6 @@ $wgSiteNotice = "";
 # 
 $wgUseImageResize              = false;
 
-## Set maximum width of images on image description pages.
-## Images bigger than this will be rendered down.
-$wgMaxImageWidth = 800;
-
 ## Resizing can be done using PHP's internal image libraries
 ## or using ImageMagick. The later supports more file formats
 ## than PHP, which only supports PNG, GIF, JPG, XBM and WBMP.
@@ -494,9 +628,9 @@ $wgGoToEdit = false;
 $wgUserHtml = true;
 
 # Allow raw, unchecked HTML in <html>...</html> sections.
-# THIS IS VERY DANGEROUS on a publically editable site.
-# Don't enable it unless you've restricted editing to trusted
-# users only.
+# THIS IS VERY DANGEROUS on a publically editable site, so
+# you can't enable it unless you've restricted editing to
+# trusted users only with $wgWhitelistEdit.
 $wgRawHtml = false;
 
 # $wgUseTidy: use tidy to make sure HTML output is sane.
@@ -555,16 +689,50 @@ $wgUseRCPatrol = true;
 # If you rename it, then you can access them through the new namespace name.
 #
 # Custom namespaces should start at 100.
-#$wgExtraNamespaces
-#      array(100 => "Hilfe", 
+#$wgExtraNamespaces =
+#      array(100 => "Hilfe",
 #            101 => "Hilfe_Diskussion",
-#            102 =>"Aide", 
-#            103 =>"Discussion_Aide"
+#            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) );
+
+
+# Navigation links for the user sidebar.
+# 'text' is the name of the MediaWiki message that contains the label of this link
+# 'href' is the name of the MediaWiki message that contains the link target of this link.
+#        Link targets starting with http are considered remote links. Ones not starting with
+#        http are considered as names of local wiki pages.
+$wgNavigationLinks = array (
+       array( 'text'=>'mainpage',      'href'=>'mainpage' ),
+       array( 'text'=>'portal',        'href'=>'portal-url' ),
+       array( 'text'=>'currentevents', 'href'=>'currentevents-url' ),
+       array( 'text'=>'recentchanges', 'href'=>'recentchanges-url' ),
+       array( 'text'=>'randompage',    'href'=>'randompage-url' ),
+       array( 'text'=>'help',          'href'=>'helppage' ),
+       array( 'text'=>'sitesupport',   'href'=>'sitesupport-url' ),
+);
+
+
 } else {
        die();
 }