Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0

...

  • 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
  • waitFor - the name of an action or menu item that the user is supposed to do. The tutorial will stay on this step until the user performs the action or clicks 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
  • subTutorial - an inner tutorial that can be "triggered" by an action to start
  • trigger - an action that is a "trigger" to start a sub tutorial
  • script - will allow commands in the existing IGB scripting format. (e.g. "script": "goto chr4:18,040,000 - 18,045,056"  )
  • Wiki Markup*tab* \ - will allow navigation to a tab specified by its display name (e.g. "tab": \ ["Bookmarks"\],) or multiple tabs
    Code Block
      (e.g. "tab": [{"tab": "Bookmarks", "tab": "Selection Info"}])
    
  • checkServer - this will verify a specific server is enabled and offer the user the opportunity to enable or cancel the tutorial if it is not.   (e.g. "checkServer": "IGB Quickload")

...