Offline Support for Wikitolearn WikiEditor

Description of the project[edit | edit source]

My main focus in the project is to add offline support to the current Wiki Editor used by WikiToLearn. I will be making a MediaWiki extension that will help the users to have an offline editing experience.

Expected results: A MediaWiki extension capable of providing offline support to WikiEditor.

Mentors: Gianluca Rigoletti, Irene Cortinovis (@rigolo and @pipsin on telegram)

Features[edit | edit source]

This extension notifies the user, his/her's internet connectivity status and if submitted while offline, will parse Wikitext to HTML and then renders it.

Installation[edit | edit source]

  • Download and place the file(s) in a directory called OfflineExtension in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php file:

require_once "$IP/extensions/OfflineExtension/OfflineExtension.php";

  • Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

WikiText tags supported[edit | edit source]

Wikitext is written in a lightweight markup language with specific syntax rules. The tags supported by the Offline Extension can be found here.

Known Issues[edit | edit source]

  • Parsing WikiTables to HTML hasn't been added to the parser yet. It is under development.

Weekly Log[edit | edit source]

  • Week 1
    • Setted up blog, Got a developer account on KDE, Installed WTL locally, Working on Visual-Editor branch and Interacted with Mediawiki developers.
  • Week 2
    • Made a prototype of the offline extension. Made changes to offline Javascript to check the connectivity of the user.
  • Week 3
    • The offline extension with the JS script has been set up. The script has the ability to check the connectivity of the user and wrap the ajax request and send them when the connection is re-estabilished.
  • Week 4
    • Wrote a JS script and linked it to WikiEditor, which alerts the user about its connectivity.

Days when unavailable[edit | edit source]

  • 10th May to 23rd May
    • End semester Examinations!

Blog posts[edit | edit source]

  • You can find my blog posts about GSoC and WikiToLearn here

Extension git repository[edit | edit source]