diff options
| author | Robert C. Martin <unclebob@cleancoder.com> | 2022-05-04 12:08:19 -0500 |
|---|---|---|
| committer | Robert C. Martin <unclebob@cleancoder.com> | 2022-05-04 12:08:19 -0500 |
| commit | 99c5425c42d700d27642e75b9361664e823dace4 (patch) | |
| tree | 2f2de1f3d023b1ad5efc531bb8609922ee459f5f | |
| parent | 39c7f54db6af511361a4622744edaa84f90d5914 (diff) | |
improve formatting
| -rw-r--r-- | e-and-p-tags.md | 26 |
1 files changed, 14 insertions, 12 deletions
diff --git a/e-and-p-tags.md b/e-and-p-tags.md index 16fdbef..447f9f8 100644 --- a/e-and-p-tags.md +++ b/e-and-p-tags.md | |||
| @@ -1,4 +1,4 @@ | |||
| 1 | # On 'e' and 'p' tags in Text Events (kind 1). | 1 | # On `e` and `p` tags in Text Events (kind 1). |
| 2 | ### A recommendation for clients. | 2 | ### A recommendation for clients. |
| 3 | 3 | ||
| 4 | The following seems to be the conventions that are used by `Branle`, `Damus`, and `more-speech` for referencing | 4 | The following seems to be the conventions that are used by `Branle`, `Damus`, and `more-speech` for referencing |
| @@ -10,24 +10,26 @@ replies. | |||
| 10 | * A reply thread is the tree of events consisting of all replies beginning at the root. | 10 | * A reply thread is the tree of events consisting of all replies beginning at the root. |
| 11 | * An event id is a 32 byte number in lower-case hexidecimal. | 11 | * An event id is a 32 byte number in lower-case hexidecimal. |
| 12 | 12 | ||
| 13 | ## The 'e' tag | 13 | ## The `e` tag |
| 14 | Used in a text event contains a single event id. ["e", "~hex number~"] | 14 | Used in a text event contains a single event id. ["e", "`hex-number`"] |
| 15 | 15 | ||
| 16 | * No 'e' tag: | 16 | * No `e` tag: |
| 17 | This event is not a reply to, nor does it refer to, any other event. | 17 | This event is not a reply to, nor does it refer to, any other event. |
| 18 | 18 | ||
| 19 | * One 'e' tag: ["e",id]: | 19 | * One `e` tag: ["e",`id`]: |
| 20 | The id of the event to which this event is a reply. | 20 | The id of the event to which this event is a reply. |
| 21 | 21 | ||
| 22 | * Two 'e' tags: ["e",root-id], ["e",reply-id] | 22 | * Two `e` tags: ["e",`root-id`], ["e",`reply-id`] |
| 23 | 'root-id' is the id of the event at the root of the reply chain. 'reply-id' is the id of the article to which this event is a reply. | 23 | 'root-id' is the `id` of the event at the root of the reply chain. `reply-id` is the id of the article to which this event is a reply. |
| 24 | 24 | ||
| 25 | * Many 'e' tags: ["e",root-id] ["e",mention-id], ..., ["e",reply-id] | 25 | * Many `e` tags: ["e",`root-id`] ["e",`mention-id`], ..., ["e",`reply-id`] |
| 26 | There may be any number of 'mention-ids'. These are the ids of events which may, or may not be in the reply chain. They are citings from this event. 'root-id' and 'reply-id' are as above. | 26 | There may be any number of `mention-ids`. These are the ids of events which may, or may not be in the reply chain. |
| 27 | They are citings from this event. `root-id` and `reply-id` are as above. | ||
| 27 | 28 | ||
| 28 | ## The 'p' tag | 29 | ## The `p` tag |
| 29 | Used in a text event contains a list of pubkeys used to record who is involved in a reply thread. | 30 | Used in a text event contains a list of pubkeys used to record who is involved in a reply thread. |
| 30 | 31 | ||
| 31 | When replying to a text event E with 'p' tags P, the replying event's 'p' tags should contain P as well as the pubkey of the of the event being replied to. | 32 | When replying to a text event E with `p` tags P, the replying event's `p` tags should contain P as well as the pubkey of the of the event being replied to. |
| 32 | 33 | ||
| 33 | Example: Given a text event authored by a1 with p tags [p1, p2, p3] then the p tags of the reply should be [a1, p1, p2, p3] in no particular order. | 34 | Example: Given a text event authored by a1 with `p` tags [`p1`, `p2`, `p3`] then the `p` tags of the reply should be [`a1`, `p1`, `p2`, `p3`] |
| 35 | in no particular order. | ||