Steps to reproduce

Product configuration with themes + codes and Dynamic.
1.Create a theme, then a code
2.Annotate something with that code
3.Remove that code
4.Reload website/PDF

Some insights

Annotation must be removed or not? I don't think so, but it should be shown in grey color (annotation does not have a valid code (look mark&Go implementation).

It also gives a error here:
https://github.com/onekin/WebAnnotatorSPL/blob/a7020374e204cefb5d3fd3eb859d288f7b89dfa1/input/app/scripts/contentScript/AnnotatedContentManager.js#L299

Due to the pure variants last update the group selector html is interpreted diffently and the groupSelectorToggle element is overwritten

When you click on a tag without underline anything to search the last annotation made, if the last annotation is deleted, the application continues searching for that annotation because the value of this last annotation is save yet

Limitation

Currently it is possible to create page notes, but not if sidebarNavigation feature exists.

Aim

To improve maintenance and its documentation it could help to define a common template to post new issues or bugs to be fixed on WacLine

To check

https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository

searchAnnotations in local storage does not retrieve annotations done with pdf urn or doi if the document url is not the same.

It should create only one button with "highlight" but it stucks the CPU at 100% and app stops working properly

Steps to reproduce

Depending on the selected storage (especially it happens on remote annotation storage systems e.g: Hypothes.is), some of the annotations are not removed. Why? Because this operation is API intensive as it makes a call for each annotation to be removed.

How to solve

The idea is to support in all the annotation storage clients the operation deleteAnnotations, where it is given an annotation array list to be removed instead of doing this:
https://github.com/onekin/WebAnnotatorSPL/blob/75262aca9709c8c253c33aff3b492cb15cdba0c3/input/app/scripts/contentScript/contentAnnotators/TextAnnotator.js#L1237-L1253

Something similar to what we have in hypothesis-api-client:
https://github.com/haritzmedina/hypothesis-api-client/blob/c2ca35adef2cb969acfe92b3d22ca6a16aca6737/lib/index.js#L332

Refactor this function, simplifying it:

Latest stable version is v2.3, and we have v1.1: https://mozilla.github.io/pdf.js/getting_started/#download

When configuring products, if only browserstorage is selected , background.js does not respond with selected annotation server, what makes contentscript error and not starting.

Steps to reproduce

Open any of the extensions using Chrome browser and try to load any functionality that requires a call to Hypothesis. It will prompt this error and won't work properly.

How to solve

Move hypothesis calls from client-side to the background using chrome messages.

IEEE is a Digital Library (DL) that it is hugely used in Computer Science. I think that it should be added as a possible target.
In this case, it is not recognized the DOI in HTML nor PDF version and it has some extra difficulties do to how is this DL implemented to annotate the PDF version (see below).

Use this article as an example:
https://ieeexplore.ieee.org/document/6916375

For HTML

Try to resolve the DOI. It can be retrieved when navigating from DOI URL:
https://doi.org/10.1109/U-MEDIA.2014.59

Or it is possible to scrap from the website, it appears usually in this place:

For PDF

Augment PDF download icon with the DOI scraped in previous step. When user clicks on PDF document, it is redirected to a new URL:
https://ieeexplore.ieee.org/stamp/stamp.jsp?tp=&arnumber=6916375#doi:10.1109/U-MEDIA.2014.59

It cannot be annotated, as the PDF is inside an iframe. A new redirection must be supported (or automatically opened), maintaining the #doi:10.1109/U-MEDIA.2014.59 in the URL of the iframe.

This is already implemented in Highlight&Go. See this file.

Steps to reproduce

After creating a product from the SPL $ npm install it is not working properly in node v12.

How to solve

There are some dependencies that must be updated in package.json file to the following versions:
"wdio-jasmine-framework": "^0.3.8", "wdio-selenium-standalone-service": "^0.0.12", "wdio-spec-reporter": "^0.1.5", "wdio-webpack-service": "^1.0.1", "webdriverio": "^5.12.5",

Setting

Any product with commenting feature (e.g.: commenting + replying)

Steps to reproduce

Create an annotation and add a comment. The annotation is updated twice, what is doesn't affect to anything.

However, if you create a comment to reply another annotation, the annotation is created twice, creating two replies with the same value.

How to solve

Check why the callback of commenting form is executed twice, and take into account all the involved features of commenting, replying, assessing and moodle comments (which is listening to replying annotations).

when you do a rigth click over a theme name, doesn't appear the options to add a code or remove a theme

Steps to reproduce

If installing a tool, activating it in one tab, sometimes it makes that other tabs have the extension activated too, but the user have never clicked on them.

How to solve

Check how propagation of active tab and which are the tabs that have activated the extension. Check popup.js

Steps to reproduce

Configure a new product and select GoogleSheetProducer or GoogleSheetConsumer. Both have a clientId attribute to set.
Currently it is possible to choose any of these two features but leave the clientId attribute empty. It is must to define a clientId, otherwise the Google Sheets API won't work.

How to solve

Define a restriction or function that the attribute cannot be a empty string if the feature is selected

Currently it is possible to create spreadsheets but not IRR or Inter Annotator Agreement like spreadsheets. The idea is to replicate this functionality already working in Highlight&Go standalone version:

Set a restriction to ensure that the user selects a correct default storage

Steps to reproduce

Get a document (e.g.: txt file) with repeated text among the whole text.
Annotate the same fragments but in different positions.
Created annotations are different, but they are drawn in the same place.

How to solve

Check if the algorithms are working properly, specifically textposition anchoring.

Steps to reproduce

When Manual and BuiltIn is selected, the first time that the application is opened it is automatically created a group with the default name. However, it must ask you for a name for the first group, as the default group name is an AppBased feature's functionality.

How to solve

Reuse the functionality given in Create new codebook to ask user for the name of the group.

Currently it is possible to create page notes, but it is not possible to delete, update or view (only a number in a sidebar denotes that the annotation exists) and if annotation server provides visualization mechanisms, it is possible to see there (e.g.: Hypothes.is or browserStorage), but it has some limitations to modify or delete it.

Steps to reproduce

In groupmanipulation, if manual is chosen, create group feature must be selected. Otherwise, when opening the generated product, it doesn't give user to do anything. They cannot create a group to annotate and the following error appears:

How to solve

Set a requirement if manual is selected to select create group feature.

Things to verify

Maybe it is possible to create a group if User feature is selected?

Marks must be translated to moodle automatically if teacher creates an annotation with a mark, if a comment is added or if an annotation is deleted.
In the last two cases works well and it is updated automatically moodle, but when user mark for the first time just highlighting with a mark, it is not updated in moodle

Steps to reproduce

Open a long PDF document. E.g.: https://www.pure-systems.com/fileadmin/downloads/pure-variants/doc/pv-user-manual.pdf
Create annotations in two pages that are far one from the other. E.g: page 1 and 70
Open the comment form (for example, as it happens in all the forms). Start typing in the input text or textarea
After some seconds it will lose the focus.

How to solve

If swal form is opened, don't highlight annotations, as this functionality sometimes require to change the user focus to find where is the annotated content. In long PDF documents, PDF.js to save memory destroyes and creates dynamically PDF pages (DOM elements representing the PDF content) that the annotation system is trying to find, and if not found, it tries different mechanisms to find the annotated fragment. One of the most costly methods to find annotations changes the user focus programatically. The best solution is just not to try to load those annotations when a sweetalert exist or the annotated page does not exist.

Similar bug solved here: haritzmedina/MarkAndGo#14

It should be useful (for anybody who wants to use/reuse the SPL, but also for us) to document a bit at least the readme. Things to document:

• What is this project about?
• How to setup the environment to create a product: dependencies installation,...
• How to setup for developing, contribute,...
• How to extend the SPL with new features
• Which one is the folder structure

Steps to reproduce

Try to configure a highlighter (codebook) externally (e.g.: via moodle or sheets) without being logged in Hypothes.is in your browser.

The system will crash and won't show you any alert to log in Hypothes.is. Also after login it won't continue configuring the highlighter or doing further steps, requiring user to reload the website and relaunch the configuration

The ack with moodle update in student's assessment should appear only when a mark is updated in moodle, not always.

Steps to reproduce

Open a PDF document and activate extension. Annotator starts. Try to click again on the extension to deactivate. The extension funcionality and URL still alives.

Steps to reproduce

Create a vdm and disable all the targets in Definition->Target feature.

Result

It is said that there is an error because one of the Targets must be selected.

Expected behaviour

I think that it is a correct configuration for that variation model, because it is possible to have an annotator which only annotates websites. In addition, URL feature is already selected.

Check this:
https://github.com/onekin/WebAnnotatorSPL/blob/fc830b66ab04c77d5d6c91ef4328fcd95f402ad5/input/app/scripts/Config.js#L42

Depending on the product, this variable value should change: e.g.:

• Highlight&Go = hag
• Mark&Go = mag
• Review&Go = rag

And so on. It can be defined a new attribute for the root feature WebAnnotator in xfm file which is urlParam or reuse short app name?

Latest node LTS version is v12, but we are using v10, with a ton of obsolete dependencies. The idea is to update node v12, babel 7 (allowing async/await) and update the rest of the used dependencies, removing those which are not used anymore.

To check if everything is up to date, we can use https://www.npmjs.com/package/npm-check-updates

There are two navigation issues when clicking on sidebar buttons:

• When clicking on a theme (or evaluation rubric criteria) it does not navigate through the evidences of the annotation. It should navigate through each annotation with that code
• When clicking on a level (giving a mark), it navigates to the annotation and also marks the assignment. It should no navigate to the annotation, the teacher is only marking

Annotations with the following form:
AnnotationServer->pv:SelectedChildren()->pv:Size()
Must be changed by:
AnnotationServer->pv:SelectedChildren('ps:annotationServer')->pv:Size()
As servers are now classified as local or remote and later divided in possible options (browser storage, hypothesis, neo4j,...)

Some products may be affected by this bug (was detected in Mark&Go)

Refactor the following method if and second if are similar and can be simplified:

To check

• MoodleReport.js -> has commented the linkify-urls dependency. Implement it again
• ReplyAnnotation.js -> linkify comments created in replies stack.

When configuring annotation server, one or more annotation servers can be configured. If default annotation server is not defined (empty string), it should take the first one, but current function in refactoring branch does not allow to set as empty string the defaultAnnotationServer attribute for a variant model.

Steps to reproduce

• Login as a student in Moodle and join your teacher's created group
• When clicking on back to moodle button in sidebar, it tries to redirect to moodle, but the URL to be redirected in case of teachers and students is different, so tries to redirect to teachers' where students doesn't have permission to access

Steps to reproduce

Open a TXT or plain-text-like file (can be local or on the web), specially it happens with XML files. Create some annotations, and after that, the extension starts auto-scrolling to those annotations, making impossible to annotate more or navigate throught the document

Steps to reproduce

When packing a transformed product using gulp pack, it creates a .zip file that can be uploaded to the chrome store or install locally in another computer.
When trying to install in other computer (different system and maybe language) it throws an error unpacking it and later when trying to load it:
"localisation used, but default_locale wasn't specified in the manifest, could not load manifest"

Packing environment:
OS: Windows 10
NodeJS: -v 10
System lang: Spanish

Unpacking environment:
MacOSX
System lang: English

Configuration

Hypothesis server must be selected and in use.

Steps to reproduce

Try to modify programatically an annotation from a different URL, when using Annotation.serialize before sending to the annotation server, it gets and saves current URL and not annotation former one, see:

Thanks to @aitord97 for notifying and providing a patch to solve this issue.

Steps to reproduce

Create inside a group 2 sessions to review documents. When changing from one to the other, the counters of number of annotations for each of the criterion is not updated.

Problem found

When we conducted a first evaluation of configuration of web annotation clients (based on already implemented features), we found that some of the features are not easy to understand by a simple name or description. Also, it is difficult to imagine which one is the resultant annotation tool before generating it.

How to solve

That's why we should add images to demonstrate how the interface is and facilitating comprehension of what is the product manager is selecting.

Steps to reproduce

Create a product with option to create on runtime new themes or codes (aka Dynamic).
Feature:Dynamic
When creating a new theme the current interface is this one:

It can be improved for better looking (or at least to look homogeneous with other alerts.

Currently it is possible to update/modify annotations comment, assessment values, etc. but there is not a mechanism to reclassify it.

Proposal: make selectable an annotation and sidebar will open, if clicked in a button, the selected annotation changes it's classification code.

Springer is a DL that it is hugely used in Computer Science. I think that it should be added as a possible target. When annotating the HTML document, current implementation of DOI retrieves the DOI from the website, but not in case of a PDF document. It follows the same idea of ACM and ScienceDirect hosting services. See implementation of these features to replicate it for Springer.

Steps to reproduce

Try to install an annotation client without logged in Hypothes.is and try to use any of the functions (e.g.: getListOfGroups). The HypothesisClientManager won't initialize the client, return an error in console, but completely silent for the user, so won't know why the client is not working (reason: need to log in Hypothes.is website to get the token).

How to solve

Notify somehow the user about requiring to log in Hypothesis website.

Steps to reproduce

It is not possible to annotate content only with the theme. It works with the code buttons, but it should work aswell with the theme button.

It must be checked if there is something in Buttons.js implementation which removes the groupHandler event from the button of the theme.

First time shown

After adding the counter of number of annotations for themes and codes it stops working.