diff options
| author | Terry Yiu <963907+tyiu@users.noreply.github.com> | 2023-12-08 09:59:44 -0800 |
|---|---|---|
| committer | Terry Yiu <963907+tyiu@users.noreply.github.com> | 2023-12-08 09:59:44 -0800 |
| commit | ec08d65665fd533be685702501b69fe9ce7bdd24 (patch) | |
| tree | 647b666a80be20392c695b6f53f2abce1ec1795a | |
| parent | b8308a9a040005c7a06369d6f71a6f2db6ee9c92 (diff) | |
Deprecate 'name' for 'title' on calendar events and add 'title' as a shared tag via NIP-24
| -rw-r--r-- | 24.md | 1 | ||||
| -rw-r--r-- | 52.md | 18 |
2 files changed, 13 insertions, 6 deletions
| @@ -39,3 +39,4 @@ tags | |||
| 39 | These tags may be present in multiple event kinds. Whenever a different meaning is not specified by some more specific NIP, they have the following meanings: | 39 | These tags may be present in multiple event kinds. Whenever a different meaning is not specified by some more specific NIP, they have the following meanings: |
| 40 | 40 | ||
| 41 | - `r`: a web URL the event is referring to in some way | 41 | - `r`: a web URL the event is referring to in some way |
| 42 | - `title`: title of the event | ||
| @@ -26,7 +26,7 @@ The `.content` of these events should be a detailed description of the calendar | |||
| 26 | 26 | ||
| 27 | The list of tags are as follows: | 27 | The list of tags are as follows: |
| 28 | * `d` (required) universally unique identifier (UUID). Generated by the client creating the calendar event. | 28 | * `d` (required) universally unique identifier (UUID). Generated by the client creating the calendar event. |
| 29 | * `name` (required) name of the calendar event | 29 | * `title` (required) title of the calendar event |
| 30 | * `start` (required) inclusive start date in ISO 8601 format (YYYY-MM-DD). Must be less than `end`, if it exists. | 30 | * `start` (required) inclusive start date in ISO 8601 format (YYYY-MM-DD). Must be less than `end`, if it exists. |
| 31 | * `end` (optional) exclusive end date in ISO 8601 format (YYYY-MM-DD). If omitted, the calendar event ends on the same date as `start`. | 31 | * `end` (optional) exclusive end date in ISO 8601 format (YYYY-MM-DD). If omitted, the calendar event ends on the same date as `start`. |
| 32 | * `location` (optional, repeated) location of the calendar event. e.g. address, GPS coordinates, meeting room name, link to video call | 32 | * `location` (optional, repeated) location of the calendar event. e.g. address, GPS coordinates, meeting room name, link to video call |
| @@ -35,6 +35,9 @@ The list of tags are as follows: | |||
| 35 | * `t` (optional, repeated) hashtag to categorize calendar event | 35 | * `t` (optional, repeated) hashtag to categorize calendar event |
| 36 | * `r` (optional, repeated) references / links to web pages, documents, video calls, recorded videos, etc. | 36 | * `r` (optional, repeated) references / links to web pages, documents, video calls, recorded videos, etc. |
| 37 | 37 | ||
| 38 | The following tags are deprecated: | ||
| 39 | * `name` name of the calendar event. Use only if `title` is not available. | ||
| 40 | |||
| 38 | ```json | 41 | ```json |
| 39 | { | 42 | { |
| 40 | "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, | 43 | "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, |
| @@ -45,7 +48,7 @@ The list of tags are as follows: | |||
| 45 | "tags": [ | 48 | "tags": [ |
| 46 | ["d", "<UUID>"], | 49 | ["d", "<UUID>"], |
| 47 | 50 | ||
| 48 | ["name", "<name of calendar event>"], | 51 | ["title", "<title of calendar event>"], |
| 49 | 52 | ||
| 50 | // Dates | 53 | // Dates |
| 51 | ["start", "<YYYY-MM-DD>"], | 54 | ["start", "<YYYY-MM-DD>"], |
| @@ -82,7 +85,7 @@ The `.content` of these events should be a detailed description of the calendar | |||
| 82 | 85 | ||
| 83 | The list of tags are as follows: | 86 | The list of tags are as follows: |
| 84 | * `d` (required) universally unique identifier (UUID). Generated by the client creating the calendar event. | 87 | * `d` (required) universally unique identifier (UUID). Generated by the client creating the calendar event. |
| 85 | * `name` (required) name of the calendar event | 88 | * `title` (required) title of the calendar event |
| 86 | * `start` (required) inclusive start Unix timestamp in seconds. Must be less than `end`, if it exists. | 89 | * `start` (required) inclusive start Unix timestamp in seconds. Must be less than `end`, if it exists. |
| 87 | * `end` (optional) exclusive end Unix timestamp in seconds. If omitted, the calendar event ends instantaneously. | 90 | * `end` (optional) exclusive end Unix timestamp in seconds. If omitted, the calendar event ends instantaneously. |
| 88 | * `start_tzid` (optional) time zone of the start timestamp, as defined by the IANA Time Zone Database. e.g., `America/Costa_Rica` | 91 | * `start_tzid` (optional) time zone of the start timestamp, as defined by the IANA Time Zone Database. e.g., `America/Costa_Rica` |
| @@ -93,6 +96,9 @@ The list of tags are as follows: | |||
| 93 | * `t` (optional, repeated) hashtag to categorize calendar event | 96 | * `t` (optional, repeated) hashtag to categorize calendar event |
| 94 | * `r` (optional, repeated) references / links to web pages, documents, video calls, recorded videos, etc. | 97 | * `r` (optional, repeated) references / links to web pages, documents, video calls, recorded videos, etc. |
| 95 | 98 | ||
| 99 | The following tags are deprecated: | ||
| 100 | * `name` name of the calendar event. Use only if `title` is not available. | ||
| 101 | |||
| 96 | ```json | 102 | ```json |
| 97 | { | 103 | { |
| 98 | "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, | 104 | "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, |
| @@ -103,7 +109,7 @@ The list of tags are as follows: | |||
| 103 | "tags": [ | 109 | "tags": [ |
| 104 | ["d", "<UUID>"], | 110 | ["d", "<UUID>"], |
| 105 | 111 | ||
| 106 | ["name", "<name of calendar event>"], | 112 | ["title", "<title of calendar event>"], |
| 107 | 113 | ||
| 108 | // Timestamps | 114 | // Timestamps |
| 109 | ["start", "<Unix timestamp in seconds>"], | 115 | ["start", "<Unix timestamp in seconds>"], |
| @@ -141,7 +147,7 @@ The `.content` of these events should be a detailed description of the calendar. | |||
| 141 | 147 | ||
| 142 | The format uses a custom replaceable list of kind `31924` with a list of tags as described below: | 148 | The format uses a custom replaceable list of kind `31924` with a list of tags as described below: |
| 143 | * `d` (required) universally unique identifier. Generated by the client creating the calendar. | 149 | * `d` (required) universally unique identifier. Generated by the client creating the calendar. |
| 144 | * `name` (required) calendar name | 150 | * `title` (required) calendar title |
| 145 | * `a` (repeated) reference tag to kind `31922` or `31923` calendar event being responded to | 151 | * `a` (repeated) reference tag to kind `31922` or `31923` calendar event being responded to |
| 146 | 152 | ||
| 147 | ```json | 153 | ```json |
| @@ -153,7 +159,7 @@ The format uses a custom replaceable list of kind `31924` with a list of tags as | |||
| 153 | "content": "<description of calendar>", | 159 | "content": "<description of calendar>", |
| 154 | "tags": [ | 160 | "tags": [ |
| 155 | ["d", "<UUID>"], | 161 | ["d", "<UUID>"], |
| 156 | ["name", "<calendar name>"], | 162 | ["title", "<calendar title>"], |
| 157 | ["a", "<31922 or 31923>:<calendar event author pubkey>:<d-identifier of calendar event>", "<optional relay url>"], | 163 | ["a", "<31922 or 31923>:<calendar event author pubkey>:<d-identifier of calendar event>", "<optional relay url>"], |
| 158 | ["a", "<31922 or 31923>:<calendar event author pubkey>:<d-identifier of calendar event>", "<optional relay url>"] | 164 | ["a", "<31922 or 31923>:<calendar event author pubkey>:<d-identifier of calendar event>", "<optional relay url>"] |
| 159 | ] | 165 | ] |