Note:

If you want to create a new page for developers, you should create it on the Moodle Developer Resource site.

Google Gears integration: Difference between revisions

From MoodleDocs
Line 16: Line 16:
=== To-do list ===
=== To-do list ===


* Define the architecture for the web application: isolate de data layers (local and server), and the incorporation of a data switch and synchronization engine.
* Start a working flexible base/architecture for Google Gears in Moodle. Define the architecture for the web application: isolate de data layers (local and server), and the incorporation of a data switch and synchronization engine. Begin with the homepage and course page to make sure that we can handle logs and then continue with mod/resource:
* Start a working flexible base/architecture for Google Gears in Moodle:
** Store the HTML, CSS and Javascript in the SQLite DB provided by Gears. Use the Database class to store the data.
** Store the HTML, CSS and Javascript in the SQLite DB provided by Gears. Use the Database class to store the data.
** Code and edit a dynamic manifest to include the resource available offline
** Code and edit a dynamic manifest to include the resource available offline
** Make use of the LocalServer class to store an initial sample of the Moodle application on the local server. Make sure the application starts offline.
** Make use of the LocalServer class to store an initial sample of the Moodle application on the local server. Make sure the application starts offline.
** Add the WorkerPool class to run the Javascript code in Moodle
** Add the WorkerPool class to run the Javascript code in Moodle
* Submit initial code for evaluation. A course admin should be able to edit notes offline at this point. For example:
* Submit initial code for evaluation. A course admin should be able to access resources at this point. For example:
** Download all the interface for offline visualization
** Download all the interface for offline visualization
** Make changes offline in a course’s notepad
** Make changes offline in a course’s notepad
Line 28: Line 27:
** Synchronize when back online and upload notes
** Synchronize when back online and upload notes
* Based on feedback: debug, clean code, perform more extensive tests on this base architecture.
* Based on feedback: debug, clean code, perform more extensive tests on this base architecture.
* Add a versatile functionality of other basic kinds of Moodle resources.
* Add a more versatile functionality for other basic kinds of modules: lesson and assignment (suggested).
* Test the functionality above with a limited sample of activities: lesson, uploading files, and glossaries. Debug where necessary.
* Test the functionality above with a limited sample of activities, for example, uploading files and glossaries.  
* Revise security holes and permissions.
* Revise security holes and permissions.
* Clean code, perform final tests, and finish documentation.
* Clean code, perform final tests, and finish documentation.

Revision as of 15:59, 12 May 2009

Project specification, Google Summer of Code 2009 - Alberto Jurado-Varela, Princeton University


Summary: This project is based on the idea of integrating Google Gears to Moodle. An offline mode will allow people with limited Internet connection to browse activities and other resources, take notes and store them locally, save assignments even if the user is not connected and then upload/synchronize when the user is online. Moreover, the plan is to create a working base/architecture and then make it easier to add any kind of activity to the Gears module.


Motivation

Integrating Google Gears to Moodle would allow to browse the homepage and the course site while offline, and speed up the loading process while online: it stores files on the end user's computer therefore enhancing local access. It also let webs applications interact naturally with the user's desktop by storing data locally (in a database) and improving performance by running JavaScript in the background. And last but not least, it is open source.

I find this project particularly useful for communities with a slow bandwidth or where students can get online only a few times a week, download a lesson, and upload what they have worked on while offline. Other potential users would be people who travel and do not want to pay for getting online at an airport, but still continue following a course. The ability to keep learning from useful resources, even if we are not connected to the Internet, was one of my major motivations for this project. This, together with the speeding up advantage, will help Moodle's performance and usability.

Implementation details

To-do list

  • Start a working flexible base/architecture for Google Gears in Moodle. Define the architecture for the web application: isolate de data layers (local and server), and the incorporation of a data switch and synchronization engine. Begin with the homepage and course page to make sure that we can handle logs and then continue with mod/resource:
    • Store the HTML, CSS and Javascript in the SQLite DB provided by Gears. Use the Database class to store the data.
    • Code and edit a dynamic manifest to include the resource available offline
    • Make use of the LocalServer class to store an initial sample of the Moodle application on the local server. Make sure the application starts offline.
    • Add the WorkerPool class to run the Javascript code in Moodle
  • Submit initial code for evaluation. A course admin should be able to access resources at this point. For example:
    • Download all the interface for offline visualization
    • Make changes offline in a course’s notepad
    • Save changes
    • Synchronize when back online and upload notes
  • Based on feedback: debug, clean code, perform more extensive tests on this base architecture.
  • Add a more versatile functionality for other basic kinds of modules: lesson and assignment (suggested).
  • Test the functionality above with a limited sample of activities, for example, uploading files and glossaries.
  • Revise security holes and permissions.
  • Clean code, perform final tests, and finish documentation.

Future Work

  • Try the functionality to work with all kinds of activities and a full offline Moodle.

See also

For more information, please visit the following links: