Merge "Make enhanced recent changes and extended watchlist default"
[mediawiki.git] / RELEASE-NOTES-1.25
blob8c5a716f4d5f687ece6e4ab53b939651b6672e9b
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.
4 == MediaWiki 1.25 ==
6 THIS IS NOT A RELEASE YET
8 MediaWiki 1.25 is an alpha-quality branch and is not recommended for use in
9 production.
11 === Configuration changes in 1.25 ===
12 * $wgPageShowWatchingUsers was removed.
13 * $wgLocalVirtualHosts has been added to replace $wgConf->localVHosts.
14 * $wgAntiLockFlags was removed.
16 === New features in 1.25 ===
17 * (bug 58139) ResourceLoaderFileModule now supports language fallback
18   for 'languageScripts'.
19 * Added a new hook, "ContentAlterParserOutput", to allow extensions to modify the
20   parser output for a content object before links update.
21 * (bug 35785) Enhanced recent changes and extended watchlist are now default.
22   Documentation: https://meta.wikimedia.org/wiki/Help:Enhanced_recent_changes
23   and https://www.mediawiki.org/wiki/Manual:$wgDefaultUserOptions.
24 * (bug 67341) SVG images will no longer be base64-encoded when being embedded
25   in CSS. This results in slight size increase before gzip compression (due to
26   percent-encoding), but up to 20% decrease after it.
28 === Bug fixes in 1.25 ===
29 * (bug 71003) No additional code will be generated to try to load CSS-embedded
30   SVG images in Internet Explorer 6 and 7, as they don't support them anyway.
31 * (bug 67021) On Special:BookSources, corrected validation of ISBNs (both
32   10- and 13-digit forms) containing "X".
34 === Action API changes in 1.25 ===
35 * (bug 65403) XML tag highlighting is now only performed for formats
36   "xmlfm" and "wddxfm".
37 * action=paraminfo supports generalized submodules (modules=query+value),
38   querymodules and formatmodules are deprecated
39 * action=paraminfo no longer outputs descriptions and other help text by
40   default. If needed, it may be requested using the new 'helpformat' parameter.
41 * action=help has been completely rewritten, and outputs help in HTML
42   rather than plain text.
43 * Hitting api.php without specifying an action now displays only the help for
44   the main module, with links to submodule help.
45 * API help is no longer displayed on errors.
46 * Internationalized messages returned by the API will be in the wiki's content
47   language by default. 'uselang' is now a recognized API parameter;
48   "uselang=user" may be used to select the language from the current user's
49   preferences.
50 * Default output format for the API is now jsonfm.
51 * Simplified continuation will return a "batchcomplete" property in the result
52   when a batch of pages is complete.
53 * Pretty-printed HTML output now has nicer formatting and (if available)
54   better syntax highlighting.
56 === Action API internal changes in 1.25 ===
57 * ApiHelp has been rewritten to support i18n and paginated HTML output.
58   Most existing modules should continue working without changes, but should do
59   the following:
60   * Add an i18n message "apihelp-{$moduleName}-description" to replace getDescription().
61   * Add i18n messages "apihelp-{$moduleName}-param-{$param}" for each parameter
62     to replace getParamDescription(). If necessary, the settings array returned
63     by getParams() can use the new ApiBase::PARAM_HELP_MSG key to override the
64     message.
65   * Implement getExamplesMessages() to replace getExamples().
66 * Modules with submodules (like action=query) must have their submodules
67   override ApiBase::getParent() to return the correct parent object.
68 * The 'APIGetDescription' and 'APIGetParamDescription' hooks are deprecated,
69   and will have no effect for modules using i18n messages. Use
70   'APIGetDescriptionMessages' and 'APIGetParamDescriptionMessages' instead.
71 * Api formatters will no longer be asked to display the help screen on errors.
72 * ApiMain::getCredits() was removed. The credits are available in the
73   'api-credits' i18n message.
74 * ApiFormatBase has been changed to support i18n and syntax highlighting via
75   extensions with the new 'ApiFormatHighlight' hook. Core syntax highlighting
76   has been removed.
77 * ApiFormatBase now always buffers. Output is done when
78   ApiFormatBase::closePrinter is called.
79 * The following methods have been deprecated and may be removed in a future
80   release:
81   * ApiBase::getDescription
82   * ApiBase::getParamDescription
83   * ApiBase::getExamples
84   * ApiBase::makeHelpMsg
85   * ApiBase::makeHelpArrayToString
86   * ApiBase::makeHelpMsgParameters
87   * ApiFormatBase::setUnescapeAmps
88   * ApiFormatBase::getWantsHelp
89   * ApiFormatBase::setHelp
90   * ApiFormatBase::formatHTML
91   * ApiFormatBase::setBufferResult
92   * ApiFormatBase::getDescription
93   * ApiMain::setHelp
94   * ApiMain::reallyMakeHelpMsg
95   * ApiMain::makeHelpMsgHeader
97 === Languages updated in 1.25 ===
99 MediaWiki supports over 350 languages. Many localisations are updated
100 regularly. Below only new and removed languages are listed, as well as
101 changes to languages because of Bugzilla reports.
103 === Other changes in 1.25 ===
104 * The skin autodiscovery mechanism, deprecated in MediaWiki 1.23, has been
105   removed. See https://www.mediawiki.org/wiki/Manual:Skin_autodiscovery for
106   migration guide for creators and users of custom skins that relied on it.
107 * Javascript variable 'wgFileCanRotate' now only available on Special:Upload.
108 * (bug 56257) Set site logo from mediawiki.skinning.interface module instead of
109   inline styles in the HTML.
110 * Removed ApiQueryUsers::getAutoGroups(). (deprecated since 1.20)
111 * Removed XmlDumpWriter::schemaVersion(). (deprecated since 1.20)
112 * Removed LogEventsList::getDisplayTitle(). (deprecated since 1.20)
113 * Removed Preferences::trySetUserEmail(). (deprecated since 1.20)
114 * Removed mw.user.name() and mw.user.anonymous() methods. (deprecated since 1.20)
115 * Removed 'ok' and 'err' parameters in the mediawiki.api modules. (deprecated
116   since 1.20)
117 * Removed 'async' parameter from the  mw.Api#getCategories() method. (deprecated
118   since 1.20)
119 * Removed 'jquery.json' module. (deprecated since 1.24)
120   Use the 'json' module and global JSON object instead.
121 * Deprecated OutputPage::readOnlyPage() and OutputPage::rateLimited().
122   Also, the former will now throw an MWException if called with one or more
123   arguments.
125 == Compatibility ==
127 MediaWiki 1.25 requires PHP 5.3.2 or later. There is experimental support for
128 HHVM 3.3.0.
130 MySQL is the recommended DBMS. PostgreSQL or SQLite can also be used, but
131 support for them is somewhat less mature. There is experimental support for
132 Oracle and Microsoft SQL Server.
134 The supported versions are:
136 * MySQL 5.0.2 or later
137 * PostgreSQL 8.3 or later
138 * SQLite 3.3.7 or later
139 * Oracle 9.0.1 or later
140 * Microsoft SQL Server 2005 (9.00.1399)
142 == Upgrading ==
144 1.25 has several database changes since 1.24, and will not work without schema
145 updates. Note that due to changes to some very large tables like the revision
146 table, the schema update may take quite long (minutes on a medium sized site,
147 many hours on a large site).
149 If upgrading from before 1.11, and you are using a wiki as a commons
150 repository, make sure that it is updated as well. Otherwise, errors may arise
151 due to database schema changes.
153 If upgrading from before 1.7, you may want to run refreshLinks.php to ensure
154 new database fields are filled with data.
156 If you are upgrading from MediaWiki 1.4.x or earlier, you should upgrade to
157 1.5 first. The upgrade script maintenance/upgrade1_5.php has been removed
158 with MediaWiki 1.21.
160 Don't forget to always back up your database before upgrading!
162 See the file UPGRADE for more detailed upgrade instructions.
164 For notes on 1.23.x and older releases, see HISTORY.
166 == Online documentation ==
168 Documentation for both end-users and site administrators is available on
169 MediaWiki.org, and is covered under the GNU Free Documentation License (except
170 for pages that explicitly state that their contents are in the public domain):
172         https://www.mediawiki.org/wiki/Documentation
174 == Mailing list ==
176 A mailing list is available for MediaWiki user support and discussion:
178         https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
180 A low-traffic announcements-only list is also available:
182         https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
184 It's highly recommended that you sign up for one of these lists if you're
185 going to run a public MediaWiki, so you can be notified of security fixes.
187 == IRC help ==
189 There's usually someone online in #mediawiki on irc.freenode.net.