Merge "Re add wpScrolltop id in EditPage"
[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 * Edit summaries, block reasons, and other "comments" are now stored in a
65 separate database table. Use the CommentFormatter class to access them.
66 ** This is currently gated by $wgCommentTableSchemaMigrationStage. Most wikis
67 can set this to MIGRATION_NEW and run maintenance/migrateComments.php as
68 soon as any necessary extensions are updated.
69
70 === External library changes in 1.30 ===
71
72 ==== Upgraded external libraries ====
73 * mediawiki/mediawiki-codesniffer updated to 0.8.1.
74 * wikimedia/composer-merge-plugin updated to 1.4.1.
75
76 ==== New external libraries ====
77 * The class \TestingAccessWrapper has been moved to the external library
78 wikimedia/testing-access-wrapper and renamed \Wikimedia\TestingAccessWrapper.
79
80 ==== Removed and replaced external libraries ====
81 * …
82
83 === Bug fixes in 1.30 ===
84 * (T151633) Ordered list items use now Devanagari digits in Nepalese
85 (thanks to Sfic)
86
87 === Action API changes in 1.30 ===
88 * (T37247) action=parse output will be wrapped in a div with
89 class="mw-parser-output" by default. This may be changed or disabled using
90 the new 'wrapoutputclass' parameter.
91 * When errorformat is not 'bc', abort reasons from action=login will be
92 formatted as specified by the error formatter parameters.
93 * action=compare can now handle arbitrary text, deleted revisions, and
94 returning users and edit comments.
95 * (T164106) The 'rvdifftotext', 'rvdifftotextpst', 'rvdiffto',
96 'rvexpandtemplates', 'rvgeneratexml', 'rvparse', and 'rvprop=parsetree'
97 parameters to prop=revisions are deprecated, as are the similarly named
98 parameters to prop=deletedrevisions, list=allrevisions, and
99 list=alldeletedrevisions. Use action=compare, action=parse, or
100 action=expandtemplates instead.
101
102 === Action API internal changes in 1.30 ===
103 * ApiBase::getDescriptionMessage() and the "apihelp-*-description" messages are
104 deprecated. The existing message should be split between "apihelp-*-summary"
105 and "apihelp-*-extended-description".
106 * (T123931) Individual values of multi-valued parameters can now be marked as
107 deprecated.
108
109 === Languages updated in 1.30 ===
110 MediaWiki supports over 350 languages. Many localisations are updated
111 regularly. Below only new and removed languages are listed, as well as
112 changes to languages because of Phabricator reports.
113
114 * Added: kbp (Kabɩyɛ / Kabiyè)
115 * Added: skr (Saraiki, سرائیکی)
116 * Added: tay (Tayal / Atayal)
117
118 ==== Pig Latin added ====
119 * (T45547) Added Pig Latin, a made-up English variant (en-x-piglatin),
120 for easier variant development and testing. Disabled by default. It can be
121 enabled by setting $wgUsePigLatinVariant to true.
122
123 === Other changes in 1.30 ===
124 * The use of an associative array for $wgProxyList, where the IP address is in
125 the key instead of the value, is deprecated (e.g. [ '127.0.0.1' => 'value' ]).
126 Please convert these arrays to indexed/sequential ones (e.g. [ '127.0.0.1' ]).
127 * mw.user.bucket (deprecated in 1.23) was removed.
128 * LoadBalancer::getServerInfo() and LoadBalancer::setServerInfo() are
129 deprecated. There are no known callers.
130 * File::getStreamHeaders() was deprecated.
131 * MediaHandler::getStreamHeaders() was deprecated.
132 * Title::canTalk() was deprecated. The new Title::canHaveTalkPage() should be
133 used instead.
134 * MWNamespace::canTalk() was deprecated. The new MWNamespace::hasTalkNamespace()
135 should be used instead.
136 * The ExtractThumbParameters hook (deprecated in 1.21) was removed.
137 * The OutputPage::addParserOutputNoText and ::getHeadLinks methods (both
138 deprecated in 1.24) were removed.
139 * wfMemcKey() and wfGlobalCacheKey() were deprecated. BagOStuff::makeKey() and
140 BagOStuff::makeGlobalKey() should be used instead.
141 * (T146304) Preprocessor handling of LanguageConverter markup has been improved.
142 As a result of the new uniform handling, '-{' may need to be escaped
143 (for example, as '-<nowiki/>{') where it occurs inside template arguments
144 or wikilinks.
145 * (T163966) Page moves are now counted as edits for the purposes of
146 autopromotion, i.e., they increment the user_editcount field in the database.
147 * Two new hooks, LogEventsListLineEnding and NewPagesLineEnding, were added for
148 manipulating Special:Log and Special:NewPages lines.
149 * The OldChangesListRecentChangesLine, EnhancedChangesListModifyLineData,
150 PageHistoryLineEnding, ContributionsLineEnding and DeletedContributionsLineEnding
151 hooks have an additional parameter, for manipulating HTML data attributes of
152 RC/history lines. EnhancedChangesListModifyBlockLineData can do that via the
153 $data['attribs'] subarray.
154 * (T130632) The OutputPage::enableTOC() method was removed.
155 * WikiPage::getParserOutput() will now throw an exception if passed
156 ParserOptions that would pollute the parser cache. Callers should use
157 WikiPage::makeParserOptions() to create the ParserOptions object and only
158 change options that affect the parser cache key.
159 * Article::viewRedirect() is deprecated.
160 * IP::isValidBlock() was deprecated. Use the equivalent IP::isValidRange().
161 * DeprecatedGlobal no longer supports passing in a direct value, it requires a
162 callable factory function or a class name.
163 * The $parserMemc global, wfGetParserCacheStorage(), and ParserCache::singleton()
164 are all deprecated. The main ParserCache instance should be obtained from
165 MediaWikiServices instead. Access to the underlying BagOStuff is possible
166 through the new ParserCache::getCacheStorage() method.
167 * .mw-ui-constructive CSS class (deprecated in 1.27) was removed.
168 * Sanitizer::escapeId() was deprecated, use escapeIdForAttribute(),
169 escapeIdForLink() or escapeIdForExternalInterwiki() instead.
170 * Title::escapeFragmentForURL() was deprecated, use one of the aforementioned
171 Sanitizer functions or, if possible, Title::getFragmentForURL().
172 * Second parameter to Sanitizer::escapeIdReferenceList() ($options) now does
173 nothing and is deprecated.
174 * mw.util.escapeId() was deprecated, use escapeIdForAttribute() or
175 escapeIdForLink().
176 * MagicWord::replaceMultiple() (deprecated in 1.25) was removed.
177 * WikiImporter now requires the second parameter to be an instance of the Config,
178 class. Prior to that, the Config parameter was optional (a behavior deprecated in
179 1.25).
180 * Removed 'jquery.mwExtension' module. (deprecated since 1.26)
181 * mediawiki.ui: Deprecate greys, which are not part of WikimediaUI color palette
182 any more.
183 * CdbReader, CdbWriter, CdbException classes (deprecated in 1.25) were removed.
184 The namespaced classes in the Cdb namespace should be used instead.
185 * IPSet class (deprecated in 1.26) was removed. The namespaced IPSet\IPSet
186 should be used instead.
187 * RunningStat class (deprecated in 1.27) was removed. The namespaced
188 RunningStat\RunningStat should be used instead.
189 * MWMemcached and MemCachedClientforWiki classes (deprecated in 1.27) were removed.
190 The MemcachedClient class should be used instead.
191 * EditPage::isOouiEnabled() is deprecated and will always return true.
192 * Parser::getRandomString() (deprecated in 1.26) was removed.
193 * Parser::uniqPrefix() (deprecated in 1.26) was removed.
194 * Parser::extractTagsAndParams() now only accepts three arguments. The fourth,
195 $uniq_prefix was deprecated in 1.26 and has now been removed.
196 * (T172514) The following tables have had their UNIQUE indexes turned into proper
197 PRIMARY KEYs for increased maintainability: categorylinks, imagelinks, iwlinks,
198 langlinks, log_search, module_deps, objectcache, pagelinks, query_cache, site_stats,
199 templatelinks, text, transcache, user_former_groups, user_properties.
200 * IDatabase::nextSequenceValue() is no longer needed by any database backends
201 (formerly it was needed by PostgreSQL and Oracle), and is now deprecated.
202
203 == Compatibility ==
204 MediaWiki 1.30 requires PHP 5.5.9 or later. There is experimental support for
205 HHVM 3.6.5 or later.
206
207 MySQL/MariaDB is the recommended DBMS. PostgreSQL or SQLite can also be used,
208 but support for them is somewhat less mature. There is experimental support for
209 Oracle and Microsoft SQL Server.
210
211 The supported versions are:
212
213 * MySQL 5.5.8 or later
214 * PostgreSQL 8.3 or later
215 * SQLite 3.3.7 or later
216 * Oracle 9.0.1 or later
217 * Microsoft SQL Server 2005 (9.00.1399)
218
219 == Upgrading ==
220 1.30 has several database changes since 1.29, and will not work without schema
221 updates. Note that due to changes to some very large tables like the revision
222 table, the schema update may take a long time (minutes on a medium sized site,
223 many hours on a large site).
224
225 Don't forget to always back up your database before upgrading!
226
227 See the file UPGRADE for more detailed upgrade instructions, including
228 important information when upgrading from versions prior to 1.11.
229
230 For notes on 1.29.x and older releases, see HISTORY.
231
232 == Online documentation ==
233 Documentation for both end-users and site administrators is available on
234 MediaWiki.org, and is covered under the GNU Free Documentation License (except
235 for pages that explicitly state that their contents are in the public domain):
236
237 https://www.mediawiki.org/wiki/Special:MyLanguage/Documentation
238
239 == Mailing list ==
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 There's usually someone online in #mediawiki on irc.freenode.net.