Was this page helpful?

MindTouch $wg Variables

    Table of contents
    No headers

    The following is a list of all the $wg Variables in includes/DefaultSettings.php

     

    $wgSiteName (deprecated)

        Use the configuration setting ui/sitename 

    $wgProto
        Determines the protocol the site uses (http or https).

    $wgControlPanelPath
       
    Path to the control panel code (default: /deki/cp/).

    $wgDekiPluginPath
        Path to the plugins root directory (default: /deki/plugins).

    $wgStylePath
        Uri path to the skins directory (default: /skins).

    $wgStyleDirectory
        Filesystem path to the skins directory (default: $IP/skins)

    $wgResourcesDirectory
        Filesystem path to the resources directory containing localization strings (default: $IP/resources)

    $wgStyleSheetPath
        Same as $wgStylePath

    $wgStyleSheetDirectory
        Same as $wgStyleDirectory

    $wgLogoDefault
        Uri path to the default site logo (default: /common/logo/logo.png)

    $wgLogo
        Uri path to the current logo (set from ui/logo-uri configuration setting)

    $wgCacheDirectory
        Filesystem path to the skin cache directory (default: $IP/skins/common/cache)

    $wgCachePath
        Uri path to the skins cache directory (default: /skins/common/cache)

    $wgLocalCssPath
        Uri to custom CSS endpoint (default: $wgStylePath/common/custom_css.php)

    $wgPasswordSender (deprecated)
        From address for sending emails.  Use Email Settings in the control panel instead of $wgPasswordSender.

    $wgDBserver
        Database server name. (default: localhost)

    $wgDBport
        Database port (default: 3306)

    $wgDBname
        Databse name (default: wikidb)

    $wgDBuser
        Database user (default: wikiuser)

    $wgSqlTimeout (deprecated)
        Database query timeout.  Deprecated since all queries 

    $wgLanguageCode (deprecated)
        Default language.  Use ui/language in configuration settings instead.

    $wgInputEncoding
        Input encoding (default: UTF-8)

    $wgOutputEncoding
        Output encoding (default: UTF-8)

    $wgMimeType
        Mime type of pages (default: text/html)

    $wgDocType
        DocType of pages (default: -//W3C//DTD XHTML 1.0 Transitional//EN)

    $wgDTD
        DTD of pages (default: http://www.w3.org/TR/xhtml1/DTD/xhtm...ansitional.dtd)

    $wgDebugRedirects
        Displays Location header instead of redirecting (default: false)

    $wgDebugRawPage (deprecated)
        Avoid overlapping debug entries by leaving out CSS (default: false)

    $wgDebugComments (deprecated)

    $wgReadOnly (deprecated)

    $wgLogQueries (deprecated)

    $wgDebugDumpSql (deprecated)

    $wgShowSQLErrors
        Show mysql query when a query errors (default: false)

    $wgBlockedNamespaces
        Namespaces which are not editable (default: array(NS_ADMIN, NS_ATTACHMENT))

    $wgCanonicalAlternateNamespaces (deprecated)
        Custom localized namespaces; map any string to any namespace below (default: array())

    $wgCacheEpoch (deprecated)
        Set this to current time to invalidate all prior cached pages. Affects both client- and server-side caching. (Default: 20030516000000)

    $wgUseGzip (deprecated)

    $wgUseGzDisplay
        Determines if content should be gzipped (default: true)

    $wgDisabledGzip
        Disable Gzip output (default: false)

    $wgCookieExpiration
        Default cookie expiration time.  Can also be set using configuration key: security/cookie-expire-secs (default: 561600)

    $wgClockSkewFudge (deprecated)

    $wgInternalServer (deprecated)

    $wgCookieDomain
        Cookie domain (default: '')

    $wgCookiePath (deprecated)
        Cookie path (default: /)

    $wgCookieSecure
        If using https, cookie is marked as secure (default: null, false)

    $wgCookieHttpOnly
        Set authentication cookies to httpOnly to prevent stealing by JS, in browsers that support this feature (default: true)

    $wgProfiling (deprecated)

    $wgProfileLimit (deprecated)

    $wgProfileOnly (deprecated)

    $wgProfileToDatabase (deprecated)

    $wgProfileSampleRate (deprecated)

    $wgProfileCallTree (deprecated)

    $wgProfileToCommentUser (deprecated)

    $wgDebugProfiling (deprecated)

    $wgDebugFunctionEntry (deprecated)

    $wgProfileApi
        Displays API execution time in comments in page output (default: false)

    $wgDisableCounters (deprecated)

    $wgStyledExtensions
        The list of extensions for which we have special file icons.  Default: array('jpg', 'jpeg', 'jpe', 'gif', 'png', 'sh', 'txt', 'doc', 'zip', 'pdf',
            'xls', 'csv', 'xlsx', 'xlsm', 'xltx', 'xltm', 'xlsb', 'xlam',

            'ppt', 'pps', 'pptx', 'pptm', 'potx', 'potm', 'ppam', 'ppsx', 'ppsm',
            'doc', 'rtf', 'txt', 'docx', 'docm', 'dotx', 'dotm',
            'fla', 'swf', 'tar', 'rar', 'gzip', 'html', 'htm', 'shtml',
            'wmv', 'avi', 'mov', 'mpg', 'mp4', 'mpeg')
     

    $wgImageExtensions
        Files with these file extensions will show up in the image gallery; if no extension is set, will check mimetype for image/* (Default: array('png', 'gif', 'jpg', 'jpeg', 'jpe', 'bmp');)

    $wgWriteViewer
        Extensions showing the document icon.  (Default: array('doc', 'rtf', 'docx', 'docm', 'dotx', 'dotm') )

    $wgCalcViewer
        Extensions showing the Calculator icon.  (Default: array('xls', 'xlsx', 'xlsm', 'xltx', 'xltm', 'xlsb', 'xlam') )

    $wgShowViewer
        Extensions showing the Presentation icon. (Default: array('ppt', 'pps', 'pptx', 'pptm', 'potx', 'potm', 'ppam', 'ppsx', 'ppsm') )

    $wgWebDavExtensions
        Extensions that enable editing over WebDAV on Windows platforms (Default: array_merge($wgWriteViewer, $wgCalcViewer, $wgShowViewer) )

    $wgImageMagickConvertCommand (deprecated)
        Imagemagic binaries are defined in mindtouch.deki.startup.xml (imagemagick-convert-path, imagemagick-identify-path)

    $wgRCMaxAge (deprecated)

    $wgActiveTemplate
    $wgDefaultTemplate

       Skin template.  Overriden by configuration key ui/template.  (Default: deuce)

    $wgActiveSkin
    $wgDefaultSkin

        Skin name.  Overriden by configuration key ui/skin.  (Default: lighty-blue)

    $wgTemplateOverrides
        Custom overrides for template variables (Default: array())

    $wgAllowRealName (deprecated)

    $wgExtensionFunctions (deprecated)

    $wgDekiPluginMode
        Determines whether to load all plugins in plugins directory or only those whitelisted/blacklisted (Default: safe)  

    $wgDefaultDekiPlugins
        Array of enabled plugins. (Default: array('atd_spell_checker', 'files_table', 'image_gallery_lite', 'mindtouch_default', 'nav_pane', 'page_editor', 'page_editor_ckeditor', 'page_tags', 'page_alerts', 'page_template_selector', 'param_switches', 'sitemap', 'special_page', 'special_search', 'user_dashboard', 'page_content_rating', 'page_title_editor', 'site_announcement', 'tooltips', 'json_site_functions'))

    $wgDekiPlugins
        Array of enabled plugins. (Default: $wgDefaultDekiPlugins)

    $wgDefaultDekiSpecialPages
        Array of enabled special pages.  (Default: array('special_about', 'special_admin', 'special_article', 'special_contributions', 'special_events','special_listrss', 'special_listtemplates', 'special_listusers', 'special_package', 'special_pageemail', 'special_pageproperties', 'special_pagerestrictions', 'special_popularpages', 'special_recentchanges', 'special_sitemap', 'special_specialpages', 'special_tags', 'special_userban', 'special_userlogin', 'special_userlogout', 'special_userpassword', 'special_userpreferences', 'special_userregistration', 'special_watchedpages', 'special_watchlist'))

    $wgDekiSpecialPages
        User defined list of additional special page plugins to load.  (Default: array())

    $wgDefaultDekiUserDashboardPlugins
        Determines which internal dashboard plugins to load.  (Default: array('user_page'))

    $wgDisabledDekiPlugins
        User defined list of plugins to stop from loading. Useful for hiding/disabling certain functionality or streamlining the PHP plugin loads.  (Default: array())

    $wgFeedLimit
        The maximum number of results to return in syndication feeds.  (Default: 50)

    $wgFeedCacheTimeout (deprecated)
        Replaced by API caching.

    $wgNavigationLinks (deprecated)

    $wgDefaultTimezone
        If a user does not set his or her own timezone, this will set the default timezone.  (Default: +00:00)

    $wgCustomTimezones
        Timezones that don't fall on the hour; there are a lot of smaller random ones, so we'll keep them in this special list.  (Default: array('-09:30', '-08:30', '-03:30', '+03:30', '+04:30', '+05:30', '+05:45', '+06:30', '+09:30', '+10:30', '+11:30'))

    $wgHooks (deprecated)

    $wgDisableTextSearch (deprecated)

    $wgCustomerLogo (deprecated)

    $wgDreamServer
        Base URI for the MindTouch API.  (Default: http://localhost:8081)

    $wgDreamHost
        Sets the dream.in.host request parameter for API calls.  This is used in multi-tenant installations.  (Default: $_SERVER['HTTP_HOST])

    $wgDreamApi (deprecated)

    $wgApi
        Path to the API.  This setting should not be changed.  (Default: @api)

    $wgDeki
    $wgDekiApi

        Path to the deki service.  This settings should not be changed.  (Default: deki)

    $wgAnonAccCreate
        Determine if anonymous account creation is enabled.  Use configuration key security/allow-anon-account-creation instead.  (Default: true)

    $wgAnonView (deprecated)

    $wgHelpUrl
        Uri for help documentation.  (Default: http://www.mindtouch.com/redir/support-help/)

    $wgDefaultAnalytics
    $wgGoogleAnalytics

        Google analytics key.  Use configuration key ui/analytics-key instead.  (Default: UA-68075-16)

    $wgGoogleAnalyticsDomain
        Cookie domain for Google Analytics.  Use configuration key ui/analytics-domain instead.  (Default .mindtouch.com)

    $wgRssUrl
        URL of RSS feed for getting the latest MindTouch news. (Default: http://feeds.feedburner.com/mindtouch/updates)

    $wgVideoRssUrl (deprecated)

    $wgVersionPingUrl
        URL that is used to ping to see if updates are available for MindTouch.  (Default: http://updates.mindtouch.com/updates.php)

    $wgShowBannerToAdmins
        License expiration banner displayed to admins.  (Default: 14)

    $wgShowBannerToUsers
        License expiration banner displayed to authenticated users.  (Default: 4)

    $wgShowBannerToAnon
        License expiration banner displayed to anonymous users.  (Default: 0)

    $wgGracePeriod
        License grace period for trials.  (Default: 14)

    $wgRegistrationThreshold (deprecated)

    $wgRegistrationHelpTime (deprecated)

    $wgRegistrationHelpTimeToAdd (deprecated)

    $wgRedirectToUserPageOnCreate
        Redirect users to their user page after registration instead of the homepage.  (Default: true)

    $wgCommentCount
        Number of comments to retrieve, setting to 0 will disable comment functionality.  (Default: 15)

    $wgLimitCount
        Number of revisions to retrieve when viewing page history.  (Default: 50)

    $wgSpecialPagesCount
        Number of pages to show in popular pages.  (Default: 50)

    $wgDefaultRestrictRole
        Default user role when restricting pages.  (Default: Contributor)

    $wgCommentCountAll
        The API doesn't have a true "all" value - so you need to hardcode a large number.  (Default: 10000)

    $wgSearchCount (deprecated)

    $wgDekiSiteHeader
        Name of X-Deki-Site HTTP header.

    $wgDekiSiteId
        Sets the instance name, can be retrieved via X-Deki-Site header.

    $wgInstanceConfig
        Contains the instance configuration data retrieved from GET:site/settings API call.

    $wgAllowAnonymousEmailing (deprecated)

    $wgPreloadPages
        See bug #4272 ; this is a list of pages to always load - THIS IS EXPENSIVE and requires todo #4273.  (Default: array())

    $wgTargetSkinVars
        See bug #4215; this whitelists the skinning variables that templates can write to.  (Default: array('languages', 'toc'))

    $wgEditorToolbarSet
        Default toolbar set for CKEditor.  (Default: Default)

    $wgEditorToolbarSets
        Array of pre-defined toolbar sets for CKEditor.  (Default: array('Default', 'Basic', 'Simple', 'Advanced', 'Everything'))

    $wgPreloadEditorCore
        Enable/disable preloading of editor core. (Default: false)

    $wgUploaders
        List of supported uploaders.  (Default: array( 'classic', 'flash' ))

    $wgMimeTypes
        Array mapping file extensions to mime types since libmagic isn't always reliable.  (Default: array('xls' => 'application/vnd.xls', 'xlsx' => 'application/vnd.xls', 'xlsm' => 'application/vnd.xls', 'xltx' => 'application/vnd.xls', 'xltm' => 'application/vnd.xls', 'xlsb' => 'application/vnd.xls', 'xlam' => 'application/vnd.xls', 'ppt' => 'application/vnd.ms-powerpoint','pps' => 'application/vnd.ms-powerpoint', 'pptx' => 'application/vnd.ms-powerpoint', 'pptm' => 'application/vnd.ms-powerpoint', 'potx' => 'application/vnd.ms-powerpoint', 'potm' => 'application/vnd.ms-powerpoint', 'ppam' => 'application/vnd.ms-powerpoint', 'ppsx' => 'application/vnd.ms-powerpoint', 'ppsm' => 'application/vnd.ms-powerpoint',  'mmp' => 'application/vnd.ms-project', 'mpd' => 'application/vnd.ms-project', 'mpt' => 'application/vnd.ms-project', 'vst' => 'application/vst', 'vss' => 'application/vst', 'vsd' => 'application/vst', 'vxd' => 'application/vnd.visio', 'vsd' => 'application/vnd.visio', 'vsl' => 'application/vnd.visio', 'vss' => 'application/vnd.visio', 'vtx' => 'application/vnd.visio', 'xml' => 'text/xml','html' => 'text/html','htm' => 'text/html', 'gif' => 'image/gif', 'jpg' => 'image/jpeg', 'png' => 'image/png'))

    $wgVarnishCache
        Uri to varnish reverse proxy.  (Default: null)

    $wgVarnishMaxage
        Amount of time for varnish to cache a result.  Sets the s-max-age directive.  (Default: 18000)

    $wgSessionsInMemcached
        Determines of PHP sessions should be stored in memcache.  (Default: false)

    $wgMemCachedServers
        Array of memcache servers to use if $wgSessionsInMemcached is enabled.  (Default: array())

    $wgEnableSearchHighlight
        Enable highligting in pages after searching.  (Default: true)

    $wgPageExclude
        List of parameters to exclude when calling GET:pages/{id}.  Example: 'inbound,outbound' to exclude inbound and outbound links.  (Default: null)

     
    Was this page helpful?
    Tag page
    You must login to post a comment.

    Copyright © 2011 MindTouch, Inc. Powered by