Merge "The siteinfo API uses '' as an attribute value, not `true`."
[mediawiki.git] / RELEASE-NOTES-1.24
blob72edd7665d9ef35fefa6c580c1a5dbbf2730e672
1 Security reminder: MediaWiki does not require PHP's register_globals. If you
2 have it on, turn it '''off''' if you can.
4 == MediaWiki 1.24 ==
6 THIS IS NOT A RELEASE YET
8 MediaWiki 1.24 is an alpha-quality branch and is not recommended for use in
9 production.
11 === Configuration changes in 1.24 ===
12 * The server's canonical hostname is available as $wgServerName, which is
13   exposed in both mw.config and ApiQuerySiteInfo.
14 * Introduced $wgPagePropsHaveSortkey as a backwards-compatibility switch,
15   for using the old schema of the page_props table, in case the respective
16   schema update was not applied.
17 * $wgSearchEverythingOnlyLoggedIn was removed as the 'searcheverything'
18   user option was removed. Use $wgNamespacesToBeSearchedDefault instead or
19   if you used to have $wgDefaultUserOptions['searcheverything'] = 1.
20 * $wgMasterWaitTimeout has been deprecated.
21 * $wgDBClusterTimeout has been removed.
22 * $wgProxyKey has been removed. It is no longer used by MediaWiki core.
23   Ensure $wgSecretKey is set in LocalSettings.php.
25 === New features in 1.24 ===
26 * Added a new hook, "WhatLinksHereProps", to allow extensions to annotate
27   WhatLinksHere entries.
28 * Added a new hook, "ContentGetParserOutput", to customize parser output for
29   a given content object.
30 * Deprecated the hook "ShowRawCssJs", use "ContentGetParserOutput" instead.
31 * HTMLForm's HTMLTextField now supports the 'url' type.
32 * HTMLForm fields may now be dynamically hidden based on the values of other
33   fields in the form.
34 * HTMLForm now supports multiple copies of an input field or set of input
35   fields, e.g. the form may request "one or more usernames" without having to
36   have the user enter delimited list of names into a text field.
37 * Added a new hook, "SidebarBeforeOutput", to allow to edit the structure of
38   the sidebar just before its display.
39 * (bug 49156) Added the mediawiki.cookie ResourceLoader module, which wraps
40   jquery.cookie so that getting/setting a cookie is syntactically and
41   functionally similar to using the WebRequest::getCookie() and
42   WebResponse::setcookie() methods.
43 * (bug 44740) jQuery upgraded from 1.8.3 to 1.11.1. A new configuration option,
44   $wgIncludejQueryMigrate, also loads the jQuery Migrate hack to let extensions
45   and gadgets use the long-deprecated functions that were removed in jQuery 1.9.
46   This option is turned off by default, and will be removed in MediaWiki 1.25.
47 * (bug 47076) jQuery UI upgraded from 1.8.24 to 1.9.2.
48 * Changes to content typography (fonts, etc.). See
49   https://www.mediawiki.org/wiki/Typography_refresh for further information.
50 * WikitextContent will now render redirects with the expected "redirect"
51   header, rather than as an ordered list. Code calling Article::viewRedirect
52   can probably be changed to no longer special-case redirects.
53 * Header font set to a serif font stack. See
54   https://www.mediawiki.org/wiki/Typography_refresh for further information.
55 * (bug 65567) Added a new hook, "BeforeHttpsRedirect", to allow cancellation of
56   the HTTP to HTTPS redirect due to forceHTTPS cookie, userRequires, etc. This
57   is only for page views, since this hook doesn't affect UserLogin, OAuth,
58   CentralAuth, etc. ATTENTION: This hook is likely to be removed soon due to
59   overall design of the system.
60 * (bug 17367) It is now possible to add pages to your watchlist from
61   Special:UnwatchedPages without reloading the special page.
62 * New methods setVolatile and isVolatile are added to PPFrame, so that
63   extensions such as Cite.php can mark that their output is volatile and
64   shouldn't be cached.
65 * (bug 52817) Advanced search options are now saved on the search page itself,
66   rather than in a dedicated pane in the preferences panel.
67 * (bug 44591) The dropdown actions menu (little triangle next to page tabs) in
68   the Vector skin has gained a label that should make it more discoverable.
69 * MWCryptHKDF added for fast, cryptographically secure random number generation
70   that won't deplete openssl's entropy pool.
71 * ResourceLoader: File modules can now provide a skip function that uses an
72   inline feature test to bypass loading of the module.
73 * (bug 20210) Special pages may now provide autocompletion of their subpage
74   names in search suggestions. Right now the only useful implementation is in
75   Special:Log, but more are to come.
76 * Special:MostLinkedTemplates is no longer limited to transclusions from the
77   Template namespace.
78 * Skins can now use 'remoteSkinPath' when defining ResourceLoader modules.
79   This works the same as 'remoteExtPath' but is relative to the skins/ folder
80   instead of the extensions/ folder.
82 === Bug fixes in 1.24 ===
83 * (bug 49116) Footer copyright notice is now always displayed in user language
84   rather than content language (same as copyright notice for editing interface).
85 * (bug 62258) A bug was fixed in File::getUnscaledThumb when a height
86   restriction was present in the parameters. Images with both the "frame"
87   option and a size specification set will now always ignore the provided
88   size and display an unscaled image, as the documentation has always
89   claimed it would.
90 * (bug 39035) Improved Vector skin performance by removing collapsibleNav,
91   which used to collapse some sidebar elements by default.
92   This removes -list id suffixes like p-lang-list: instead of using things like
93   #p-lang-list, you can do #p-lang .body ul.
94 * (bug 890) Links in Special:RecentChanges and Special:Watchlist no longer
95   follow redirects to their target pages.
96 * Parser now dies early if called recursively, instead of producing subtle bugs.
97 * (bug 14323) Redirect pages, when viewed with redirect=no, no longer hide the
98   remaining page content.
99 * (bug 52587) Maintenance script deleteBatch.php no longer follows redirects
100   in the file namespace and delete the file on the target page. It will still
101   however delete the redirect page.
103 === Web API changes in 1.24 ===
104 * action=parse API now supports prop=modules, which provides the list of
105   ResourceLoader modules that should be used to enhance the parsed content.
106 * action=query&meta=siteinfo&siprop=interwikimap returns a new "protorel"
107   field which is true iff protocol-relative urls can be used to access
108   a particular interwiki map entry.
109 * ApiQueryLogEvents now provides logpage, which is the page ID from the
110   logging table, if ids are requested and the user has the permissions.
111 * action=edit now requires that appendtext, prependtext, or section=new be used
112   when using the 'redirect' parameter, to prevent clients accidentally
113   overwriting the target page with the content of the redirect.
114 * action=logevents will now return an error if both letitle and leprefix are
115   specified.
116 * action=logevents has a new parameter, lenamespace, to allow filtering by
117   namespace.
118 * action=expandtemplates has a new parameter, prop, and a new output format.
119   The old format is still used if prop isn't provided, but this is deprecated.
120 * meta=userinfo can now return the count of unread pages on the watchlist.
121 * list=watchlist can now filter by unread status.
123 === Languages updated in 1.24 ===
125 MediaWiki supports over 350 languages. Many localisations are updated
126 regularly. Below only new and removed languages are listed, as well as
127 changes to languages because of Bugzilla reports.
129 === Other changes in 1.24 ===
130 * The deprecated jquery.delayedBind ResourceLoader module was removed.
131 * The deprecated function mw.util.toggleToc was removed.
132 * The Special:Search hooks SpecialSearchGo and SpecialSearchResultsAppend
133   were removed as they were unused.
134 * (bug 65477) User::pingLimiter() now has an additional profile point varying
135   by action being used.
136 * mediawiki.util.$content no longer supports old versions of the Vector,
137   Monobook, Modern and CologneBlue skins that don't yet implement the "mw-body"
138   and/or "mw-body-primary" class name in their html.
139 * Added pp_sortkey column to page_props table, so pages can be efficiently
140   queried and sorted by property value (bug 58032).
141   See $wgPagePropsHaveSortkey if you want to postpone the schema change.
142 * BREAKING CHANGE: The Modern and Cologne Blue skins were moved out of MediaWiki
143   core to their own respective repositories. See also
144   https://www.mediawiki.org/wiki/Skin:Modern and
145   https://www.mediawiki.org/wiki/Skin:CologneBlue.
146 * BREAKING CHANGE: Skins built for MediaWiki 1.15 and earlier that do not use
147   the "headelement" template key are no longer supported. Setting
148   $useHeadElement = false; is no longer supported and will not cause old keys
149   like "headlinks", "skinnameclass", etc. to be defined.
150 * The deprecated 'SpecialVersionExtensionTypes' hook was removed.
151 * (bug 63891) Add 'X-Robots-Tag: noindex' header in action=render pages.
152 * SpecialPage no longer supports the syntax for invoking wfSpecial*() functions.
153   Special pages should subclass SpecialPage and implement the execute() method.
154 * (bug 63755) The deprecated constants RC_MOVE and RC_MOVE_OVER_REDIRECT were
155   removed.
156 * Special:MostLinkedTemplates has been renamed to Special:MostTranscludedPages.
157 * The skin autodiscovery mechanism has been deprecated and will be removed in
158   MediaWiki 1.25. See https://www.mediawiki.org/wiki/Manual:Skin_autodiscovery
159   for migration guide for creators and users of custom skins that relied on it.
160 * ResourceLoaderFileModule#getAllStyleFiles now returns all style files and all
161   skin style files used by the module.
163 ==== Renamed classes ====
164 * CLDRPluralRuleConverter_Expression to CLDRPluralRuleConverterExpression
165 * CLDRPluralRuleConverter_Fragment to CLDRPluralRuleConverterFragment
166 * CLDRPluralRuleConverter_Operator to CLDRPluralRuleConverterOperator
167 * CLDRPluralRuleEvaluator_Range to CLDRPluralRuleEvaluatorRange
168 * CSSJanus_Tokenizer to CSSJanusTokenizer
169 * MediaWiki_I18N to MediaWikiI18N
170 * RevDel_ArchiveItem to RevDelArchiveItem
171 * RevDel_ArchiveList to RevDelArchiveList
172 * RevDel_ArchivedFileItem to RevDelArchivedFileItem
173 * RevDel_ArchivedFileList to RevDelArchivedFileList
174 * RevDel_ArchivedRevisionItem to RevDelArchivedRevisionItem
175 * RevDel_FileItem to RevDelFileItem
176 * RevDel_FileList to RevDelFileList
177 * RevDel_Item to RevDelItem
178 * RevDel_List to RevDelList
179 * RevDel_LogItem to RevDelLogItem
180 * RevDel_LogList to RevDelLogList
181 * RevDel_RevisionItem to RevDelRevisionItem
182 * RevDel_RevisionList to RevDelRevisionList
183 * WebInstaller_Complete to WebInstallerComplete
184 * WebInstaller_Copying to WebInstallerCopying
185 * WebInstaller_DBConnect to WebInstallerDBConnect
186 * WebInstaller_DBSettings to WebInstallerDBSettings
187 * WebInstaller_Document to WebInstallerDocument
188 * WebInstaller_ExistingWiki to WebInstallerExistingWiki
189 * WebInstaller_Install to WebInstallerInstall
190 * WebInstaller_Language to WebInstallerLanguage
191 * WebInstaller_Name to WebInstallerName
192 * WebInstaller_Options to WebInstallerOptions
193 * WebInstaller_Readme to WebInstallerReadme
194 * WebInstaller_ReleaseNotes to WebInstallerReleaseNotes
195 * WebInstaller_Restart to WebInstallerRestart
196 * WebInstaller_Upgrade to WebInstallerUpgrade
197 * WebInstaller_UpgradeDoc to WebInstallerUpgradeDoc
198 * WebInstaller_Welcome to WebInstallerWelcome
200 ==== Removed classes ====
201 * IPBlockForm - Use SpecialBlock directly
202 * WatchlistEditor - Use SpecialEditWatchlist directly
204 == Compatibility ==
206 MediaWiki 1.24 requires PHP 5.3.2 or later.
208 MySQL is the recommended DBMS. PostgreSQL or SQLite can also be used, but
209 support for them is somewhat less mature. There is experimental support for
210 Oracle and Microsoft SQL Server.
212 The supported versions are:
214 * MySQL 5.0.2 or later
215 * PostgreSQL 8.3 or later
216 * SQLite 3.3.7 or later
217 * Oracle 9.0.1 or later
218 * Microsoft SQL Server 2005 (9.00.1399)
220 == Upgrading ==
222 1.24 has several database changes since 1.23, and will not work without schema
223 updates. Note that due to changes to some very large tables like the revision
224 table, the schema update may take quite long (minutes on a medium sized site,
225 many hours on a large site).
227 If upgrading from before 1.11, and you are using a wiki as a commons
228 repository, make sure that it is updated as well. Otherwise, errors may arise
229 due to database schema changes.
231 If upgrading from before 1.7, you may want to run refreshLinks.php to ensure
232 new database fields are filled with data.
234 If you are upgrading from MediaWiki 1.4.x or earlier, you should upgrade to
235 1.5 first. The upgrade script maintenance/upgrade1_5.php has been removed
236 with MediaWiki 1.21.
238 Don't forget to always back up your database before upgrading!
240 See the file UPGRADE for more detailed upgrade instructions.
242 For notes on 1.23.x and older releases, see HISTORY.
244 == Online documentation ==
246 Documentation for both end-users and site administrators is available on
247 MediaWiki.org, and is covered under the GNU Free Documentation License (except
248 for pages that explicitly state that their contents are in the public domain):
250         https://www.mediawiki.org/wiki/Documentation
252 == Mailing list ==
254 A mailing list is available for MediaWiki user support and discussion:
256         https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
258 A low-traffic announcements-only list is also available:
260         https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
262 It's highly recommended that you sign up for one of these lists if you're
263 going to run a public MediaWiki, so you can be notified of security fixes.
265 == IRC help ==
267 There's usually someone online in #mediawiki on irc.freenode.net.