https://github.com/creisle/civic-nli-ext

https://github.com/creisle/civic-nli-ext

Last synced: 7 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/creisle/civic-nli-ext
• Owner: creisle
• Created: 2022-03-04T17:47:14.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-01-13T18:13:55.000Z (almost 2 years ago)
• Last Synced: 2023-08-19T06:10:27.617Z (about 1 year ago)
• Language: JavaScript
• Homepage: https://creisle.github.io/civic-nli-ext
• Size: 3.69 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# CIViC NLI Chrome Extension

Chrome Extension for viewing Hypothes.is annotations in-line on CIViC Evidence Items for convenience of annotators.

- [Testing the Extension](#testing-the-extension)

- [Get the Hypothes.is Group ID](#get-the-hypothesis-group-id)

- [Get the Hypothes.is API Token](#get-the-hypothesis-api-token)

- [Full-text Available in PMC](#full-text-available-in-pmc)

## Testing the Extension

Clone this repository

```bash

git clone https://github.com/creisle/civic-nli-ext.git

```

Open the extensions page in chrome `chrome://extensions` and enable developer mode. This will allow you to load the extension

![dev mode](./docs/images/chrome-dev-mode.png)

Next load the extension unpacked

![load unpacked](./docs/images/chrome-load-unpacked.png)

Select the `src` folder of this repository. You should now see a new extension at the top of the page.

![new ext](./docs/images/chrome-new-ext.png)

To add your credentials, you will need to  click on the extension icon on the top-right of your browser. You can do this from the extensions drop down menu but it is simpler if you pin the extension so that it shows up and then click on it.

![load unpacked](./docs/images/ext-panel.png)

Click on the extension icon to input your hypothes.is credentials

![ext credentials](./docs/images/ext-credentials.png)

Now, navigate to the evidence summary page of a CIViC Evidence Item with known annotations. The extension will now display the annotations on the page

![display](./docs/images/civic-nli-annotations.png)

## Get the Hypothes.is Group ID

You can find the relevant group ID by navigating to the group overview page in Hypothesis

![hyp group ID](./docs/images/hyp-group-id.png)

## Get the Hypothes.is API Token

To find your API token, go to the developers page in Hypothes.is

![developers page](./docs/images/hyp-developer.png)

Generate (or use existing if you have already generated it) and copy the API token

![token](./docs/images/hyp-token.png)

## Full-text Available in PMC

When you are highlighting text in PMC if an author manuscript or the fulltext is available for the current article then the civic-nli extension icon will be green.

![green extension icon](./docs/images/extension-green.png)

If it remains grey then the full text of this article is not easily available and annotations on this article is unlikely to make it into the final dataset