Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The tutorial consists of an array of steps that the user will take.
each step can contain the following fields (only the text field is required):

  • text - the text to display in the tutorial status bar
  • highlight - the widget to highlight during the step, use thewidget id
  • timeout - the amount of time in seconds that this step is displayed before
    it continues onto the next step
  • waitAction - the name of an action that the user is supposed to do. The tutorial
    will stay on this step until the user performs the action.
  • waitMenu - the name of a menu item (action) that the user is supposed to select. The tutorial
    will stay on this step until the user performs selects the menu item.
  • execute - an action that the tutorial will perform; this is an object containing the
    following fields (only name is required):
    name - the name of the action to perform
    amount - a numeric value to pass to the action