The online documentation is written in the markup used by PmWiki.
The documentation is written to be viewed from inside Solfege but it can of course be viewed in a web browser.
What make the generated html-files different from regular html is that 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.
solfege:
linksprotocol:action/exercise/lessoncollection/lessonfile?configuration
protocol
solfege
.
action
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-interval, melodic-interval, sing-interval, identify-scale, dictation, id-by-name, twelve-tone, sing-chord, id-tone, compare-intervals, rhythm
lessoncollection
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
configuration
highest_instrument=80; intervals=[1, 2, 3, 4]
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
highest_instrument
middle_instrument
lowest_instrument
highest_instrument_velocity
middle_instrument_velocity
lowest_instrument_velocity
highest_instrument
lowest_instrument
highest_instrument_velocity
lowest_instrument_velocity
override_default_instrument
intervals
highest_tone
lowest_tone
c
, fis,
or d''
new_question_automatically
seconds_before_new_question
disable_unused_intervals
boolean
.
number_of_intervals
ask_for_intervals_nn
FIXME
scales
Only specifying lesson file.
c_weight
one_chance_only
warning_sound
repeat_question