mirror of
https://github.com/nostr-protocol/nips.git
synced 2024-11-09 22:09:06 -05:00
118 lines
7.3 KiB
Markdown
118 lines
7.3 KiB
Markdown
NIP-54
|
|
======
|
|
|
|
Wiki
|
|
----
|
|
|
|
`draft` `optional`
|
|
|
|
This NIP defines `kind:30818` (a _parameterized replaceable 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.
|
|
|
|
Articles are identified by lowercase, normalized ascii `d` tags.
|
|
|
|
### Articles
|
|
```jsonc
|
|
{
|
|
"content": "A wiki is a hypertext publication collaboratively edited and managed by its own audience.",
|
|
"tags": [
|
|
["d", "wiki"],
|
|
["title", "Wiki"],
|
|
]
|
|
}
|
|
```
|
|
|
|
### `d` tag normalization rules
|
|
|
|
- Any non-letter character MUST be converted to a `-`.
|
|
- All letters MUST be converted to lowercase.
|
|
|
|
### Content rules
|
|
|
|
The content should be Markdown, following the same rules as of [NIP-23](23.md), although it takes some extra (optional) metadata 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.
|
|
|
|
One extra functionality is added: **wikilinks**. Unlike normal Markdown 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.
|
|
|
|
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`.
|
|
|
|
### 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.
|
|
|
|
[INSERT EVENT EXAMPLE]
|
|
|
|
### Redirects
|
|
|
|
Event `kind:30819` is also defined to stand for "wiki redirects", i.e. if one thinks `Shell structure` should redirect to `Thin-shell structure` 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](https://en.wikipedia.org/wiki/Help:Disambiguation)).
|
|
|
|
[INSERT EVENT EXAMPLE]
|
|
|
|
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:
|
|
|
|
### Reactions
|
|
|
|
[NIP-25](25.md) 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](51.md) 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](02.md) 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](51.md) 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.
|
|
|
|
Why Markdown?
|
|
-------------
|
|
|
|
If the idea is to make a wiki then the most obvious text format to use is probably the mediawiki/wikitext format used by Wikipedia since it's widely deployed in all mediawiki installations and used for decades with great success. However, it turns out that format is very bloated and convoluted, has way too many features and probably because of that it doesn't have many alternative implementations out there, and the ones that exist are not complete and don't look very trustworthy. Also it is very much a centralized format that can probably be changed at the whims of the Wikipedia owners.
|
|
|
|
On the other hand, Markdown has proven to work well for small scale wikis and one of the biggest wikis in the planet (which is not very often thought of as a wiki), [StackOverflow](https://stackoverflow.com) and its child sites, and also one of the biggest "personal wiki" software, [Obsidian](https://obsidian.md/). Markdown can probably deliver 95% of the functionality of wikitext. When augmented with tables, diagram generators and MathJax (which are common extensions that exist in the wild and can be included in this NIP) that rate probably goes to 99%, and its simplicity is a huge benefit that can't be overlooked. Wikitext format can also be transpíled into Markdown using Pandoc. Given all that, I think it's a reasonable suspicion that mediawiki is not inherently better than Markdown, the success of Wikipedia probably cannot be predicated on the syntax language choice.
|
|
|
|
# Appendix 1: Merge requests
|
|
Users can request other users to get their entries merged into someone else's entry by creating a `kind:818` event.
|
|
|
|
```jsonc
|
|
{
|
|
"content": "I added information about how to make hot ice-creams",
|
|
"kind": 818,
|
|
"tags": [
|
|
[ "a", "30818:<destination-pubkey>:hot-ice-creams", "<relay-url>" ],
|
|
[ "e", "<version-against-which-the-modification-was-made>", "<relay-url>' ],
|
|
[ "p", "<destination-pubkey>" ],
|
|
[ "e", "<version-to-be-merged>", "<relay-url>", "source" ]
|
|
]
|
|
}
|
|
```
|
|
|
|
`.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 in which this modifications is based
|
|
`e` tag with `source` marker: the ID of the event that should be merged. This event id MUST be of a `kind:30818` as defined in this NIP.
|
|
|
|
The destination-pubkey (the pubkey being requested to merge something into their article can create [[NIP-25]] reactions that tag the `kind:818` event with `+` or `-`
|