Skip to content
Joshua Monson edited this page Aug 7, 2013 · 11 revisions

Most of the project's code is JavaScript. All JavaScript, CSS, images, fonts, and other static assets are stored under the public folder.

External Repositories

It uses several JavaScript repositories, which are:

Each of these repositories should be under the public folder.

Libraries

The JavaScript libraries are stored in the javascripts/libraries folder. These include

JavaScript files

Apart from the external repositories, the JavaScript code is under the public/javascripts folder.

Annotating

There are six scripts that deal with annotating. They are located under the javascripts/annotating folder.

  • AnnotationLoader.js - Creates an AnnotationManifest from JSON.
  • AnnotationManifest.js - A container for annotations
  • ImageAnnotation.js - A single annotation for an image
  • ImageAnnotator.js - A module which annotates images
  • TextAnnotation.js - A single annotation for text
  • TextAnnotator.js - A module which annotates text

Annotation Editing

There are four scripts that deal with annotation editing. They are located under the javascripts/annotationEditing folder.

  • annotationEditing.js - The page script for the annotation editor.
  • AnnotationImageEditor.js - The annotation editor for images
  • AnnotationPopupEditor.js - The popup editor for editing annotation content.
  • AnnotationTextEditor.js - The annotation editor for text

Content Rendering

There are nine scripts that deal with content rendering. These are located under the javascripts/contentRendering folder.

  • ContentCache.js
  • ContentLayoutManager.js
  • ContentRenderer.js
  • ContentThumbnails.js
  • ImageRenderer.js
  • QuestionSetRenderer.js
  • TextRenderer.js
  • TranscriptPlayer2.js
  • VideoRenderer.js

Content Browsing and Selecting

There are three scripts that deal with listing and selecting content. They are located under javascripts/contentSelection.

  • ContentItemRenderer.js
  • PopupBrowser.js
  • PopupLabelBrowser.js

Form fixes

There are four scripts that deal with improving HTML forms. They are located under javascripts/formFixes.

  • dragDropBinder.js
  • fileFix.js
  • labelsInput.js
  • superselect.js

PlayGraph

These two JavaScript files deal with the playback and authoring of PlayGraphs (or playlists as they are called on the site). They are located under javascripts/playGraph.

  • player.js
  • widgets.js

Translation

There are five scripts that deal with translation. They are located under javascripts/Translate.js.

  • ArcliteTranslationEngine.js
  • GoogleTranslationEngine.js
  • TextTranslator.js
  • TranslationEngine.js
  • WordReferenceTranslationEngine.js

Page specific scripts

There are several JavaScript files which are used for giving a specific page certain functionality. These scripts are located under javascripts/pageScripts

  • addRelatedDocs.js - This deals the with the pop-up windows for caption tracks and annotation sets.
  • captionAider.js - This deals with connecting all the pieces and parts of CaptionAider
  • fileUpload.js - This deals with the page where the user can upload a file to create content.
  • index.js - This deals with the index/login page.
  • viewCourse.js - This deals with the course page.

Other scripts

Other scripts are located directly under the javascripts folder.

  • ActivityStreams.js
  • BoxDrawingCanvas.js
  • ContentSettings.js
  • ImageEditor.js
  • ScreenAdapter.js
  • SettingsForm.js
  • TemplateEngine.js