On this page...

  1. Help files
    1. 1.1 The special solfege: links

Help files

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.

The special solfege: links

It comes in two forms:

 protocol:action/lessoncollection/lessonfile?configuration

and

 protocol:action/lesson_id?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, practise will be used.
lessoncollection
Use the value solfege for files distributed with Solfege. Use user for your own files stored in $HOME/lessonfiles.
lessonfile
File name.
lesson_id
This is the identifier in the header block of lesson files.
configuration
Optional. Semicolon-separated list of assignments. You can override any variable in the lesson file header. Example:
 highest_instrument=80; intervals=[1, 2, 3, 4]