Description Usage Arguments Value Source Examples
Create annotations
1 2 3 |
token |
Character. Your account token, which you can generate at https://hypothes.is/register |
uri |
Character. The URI to be annotated. |
user |
Character. Your user account, normally in the format |
permissions |
A named list with read, update, delete, and admin permissions. Defaults to setting global read permissions ( |
document |
A list describing the document. CURRENTLY IGNORED. |
target |
A list describing the highlight position of the annotation. CURRENTLY IGNORED |
tags |
Character. (optional) Tags to apply to the annotation. |
text |
Character. Text to put in the body of the annotation. This will be coerced into a character vector of length 1 using paste. |
custom |
Add arbitrary fields to the JSON object submitted to hypothes.is by means of a named list. |
Upon successful creation, returns a 22-character annotation ID. This ID may be retrieved using hs_read.
https://h.readthedocs.io/en/latest/api/#create
1 2 3 4 5 6 7 |
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.