Word definitionsThis page does not desribe the current implementation. It was a draft used for discussion. Parts of it has been implemented. This will become a long and detailed document. Let us define some of the terms used, so that we don't get confused. (Please correct the definitions if they are wrong.) And more important, lets make sure the terms consistently in the user documentation. This list is sorted with the most elementary items last. Topic indexWhen the program starts, Solfege shows all available topics in a list: the topics index. The user can select a topic. The topics index is generated automagically. (It has to be, because maintaining it manually would be a nightmare). Topic directoryAll lesson files (and also theory files specific to the topic) that define a level for a topic are stored together in a directory: a topic directory. There is one leveldirectory for each topic. This is a subdirectory of lesson-files. TopicA topic is a collection of exercises, usually ordered from easy to difficult exercises. For example 'Minor or major' or 'Learning intervals'. LevelThe exercises in a topic are ordered from easy to difficult, each step in this order is called a level. One level can consist of:
LessonfileA lessonfile is a textfile that contains configuration for an exercise module, and questions. For example: the 'scales' lessonfile configures the ID-by-name exercise module so that plays scales, and shows a button for each type of scale. Exercise moduleThe python modules that either implement a single exercise, or interprets lesson files and thus can serve many different exercises. Examples: Identify tone, Melodic intervales, Compare intervals, ID-by-name. << What it should look like | NewExerciseSetup | How it can be done >> |