weekly release 2.7dev
[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
6b216432
AA
4=== 2.7 ===
5
6* Please update your css to use 'tr:nth-of-type(odd/even)' instead of '.ro/.r1' to apply tr specific css for various tables.
98396c23
SH
7 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.
8 Here is an example to update your css:
9 Old code:
10 table.generaltable .r0 {background-color: #F0F0F0;}
11 table.generaltable .r1 {background-color: #F0F0F0;}
12 New code:
13 table.generaltable > tbody > tr:nth-of-type(odd) {background-color: #F0F0F0;}
14 table.generaltable > tbody > tr:nth-of-type(even) {background-color: #F0F0F0;}
6b216432
AA
15
16
699e2fd0 17=== 2.6 ===
3b42864d 18
7c2efc11
JM
19Removed themes:
20* "My Mobile" theme has been removed (see MDL-40874).
21 During the upgrade process "My Mobile" theme will be uninstalled and all its settings will be deleted.
22 "My Mobile" theme and its extending themes will fallback to the mobile friendly "Clean" theme.
23 If you wish to keep "My Mobile" theme and its settings, BEFORE UPGRADING you can copy the files from the
24 unmaintained plugin into theme/mymobile.
25 The unmaintained plugin can be downloaded at https://moodle.org/plugins/pluginversion.php?id=4563
699e2fd0 26Notes:
faf6010b 27* There have been several changes made to the classes used on headings throughout Moodle.
28 This was done as per the Moodle HTML guidelines. h1 and h2 elements should have no classes, h3 and lower headings
29 may have descriptive classes only (any classes must properly describe the relation between the header and its content).
699e2fd0 30* The parameters value for the following functions have been modified: core_renderer::heading() and core_renderer::heading_with_help().
3b42864d 31 This means that headings using the default options will no longer have the class "main" which was the previous default.
d61c96b6 32* The file picker and activity chooser have been converted to use M.core.dialogue. This means the styles
3b42864d
RW
33 for these elements have changed in the base and bootstrapbase themes and you will need to copy the new styles
34 if you are not inheriting from either one of these themes.
b4c6b42e 35* For the themes based on bootstrapbase please also read theme/bootstrapbase/upgrade.txt
e5de4933
SH
36* 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
37 extend base, canvas, or clean then you will need to style for this new component within your theme.
166ac0a3
SH
38* The maintenance layout now has a special renderer that extends the core_renderer in order to prevent some methods from interacting
39 with the database. Please be aware that for the maintenance layout some methods now always return an empty string.
40 This has been done because it is important that during maintenance routines we don't show any links, interact with the database,
41 or interact with caches as doing so may lead to errors,
42 Please see the maintenance renderer notes below for details on the functions affected.
e5de4933
SH
43
44Renderer changes:
45* core_course_renderer::course_section_cm_edit_actions has two new optional arguments and now uses and action_menu component.
46* core_course_renderer::course_section_cm has been altered to call core_course_renderer::course_section_cm_edit_actions with the two new arguments.
47* core_renderer::block_controls has a new optional argument (the block id) and has been altered to use the new action_menu component.
48* core_renderer::block_header has been altered to give core_renderer::block_controls the new second argument, the block id.
49* core_renderer::action_link has a new argument, and optional icon that can be rendererd into the link.
50
faf6010b 51Selector changes:
52* Changes to the classes given to the header produced when rendering a single section within a course.
53 .section-navigation.header.headingblock => .section-navigation.navigationtitle
54* Changes to the classes used when producing the course information box that lists courses.
55 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.
56* Classes ".header and .headingblock" were removed from all front page content headings.
57* Classes ".headingblock .header .tag-header" were removed from the tag index page
58
166ac0a3
SH
59Maintenance renderer notes:
60When the maintenance layout is being used $OUTPUT will be an instance of core_renderer_maintenance.
61This renderer mimics the core_renderer except that the following functions always return an empty string.
62* core_maintenance_renderer::block
63* core_maintenance_renderer::blocks
64* core_maintenance_renderer::blocks_for_regions
65* core_maintenance_renderer::course_header
66* core_maintenance_renderer::course_footer
67* core_maintenance_renderer::course_content_header
68* core_maintenance_renderer::course_content_footer
69* core_maintenance_renderer::custom_menu
70* core_maintenance_renderer::file_picker
71* core_maintenance_renderer::htmllize_file_tree
72* core_maintenance_renderer::lang_menu
73* core_maintenance_renderer::login_info
74* core_maintenance_renderer::user_picture
75
76If you have overridden methods of the core_renderer in your theme and want those changes to be shown during times of maintenance you
77will also need to override the core_renderer_maintenance and copy your customisations from the core_renderer to that.
78
90160639 79=== 2.5.1 ===
d3e5a21e
SH
80
81Notes:
82* Block drag and drop functionality has been improved so that it works regardless of what block regions you use
83 or how many block regions you have. In order to benefit from this improvement you must convert your calls from
84 $OUTPUT->blocks_for_region() to $OUTPUT->blocks.
85
86Optional changes:
87* Theme config can nominate block regions to swap if the user is using a rtl languages such as Hebrew.
88 $THEME->blockrtlmanipulations should be an associative array, the key is the original block region, and the
89 value should be where the blocks in that region should be displayed.
90* New $OUTPUT methods to replace code that was previously using $PAGE. Converting to these methods is optional
91 but highly recommended. Refer to the bootstrapbase layouts for examples.
92 - $OUTPUT->body_attributes() returns a string you can use for the body id and classes.
93 - $OUTPUT->blocks() returns HTML to display a block region and all of its blocks. This adds data attributes
94 that ensure drag and drop of blocks will work no matter what block regions or how many you have.
95 - $OUTPUT->page_heading() returns the page heading. Replaces $PAGE->heading.
96 - $OUTPUT->page_heading_button() returns the button to display with the heading. Replaces $page->button.
97 - $OUTPUT->page_doc_link() returns the link to moodle docs for the page. Replaces page_doc_link().
98 - $OUTPUT->page_heading_menu() returns the heading menu for the page. Replaces $PAGE->headingmenu.
99 - $OUTPUT->page_title() Returns the title to use for the head section.
100 - $OUTPUT->favicon() returns the URL to the favicon.
101
102Renderer changes:
103* core_renderer::navbar now returns an empty string if there are no navigation items to display.
104* core_renderer::custom_menu now adds a class "custom_menu" to the div that contains the HTML for the custom menu.
105
fc7defef
JF
106=== 2.5 ===
107
09ae7ee0
MG
108required changes:
109* Functions core_course_renderer::course_category_tree() and course_category_tree_category()
110 are deprecated
111* Significant changes in rendering of courses and categories listings, lots of CSS classes changed,
112 several functions such as print_courses(), print_whole_category_list(), print_category_info()
113 are moved to course renderer.
114 See http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
115
fc7defef
JF
116DOM changes:
117* changed the h1 title in the help popup to a h2.
97dbc8f2 118* new setting $THEME->yuicssmodules = array('cssreset', 'cssfonts', 'cssgrids', 'cssbase'); which
12cb45f1 119 allows themes to use different CSS reset normalisers such as cssnormalize YUI module.
6e5d002e 120* Re-wrote the user profile views to definition lists.
12cb45f1
MN
121* Re-wrote the table for the course completion status block to use html_table - added some CSS classes to
122 the table in the process (see MDL-35608).
5581c618 123* Cancel buttons have the class btn-cancel.
12cb45f1
MN
124* Added a z-index for the div#dateselector-calendar-panel so that the calendar pop-up renders above
125 the filemanager when they overlap, ie. the course settings page (see MDL-39047).
9074e478
DM
126* Trivial change of CSS selectors used to display plugin status at the plugins overview
127 screen (#plugins-control-panel).
fc7defef 128
6671fa73
JF
129Renderer changes:
130* Mymobile theme changed to support more verbose move-block-here descriptions.
131
2d0e682d
MV
132=== 2.4 ===
133
52b1ed5e
MG
134required changes:
135* output course and course content header/footer that may be returned by course format (see MDL-36048)
e40bd746 136* span.completionprogress has been changed to a <div> and is not a float by default any more.
52b1ed5e 137
fbb207c5
FM
138deprecation:
139* i/roles: Use t/assignroles instead
0cddd851
FM
140* t/manual_item: Use i/manual_item instead
141* t/unlock_gray: Use t/locked instead
f2bba619 142* t/userblue: Previously used to unblock a user, use t/unblock.
5326675e
BR
143* c/course: Use i/courseevent instead
144* c/group: Use i/groupevent instead
145* c/site: Use i/siteevent instead
146* c/user: Use i/userevent instead
99938034 147* t/clear: Use t/check instead
c3847443
FM
148* i/cross_red_big: Use i/invalid or i/grade_incorrect
149* i/tick_green_big: Use i/valid or i/grade_correct
150* i/tick_amber_big: Use i/caution or i/grade_partiallycorrect
151* No more small versions of i/cross_red_small, i/tick_green_small and i/tick_amber_small, use their big equivalent.
501380a9 152* t/addgreen: Use t/add instead.
851d3b7a 153* i/approve: Use t/approve instead
fbb207c5 154
2d0e682d
MV
155optional changes:
156* new optional boolean parameter $withlinks for public function login_info() in lib/outputrenderers.php (MDL-31365)
157* new layout option "nologinlinks" and new page layout "secure" e.g. for safebrowser and securewindow (MDL-31365)
bb128107 158* new class 'iconlarge' for 24x24 icons.
fbb207c5
FM
159* new icons i/export and i/import (sized 16x16). Previously export and import actions used i/backup and i/restore.
160* new icon i/assignroles (sized 16x16), to prevent the use of i/roles which is 12x12.
161* new icon i/switchrole (sized 16x16), was previously using i/roles. Now is a copy of the new i/assignroles icon.
c42651d6
FM
162* new icons i/enrolusers and t/enrolusers, previsouly i/users was used.
163* new icon t/cohorts (sized 12x12), to prevent the use of i/cohorts which is 16x16.
06b7ed0a
FM
164* new icons t/sort_asc, t/sort_desc to use for ordering in table headers.
165* new class 'iconsort' for icons used for ordering in table headers.
fa9c0aab 166* new icons t/locked and t/unlocked (12x12) which should be used when there is no action associated to the icon.
0cddd851 167* new icons i/folder (16x16), monochrome equivalent to f/folder.
f2bba619
FM
168* new icons t/addcontact, t/removecontact and t/messages, previously t/addgreen, t/delete and t/log were used in messaging.
169* new icons t/unblock and i/twoway.
5326675e 170* new icons i/courseevent, i/groupevent, i/siteevent and i/userevent (16x16) instead of c/* for calendar events.
99938034
FM
171* new icon t/markasread (12x12) to replace t/clear used in forums.
172* new icon t/check (12x12) to replace t/clear which name does not reflect the icon meaning.
c22fbd38 173* 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
174* new icons i/valid, i/caution and i/invalid for generic statuses.
175* new icons i/grade_correct, i/grade_partiallycorrect and i/grade_incorrect for grades.
851d3b7a 176* new icon t/approve (12x12).
0348468b 177* new icon t/contextmenu (12x12) for a monochrome version of i/menu.
ee362526 178
33d9f44b
PS
179=== 2.3 ===
180
181optional changes:
182* add new u/f3.png image when theme contains customised f1 and f2 default user images
183
0f704140
PS
184=== 2.2 ===
185
186required changes:
187* use new page content placeholder "echo $OUTPUT->main_content()" instead of "echo core_renderer::MAIN_CONTENT_TOKEN"
ee362526 188 see git commit: 3b3f302855d7621405a8b93e49bd399d67a998d7
2d0e682d 189* upgrade report selectors: search for "-course-report-" and replace with "-report-"