diff options
Diffstat (limited to 'B0.md')
| -rw-r--r-- | B0.md | 22 |
1 files changed, 7 insertions, 15 deletions
| @@ -6,31 +6,23 @@ Web Bookmarking | |||
| 6 | 6 | ||
| 7 | `draft` `optional` | 7 | `draft` `optional` |
| 8 | 8 | ||
| 9 | This NIP defines `kind:39701` (an _addressable event_) for a URI as a web bookmark which uses the HTTP (Hypertext transfer protocol) scheme. | 9 | This NIP defines `kind:39701` for a URI as editable web bookmark which uses the HTTP scheme. |
| 10 | These web bookmark events are _addressable_ and deletable per [NIP-09](09.md). | ||
| 11 | |||
| 12 | ### Editability | ||
| 13 | |||
| 14 | Web bookmarks are meant to be editable, so they should include a `d` tag with an identifier for the bookmark. Clients should take care to only publish and read these events from relays that implement that. If they don't do that they should also take care to hide old versions of the same bookmark they may receive. | ||
| 15 | 10 | ||
| 16 | ### Format | 11 | ### Format |
| 17 | 12 | ||
| 18 | The format uses an _addressable event_ of `kind:39701`. | 13 | The format uses `kind:39701`. |
| 19 | 14 | ||
| 20 | The `.content` of these events should be a detailed description of the web bookmark. It is required but can be an empty string. | 15 | The `.content` should be a detailed description of the web bookmark. It can be an empty string. |
| 21 | 16 | ||
| 22 | The `d` tag is required. | 17 | The `d` tag is just their URL without the scheme, which is always and everywhere assumed to be `https://` or `http://`. |
| 23 | 18 | ||
| 24 | In this way web bookmarks events can be queried by the `d` tag by clients, which is just their URL without the scheme, which is always and everywhere assumed to be `https://` or `http://`. | 19 | In this way web bookmarks events can be queried by the `d` tag by clients. |
| 25 | |||
| 26 | The querystring and the hash must be removed entirely, unless their requirement is explicitly stated either by the user or by some hardcoded list of URLs that rely on querystrings for basic routing provided by the client. | ||
| 27 | 20 | ||
| 28 | ### Metadata | 21 | ### Metadata |
| 29 | 22 | ||
| 30 | For the date of the last update the `.created_at` field should be used. For "tags"/"hashtags" (i.e. topics about which the event might be of relevance) the `t` tag should be used. | 23 | Metadata fields can be added as tags to the event as necessary. |
| 31 | |||
| 32 | Other metadata fields can be added as tags to the event as necessary. | ||
| 33 | 24 | ||
| 25 | * `"t"`, for "tags"/"hashtags" (i.e. topics about which the event might be of relevance) | ||
| 34 | * `"published_at"`, for the timestamp in unix seconds (stringified) of the first time the bookmark was published | 26 | * `"published_at"`, for the timestamp in unix seconds (stringified) of the first time the bookmark was published |
| 35 | * `"title"`, title about bookmark and can be used as a attribute for the HTML link element | 27 | * `"title"`, title about bookmark and can be used as a attribute for the HTML link element |
| 36 | 28 | ||