NIP-54

Wiki

draft optional

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 d tags.

Articles

{
  "content": "A wiki is a hypertext publication collaboratively edited and managed by its own audience.",
  "tags": [
    ["d", "wiki"],
    ["title", "Wiki"]
  ]
}

d tag normalization rules

• All letters with uppercase/lowercase variants MUST be converted to lowercase.
• Whitespace MUST be converted to -.
• Punctuation and symbols SHOULD be removed.
• Multiple consecutive - SHOULD be collapsed to a single -.
• Leading and trailing - SHOULD be removed.
• Non-ASCII letters (e.g., Japanese, Chinese, Arabic, Cyrillic) MUST be preserved as UTF-8.
• Numbers MUST be preserved.

For example:

• "Wiki Article" → "wiki-article"
• "What's Up?" → "whats-up"
• " Hello World " → "hello-world"
• "Article 1" → "article-1"
• "ウィキペディア" → "ウィキペディア" (Japanese, no case change)
• "Ñoño" → "ñoño" (Spanish, lowercased)
• "Москва" → "москва" (Russian, lowercased)
• "日本語 Article" → "日本語-article" (mixed scripts)

Content

The content should be Asciidoc with two extra functionalities: wikilinks and nostr:… links.

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 forms:

1. [[Target Page]] – links to target-page and displays as Target Page;
2. [[target page|see this]] – links to target-page but displays as see this;
3. [[日本語 Topic|Japanese Topic]] – links to 日本語-topic and displays as Japanese Topic.

nostr:... links 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.

{
  "content": "I added information about the block size limit",
  "kind": 818,
  "tags": [
    ["a", "30818:<destination-pubkey>:bitcoin", "<relay-url>"],
    ["e", "<version-against-which-the-modification-was-made>", "<relay-url>"],
    ["p", "<destination-pubkey>"],
    ["e", "<version-to-be-merged>", "<relay-url>", "fork"]
  ]
}

• .content: an optional explanation detailing why this merge is being requested.
• a tag: tag of the article which should be modified (i.e. the target of this merge request).
• e tag: optional version of the article on which this modification is based.
• e tag with fork marker: the ID of the event that should be merged. This event id MUST be of a kind:30818 as defined in this NIP, and SHOULD be the forked version that carries the fork marker.

Accepting or rejecting a merge request

The destination pubkey can respond to a kind:818 merge request in either of two ways:

1. NIP-25 reaction — a reaction event that tags the kind:818 event with + to accept or - to reject the merge request. This is the lightweight signal and does not, by itself, publish the merged content.

2. kind:819 merge acceptance — when the destination pubkey actually merges the change (by publishing a new version of their kind:30818 article that incorporates the proposed content), they MAY publish a kind:819 event to explicitly record that the merge request was accepted and to point at the resulting version.

{
  "kind": 819,
  "content": "",
  "tags": [
    ["e", "<id-of-the-resulting-merged-version>", "<relay-url>", "result"],
    ["e", "<id-of-the-kind-818-merge-request>", "<relay-url>", "request"],
    ["p", "<pubkey-of-the-merge-request-author>"]
  ]
}

• e tag with result marker: the ID of the newly published kind:30818 version that contains the merged changes.
• e tag with request marker: the ID of the kind:818 merge request that was accepted.
• p tag: the pubkey of the author who submitted the merge request, so they can be notified that their contribution was incorporated.

Clients SHOULD treat a kind:819 event as a stronger, affirmative signal than a + reaction, since it also links to the concrete merged version. A merge request MAY be accepted with a kind:819 event, a + reaction, or both.

Redirects

Event kind:30819 is also defined to stand for “wiki redirects”, i.e. if one thinks “BTC” should redirect to “Bitcoin” they can issue one of these events instead of replicating the content. These events can be used for automatically redirecting between articles on a client, but also for generating crowdsourced “disambiguation” pages (common in Wikipedia).

{
  "kind": 30819,
  "tags": [
    ["d", "btc"],
    ["a", "30818:<pubkey>:bitcoin", "<relay-url>"]
  ],
  "content": ""
}

How to decide what article to display

As there could be many articles for each given name, some kind of prioritization must be done by clients. Criteria for this should vary between users and clients, but some means that can be used are described below:

Pages and Recommendations from Sender

If someone includes a wikilink in their note, their wiki page on the subject, or the page(s) they have deferred to or positively reacted to, might be ranked higher on the results page.

Reactions

NIP-25 reactions are very simple and can be used to create a simple web-of-trust between wiki article writers and their content. While just counting a raw number of “likes” is unproductive, reacting to any wiki article event with a + can be interpreted as a recommendation for that article specifically and a partial recommendation of the author of that article. When 2 or 3-level deep recommendations are followed, suddenly a big part of all the articles may have some form of tagging.

Relays

NIP-51 lists of relays can be created with the kind 10102 and then used by wiki clients in order to determine where to query articles first and to rank these differently in relation to other events fetched from other relays.

Contact lists

NIP-02 contact lists can form the basis of a recommendation system that is then expanded with relay lists and reaction lists through nested queries. These lists form a good starting point only because they are so widespread.

Wiki-related contact lists

NIP-51 lists can also be used to create a list of users that are trusted only in the context of wiki authorship or wiki curationship.

Forks

Wiki-events can tag other wiki-events with a fork marker to specify that this event came from a different version. Both a and e tags SHOULD be used and have the fork marker applied, to identify the exact version it was forked from.

Deference

Wiki-events can tag other wiki-events with a defer marker to indicate that it considers someone else’s entry as a “better” version of itself. If using a defer marker both a and e tags SHOULD be used.

This is a stronger signal of trust than a + reaction.

This marker is useful when a user edits someone else’s entry; if the original author includes the editor’s changes and the editor doesn’t want to keep/maintain an independent version, the link tag could effectively be a considered a “deletion” of the editor’s version and putting that pubkey’s WoT weight behind the original author’s version.