autoEdit 2 Documentation
1.0.13
1.0.13
  • Introduction
  • Overview
    • Intro
      • Development approach
      • from 1.0.5 to 1.0.6
    • Architecture Overview
      • Lo fi Design Sketches
      • High fidelity sketches in HTML
    • Support the project
    • documentation section template
    • Build / Deployment
      • Deployment/build for Mac OS X
      • Deployment / Build for Linux
      • Deployment / Build for Windows
      • Travis CI continuous build
        • previous travis setup
  • R&D Doc
    • About R&D doc section
    • Transcription & Media Processing
      • Transcription json
      • Transcriber
        • audio to video
        • STT sdks
          • IBM Watson STT
          • Gentle STT
          • Pocketsphinx
      • Video preview conversion
      • Read metadata
    • Hypertranscript
    • Selections, Annotations, Papercuts
      • Selections
      • Annotations
      • Tags
    • Paper-edit
      • Paper-edit json
      • search-filter
      • drag-and-drop
      • Preview Paper-edit video
    • Export
      • EDL export
      • XML export
      • mp4 export
  • Appendix
    • Dev configuration
    • Current db setup
    • EDL Format
    • Reusable components
    • Prerequisites
    • Testing
    • Updating automated documentation
    • ffmpeg and ffprobe in electron
    • Adding STT services
  • Appendix - Data structures
    • IBM Watson json specs
    • Gentle Json transcription specs
    • Pocketsphinx results
    • autoEdit transcription Json
  • QA List
    • QA Intro
  • Adobe Panel
    • autoEdit Adobe CEP Panel dev setup
      • Adobe Extensions HostList codes
    • autoEdit Adobe CEP Panel integration overview
    • Jsx functions for Adobe CEP autoEdit adobe Panel
    • Packaging and distributing Adobe CEP Extensions
      • Packaging signing Adobe CEP Panel in details
      • Submit to Adobe
  • Project Page
    • Build project page
    • Build/update demo front end page
  • Roadmap
    • Improvements
    • Roadmap
      • Paper-editing Roadmap
      • Extra Features Roadmap
      • Future Roadmap
        • Live video editing
        • Social Media Export
        • Translate transcriptions
        • Web app
          • Multi-user collaboration
        • Searchable Editable Archive
        • NLP insights
        • Slack/Chat bot integration
        • Interactive dev tool
        • Phone mms integration with twillio
        • B-roll computational photography
Powered by GitBook
On this page
  • Component/part description
  • Selections component
  • Annotations
  • Tags
  • Related projects.
  • Annotations
  • Implementations Options considered
  • Selections
  • Current implementation
  • Selection
  • What needs refactoring
  • → Refactoring: Words Selections
  • refactoring words data
  1. R&D Doc

Selections, Annotations, Papercuts

PreviousHypertranscriptNextSelections

Last updated 6 years ago

Component/part description

Semanticly papercuts can be selections, hilights, annotations when found in a transcription but is only as the building block of a paper-edit that we refer to them as paper-cuts.

Connected to this is defining a schema for paper-edit, to make sure all components that work with this have a defined interface/specification.

Same as EDL papercut/”event” object in “EDL JSON: schema from EDL composer component module from autoEdit2.

img/sketches/Transcription%20Show%20Annotate.png

Selections component

A component that can make a selection of word objects from a transcription/hypertranscript.

Annotations

Associate a selection with a tag, a tag description and a comment.

Tags

Tags to group annotations.

--

Related projects.

Annotations

Combine, selection, annotation, tag, and event info/papercut for paper edit/“JSON EDL” when multiple annotations combined. With some as optional fields. Eg tags, etc..

--

Implementations Options considered

Selections

Selections Make text selection of transcription

--

Current implementation

Paper-edit json schema specification Connected to this is defining a schema for paper-edit, to make sure all components that work with this have a defined interface/specification. Same as EDL papercut/”event” object in “EDL JSON: schema from EDL composer component module from autoEdit2.

Selection

ended up using intermediate data structure. Data is stored in html in data attribute for ease of retrieval at word level.

--

What needs refactoring

→ Refactoring: Words Selections

There might be a better way to do this? Using rangy ?

refactoring words data

Data is stored in html in data attribute for ease of retrieval at word level. this is very bulky. There might be more elegant options, using listeners and events(?) or other(?).

Need Annotation schema specification Check out recent annotation spec by W3C

Could use to keep annotation close to selection in trascription . And coul use bootstrap popovers

To look into

How to do text selection for highlight paper cuts. Currently in transcription show it traverse the DOM to update those. Eg see selecting words function. That recognises uses selection.

And this function to update the dom with selections.

https://www.w3.org/annotation/
http://tether.io
https://getbootstrap.com/javascript/#popovers
https://github.com/timdown/rangy
https://developer.mozilla.org/en-US/docs/Web/API/Selection
https://github.com/OpenNewsLabs/autoEdit_2/blob/paperedit/lib/app/views/transcription_view.js#L488
https://github.com/OpenNewsLabs/autoEdit_2/blob/paperedit/lib/app/views/transcription_view.js#L91