Merge "Remove use of old API doc methods"
[lhc/web/wiklou.git] / RELEASE-NOTES-1.33
1 == MediaWiki 1.33 ==
2
3 THIS IS NOT A RELEASE YET
4
5 MediaWiki 1.33 is an alpha-quality branch and is not recommended for use in
6 production.
7
8 === Configuration changes in 1.33 ===
9
10 ==== New configuration ====
11 * $wgEnablePartialBlocks – This enables the Partial Blocks feature, which gives
12 accounts with block permissions the ability to block users, IPs, and IP ranges
13 from editing specific pages, while allowing them to edit the rest of the wiki.
14 * …
15
16 ==== Changed configuration ====
17 * …
18
19 ==== Removed configuration ====
20 * …
21
22 === New features in 1.33 ===
23 * …
24
25 === External library changes in 1.33 ===
26
27 ==== New external libraries ====
28 * …
29
30 ==== Changed external libraries ====
31 * …
32
33 ==== Removed external libraries ====
34 * …
35
36 === Bug fixes in 1.33 ===
37 * …
38
39 === Action API changes in 1.33 ===
40 * (T198913) Added 'ApiOptions' hook.
41 * …
42
43 === Action API internal changes in 1.33 ===
44 * A number of deprecated methods for API documentation, intended for overriding
45 by extensions, are no longer called by MediaWiki, and will emit deprecation
46 notices if your extension attempts to use them:
47 * ApiBase::getDescription() (deprecated in 1.25)
48 * ApiBase::getParamDescription() (deprecated in 1.25)
49 * ApiBase::getExamples() (deprecated in 1.25)
50 * ApiBase::getDescriptionMessage() (deprecated in 1.30)
51 Additionally, the 'APIGetDescription' and 'APIGetParamDescription' hooks have
52 been removed, as their only use was to let extensions override values returned
53 by getDescription() and getParamDescription(), respectively.
54 * …
55
56 === Languages updated in 1.33 ===
57 MediaWiki supports over 350 languages. Many localisations are updated regularly.
58 Below only new and removed languages are listed, as well as changes to languages
59 because of Phabricator reports.
60
61 * …
62
63 === Breaking changes in 1.33 ===
64 * The parameteter $lang in DifferenceEngine::setTextLanguage must be of type
65 Language. Other types are deprecated since 1.32.
66 * Skin::doEditSectionLink requires type Language for the parameter $lang.
67 The parameters $tooltip and $lang are mandatory. Omitting the parameters is
68 deprecated since 1.32.
69 * Language::truncate(), deprecated in 1.31, has been removed.
70 * UtfNormal, deprecated in 1.25, was removed. Use UtfNormal\Validator directly
71 instead.
72 * (T197179) In OOUI HTMLForm fields, the parameters 'notice', 'notice-messages',
73 and 'notice-message', which were deprecated in 1.32, were removed. Instead,
74 use 'help', 'help-message', and 'help-messages'.
75 * (T197179) HTMLFormField::getNotices(), deprecated in 1.32, was removed.
76 * The "Parsoid v1" compatibility mappings in ParsoidVirtualRESTService and
77 RestbaseVirtualRESTService, deprecated since 1.26, have been removed.
78 Use the RESTBase v1 or Parsoid v3 API instead.
79 * ParserOptions defaults 'tidy' to true now, since the untidy modes of the
80 parser are being deprecated and ParserOptions::getCanonicalOverrides()
81 has always been true at any rate.
82 * A number of deprecated methods for API documentation, intended for overriding
83 by extensions, are no longer called by MediaWiki, and will emit deprecation
84 notices if your extension attempts to use them:
85 * ApiBase::getDescription() (deprecated in 1.25)
86 * ApiBase::getParamDescription() (deprecated in 1.25)
87 * ApiBase::getExamples() (deprecated in 1.25)
88 * ApiBase::getDescriptionMessage() (deprecated in 1.30)
89 Additionally, the 'APIGetDescription' and 'APIGetParamDescription' hooks have
90 been removed, as their only use was to let extensions override values returned
91 by getDescription() and getParamDescription(), respectively.
92 * …
93
94 === Deprecations in 1.33 ===
95 * The configuration option $wgUseESI has been deprecated, and is expected
96 to be removed in a future release.
97 * The configuration option $wgSquidPurgeUseHostHeader has been deprecated,
98 and is expected to be removed in a future release.
99 * The configuration options $wgFixArabicUnicode and $wgFixMalayalamUnicode,
100 introduced in MW 1.17, have been deprecated. These fixes will always be
101 applied for Arabic and Malayalam in the future. Please enable these on
102 your local wiki (if you have them explicitly set to false) and run
103 maintenance/cleanupTitles.php to fix any existing page titles.
104 * OutputPage::parse() and OutputPage::parseInline() have been deprecated
105 due to untidy output and inconsistent handling of wrapper divs and
106 interface/content language defaults. Use OutputPage::parseAsContent(),
107 OutputPage::parseAsInterface(), or OutputPage::parseInlineAsInterface()
108 as appropriate.
109 * The LegacyHookPreAuthenticationProvider class, deprecated since its creation
110 in 1.27 as part of the AuthManager re-write, now emits deprecation warnings.
111 This will help identify the issue if you added it to $wgAuthManagerConfig.
112 * wfSplitWikiId() is now deprecated. Cache key generation should have the wiki
113 domain ID as a key component and use makeGlobalKey().
114 * …
115
116 === Other changes in 1.33 ===
117 * …
118
119 == Compatibility ==
120 MediaWiki 1.33 requires PHP 7.0.0 or later. Although HHVM 3.18.5 or later is
121 supported, it is generally advised to use PHP 7.0.0 or later for long term
122 support.
123
124 MySQL/MariaDB is the recommended DBMS. PostgreSQL or SQLite can also be used,
125 but support for them is somewhat less mature. There is experimental support for
126 Oracle and Microsoft SQL Server.
127
128 The supported versions are:
129
130 * MySQL 5.5.8 or later
131 * PostgreSQL 9.2 or later
132 * SQLite 3.3.7 or later
133 * Oracle 9.0.1 or later
134 * Microsoft SQL Server 2005 (9.00.1399)
135
136 == Upgrading ==
137 1.33 has several database changes since 1.32, and will not work without schema
138 updates. Note that due to changes to some very large tables like the revision
139 table, the schema update may take quite long (minutes on a medium sized site,
140 many hours on a large site).
141
142 Don't forget to always back up your database before upgrading!
143
144 See the file UPGRADE for more detailed upgrade instructions, including
145 important information when upgrading from versions prior to 1.11.
146
147 For notes on 1.32.x and older releases, see HISTORY.
148
149 == Online documentation ==
150 Documentation for both end-users and site administrators is available on
151 MediaWiki.org, and is covered under the GNU Free Documentation License (except
152 for pages that explicitly state that their contents are in the public domain):
153
154 https://www.mediawiki.org/wiki/Special:MyLanguage/Documentation
155
156 == Mailing list ==
157 A mailing list is available for MediaWiki user support and discussion:
158
159 https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
160
161 A low-traffic announcements-only list is also available:
162
163 https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
164
165 It's highly recommended that you sign up for one of these lists if you're
166 going to run a public MediaWiki, so you can be notified of security fixes.
167
168 == IRC help ==
169 There's usually someone online in #mediawiki on irc.freenode.net.