MDL-58428 theme: Update upgrade txt & versions.
[moodle.git] / theme / upgrade.txt
CommitLineData
0f704140
PS
1This files describes API changes in /theme/* themes,
2information provided here is intended especially for theme designer.
edb7d5ad 3
e994dea0
AN
4=== 3.7 ===
5* The core/form_autocompelte_input template now has a `data-tags` attribute.
1baadc87
MM
6* Boost theme renderer overrides have now been migrated to core.
7* Renderers that were overridden by Boost are now in Bootstrapbase
8* Core templates in Boost have now moved into core
9* Templates that were overridden by boost are now located in Bootstrapbase
e994dea0 10
a266ae30
TH
11=== 3.6 ===
12
fed67b67
BB
13* A new callback has been added to the theme layout files allowing plugins to inject their content
14 into the page. For Boost it was added as a mustache variable "{{{ output.standard_after_main_region_html }}}" in
15 templates/columns1.mustache and templates/columns2.mustache. In bootstrapbase it was added as a
16 function call "$OUTPUT->standard_after_main_region_html()" in layout/columns1.php, layout/columns2.php.
17 and layout/columns3.php. Child themes not inheriting these templates should add the function call
18 after the div containing the main content region. Please refer to the messaging drawer UI for an example of
19 making use of this new feature.
a266ae30
TH
20* The body tag has various browser-specific classes for those cases where some
21 browser-sniffing is unavoidable. This used not to recognised Microsoft Edge,
22 but now it does (class 'edge'). Also, both Safari and Chrome used to be
23 class 'safari', but now there are separate classes 'safari' and 'chrome'.
24 The body's class should change to match the browser:
25 - Google Chrome (Mac & Window): The body class should change from safari to chrome.
26 - Google Chrome (Android) : The body class should change from safari, android to chrome, android.
27 - Microsoft Edge: The body class should change from safari to edge.
28 - Mobile safari: The class ios should exist, safari class should be removed.
29* Remove class .safari styling from activity chooser dialog for theme boost and bootstrapbase.
216b8947
MG
30* The following functions and classes have been finally deprecated and can not be used anymore:
31 * css_is_colour()
32 * css_is_width()
33 * css_sort_by_count()
db03bff7 34 * core_course_renderer::add_modchoosertoggle()
216b8947 35 * class css_optimiser
a266ae30 36
46676b76
AB
37=== 3.4 ===
38
39* There was a mustache template login.mustache in /lib/templates/ rendering the login form
40 and a template with the same name in /theme/boost/templates/ rendering the pagelayout "login".
41 To prevent misunderstanding when overriding one of these templates in a Boost child theme,
42 the first one was renamed to loginform.mustache - see MDL-58970.
d7d2a72f
AB
43* The Boost flat navigation nodes now have several data-attributes which let plugin developers
44 access properties from the underlying navigation nodes in the browser - see MDL-59425.
d8cb4615
MN
45* Navigation between activities via a previous and next link was added to Boost, Clean and Bootstrapbase. This
46 is made possible by a new function core_renderer->activity_navigation().
4a8dfef0
JB
47* Theme designers may now place the Reset tour on this page link where required by adding an empty
48 container (e.g. <div class="tool_usertours-resettourcontainer"></div>) to their layouts.
46676b76 49
f745b812
DP
50=== 3.3 ===
51
52* As boost-based themes no longer use the moodle-core-popuphelp help popups, the javascript
53 setup for this module have been moved from core standard_head_html to the bootstrapbase
54 renderer. If your theme needs this javascript you will need to ensure the bootstrap renderer
55 is called, or require the JS yourself
56
2258b4dc
FM
57=== 3.2 ===
58
862816ee
FM
59* Removed themes: base, canvas
60 During the upgrade process the themes will be uninstalled and all their settings will be deleted.
61 If you wish to keep your theme and its settings, download it from moodle.org and put it back in
62 the theme/ directory BEFORE UPGRADING.
2ede86d7 63* Bootstrap 4 was added as part of a the new theme 'boost'.
862816ee
FM
64* Some backwards and forwards compatibility has been added for different bootstrap versions.
65 This is to allow the same markup to work in "clean" and "boost" themes a lot of the time.
66 It is also to allow user text with bootstrap classes to keep working in the new theme.
d3c35f93
FM
67* Using .dir-rtl for RTL styling is deprecated and should not be used any more. From now
68 the styles are automatically flipped when the language is right-to-left. However,
69 as this is not always perfect, you can define exceptions. Please refer to the documentation
70 of the tool RTLCSS-PHP for more information: https://github.com/moodlehq/rtlcss-php
862816ee
FM
71* Themes can now automatically compile SCSS on the fly. This works the same way as it
72 does compiling LESS on the fly, effecitvely adding $THEME->scss to your config. The
73 latter can either be the name a SCSS file (without extension) in your theme's scss/ folder,
74 or a Closure which will return the main SCSS content.
75* Two new callbacks allow themes to inject SCSS code before and after the content provided
76 by the SCSS file $THEME->scss. See $THEME->prescsscallback and $THEME->extrascsscallback.
77* A new callback can be defined to post process the CSS using an object representation
78 of the CSS tree ($THEME->csstreepostprocess). This gives a lot more flexibility than a
79 simple find and replace. Refer to 'boost' for an example, and to PHP-CSS-Parser.
80 (https://github.com/sabberworm/PHP-CSS-Parser) for the API.
81* A new core setting now enables admins to upload the logos of their site. Using the
82 following methods, themers can instantly support branding logos without the need
83 to implement specific theme settings:
84 * $OUTPUT->get_logo_url($maxwidth, $maxheight);
85 * $OUTPUT->get_compact_logo_url($maxwidth, $maxheight);
d3c35f93
FM
86* The class .dir-ltr should not be used any more. To force LTR styles use the directive
87 to remove the rule when the language is RTL. See RTLCSS-PHP for more information.
113efed5
FM
88* A new class .text-ltr may be used to force the direction to LTR. This is especially useful
89 for forms fields (numbers, emails, URLs must not be RTL'd), and for displaying code
90 snippets or configuration samples.
9d1402ab 91* A new theme config 'requiredblocks' allows a theme to define which blocks are deletable.
4f2378d9
FM
92* You may no longer override the following core_course_renderer methods.
93 See course/upgrade.txt for more information:
94 - course_modchooser_module_types
95 - course_modchooser_module
96 - course_modchooser_title
891750bc
FM
97* The question chooser now uses a renderable and a template, the following methods
98 have been deprecated in favour of core_question_bank_renderer::render_qbank_chooser().
99 - qbank_chooser
100 - qbank_chooser_types
101 - qbank_chooser_qtype
102 - qbank_chooser_title
d52ebf11
DP
103* The 'css optimiser' has been removed. Developers are encouraged to use tools such as stylelint
104 to help optimise their css. Some functions and classes in lib/csslib.php (which was not for public use)
105 have been deprecated:
106 - css_is_colour
107 - css_is_width
108 - css_sort_by_count
109 - class css_optimiser no longer does anything.
862816ee
FM
110* CLI svgtool.php has moved from theme/base/cli to admin/cli and paths should be relative to the new location.
111* mod_chat will now display the 'course theme' option for all themes (previously it was only displayed on
112 bootstrap2 based themes).
b11916d3
MG
113* Theme can choose how to display "Add a block" control in $THEME->addblockposition, default value is
114 BLOCK_ADDBLOCK_POSITION_DEFAULT that displays it as a fake block in editing mode.
2258b4dc 115
4040c8b3
DM
116=== 3.1 ===
117
118* A new search box for global search has been added to bootstrap and clean layout files, if
119 your theme is overwriting columns1.php, columns2.php or columns3.php you will need to add a
120 call to core_renderer::search_box to display it.
24346803
AN
121* Notification templates have been renamed to better suit types of alert
122 rather than uses. The following changes have been made:
123 * notification_problem.mustache => notification_error.mustache
124 * notification_message => notification_info
125 * notification_redirect => notification_warning
f59f89b4
MG
126* Method core_course_renderer::course_section_cm_name() is split into two methods, custom themes that override
127 this method must be modified or otherwise editing functionality may become broken. This method is now also used by
128 social activities block and site menu block to display activities names.
4040c8b3 129
c7b73854 130=== 3.0 ===
131
132* The renderer function core_availability_renderer::multiple_messages was changed to
133 render_core_availability_multiple_messages, requiring a parameter of the new
134 \core_availability\multiple_messages type.
5e9a937b
JO
135* Meta description is now included in standard_head_html for homepage in bootstrapbase.
136 If your theme includes a meta description directly in a layout for the frontpage,
137 you will need to remove it or override the standard_head_html instead.
45cd3f60
DM
138* Themes Clean and More have been updated to use a new navbar_button function, which shows the
139 hamburguer icon (responsive menu) or not depending on custom and language menus settings;
140 themes extending bootstrapbase and overriding its layouts can call replace their "a.btn-navbar"
141 node for a call to this function.
c47f3803 142* Themes Clean and More page header logo only displays on front page and login page.
c08b52aa
DM
143* A new function navbar_home has been added to theme_clean and theme_more to display the navigation bar link
144 to the site home. Two new settings have been added to control if the link should be a small logo image, text
145 or both. It defaults to the current behaviour, only a text link.
c7b73854 146
c58891f1
ME
147=== 2.9 ===
148
73b425be
ME
149* Themes Bootstrapbase, Clean and More have undergone some changes for RTL layouts see - MDL-48160.
150
c58891f1 151* Themes Clean amd More page header background logo, if loaded, no longer links to the home page.
c36c3d07
AG
152* Themes Clean and More have been updated to use the renderer full_header(). This renderer (when in a user context) displays a message button
153 and consequently the link to message users have been removed from various pages. It is recommended that theme developers use this
154 renderer to ensure that they do not suffer from a reduction in access to this feature.
155* $OUTPUT->context_header() has been introduced to produce headers similar to what full_header() creates. This renderer is used for creating
156 subsequent headers in a page. If provided with user information, this render will also display a message button like full_header().
c58891f1 157
c10fa5da 158=== 2.8 ===
c58891f1 159
a2633964
ME
160* Themes Base and Canvas layout/embedded.php has changed.
161 The div id="content" has been changed to id="page-content" - see MDL-47915.
c10fa5da
DW
162* All mod_assign CSS selectors have been qualified with ".path-mod-assign". This means any custom CSS
163 rules for mod_assign in a theme may need to be updated.
ebdcb292
SH
164* The following render methods were renamed, if you have overridden any of these you will need to update your renderer:
165 - report_log_renderer::render_report_log_renderable => report_log_renderer::render_report_log
166 - report_loglive_renderer::render_report_loglive_renderable => report_loglive_renderer::render_report_log
a2a4ad89 167* On calendar view screen the course selector and new event button have been swapped, custom CSS for .path-calendar might be affected.
2f6a0e5f
MN
168* The functions search_listing() and search_pagination() in the core_course_management_renderer class take the searched string
169 as an extra parameter - see MDL-46902.
f2b4b2ad 170* Themes with non-fixed headers must have the .navbar class in their navbar in order for floating headers in the grader report to work - see MDL-46658.
6d8eba1a
JC
171* To accomodate the new gradebook, use of overflow: hidden or overflow-x: hidden CSS rules on DOM elements containing the
172 #user-grades table, visible at [Course administration -> Grades] is not recommended. Please use overflow: auto or
173 overflow: scroll instead, as this will handle medium to large courses with multiple activities better (more information available at https://docs.moodle.org/dev/Theme_upgrade_notes ).
174* The new user menu can be added to themes by calling $OUTPUT->user_menu(); we recommend doing so in a backwards-compatible way (see https://docs.moodle.org/dev/Theme_upgrade_notes for more information).
c10fa5da 175
6b216432
AA
176=== 2.7 ===
177
31f28b6a
178* CSS related functions in theme class and csslib.php were refactored, addons that are
179 using this private API need to be updated
ba55be91 180* Please update your css to use 'tr:nth-of-type(odd/even)' instead of '.r0/.r1' to apply tr specific css for various tables.
98396c23
SH
181 These classes are deprecated now and will be removed in Moodle 2.9. This has done to better support styling tables that will be altered by JavaScript.
182 Here is an example to update your css:
183 Old code:
184 table.generaltable .r0 {background-color: #F0F0F0;}
185 table.generaltable .r1 {background-color: #F0F0F0;}
186 New code:
98396c23 187 table.generaltable > tbody > tr:nth-of-type(even) {background-color: #F0F0F0;}
ba55be91 188 table.generaltable > tbody > tr:nth-of-type(odd) {background-color: #F0F0F0;}
6b216432 189
7a2dabcb
FM
190Removed themes:
191* afterburner, anomaly, arialist, binarius, boxxie, brick, formal_white, formfactor, fusion, leatherbound,
192 magazine, nimble, nonzero, overlay, serenity, sky_high, splash, standard and standardold have been removed.
193 During the upgrade process the themes will be uninstalled and all their settings will be deleted.
194 If you wish to keep your theme and its settings, download it from moodle.org and put it back in
195 the theme/ directory BEFORE UPGRADING.
6b216432 196
71715870
JC
197Notes:
198* z-index on #dock has been adjusted from 11000 to 5000 to prevent overlapping issues with fullscreen TinyMCE in Base theme.
199
699e2fd0 200=== 2.6 ===
3b42864d 201
7c2efc11
JM
202Removed themes:
203* "My Mobile" theme has been removed (see MDL-40874).
204 During the upgrade process "My Mobile" theme will be uninstalled and all its settings will be deleted.
205 "My Mobile" theme and its extending themes will fallback to the mobile friendly "Clean" theme.
206 If you wish to keep "My Mobile" theme and its settings, BEFORE UPGRADING you can copy the files from the
207 unmaintained plugin into theme/mymobile.
208 The unmaintained plugin can be downloaded at https://moodle.org/plugins/pluginversion.php?id=4563
699e2fd0 209Notes:
faf6010b 210* There have been several changes made to the classes used on headings throughout Moodle.
211 This was done as per the Moodle HTML guidelines. h1 and h2 elements should have no classes, h3 and lower headings
212 may have descriptive classes only (any classes must properly describe the relation between the header and its content).
699e2fd0 213* The parameters value for the following functions have been modified: core_renderer::heading() and core_renderer::heading_with_help().
3b42864d 214 This means that headings using the default options will no longer have the class "main" which was the previous default.
d61c96b6 215* The file picker and activity chooser have been converted to use M.core.dialogue. This means the styles
3b42864d
RW
216 for these elements have changed in the base and bootstrapbase themes and you will need to copy the new styles
217 if you are not inheriting from either one of these themes.
b4c6b42e 218* For the themes based on bootstrapbase please also read theme/bootstrapbase/upgrade.txt
e5de4933
SH
219* A new component action_menu is now used to display editing icons for courses and blocks within a drop down. If you have a theme that doesn't
220 extend base, canvas, or clean then you will need to style for this new component within your theme.
166ac0a3
SH
221* The maintenance layout now has a special renderer that extends the core_renderer in order to prevent some methods from interacting
222 with the database. Please be aware that for the maintenance layout some methods now always return an empty string.
223 This has been done because it is important that during maintenance routines we don't show any links, interact with the database,
224 or interact with caches as doing so may lead to errors,
225 Please see the maintenance renderer notes below for details on the functions affected.
e5de4933
SH
226
227Renderer changes:
228* core_course_renderer::course_section_cm_edit_actions has two new optional arguments and now uses and action_menu component.
229* core_course_renderer::course_section_cm has been altered to call core_course_renderer::course_section_cm_edit_actions with the two new arguments.
230* core_renderer::block_controls has a new optional argument (the block id) and has been altered to use the new action_menu component.
231* core_renderer::block_header has been altered to give core_renderer::block_controls the new second argument, the block id.
232* core_renderer::action_link has a new argument, and optional icon that can be rendererd into the link.
233
faf6010b 234Selector changes:
235* Changes to the classes given to the header produced when rendering a single section within a course.
236 .section-navigation.header.headingblock => .section-navigation.navigationtitle
237* Changes to the classes used when producing the course information box that lists courses.
238 The name (h3|div} of both courses and categories used to have .name, for courses in the list this was changed to .coursename and for categories in the list this was changed to .categoryname.
239* Classes ".header and .headingblock" were removed from all front page content headings.
240* Classes ".headingblock .header .tag-header" were removed from the tag index page
241
166ac0a3
SH
242Maintenance renderer notes:
243When the maintenance layout is being used $OUTPUT will be an instance of core_renderer_maintenance.
244This renderer mimics the core_renderer except that the following functions always return an empty string.
cf9f5a17 245* core_renderer_maintenance::block
246* core_renderer_maintenance::blocks
247* core_renderer_maintenance::blocks_for_regions
248* core_renderer_maintenance::course_header
249* core_renderer_maintenance::course_footer
250* core_renderer_maintenance::course_content_header
251* core_renderer_maintenance::course_content_footer
252* core_renderer_maintenance::custom_menu
253* core_renderer_maintenance::file_picker
254* core_renderer_maintenance::htmllize_file_tree
255* core_renderer_maintenance::lang_menu
256* core_renderer_maintenance::login_info
257* core_renderer_maintenance::user_picture
166ac0a3
SH
258
259If you have overridden methods of the core_renderer in your theme and want those changes to be shown during times of maintenance you
260will also need to override the core_renderer_maintenance and copy your customisations from the core_renderer to that.
261
90160639 262=== 2.5.1 ===
d3e5a21e
SH
263
264Notes:
265* Block drag and drop functionality has been improved so that it works regardless of what block regions you use
266 or how many block regions you have. In order to benefit from this improvement you must convert your calls from
267 $OUTPUT->blocks_for_region() to $OUTPUT->blocks.
268
269Optional changes:
270* Theme config can nominate block regions to swap if the user is using a rtl languages such as Hebrew.
271 $THEME->blockrtlmanipulations should be an associative array, the key is the original block region, and the
272 value should be where the blocks in that region should be displayed.
273* New $OUTPUT methods to replace code that was previously using $PAGE. Converting to these methods is optional
274 but highly recommended. Refer to the bootstrapbase layouts for examples.
275 - $OUTPUT->body_attributes() returns a string you can use for the body id and classes.
276 - $OUTPUT->blocks() returns HTML to display a block region and all of its blocks. This adds data attributes
277 that ensure drag and drop of blocks will work no matter what block regions or how many you have.
278 - $OUTPUT->page_heading() returns the page heading. Replaces $PAGE->heading.
279 - $OUTPUT->page_heading_button() returns the button to display with the heading. Replaces $page->button.
280 - $OUTPUT->page_doc_link() returns the link to moodle docs for the page. Replaces page_doc_link().
281 - $OUTPUT->page_heading_menu() returns the heading menu for the page. Replaces $PAGE->headingmenu.
282 - $OUTPUT->page_title() Returns the title to use for the head section.
283 - $OUTPUT->favicon() returns the URL to the favicon.
284
285Renderer changes:
286* core_renderer::navbar now returns an empty string if there are no navigation items to display.
287* core_renderer::custom_menu now adds a class "custom_menu" to the div that contains the HTML for the custom menu.
288
fc7defef
JF
289=== 2.5 ===
290
09ae7ee0
MG
291required changes:
292* Functions core_course_renderer::course_category_tree() and course_category_tree_category()
293 are deprecated
294* Significant changes in rendering of courses and categories listings, lots of CSS classes changed,
295 several functions such as print_courses(), print_whole_category_list(), print_category_info()
296 are moved to course renderer.
297 See http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
298
fc7defef
JF
299DOM changes:
300* changed the h1 title in the help popup to a h2.
97dbc8f2 301* new setting $THEME->yuicssmodules = array('cssreset', 'cssfonts', 'cssgrids', 'cssbase'); which
12cb45f1 302 allows themes to use different CSS reset normalisers such as cssnormalize YUI module.
6e5d002e 303* Re-wrote the user profile views to definition lists.
12cb45f1
MN
304* Re-wrote the table for the course completion status block to use html_table - added some CSS classes to
305 the table in the process (see MDL-35608).
5581c618 306* Cancel buttons have the class btn-cancel.
12cb45f1
MN
307* Added a z-index for the div#dateselector-calendar-panel so that the calendar pop-up renders above
308 the filemanager when they overlap, ie. the course settings page (see MDL-39047).
9074e478
DM
309* Trivial change of CSS selectors used to display plugin status at the plugins overview
310 screen (#plugins-control-panel).
fc7defef 311
6671fa73
JF
312Renderer changes:
313* Mymobile theme changed to support more verbose move-block-here descriptions.
314
2d0e682d
MV
315=== 2.4 ===
316
52b1ed5e
MG
317required changes:
318* output course and course content header/footer that may be returned by course format (see MDL-36048)
e40bd746 319* span.completionprogress has been changed to a <div> and is not a float by default any more.
52b1ed5e 320
fbb207c5
FM
321deprecation:
322* i/roles: Use t/assignroles instead
0cddd851
FM
323* t/manual_item: Use i/manual_item instead
324* t/unlock_gray: Use t/locked instead
f2bba619 325* t/userblue: Previously used to unblock a user, use t/unblock.
5326675e
BR
326* c/course: Use i/courseevent instead
327* c/group: Use i/groupevent instead
328* c/site: Use i/siteevent instead
329* c/user: Use i/userevent instead
99938034 330* t/clear: Use t/check instead
c3847443
FM
331* i/cross_red_big: Use i/invalid or i/grade_incorrect
332* i/tick_green_big: Use i/valid or i/grade_correct
333* i/tick_amber_big: Use i/caution or i/grade_partiallycorrect
334* No more small versions of i/cross_red_small, i/tick_green_small and i/tick_amber_small, use their big equivalent.
501380a9 335* t/addgreen: Use t/add instead.
851d3b7a 336* i/approve: Use t/approve instead
fbb207c5 337
2d0e682d
MV
338optional changes:
339* new optional boolean parameter $withlinks for public function login_info() in lib/outputrenderers.php (MDL-31365)
340* new layout option "nologinlinks" and new page layout "secure" e.g. for safebrowser and securewindow (MDL-31365)
bb128107 341* new class 'iconlarge' for 24x24 icons.
fbb207c5
FM
342* new icons i/export and i/import (sized 16x16). Previously export and import actions used i/backup and i/restore.
343* new icon i/assignroles (sized 16x16), to prevent the use of i/roles which is 12x12.
344* new icon i/switchrole (sized 16x16), was previously using i/roles. Now is a copy of the new i/assignroles icon.
c42651d6
FM
345* new icons i/enrolusers and t/enrolusers, previsouly i/users was used.
346* new icon t/cohorts (sized 12x12), to prevent the use of i/cohorts which is 16x16.
06b7ed0a
FM
347* new icons t/sort_asc, t/sort_desc to use for ordering in table headers.
348* new class 'iconsort' for icons used for ordering in table headers.
fa9c0aab 349* new icons t/locked and t/unlocked (12x12) which should be used when there is no action associated to the icon.
0cddd851 350* new icons i/folder (16x16), monochrome equivalent to f/folder.
f2bba619
FM
351* new icons t/addcontact, t/removecontact and t/messages, previously t/addgreen, t/delete and t/log were used in messaging.
352* new icons t/unblock and i/twoway.
5326675e 353* new icons i/courseevent, i/groupevent, i/siteevent and i/userevent (16x16) instead of c/* for calendar events.
99938034
FM
354* new icon t/markasread (12x12) to replace t/clear used in forums.
355* new icon t/check (12x12) to replace t/clear which name does not reflect the icon meaning.
c22fbd38 356* new classes 'icon-pre' and 'icon-post' supposedly to be used when the icon is positioned before or after the text. This is not really used yet, but it's a start towards some standardisation of the icon selectors.
c3847443
FM
357* new icons i/valid, i/caution and i/invalid for generic statuses.
358* new icons i/grade_correct, i/grade_partiallycorrect and i/grade_incorrect for grades.
851d3b7a 359* new icon t/approve (12x12).
0348468b 360* new icon t/contextmenu (12x12) for a monochrome version of i/menu.
ee362526 361
33d9f44b
PS
362=== 2.3 ===
363
364optional changes:
365* add new u/f3.png image when theme contains customised f1 and f2 default user images
366
0f704140
PS
367=== 2.2 ===
368
369required changes:
370* use new page content placeholder "echo $OUTPUT->main_content()" instead of "echo core_renderer::MAIN_CONTENT_TOKEN"
ee362526 371 see git commit: 3b3f302855d7621405a8b93e49bd399d67a998d7
2d0e682d 372* upgrade report selectors: search for "-course-report-" and replace with "-report-"