diff options
| author | Pablo Fernandez <p@f7z.io> | 2023-11-23 17:52:48 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-11-23 17:52:48 +0200 |
| commit | 60256a62675a165c4d4fd9811a19a9cbf6a9e7fd (patch) | |
| tree | 5c450154d373caafc37f324dd01e20338308c9d6 /84.md | |
| parent | 43d50ee42409252a1313928cd437d55fd7bf7bf4 (diff) | |
| parent | 7822a8b12670312aff104ddc03066425882f739d (diff) | |
Merge branch 'master' into nip88
Diffstat (limited to '84.md')
| -rw-r--r-- | 84.md | 42 |
1 files changed, 42 insertions, 0 deletions
| @@ -0,0 +1,42 @@ | |||
| 1 | NIP-84 | ||
| 2 | ====== | ||
| 3 | |||
| 4 | Highlights | ||
| 5 | ---------- | ||
| 6 | |||
| 7 | `draft` `optional` | ||
| 8 | |||
| 9 | This NIP defines `kind:9802`, a "highlight" event, to signal content a user finds valuable. | ||
| 10 | |||
| 11 | ## Format | ||
| 12 | The `.content` of these events is the highlighted portion of the text. | ||
| 13 | |||
| 14 | `.content` might be empty for highlights of non-text based media (e.g. NIP-94 audio/video). | ||
| 15 | |||
| 16 | ### References | ||
| 17 | Events SHOULD tag the source of the highlight, whether nostr-native or not. | ||
| 18 | `a` or `e` tags should be used for nostr events and `r` tags for URLs. | ||
| 19 | |||
| 20 | When tagging a URL, clients generating these events SHOULD do a best effort of cleaning the URL from trackers | ||
| 21 | or obvious non-useful information from the query string. | ||
| 22 | |||
| 23 | ### Attribution | ||
| 24 | Clients MAY include one or more `p` tags, tagging the original authors of the material being highlighted; this is particularly | ||
| 25 | useful when highlighting non-nostr content for which the client might be able to get a nostr pubkey somehow | ||
| 26 | (e.g. prompting the user or reading a `<meta name="nostr:nprofile1..." />` tag on the document). A role MAY be included as the | ||
| 27 | last value of the tag. | ||
| 28 | |||
| 29 | ```json | ||
| 30 | { | ||
| 31 | "tags": [ | ||
| 32 | ["p", "<pubkey-hex>", "<relay-url>", "author"], | ||
| 33 | ["p", "<pubkey-hex>", "<relay-url>", "author"], | ||
| 34 | ["p", "<pubkey-hex>", "<relay-url>", "editor"] | ||
| 35 | ], | ||
| 36 | ... | ||
| 37 | } | ||
| 38 | ``` | ||
| 39 | |||
| 40 | ### Context | ||
| 41 | Clients MAY include a `context` tag, useful when the highlight is a subset of a paragraph and displaying the | ||
| 42 | surrounding content might be beneficial to give context to the highlight. | ||