diff --git a/README.md b/README.md index a497f48..057dd27 100644 --- a/README.md +++ b/README.md @@ -22,9 +22,9 @@ A chrome extension for tagging words with semantic information. Technology stack (roughly): Angular.js, Typescript, Lodash and Rangy.js. -*How is the plugin loaded?* `Manifest.json` defines add an icon and a background page called `background.js`. The background page adds a click listener to the plugin's browser icon. When triggered it will first load jquery and then inject the menu in an iframe as well as create an iframe for the page content. It will then continue loading dependencies before finally calling `tagit.init()` on the plugin which to make angular initialize itself making it possible to interact with the menu. When loading the plugin will check local storage for previously made tags and add them the page. The plugin will also add click listeners to the iframe(s) containing content to be tagged. +*How is the plugin loaded?* `Manifest.json` adds an icon and defines an [event page](https://developer.chrome.com/extensions/event_pages) called `background.js`. The event page adds a click listener to the plugin's browser icon. When triggered it will first load jquery and then inject the menu in an iframe as well as create an iframe for housing the page content. The plugin is in fact reloading the page inside an iframe on the page. It will then continue loading dependencies before finally calling `tagit.init()` on the plugin which makes angular initialize itself making it possible to interact with the injected menu. When loading the plugin will check local storage for previously made tags and add them the page. The plugin will also add click listeners to the iframe(s) containing content to be tagged. -*How does tagging happen?* After the plugin has been loaded it will have added click listeners to the iframe(s) containing the taggable content. When a click happens it will check if a word was selected. If a new word had been selected it will query a backend for possible definitions to tag the word with. When the user selects a definition the plugin tags the word, saves the tag and posts the result back to the backend. +*How does tagging happen?* After the plugin has been loaded it will have added click listeners to the iframe(s) containing the taggable content. When a click is registered the plugin will check if a word was selected. If a new word had been selected it will query a backend service (url endpoint) for possible definitions to tag the word with. When the user selects a definition the plugin tags the word, saves the tag in localstorage and posts the result back to the backend service. *Particularities to tagging:* When tagging a selection the plugin must always relate the tag position to the original DOM object (original web page structure). Thus the plugin will remove all tags and selections before saving a word selection or saving a tag. Tags also need to be loaded in a bottom up order so that their `range.startOffset` is always in relation to the original DOM. `StartOffset` is simply a position number of where the node (html element etc.) is located within the DOM tree-structure that starts with 0 (document root).