7e2652b5a8
First set of fixes from the pull request This does not include some of the testing files. The textannotation and videoannotation test files are not ready. waiting for an answer on the issue. Deleted token line in api.py and added test for token generator Added notes_spec.coffee remove spec file fixed minor error with the test fixes some quality errors fixed unit test fixed unit test added advanced module Added notes_spec.coffee remove spec file Quality and Testing Coverage 1. in test_textannotation.py I already check for line 75 as it states in the diff in line 43, same with test_videoanntotation 2. Like you said, exceptions cannot be checked for firebase_token_generator.py. The version of python that is active on the edx server is 2.7 or higher, but the code is there for correctness. Error checking works the same way. 3. I added a test for student/views/.py within tests and deleted the unused secret assignment. 4. test_token_generator.py is now its own file Added Secret Token data input fixed token generator Annotation Tools in Place The purpose of this pull request is to install two major modules: (1) a module to annotate text and (2) a module to annotate video. In either case an instructor can declare them in advanced settings under advanced_modules and input content (HTML in text, mp4 or YouTube videos for video). Students will be able to highlight portions and add their comments as well as reply to each other. There needs to be a storage server set up per course as well as a secret token to talk with said storage. Changes: 1. Added test to check for the creation of a token in tests.py (along with the rest of the tests for student/view.py) 2. Removed items in cms pertaining to annotation as this will only be possible in the lms 3. Added more comments to firebase_token_generator.py, the test files, students/views.py 4. Added some internationalization stuff to textannotation.html and videoannotation.html. I need some help with doing it in javascript, but the html is covered. incorporated lib for traslate fixed quality errors fixed my notes with catch token Text and Video Annotation Modules - First Iteration The following code-change is the first iteration of the modules for text and video annotation. Installing Modules: 1. Under “Advanced Settings”, add “textannotation” and “videoannotation” to the list of advanced_modules. 2. Add link to an external storage for annotations under “annotation_storage_url” 3. Add the secret token for talking with said storage under “annotation_token_secret” Using Modules 1. When creating new unit, you can find Text and Video annotation modules under “Advanced” component 2. Make sure you have either Text or Video in one unit, but not both. 3. Annotations are only allowed on Live/Public version and not Studio. Added missing templates and fixed more of the quality errors Fixed annotator not existing issue in cmd and tried to find the get_html() from the annotation module class to the descriptor Added a space after # in comments Fixed issue with an empty Module and token links Added licenses and fixed vis naming scheme and location.
107 lines
4.1 KiB
Python
107 lines
4.1 KiB
Python
''' Text annotation module '''
|
|
|
|
from lxml import etree
|
|
from pkg_resources import resource_string
|
|
|
|
from xmodule.x_module import XModule
|
|
from xmodule.raw_module import RawDescriptor
|
|
from xblock.core import Scope, String
|
|
|
|
import textwrap
|
|
|
|
|
|
class AnnotatableFields(object):
|
|
"""Fields for `TextModule` and `TextDescriptor`."""
|
|
data = String(help="XML data for the annotation", scope=Scope.content, default=textwrap.dedent("""\
|
|
<annotatable>
|
|
<instructions>
|
|
<p>
|
|
Add the instructions to the assignment here.
|
|
</p>
|
|
</instructions>
|
|
<p>
|
|
Lorem ipsum dolor sit amet, at amet animal petentium nec. Id augue nemore postulant mea. Ex eam dicant noluisse expetenda, alia admodum abhorreant qui et. An ceteros expetenda mea, tale natum ipsum quo no, ut pro paulo alienum noluisse.
|
|
</p>
|
|
</annotatable>
|
|
"""))
|
|
display_name = String(
|
|
display_name="Display Name",
|
|
help="Display name for this module",
|
|
scope=Scope.settings,
|
|
default='Text Annotation',
|
|
)
|
|
tags = String(
|
|
display_name="Tags for Assignments",
|
|
help="Add tags that automatically highlight in a certain color using the comma-separated form, i.e. imagery:red,parallelism:blue",
|
|
scope=Scope.settings,
|
|
default='imagery:red,parallelism:blue',
|
|
)
|
|
source = String(
|
|
display_name="Source/Citation",
|
|
help="Optional for citing source of any material used. Automatic citation can be done using <a href=\"http://easybib.com\">EasyBib</a>",
|
|
scope=Scope.settings,
|
|
default='None',
|
|
)
|
|
annotation_storage_url = String(help="Location of Annotation backend", scope=Scope.settings, default="http://your_annotation_storage.com", display_name="Url for Annotation Storage")
|
|
|
|
|
|
class TextAnnotationModule(AnnotatableFields, XModule):
|
|
''' Text Annotation Module '''
|
|
js = {'coffee': [],
|
|
'js': []}
|
|
css = {'scss': [resource_string(__name__, 'css/annotatable/display.scss')]}
|
|
icon_class = 'textannotation'
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
super(TextAnnotationModule, self).__init__(*args, **kwargs)
|
|
|
|
xmltree = etree.fromstring(self.data)
|
|
|
|
self.instructions = self._extract_instructions(xmltree)
|
|
self.content = etree.tostring(xmltree, encoding='unicode')
|
|
self.highlight_colors = ['yellow', 'orange', 'purple', 'blue', 'green']
|
|
|
|
def _render_content(self):
|
|
""" Renders annotatable content with annotation spans and returns HTML. """
|
|
xmltree = etree.fromstring(self.content)
|
|
if 'display_name' in xmltree.attrib:
|
|
del xmltree.attrib['display_name']
|
|
|
|
return etree.tostring(xmltree, encoding='unicode')
|
|
|
|
def _extract_instructions(self, xmltree):
|
|
""" Removes <instructions> from the xmltree and returns them as a string, otherwise None. """
|
|
instructions = xmltree.find('instructions')
|
|
if instructions is not None:
|
|
instructions.tag = 'div'
|
|
xmltree.remove(instructions)
|
|
return etree.tostring(instructions, encoding='unicode')
|
|
return None
|
|
|
|
def get_html(self):
|
|
""" Renders parameters to template. """
|
|
context = {
|
|
'display_name': self.display_name_with_default,
|
|
'tag': self.tags,
|
|
'source': self.source,
|
|
'instructions_html': self.instructions,
|
|
'content_html': self._render_content(),
|
|
'annotation_storage': self.annotation_storage_url
|
|
}
|
|
|
|
return self.system.render_template('textannotation.html', context)
|
|
|
|
|
|
class TextAnnotationDescriptor(AnnotatableFields, RawDescriptor):
|
|
''' Text Annotation Descriptor '''
|
|
module_class = TextAnnotationModule
|
|
mako_template = "widgets/raw-edit.html"
|
|
|
|
@property
|
|
def non_editable_metadata_fields(self):
|
|
non_editable_fields = super(TextAnnotationDescriptor, self).non_editable_metadata_fields
|
|
non_editable_fields.extend([
|
|
TextAnnotationDescriptor.annotation_storage_url
|
|
])
|
|
return non_editable_fields
|