From 7700ed3339683fbe2e4d66e8791d7b9def0f451c Mon Sep 17 00:00:00 2001 From: Coder Avi Verma Date: Thu, 29 Oct 2026 12:08:09 +0530 Subject: [PATCH] Add JSON formatter alternative to tutorial guide --- source/OSBv1/Creating_Tutorials.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/OSBv1/Creating_Tutorials.md b/source/OSBv1/Creating_Tutorials.md index 1b64eff..3ea8301 100644 --- a/source/OSBv1/Creating_Tutorials.md +++ b/source/OSBv1/Creating_Tutorials.md @@ -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