Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/opentower/populus-viewer

A Social Annotation Tool Powered by Matrix
https://github.com/opentower/populus-viewer

education matrix pdfjs social-annotation

Last synced: about 2 months ago
JSON representation

A Social Annotation Tool Powered by Matrix

Awesome Lists containing this project

README 

        
> [!IMPORTANT] 

> Populus-Viewer is no longer actively maintained, so the information below may

> be out of date - If you'd like to take over the project, let me know and I'll

> redirect to your fork.



# Populus-Viewer

*Social Annotation Powered by Matrix*



Populus-Viewer is a tool for decentralized social annotation, built on

[pdfjs](https://mozilla.github.io/pdf.js/),

[wavesurfer.js](https://wavesurfer-js.org/) and [the Matrix

protocol](https://matrix.org). You can use it to read PDFs, listen to audio, or

watch videos, and have rich discussions in the margins, with your friends,

classmates, or scholarly collaborators.



Each uploaded file is attached to a matrix space, and each annotation to the

file becomes a room within that space. Populus-Viewer has been tested with

synapse and dendrite, but should be compatible with any spec-compliant matrix

server.



To learn more or talk about the project, [find us on Matrix](https://matrix.to/#/#opentower:matrix.org).

The project should currently be considered beta-quality. UX is 

unpolished, bugs are likely, and features are missing. Bug reports and 

feature requests are welcome.



## Features



https://user-images.githubusercontent.com/6383381/183310450-fa4c1809-3e1b-4375-929e-b9eb20b5c4b5.mp4



Populus-Viewer currently supports:



- Highlight and pin-drop annotations on PDFs 

- Timespan annotations on audio and video files 

- Annotating spatial regions of images and video files

- Audio and video messages

- Message edits and redactions

- Replies and reactions

- Unread message counts

- Markdown for text formatting (via [commonmark.js](https://github.com/commonmark/commonmark.js))

- LaTeX for mathematical notation (via [KaTeX](https://katex.org))

- Integration with bots

- Typing notifications

- Room invitations

- Synchronized reading positions across devices

- Single Sign On (via Google, university, or another SSO provider), given a matrix server that supports it



If there's a feature supported by Matrix that you think would make for a 

better social annotation experience, please open an issue or a PR!



Populus' annotations are stored on your Matrix server in a format compatible

with the [w3c Web Annotation Data Model](https://www.w3.org/TR/annotation-model/). 

The details are documented in a couple of related matrix spec proposals:



* [MSC3775: Markup Locations for Audiovisual Media](https://github.com/matrix-org/matrix-spec-proposals/pull/3775) 

* [MSC3752: Markup locations for text](https://github.com/matrix-org/matrix-spec-proposals/pull/3752)

* [MSC3592: Markup locations for PDF documents](https://github.com/matrix-org/matrix-spec-proposals/pull/3592)

* [MSC3574: Marking up resources](https://github.com/matrix-org/matrix-spec-proposals/pull/3574)



## Usage



To try out Populus-Viewer, just point your browser at our [github pages

instance](https://opentower.github.io/populus-viewer). You're welcome to use

the default testing server, but be aware that this server may be torn down or

replaced at any time. Also, be aware that the testing server isn't federated,

so it won't be possible for users on other servers to join your discussions or

vice-versa. We may consider running a larger public instance in the future once

client development is further along.



To get started tinkering with the source code, clone this repository and then

run:



* `npm install` to download dependencies and install them locally.

* `npm run-script build` to build the browser JS, which will end up in the `dist` directory. 

* `npm run-script serve` to serve the contents of `dist` at localhost:9000, and auto-reload on changes.



## Prior Art



Similar projects include:



- [Perusall](https://perusall.com)

- [Hypothes.is](https://web.hypothes.is)

- [PeerLibrary](https://peerlibrary.org)

- [BookWyrm](https://joinbookwyrm.com)



But I couldn't resist trying something new :)