Skip to content

Add JSON formatter alternative to tutorial guide #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
coderaviverma wants to merge 1 commit into from
Closed

Add JSON formatter alternative to tutorial guide #58

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion source/OSBv1/Creating_Tutorials.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ If you wish to include a step-by-step tutorial component, ensure that you have t
The main component of tutorials are plain html files, one per step, and a json file to tie them together, see [here](https://github.com/mattearnshaw/tutorials/tree/master/1_hh_practical) for an example.
To create interactive aspects, the `quickExperiment` javascript function can be used to add experiments with parameters set by the tutee, see [here](https://github.com/mattearnshaw/tutorials/blob/master/1_hh_practical/2.html) for an example. The json file should specify a `name` (tutorial title), default `height` and `width` of the tutorial widget, and a list of paths of the html files for each step, see [here](https://github.com/mattearnshaw/tutorials/blob/master/1_hh_practical/hh_practical.json) for an example.

Finally we need to add our tutorials to the tutorial widget by editing the json file downloaded in the step above (Configuring the default session). It may help to run this file through [a formatter](https://jsonformatter.org/json-pretty-print) before editing. To the data field of the tutorial widget, add URLs pointing to the json file(s) that you created above (see [here](https://github.com/mattearnshaw/tutorials/blob/master/models/hodgkinHuxley/GEPPETTO.json) for an example). You may also wish to change the `activeTutorial` field under `componentSpecific` to the title of tutorial you wish to be initially displayed. Tutees may switch between tutorials using the book icon at the top-left corner of tutorial widget.
Finally we need to add our tutorials to the tutorial widget by editing the json file downloaded in the step above (Configuring the default session). It may help to run this file through [a formatter](https://jsonformatter.org/json-pretty-print), such as [JSONViewerTool's JSON Formatter](https://jsonviewertool.com/json-formatter), before editing. To the data field of the tutorial widget, add URLs pointing to the json file(s) that you created above (see [here](https://github.com/mattearnshaw/tutorials/blob/master/models/hodgkinHuxley/GEPPETTO.json) for an example). You may also wish to change the `activeTutorial` field under `componentSpecific` to the title of tutorial you wish to be initially displayed. Tutees may switch between tutorials using the book icon at the top-left corner of tutorial widget.

## Existing tutorials

Expand Down