WebAnnotator

WebAnnotationClient

General Properties

ps:Source:: haritz
ps:Created:: 07-nov-2019 12:39:58
ps:ChangedBy:: haritz
ps:Changed:: 25-feb-2020 17:09:58
Unique Name:: WebAnnotationClient
Element Class:: ps:feature
Element Type:: ps:feature
Variation Type:: Mandatory
Default Selected:: on

Description

The root feature that groups the rest of the features to define a Web Annotation client in the form of Web Browser extension

Properties

appName:

Web annotation client

appShortName:

oa

appDescription:

Annotate documents online following color coding paradigm

key:

1. AnnotationServer

General Properties

ps:Source:: haritz
ps:Created:: 07-nov-2019 12:51:34
ps:ChangedBy:: haritz
ps:Changed:: 24-feb-2020 17:06:05
Unique Name:: AnnotationServer
Element Class:: ps:feature
Element Type:: ps:feature
Variation Type:: Mandatory
Default Selected:: on

Description

This abstract feature groups annotation servers. An annotation server is a web server that makes available (stores) and allows annotation management via the protocol described in the W3C recommendations [https://www.w3.org/TR/annotation-protocol/]

Properties

defaultAnnotationServer:

BrowserStorage

key:

Relations, Restrictions, Constraints

: checkDefaultAnnotationServer()

1.1. Local

General Properties

ps:Source:: haritz
ps:Created:: 07-nov-2019 12:51:34
ps:ChangedBy:: haritz
ps:Changed:: 25-feb-2020 9:20:41
Unique Name:: Local
Element Class:: ps:feature
Element Type:: ps:feature
Variation Type:: Or
Default Selected:: off

Description

[Language: EN]

This abstract feature groups annotation servers which store annotations locally (e.g: browser storage or cookies).

Properties

key:

1.1.1. BrowserStorage

General Properties

ps:Source:: haritz
ps:Created:: 07-nov-2019 12:51:34
ps:ChangedBy:: haritz
ps:Changed:: 24-feb-2020 17:08:13
Unique Name:: BrowserStorage
Element Class:: ps:feature
Element Type:: ps:annotationServer
Variation Type:: Or
Default Selected:: off

Description

Web annotations are stored locally in browser extensions storage. See chrome.storage.local: https://developer.chrome.com/apps/storage

Properties

key:

1.2. Remote

General Properties

ps:Source:: haritz
ps:Created:: 07-nov-2019 12:51:34
ps:ChangedBy:: haritz
ps:Changed:: 24-feb-2020 17:10:43
Unique Name:: Remote
Element Class:: ps:feature
Element Type:: ps:feature
Variation Type:: Or
Default Selected:: off

Description

This feature groups annotation servers hosted and accessible by URL and API on the web (e.g.: Hypothes.is).

Properties

key:

1.2.1. Hypothesis

General Properties

ps:Source:: haritz
ps:Created:: 07-nov-2019 12:51:34
ps:ChangedBy:: haritz
ps:Changed:: 24-feb-2020 17:11:05
Unique Name:: Hypothesis
Element Class:: ps:feature
Element Type:: ps:annotationServer
Variation Type:: Or
Default Selected:: off

Description

Hypothes.is is a widely-used annotation server that provides an API to manage annotations, groups and users

Properties

key:

1.2.2. Neo4J

General Properties

ps:Source:: haritz
ps:Created:: 07-nov-2019 12:51:34
ps:ChangedBy:: haritz
ps:Changed:: 25-feb-2020 9:58:53
Unique Name:: Neo4J
Element Class:: ps:feature
Element Type:: ps:annotationServer
Variation Type:: Or
Default Selected:: off

Description

[Language: EN]

This is a pre-alpha feature, it is not reliable and your data can be lost. Neo4J for annotations is a experimental annotation server that implement Hypothes.is API (https://h.readthedocs.io/en/latest/api/) but using Neo4J as the underlying database.

Properties

key:

2. Target

General Properties

ps:Source:: haritz
ps:Created:: 07-nov-2019 12:51:46
ps:ChangedBy:: haritz
ps:Changed:: 26-feb-2020 9:42:06
Unique Name:: Target
Element Class:: ps:feature
Element Type:: ps:feature
Variation Type:: Mandatory
Default Selected:: on

Description

This feature groups features related with resource to be annotatated. Following the W3C recommendation it is possible to annotate resources taking into account like format (PDF, HTML,...) and location (web, localfile,...),...

Properties

key:

2.1. Format

General Properties

ps:Source:: haritz
ps:Created:: 07-nov-2019 12:51:46
ps:ChangedBy:: haritz
ps:Changed:: 25-feb-2020 10:15:04
Unique Name:: Format
Element Class:: ps:feature
Element Type:: ps:feature
Variation Type:: Mandatory
Default Selected:: on

Description

This feature gathers the possible file formats that the web annotation client will support to create annotations over. It is possible to select 1 or more.

Properties

key:

2.1.1. PDF

General Properties

ps:Source:: haritz
ps:Created:: 07-nov-2019 12:51:46
ps:ChangedBy:: haritz
ps:Changed:: 25-feb-2020 9:24:57
Unique Name:: PDF
Element Class:: ps:feature
Element Type:: ps:feature
Variation Type:: Or
Default Selected:: off

Description

If selected, web annotation client will support text annotation in PDF documents.

Properties

key:

2.1.2. HTML

General Properties

ps:Source:: haritz
ps:Created:: 07-nov-2019 12:51:46
ps:ChangedBy:: haritz
ps:Changed:: 25-feb-2020 9:25:07
Unique Name:: HTML
Element Class:: ps:feature
Element Type:: ps:feature
Variation Type:: Or
Default Selected:: off

Description

If selected, web annotation client will support text annotation in HTML documents.

Properties

key:

2.1.3. TXT

General Properties

ps:Source:: haritz
ps:Created:: 07-nov-2019 12:51:46
ps:ChangedBy:: haritz
ps:Changed:: 25-feb-2020 10:00:22
Unique Name:: TXT
Element Class:: ps:feature
Element Type:: ps:feature
Variation Type:: Or
Default Selected:: off

Description

This is a pre-alpha feature, can work unexpectedly. If selected, web annotation client will support text annotation in plain-text documents (.txt, .xml, .java,...)

Properties

key:

2.2. Source

General Properties

ps:Source:: haritz
ps:Created:: 07-nov-2019 12:51:46
ps:ChangedBy:: haritz
ps:Changed:: 25-feb-2020 9:26:58
Unique Name:: Source
Element Class:: ps:feature
Element Type:: ps:feature
Variation Type:: Mandatory
Default Selected:: on

Description

The source feature groups the identifiers that can be used to identify an annotated resource, Internationalized Resource Identifiers (IRIs).

Properties

key:

2.2.1. URL

General Properties

ps:Source:: haritz
ps:Created:: 07-nov-2019 12:51:46
ps:ChangedBy:: haritz
ps:Changed:: 25-feb-2020 9:51:22
Unique Name:: URL
Element Class:: ps:feature
Element Type:: ps:feature
Variation Type:: Or
Default Selected:: off

Description

You should select this feature if you want to annotate documents hosted on the Web with a URL

Properties

key:

2.2.2. URN

General Properties

ps:Source:: haritz
ps:Created:: 07-nov-2019 12:51:46
ps:ChangedBy:: haritz
ps:Changed:: 25-feb-2020 9:52:02
Unique Name:: URN
Element Class:: ps:feature
Element Type:: ps:feature
Variation Type:: Or
Default Selected:: off

Description

You should select this feature if web annotation client must support user's local filesystem files annotation.

Properties

key:

2.2.3. DOI

General Properties

ps:Source:: haritz
ps:Created:: 07-nov-2019 12:51:46
ps:ChangedBy:: haritz
ps:Changed:: 25-feb-2020 9:54:46
Unique Name:: DOI
Element Class:: ps:feature
Element Type:: ps:feature
Variation Type:: Or
Default Selected:: off

Description

If your annotation client needs to annotate documents that can be identified by Document Object Identifiers (e.g.: research papers), you can select this feature to sync annotations done over the same DOI but in different instances of the document (e.g.: a paper downloaded form ScienceDirect in PDF format and the same paper in HTML format hosted on the Web)

Properties

key:

2.3. Selector

General Properties

ps:Source:: haritz
ps:Created:: 07-nov-2019 12:51:46
ps:ChangedBy:: haritz
ps:Changed:: 26-feb-2020 9:42:06
Unique Name:: Selector
Element Class:: ps:feature
Element Type:: ps:feature
Variation Type:: Mandatory
Default Selected:: on

Description

This feature enables text fragments annotations over a document, where the user selects a fragment.

Properties

key:

3. Purpose

General Properties

ps:Source:: haritz
ps:Created:: 07-nov-2019 12:52:27
ps:ChangedBy:: haritz
ps:Changed:: 25-feb-2020 10:25:30
Unique Name:: AnnotationPurpose
Element Class:: ps:feature
Element Type:: ps:feature
Variation Type:: Mandatory
Default Selected:: on

Description

This feature gathers the possible purposes that the web annotation can create annotations with. This follows the annotation purposes and motivations described in the W3C recommendation: https://www.w3.org/TR/annotation-model/#motivation-and-purpose

Properties

key:

3.1. Classifying

General Properties

ps:Source:: haritz
ps:Created:: 07-nov-2019 12:52:27
ps:ChangedBy:: haritz
ps:Changed:: 25-feb-2020 10:27:43
Unique Name:: Classifying
Element Class:: ps:feature
Element Type:: ps:feature
Variation Type:: Optional
Default Selected:: off

Description

Selecting this feature allow users to create annotations with the purpose of classifying. This feature is related with the codebook.

Properties

key:

3.2. Commenting

General Properties

ps:Source:: haritz
ps:Created:: 07-nov-2019 12:52:27
ps:ChangedBy:: haritz
ps:Changed:: 04-mar-2020 10:02:30
Unique Name:: Commenting
Element Class:: ps:feature
Element Type:: ps:feature
Variation Type:: Optional
Default Selected:: off

Description

Selecting this feature allow users to create annotations with the purpose of commenting. When user right-click over an annotation can click on "comment" button and a form is shown to create a comment. Some practices demand for comments to be assisted to either speed up the commenting process or enhance comments quality, this leads to a further elaboration of this functionality with commenting sub-features.

Properties

key:

3.2.1. SentimentAnalysis

General Properties

ps:Source:: haritz
ps:Created:: 07-nov-2019 12:52:27
ps:ChangedBy:: haritz
ps:Changed:: 04-mar-2020 10:34:33
Unique Name:: SentimentAnalysis
Element Class:: ps:feature
Element Type:: ps:feature
Variation Type:: Optional
Default Selected:: off

Description

This feature verifies the content of user's comment when creating the annotation and notifies if the comment has a negative or offensive connotation. It is adequate to avoid offensive content when annotation comments are read by third parties or are used as a mechanism for feedback.

Properties

key:

3.2.2. SuggestedLiterature

General Properties

ps:Source:: haritz
ps:Created:: 07-nov-2019 12:52:27
ps:ChangedBy:: haritz
ps:Changed:: 04-mar-2020 10:45:15
Unique Name:: SuggestedLiterature
Element Class:: ps:feature
Element Type:: ps:feature
Variation Type:: Optional
Default Selected:: off

Description

This feature provides an in-context literature lookup, simplifying literature suggestion or linking comments with scholarly literature. Currently it supports lookup in DBLP: https://dblp.uni-trier.de/

Properties

key:

3.2.3. Autocomplete

General Properties

ps:Source:: haritz
ps:Created:: 07-nov-2019 12:52:27
ps:ChangedBy:: haritz
ps:Changed:: 04-mar-2020 9:47:30
Unique Name:: Autocomplete
Element Class:: ps:feature
Element Type:: ps:feature
Variation Type:: Optional
Default Selected:: off

Description

Provides functionality for comment reuse. It is useful in contexts where the same comment is repeated or reused in multiple annotations.

When the user starts writing, the system automatically hints with previously created comments. Comments that can be reused are those which has the same classification if classifying feature is selected, otherwise all the comments done are shown.

Properties

key:

3.2.4. PreviousAssignments

General Properties

ps:Source:: haritz
ps:Created:: 07-nov-2019 12:52:27
ps:ChangedBy:: haritz
ps:Changed:: 04-mar-2020 10:33:05
Unique Name:: PreviousAssignments
Element Class:: ps:feature
Element Type:: ps:feature
Variation Type:: Optional
Default Selected:: off

Description

This feature is closely related to Moodle ones. It shows previously assessed assignments to students, where the user can place add a reference in the comment to student's previous assignments.