out of date content - available for reference purposes only
This guide describes how to create interactive tutorials for the Integrated Genome Browser.
Users run tutorial through the Help menu's Tutorials sub-menu. When they choose a tutorial, the tutorial will start and guide users through IGB features.
The tutorials should be contained in a single directory, with a properties file
tutorials.properties listing the available tutorials
The tutorials are text files written in json http://www.json.org
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):
tab - will allow navigation to a tab specified by its display name (e.g. "tab": ["Bookmarks"],) or multiple tabs
(e.g. "tab": [{"tab": "Bookmarks", "tab": "Selection Info"}]) |
sample tutorial[ { "text": "Welcome to the IGB Getting Started tutorial. Click Next to Begin.", "checkServer": "IGB Quickload", "script": "homescreen", "tab": [{"tab": "Data Access", "tab": "Current Sequence"}], "highlight": ["TutorialNavigator_next"] }, { "text": "Select Arabidopsis thaliana in the species box", "highlight": ["DataAccess_species"], "waitFor": "speciesSelectionChanged.Arabidopsis thaliana" }, { "text": "Select A_thaliana_Jun_2009 in the version box", "highlight": ["DataAccess_version"], "waitFor": "groupSelectionChanged.Arabidopsis thaliana.A_thaliana_Jun_2009" }, { "text": "Drag horizontal slider to the right to zoom in. Click Next to see zooming in.", "script": "setZoomStripePosition 16267374", "highlight": ["TutorialNavigator_next", "SeqMapView_xzoomer"] }, { "execute": { "name": "TweeningZoomAction", "amount": 1 } }, { "text": "Click Load Sequence in View button to load sequence bases.", "highlight": ["DataAccess_sequenceInView"], "waitFor": "LoadResidueAction" }, { "timeout": "3" }, { "text": "Drag horizontal slider to the left to zoom out. Click Next to see zooming out.", "highlight": ["TutorialNavigator_next", "SeqMapView_xzoomer"] }, { "execute": { "name": "TweeningZoomAction", "amount": -1 } }, { "text": "Try it for yourself. You can click a gene to focus zooming on that gene. Click Next when you're done.", "highlight": ["TutorialNavigator_next", "SeqMapView_xzoomer"] }, { "execute": { "name": "TweeningZoomAction", "amount": -1 } }, { "text": "Drag vertical slider down to stretch vertically. Click Next to see vertical stretch.", "highlight": ["TutorialNavigator_next", "SeqMapView_yzoomer"] }, { "execute": { "name": "VerticalStretchZoomAction", "amount": 0.2 } }, { "text": "Drag vertical slider back up to shrink everything into view. Click Next to see vertical shrink.", "highlight": ["TutorialNavigator_next", "SeqMapView_yzoomer"] }, { "execute": { "name": "VerticalStretchZoomAction", "amount": -1 } }, { "text": "Try it for yourself. You can click a gene to focus zooming on that gene. Click Next when you're done.", "highlight": ["TutorialNavigator_next", "SeqMapView_yzoomer"] }, { "execute": { "name": "VerticalStretchZoomAction", "amount": -1 } }, { "text": "Congratulations, you have completed the Getting Started tutorial. Click Next to finish.", "highlight": ["TutorialNavigator_next"] } ] |