Help files

The source code for the online documentation is written in texinfo and converted to plain html.

In addition to links to other help files, you can write links that will start and configure an exercise if you click on it, like this one .

Feel free to ask any questions if you want to write some documentation for Solfege, I'll even give you a private crash course in texinfo via email if that is needed...

The special solfege: links

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, rhythm
lessoncollection
Use the value solfege for files distributed with Solfege. Use user for your own files stored in $HOME/lessonfiles. (Optional, only used with lesson file based exercises.)
lessonfile
File name. (Optional, only used with lesson file based exercises.)
configuration
Optional. Semicolon-separated list of assignments. Example:
          highest_instrumnt=80; intervalls=[1, 2, 3, 4]
          

Listing of variables

Theses two can be used with all exercises that has the New question automatically option on the config page.

new_question_automatically = true | false

seconds_Before_question = float
Chord
highest_instrument, middle_instrument, lowest_instrument
integer 0-127
highest_instrument_velocity, middle_instrument_velocity, lowest_instrument_velocity
integer 0-127
override_default_instrument
boolean
Harmonic interval
highest_instrument, lowest_instrument
integer 0-127
highest_instrument_velocity, lowest_instrument_velocity
integer 0-127
override_default_instrument
boolean
intervalls
list of integers, [1, 2, ... 15, 16]
highest_tone, lowest_tone
Notename like, c, fis,, or d''
new_question_automatically
boolean
seconds_before_new_question
float
Melodic interval, sing interval
number_of_intervalls
integer
ask_for_intervalls_nn, where nn is 0 or greater
list 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_only
boolean
warning_sound
boolean
repeat_question
boolean

solfegescript

An experimental feature was added some time ago, so the documentation will show the current key bindings even if the user customise the program:

     <script type="text/solfegescript">
       get_string("chord/new_ak")
     </script>