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