Changing Tutorial Settings

This page describes how to change various settings with minimal-to-no programming effort.

Configuration is done via a JSON file settings.json. There is a global file in lessons (lessons/settings.json) and there may be optional settings.json configuration files in each of the lesson folders. These individual lessons configuration files better let you tailor lessons individually. For instance, lessons 1-5 and 7 have a configuration file, while all other lessons rely on the global configuration.

The configuration is fundamentally a JSON dictionary. The known keys are:

• lesson_order, which is global only;
• tooltips, either global or per lesson;
• hide, either global or per lesson.

The lesson_order key is described in Create Lessons#Naming and Storing Lessons.

The tooltips attribute indicates lists of selectors that are to be given tooltips. Fundamentally, it is a dictionary that expects the following keys:

• list: a dictionary whose keys are selectors and whose values are a selector's tooltip value;
• attr: an HTML attribute, typically title, to apply the tooltip value to.

The hide attribute indicates lists of selectors that are to be hidden from the user. Fundamentally, it is a dictionary that expects the following keys:

• list: a dictionary whose keys are selectors and whose values are the empty string;
• reverse: a boolean indicating whether or not the list selectors can be shown again.