Getting_Started

Getting Started

NEW: SAVES

You can now save your work for future use. This can be slightly buggy at present (12/01/12) but should be absolutely error-free if you're simply loading up one quiz, and haven't moved any of the image files.

Interface

Revisaid aims to be as simple as possible; if you want to add, change, or delete anything, then just select Modify in the menubar. This will ask you what type of data you want to modify, and bring up the correct dialog.

Adding a Topic

Before we add any facts, we need to add a topic to be its parent. Selecting Modify>Topic should bring up the following dialog:

Let's select New, which brings up a prompt asking the topic's name. Any unique value will be accepted - duplicate topics will just be ignored.

If you want to delete a topic, just select it and click delete.

There are still a lot of topics here, and pushing the delete button could get very tedious if we have hundreds of topics loaded. Using the clear button instead will destroy all the topics in one easy click.

Adding a Fact

Learning about topics is all very nice, but we want to do more than just memorise their names. Facts can be added to topics, which allows a lot of data to be stored.

Select Modify>Fact to bring up the appropriate dialog, then click new. A prompt will ask you which topic this fact belongs in. If the topic doesn't exist, then the process will stop.

Now that you've selected the topic, you can name a unique fact.

A technical note

The Revisaid engine works by adding topics to a "manager". The manager keeps a track of all the topics, and allows the user to access any data within them. Similarly, topics manage all the facts in an indivdual topic.

This means that if you delete a topic, you will delete all the facts within that topic.

API

The engine is still going through a lot of changes at the minute, but the very basics of an API are there, in the form of the following modules, and a few others:

• engine.py
• topic.py
• fact.py
• quiz.py

These can be considered the core functionality of Revisaid, and will be the number one priority of the project. Ultimately, we'd like to have a super-small & efficient program that is highly customisable through add-ons, rather than some bloated behemoth of a program.

There isn't official support for plugins/add-ons at the minute, and unofficially it would be inadvisable due to gigantic structural changes. But if you're interested in developing additional functionality, by all means have a look at our source code. (We welcome any criticism, or unofficial features, as that's half the fun of GPL programs!)

Also please watch this space, as we will be adding official support for addons in the near future. We'll also be creating a lot of documentation, tutorials, and maybe even video lessons or one-to-one advice if you request it. We'd very much like this to become a community project, so we'll be working really hard over the next few months (written 12/01/12) to make it easy as possible for you to develop cool plugins.