Making Cytoscape Tutorials
If you are interested in preparing training materials for Cytoscape Apps, you have come to the right place! This tutorial will guide you through how to prepare a tutorial for a Cytoscape App using the Reveal presentation system customized for Cytoscape-related content.
Let us know if you have an questions or suggestions.
Setup
- Create a GitHub account if you don't already have one
- Fork the Cytoscape-tutorials repo
- Consider installing an html editor, for example Brackets, an open source code editor.
Template Tutorials
The reveal framework includes a large set of features and components. This template reviews a core set of components that are useful for Cytoscape tutorials.
- Explore the template content
- Explore the code behind the template
Creating a Tutorial
- If you don't have it open already, open protocols/template-app/index.html in your favorite html editor.
- Create a copy of it in a new directory under protocols/ named after your app or workflow, e.g., protocols/my-new-app/index.html.
- Open your new copy and start building your protocol replacing the template content as you go. There are two sections of the documentation that are particularly relevant here:
Creating a Tutorial
- When your tutorial is ready, make a pull request to the cytoscape-tutorial repo to add your app tutorial to the growing collection shared with all Cytoscape users.
- Share your completed protocol on the Cytoscape App Dev List.