Home

KA Lite Documentation

Contents

1. Contact Phone m Contact Email e User Count How many potential users do you estimate there are atthis facility Save facility KA Lite version 0 14 0 2015 Videos 2015 Khan Academy Creative Commons Exercises 2015 Khan Academy EY NC Sh 7 Once the information has been saved you will be redirected back to the Facilities page where you will see a message indicating that you have successfully saved your new facility 2 1 Admininistrator User Manual 21 Lite Documentation Release 0 2 1 7 Delete a Facility 1 Log in to KA Lite 2 Click the Manage tab at the top of the page 3 Make sure that the Facilities tab is selected Topic video exercise ry MANAGE LEARN ADMIN Facilities Videos Language Unregistered Device Register Now Export Data Facilities Facility Name Users Groups Last Usage Delete Silly Facility 2 0 Never Wilson Elementary 20 2 July 5 2015 4 34 a m Add a new facility Devices Device name Times Synced Last Sync Last Usage Available Actions currents 0 N A July 5 2015 4 34 a m KA Lite version 0 14 0 2015 Videos 2015 Khan Academy Creative Commons Exercises 2015 Khan Academy OR 4 Find the facility you would like to delete and click the trash can icon to delete the facility 5 You will be prompted to type in the name of the facility you wish to delete for confirmation 6
2. The initialize method is called whenever a new instance of Total PointView is instantiated by calling e g my total point view new TotalPointView model model There are several arguments that will automatically get set on the view if passed in to the constructor model is one of them See the Backbone js for more details _ bindAl1l this isincluded in many initialize methods we use this helps to ensure that whenever a View method is called then the this variable inside each method always refers to the view itself without this especially when methods are called due to being bound to events the this variable can refer to something completely different this listenTo this model change points this render is an example of such an event binding Here the view is being told that whenever its model fires the event change points then it should call its own render method this render Backbone models fire change events whenever one of their attributes changes and also a specific event like change points which would only fire when the points attribute of the model changes Finally this render calls the render method of the view This method is generally reserved for creating and modifying DOM elements that we will insert into the page Inside the render function var points this model get points locally defines the points as you can see from this example to access the attributes of a Backbone Model the
3. P i AT J aa EARN TT eM 7 2157 pur FOUNDA II N CUR WIT AUF pits ts 5 The page will refresh with a message at the top indicating a successful move Removing Users from a Group If you d like to remove a user from a group without permanently deleting the user please follow the instructions below 1 Follow the same instructions as for Moving a User to a New Group but select Ungrouped from the drop down menu 2 1 Admininistrator User Manual 37 KA Lite Documentation Release 0 Group Summary Statistics For each group you should be able to view some statistics 1 Navigate to the Learner Groups section of the facility you wish to look at 2 Click on the group that you wish to view EITE Topic video exercise MANAGE LEARN ADMIN MEM MZ Facilities Videos Language Unregistered Device Register Now Silly Facility Coaches Coach Edit Logins Login Time Coach Report Views Sample Teacher 1 0 0 hour s 0 Add a new coach Learner Groups Delete Groups Group Edit Coach Learners Logins Login Time Videos Viewed Exercises Completed Mastery Ungrouped N A 1 0 0 hour s 0 0 0 0 Learners Change Learner Groups M Delete Learners L Learner Name Edit Coach Group Logins Login Time Videos Viewed Exercises Completed Mastery Fodder Cannon Pd 0 0 5 0 0 0 0 Add a new learner _FOUNDATION FOR LEARNING EQUALIT
4. Device registration The device needs to have internet access when first being registered Please ensure it is connected to the internet and then refresh this page KA Lite version 0 14 0 2015 Videos 2015 Khan Academy Creative Commons Exercises 2015 Khan Academy If you do not see this page click on the Manage tab At the top of this page you should see a link to register your device It should like like the following Please follow the directions to register your device so that it can synchronize with the central server You will be prompted to log in with your central server login credentials Please note that these credentials are different from your login credentials created during set up Click on the Sign up here link and you will be redirected to a page that prompts you to create an account on the central server 2 1 Admininistrator User Manual 17 Lite Documentation Release 0 ON ABOUT LOGIN SIGN UP Please note that this is the central server you cannot log in here using your local server s account information If you do not have an account on the central server you can sign up here Email Password If you ve forgotten your password you can reset it here 2014 Foundation for Learning Equality Inc Except where otherwise noted content on this site is licensed under a Creative Commons Attribution 4 0 International license Once you have filled out the form and submit
5. so we can keep adding features that support you You will have two options 2 1 Admininistrator User Manual 13 Lite Documentation Release 0 1 One click registration This is the perfect option for individual users who just want to get KA Lite up and running fast and don t need online access to data This allows you to get the reg istration process over in one click without worrying about creating a login that you re never going to use Caution if you choose to one click register you will unable to register with online ac cess to data later If you chose this option by accident and would like to start over you can re run the setup command by navigating to the folder KA Lite is in and rerunning the setup command LITE Topic video exercise Ea MANAGE LEARN ADMIN amp D Facilities EIET Unregistered Device Register Now Export Data Facilities Facility Name Users Groups Last Usage Delete Silly Facility 2 0 Never Wilson Elementary 20 2 July 5 2015 4 34 a m Add a new facility Devices Device name Times Synced Last Sync Last Usage Available Actions currents 0 N A July 5 2015 4 34 a m KA Lite version 0 14 0 2015 Videos 2015 Khan Academy Creative Commons Exercises 2015 Khan Academy 14 Chapter 2 User Manual KA Lite Documentation Release 0 GLEE Topic video exercise LEARN ADMIN Device registration The
6. Django management commands can be run by typing bin kalite manage lt command_name gt in the root directory of the KA Lite project 72 Chapter 6 Developer Docs KA Lite Documentation Release 0 6 8 2 generaterealdata This function is designed to produce example user data for testing various front end functionality such as coach reports and content recommendation It does take some shortcuts and will not produce accurate answer data for exercises This is a Django management command and can be run with the following command bin kalite manage generaterealdata 6 9 Logging If you wish to view output from the server you have a few options e Start the server using the command kalite manage runserver this doesn t start the job scheduler e Start the server with kalite start foreground This will start the server using CherryPy and a single thread with output going to your terminal e Run the normal mode kalite start check kalite server 1log for output 6 9 Logging 73
7. Group Edit Coach Learners Logins Login Time Videos Viewed Exercises Completed Mastery Ungrouped N A 1 0 0 hour s 0 0 0 0 Add a new group Learners Change Learner Groups 7 Delete Learners L Learner Name Edit Coach Group Logins Login Time Videos Viewed Exercises Completed Mastery Fodder Cannon 0 0 5 0 0 0 0 Add a new learner FOUNDATION FOR LEARNING EQUALITY KA Lite version 0 14 0 2015 Videos 2015 Khan Academy Creative Commons Exercises 2015 Khan Academy BY NC SA 7 You will be prompted with a confirmation of your deletion Press to proceed with the deletion Adding Coaches 1 Log in to KA Lite 2 Click on the Manage tab at the top of the page 3 Make sure that the Facilities tab is selected 2 1 Admininistrator User Manual 27 KA Lite Documentation Release 0 4 Select the facility that the coach will belong to 5 Under the Coaches header click on a new coach Topic video exercise MANAGE LEARN ADMIN Facilities Videos Language Unregistered Device Register Now Silly Facility Coaches Coach Edit Logins Login Time Coach Report Views Sample Teacher 1 0 0 hour s 0 w Add a new coach Learner Groups Delete Groups L Group Edit Coach Learners Logins Login Time Videos Viewed Exercises Completed Mastery Ungrouped N A 1 0 0 hour s 0 0 0 0 Add a ne
8. Group Logins Fodder Cannon pP 0 0 hour s 0 0 0 0 Add a new learner KA Lite version 0 14 0 2015 Videos 2015 Khan Academy Creative Commons Exercises 2015 Khan Academy BY NC SA 7 You will be prompted with a confirmation of your deletion Press OK to proceed with the deletion Adding a Group You can create groups within a facility Each group can represent a classroom a study group or any other way you would like to group Learners To create a group follow the instructions below 1 Log in to KA Lite 2 1 Admininistrator User Manual 31 KA Lite Documentation Release 0 2 Click on the Manage tab at the top of the page 3 Make sure that the Facilities tab is selected 4 Select the facility that the group will belong to 5 Under the Learner Groups header click on Add a new group Topic video exercise MANAGE LEARN ADMIN Facilities Videos Language Unregistered Device Register Now Silly Facility Coaches 9 Delete Coaches LJ Coach Edit Logins Login Time Coach Report Views Sample Teacher 1 0 0 5 0 Add new coach Learner Groups Delete Groups Group Edit Coach Learners Logins Login Time Videos Viewed Exercises Completed Ungrouped N A 1 0 0 hour s 0 0 Learners Change Learner Groups M Delete Learners L Learner Name Edit Coach Group Logins Login Time Videos Viewed Exercise
9. That s why we created KA Lite with the goal of making high quality educational resources and tools provided by Khan Academy accessible to the estimated 65 of the world that don t have access to Internet 2 4 2 How KA Lite works KA Lite can be used in two different ways depending on your needs 1 KA Lite can be installed on one local computer which acts as a server with client devices connecting to this local server to watch the Khan Academy videos and to work on practice problems A coach teacher can then check on each student s progress This method is typically used by schools and other educational institutions 2 KA Lite can be installed on the client device itself and be used to download Khan Academy videos for offline viewing In this way KA Lite is almost like a piece of software that you d install on your computer except it runs in the Internet browser 2 4 3 Who can use KA Lite Reaching offline or low bandwidth communities with KA Lite is a team effort and we find that a wide variety of people come together to make that happen In a typical KA Lite deployment there are 3 types of people involved with the project which are organized into user types 1 Administrators Administrators plan out the deployment and logistics procure the devices and installs KA Lite and oversee their delivery and integration into the classroom or community They can also update the software add content customize configuration settings
10. and manage user accounts 2 Coaches Coaches also referred to as facilitators or teachers are users who add manage and track the progress of groups of students They have access to student progress data in the form of coach reports and can step in and provide individualized instruction when the student needs it 3 Learners Learners also referred to as students are users who use KA Lite primarily for learning They earn points for watching videos and answering exercises correctly and their progress is tracked by the system 2 4 Introduction 53 KA Lite Documentation Release 0 54 Chapter 2 User Manual CHAPTER 3 Frequently Asked Questions 3 1 How do install KA Lite Information on how to install KA Lite is available via our user guides 3 2 How much does KA Lite cost to install It is FREE both free as in free speech and free as in free beer To learn more about free software see this Free Software Foundation article 3 3 How do report a problem Please follow the instructions on our Github Wiki for reporting bugs 3 4 How do I change KA Lite s content folder If you want to change your installation s content folder from the default say to point to a shared folder across instal lations here are the steps you need to do 1 If it doesn t already exist create a file named local settings py in the ka lite kalite folder the one containing settings py 2 Add the line CONTEN
11. desired language code for this installation All choices can be found here If there are translations available our web server will show them in KA Lite Soon we hope to provide support for internationalized content inside the KA Lite interface e USE_I18N True or False default True If you set this to False our web server will make some opti mizations so as to avoid loading internationalization tools Things might run a little faster but you won t have support for translated content USE LION True or False default False By default this is set to False If you set this to True Django will format dates numbers and calendars according to the current locale For example January 5 2000 would be 1 5 2000 if locale en us and 5 1 2000 if locale en gb User restrictions e LOCKDOWN True or False default False With this setting users must be logged in order to access videos amp exercises e DISABLE SELF ADMIN True or False default False Disables user sign ups Online Synchronization USER LOG MAX RECORDS desired maxium for user log records default 0 When this is set to any non zero number we will record and sync for online tracking user login activity summarized for every month which is configurable see below Default is set to for efficiency purposes but if you want to record this setting to 1 1s enough The of records kept are not summary records b
12. get attribute method is used The content to be rendered into the DOM in this instance is so simple that a Handlebars template is not used Rather message sprintf gettext Points points d points points simply fills in the points with the points attribute of the second argument of sprintf See the sprintf docs for more information The part of the page that the view is scoped to can be refered to by this Sel this is a jQuery object for the subsection of the DOM of the view so any whole view operations such as this el html message or this Sel show will change the entire subsection of the DOM for that view but will normally only be a subset of the DOM of the entire page this Sel html message sets the entire HTML content of the view DOM subsection to the content of the message variable and this el show makes the DOM subsection visible 66 Chapter 6 Developer Docs in KA Lite Documentation Release 0 6 3 Creating Your Own Backbone View To create a new Backbone View you will either add to an existing Javascript file in the project or create a new file For example if you were to add a new View to the coachreports app you could create a file under kalite coachreports static js coachreports hexagon report js Some boilerplate to start off with might look something like this var HexagonReportView BaseView extend template HB template reports hexagon counting initialize
13. inside your KA Lite installation as the location unless you want the videos going somewhere else e Allow the videos to sync in there from your peers It may take a while for now as we don t yet have many seeders on it On that note please help seed by keeping it running even after you ve got all the videos if you have the bandwidth to spare This to will make it easier for others to download the content as well e Please note that these are resized videos All in all this will take around 23GB of space Once you have the videos you need to tell KA Lite where to find them by following the instructions in the user guide for your version 3 7 Do I need the internet to run KA Lite No The only time you need an internet connection is for the initial download of the content either to the target device or to a USB stick that can then be carried or mailed After installation you can serve the content from a local server or use it directly on the server device without an internet connection 3 8 Is KA Lite involved in getting devices into the hands of students families and communities Currently KA Lite does not distribute any devices We are working with partner organizations who do directly distribute devices to local students and communities and KA Lite is open to any organization who would like to help in this regard If your organization wants to help KA Lite distribute devices you can contact us at infoQ learningequ
14. page 3 It will then show a drop down menu from which you can click on My Progress On the progress page you will be able to view your progress on each topic There will be two bars for each topic The top bar represents your progress on the videos for that topic and the bottom bar will represent your progress on the exercises for that topic This guide assumes that you have already downloaded and installed the KA Lite software on your computer If you have not yet completed these steps please see the KA Lite Installation Guides 52 Chapter 2 User Manual KA Lite Documentation Release 0 2 4 Introduction KA Lite is a lightweight web application software that allows users without Internet access to engage with Khan Academy videos and exercises in completely offline settings It brings the flipped classroom model to some of the most remote areas in the world Users can track their progress through videos and exercises and coaches can log in to check students progress identifying which areas the students need the most help in If KA Lite ever reaches an Internet connection it can sync this usage data with the KA Lite Hub an online data repository that allows project administrators to view data and manage accounts remotely of offline deployments 2 4 1 What are the goals of KA Lite Learning is fundamental to human flourishing and at Foundation for Learning Equality we strive to support learning opportunities on every front
15. should install the correct version of behave Selenium is also required but is currently included in our python packages directory To run the tests simply run python kalitectl py manage test just like you used to This will automat ically search out tests using both the unit test framework and the behave framework You can specify apps but right now there s no way to just run integration tests 6 6 2 Anatomy of the integration tests The test command will look inside each app for a features directory Inside that directory should be one or more feature files written in the Gherkin specification language See the behave docs for more details on Gherkin or look in the control panel app where your humble author has attempted to provide some examples The test runner will parse the feature files and attempt to build a test suite from step specifications found in any python files the name is irrelevant in the steps subdirectory There is a 1 to 1 mapping between the clauses you write in the Gherkin specification and the steps you implement so it can save you time to reuse clauses Steps can also be templated to match clauses that follow a pattern You can also set up the test environment at key stages in the testing process by writing hooks in an environment py file in the features directory In the control panel example the before feature function is defined to log the testing user in as an admi
16. that can be further expanded icons designate that the selection be further expanded into subtopics icons designate that the selection is an exercise for that topic icons designate that the selection is a video for that topic Once you have found the video or exercise that you d like to engage with simply click on that selection Content Recommendation The content recommendations based off of your current progress are on the homepage and becomes visible after you have made some progress on at least one exercise After you have made any form of progress this is the first page you 2 3 Learner User Manual 51 Lite Documentation Release 0 should see after logging in If at any point you would like to get to your homepage please click on the KA Lite logo in the top left hand corner The homepage now provides you with three cards Resume This card allows you to navigate to the last exercise you were on This includes both videos and written exercises Next Steps This card allows you to navigate to excercises you have begun you can also to navigate to the over arching topic to which that exercise belongs to Explore This card recommends content for you based on topics you have completed and begun This card also recommends random content from our collection of topics to encourage learning from multiple fields 2 3 5 How to Practice Exercises First please log into KA Lite Then navigate to the to
17. the pyvirtualdisplay package installed you can build in headless mode by running the command env SPHINX_SS_USE_PVD true make html in the sphinx docs directory In other OSes or to build in non headless headed mode just run the command make html in the sphinx docs directory This may launch a browser Don t interfere with it You can view the docs in a browser by opening sphinx docs build html index html After you are satisfied with your changes push them to your fork of the ka lite project and then open a PR For this project we have created an rst directive to take screenshots of the site in case of UI changes or to build internationalized versions of the docs To read about the use of this directive see the SCREENSHOT_USAGE file and check out usage in the docs a good starting point is the ss_examples rst file 61 KA Lite Documentation Release 0 62 Chapter 4 Contributing and Development 5 Setting up your development environment KA Lite is like a normal django project if you have done Django before you will recognize most of these steps 1 Check out the project from our github 1 Create a virtual environment kalite that you will work in 1 Install kalite in your virtualenv in editable mode meaning that the source is just linked cd path to repo pip install 1 Install additional development tools pip install r requirements dev txt Run a developm
18. to synchronize data with our central data repository when an online connection exists For the deployments in which we do have direct involvement we receive updates from the administrator s with quan titative data from the built in coach reports and attain qualitative data from our on site visits For example we know that 20 out of 20 students in the Idaho Department of Corrections deployment have passed their GED using KA Lite We are also developing RCTs to start in June for a deployment in India 3 2 Backing up data is there any easy way to do it locally Yes Just copy the file ka lite kalite database data sqlite to a secure location To restore simply copy the backup data file to the same location If you have changed versions please run python kalite manage py migrate merge to guarantee your database is compatible with the current version of KA Lite you have installed Note that online data back ups occur if you register your KA Lite installation with an online account on our website 3 28 I skipped the step for downloading the assessment items during install how can I do it now Run the following command beware it can take a while the download size is over 500 MB kalite manage unpack assessment zip https learningequality org downloads ka lite 0 14 co As alternative you can download the zip file from _https learningequality org downloads ka lite O 14 content assessment zip and run the co
19. web server implemented in pure Python for serving the website capable of handling hundreds of simultaneous users while using very little memory So you don t have to run Apache or Nginx for efficiency Apache configuration using mod wsgi example would work for an Ubuntu deb installation lt VirtualHost 90 ServerName kalite com DocumentRoot var www html Alias static var www kalite static Alias media var www kalite media WSGIScriptAlias usr lib python2 7 dist packages kalite project wsgi py Possible values include debug info notice warn error crit alert emerg LogLevel warn ErrorLog LOG DIRj kalite error log CustomLog LOG DIRj kalite access log combined lt VirtualHost gt 18 Nginx Apache setup eee Lite Documentation Release 0 If you are using uwsgi Nginx this is the critical part of your uwsgi configuration provided that you have installed kalite from PyPi or deb module kalite project wsgi Remember that kalite runs in user space and creates data files in that user s home directory A normal Debian Ubuntu system has a www data user for Apache which is the default user for mod_wsgi and will create database files static files etc for kalite in var www kalite If you run it as another user it may be located somewhere else Note Log in as the Django application server s user e g www data and initialize the kalite static files and databas
20. A Lite is currently not supported on Internet Explorer version 8 or lower You must use IE9 or later 110 Supported Browsers 9 KA Lite Documentation Release 0 10 Chapter 1 KA Lite Installation Guides 2 User Manual The user manual is organized by the different user types within KA Lite If you know which user manual you d like to see click to jump to a specific manual 2 1 Admininistrator User Manual Who is an administrator A person who helps to plan and oversee a project using KA Lite e installs and updates KA Lite can create coach logins Learner logins download videos and language packs 2 1 1 Administrator Glossary For users that choose to register online there are some important terms to familiarize yourself with so that you under stand how the flow of data works between installations and the online data hub Sharing Network A sharing network is a group of devices that share data between one another Data can mean video content access software applications and certain files Organization An organization is a group of people responsible for administering a set of Sharing Networks An organization can have multiple administrators and manage multiple sharing networks Facility A facility is the physical space in which a device 15 located e g a school or a computer lab in a community center Learner coach and admin accounts are associated with a particular facility Devic
21. If your delete is successful you will be redirected back to the Facilities page where you will see a message indicating that you have successfully deleted the facility 2 1 8 User Management Coaches and learners are the other types of users that KA Lite supports In order for them to be able to login you need to create accounts for them 22 Chapter 2 User Manual KA Lite Documentation Release 0 Adding Learners 1 Log in to KA Lite 2 Click on the Manage tab at the top of the page 3 Make sure that the Facilities tab is selected 4 Select the facility that the learner will belong to LITE Topic video exercise LEARN ADMIN Facilities Videos Unregistered Device Register Now Facilities Facility Name Users Groups Last Usage Delete Silly Facili 2 0 Never 0 2 July 5 2015 4 34 a m Devices 9 Device name it Times Synced Last Sync Last Usage Available Actions currents 0 N A July 5 2015 4 34 a m FOUNDATION FOR LEARNING EQUALITY KA Lite version 0 14 0 2015 Videos 2015 Khan Academy Creative Commons Exercises 2015 Khan Academy 5 Under the Learners header click on Add a new Learner 2 1 Admininistrator User Manual 23 KA Lite Documentation Release 0 Sere Topic video exercise MANAGE LEARN ADMIN Facilities Videos Language Unregistered Device Reg
22. KA Lite Documentation Release 0 FLE July 06 2015 1 KA Lite Installation Guides 2 3 11 1 2 1 5 1 4 L3 L6 1 7 1 8 1 9 1 10 Windows Mac Installation Linux Debian Ubuntu Linux Installing as a PyPI package Uninstalling Raspberry Pi Advanced topics Nginx Apache setup Release Notes Supported Browsers User Manual 2 4 24 2 3 2 4 Admininistrator User Manual Coach User Manual Learner User Manual 2 0 0 eee sn Introduction Frequently Asked Questions 2 2 3 3 3 4 23 Su 3 8 3 9 3 10 241 2 12 3 13 3 14 Ae 3 16 o7 3 18 2419 How do I install KA Lite How do I report a problem How do I change KA Lite s content 1 What are some possible hardware configurations for deploying KA Lite What sort of processing power is required for KA Lite What is data syncing Does KA Lite support peer to peer synchronization What is KA Lite s affiliation with Khan Academy How can local curriculum be generated How is it possible to compress the content Contents HH HWW 19 TOM 5 2 20 3 21 2 22 3 23 3 24 S BA 3 26 2 3 26 What languages is KA Lite available in Can I contri
23. Lite Installation Guides KA Lite Documentation Release 0 git clone git github com learningequality ka lite git cd ka lite You may wish to create and activate a virtual env here pip install e Testing installers Here s an overview of the various ways of installing KA Lite as a reference to testers and package maintainers Source code setuptools test python setup py install e Source code setuptools test static python setup py install static e Source code pip test pip install e Source code pip test static N A the st atic option can t be passed through pip Dynamic tarball testing python setup py sdist static pip install dist ka lite XXXX tar gz Removal pip remove ka lite e Static tarball testing python setup py sdist static pip install dist ka lite static XXXX tar gz Removal pip remove ka lite static Wheel whl Not supported in 0 14 Those testing scenarios should be sufficient but there may be small differences encountered that we need to look at once in a while with pip install e editable mode or unzipping a source ka lite X X X zip and run setup py with setuptools instead of through pip Using pip install and static Is not possible so you cannot install the static version in editable mode This is because pip commands do not pass our user defined options to setup py 1 8 Nginx Apache setup This section is written for the Django knowledgable crowd KA Lite includes a
24. N FOR LEARNING EQUALITY KA Lite version 0 14 0 2015 Videos 2015 Khan Academy Creative Commons Exercises 2015 Khan Academy Permanently Deleting Learners 1 Log in to KA Lite 2 Click on the Manage tab at the top of the page 3 Make sure that the Facilities tab is selected 4 Under the Facilities header select the facility the Learner belongs to 5 Under the Learners header mark the box to the left of the Learner account you would like to delete 2 1 Admininistrator User Manual 25 KA Lite Documentation Release 0 10 Facilities Videos ELIEL Unregistered Device Register Now Silly Facility Coaches Delete Coaches Sample Teacher 1 Pj 0 0 hour s 0 Q Add a new coach Learner Groups 9 Delete Groups Ungrouped N A 1 0 0 hour s 0 0 0 0 Add a new group Learners Change Learner Groups Delete Learners Fodder Cannon 0 0 5 0 0 0 0 FOUNDATION FOR LEARNING EQUALITY 6 Press the Delete Learners button 26 Chapter 2 User Manual KA Lite Documentation Release 0 Topic video exercise KJ TEACH MANAGE LEARN ADMIN Facilities Videos Language Unregistered Device Register Now Silly Facility Coaches 9 LJ Coach Edit Logins Login Time Coach Report Views Sample Teacher 1 0 0 hour s 0 Add a new coach Learner Groups Delete Groups
25. P as a separate software package accessible to your whole system This is recommended if you run KA Lite and have internet access while installing and updating Static Static means that KA Lite is installed with all the external applications bundled in Use this method if you need to have KA Lite installed from offline media or if KA Lite s dependencies are in conflict with the system that you install upon You can install KA Lite in its very own separate environment that does not interfere with other Python software on your machine like this pip install virtualenv virtualenvwrapper mkvirtualenv my kalite env workon my kalite env pip install ka lite This documentation is preliminary and will be moved and restructured For command line users with access to PIP you can install the following versions of KA Lite gt pip install ka lite 1 7 1 Static version If you need to run KA Lite with static dependencies bundled and isolated from the rest of your environment you can run 1 7 2 Portable tarballs zip files with setup py You can also fetch a tarball directly from PyPi lt https pypi python org pypi ka lite static gt Do this for the sake of carrying KA Lite on an offline media You can then unpack the tarball and run python setup py install 1 7 3 Developer setup Developers should consider installing in editable mode That means create a git clone and from the git cloned directory run 6 Chapter 1 KA
26. T ROOT 2 full path to your videos directory making SURE to include an OS spe For example on Windows CONTENT ROOT C NNvideos location NV For example on Linux CONTENT ROOT home me videos location 3 Restart your server If you are unsure on how to do this please see Restarting Your Server 3 5 Is there somewhere can find Spanish language content orga nized by topic Yes Thanks to the efforts of an awesome volunteer deploying KA Lite and other OER in the Sacred Valley in Peru you can download blocks of Spanish Lanugage content from his public Google Drive folder You can also follow his 55 Lite Documentation Release 0 deployment at http www huacamayu org 3 6 would like to download the videos for KA Lite via BitTorrent is this possible We have made the full set of KA videos in the format needed by KA Lite available via BitTorrent Sync btsync note that this 1s different from BitTorrent btsync allows us to add new videos or fix problems without issuing a whole new torrent file and then having seeders split between the old and new torrent files Here are the steps to set this up Download and install BitTorrent Sync Run btsync On some platforms this will bring up a graphical interface On Linux you will need to load http 127 0 0 1 8888 to get the interface Click the Enter a key or link button and enter BT7AOITNAIP3X3CSLE2EPQUFXJXMXVGOI Then select the content folder
27. USE True or False default False With this setting if the browser is run from the same computer as the KA Lite server then instead of playing the video in the browser the video will be launched outside of the browser and played in mplayer a light weight video player that is included with the KA Lite software This is intended for use only on the Raspberry Pi where no other video player is available 2 2 Coach User Manual Who is coach A person who adds manages and tracks the progress of groups of students has access to student progress data in the form of coach reports provides instructions to students 2 2 1 Coach Reports Coach reports are visualizations of the data generated by your learners The goal of the coach reports is to put the data into an easy to understand format so you can understand how learners are progressing and where they need the most help The Report Page displays an overview of the learners and a tabular report 48 Chapter 2 User Manual KA Lite Documentation Release 0 Topic video exercise a TEACH MANAGE LEARN TEACHER 1 SAMPLE Coach Reports Facility Group Wilson Elementary M All Wilson Elementary SL DL a This week 9480 Total hours logged Average progress in Total exercise attempts Total time spent on exercises content KA Lite version 0 14 0 2015 English he Videos 2015 Khan Academy Creative Commons Exercise
28. Y KA Lite version 0 14 0 2015 Videos 2015 Khan Academy Creative Commons Exercises 2015 Khan Academy BY NC SA 3 The statistics for the group should be displayed at the top of the page 38 Chapter 2 User Manual KA Lite Documentation Release 0 Edit User Information 1 Navigate to the page for the facility that the user belongs in 2 Find the user you would like to edit 4 3 Click the blue pencil 4 icon next to the name of the user that you would like to edit 4 Make all necessary changes on the edit user page and click Update user 5 You will be redirected to the previous page with a message at the top indicating that your changes have been saved 2 1 9 Allowing Other Users to Connect In order for other users to be able to connect to the KA Lite server with a different machine you will need to give them an IP address with which to access the software This should be different from the IP address given to you during setup 127 0 0 1 8008 2 1 10 Downloading Videos Now that you ve created a facility and user accounts it s time to add video content to your local KA Lite installation Since the videos can take up a large amount of space you can choose to download only the videos that you need If your device has enough space and you wish to download all of the videos we recommend skipping to Downloading Videos in Bulk Downloading Individual Videos After registering your device 1 Cli
29. ality org 3 9 How do you operate in the field The FLE team primarily works in our San Diego offices building software and shaping our roadmap based on our interactions with our partners around the world We work with individual humanitarians and NGOs of all sizes to help them distribute KA Lite to offline communities around the world 56 Chapter 3 Frequently Asked Questions KA Lite Documentation Release 0 3 10 What are the typical deployment scenarios A typical school deployment varies depending on whether or not a school already has a computer lab School with an existing computer lab In this case KA Lite would be deployed as a server on one of the existing computers Students would connect using client devices over the local intranet School with no existing computer lab For schools that do not have an existing computer lab a KA Lite deployment would involve obtaining a device that can run as a KA Lite server most computers and other devices to be used as clients One common configuration is using a Raspberry Pi or other inexpensive computer as a server and relatively cheap tablets as client devices 3 11 What are some possible hardware configurations for deploying KA Lite You will need 1 A computer that is running the KA Lite software e g a desktop computer laptop or Raspberry P1 2 One or more client devices that have web browsers laptops tablets desktop computers etc Note that for a single user deploymen
30. ally to actually have this render on the page we would need to have a Backbone Model that is able to fetch the data from an API endpoint on the server and when the fetch is successfully completed prompt the view to be created Assuming we have a HexagonReportModel already defined we could insert the following code into the template to initialize this report lt script gt S function window hexagonReportModel new window HexagonReportModel hexagonReportModel fetch then function window hexagonView new HexagonReportView ele S Fstudent reporl container model hexagonReportModel 6 3 Creating Your Own Backbone View 67 Lite Documentation Release 0 jg lt script gt Line by line this means function lt here gt wait for the browser to finish ren dering the HTML before executing the code inside this function window hexagonReportModel new window HexagonReportModel make a new instance of the HexagonReportModel hexagonReportModel fetch then function lt code here gt get the data for this par ticular model from the server and when that has finished then execute the code inside the function window hexagonView new HexagonReportView el S student report container model hexagonReportModel make a new instance of the HexagonReportView This will automatically call initialize and so the view will render In addition el 4student report co
31. ase 0 Topic video exercise MANAGE LEARN ADMIN Facilities Videos Unregistered Device Register Now Facilities Facility Name Users Groups Last Usage Delete Silly Facility 2 0 Never Wilson Elementary 20 2 July 5 2015 4 34 a m Devices Device name Times Synced Last Sync Last Usage Available Actions currents 0 N A July 5 2015 4 34 a m FOUNDATION FOR LEARNING EQUALITY KA Lite version 0 14 0 2015 Videos 2015 Khan Academy Creative Commons Exercises 2015 Khan Academy cc 5 Fill in the information for all the fields you find below the 6 Click the Save facility button when you are finished 20 Chapter 2 User Manual KA Lite Documentation Release 0 LITE Topic video exercise LEARN ADMIN Unregistered Device Register Now Add a new Facility Please enter the following information about your facility Please enter a detailed address because knowing where you are in the world allows us to better plan for future deployments and partnerships Search for your facility s address or name to find its location on the map enter to searcl Name required Your School Description An optional description of your school Address Please provide as detailed an address as possible Contact Name Who should we contact with any questions about this facility
32. b browser on that machine 2 1 4 Setting up KA Lite Once you have successfully installed KA Lite the installation script should give you a URL http 127 0 0 1 8008 to visit so that you can open KA Lite and login for the first time 12 Chapter 2 User Manual KA Lite Documentation Release 0 Copy and paste the URL into a web browser The KA Lite application should show up Then login to KA Lite using the username and password you created during the installation process Select Facility e If you have forgotten the username password combination simply run bin kalite manage createsuperuser from the kalite directory and then follow the instructions If it is critical that you are able to login with your credentials contact and we can help you manually reset your login information Once you ve logged in the next step in the setup process is registering your device with the KA Lite Hub Registering Your Device with the Hub By registering your device with FLE you can sync data back with our central data hub This is useful for many reasons 1 a project administrator can manage user accounts and view usage data from afar without needing to physically visit the offline device 2 usage data syncing back can inform the FLE team of multiple users in a certain geographic region and we can connect people that might be able to help one another 3 it helps FLE and our partners understand where and how the software is being used
33. bute to KA Lite Can I contribute to KA Lite as a translator Can I contribute even if I don t know how How do I find out more uus sae w ES ERE UR DEERE REDE HES OS I skipped the step for downloading the assessment items during install how do it now Contributing and Development 4 How contribute to 5 5 5 5 5 2 Setting up your development environment Developer Docs 6 1 6 2 6 3 6 4 6 5 6 6 6 7 6 8 6 9 Front Eod C Ode e b amp BG be e Implementing with Backbone Creating Your Own Backbone View TL DR or 7 quick steps to creating a Backbone View in Purpose and creation of Javascript Unit Tests in KA Lite Behavior Driven Integration Tests KRALI e e as raea aee a a aa L Developer Utility Commands uu s i ser 54 9 RO RO ita Cw o3 Oy SR OE y o HHS cun Lr 58 58 58 59 KA Lite Documentation Release 0 Welcome to the KA Lite Documentation page Here you will find all the information needed to set up the KA Lite s
34. cannot be downloaded at this time x MEM MO Facilities Videos Language Download or Update Language Packs Language packs contain all available translations for the interface and video subtitles Select language pack Show beta language packs L Installed Languages Danish 1442 Subtitles 91 Translated Set as default English Default 0 Subtitles 100 Translated Spanish Castilian Set as default 2895 Subtitles 87 Translated KA Lite version 0 14 0 2015 Videos 2015 Khan Academy Creative Commons Exercises 2015 Khan Academy ad i 4 Once the download finishes you can see your language pack in the list of installed packs but you MUST restart your server to make them available for your users If you are unsure on how to do this please see Restarting Your Server 5 After the server restart learners and coaches will be able to switch their language to any of the installed language packs Their default will be the default that you set by clicking on Set as default Delete Language Packs To delete language packs 1 Log in as the administrator 2 1 Admininistrator User Manual 43 Lite Documentation Release 0 2 Click the Languages link in the navigation bar 3 In the Installed Languages section there is a button for deletion of each language LITE Topic video exercise MANAGE LEARN ADMIN Could not connect to the central server lan
35. ck the Manage tab at the top of the page 2 Click on the Videos tab 2 1 Admininistrator User Manual 39 Lite Documentation Release 0 Topic video exercis ES TEACH MANAGE LEARN ADMIN Facilities Videos Language Unregistered Device Register Now Facilities Facility Name Users Groups Last Usage Delete Silly Facility 2 0 Never Wilson Elementary 20 2 July 5 2015 4 34 a m Add new facility Devices Device name Times Synced Last Sync Last Usage Available Actions currents 0 N A July 5 2015 4 34 a m Register device KA Lite version 0 14 0 2015 Videos 2015 Khan Academy Creative Commons Exercises 2015 Khan Academy hate 3 View subtopics by clicking on the symbol to the left of a subject of your choice You can close them by clicking on the symbol 4 Mark the content you wish to download by clicking the checkbox to the left of the content name 5 Click the green Download button in the top left box of the page The button should also show you the total number of videos you have selected to download as well as the total size of the content 6 Once the download is completed video content will be ready for Learners to watch Downloading Videos in Bulk If you want to download videos in bulk your best option is to download the KA Lite videos through the BitTorrent Sync client This will be a much faster process than using th
36. der to make use of the compress template tag Let s examine the important details of Z compress js file learnjs the compress tag name is followed by the kind of file being compressed js then two optional parameters The first tells django compress to compress the assets to a separate file rather than rendering the concatenated Javascript inline in the HTML the second gives a name to the code block This should be a unique name across the entire code base At current there is no way to know what names have already been used except by examining karma conf js in the root of the project The name of the block is important for making it available for Javascript testing it needs to be manually added to the karma conf js here 6 5 Purpose and creation of Javascript Unit Tests in KA Lite 69 Lite Documentation Release 0 list of files patterns to load in the browser files file map basejs slice 1 file map perseusjs 1 slice 1 file map perseusjs 2 slice 1 file map learnjs slice 1 file map pdrgjgs Jslrcerl INSERT NEW JAVASCRIPT BUNDLES HERE xx tests javascript unit tests x js testing testrunner js So if you had created a new compression block called exparrotshop then you would add the element file map exparrotshop slice 1 to the array 6 5 4 Writing a Test You are now ready to write a test All Javascript unit tests live inside the appropriate app F
37. device needs to have internet access when first being registered Please ensure it is connected to the internet and then refresh this page KA Lite version 0 14 0 2015 Videos 2015 Khan Academy Creative Commons Exercises 2015 Khan Academy 2 Register with online access to data Choose this option if you re an administrator of larger projects This option allows you to access your uploaded data and connect multiple installations to the same account 2 1 Admininistrator User Manual 15 Lite Documentation Release 0 Topic video exercis MANAGE LEARN ADMIN Device registration The device needs to have internet access when first being registered Please ensure it is connected to the internet and then refresh this page KA Lite version 0 14 0 2015 Videos 2015 Khan Academy Creative Commons Exercises 2015 Khan Academy SA How to register your device with online access to data Note You will need Internet access in order to perform these steps 1 Log into KA Lite with the username and password that you set during set up 2 If you have not already registered your device you will be redirected to a page that shows you your options Click the Register with an online account now button to get started with the registration process 16 Chapter 2 User Manual KA Lite Documentation Release 0 Topic video exercis r3 MANAGE LEARN ADMIN
38. e before anything you can run kalite with uwsgi mod_wsgi Example of setting up kalite for the www data user S gt su s bin bash www data S gt kalite manage setup gt exit 1 9 Release Notes 1 9 1 0 14 0 General Installation from source using git 15 no longer supported for end users If you have previously installed from source in order to upgrade you must first install KA Lite again in a separate location using one of the supported installers Then you can migrate your data from your old installation to your new one using the command kalite manage setup git migrate path to your old installation You must use the kalite command that comes with your new installation The path you should specify is the base project directory it should contain the kalite directory which should in turn contain the database directory Follow the on screen prompts to complete the migration 1 9 2 0 13 0 General Interacting with the system through kalite manage py has now been deprecated Please use the kalite executable under the bin folder Run bin kalite h for more details If you are pulling the source from git you will need to run the setup command to complete the upgrade From the base directory run bin kalite manage setup On Windows use the bin windows kalite bat in the cmd exe prompt binNwindowsNkalite bat manage setup When you are asked whether or not to delete your database you should choose to keep yo
39. e A device should be able to run a KA Lite server most computers and other devices to be used as clients One common configuration is using a Raspberry Pi or other inexpensive computer as a server and relatively cheap tablets as client devices Tablets can access the servers through an access point such as a Wi Fi dongle or some other networking device such as a router Web Browser A program that retrieves and presents information resources on the World Wide Web Popular web browsers include Internet Explorer Google Chrome Mozilla Firefox and Safari Torrent A file or files sent using the BitTorrent protocol It can be any type of file such as a movie song game or application During the transmission the file is incomplete and therefore referred to as a torrent Torrent downloads that are incomplete cannot be opened as regular files because they do not have all the necessary data 11 Lite Documentation Release 0 Seeder Seeders are users who have a complete version of the file you wish to download If there are no seeders for a particular file you will not be able to download the file Seeders are extremely important for they help distribute the file Bandwidth The amount of data that an Internet connection can handle in a given time An Internet connection with larger bandwidth can move a certain amount of data much faster than an Internet connection with a lower bandwidth 2 1 2 Running the KA Lite Server After a succes
40. e KA Lite app to download all of the videos We have made the full set of KA videos in the format needed by KA Lite available via BitTorrent Sync btsync Note that this is different from BitTorrent btsync allows us to add new videos or fix problems without issuing a whole new torrent file and then having seeders split between the old and new torrent files Here are the steps to set this up 1 Download and install BitTorrent Sync 2 Run btsync On some platforms this will bring up a graphical interface On Linux you will need to type http 127 0 0 1 8888 into the address bar of your browser to get the interface 40 Chapter 2 User Manual KA Lite Documentation Release 0 3 Click the Enter a key or link button and enter BTTAOITNAIP3X3CSLE2EPQJFXJXMXVGOI 4 Select the content folder inside your KA Lite installation as the location unless you want the videos to be located elsewhere 5 Allow the videos to sync in there from your peers It may take a while for now as we don t yet have many seeders on it On that note please help seed by keeping it running even after you ve got all the videos if you have bandwidth to spare This will make it easier for others to download the content as well These are resized videos All in all this will take around 23 GB of space Warning If you chose to download them to somewhere other than the content folder inside the ka lite folder as recommended above you need
41. egmentation fault error 4 Install the USB adaptor software If using WiPi run this command e cd opt ka lite pi scripts e sudo use wipi sh If using the Edimax EW 7811Un run this command cd opt ka lite pi scripts sudo use_edimax sh 5 Complete the access point configuration sudo python configure network interfaces py sudo insserv hostapd 6 Finally sudo reboot A wireless network named kalite should be available Connect to this network If the KA Lite server is started browse to 1 1 1 1 1 6 Raspberry Pi 5 Lite Documentation Release 0 1 7 Advanced topics KA Lite can also be run as a source distribution for development purposes By this we just mean a git checkout from our github lt https github com learningequality ka lite gt _ Note Running directly from source will also maintain all user data in that same directory This is convenient for having several versions of kalite with different data on the same computer If you are able to use pip and install conventional python packages from an online source then the quickest option to install the latest stable release of KA Lite is pip install ka lite or pip install ka lite static Apart from Python itself KA Lite depends on a couple of python applications mainly from the Django ecology These applications can be installed in two ways Dynamic That means that they are automatically installed through P
42. ent server and use development settings like this kalite manage runserver settings kalite project settings dev You can also change your kalite settings py to point to kalite project settings dev by de fault then you do not have to specify settings every time you run kalite Now everytime you work on your development environment just remember to switch on your virtual environment with workon kalite KA Lite Documentation Release 0 64 Chapter 5 Setting up your development environment CHAPTER 6 Developer Docs Useful stuff our devs think that the rest of our devs ought to know about 6 1 Front End Code All of our front end code is written in Javascript with much of it using Backbone js and its dependencies jQuery and Underscore js All new code where possible should be written using Backbone js to modularize functionality and allow code to be reused across the site Inline Javascript i e Javascript directly in the Django templates inside script tags should be avoided except where absolutely necessary such as to initialize some master object on a page For templating on the front end we use Handlebars js to render templates with a restricted set of statements and access to all variables passed into the template context 6 2 Implementing with Backbone Most of our front end code uses only three kinds of objects Backbone Models Collections and Views Backbone Models contain data that we
43. function _ bindAll this this listenTo this model change number of hexagons this render this render render function this Sel html this template this model attributes this el html this template this model attributes this line will insert all the attributes of the model into the template for rendering and then set the HTML of the subsection of the DOM for the view to the resulting HTML For this to work there must be a file kalite coachreports hbtemplates reports hexagon counting handlebars that contains the Handlebars js template for this view For a simple report the template might look something like this lt div class hexagon report gt h3 11 Hexagon Report lt h3 gt lt p gt _ Current number of hexagons number_of_hexagons lt p gt lt div gt To have this render in a particular Django template both of the above files would need to be imported through lt script gt tags in the Django template The relevant tags to add in this case would be lt script src url handlebars templates module_name reports gt lt script gt script type text javascript src static js coachreports hexagon report js gt lt script gt Note that for the Handlebars importing only the folder name is necessary to be imported not each individual template It is also important that you do not place this script tag inside a Django Compressor compress block Fin
44. guage packs cannot be downloaded at this time MEM MO Facilities Videos Language Download or Update Language Packs Language packs contain all available translations for the interface and video subtitles Select language pack Show beta language packs Installed Languages Danish Set as default 1442 Subtitles 91 Translated English Default 0 Subtitles 100 Translated Spanish Castilian Set as default 2895 Subtitles 87 Translated KA Lite version 0 14 0 2015 Videos 2015 Khan Academy Creative Commons Exercises 2015 Khan Academy 2 1 12 Restarting Your Server If you have made some configuration changes such as changing the filepath to your video content to your liking or if you feel the need to reboot your KA Lite system you may want to restart your server Please note that this will cause KA Lite to become inaccessible to any users However this will not delete any user accounts or information that you have configured during set up This process varies depending on which OS you are running the KA Lite Server on 44 Chapter 2 User Manual KA Lite Documentation Release 0 Restarting Your Server Windows In the system tray right click on the KA Lite icon Click the Stop Server item in the context menu Right click on the KA Lite icon in the system tray again and click Start Server If the option is not clickable wait a while and try again or restart y
45. have varying levels of support Portuguese Danish French Polish Spanish Please visit our blog for the latest information about language support 3 21 contribute to KA Lite as a developer Yes KA Lite is an open source project and developers are encouraged to contribute If you are interested in develop ing for KA Lite check out the instructions for getting started 3 22 Can I contribute to KA Lite as a translator Yes absolutely If you would like to contribute to KA Lite as a translator you can get started over on our translations and internationalization page on our GitHub Wiki 3 23 Can contribute even if don t know how to code Yes There are many ways 58 Chapter 3 Frequently Asked Questions KA Lite Documentation Release 0 3 24 How do find out more To stay up to date on all our activities follow our blog Twitter and Facebook 3 25 What can be done with progress tracking during offline usage KA Lite s built in coach reports are meant to provide teachers and administrators access to progress tracking offline When a student connects back up to the server that they sync with all of their progress data will be uploaded for teachers and administrators to evaluate 3 26 How does FLE measure the impact of KA Lite Because KA Lite is freely available and designed to run offline we are not in contact with many of our deployments and collecting impact data can be challenging KA Lite is capable
46. ike to move the user to 2 1 Admininistrator User Manual 35 KA Lite Documentation Release 0 10 8 Facilities Videos Unregistered Device Register Now Silly Facility Coaches Delete Coaches Sample Teacher 1 Pd 0 0 hour s 0 Q Add a new coach Learner Groups 9 Delete Groups Ungrouped N A 1 0 0 hour s 0 0 0 0 Add a new group Learners Change Learner Groups i i Delete Learners Fodder Cannon Pd 0 0 hour s 0 0 0 095 Add a new learner FOUNDATION FOR LEARNING EQUALITY 4 Click the Change Learner Groups button 36 Chapter 2 User Manual KA Lite Documentation Release 0 LITE Topic video exercise Ig MANAGE LEARN ADMIN Facilities Videos Language Unregistered Device Register Now Silly Facility Coaches 9 Coach Edit Logins Login Time Coach Report Views Sample Teacher 1 Pd 0 0 hour s 0 Add a new coach Learner Groups Delete Groups Group Edit Coach Learners Logins Login Time Videos Viewed Exercises Completed Mastery Ungrouped N A 1 0 0 hour s 0 0 0 0 Add a new group Learners Change Learner Groups Delete Learners L Learner Name Edit Coach Group Logins Login Time Videos Viewed Exercises Completed Mastery Fodder Cannon 0 0 5 0 0 0 0 Add a new learner pus Ege gp umana DIR qe Com esee a ocn 4 E re np y
47. ion Release 0 3 16 Who maintains the KA Lite project KA Lite is created maintained and operated by the Foundation for Learning Equality Inc a California based nonprofit organization 3 17 What is KA Lite s affiliation with Khan Academy KA Lite is an independent open source project maintained by a distributed team of volunteers and is not officially affiliated with Khan Academy although they are unofficially very supportive of the KA Lite project 3 18 How can local curriculum be generated Local content creation is something that KA Lite intends to pursue in the future This feature is not available at this time but steps are being taken as you can read about here If you would like to be notified when it is available subscribe for updates on our home page or if you would like to fund this project please click here 3 19 How is it possible to compress the content into KA Lite First users are able to select the amount of videos and exercises they wish to download on the user interface allowing the users to customize the size of the files Also we have resized much of the content and approximately 4 000 videos are around 25 GB if downloaded via BitTorrent and around 70 GB via the user interface 3 20 What languages is KA Lite available in KA Lite was released with internationalization support on 2014 03 07 including support for a translated interface dubbed videos subtitles and translated exercises Currently we
48. ister Now Silly Facility Coaches 9 Coach Edit Logins Login Time Coach Report Views Sample Teacher 1 0 0 hour s 0 Add a new coach Learner Groups L Group Edit Coach Learners Logins Login Time Videos Viewed Exercises Completed Mastery Ungrouped N A 1 0 0 hour s 0 0 0 0 Add a new group Learners Change Learner Groups M Delete Learners L Learner Name Edit Coach Group Logins Login Time Videos Viewed Exercises Completed Mastery Fodder Cannon 4 0 0 hour s 0 0 0 095 w Add a new learner FOUNDATION FOR LEARNING EQUALITY KA Lite version 0 14 0 2015 Videos 2015 Khan Academy Creative Commons Exercises 2015 Khan Academy 6 You will be redirected to a page that says Add a new Learner Fill in all the information The facility dropdown defaults to the facility you selected in the previous steps 7 Click Create user You should be redirected to the Facilities page where you will see a message indicating that you have successfully created a Learner user 24 Chapter 2 User Manual KA Lite Documentation Release 0 Topic video exercise TEACH MANAGE LEARN ADMIN Facilities Videos Language Add a new learner Facility Silly Facility 1781 v Group class bd Add a new group Username m First Name Last Name Password Confirm password Default Language English v Create user FOUNDATIO
49. ite folder on your machine 2 1 Admininistrator User Manual 45 Lite Documentation Release 0 2 inbin kalite restart This should stop the server then attempt to restart it again The process may take up to a few minutes 3 Once you see the script that begins with To access KA Lite from another connected computer try the following address es you will know that your KA Lite server has been successfully restarted 2 1 13 Updating KA Lite If a new version of KA Lite comes out you can update to the latest version by following the instructions below Updating on Mac OS and Linux At this time the only supported way to update is to grab the source and run the setup management command Follow the instructions in the installation guide to ensure you re using the latest version Updating on Windows To update on Windows simply use our Windows installer You will have the option to update from a prior version See the Windows installation guide 2 1 14 Configuration Settings Once you have deployed KA Lite to a computer there are a number of ways you can customize the behavior of your installation Below you will find a list of these possible customizations with instructions or descriptions on how to do it Warning Please follow these instructions carefully Customizing the server incorrectly can break your installa tion It can be very hard to find and undo the error Running KA Lite with your own se
50. ity Coaches 9 Coach Edit Logins Login Time Coach Report Views Sample Teacher 1 Pd 0 0 hour s 0 Add a new coach Learner Groups Delete Groups O Group Edit Coach Learners Logins Login Time Videos Viewed Exercises Completed Mastery Ungrouped N A 1 0 0 hour s 0 0 0 0 Add a new group Learners Change Learner Groups M Delete Learners L Learner Name Edit Coach Group Logins Login Time Videos Viewed Exercises Completed Mastery Fodder Cannon rd 0 0 hour s 0 0 0 0 Add a new learner 7 You will be prompted with a confirmation of your deletion Press to proceed with the deletion Moving a User to a New Group 1 Navigate to the page for the facility the user belongs to 2 Under the Learners header select the Learner you would like to move by clicking in the checkbox to the left of the Learner name 34 Chapter 2 User Manual KA Lite Documentation Release 0 10 Facilities Videos ELIEL Unregistered Device Register Now Silly Facility Coaches Delete Coaches Sample Teacher 1 Pj 0 0 hour s 0 Q Add a new coach Learner Groups 9 Delete Groups Ungrouped N A 0 0 hour s 0 0 0 0 Add a new group Learners 1 Change Learner Groups Delete Learners Fodder Cannon Pd 0 0 hour s 0 0 0 095 Senece FOUNDATION FOR LEARNING EQUALITY 3 In the dropbox select the group you would l
51. ize user data with other Devices on your Zone This can be changed to sync data more often use a smaller or if you re never online can be set to a large number CACHE TIME desired length of cache time in seconds default 5 365 24 60 60 that s 5 years Our basic topic pages video pages and exercise pages rarely change only when you download new videos changes made by user logins are made in a different way Therefore we can cache copies of these pages to avoid constantly regenerating them and speed up KA Lite We have logic to delete the cached copies and therefore generate new copies if you download new videos or delete old videos through our interface If you would like to disable caching set CACHE TIME 0 Read a little more about caching on Wikipedia CACHE LOCATION path to cache directory default dir named kalite web cache in the OS temporary dir Some operating systems will clear the temporary directories when the system is rebooted To retain the cache between reboots an alternative location can be specified for example on Linix var tmp kalite web cache CHERRYPY THREAD COUNT number of threads default 50 The CherryPy Webserver can handle multiple page requests simultaneously The default is 50 but for slow or single CPU servers performance will be improved if the number of threads 1s reduced Minimum number of threads is 10 optimum setting for Raspberry Pi is 18 Raspberry Pi e
52. lities header select the facility the coach belongs to 5 Under the Coaches header mark the box to the left of the coach account you would like to delete 2 1 Admininistrator User Manual 29 KA Lite Documentation Release 0 Facilities Videos ELIEL Unregistered Device Register Now Silly Facility Coaches Delete Coaches Sample Teacher 1 0 0 5 0 Learner Groups Delete Groups Ungrouped N A 0 0 hour s 0 0 0 0 Add a new group Learners 1 Change Learner Groups Delete Learners Fodder Cannon 0 0 hour s 0 0 0 0 Add a new learner FOUNDATION FOR LEARNING EQUALITY 6 Press the Delete Coaches button 30 Chapter 2 User Manual KA Lite Documentation Release 0 LITE Topic video exercise LEARN ADMIN Language Facilities Videos Unregistered Device Register Now Silly Facility Export learner stats Coaches Delete Coaches Coach Edit Logins Login Time Coach Report Views Sample Teacher 1 d 0 0 hour s 0 Add new coach Learner Groups 9 Delete Groups 1 Group Edit Coach Learners Logins Login Time Videos Viewed Exercises Completed Mastery Ungrouped N A 1 0 0 hour s 0 0 0 0 Add a new group Learners Change Learner Groups Coach M Delete Learners Login Time Videos Viewed Exercises Completed Mastery L Learner Name Edit
53. mmand on your local copy This is useful if you re deploying KA Lite on multiple computers 3 24 How dol find out more 59 KA Lite Documentation Release 0 60 Chapter 3 Frequently Asked Questions 4 Contributing and Development Want to contribute You can check us out on github or browse the link s below 4 1 How I contribute to 4 1 1 How to contribute to documentation You can propose changes to the docs directly on github instructions below or email your recommendations to info learningequality org To propose changes directly you ll need to create an account on github and open a pull request This document assumes you are somewhat familiar with that process and will not explain all the steps in detail For full instructions on how to make a pull request see Github s help section Some guidelines Work from the develop branch From the base directory the documenation can be found in the sphinx docs subdirectory Specific pages of the docs are each associated with a different rst file potentially in a subdirectory of sphinx docs The documentation is written in ReStructured Text format so please see the primer After making your changes try to build the docs to review them This process can take some time as an instance of the server and a browser may need to be started To build the docs see README md in the sphinx docs directory for requirements In Linux if you have
54. n before each feature tagged with the Gas admin tag in the specification In testing base environment py the before all and after all hooks are defined to set up a Selenium WebDriver instance on the context object that is passed around by the test runner This file is intended to be used as a base for all the integration tests so if there is some setup common to all integration tests then put it there You can then import those functions in the environment py of specific apps and extend or overwrite as necessary 6 6 Behavior Driven Integration Tests T1 Lite Documentation Release 0 Finally in testing behave_helpers py you ll find various functions that should be generally useful for all integration tests If you find yourself wishing you had a nice useful function add it here In order to avoid reproducing functionality while we phase out the old integration tests if some functionality already exists in the form of a mixin you should import it into that file and wrap it in a new function Be very reticent about importing mixin code A good rule of thumb is to glance at how something is implemented in the mixins first and only import it if it s not trivial to reproduce Only re write if there s no chance of the new code producing an error The main goal is to avoid maintaining two sets of code 6 6 3 Suggested workflow for writing new features Ideally you should 1 Specify your integration tests 2 Write failing
55. n to download individual dubbed videos from the language s Khan Academy YouTube channel Warning Remember to Restart Your Server _ after every language pack download or update Download Language Packs To download language packs 1 From the Manage page click on the Language tab 2 Select the language pack you wish to download by selecting from the drop down menu 2 1 Admininistrator User Manual 41 KA Lite Documentation Release 0 Topic video exercise Kg LEARN ADMIN Could not connect to the central server language packs cannot be downloaded at this time x Facilities Videos Language Download or Update Language Packs Language packs contain all available translations for the interface and video subtitles Select language pack Show beta language packs L Installed Languages Danish Set as default Sper 1442 Subtitles 91 Translated English Default 0 Subtitles 100 Translated Set as default 2895 Subtitles Delete 87 Translated FOUNDATION FOR LEARNING EQUALITY KA Lite version 0 14 0 2015 Videos 2015 Khan Academy Creative Commons Exercises 2015 Khan Academy EY NC Sh 3 Click the Get Language Pack button 42 Chapter 2 User Manual KA Lite Documentation Release 0 Topic video exercise KY TEACH MANAGE LEARN ADMIN Could not connect to the central server language packs
56. ntainer tells the view that it should set its subsection of the DOM to be the DOM element selected by 5 student report container ie the element with the id student report container and model hexagonReportModel tells it to set its model attribute to the hexagonReportModel we instantiated and fetch before 6 4 TL DR or 7 quick steps to creating a Backbone View in KA Lite 1 Find the appropriate app folder inside KA Lite inside lt folder gt static js lt folder gt either create a folder for your Backbone files or find an existing one with a name that fits Inside this folder either create or open views js To start creating a view type var MyViewNameView BaseView extend Define at least an initialize method and a render method A Ww N If you want a Handlebars template for your View look inside lt folder gt hbtemplates and either create a folder for your Handlebars templates or find an existing one with a name that fits ON Inside this folder create a new file for your handlebars template mytemplatename handlebars 7 Add this to your View definition code inside the curly braces and don t forget commas to separate key value pairs template HB template templatefolder mytemplatename 6 5 Purpose and creation of Javascript Unit Tests in KA Lite 6 5 1 Purpose Our Backbone Models and Views can end up having a lot of methods It is important that all of those methods ob
57. oftware Additionally there s information on how to manage KA Lite and how to perform role specific tasks If you have any questions that are not addressed by the documentation and you have access to the Internet please be sure to check our FAQ or Forums Contents 1 KA Lite Documentation Release 0 Contents 1 KA Lite Installation Guides Hello If you know what OS you re installing on then click ahead 1 1 Windows Installation 1 Download the KA Lite Windows installer 2 After downloading the exe file double click it A window will appear and guide you through the process of installing KA Lite on the server 1 2 Mac Installation 1 Download the KA Lite OSX installer Warning Dear maintainers please update this link 1 3 Linux Debian Ubuntu Installation 1 3 1 Option 1 Ubuntu Add a PPA We maintain a PPA on Launchpad and if you are connected to the internet this will also give you automatic updates sudo add apt repository ppa learningequality ka lite sudo apt get update sudo apt get install ka lite 1 3 2 Option 2 Ubuntu Debian download a Debian package Download the latest deb manually from the Launchpad archive server Look for the latest file with a deb extension download it and open it with Ubuntu Software Center GDebi Synaptic or install it from command line with dpkg i ka lite O x x Oubuntul 11 The file may be named as if it was intended for Ubuntu bu
58. or a complete set of assertions 6 5 5 Running Tests When you have written your tests before you can run them we need to bundle the Javascript for testing In order to do this from the root of the project run 70 Chapter 6 Developer Docs KA Lite Documentation Release 0 bin kalite manage bundleassets This will bundle all the django compress tags and make concatenated files It will also update the file_map that our Karma config uses to find these files When this is complete simply run karma start This will run through all the Javascript tests and report on failures N B Karma is often and most helpfully run in continuous integration mode our code base does not currently suppor that but hopefully will in the future 6 6 Behavior Driven Integration Tests Part of our comprehensive testing intiative is to write better integration tests The goals are to 1 Stop using browser driven integration tests as unit tests Such slow 2 Have robust integration tests that don t fail randomly 3 Use behavior driven tests to clarify design goals of features We re using behave 1 2 4 to run our integration tests Behavior driven tests are specified using the Gherkin specification language and then behave builds a test suite from step implementations that are directly mapped to clauses from the Gherkin specification 6 6 1 Running the integration tests To get the dependencies run pip install r dev requirements txt This
59. or example if you were writing a unit test for Javascript code for the coachreport app you would put your test file in kalite coachreports tests javascript unit tests Call your file the name of the Model View or Router you are test ing or use an existing test file if you are extending an already tested Model or View For example the Session Model test file is called Session model test js Each test file should start with a definition statement module Session Model Tests setup function return this sessionModel new SessionModel yg The text gives the name of the suite of tests you will be writing in this file The setup method defines something that happens prior to every single test being run this gets returned to every subsequent test as this also so anything set as an attribute of this will be available inside each test After the module definition you can define any number of tests Here is a simple example test Default values function expect 2 equal this sessionModel get SEARCH TOPICS URL equal this sessionModel get STATUS URL This simple test is checking the default values for the Session Model defined during the setup method above At the beginning of the test we declare how many assertion statements will be made during the course of the test Not specifying this number correctly will cause a failure The tests are written in QUnit whose docs can be referred to f
60. our computer Restarting Your Server Linux 1 Open up your terminal For most Linux distributions you can do this by going to Menu gt Accessories gt Terminal or Applications menu gt System gt Terminal 2 Navigate to the folder that you downloaded KA Lite in You can do this by typing cd lt PATH TO KALITE FOLDER gt Change the path to the path name of the KA Lite folder on your machine 3 in bin kalite restart This should stop the server then attempt to restart it again The process may take up to a few minutes 4 Once you see the script that begins with To access KA Lite from another connected computer try the following address es you will know that your KA Lite server has been successfully restarted Restarting Your Server Mac 1 Open up your terminal You may do this by navigating to the magnifying glass Q at the top right corner of your screen and typing in Terminal then hitting Enter on your keyboard 0 9 3 A 62 CG Mon Feb 2 6 05 PM fe Spotlight Show in Finder Top Hit Terminal Applications W Terminal 1 Your terminal should be opened up It should look a little something like the following e o0 teekay bash 80x24 w Last login Mon Feb 2 15 18 34 on 11 5001 localhost teekay 1 Navigate to the folder that you downloaded KA Lite in You can do this by typing cd lt PATH TO KALITE FOLDER gt Change the path to the path name of the KA L
61. pic that you d like to practice exercises for To answer a question enter the answer in the box on the top right of the module or select the bubble next to the answer choice in the exercise panel Once you have decided on your answer click Check Answer After answering a question the exercise module will not advance to the next question until you click the Next Question button on the right hand side of the module The bar on the top right will display your progress as you go through the exercises After 8 correct answers out of the last 10 answered your points for the exercise will be added to our total and you will have mastered the exercise If you get an answer wrong or ask for a hint you will be unable to earn points from that question until it is presented again Hint If you are stuck on a problem you can ask for a hint by clickin on the Show hints button Use your hints wisely for there are a limited number of them for every section Saved Progress If at any point during an exercise you wish to watch a video to refresh your memory feel free to navigate to the video by expanding the green tab which will bring up the content menu Your progress for that exercise will be saved and you will not lose your work 2 3 6 How to View Your Progress At any point in time you should be able to view your progress on any topic In order to do this 1 Log into KA Lite 2 Then click on your name in the top right of the
62. pip uninstall ka lite or pip uninstall ka lite static static version For Ubuntu use apt get remove ka lite Downloaded videos and database files are in kalite Navigate to the home directory of the user who ran the KA Lite server and remove that directory to potentially reclaim lots of hard drive space 1 6 Raspberry Pi For a Raspberry Pi running a Debian system you can install the Debian package Note Two Wi Fi USB modules have been tested with KA Lite on the Raspberry Pi Raspberry Pi WiPi adaptor Edimax EW 7811Un 4 Chapter 1 KA Lite Installation Guides KA Lite Documentation Release 0 In our tests we found that the WiPi adaptor supported a higher number tablet connections Note The Raspberry Pi may crash if the USB adaptor is inserted or removed while the computer is switched on Make sure to shutdown and remove the power from the Raspberry Afterwards insert the wireless USB adaptor Lastly switch the Raspberry Pi on 1 Make sure the Raspberry Pi operating system is up to date Login with the account used to install KA Lite Update the Raspberry Pi operating system by sudo apt get update sudo apt get upgrade 2 Get the installation scripts e cd opt e sudo git clone https github com learningequality ka lite pi scripts git 3 Install and configure the access point cd opt ka lite pi scripts sudo configure sh Note If using the Edimax EW 7811UN ignore the hostapdS
63. s 2015 Khan Academy Overview 1 Select the Teach tab at the top of the page 2 Select the appropriate facility from the drop down menu to view reports for a specific facility 3 Select a group from the drop down menu to view the overivew for a specific group or leave the group as 15 4 The display should refresh with the data requested The overview will display the activity of the group the total hours logged the average progress in exercises the total exercises attempted and the total time spent on content Tabular Report A tabular report is a grid that can show how students are doing in specific subjects at a high level As a coach you can select which group of students you d like to check progress for and which subset of videos or exercises you d like to see reports on This allows you to easily identify which areas learners are struggling in as well as which learners are doing well 2 2 Coach User Manual 49 Lite Documentation Release 0 Progress By Topic 1 Click on the Show Tabular Report button 2 A table should be generated with the data requested The color of the rectangles in the table indicate how that student is doing on a particular exercise The following key explains the color code of the table cells this information will also be available on the Coach Report page Not Attempted The student has not attempted the subtopic In Progress The student has completed a few questions Str
64. s Completed Fodder Cannon 0 0 hour s 0 0 Add a new learner UNDATION FOR LEARNING EQUALITY KA Lite version 0 14 0 2015 Videos 2015 Khan Academy Creative Commons Exercises 2015 Khan Academy 6 Fill out the name of the group and provide a description 7 Click create group 32 Export learner stats Mastery 0 0 Mastery 0 0 Chapter 2 User Manual KA Lite Documentation Release 0 eo exercis r3 MANAGE LEARN Add a new group Name Description Create group KA Lite version 0 14 0 2015 Videos 2015 Khan Academy Creative Commons Exercises 2015 Khan Academy Y NC SR 8 You should be redirected back to the page for the facility If the group was successfully created you will see it listed under the Learner Groups section Deleting a Group 1 Log in to KA Lite Click on the Manage tab at the top of the page Make sure that the Facilities tab is selected Select the facility that the group you would like to delete belongs to Mark the box to the left of the group you would like to delete QN A W N Press the Delete Groups button under the Learner Groups header 2 1 Admininistrator User Manual 33 KA Lite Documentation Release 0 LITE Topic video exercise Ig TEACH MANAGE LEARN ADMIN Facilities Videos Language Unregistered Device Register Now Silly Facil
65. ser to access KA Lite it should be http 127 0 0 1 8008 2 3 2 How to Sign Up Learners may receive their account information from their Coaches or Administrators if their account has been pre configured However it is possible for learners to create their own account To create an account please follow the instructions below 1 Open KA Lite 2 Click Sign Up at the top right of your screen 3 If you are redirected to a page that asks you to select a facility please select the facility to which you belong If you are unsure which facility you belong to please contact your administrator or coach Skip this step if you do not see this page 4 Fill out the information 5 Click the Create user button when you are finished 2 3 3 How to Log In 1 Open KA lite 2 Click on the Log In tab 3 Enter your username and password and then click the Log in button 2 3 4 Navigating through Content To begin engaging with the Khan Academy videos and exercises first make sure you are logged into KA Lite Upon log in you should see a green menu on the left that lists the content If you do not see this green menu please start by clicking on the Learn tab on the home page Start by selecting the subject you d like to explore This will expand the side menu displaying subtopics within that subject The icons to the left of the menu selections describe whether or not it is a video an exercise or a menu
66. serve the correct input output characteristics Hence it is important that we write tests that guarantee that our methods either take the correct input and produce the right output or as is often the case produce the right side effects on models views or the DOM In pursuit of this lofty goal of having every method and object testable and tested there will be some requirements of refactoring along the way Some of the code that has already been written for the KA Lite project is not conveniently parcelled in such a way as to be conducive to testing individual components in an atomic fashion In order to ensure that functionality does not break as a result we have integration tests which are currently only implemented using Selenium scripted by Python for now we are avoiding writing such integration tests in Javascript as well so as to avoid duplication 68 Chapter 6 Developer Docs KA Lite Documentation Release 0 6 5 2 Setting up your Test Environment 1 Install requirements e install node if you don t have it already e install pip if you don t have it already 2 Install the dependencies listed in requirements txt pip install r requirements txt 3 Install the dependencies listed in packages json sudo npm install 6 5 3 Getting Your Javascript to be Testable in KA Lite Before you can test your javascript it must be capable of being bundled in such a way that django compress the asset compression package we use is able
67. sful installation of KA Lite the terminal should give you a command to copy It will look something like the following PATH TO KALITE bin kalite start The first string will vary depending on which folder you installed KA Lite in Simply copy and paste the provided string back into the command prompt and hit enter on your keyboard You will be asked whether or not you wish to run the KA Lite server in the background automatically every time you start up the computer Once you answer yes or no success The KA Lite server is now running on your computer During the process your operating system might prompt you to allow Python app to accept incoming connections The message dialogue may look like the following depending on your operating system Do you want the application Python app to accept incoming network connections Clicking Deny may limit the application s behavior This setting can be changed in the Firewall pane of Security amp Privacy preferences Den Allow Please allow the app to run This will make it possible for the KA Lite application to be accessible 2 1 3 Accessing KA Lite Once the server has been started you will be given a few IP addresses You can use these addresses to access KA Lite by copying and pasting them into a web browser of your choice In order to access KA Lite from another machine please enter the IP address that does not start with http 127 0 0 1 8008 into the we
68. steps 3 Write code that makes your tests pass In practice at least try to specify the tests first Then you can seek out assistance implementing the steps 6 6 4 Selenium gotchas aka race conditions Finding elements on the page can be subject to race conditions if the page is not yet completely loaded or if the DOM changes in response to AJAX stuff Selenium pprovides methods for finding elements with and without explicit waits When in doubt use a wait If your app is AJAX y write testable code by putting in events or flags that Selenium can explicitly wait for The Selenium get method of browsing will wait for the page to fully load Do not assume that following links using e g the click method will wait for the page to load it does not To summarize 1 Incorporate explicit flags in your code that Selenium can use in waits 2 Don t use unsafe methods that don t wait unless you re 100 certain there s no possibility for a race condition 6 7 Profiling KA Lite 6 7 1 Getting a general overview of resources used To get a sense of the resources used by KA Lite over a period of time run the kalite command with the PROFILE environment variable PROFILE yes kalite lt command gt Upon normal exit the program will write to a file called memory_profile log containing the time and resource utiliza tion For now we only log memory usage 6 8 Developer Utility Commands 6 8 1 Django Management Commands All
69. t 1 and 2 can be the same computer with the browser connecting to the locally running KA Lite server software To make the software accessible to multiple client devices you will need to put them on the same local network as the KA Lite device 1 e g through a router 3 12 What sort of processing power is required for KA Lite KA Lite has very low processing requirements and can be run as a server on devices with processors as low powered as the 35 Raspberry Pi using about 100MB of RAM There is also low processing power required for client devices as well and any browser that supports HTMLS video with h264 encoding or Flash Player should be able to function as a client device 3 13 What are the operating system OS and software requirements for running KA Lite KA Lite can run on almost any major operating system Windows Linux and Mac OSX The only software depen dency is the Python 2 7 runtime 3 14 What is data syncing KA Lite is capable to share your student progress data with a central data repository when you are online This enables the system to have an online backup of your data allows you to view your student progress online and to share your data across multiple KA Lite installations 3 15 Does KA Lite support peer to peer synchronization Not yet Peer to peer sync is a priority for KA Lite in the near future but is not available yet 3 10 What are the typical deployment scenarios 57 Lite Documentat
70. t works just as well for any other Debian based systems like Debian Raspberry Pi Linux Mint etc Lite Documentation Release 0 1 3 3 Configuration after installing updating Every time you install or update kalite you should re run kalite manage setup to setup the database and download assessment items video descriptions exercises etc 1 4 Linux Installing as a package To install KA Lite from a file go to our PyPi page and download a tar gz or zip You can then install the file from a system by unpacking it and running python setup py install or pip install ka lite static X Y Z tar gz Alternatively install with pip using the instructions below Note Type the following commands in a terminal 1 Install pip Ubuntu sudo apt get install python pip 2 Recommended essential on slower platforms like Raspberry Pi Install M2Crypto sudo apt get install python m2crypto 3 Run sudo pip install ka lite static bundled dependencies or sudo pip install ka lite normal pip behaviour dependencies installed to host system 4 Run kalite manage setup For more tips see advanced installation 1 4 1 Configuration after installing updating Every time you install or update kalite you should re run kalite manage setup to setup the database and download assessment items video descriptions exercises etc 1 5 Uninstalling You can remove KA Lite when installed from pip or source distribution with
71. ted it you will be sent an activation link via the email address you supplied 2 1 5 Post Registration Setup Now that you have registered successfully it s time to configure your local KA Lite installation to suit your needs If any terms like facility or device become confusing feel free to reference the Administrator Glossary for a quick reminder 2 1 6 Create a Facility KA Lite assumes that you are going to be using the software primarily in one place This could be a school a home a community center etc We call this place a facility and use it to help differentiate users who are syncing back data with our central data hub In order to create a facility follow the steps below 1 Log in to KA Lite 2 Click the Manage tab at the top of the page 18 Chapter 2 User Manual KA Lite Documentation Release 0 LITE Topic video exercise MANAGE LEARN ADMIN A free world class education for anyone anywhere KA Lite is a light weight web server for viewing and interacting with core Khan Academy content videos and exercises without needing an Internet connection KA Lite version 0 14 0 2015 Videos 2015 Khan Academy Creative Commons Exercises 2015 Khan Academy EY NC SA 3 Make sure that the Facilities tab is selected 4 Under the Facilities section click on Add a new facility 2 1 Admininistrator User Manual 19 KA Lite Documentation Rele
72. to tell KA Lite where to find them If this is the case follow the steps below 1 Make sure all video files are located in a single directory with mp4 extensions KA Lite expects this 2 In a text editor open up kalite settings py on Windows locate C Users lt username gt kalite 3 Add the line CONTENT _ROOT full path to your videos directory making SURE to include an OS spe For example on Windows CONTENT_ROOT C torrented_videos_location For example on Linux CONTENT ROOT home me torrented videos location 4 Restart your server If you are unsure on how to do this please see Restarting Your Server Adding assessment items exercises If you skipped the step for adding assessment items during install run the following command beware it can take a while the download size is over 500 MB kalite manage unpack assessment zip https learningequality org downloads ka lite 0 14 co f As alternative you can download the zip file from https learningequality org downloads ka lite O 14 content assessment zip and run the command on your local copy This is useful if you re deploying KA Lite on multiple computers 2 1 11 Language Packs KA Lite supports internationalization You can download language packs for your language if it is available A language pack comes with all the available subtitles and user interface translations for that language When it is installed KA Lite will give you the optio
73. to write it to a Javascript file which can then be loaded by the Javascript test runner karma In order to make this happen use compression tags around blocks of Javascript script imports inside django templates for example from learn html compress js file learnjs lt if IE gt ee script sre 4 static Video js7 video Js gt lt script gt lt script src static yvideo j s video sSpeed J s 2 soript socr lpt V options flash swf window flash swf scecID lt lt endif gt script static soundmanager soundmanager2 nodebug jsmin js gt lt script gt script src static js distributed content models js gt lt script gt script Src static Jjs distributed content views s 5 soript script src static js distributed video models js gt lt script gt script src static qs distributed video views s 5 scoript script src static js distributed audio views js gt lt script gt Script Src S statio 77657 query slimscroll min js gt lt script gt lt script src static js distributed topics models js gt lt script gt script src static js distributed topics views js gt lt script gt lt SCript srosS static gs distributed topics router s 9 scoript endcompress You will also need to inclue the tag load compress at the top of a template in or
74. ttings In a text editor open up kalite settings py on Windows locate C Users lt username gt kalite That file is where you should put your custom settings and KA Lite will load them automatically You can also run the kalite with a completely different Python settings module by specifying kalite command settings my settings module Changing base settings By default kalite settings py will load kalite project settings base which are the basic settings But you can also load Raspberry Pi settings by changing the file to read something like 46 Chapter 2 User Manual KA Lite Documentation Release 0 2 1 15 Available settings Most common settings DEBUG True or False default False Enables debug mode In case you run into technical issues enable this setting before troubleshooting reporting e CONTENT ROOT lt path to desired content folder gt default ka lite content This is the path that KA Lite will use to look for KA Lite video files to play Change the path to another local directory to get video files from that directory NB Directory has to be writable for the user running the server in order to download videos e TIME ZONE desired time zone default America Los Angeles You can set this to be the local time zone for your installation Choices can be found here e LANGUAGE CODE lt desired ISO 639 1 Language Code gt default en us You can set this to the
75. uggling The student is struggling on the subtopic Completed The student has completed the subtopic Detailed View 1 Click on the colored cells 2 A panel should open up below the cell to reveal the number of questions attempted and the actions made on each exercise 3 Click on the same cell to close the panel 2 3 Learner User Manual Who is a learner Anyone who uses KA Lite primarily for learning Learner accounts will track individual progress through videos and exercises and learners will only be allowed to view their own data 2 3 1 Accessing KA Lite There are two ways KA Lite can be used 1 Set up on a network with one main server having machines connect to this server If this is the setup chosen installation is not necessary on a learner s computer as it can be accessible through a web browser with the IP address of the server Simply copy and paste the server s IP address into your web browser any time you d like to access KA Lite If you are unsure what the address is please contact your administrator 50 Chapter 2 User Manual KA Lite Documentation Release 0 2 Installed for single user on one machine If you are not accessing KA Lite through a network or wish to run KA Lite on your own computer please follow the KA Lite Installation Guides first before proceeding with this user manual Once you have done so copy and paste the URL given during the installation process into a web brow
76. ur database You will also be prompted to download an assessment items package or to specify the location if you have already downloaded it If you wish to download the package and specify the location during the setup process 8 Chapter 1 KA Lite Installation Guides KA Lite Documentation Release 0 Download the assessment items package here Save it in the same folder as the setup script e During the setup process you will see the prompt Do you wish to download the assessment items package now Type no and press enter to continue You will then see the prompt Have you already downloaded the assessment items package Type and press enter Finally you will see a prompt that begins with Please enter the filename of the assessment items package you have downloaded A recommened file may appear in parentheses if this is the file you downloaded then press enter Otherwise enter the name of the file you downloaded Absolute paths are okay as are paths relative to the directory you are running the setup script from Windows Warning Internet Explorer 8 is no longer supported in this version Please use a newer browser or stick to version 0 12 to maintain compatibility Raspberry Pi If you re updating a current Raspberry Pi installation make sure to put this in your local_settings py to avoid slow performance DO NOT RELOAD CONTENT CACHE AT STARTUP True 1 10 Supported Browsers K
77. use to render the page in the case of a coach report for example this might be data about each student Backbone Collections are groups of Models so you might have a Collection where each model represents the progress data for an individual student The Views define how this data is displayed in the browser and also defines responses to user interaction to the current display Most Views also have an associated Handlebars template which defines the HTML and how the data passed into the template is displayed in the rendered View Often the data contained in a Backbone Model can change while the user is still on the same page for example a student s total points can change while they are interacting with an exercise so we want their displayed points to update whenever the points attribute of the model updates too Here is an example of a Backbone View in KA Lite that does just that var TotalPointView Backbone View extend initialize f unction 65 Lite Documentation Release 0 _bindAl this this listenTo this model change points this render this render render function var points this model get points var message null only display the points if they are greater than zero and the user is logged if this model get is logged in return message sprintf gettext Points points d points points this Sel html message this Sel show
78. ut raw records of every login These raw data are not synced but are kept on your local machine only there s too many of them Currently we have no specific report to view these data though we may have for v0 10 1 USER LOG SUMMARY FREQUENCY desired frequency in the following format number amount of time default 1 months This determines the granularity of how we summarize and store user log data One database row is kept for each student on each KA Lite installation for the defined time period Acceptable values 1 months 2 months 3 months 6 months separate logged data for every month 2 months 3 months or 6 months respectively 1 weeks separate logged data for every week NOTE THIS MAY PRODUCE A LOT OF DATA e SYNC SESSIONS MAX RECORDS desired max records of sync sessions default 10 Every time your installation syncs data we record the time of the sync the of successful logs that were uploaded and downloaded and any failures This setting is how many such records we keep on your local server for display When you log in to our online server you will see a full history of these records 2 1 Admininistrator User Manual 47 Lite Documentation Release 0 Optimization of storage and system load CRONSERVER_FREQUENCY lt desired frequency of cronserver to run in seconds gt default 10 minutes This is how frequently KA Lite tries to synchron
79. w group Learners Change Learner Groups M Delete Learners Learner Name Edit Coach Group Logins Login Time Videos Viewed Exercises Completed Mastery Fodder Cannon d 0 0 hour s 0 0 0 0 Add a new learner HININ ATION COR CARN NG Eal FC J DA fil FOR LEA 13 ING E QU i 7 ALITY KA Lite version 0 14 0 2015 Videos 2015 Khan Academy Creative Commons Exercises 2015 Khan Academy EY NC Sh 6 You will be redirected to a page that says Add a new coach Fill in all the information The facility dropdown defaults to the facility you selected in the previous steps 7 Click the Create User button 28 Chapter 2 User Manual KA Lite Documentation Release 0 LITE Topic video exercise Hg LEARN ADMIN Facilities Videos Add a new coach Facility Silly Facility 1781 v Username First Name Last Name Password Confirm password Default Language English v Create user KA Lite version 0 14 0 2015 Videos 2015 Khan Academy Creative Commons Exercises 2015 Khan Academy Ba 8 If the user was successfully created the page will reload with a message indicating that you have created the user Permanently Deleting Coaches 1 Log in to KA Lite 2 Click on the Manage tab at the top of the page 3 Make sure that the Facilities tab is selected 4 Under the Faci

Download Pdf Manuals

Related Search

Related Contents

78K/II SERIES 8-BIT SINGLE-CHIP UM  取扱説明書  Latitude D830 User`s Guide  Super Head Bore Up KIT 取扱説明書  

Copyright © All rights reserved. Failed to retrieve file