Grid Format

Course formats ::: format_grid
Maintained by Gareth J BarnardGareth J Barnard
A modular and visual course format. Hides all topics and creates a grid of icons (one for each topic) with short titles. Clicking on an icon brings up the content from the corresponding topic.

Grid Format 2.3.2.3

Moodle 2.3
Released: Thursday, 11 April 2013, 8:47 PM
GRID COURSE FORMAT
============================
Package tested in: Moodle version 2012062504.01 release 2.3.4+ (Build: 20130118)

Requires Moodle version 2012062504.01 release 2.3.4+ (Build: 20130118) because of MDL-36095.

BETA DEVELOPMENT VERSION - NOT FOR PRODUCTION SITES - Please place comments / feedback on:
http://tracker.moodle.org/browse/CONTRIB-3769 - preferred.
or
http://moodle.org/mod/forum/discuss.php?d=207059

QUICK INSTALL
==============
Download zip package, extract the grid folder and upload this folder into course/format/.

NOTE: If you have previously installed a development version and get the latest code you MUST:
Remove the row with the 'plugin' of 'format_grid' in the 'config_plugins' table and drop the 'format_grid_icon'
and 'format_grid_summary' tables in the database before clicking on 'notifications'.

If upgrade fails, please perform the actions as detailed in the note above.

ABOUT
=============
Developed by:
Information in:

FILES
--------------

* grid/format.php

Code that actually displays the course view page.

* grid/config.php

Configuration file, mainly controlling default blocks for the format.

* grid/lang/en/format_grid.php
* grid/lang/ru/format_grid.php
* grid/lang/es/format_grid.php
* grid/lang/fr/format_grid.php

Language file containing language strings for grid format.

Note that existing formats store their language strings in the main
moodle.php, which you can also do, but this separate file is recommended
for contributed formats.

Of course you can have other folders as well as just English and Russian
if you want to provide multiple languages.

* grid/db/install.xml

Database table definitions.

* grid/db/upgrade.php

Database upgrade script.

* grid/version.php

Required for using database tables. The file provides information
about plugin version (update when tables change) and required Moodle version.

* grid/styles.css

The file include in the CSS Moodle generates.

* grid/backup/moodle2/backup_format_grid_plugin.class.php
grid/backup/moodle2/restore_format_grid_plugin.class.php

Backup and restore run automatically when backing up the course.
You can't back up the course format data independently.

ROADMAP
=============

1. Working Moodle 2.4 version.
2. Improved instructions.
3. User definable grid row icon numbers - https://moodle.org/mod/forum/discuss.php?d=196716

HISTORY
=============

13th July 2012 - Version 2.3
Change by G J Barnard
1. First release for Moodle 2.3

22nd August 2012 - Version 2.3.1
Change by G J Barnard
1. Added missing 'current section' string.

19th December 2012 - Version 2.3.2
Change by G J Barnard
1. Fixed ability to use png files because of attempting to use jpeg quality setting.
2. Increased quality setting for better icons.

21st December 2012 - Version 2.3.2.1
Change by G J Barnard
1. Fixed BOM (http://docs.moodle.org/23/en/UTF-8_and_BOM) issue in 'lib.php' and 'lang/ru/format_grid.php' which can cause the icons not to display.

12th January 2013 - Version 2.3.2.2
Change by G J Barnard
1. Fixed inadvertent application of 2.4 code.
2. Fixed issue in editimage.php where the GD library needs to be used for image conversion for transparent PNG's.
3. Perform a 'Purge all caches' under 'Home -> Site administration -> Development -> Purge all caches' after this is installed.

21st January 2013 - Version 2.3.2.3 - Beta version, not for production servers.
Change by G J Barnard
1. Changes to 'renderer.php' because of MDL-36095 hence requiring Moodle version 2012062504.01 release 2.3.4+ (Build: 20130118) and above.

Authors
-------
J Ridden - Moodle profile: https://moodle.org/user/profile.php?id=39680 - Web: http://www.moodleman.net
G J Barnard - Moodle profile: moodle.org/user/profile.php?id=442195 - Web profile: about.me/gjbarnard

Version information

Version build number
2012082200
Version release name
2.3.2.3
Can be updated to
2.3.3 (2012082201)
Maturity
Beta
MD5 Sum
9d8c518c41ced70f09a8a3764a405381
Supported software
Moodle 2.3

Version control information

Version control system (VCS)
GIT
VCS repository URL
VCS branch
MOODLE_23_STABLE
VCS tag
V2.3.2.3

Default installation instructions for plugins of the type Course formats

  1. Make sure you have all the required versions.
  2. Download and unpack the module.
  3. Place the folder (eg "myformat") in the "course/format" subdirectory.
  4. Visit http://yoursite.com/admin to finish the installation