From 3970ea33e19c0ac448242ccfbf15657f8573d203 Mon Sep 17 00:00:00 2001
From: Arthur Barrett <abarrett@edx.org>
Date: Thu, 21 Feb 2013 22:54:50 -0500
Subject: [PATCH] return from capa problem

---
 .../capa/capa/templates/annotationinput.html  |  6 +-
 .../lib/xmodule/xmodule/annotatable_module.py |  2 -
 .../lib/xmodule/xmodule/css/capa/display.scss |  6 +-
 .../xmodule/js/src/annotatable/display.coffee | 67 +++++++++++--------
 4 files changed, 48 insertions(+), 33 deletions(-)

diff --git a/common/lib/capa/capa/templates/annotationinput.html b/common/lib/capa/capa/templates/annotationinput.html
index f3c560f741..eb136766f6 100644
--- a/common/lib/capa/capa/templates/annotationinput.html
+++ b/common/lib/capa/capa/templates/annotationinput.html
@@ -1,8 +1,8 @@
 <form class="annotation-input">
 <div class="script_placeholder" data-src="/static/js/capa/annotationinput.js"/>
 
-<div class="header">${title}</div>
-<div class="body">
+<div class="annotation-header">${title}</div>
+<div class="annotation-body">
     <div class="prompt prompt-text">${text}</div>
     <div class="prompt">${comment_prompt}</div>
     <textarea id="input_${id}_comment" name="input_${id}_comment"/>
@@ -28,6 +28,8 @@
     <span class="incorrect" id="status_${id}"></span>
     % endif
     </div>
+
+    <a class="annotation-return" href="javascript:void(0)">Return to Annotation</a><br/>
 </div>
 </form>
 
diff --git a/common/lib/xmodule/xmodule/annotatable_module.py b/common/lib/xmodule/xmodule/annotatable_module.py
index a715e302e0..15d1b5d5a0 100644
--- a/common/lib/xmodule/xmodule/annotatable_module.py
+++ b/common/lib/xmodule/xmodule/annotatable_module.py
@@ -69,8 +69,6 @@ class AnnotatableModule(XModule):
                 html_key = attrs_map[xml_key]
                 data_attrs[html_key] = { 'value': value, '_delete': xml_key }
 
-        data_attrs['data-span-id'] = { 'value': str(index) }
-
         return data_attrs
 
     def _render_content(self):
diff --git a/common/lib/xmodule/xmodule/css/capa/display.scss b/common/lib/xmodule/xmodule/css/capa/display.scss
index cea86716b5..881e8e5cf6 100644
--- a/common/lib/xmodule/xmodule/css/capa/display.scss
+++ b/common/lib/xmodule/xmodule/css/capa/display.scss
@@ -809,12 +809,14 @@ section.problem {
     border: 1px solid #ccc;
     border-radius: 1em;
     margin: 0 0 1em 0;
-    .header {
+    .annotation-header {
       font-weight: bold;
       border-bottom: 1px solid #ccc;
       padding: .5em 1em;
     }
-    .body { padding: .5em 1em; }
+    .annotation-body { padding: .5em 1em; }
+    .annotation-return { float: right; }
+    .annotation-return:after { content: " \2191" }
     .prompt { font-style: italic; }
     .prompt.prompt-text {
       padding: .5em;
diff --git a/common/lib/xmodule/xmodule/js/src/annotatable/display.coffee b/common/lib/xmodule/xmodule/js/src/annotatable/display.coffee
index 9714ac4437..fb1f774a55 100644
--- a/common/lib/xmodule/xmodule/js/src/annotatable/display.coffee
+++ b/common/lib/xmodule/xmodule/js/src/annotatable/display.coffee
@@ -6,8 +6,10 @@ class @Annotatable
     spanSelector:    '.annotatable-span'
     replySelector:   '.annotatable-reply'
     helpSelector:    '.annotatable-help-icon'
-    returnSelector:  '.annotatable-return'
+
+    problemXModuleSelector: '.xmodule_CapaModule'
     problemSelector: 'section.problem'
+    problemReturnSelector:  'section.problem .annotation-return'
 
     discussionXModuleSelector: '.xmodule_DiscussionModule'
     discussionSelector:        '.discussion-module'
@@ -26,24 +28,38 @@ class @Annotatable
         @initDiscussion()
 
     initEvents: () ->
+        # For handling hide/show of annotations
         @annotationsHidden = false
         @$(@toggleSelector).bind 'click', @onClickToggleAnnotations
-        @$(@wrapperSelector).delegate @replySelector, 'click', @onClickReply
-        $(@discussionXModuleSelector).delegate @returnSelector, 'click', @onClickReturn
 
-    initDiscussion: () ->
-        1
+        # For handling 'reply to annotation' events that scroll to the associated capa problem.
+        # These are contained in the tooltips, which should be rendered somewhere in the wrapper
+        # (see the qtip2 options, this must be set explicitly, otherwise they render in the body).
+        @$(@wrapperSelector).delegate @replySelector, 'click', @onClickReply
+
+        # This is a silly hack, but it assumes two things:
+        #   1) There are annotationinput capa problems rendered on the page
+        #   2) Each one has its an embedded "return to annotation" link.
+        # The capa problem's html is injected via AJAX so this just sets a listener on the body and
+        # handles the click event there.
+        $('body').delegate @problemReturnSelector, 'click', @onClickReturn
+
+    initDiscussion: () -> 1
   
     initTips: () ->
         @savedTips = []
-        @$(@spanSelector).each (index, el) => $(el).qtip(@getTipOptions el)
+
+        # Adds a tooltip to each annotation span to display the instructor prompt
+        @$(@spanSelector).each (index, el) =>
+            $(el).qtip(@getTipOptions el)
+
         @$(@helpSelector).qtip
             position:
                 my: 'right top'
                 at: 'bottom left'
                 container: @$(@wrapperSelector)
             content:
-                title: 'Annotated Reading'
+                title: 'Instructions'
                 text: true # use title attribute of this element
 
     getTipOptions: (el) ->
@@ -79,32 +95,32 @@ class @Annotatable
         e.preventDefault()
         offset = -20
         el = @getProblem e.currentTarget
-        @scrollTo(el, @afterScrollToProblem, offset)
+        if el.length > 0
+            @scrollTo(el, @afterScrollToProblem, offset)
+        else
+            console.log('problem not found. event: ', e) if @_debug
 
     onClickReturn: (e) =>
         e.preventDefault()
         offset = -200
-        el = @getSpan e.currentTarget
-        @scrollTo(el, @afterScrollToSpan, offset)
+        el = @getSpanForProblemReturn e.currentTarget
+        if el.length > 0
+            @scrollTo(el, @afterScrollToSpan, offset)
+        else
+            console.log('span not found. event:', e) if @_debug
 
-    getSpan: (el) ->
-        span_id = @getSpanId(el)
-        @$(@spanSelector).filter("[data-span-id='#{span_id}']")
+    getSpanForProblemReturn: (el) ->
+        problem_id = $(@problemReturnSelector).index(el)
+        @$(@spanSelector).filter("[data-problem-id='#{problem_id}']")
 
     getProblem: (el) ->
-        problem_id = parseInt(@getProblemId(el), 10)
-        if isNaN(problem_id)
-            console.log 'invalid problem identifier' if @_debug
-            return $()
-        return $(@problemSelector).eq(problem_id - 1)
+        problem_id = @getProblemId(el)
+        $(@problemSelector).eq(problem_id)
     
     getDiscussion: () ->
         discussion_id = @getDiscussionId()
         $(@discussionXModuleSelector).find(@discussionSelector).filter("[data-discussion-id='#{discussion_id}']")
 
-    getSpanId: (el) ->
-        $(el).data('span-id')
-
     getProblemId: (el) ->
         $(el).data('problem-id')
         
@@ -136,7 +152,7 @@ class @Annotatable
             duration: 500
             onAfter: @_once => after?.call this, el
             offset: offset
-        }) if el
+        }) if $(el).length > 0
  
     afterScrollToDiscussion: (discussion_el) ->
         btn = $('.discussion-show', discussion_el)
@@ -151,7 +167,7 @@ class @Annotatable
     makeTipContent: (el) ->
         (api) =>
             text = $(el).data('comment-body')
-            comment = @createCommentEl(text)
+            comment = @createComment(text)
             problem_id = @getProblemId(el)
             reply = @createReplyLink(problem_id)
             $(comment).add(reply)
@@ -161,15 +177,12 @@ class @Annotatable
             title = $(el).data('comment-title')
             (if title then title else 'Commentary')
 
-    createCommentEl: (text) ->
+    createComment: (text) ->
         $("<div class=\"annotatable-comment\">#{text}</div>")
 
     createReplyLink: (problem_id) ->
         $("<a class=\"annotatable-reply\" href=\"javascript:void(0);\" data-problem-id=\"#{problem_id}\">Reply to Annotation</a>")
 
-    createReturnLink: (span_id) ->
-        $("<a class=\"annotatable-return\" href=\"javascript:void(0);\" data-span-id=\"#{span_id}\">Return to annotation</a>")
-
     openSavedTips: () ->
         @showTips @savedTips