Flash Card File Format

You can create your own flash card sets directly on your computer using any text editor (such as notepad). The file format is fairly straight forward, and if you follow these guidelines you should have no trouble. As an alternative, you can use the EasyFC Generator I put together for the purpose.

The Nuts and Bolts

The file format expected is UTF-8 encoded XML. Ok, don't worry, that isn't as scary as it sounds. It simply means:

1. If you are going to be using international characters (i.e. accented letters in foreign languages), the file needs to be formated to allow for that. In that case I would recommend using the generator provided here as it handles the encoding for you.

2. The file needs to be valid XML - this is simply a strict formatting so that the app will know what you want to be entered as a question, answer, etc. You can find some info on XML

OK, with that out of the way, what does the file need to look like?

The FIRST line MUST contain:

  <?xml version="1.0" encoding="utf-8"?>

This tells us that the file will be valid xml 1.0 that is utf-8 encoded.

Now, the rest of the file is as follows:

  <qset> ..... </qset>: This opens and closes the Flash Card Set: Everything in between will be considered part of the set

  <name> ..... </name>: This is the name of the set

  <description> .... </description>: This is the set Description

  <qtext> .... </qtext>: This is the question text

  <atext> .... </atext>: This is the answer text

The last two are repeated as many times as you want, each representing another question.
So, the entire file is merely a progression of tags (each item enclosed in < > is a "tag"), with the text to be saved into the app simply put in between.

NOTE for MAC users: The default "text" editor does NOT save files in plain text - it adds its own formating before saving (throwing in extra tags...). Thus, it WILL NOT work. I am sure there are plain text editors out there for the MAC, but I don't know what they are.

So, a completed file, ready to be imported into the app, would look something like:

  <?xml version="1.0" encoding="utf-8"?>
   <name>Test Question Set</name>
    <description>A test question set to demonstrate the file format</description>
      <qtext>What is this?</qtext>
      <atext>A Test Question Set</atext>
      <qtext>Are You Sure?</qtext>

That's all there is! Admittedly, it may seem a bit intense. That is why I put together the generator - It handles all this formatting stuff for you: you just type in your questions and then import them!