theme/upgrade.txt

   1 This files describes API changes in /theme/* themes,
   2 information provided here is intended especially for theme designer.
   3
   4 === 2.5.3 ===
   5
   6 Notes:
   7 * For themes based on bootstrapbase please also read theme/bootstrapbase/upgrade.txt
   8
   9 === 2.5.1 ===
  10
  11 Notes:
  12 * Block drag and drop functionality has been improved so that it works regardless of what block regions you use
  13   or how many block regions you have. In order to benefit from this improvement you must convert your calls from
  14   $OUTPUT->blocks_for_region() to $OUTPUT->blocks.
  15
  16 Optional changes:
  17 * Theme config can nominate block regions to swap if the user is using a rtl languages such as Hebrew.
  18   $THEME->blockrtlmanipulations should be an associative array, the key is the original block region, and the
  19   value should be where the blocks in that region should be displayed.
  20 * New $OUTPUT methods to replace code that was previously using $PAGE. Converting to these methods is optional
  21   but highly recommended. Refer to the bootstrapbase layouts for examples.
  22   - $OUTPUT->body_attributes() returns a string you can use for the body id and classes.
  23   - $OUTPUT->blocks() returns HTML to display a block region and all of its blocks. This adds data attributes
  24     that ensure drag and drop of blocks will work no matter what block regions or how many you have.
  25   - $OUTPUT->page_heading() returns the page heading. Replaces $PAGE->heading.
  26   - $OUTPUT->page_heading_button() returns the button to display with the heading. Replaces $page->button.
  27   - $OUTPUT->page_doc_link() returns the link to moodle docs for the page. Replaces page_doc_link().
  28   - $OUTPUT->page_heading_menu() returns the heading menu for the page. Replaces $PAGE->headingmenu.
  29   - $OUTPUT->page_title() Returns the title to use for the head section.
  30   - $OUTPUT->favicon() returns the URL to the favicon.
  31
  32 Renderer changes:
  33 * core_renderer::navbar now returns an empty string if there are no navigation items to display.
  34 * core_renderer::custom_menu now adds a class "custom_menu" to the div that contains the HTML for the custom menu.
  35
  36 === 2.5 ===
  37
  38 required changes:
  39 * Functions core_course_renderer::course_category_tree() and course_category_tree_category()
  40   are deprecated
  41 * Significant changes in rendering of courses and categories listings, lots of CSS classes changed,
  42   several functions such as print_courses(), print_whole_category_list(), print_category_info()
  43   are moved to course renderer.
  44   See http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
  45
  46 DOM changes:
  47 * changed the h1 title in the help popup to a h2.
  48 * new setting $THEME->yuicssmodules = array('cssreset', 'cssfonts', 'cssgrids', 'cssbase'); which
  49   allows themes to use different CSS reset normalisers such as cssnormalize YUI module.
  50 * Re-wrote the user profile views to definition lists.
  51 * Re-wrote the table for the course completion status block to use html_table - added some CSS classes to
  52   the table in the process (see MDL-35608).
  53 * Cancel buttons have the class btn-cancel.
  54 * Added a z-index for the div#dateselector-calendar-panel so that the calendar pop-up renders above
  55   the filemanager when they overlap, ie. the course settings page (see MDL-39047).
  56 * Trivial change of CSS selectors used to display plugin status at the plugins overview
  57   screen (#plugins-control-panel).
  58
  59 Renderer changes:
  60 * Mymobile theme changed to support more verbose move-block-here descriptions.
  61
  62 === 2.4 ===
  63
  64 required changes:
  65 * output course and course content header/footer that may be returned by course format (see MDL-36048)
  66 * span.completionprogress has been changed to a <div> and is not a float by default any more.
  67
  68 deprecation:
  69 * i/roles: Use t/assignroles instead
  70 * t/manual_item: Use i/manual_item instead
  71 * t/unlock_gray: Use t/locked instead
  72 * t/userblue: Previously used to unblock a user, use t/unblock.
  73 * c/course: Use i/courseevent instead
  74 * c/group: Use i/groupevent instead
  75 * c/site: Use i/siteevent instead
  76 * c/user: Use i/userevent instead
  77 * t/clear: Use t/check instead
  78 * i/cross_red_big: Use i/invalid or i/grade_incorrect
  79 * i/tick_green_big: Use i/valid or i/grade_correct
  80 * i/tick_amber_big: Use i/caution or i/grade_partiallycorrect
  81 * No more small versions of i/cross_red_small, i/tick_green_small and i/tick_amber_small, use their big equivalent.
  82 * t/addgreen: Use t/add instead.
  83 * i/approve: Use t/approve instead
  84
  85 optional changes:
  86 * new optional boolean parameter $withlinks for public function login_info() in lib/outputrenderers.php (MDL-31365)
  87 * new layout option "nologinlinks" and new page layout "secure" e.g. for safebrowser and securewindow (MDL-31365)
  88 * new class 'iconlarge' for 24x24 icons.
  89 * new icons i/export and i/import (sized 16x16). Previously export and import actions used i/backup and i/restore.
  90 * new icon i/assignroles (sized 16x16), to prevent the use of i/roles which is 12x12.
  91 * new icon i/switchrole (sized 16x16), was previously using i/roles. Now is a copy of the new i/assignroles icon.
  92 * new icons i/enrolusers and t/enrolusers, previsouly i/users was used.
  93 * new icon t/cohorts (sized 12x12), to prevent the use of i/cohorts which is 16x16.
  94 * new icons t/sort_asc, t/sort_desc to use for ordering in table headers.
  95 * new class 'iconsort' for icons used for ordering in table headers.
  96 * new icons t/locked and t/unlocked (12x12) which should be used when there is no action associated to the icon.
  97 * new icons i/folder (16x16), monochrome equivalent to f/folder.
  98 * new icons t/addcontact, t/removecontact and t/messages, previously t/addgreen, t/delete and t/log were used in messaging.
  99 * new icons t/unblock and i/twoway.
 100 * new icons i/courseevent, i/groupevent, i/siteevent and i/userevent (16x16) instead of c/* for calendar events.
 101 * new icon t/markasread (12x12) to replace t/clear used in forums.
 102 * new icon t/check (12x12) to replace t/clear which name does not reflect the icon meaning.
 103 * 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.
 104 * new icons i/valid, i/caution and i/invalid for generic statuses.
 105 * new icons i/grade_correct, i/grade_partiallycorrect and i/grade_incorrect for grades.
 106 * new icon t/approve (12x12).
 107 * new icon t/contextmenu (12x12) for a monochrome version of i/menu.
 108
 109 === 2.3 ===
 110
 111 optional changes:
 112 * add new u/f3.png image when theme contains customised f1 and f2 default user images
 113
 114 === 2.2 ===
 115
 116 required changes:
 117 * use new page content placeholder "echo $OUTPUT->main_content()" instead of "echo core_renderer::MAIN_CONTENT_TOKEN"
 118   see git commit: 3b3f302855d7621405a8b93e49bd399d67a998d7
 119 * upgrade report selectors: search for "-course-report-" and replace with "-report-"