Tutorial Setup:
The tutorial is controlled via the tutorialScript.xml file. New steps can be added to the tutorial by adding 'page' elements to the script.
Flow Restriction
Flow restriction dictates how the user is allowed to move through a tutorial.
These are the possible flow restriction values:
- 'free' - no error checking done between pages. Free to go to any page
- 'freewithchecks' - checks will be done when user exits and enters any page. Free to go to any page.
- 'forwardexploration' - checks done each step forward first time only. Can only progress one step at a time unless step has been completed
- 'forwardsequential' - checks done each step forward. If user jumps back, checks will be done again moving forward.
- 'strictsequential' - checks are done always. User can only move to the next step or previous step.
Required File Structure:
This is an example of the required file structure for the 'Tutorial Template' tutorial:
tutorials
|TE
|menu_03_template.xml
|tutorialTemplate
|tutorialScript.xml
|actionScript
| |graph.xml
|HTML
| |page1.html
| |page2.html
| |page3.html
| |page4.html
| |page5.html
|SQL
|page2.sql
Right Panel Tabs:
HTML files can be displayed in new tabs in the right panel using the 'autoLoadLink' element. For more information see the fourth tutorial of this workshop: 4. Integrating Outside Information.
SQL:
The SQL content visible in the tab in the right panel of the tutorial is generated from .sql files contained within the folder 'SQL'. The file used is set via the 'sqlFile' element in tutorialScript.xml. For more information see the tutorial page on SQL in the Writing Tutorials Workshop: Tutorial Template.
Graphing:
The graphing functionality is generated from .xml files contained within the folder 'actionScript'. The file used is set via the 'loadActionScriptFile' element in tutorialScript.xml. For more information see the Actions tutorial in the TE workshop: Extending the TE, and Graphing tutorial page in the Writing Tutorials Workshop: Tutorial Template.