From 378dfaa5dbf44bd1f17fd70f8727b636b7c99239 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Tue, 3 Sep 2024 14:07:46 -0300 Subject: [PATCH] nip54: remove markdown leftovers. --- 54.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/54.md b/54.md index cf225448..39528cf9 100644 --- a/54.md +++ b/54.md @@ -6,7 +6,7 @@ Wiki `draft` `optional` -This NIP defines `kind:30818` (an _addressable event_) for long-form text content similar to [NIP-23](23.md), but with one important difference: articles are meant to be descriptions, or encyclopedia entries, of particular subjects, and it's expected that multiple people will write articles about the exact same subjects, with either small variations or completely independent content. +This NIP defines `kind:30818` (an _addressable event_) for descriptions (or encyclopedia entries) of particular subjects, and it's expected that multiple people will write articles about the exact same subjects, with either small variations or completely independent content. Articles are identified by lowercase, normalized ascii `d` tags. @@ -26,21 +26,25 @@ Articles are identified by lowercase, normalized ascii `d` tags. - Any non-letter character MUST be converted to a `-`. - All letters MUST be converted to lowercase. -### Content rules +### Content -The content should be Asciidoc, following the same rules as of [NIP-23](23.md), although it takes some extra (optional) metadata tags: +The `content` should be Asciidoc with two extra functionalities: **wikilinks** and **nostr:...** links. - - `title`: for when the display title should be different from the `d` tag. - - `summary`: for display in lists. - - `a` and `e`: for referencing the original event a wiki article was forked from. - -One extra functionality is added: **wikilinks**. Unlike normal Asciidoc links `[]()` that link to webpages, wikilinks `[[]]` link to other articles in the wiki. In this case, the wiki is the entirety of Nostr. Clicking on a wikilink should cause the client to ask relays for events with `d` tags equal to the target of that wikilink. +Unlike normal Asciidoc links `http://example.com[]` that link to external webpages, wikilinks `[[]]` link to other articles in the wiki. In this case, the wiki is the entirety of Nostr. Clicking on a wikilink should cause the client to ask relays for events with `d` tags equal to the target of that wikilink. Wikilinks can take these two forms: 1. `[[Target Page]]` -- in this case it will link to the page `target-page` (according to `d` tag normalization rules above) and be displayed as `Target Page`; 2. `[[target page|see this]]` -- in this case it will link to the page `target-page`, but will be displayed as `see this`. +`nostr:...` links, as per [NIP-21](21.md), should link to profiles or arbitrary Nostr events. Although it is not recommended to link to specific versions of articles -- instead the _wikilink_ syntax should be preferred, since it should be left to the reader and their client to decide what version of any given article they want to read. + +### Optional extra tags + + - `title`: for when the display title should be different from the `d` tag. + - `summary`: for display in lists. + - `a` and `e`: for referencing the original event a wiki article was forked from. + ### Merge Requests Event `kind:818` represents a request to merge from a forked article into the source. It is directed to a pubkey and references the original article and the modified event.