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