Skip to content
CLIxIndia edited this page Mar 16, 2018 · 6 revisions

Open Story Tool Documentation

Embedding Open Story Tool

Open Story can be embedded into an activity. When you do this, you can specify two things that are unique to that activity:

  • a starting slideshow file that is preloaded
  • a specified gallery of images

Where do I get the starting slideshow file? This part is very easy. Just open any version of Open Story, create the slideshow that you want students to see when they start the activity, and save it. Then put that file in the correct activity folder in unplatform. It can be any type of slideshow file, .cssw, .csst, or .cssv.

OST files have the following types: * CSSW (Working file, everything can be edited) * CSST (Template file, only certain things can be edited) * CSSV (Video file, the slideshow can only be played and not edited)

How do I make a gallery? All images that Open Story can access are stored in the OpenStoryTool/images folder.

Images in the top level of that folder populate the default gallery. That means that if you don’t specify any gallery within an activity’s html, the images in the default gallery will be available to the student in the gallery. So you might have a general set of images that students can access in that case, or you might keep it empty.

To define a gallery, create a subfolder in the OpenStoryTool/images folder. For example,you might create a folder called “birds”. The name of that folder is now the name of the gallery, which you must specify in the activity’s html. Put the images for this activity into the subfolder you created. These are the images that will populate this gallery. Make as many subfolders as you want, one for each Open Story activity. Students will only be able to access one gallery per activity.

How to embed the Open Story tool To embed the Open Story tool into an activity, create a blank activity page and embed the following code. This will launch the Open Story tool with a blank slideshow and access to the default gallery.

<iframe src="/modules/OpenStoryTool/index.html" style="width:860px; height:600px" frameBorder="0"></iframe>

To specify a starting slideshow and/or a specific gallery, you need to provide the information to the Open Story tool’s code.

<iframe src="/modules/OpenStoryTool/index.html?gallery=birds&file=birds.csst" style="width:860px; height:600px" frameBorder="0"></iframe>

From this example, replace birds.csst with the name of the starting slideshow you want to use. That starting file must be in the same folder as the index.html file. If you don’t include the file parameter, Open Story will start with a blank slideshow by default.

From this example, replace birds (the name of the gallery) with the name of the gallery you want to be available to the students. This must be a gallery that exists in the OpenStoryTool/images folder. If you don’t include the gallery parameter, Open Story will use the default gallery.

Clone this wiki locally