Skip to content
This repository was archived by the owner on Apr 2, 2023. It is now read-only.

Developers

Jump to bottom
Rainer Simon edited this page Oct 11, 2012 · 31 revisions

Developers

We're using Google's Closure Tools. I recommend using the plovr build tool to get started quickly. (Plovr requires Java to be installed on your system.)

  • Run java -jar plovr/plovr.jar serve standalone.json and open index_standalone.html to run the Yuma2 standalone version
  • Run java -jar plovr/plovr.jar serve okfn_plugin.json and open index_okfn.html to run Yuma2 as an OKFN Annotator plugin
  • To build the minified JavaScript, run java -jar plovr/plovr.jar build standalone.json > yuma2.min.js (or java -jar plovr/plovr.jar build okfn_plugin.json > yuma2.min.js), replacing 'yuma2.min.js' with a file name of your choice
  • Note: the version of plovr I included in this repository is the February 2012 release (plovr-4b3caf2b7d84.jar).

TODOs (almost in order of priority...)

  • Find a decent name for this tool!
  • Attach storage according to [OKFN Annotator Store](http://github.com/okfn/annotator/wiki/Storage protocol)
  • Expose the most relevant JS methods to the outside world: addAnnotation, removeAnnotation, addHandler, new ImageAnnotator(image)
  • Should we add the stylesheet via JS? Would make Yuma integration a 1-liner!
  • Make Yuma2 work on pages with dynamically loaded images (e.g. image carousels)
  • Editing existing annotations
  • Make selection move/resizable after it is created
  • OpenLayers and/or Seadragon AJAX support
  • Make soft fade effects work on Internet Explorer
  • Implement Point and Polygon shape selection
  • Implement freehand draw selection
  • Add support for the toponym selection tool
  • Make MOUSE_OVER/OUT_OF_ANNOTATABLE_MEDIA events fire properly DONE
  • Refactor 'Popup' into separate class DONE
  • Clean up the OKFN Annotator plugin implementation (needs to work in ADVANCED COMPILATION mode DONE
  • Support lazy loading of image annotation overlays DONE
  • Make Yuma2 work on pages with multiple images DONE
  • Make Yuma2 work on pages with floating/flexible layouts DONE
  • Deleting existing annotations DONE
  • Create an OKFN Annotator Plugin wrapper DONE (but very alpha)
  • Change the way activation works: activation no longer via JavaScript but via a CSS class DONE
  • Popup annotation text bubble DONE (but needs some style)
  • Popup annotation create/edit form DONE (but needs some style)
  • Clean up namespacing (it's a bit messy after the last refactoring) DONE
  • Central event bus/event broker to keep code tidy DONE (but needs fix to work with multiple annotatable images!)
  • Custom mouseover/mouseout events for annotation shapes DONE
Clone this wiki locally