Skip to content
This repository has been archived by the owner on Nov 24, 2021. It is now read-only.

willemliu/universal-comments-plugin

Repository files navigation

DEPRECATED ❗ : Will no longer work after Manifest v3 rolled out.

universal-comments-extension

Take only memories, leave only comments.

A comment plugin which adds an overlay to the website you're visiting. The overlay allows you to submit comments to that specific page. Other people using this plugin can read your comments left on that page.

You can create circles in which you can post comments. You can invite other people you know to join your circle. Only you and other members can see the comments posted there. This makes it possible to make separate circles for your colleagues, friends and family.

Table of contents

Installation

Edge (Chromium)

FireFox

Chrome

Manually

  1. In Chrome address bar type: chrome://extensions

  2. Enable developer mode

  3. Load unpacked and select the /universal-comments folder

Usage

Open a web page and click the Extension icon to open the comments overlay.

Extension options

The following extension options can be set:

Extension options

  • Enable: uncheck to disable the plugin (default: checked)

  • Hide button overlay: check to hide the Universal Comments button overlay. You can still toggle the comments overlay clicking the Extension icon. (default: unchecked)

  • Keep URL Parameters: Check to keep URL Parameters of the page you're commenting on (default: unchecked)

    This is useful if the website you're visiting uses URL Parameters to differentiate between pages. E.g.

  • Overlay height (%): Comments overlay height as a percentage of the viewport (default: 50)

Post comment

Once you're logged in you can post a comment using the form.

Comment form

Reply

You can directly reply to an existing comment by clicing on the 📥-icon at the bottom right corner of a comment.

Remove

You can remove your own comment by clicking the ☠️-icon at the top right corner of a comment.

Edit

You can edit your own comment by clicking the ✏️-icon at the bottom right corner of a comment.

View changes

You can view the changes of any comment by the result of an edit compared to the original by clicking the 📜-icon at the top right corner of a comment.

Receive e-mail notifications

When this option is checked you'll receive e-mail notifications whenever a new comment has been posted for the page you've previously left a comment.

If the option is unchecked then you will no longer receive any e-mail notifications from Universal Comments.

Comments Admin

You can open the Comments Admin by clicking the ⚙️-icon next to the Comments label in the comments overlay.

Comments Admin

When you are on the Comments Admin page you can login with the account with which you've posted comments. Then all your comments are visible there and you have the option to remove the comments.

Circle Admin

You can open the Circle Admin by clicking the ⚙️-icon next to the Circle select-box in the comments overlay.

Circle Admin

When you are on the Circle Admin page you can login with the account with which you post comments. You can create, delete, leave and join circles here.

What are circles?

Circles are enclosed areas in which only the invited are able to post and read comments. You can create circles as you please. After which you can invite other people to join your circle. Maybe you want to have separate circles for your family, friends and colleagues.

Your comments intended for colleagues may be more formal or work-related and irrelevant for other people. Same goes for your comments in a circle of friends.

With circles you can manage your circles as you please.

Disable on your website

You can easily disable the plugin on any page of your website by adding the following meta tag in your page head:

<meta name="uc:disabled" content="true"/>

Development

Prerequisites

  1. NodeJS
  2. NPM

Getting started

  1. Run npm i to install dependencies
  2. Run npm run webpack to build the plugin
  3. Run npm run release:... to copy the correct manifest to the assets folder
    1. For Chrome run: npm run release:chrome
    2. For FireFox run: npm run release:firefox