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