Contents

Help files

Solfege is using the GtkXmHTML widget to display help, so the file format is plain html, more specific HTML 3.2.

In addition to links to other help files, you can have links to exercises, and the link can contain data that configure the exercise.

One of the main ideas of the integrated help system is that you can write texts about music theory and ear training, and have links in the text that start an exercise, configured to do whatever the author wants.

Syntax

protocol:action/exercise/lessoncollection/lessonfile?configuration

protocol
Optional, if omitted, the links if to a html file. One possible value: solfege.
action
Optional, possible values: practise, config or statistics. If omitted, you will view the same part of the exercise you used last time. If the exercise has not been used in this session, you will see the practise page.
exercise
chord, harmonic-intervall, melodic-intervall, sing-intervall, identify-scale, dictation, id-by-name, twelve-tone, sing-chord, id-tone, compare-intervalls
lessoncollection
Use the value solfege for files distributed with Solfege. Use user for your own files stored in ~/lessonfiles
lessonfile
File name.
configuration
Optional. Semicolon-separated list of assignments. Example: highest_instrumnt=80; intervalls=[1, 2, 3, 4]

Configuring exercises

If you want to configure the exercise, add data for that after a question mark.

I am implementing configuration of exercises right now, so all exercises are not finished. Some examples (please view the source to see how it is done):

Harmonic intervall: link link View config page

Melodic intervall and scales: link link

Compare intervall: link compare, set instr compare, set instr

link link override

Listing of variables

Chord

highest_instrument
middle_instrument
lowest_instrument
integer 0-127
highest_instrument_velocity
middle_instrument_velocity
lowest_instrument_velocity
integer 0-127
override_default_instrumentboolean

Harmonic intervall

highest_instrument
lowest_instrument
integer 0-127
highest_instrument_velocity
lowest_instrument_velocity
integer 0-127
override_default_instrumentboolean
intervallslist of integers, [1, 2, ... 15, 16]
highest_tone
lowest_tone
Notename like, c, fis,, or d''
new_question_automaticallyboolean
seconds_before_new_questionfloat

Melodic intervall, sing intervall

number_of_intervallsinteger
ask_for_intervalls_nn, where nn is 0 or greaterlist of integers: [-16, -15 ... 15, 16]

Identify scale

scales list of scale types: ['ionian', 'dorian', 'phrygian', 'lydian', 'mixolydian', 'aeolian', 'lokrisk', 'harmonic_minor', 'melodic_minor']

Id by name, dictation, harmonic progression dictation

Only specifying lesson file.

Id tone

c_weight
cis_weight
etc..
0..1000
one_chance_onlyboolean
warning_soundboolean
repeat_questionboolean

Copyright (C) 2000 Tom Cato Amundsen. This file may be distributed under the terms of the GNU General Public License version 2 or (at your option) any later version.