W3C‐Annotation

W3C Annotation Data Model

Introduction

The Web Annotation Data Model is a W3C (World Wide Web Consortium) standard that defines a structured format for creating and sharing annotations on digital resources. In our app, we will utilize this model to allow users to view and interact with news articles, portfolios, and stock information directly within posts through annotations. This integration aims to enhance user engagement and provide a richer exchange of information.

Benefits

Enhanced User Engagement

• Interactive Content: Annotations enable users to interact with specific parts of a post.

Improved Content Discovery

• Contextual Information: Annotations can provide additional context, such as linking a stock symbol to its market data or attaching relevant news articles.
• Efficient Navigation: Users can quickly access related content without leaving the post, improving the overall user experience.

Interoperability

• Standardization: Adhering to the W3C standard ensures compatibility with other tools and platforms that support the Web Annotation Data Model.
• Data Portability: Annotations can be easily shared or transferred between systems, promoting collaboration.

Scalability

• Modular Architecture: The standardized model allows for scalable implementation, accommodating future features and integrations.
• Community Support: Utilizing a widely accepted standard provides access to community resources and updates.

Requirements of Following the Standard

Compliance with W3C Specifications

• Data Structure: Annotations must conform to the JSON-LD format as specified by the Web Annotation Data Model.
• URI Usage: Each annotation should have a unique identifier (URI) to ensure it can be individually referenced and accessed.
• Types of Annotations: Support for various annotation types such as Tagging, and Linking must be implemented.

Annotation Properties

• Target: The specific part of the content the annotation refers to (e.g., a paragraph in a news article).
• Body: The content of the annotation itself, which could be text, links, or other media.

Technical Implementation

• Compatibility: The system must be compatible with existing web technologies and standards.
• Performance: Annotations should load efficiently without degrading the performance of the app.

How it will be enforced in practice | Frontend

Which elements may be displayed by annotations?

• Posts: On body text of the posts a logged in user can annotate their opinions.

Where in our applications may annotations appear?

• Community page
  On the community page, users can view other users' annotations.

  A post consists of multiple blocks, such as graphs, text, and news items. Users can leave a comment for only body part which contains text description.

• Profile page
  On the post page, again, users can view other users' annotations on their posts.

How to visualize annotations?

Annotations may be visually highlighed as:

• On hover, a panel will open, displaying short, highlighted information.