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