From c8bdc1ab660dd98985988456799051d9ef39f58d Mon Sep 17 00:00:00 2001 From: Arthur Date: Tue, 14 May 2013 12:42:26 -0300 Subject: [PATCH] update readme --- lms/djangoapps/notes/README.md | 44 +++++++++++++++++++++++++++++----- 1 file changed, 38 insertions(+), 6 deletions(-) diff --git a/lms/djangoapps/notes/README.md b/lms/djangoapps/notes/README.md index 5d44676972..2e81fa5ec1 100644 --- a/lms/djangoapps/notes/README.md +++ b/lms/djangoapps/notes/README.md @@ -1,17 +1,17 @@ Notes Django App -================= +================ This is a django application that stores and displays notes that students make while reading static HTML book(s) in their courseware. Note taking functionality in the static HTML book(s) is handled by a wrapper script around [annotator.js](http://okfnlabs.org/annotator/), which interfaces with the API provided by this application to store and retrieve notes. Usage ----- -To use this application, course staff must *opt-in* by doing the following: +To use this application, course staff must opt-in by doing the following: -# Login to (http://studio.edx.org/)[Studio]. -# Go to *Course Settings* -> *Advanced Settings* -# Find the ```advanced_modules``` policy key and in the policy value field, add ```"notes"``` to the list. -# Save the course settings. +* Login to [Studio](http://studio.edx.org/). +* Go to *Course Settings* -> *Advanced Settings* +* Find the ```advanced_modules``` policy key and in the policy value field, add ```"notes"``` to the list. +* Save the course settings. The result of following these steps is that you should see a new tab appear in the courseware named *My Notes*. This will display a journal of notes that the student has created in the static HTML book(s). Second, when you highlight text in the static HTML book(s), a dialog will appear. You can enter some notes and tags and save it. The note will appear highlighted in the text and will also be saved to the journal. @@ -23,3 +23,35 @@ To disable the *My Notes* tab and notes in the static HTML book(s), simply rever * Sharing and replying to notes is not supported. * The student *My Notes* interface is very limited. * There is no instructor interface to view student notes. + +Developer Overview +------------------ + +### Quickstart + +``` +$ rake django-admin[syncdb] +$ rake django-admin[migrate] +``` + +Then follow the steps above to enable the *My Notes* tab or manually add a tab to the policy tab configuration with ```{"type": "notes", "name": "My Notes"}```. + +### App Directory Structure: + +lms/djangoapps/notes: + +* api.py - API used by annotator.js on the frontend +* models.py - Contains note model for storing notes +* tests.py - Unit tests +* views.py - View to display the journal of notes (i.e. *My Notes* tab) +* urls.py - Maps the API and View routes. +* utils.py - Contains method for checking if the course has this app enabled. Intended to be public to other modules. + +Also requires: + +* lms/static/coffee/src/notes.coffee -- wrapper around annotator.js +* lms/templates/notes.html -- used by views.py to display the notes + +Interacts with: + +* lms/djangoapps/staticbook - the html static book checks to see if notes is enabled and has some logic to enable/disable accordingly