Mnemogogo development

This page contains some brief notes on the development of the Mnemogogo plugin and each of the two mobile clients. Please email me if you would like more information.

Mnemogogo

The Mnemogogo source repository can be checked-out using Bazaar:

bzr branch lp:mnemogogo

Additionally, there is a (rough) Makefile for building the zipped distribution.

The Mnemogogo code has two parts:

• A plugin for Mnemosyne 1.2.2 written in Python.
• A Java library for accessing the files exported by the plugin.

Mnemogogo: plugin

The plugin comprises the mnemogogo_plugin.py file to interface with Mnemosyne, and the library routines and other files in the mnemogogo subdirectory. The main library files are:

core.py

The basic infrastructure and generic routines for import/export plugins.

gogo_frm.ui, gogo_dlg.py

The pyqt 3.x user interface and the routines it triggers.

lock_enabling.py, locked.png

Tricks for 'locking' QT Widgets (viz. the Mnemosyne question and answer boxes).

html_lib.py

Replace HTML character references and entities with unicode characters.

Mnemogogo has its own notion of an import/export plugin, though there is only really one: interface/hex_csv.py. These routines convert between data within Mnemosyne and the collection of files that the mobile clients read and update.

The util directory contains utility scripts for testing and debugging Mnemogogo. The dump_database.py script is especially useful for validating the plugin's operation. It dumps a Mnemosyne database to stdout.

Mnemogogo: library

The library routines are kept in the mobile/hexcsv subdirectory. The library is used by both the J2ME and Android clients; where the code differs between the two platforms there is usually a specific class file for each (with a name ending in either J2ME or Android), but some more minor modifications required for the Android platform (Java 1.6) are marked by comments beginning with the string Android:. The Makefile described above contains scripts for building separate J2ME and Android source and jar files.

Mnemojojo

Three components are required to build Mnemojojo:

1. The Mnemojojo source.
2. A patched version of Pashalis Padeleris' Fire UI library (now included in contrib subdirectory).
3. The J2ME version of the Mnemogogo library (mnemogogo-j2me-x.y.z.jar) distributed with the Mnemogogo plugin package.

Follow these instructions to setup a build tree:

1. Check out the Mnemojojo source repository with:

   bzr branch lp:mnemojojo
   

2. Open the Mnemojojo Makefile and adjust the MNEMOGOGO variable to point at the the jar file distributed with the Mnemogogo plugin.
3. Type make to build the source. Two files should be added to the bin/ subdirectory: mnemojojo.jad and mnemojojo.jar. These are ready to install on a mobile device.
4. Alternatively, the Makefile also contains emulator and microemulator targets to run Mnemojojo on, respectively, the Sun JWTK Emulator and the Open-source Microemulator. In both cases you will need to arrange for the files exported by Mnemogogo to be present on an emulated SD card.

Mnemododo

The Mnemododo source repository can be checked-out with:

bzr branch lp:mnemododo

It requires the Mnemogogo client library.