mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-03-14 04:30:15 +01:00
Code Issues Projects Releases Wiki Activity

Merge branch 'w46_MDL-30403_m22_upgradedocs' of git://github.com/skodak/moodle

Browse Source
This commit is contained in:
Sam Hemelryk 2011-11-23 10:57:38 +13:00
commit 15415bf8e8
2 changed files with 40 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
admin/tool/upgrade.txt Normal file
View File

@ -0,0 +1,21 @@
This files describes API changes in /admin/tool/* - plugins,
information provided here is intended especially for developers.
=== 2.2 ===
API changes:
* new admin tool plugin type introduced
How to migrate existing admin reports:
# move all files to new /admin/tool/yourplugin/ location
# update all links to admin tools /$CFG->admin/report/ to /$CFG->admin/tool/
# add language pack with at least 'pluginname' string
# update all language strings (use 'tool_yourplugin' instead of 'report_yourplugin') - use AMOS hints in commit message
# update all capability names
# create db/install.php migration script - delete old settings and capabilities (see converted plugins for examples)
# grep the plugin codebase and look for any remaining 'coursereport' occurrences
# update CSS selectors
See http://docs.moodle.org/dev/Admin_tools for more details and explanation.

22
report/upgrade.txt
View File

@ -9,11 +9,27 @@ API changes:
* new support for report settings
How to migrate old admin reports:
# copy all files to new /report/yourplugin/ location
How to migrate existing admin reports:
# move all files to new /report/yourplugin/ location
# if settings.php exists add $settings=null;
# if settings.php does not exist create it and link the report, index.php is not linked automatically any more
# update require('../../config.php'); - remove one ../
# update all others includes and requires
# update all links to report pages by removing /admin/ or /$CFG->admin/
# add language pack with at least pluginname string
# add language pack with at least 'pluginname' string
# update CSS selectors
How to migrate existing course reports (optional):
# move all files to new /report/yourplugin/ location
# update require('../../config.php'); - remove one ../
# update all others includes and requires
# update all links to report pages by removing /course/ part
# update all language strings (use 'report_yourplugin' instead of 'coursereport_yourplugin') - use AMOS hints in commit message
# update all capability names
# grep the plugin codebase and look for any remaining 'coursereport' occurrences
# add new navigation hooks in lib.php - ex: report_stats_extend_navigation_course(), report_stats_extend_navigation_user()
# add new page types in lib.php
# create db/install.php migration script - delete old settings and capabilities (see converted plugins for examples)
# update CSS selectors
See http://docs.moodle.org/dev/General_report_plugins for more details and explanation.