RELEASE-NOTES-1.25

   1 Security reminder: If you have PHP's register_globals option set, you must
   2 turn it off. MediaWiki will not work with it enabled.
   3
   4 == MediaWiki 1.25 ==
   5
   6 THIS IS NOT A RELEASE YET
   7
   8 MediaWiki 1.25 is an alpha-quality branch and is not recommended for use in
   9 production.
  10
  11 === Configuration changes in 1.25 ===
  12 * $wgPageShowWatchingUsers was removed.
  13 * $wgLocalVirtualHosts has been added to replace $wgConf->localVHosts.
  14 * $wgAntiLockFlags was removed.
  15 * Edit tokens returned from User::getEditToken may change on every call. Token
  16   validity must be checked by passing the user-supplied token to
  17   User::matchEditToken rather than by testing for equality with a
  18   newly-generated token.
  19 * (bug 72951) The UserGetLanguageObject hook may be passed any IContextSource
  20   for its $context parameter. Formerly it was documented as receiving a
  21   RequestContext specifically.
  22 * Profiling was restructured and $wgProfiler now requires an 'output' parameter.
  23   See StartProfiler.sample for details.
  24 * $wgMangleFlashPolicy was added to make MediaWiki's mangling of anything that
  25   might be a flash policy directive configurable.
  26
  27 === New features in 1.25 ===
  28 * (bug 62861) Updated plural rules to CLDR 26. Includes incompatible changes
  29   for plural forms in Russian, Prussian, Tagalog, Manx and several languages
  30   that fall back to Russian.
  31 * (bug 58139) ResourceLoaderFileModule now supports language fallback
  32   for 'languageScripts'.
  33 * Added a new hook, "ContentAlterParserOutput", to allow extensions to modify the
  34   parser output for a content object before links update.
  35 * (bug 35785) Enhanced recent changes and extended watchlist are now default.
  36   Documentation: https://meta.wikimedia.org/wiki/Help:Enhanced_recent_changes
  37   and https://www.mediawiki.org/wiki/Manual:$wgDefaultUserOptions.
  38 * (bug 67341) SVG images will no longer be base64-encoded when being embedded
  39   in CSS. This results in slight size increase before gzip compression (due to
  40   percent-encoding), but up to 20% decrease after it.
  41 * Upgrade jStorage to v0.4.12.
  42 * MediaWiki now natively supports page status indicators: icons (or short text
  43   snippets) usually displayed in the top-right corner of the page. They have
  44   been in use on Wikipedia for a long time, implemented using templates and CSS
  45   absolute positioning.
  46   - Basic wikitext syntax: <indicator name="foo">[[File:Foo.svg|20px]]</indicator>
  47   - Usage instructions: https://www.mediawiki.org/wiki/Help:Page_status_indicators
  48   - Adjusting custom skins to support indicators:
  49     https://www.mediawiki.org/wiki/Manual:Skinning#Page_status_indicators
  50 * Edit tokens may now be time-limited: passing a maximum age to
  51   User::matchEditToken will reject any older tokens.
  52 * The debug logging internals have been overhauled, and are now using the
  53   PSR-3 interfaces.
  54
  55 === Bug fixes in 1.25 ===
  56 * (bug 71003) No additional code will be generated to try to load CSS-embedded
  57   SVG images in Internet Explorer 6 and 7, as they don't support them anyway.
  58 * (bug 67021) On Special:BookSources, corrected validation of ISBNs (both
  59   10- and 13-digit forms) containing "X".
  60 * Page moving was refactored into a MovePage class. As part of that:
  61 ** The AbortMove hook was removed.
  62 ** MovePageIsValidMove is for extensions to specify whether a page
  63    cannot be moved for technical reasons, and should not be overriden.
  64 ** MovePageCheckPermissions is for checking whether the given user is
  65    allowed to make the move.
  66 ** Title::moveNoAuth() was deprecated. Use the MovePage class instead.
  67 ** Title::moveTo() was deprecated. Use the MovePage class instead.
  68 ** Title::isValidMoveOperation() broken down into MovePage::isValidMove()
  69    and MovePage::checkPermissions().
  70
  71 === Action API changes in 1.25 ===
  72 * (bug 65403) XML tag highlighting is now only performed for formats
  73   "xmlfm" and "wddxfm".
  74 * action=paraminfo supports generalized submodules (modules=query+value),
  75   querymodules and formatmodules are deprecated
  76 * action=paraminfo no longer outputs descriptions and other help text by
  77   default. If needed, it may be requested using the new 'helpformat' parameter.
  78 * action=help has been completely rewritten, and outputs help in HTML
  79   rather than plain text.
  80 * Hitting api.php without specifying an action now displays only the help for
  81   the main module, with links to submodule help.
  82 * API help is no longer displayed on errors.
  83 * 'uselang' is now a recognized API parameter; "uselang=user" may be used to
  84   explicitly select the language from the current user's preferences, and
  85   "uselang=content" may be used to select the wiki's content language.
  86 * Default output format for the API is now jsonfm.
  87 * Simplified continuation will return a "batchcomplete" property in the result
  88   when a batch of pages is complete.
  89 * Pretty-printed HTML output now has nicer formatting and (if available)
  90   better syntax highlighting.
  91 * Deprecated list=deletedrevs in favor of newly-added prop=deletedrevisions and
  92   list=alldeletedrevisions.
  93 * prop=revisions will gracefully continue when given too many revids or titles,
  94   rather than just ignoring the extras.
  95 * prop=revisions will no longer die if rvcontentformat doesn't match a
  96   revision's content model; it will instead warn and omit the content.
  97 * If the user has the 'deletedhistory' right, action=query's revids parameter
  98   will now recognize deleted revids.
  99 * prop=revisions may be used as a generator, generating revids.
 100 * (bug 66776) format=json results will no longer be corrupted when
 101   $wgMangleFlashPolicy is in effect. format=php results will cleanly return an
 102   error instead of returning invalid serialized data.
 103
 104 === Action API internal changes in 1.25 ===
 105 * ApiHelp has been rewritten to support i18n and paginated HTML output.
 106   Most existing modules should continue working without changes, but should do
 107   the following:
 108   * Add an i18n message "apihelp-{$moduleName}-description" to replace getDescription().
 109   * Add i18n messages "apihelp-{$moduleName}-param-{$param}" for each parameter
 110     to replace getParamDescription(). If necessary, the settings array returned
 111     by getParams() can use the new ApiBase::PARAM_HELP_MSG key to override the
 112     message.
 113   * Implement getExamplesMessages() to replace getExamples().
 114 * Modules with submodules (like action=query) must have their submodules
 115   override ApiBase::getParent() to return the correct parent object.
 116 * The 'APIGetDescription' and 'APIGetParamDescription' hooks are deprecated,
 117   and will have no effect for modules using i18n messages. Use
 118   'APIGetDescriptionMessages' and 'APIGetParamDescriptionMessages' instead.
 119 * Api formatters will no longer be asked to display the help screen on errors.
 120 * ApiMain::getCredits() was removed. The credits are available in the
 121   'api-credits' i18n message.
 122 * ApiFormatBase has been changed to support i18n and syntax highlighting via
 123   extensions with the new 'ApiFormatHighlight' hook. Core syntax highlighting
 124   has been removed.
 125 * ApiFormatBase now always buffers. Output is done when
 126   ApiFormatBase::closePrinter is called.
 127 * Much of the logic in ApiQueryRevisions has been split into ApiQueryRevisionsBase.
 128 * The 'revids' parameter supplied by ApiPageSet will now count deleted
 129   revisions as "good" if the user has the 'deletedhistory' right. New methods
 130   ApiPageSet::getLiveRevisionIDs() and ApiPageSet::getDeletedRevisionIDs() are
 131   provided to access just the live or just the deleted revids.
 132 * The following methods have been deprecated and may be removed in a future
 133   release:
 134   * ApiBase::getDescription
 135   * ApiBase::getParamDescription
 136   * ApiBase::getExamples
 137   * ApiBase::makeHelpMsg
 138   * ApiBase::makeHelpArrayToString
 139   * ApiBase::makeHelpMsgParameters
 140   * ApiFormatBase::setUnescapeAmps
 141   * ApiFormatBase::getWantsHelp
 142   * ApiFormatBase::setHelp
 143   * ApiFormatBase::formatHTML
 144   * ApiFormatBase::setBufferResult
 145   * ApiFormatBase::getDescription
 146   * ApiMain::setHelp
 147   * ApiMain::reallyMakeHelpMsg
 148   * ApiMain::makeHelpMsgHeader
 149   * ApiQueryImageInfo::getPropertyDescriptions
 150 * The following classes have been deprecated and may be removed in a future
 151   release:
 152   * ApiQueryDeletedrevs
 153
 154 === Languages updated in 1.25 ===
 155
 156 MediaWiki supports over 350 languages. Many localisations are updated
 157 regularly. Below only new and removed languages are listed, as well as
 158 changes to languages because of Bugzilla reports.
 159
 160 * (bug 64440) Kazakh (kk) wikis should no longer forcefully reset the user's
 161   interface language to kk where unexpected.
 162
 163 === Other changes in 1.25 ===
 164 * The skin autodiscovery mechanism, deprecated in MediaWiki 1.23, has been
 165   removed. See https://www.mediawiki.org/wiki/Manual:Skin_autodiscovery for
 166   migration guide for creators and users of custom skins that relied on it.
 167 * Javascript variable 'wgFileCanRotate' now only available on Special:Upload.
 168 * (bug 56257) Set site logo from mediawiki.skinning.interface module instead of
 169   inline styles in the HTML.
 170 * Removed ApiQueryUsers::getAutoGroups(). (deprecated since 1.20)
 171 * Removed XmlDumpWriter::schemaVersion(). (deprecated since 1.20)
 172 * Removed LogEventsList::getDisplayTitle(). (deprecated since 1.20)
 173 * Removed Preferences::trySetUserEmail(). (deprecated since 1.20)
 174 * Removed mw.user.name() and mw.user.anonymous() methods. (deprecated since 1.20)
 175 * Removed 'ok' and 'err' parameters in the mediawiki.api modules. (deprecated
 176   since 1.20)
 177 * Removed 'async' parameter from the  mw.Api#getCategories() method. (deprecated
 178   since 1.20)
 179 * Removed 'jquery.json' module. (deprecated since 1.24)
 180   Use the 'json' module and global JSON object instead.
 181 * Deprecated OutputPage::readOnlyPage() and OutputPage::rateLimited().
 182   Also, the former will now throw an MWException if called with one or more
 183   arguments.
 184 * Removed hitcounters and associated code.
 185 * The "temp" zone of the upload respository is now considered private. If it
 186   already exists (such as under the images/ directory), please make sure that
 187   the directory is not web readable (e.g. via a .htaccess file).
 188 * BREAKING CHANGE: In the XML dump format used by Special:Export and
 189   dumpBackup.php, the <model> and <format> tags now apprear before the <text>
 190   tag, instead of after the <text> and <sha1> tags.
 191   The new schema version is 0.10, the new schema URI is
 192   <https://www.mediawiki.org/xml/export-0.10.xsd>.
 193 * MWFunction::call() and MWFunction::callArray() were removed, having being
 194   deprecated in 1.22.
 195 * Deprecated the getInternalLinkAttributes, getInternalLinkAttributesObj,
 196   and getInternalLinkAttributes methods in Linker, and removed
 197   getExternalLinkAttributes method, which was deprecated in MediaWiki 1.18.
 198
 199 == Compatibility ==
 200
 201 MediaWiki 1.25 requires PHP 5.3.3 or later. There is experimental support for
 202 HHVM 3.3.0.
 203
 204 MySQL is the recommended DBMS. PostgreSQL or SQLite can also be used, but
 205 support for them is somewhat less mature. There is experimental support for
 206 Oracle and Microsoft SQL Server.
 207
 208 The supported versions are:
 209
 210 * MySQL 5.0.2 or later
 211 * PostgreSQL 8.3 or later
 212 * SQLite 3.3.7 or later
 213 * Oracle 9.0.1 or later
 214 * Microsoft SQL Server 2005 (9.00.1399)
 215
 216 == Upgrading ==
 217
 218 1.25 has several database changes since 1.24, and will not work without schema
 219 updates. Note that due to changes to some very large tables like the revision
 220 table, the schema update may take quite long (minutes on a medium sized site,
 221 many hours on a large site).
 222
 223 If upgrading from before 1.11, and you are using a wiki as a commons
 224 repository, make sure that it is updated as well. Otherwise, errors may arise
 225 due to database schema changes.
 226
 227 If upgrading from before 1.7, you may want to run refreshLinks.php to ensure
 228 new database fields are filled with data.
 229
 230 If you are upgrading from MediaWiki 1.4.x or earlier, you should upgrade to
 231 1.5 first. The upgrade script maintenance/upgrade1_5.php has been removed
 232 with MediaWiki 1.21.
 233
 234 Don't forget to always back up your database before upgrading!
 235
 236 See the file UPGRADE for more detailed upgrade instructions.
 237
 238 For notes on 1.23.x and older releases, see HISTORY.
 239
 240 == Online documentation ==
 241
 242 Documentation for both end-users and site administrators is available on
 243 MediaWiki.org, and is covered under the GNU Free Documentation License (except
 244 for pages that explicitly state that their contents are in the public domain):
 245
 246         https://www.mediawiki.org/wiki/Documentation
 247
 248 == Mailing list ==
 249
 250 A mailing list is available for MediaWiki user support and discussion:
 251
 252         https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
 253
 254 A low-traffic announcements-only list is also available:
 255
 256         https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
 257
 258 It's highly recommended that you sign up for one of these lists if you're
 259 going to run a public MediaWiki, so you can be notified of security fixes.
 260
 261 == IRC help ==
 262
 263 There's usually someone online in #mediawiki on irc.freenode.net.