Knotes

Knotes is a Open edX Plugin (XBLock) to take notes when watching videos.

This readme explains how to deploy Knotes in devstack environment. We assume you have latest devstack from edX installed and vagrant configured (and launched). More information available at: https://github.com/edx/configuration/wiki/edX-Developer-Stack

Installation guide

Connect you to your VM with:

vagrant ssh.

Connect you with edxapp user

sudo su edxapp

Create an apps directory in /edx/app/edxapp to store the Knotes app

• In /edx/app/edxapp with edxapp user create a directory my-apps

 cd /edx/app/edxapp
 mkdir my-apps
 cd my-apps

Clone the Knotes github repository in /edx/app/edxapp/my-apps

git clone https://github.com/Kalyzee/knotes.git

Activate the openedx venv and install Knotes

source /edx/app/edxapp/venvs/edxapp/bin/activate
cd knotes
pip install -r requirements.txt

Database configuration / installation

For dev environment you have to append the following lines into /edx/app/edxapp/edx-platform/cms/envs/devstack.py and /edx/app/edxapp/edx-platform/lms/envs/devstack.py

INSTALLED_APPS += ('videoknotes',)

After that it's necessary to setup the database.

cd /edx/app/edxapp/edx-platform
./manage.py lms syncdb --settings=devstack

The first output's lines will look like that:

Syncing... Creating tables ... Creating table videoknotes_knotelist Creating table videoknotes_knote Installing custom SQL ... Installing indexes ... Installed 0 object(s) from 0 fixture(s)

Restart your edX

 cd /edx/app/edxapp/edx-platform
 paver devstack --fast studio

Enabling in Studio

Login

To enable this Knotes into your course you have to:

• On a studio course main page go to Setting > Advanced Settings.

• Into the advanced module part, add "videoknotes" into the array.

• Click on "Save changes"

Using Knotes

In a unit:

Click on the advanced button in add new component.

Click on videoknotes

Your Knote is fully loaded you can change your video by cliking on edit button on the top right of the previous picture.

In this version Youtube and Dailymotion are enable it's possible to develop another player components.

Developping player adapters

function MyPlayerAdapter(element, video){


    var listeners = new KNotesListener(),
        _this = this;

    this.getCurrentTime = function(){

    }

    this.play = function(){

    }

    this.pause = function(){

    }

    this.seek = function(time){

    }

    this.createPlayerView = function(){

    }

    this.onTimeUpdate = function(callback){
      listeners.addlisteners("onTimeUpdate", callback);
    }

    var fireTimeUpdate = function(time){
      listeners.fireListeners("onTimeUpdate", function(callback){
        callback(time);
      });
    }

}


MyPlayerAdapter.isCompatible = function(videoURL){
  /**
  * Must return true if the videoURL is compatible !
  */
}

PlayerFactory.registerPlayer(MyPlayerAdapter);

You have to register your JS file in student_view method in videoknotes.py in javascript_array variable