V1 Plugins in Ekstep

Owned by Akshaya Rathinavel
Jan 02, 2019

This document contains details about the older v1 plugins available in ekstep. It provides information about how to

  • Create and upload plugins.
  • Use the plugins in ekstep portal.


Repo for Contributed plugins

https://github.com/ekstep/Contributed-Plugins/tree/release-1.0

https://github.com/ekstep/Contributed-Plugins/tree/memory-game-fix


List of Contributed plugins available in QA and Production

1. Summarizer
2. Simple Timer
3. Record And Play
4. Keyboard Plugin
5. WordPicker
6. Wordmaker Plugin
7. Eraser Plugin
8. Extract Word Plugin
9. Text Popup
10. Progress Bar
11. Wordcard Plugin
12. Memory Game
13. Language MTF


Progress bar plugin

Progress bar plugin is designed to indicate the correct and wrong answer and to give information about the number of questions attempted while playing quiz in mobile (or) web preview.

The editor and renderer work flow is as follows

Editor

  • Add a question set to the stage
  • Click on "Add Activity" → and select "progress bar" plugin and then click "Add"
  • Click on the progress bar icon on the top of the content-editor
  • An image will be added to the stage specifing the progress bar added to the stage
  • In the sidebar select "Total questions" which is added to the stage.
  • It allows one to change the indication color of the correct and wrong answer of the quiz plugin.

Renderer

  • Progress bar plugin works by using the telemetry data of the quiz plugin
  • It reads the "ASSESS" event of the quiz . If the "ASSESS" event pass value is "Yes", it will fill "Green" color inside the box and if the value is "No" it will fill "Red" color inside the box.
  • It will also show the total number of questions and the attempted questions.

How to create plugins

  • Create a folder with the plugin name. The plugin folder structure should contain
    • assets
      • images.png
    • editor
      • assets
        • images.png
      • plugin.js
    • renderer
      • assets
        • images.png
      • plugin.js
    • manifest.json


Steps to upload plugins in Ekstep portal

  1. Go inside the plugin folder and create a zip of the plugin folder.
  2. Login to dev.ekstep.in or qa.ekstep.in
  3. Click on "Create new lesson" button
  4. Select "Upload a file".
  5. Fill all the required fields
  6. Select the Content Type as "plugin"
  7. Enter the plugin name as same as plugin id in the manifest.json.
  8. Upload the .zip file of the template.
  9. Then save the plugin and send for review.
  10. Once it is reviewed and published by other user your plugin will appear in the activity browser.


How to use plugin

  1. Create a  new lesson and it will launch the content-editor.
  2. Click on "Add activity" plugin
  3. And select the plugin from the "Activity Browser" and click on "ADD"
  4. The plugin will be added in the top bar
  5. Click on the plugin to add it to the stage.

Other details about plugins

https://docs.google.com/spreadsheets/d/1fQ8ekSVjHG-QHTCffMa7K56WWIAXyGKnAWRSX7VgpdQ/edit?usp=sharing

https://docs.google.com/spreadsheets/d/1LvqQzHfhi4eNDl4LtBUJCqCfYBF71NwHYHO2Ko1B45k/edit#gid=1994775373