Merge "Rename IP::isValidBlock to isValidRange, deprecating the former"
[lhc/web/wiklou.git] / RELEASE-NOTES-1.30
1 == MediaWiki 1.30 ==
2
3 THIS IS NOT A RELEASE YET
4
5 MediaWiki 1.30 is an alpha-quality branch and is not recommended for use in
6 production.
7
8 === MySQL version requirement in 1.30 ===
9 As of 1.30, MediaWiki now requires MySQL 5.5.8 or higher (see Compatibility
10 section).
11
12 === Configuration changes in 1.30 ===
13 * The "C.UTF-8" locale should be used for $wgShellLocale, if available, to avoid
14 unexpected behavior when code uses locale-sensitive string comparisons. For
15 example, the Scribunto extension considers "bar" < "Foo" in most locales
16 since it ignores case.
17 * $wgShellLocale now affects LC_ALL rather than only LC_CTYPE. See
18 documentation of $wgShellLocale for details.
19 * $wgShellLocale is now applied for all requests. wfInitShellLocale() is
20 deprecated and a no-op, as it is no longer needed.
21 * $wgJobClasses may now specify callback functions as an alternative to plain
22 class names. This is intended for extensions that want control over the
23 instantiation of their jobs, to allow for proper dependency injection.
24 * $wgResourceModules may now specify callback functions as an alternative
25 to plain class names, using the 'factory' key in the module description
26 array. This allows dependency injection to be used for ResourceLoader modules.
27 * $wgExceptionHooks has been removed.
28 * (T45547) $wgUsePigLatinVariant added (off by default).
29 * (T152540) MediaWiki now supports a section ID escaping style that allows to display
30 non-Latin characters verbatim on many modern browsers. This is controlled by the
31 new configuration setting, $wgFragmentMode.
32 * $wgExperimentalHtmlIds is now deprecated and will be removed in a future version,
33 use $wgFragmentMode to migrate off it to a modern alternative.
34 * $wgExternalInterwikiFragmentMode was introduced to control how fragments in
35 sinterwikis going outside of current wiki farm are encoded.
36 * (T120333) Soft-deprecated the use of PHP extension 'mysql' in favor of 'mysqli'.
37 This PHP extension was deprecated in PHP 5.5 and removed in PHP 7.0. MediaWiki
38 auto-selects the 'mysqli' driver since MediaWiki 1.22, except if explicitly
39 requested through the configuration parameter $wgDBservers.
40 * $wgOOUIEditPage was removed, as it is now the default. This was documented as a
41 temporary variable during the migration period.
42
43 === New features in 1.30 ===
44 * (T37247) Output from Parser::parse() will now be wrapped in a div with
45 class="mw-parser-output" by default. This may be changed or disabled using
46 ParserOptions::setWrapOutputClass().
47 * Added 'ChangeTagsAllowedAdd' hook, enabling extensions to allow software-
48 specific tags to be added by users.
49 * Added a 'ParserOptionsRegister' hook to allow extensions to register
50 additional parser options.
51 * (T45547) Included Pig Latin, a language game in English, as a
52 LanguageConverter variant. This allows English-speaking developers
53 to develop and test LanguageConverter more easily. Pig Latin can be
54 enabled by setting $wgUsePigLatinVariant to true.
55 * Added RecentChangesPurgeRows hook to allow extensions to purge data that
56 depends on the recentchanges table.
57 * Added JS config values wgDiffOldId/wgDiffNewId to the output of diff pages.
58 * (T2424) Added direct unwatch links to entries in Special:Watchlist (if the
59 'watchlistunwatchlinks' preference option is enabled). With JavaScript
60 enabled, these links toggle so the user can also re-watch pages that have
61 just been unwatched.
62 * Added $wgParserTestMediaHandlers, where mock media handlers can be passed to
63 MediaHandlerFactory for parser tests.
64
65 === External library changes in 1.30 ===
66
67 ==== Upgraded external libraries ====
68 * mediawiki/mediawiki-codesniffer updated to 0.8.1.
69 * wikimedia/composer-merge-plugin updated to 1.4.1.
70
71 ==== New external libraries ====
72 * The class \TestingAccessWrapper has been moved to the external library
73 wikimedia/testing-access-wrapper and renamed \Wikimedia\TestingAccessWrapper.
74
75 ==== Removed and replaced external libraries ====
76 * …
77
78 === Bug fixes in 1.30 ===
79 * (T151633) Ordered list items use now Devanagari digits in Nepalese
80 (thanks to Sfic)
81
82 === Action API changes in 1.30 ===
83 * (T37247) action=parse output will be wrapped in a div with
84 class="mw-parser-output" by default. This may be changed or disabled using
85 the new 'wrapoutputclass' parameter.
86 * When errorformat is not 'bc', abort reasons from action=login will be
87 formatted as specified by the error formatter parameters.
88 * action=compare can now handle arbitrary text, deleted revisions, and
89 returning users and edit comments.
90 * (T164106) The 'rvdifftotext', 'rvdifftotextpst', 'rvdiffto',
91 'rvexpandtemplates', 'rvgeneratexml', 'rvparse', and 'rvprop=parsetree'
92 parameters to prop=revisions are deprecated, as are the similarly named
93 parameters to prop=deletedrevisions, list=allrevisions, and
94 list=alldeletedrevisions. Use action=compare, action=parse, or
95 action=expandtemplates instead.
96
97 === Action API internal changes in 1.30 ===
98 * ApiBase::getDescriptionMessage() and the "apihelp-*-description" messages are
99 deprecated. The existing message should be split between "apihelp-*-summary"
100 and "apihelp-*-extended-description".
101 * (T123931) Individual values of multi-valued parameters can now be marked as
102 deprecated.
103
104 === Languages updated in 1.30 ===
105 MediaWiki supports over 350 languages. Many localisations are updated
106 regularly. Below only new and removed languages are listed, as well as
107 changes to languages because of Phabricator reports.
108
109 * Added: kbp (Kabɩyɛ / Kabiyè)
110 * Added: skr (Saraiki, سرائیکی)
111 * Added: tay (Tayal / Atayal)
112
113 ==== Pig Latin added ====
114 * (T45547) Added Pig Latin, a made-up English variant (en-x-piglatin),
115 for easier variant development and testing. Disabled by default. It can be
116 enabled by setting $wgUsePigLatinVariant to true.
117
118 === Other changes in 1.30 ===
119 * The use of an associative array for $wgProxyList, where the IP address is in
120 the key instead of the value, is deprecated (e.g. [ '127.0.0.1' => 'value' ]).
121 Please convert these arrays to indexed/sequential ones (e.g. [ '127.0.0.1' ]).
122 * mw.user.bucket (deprecated in 1.23) was removed.
123 * LoadBalancer::getServerInfo() and LoadBalancer::setServerInfo() are
124 deprecated. There are no known callers.
125 * File::getStreamHeaders() was deprecated.
126 * MediaHandler::getStreamHeaders() was deprecated.
127 * Title::canTalk() was deprecated. The new Title::canHaveTalkPage() should be
128 used instead.
129 * MWNamespace::canTalk() was deprecated. The new MWNamespace::hasTalkNamespace()
130 should be used instead.
131 * The ExtractThumbParameters hook (deprecated in 1.21) was removed.
132 * The OutputPage::addParserOutputNoText and ::getHeadLinks methods (both
133 deprecated in 1.24) were removed.
134 * wfMemcKey() and wfGlobalCacheKey() were deprecated. BagOStuff::makeKey() and
135 BagOStuff::makeGlobalKey() should be used instead.
136 * (T146304) Preprocessor handling of LanguageConverter markup has been improved.
137 As a result of the new uniform handling, '-{' may need to be escaped
138 (for example, as '-<nowiki/>{') where it occurs inside template arguments
139 or wikilinks.
140 * (T163966) Page moves are now counted as edits for the purposes of
141 autopromotion, i.e., they increment the user_editcount field in the database.
142 * Two new hooks, LogEventsListLineEnding and NewPagesLineEnding, were added for
143 manipulating Special:Log and Special:NewPages lines.
144 * The OldChangesListRecentChangesLine, EnhancedChangesListModifyLineData,
145 PageHistoryLineEnding, ContributionsLineEnding and DeletedContributionsLineEnding
146 hooks have an additional parameter, for manipulating HTML data attributes of
147 RC/history lines. EnhancedChangesListModifyBlockLineData can do that via the
148 $data['attribs'] subarray.
149 * (T130632) The OutputPage::enableTOC() method was removed.
150 * WikiPage::getParserOutput() will now throw an exception if passed
151 ParserOptions that would pollute the parser cache. Callers should use
152 WikiPage::makeParserOptions() to create the ParserOptions object and only
153 change options that affect the parser cache key.
154 * Article::viewRedirect() is deprecated.
155 * IP::isValidBlock() was deprecated. Use the equivalent IP::isValidRange().
156 * DeprecatedGlobal no longer supports passing in a direct value, it requires a
157 callable factory function or a class name.
158 * The $parserMemc global, wfGetParserCacheStorage(), and ParserCache::singleton()
159 are all deprecated. The main ParserCache instance should be obtained from
160 MediaWikiServices instead. Access to the underlying BagOStuff is possible
161 through the new ParserCache::getCacheStorage() method.
162 * .mw-ui-constructive CSS class (deprecated in 1.27) was removed.
163 * Sanitizer::escapeId() was deprecated, use escapeIdForAttribute(),
164 escapeIdForLink() or escapeIdForExternalInterwiki() instead.
165 * Title::escapeFragmentForURL() was deprecated, use one of the aforementioned
166 Sanitizer functions or, if possible, Title::getFragmentForURL().
167 * Second parameter to Sanitizer::escapeIdReferenceList() ($options) now does
168 nothing and is deprecated.
169 * mw.util.escapeId() was deprecated, use escapeIdForAttribute() or
170 escapeIdForLink().
171 * MagicWord::replaceMultiple() (deprecated in 1.25) was removed.
172 * WikiImporter now requires the second parameter to be an instance of the Config,
173 class. Prior to that, the Config parameter was optional (a behavior deprecated in
174 1.25).
175 * Removed 'jquery.mwExtension' module. (deprecated since 1.26)
176 * mediawiki.ui: Deprecate greys, which are not part of WikimediaUI color palette
177 any more.
178 * CdbReader, CdbWriter, CdbException classes (deprecated in 1.25) were removed.
179 The namespaced classes in the Cdb namespace should be used instead.
180 * IPSet class (deprecated in 1.26) was removed. The namespaced IPSet\IPSet
181 should be used instead.
182 * RunningStat class (deprecated in 1.27) was removed. The namespaced
183 RunningStat\RunningStat should be used instead.
184 * MWMemcached and MemCachedClientforWiki classes (deprecated in 1.27) were removed.
185 The MemcachedClient class should be used instead.
186 * EditPage::isOouiEnabled() is deprecated and will always return true.
187 * Parser::getRandomString() (deprecated in 1.26) was removed.
188 * Parser::uniqPrefix() (deprecated in 1.26) was removed.
189 * Parser::extractTagsAndParams() now only accepts three arguments. The fourth,
190 $uniq_prefix was deprecated in 1.26 and has now been removed.
191 * (T172514) The following tables have had their UNIQUE indexes turned into proper
192 PRIMARY KEYs for increased maintainability: categorylinks, imagelinks, iwlinks,
193 langlinks, log_search, module_deps, objectcache, pagelinks, query_cache, site_stats,
194 templatelinks, text, transcache, user_former_groups, user_properties.
195
196 == Compatibility ==
197 MediaWiki 1.30 requires PHP 5.5.9 or later. There is experimental support for
198 HHVM 3.6.5 or later.
199
200 MySQL/MariaDB is the recommended DBMS. PostgreSQL or SQLite can also be used,
201 but support for them is somewhat less mature. There is experimental support for
202 Oracle and Microsoft SQL Server.
203
204 The supported versions are:
205
206 * MySQL 5.5.8 or later
207 * PostgreSQL 8.3 or later
208 * SQLite 3.3.7 or later
209 * Oracle 9.0.1 or later
210 * Microsoft SQL Server 2005 (9.00.1399)
211
212 == Upgrading ==
213 1.30 has several database changes since 1.29, 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 a long time (minutes on a medium sized site,
216 many hours on a large site).
217
218 Don't forget to always back up your database before upgrading!
219
220 See the file UPGRADE for more detailed upgrade instructions, including
221 important information when upgrading from versions prior to 1.11.
222
223 For notes on 1.29.x and older releases, see HISTORY.
224
225 == Online documentation ==
226 Documentation for both end-users and site administrators is available on
227 MediaWiki.org, and is covered under the GNU Free Documentation License (except
228 for pages that explicitly state that their contents are in the public domain):
229
230 https://www.mediawiki.org/wiki/Special:MyLanguage/Documentation
231
232 == Mailing list ==
233 A mailing list is available for MediaWiki user support and discussion:
234
235 https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
236
237 A low-traffic announcements-only list is also available:
238
239 https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
240
241 It's highly recommended that you sign up for one of these lists if you're
242 going to run a public MediaWiki, so you can be notified of security fixes.
243
244 == IRC help ==
245 There's usually someone online in #mediawiki on irc.freenode.net.