From 25fe9a870d8a1023dac57b49ca8f92ef7128539e Mon Sep 17 00:00:00 2001 From: Timur Ismagilov Date: Mon, 11 Jul 2022 14:21:25 +0500 Subject: [PATCH] Help, Interwiki: Write the doc --- help/en/interwiki.myco | 32 ++++++++++++++++++++++++++++++++ help/view_help.html | 1 + help/web.go | 3 ++- 3 files changed, 35 insertions(+), 1 deletion(-) create mode 100644 help/en/interwiki.myco diff --git a/help/en/interwiki.myco b/help/en/interwiki.myco new file mode 100644 index 0000000..466b654 --- /dev/null +++ b/help/en/interwiki.myco @@ -0,0 +1,32 @@ += Interwiki +**Interwiki** is a means of bringing wikis together, making a federation of them. In Mycorrhiza, one aspect of interwiki is supported: the interwiki links, or the **interlinks**. Most other wiki systems support it too. Interwiki links are shown in green. + +In Mycomarkup, you can address a different wiki by prefixing the link target with a name and a `>` character. For example: +```myco +[[Wikipedia>Wiki]] +=> Mycorrhiza>deployment +``` + +The interwiki prefixes obey the same naming rules as hyphae. In particular, they are case-insensitive, among other things. Every interwiki entry has one main name and it might have any number of aliases, which can be used interchangeably. + +See [[/interwiki]] for the list of configured interwiki entries. Unlike the WWW, there is no distributed list of wikis, so each wiki administrator has to maintain their own list. + +== Mycorrhiza interwiki +Intermycorrhizal interwiki works the best, due to the nature of hyphae. Unlike with other systems, you can address images from the other wikis reliably. + +```myco +img { + melanocarpa +} +``` + +== Setting the intermap +//This section is meant for wiki administrators.// +**Intermap**, or interwiki map, is the collection of all configured interwiki entries. To configure it, an administrator has to visit [[/interwiki]] and change the existing entries or add a new one. + +You can also change `interwiki.json` directly. + +There are three supported engine types: +* `mycorrhiza` is used for Mycorrhiza wikis. +* `agora` is used for intances of Agora, such as [[https://anagora.org]]. +* `generic` is used for everything else. diff --git a/help/view_help.html b/help/view_help.html index b5b3fe7..b20e286 100644 --- a/help/view_help.html +++ b/help/view_help.html @@ -42,6 +42,7 @@
  • {{block "lock" .}}Lock{{end}}
  • {{block "whitelist" .}}Whitelist{{end}}
  • {{block "telegram" .}}Telegram authentication{{end}}
    • +
  • {{block "interwiki" .}}Interwiki{{end}}
    • diff --git a/help/web.go b/help/web.go index bcb0bfd..462a808 100644 --- a/help/web.go +++ b/help/web.go @@ -18,7 +18,7 @@ var ( ruTranslation = ` {{define "title"}}Справка{{end}} {{define "entry not found"}}Статья не найдена{{end}} -{{define "entry not found invitation"}}Если вы хотите написать эту статью сами, то будем рады вашим правкам в репозитории Миокризы.{{end}} +{{define "entry not found invitation"}}Если вы хотите написать эту статью сами, то будем рады вашим правкам в репозитории Микоризы.{{end}} {{define "topics"}}Темы справки{{end}} {{define "main"}}Введение{{end}} @@ -40,6 +40,7 @@ var ( {{define "lock"}}Замок{{end}} {{define "whitelist"}}Белый список{{end}} {{define "telegram"}}Вход через Телеграм{{end}} +{{define "interwiki"}}Интервики{{end}} ` )