MDL-51013 themes: Info about new navbar_button function
[moodle.git] / theme / upgrade.txt
1 This files describes API changes in /theme/* themes,
2 information provided here is intended especially for theme designer.
4 === 3.0 ===
6 * The renderer function core_availability_renderer::multiple_messages was changed to
7   render_core_availability_multiple_messages, requiring a parameter of the new
8   \core_availability\multiple_messages type.
9 * Meta description is now included in standard_head_html for homepage in bootstrapbase.
10   If your theme includes a meta description directly in a layout for the frontpage,
11   you will need to remove it or override the standard_head_html instead.
12 * Themes Clean and More have been updated to use a new navbar_button function, which shows the
13   hamburguer icon (responsive menu) or not depending on custom and language menus settings;
14   themes extending bootstrapbase and overriding its layouts can call replace their "a.btn-navbar"
15   node for a call to this function.
17 === 2.9 ===
19 * Themes Bootstrapbase, Clean and More have undergone some changes for RTL layouts see - MDL-48160.
21 * Themes Clean amd More page header background logo, if loaded, no longer links to the home page.
22 * Themes Clean and More have been updated to use the renderer full_header(). This renderer (when in a user context) displays a message button
23   and consequently the link to message users have been removed from various pages. It is recommended that theme developers use this
24   renderer to ensure that they do not suffer from a reduction in access to this feature.
25 * $OUTPUT->context_header() has been introduced to produce headers similar to what full_header() creates. This renderer is used for creating
26   subsequent headers in a page. If provided with user information, this render will also display a message button like full_header().
28 === 2.8 ===
30 * Themes Base and Canvas layout/embedded.php has changed.
31   The div id="content" has been changed to id="page-content" - see MDL-47915.
32 * All mod_assign CSS selectors have been qualified with ".path-mod-assign". This means any custom CSS
33   rules for mod_assign in a theme may need to be updated.
34 * The following render methods were renamed, if you have overridden any of these you will need to update your renderer:
35   - report_log_renderer::render_report_log_renderable         => report_log_renderer::render_report_log
36   - report_loglive_renderer::render_report_loglive_renderable => report_loglive_renderer::render_report_log
37 * On calendar view screen the course selector and new event button have been swapped, custom CSS for .path-calendar might be affected.
38 * The functions search_listing() and search_pagination() in the core_course_management_renderer class take the searched string
39   as an extra parameter - see MDL-46902.
40 * 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.
41 * To accomodate the new gradebook, use of overflow: hidden or overflow-x: hidden CSS rules on DOM elements containing the
42   #user-grades table, visible at [Course administration -> Grades] is not recommended. Please use overflow: auto or
43   overflow: scroll instead, as this will handle medium to large courses with multiple activities better (more information available at ).
44 * The new user menu can be added to themes by calling $OUTPUT->user_menu(); we recommend doing so in a backwards-compatible way (see for more information).
46 === 2.7 ===
48 * CSS related functions in theme class and csslib.php were refactored, addons that are
49   using this private API need to be updated
50 * Please update your css to use 'tr:nth-of-type(odd/even)' instead of '.r0/.r1' to apply tr specific css for various tables.
51   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.
52   Here is an example to update your css:
53   Old code:
54     table.generaltable .r0 {background-color: #F0F0F0;}
55     table.generaltable .r1 {background-color: #F0F0F0;}
56   New code:
57     table.generaltable > tbody > tr:nth-of-type(even) {background-color: #F0F0F0;}
58     table.generaltable > tbody > tr:nth-of-type(odd) {background-color: #F0F0F0;}
60 Removed themes:
61 * afterburner, anomaly, arialist, binarius, boxxie, brick, formal_white, formfactor, fusion, leatherbound,
62   magazine, nimble, nonzero, overlay, serenity, sky_high, splash, standard and standardold have been removed.
63   During the upgrade process the themes will be uninstalled and all their settings will be deleted.
64   If you wish to keep your theme and its settings, download it from and put it back in
65   the theme/ directory BEFORE UPGRADING.
67 Notes:
68 * z-index on #dock has been adjusted from 11000 to 5000 to prevent overlapping issues with fullscreen TinyMCE in Base theme.
70 === 2.6 ===
72 Removed themes:
73 * "My Mobile" theme has been removed (see MDL-40874).
74   During the upgrade process "My Mobile" theme will be uninstalled and all its settings will be deleted.
75   "My Mobile" theme and its extending themes will fallback to the mobile friendly "Clean" theme.
76   If you wish to keep "My Mobile" theme and its settings, BEFORE UPGRADING you can copy the files from the
77   unmaintained plugin into theme/mymobile.
78   The unmaintained plugin can be downloaded at
79 Notes:
80 * There have been several changes made to the classes used on headings throughout Moodle.
81   This was done as per the Moodle HTML guidelines. h1 and h2 elements should have no classes, h3 and lower headings
82   may have descriptive classes only (any classes must properly describe the relation between the header and its content).
83 * The parameters value for the following functions have been modified: core_renderer::heading() and core_renderer::heading_with_help().
84   This means that headings using the default options will no longer have the class "main" which was the previous default.
85 * The file picker and activity chooser have been converted to use M.core.dialogue. This means the styles
86   for these elements have changed in the base and bootstrapbase themes and you will need to copy the new styles
87   if you are not inheriting from either one of these themes.
88 * For the themes based on bootstrapbase please also read theme/bootstrapbase/upgrade.txt
89 * 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
90   extend base, canvas, or clean then you will need to style for this new component within your theme.
91 * The maintenance layout now has a special renderer that extends the core_renderer in order to prevent some methods from interacting
92   with the database. Please be aware that for the maintenance layout some methods now always return an empty string.
93   This has been done because it is important that during maintenance routines we don't show any links, interact with the database,
94   or interact with caches as doing so may lead to errors,
95   Please see the maintenance renderer notes below for details on the functions affected.
97 Renderer changes:
98 * core_course_renderer::course_section_cm_edit_actions has two new optional arguments and now uses and action_menu component.
99 * core_course_renderer::course_section_cm has been altered to call core_course_renderer::course_section_cm_edit_actions with the two new arguments.
100 * core_renderer::block_controls has a new optional argument (the block id) and has been altered to use the new action_menu component.
101 * core_renderer::block_header has been altered to give core_renderer::block_controls the new second argument, the block id.
102 * core_renderer::action_link has a new argument, and optional icon that can be rendererd into the link.
104 Selector changes:
105 * Changes to the classes given to the header produced when rendering a single section within a course.
106   .section-navigation.header.headingblock => .section-navigation.navigationtitle
107 * Changes to the classes used when producing the course information box that lists courses.
108   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.
109 * Classes ".header and .headingblock" were removed from all front page content headings.
110 * Classes ".headingblock .header .tag-header" were removed from the tag index page
112 Maintenance renderer notes:
113 When the maintenance layout is being used $OUTPUT will be an instance of core_renderer_maintenance.
114 This renderer mimics the core_renderer except that the following functions always return an empty string.
115 * core_renderer_maintenance::block
116 * core_renderer_maintenance::blocks
117 * core_renderer_maintenance::blocks_for_regions
118 * core_renderer_maintenance::course_header
119 * core_renderer_maintenance::course_footer
120 * core_renderer_maintenance::course_content_header
121 * core_renderer_maintenance::course_content_footer
122 * core_renderer_maintenance::custom_menu
123 * core_renderer_maintenance::file_picker
124 * core_renderer_maintenance::htmllize_file_tree
125 * core_renderer_maintenance::lang_menu
126 * core_renderer_maintenance::login_info
127 * core_renderer_maintenance::user_picture
129 If you have overridden methods of the core_renderer in your theme and want those changes to be shown during times of maintenance you
130 will also need to override the core_renderer_maintenance and copy your customisations from the core_renderer to that.
132 === 2.5.1 ===
134 Notes:
135 * Block drag and drop functionality has been improved so that it works regardless of what block regions you use
136   or how many block regions you have. In order to benefit from this improvement you must convert your calls from
137   $OUTPUT->blocks_for_region() to $OUTPUT->blocks.
139 Optional changes:
140 * Theme config can nominate block regions to swap if the user is using a rtl languages such as Hebrew.
141   $THEME->blockrtlmanipulations should be an associative array, the key is the original block region, and the
142   value should be where the blocks in that region should be displayed.
143 * New $OUTPUT methods to replace code that was previously using $PAGE. Converting to these methods is optional
144   but highly recommended. Refer to the bootstrapbase layouts for examples.
145   - $OUTPUT->body_attributes() returns a string you can use for the body id and classes.
146   - $OUTPUT->blocks() returns HTML to display a block region and all of its blocks. This adds data attributes
147     that ensure drag and drop of blocks will work no matter what block regions or how many you have.
148   - $OUTPUT->page_heading() returns the page heading. Replaces $PAGE->heading.
149   - $OUTPUT->page_heading_button() returns the button to display with the heading. Replaces $page->button.
150   - $OUTPUT->page_doc_link() returns the link to moodle docs for the page. Replaces page_doc_link().
151   - $OUTPUT->page_heading_menu() returns the heading menu for the page. Replaces $PAGE->headingmenu.
152   - $OUTPUT->page_title() Returns the title to use for the head section.
153   - $OUTPUT->favicon() returns the URL to the favicon.
155 Renderer changes:
156 * core_renderer::navbar now returns an empty string if there are no navigation items to display.
157 * core_renderer::custom_menu now adds a class "custom_menu" to the div that contains the HTML for the custom menu.
159 === 2.5 ===
161 required changes:
162 * Functions core_course_renderer::course_category_tree() and course_category_tree_category()
163   are deprecated
164 * Significant changes in rendering of courses and categories listings, lots of CSS classes changed,
165   several functions such as print_courses(), print_whole_category_list(), print_category_info()
166   are moved to course renderer.
167   See
169 DOM changes:
170 * changed the h1 title in the help popup to a h2.
171 * new setting $THEME->yuicssmodules = array('cssreset', 'cssfonts', 'cssgrids', 'cssbase'); which
172   allows themes to use different CSS reset normalisers such as cssnormalize YUI module.
173 * Re-wrote the user profile views to definition lists.
174 * Re-wrote the table for the course completion status block to use html_table - added some CSS classes to
175   the table in the process (see MDL-35608).
176 * Cancel buttons have the class btn-cancel.
177 * Added a z-index for the div#dateselector-calendar-panel so that the calendar pop-up renders above
178   the filemanager when they overlap, ie. the course settings page (see MDL-39047).
179 * Trivial change of CSS selectors used to display plugin status at the plugins overview
180   screen (#plugins-control-panel).
182 Renderer changes:
183 * Mymobile theme changed to support more verbose move-block-here descriptions.
185 === 2.4 ===
187 required changes:
188 * output course and course content header/footer that may be returned by course format (see MDL-36048)
189 * span.completionprogress has been changed to a <div> and is not a float by default any more.
191 deprecation:
192 * i/roles: Use t/assignroles instead
193 * t/manual_item: Use i/manual_item instead
194 * t/unlock_gray: Use t/locked instead
195 * t/userblue: Previously used to unblock a user, use t/unblock.
196 * c/course: Use i/courseevent instead
197 * c/group: Use i/groupevent instead
198 * c/site: Use i/siteevent instead
199 * c/user: Use i/userevent instead
200 * t/clear: Use t/check instead
201 * i/cross_red_big: Use i/invalid or i/grade_incorrect
202 * i/tick_green_big: Use i/valid or i/grade_correct
203 * i/tick_amber_big: Use i/caution or i/grade_partiallycorrect
204 * No more small versions of i/cross_red_small, i/tick_green_small and i/tick_amber_small, use their big equivalent.
205 * t/addgreen: Use t/add instead.
206 * i/approve: Use t/approve instead
208 optional changes:
209 * new optional boolean parameter $withlinks for public function login_info() in lib/outputrenderers.php (MDL-31365)
210 * new layout option "nologinlinks" and new page layout "secure" e.g. for safebrowser and securewindow (MDL-31365)
211 * new class 'iconlarge' for 24x24 icons.
212 * new icons i/export and i/import (sized 16x16). Previously export and import actions used i/backup and i/restore.
213 * new icon i/assignroles (sized 16x16), to prevent the use of i/roles which is 12x12.
214 * new icon i/switchrole (sized 16x16), was previously using i/roles. Now is a copy of the new i/assignroles icon.
215 * new icons i/enrolusers and t/enrolusers, previsouly i/users was used.
216 * new icon t/cohorts (sized 12x12), to prevent the use of i/cohorts which is 16x16.
217 * new icons t/sort_asc, t/sort_desc to use for ordering in table headers.
218 * new class 'iconsort' for icons used for ordering in table headers.
219 * new icons t/locked and t/unlocked (12x12) which should be used when there is no action associated to the icon.
220 * new icons i/folder (16x16), monochrome equivalent to f/folder.
221 * new icons t/addcontact, t/removecontact and t/messages, previously t/addgreen, t/delete and t/log were used in messaging.
222 * new icons t/unblock and i/twoway.
223 * new icons i/courseevent, i/groupevent, i/siteevent and i/userevent (16x16) instead of c/* for calendar events.
224 * new icon t/markasread (12x12) to replace t/clear used in forums.
225 * new icon t/check (12x12) to replace t/clear which name does not reflect the icon meaning.
226 * 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.
227 * new icons i/valid, i/caution and i/invalid for generic statuses.
228 * new icons i/grade_correct, i/grade_partiallycorrect and i/grade_incorrect for grades.
229 * new icon t/approve (12x12).
230 * new icon t/contextmenu (12x12) for a monochrome version of i/menu.
232 === 2.3 ===
234 optional changes:
235 * add new u/f3.png image when theme contains customised f1 and f2 default user images
237 === 2.2 ===
239 required changes:
240 * use new page content placeholder "echo $OUTPUT->main_content()" instead of "echo core_renderer::MAIN_CONTENT_TOKEN"
241   see git commit: 3b3f302855d7621405a8b93e49bd399d67a998d7
242 * upgrade report selectors: search for "-course-report-" and replace with "-report-"