mirror of
https://github.com/osmarks/mycorrhiza.git
synced 2024-12-12 05:20:26 +00:00
Help: Delete Russian docs
This commit is contained in:
Timur Ismagilov
parent
2db10a2e7e
commit
2ac1874882
@ -6,7 +6,6 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
//go:embed en en.myco
|
//go:embed en en.myco
|
||||||
//go:embed ru ru.myco
|
|
||||||
var fs embed.FS
|
var fs embed.FS
|
||||||
|
|
||||||
// Get determines what help text you need and returns it. The path is a substring from URL, it follows this form:
|
// Get determines what help text you need and returns it. The path is a substring from URL, it follows this form:
|
||||||
|
|||||||
@ -1,9 +0,0 @@
|
|||||||
# Справка
|
|
||||||
|
|
||||||
Это документация к **вики-движку Микориза** версии **1.7** ([[https://mycorrhiza.wiki | официальная вики]]).
|
|
||||||
|
|
||||||
**Выберите тему из списка.**
|
|
||||||
|
|
||||||
В настоящее время документация охватывает не всё, что должна охватить, но в будущем это наверняка изменится.
|
|
||||||
|
|
||||||
Если вы хотите внести правки в эту документацию, создайте pull request или issue в [[https://github.com/bouncepaw/mycorrhiza | репозитории на GitHub]].
|
|
||||||
@ -1,34 +0,0 @@
|
|||||||
# Справка: Вложение
|
|
||||||
В контексте гиф **вложение** — это содержимое, представленное в виде ином, чем [[/help/ru/mycomarkup | микоразметка]]. Чаще всего это изображение, видео или аудио.
|
|
||||||
|
|
||||||
## Поддерживаемые типы вложений
|
|
||||||
Вы можете загружать любые файлы, но только перечисленные ниже будут отображаться на странице. Но в то же время вы можете скачивать неподдерживаемые вложения.
|
|
||||||
|
|
||||||
* **Изображения:** jpg, gif, png, webp, svg, ico
|
|
||||||
* **Видео:** ogg, webm, mp4
|
|
||||||
* **Аудио:** ogg, webm, mp3
|
|
||||||
|
|
||||||
## Как добавить вложение?
|
|
||||||
Для несуществующих гиф, загрузите файл в разделе //Загрузить медиа//.
|
|
||||||
|
|
||||||
Также для всех гиф есть ссылка //Вложение// в подвале.
|
|
||||||
|
|
||||||
## Управление вложением
|
|
||||||
У каждой гифы есть раздел //Вложение//. Нажмите на ссылку в подвале, чтобы увидеть, что в нём находится.
|
|
||||||
|
|
||||||
Здесь вы можете загрузить новый файл, //удалить// вложение (здесь это называется //открепление//) и посмотреть свойства файла (размер и тип).
|
|
||||||
|
|
||||||
## Об именовании гиф с вложениями
|
|
||||||
В большинстве случаев название гифы не должно просто копировать название файла. Если вы загружаете фотографию розы, не называйте её `rose.jpg`, нет. Назовите её `фотография розы` или `фото розы` или как-нибудь иначе. В работе с Микоризой вам очень редко понадобится обращаться к расширениям файлов.
|
|
||||||
|
|
||||||
Конечно, это не правило, скорее просто соглашение.
|
|
||||||
|
|
||||||
## Что поместить в текстовую часть?
|
|
||||||
Если у гиф есть вложение, о чём может быть текстовая часть:
|
|
||||||
* Текстовое описание или представление изображения.
|
|
||||||
* Транскрипт песни.
|
|
||||||
* Анализ вложения.
|
|
||||||
* Какие-нибудь метаданные.
|
|
||||||
* Сочетание перечисленного выше.
|
|
||||||
|
|
||||||
Вложение //не должно// быть иллюстрацией текстовой части. В подобных случаях лучше загрузить его в подгифу и добавить ссылку в разметку.
|
|
||||||
@ -1,41 +0,0 @@
|
|||||||
# Справка: Ленты
|
|
||||||
В Микоризе можно подписаться на недавние изменения на вики через RSS, Atom или JSON-ленту.
|
|
||||||
|
|
||||||
Ссылки на все три ленты есть на [[/recent-changes | странице недавних изменений]].
|
|
||||||
|
|
||||||
## Опции
|
|
||||||
Можно настроить группировку правок в лентах при помощи опций в URL:
|
|
||||||
* {
|
|
||||||
**period** — период, например: `5m`, `24h`...
|
|
||||||
|
|
||||||
Правки от одного и того же автора, которые совершены в течение этого времени будут обьединены в одну запись в ленте.
|
|
||||||
}
|
|
||||||
* {
|
|
||||||
**same** — свойство, по которому обьединяются правки в ленте: `author`, `message` или `none`.
|
|
||||||
|
|
||||||
По умолчанию, у правок должны быть одинаковые авторы и описания. Вы можете сделать так, чтобы обьединялись только по автору (`author`) или только по описанию (`message`). Если задать `none`, все правки могут быть сгруппированы.
|
|
||||||
}
|
|
||||||
* {
|
|
||||||
**order** — порядок: от старого к новому `old-to-now` (по умолчанию) или от нового к старому `new-to-old`.
|
|
||||||
}
|
|
||||||
|
|
||||||
Если ничего не настраивать, то правки не будут группироваться.
|
|
||||||
|
|
||||||
## Примеры
|
|
||||||
URL для лент с использованием этих опций выглядят так:
|
|
||||||
* {
|
|
||||||
`/recent-changes-rss?period=1h`
|
|
||||||
Правки за час от одного автора с одинаковым описанием будут сгруппированы.
|
|
||||||
}
|
|
||||||
* {
|
|
||||||
`/recent-changes-atom?period=1h&order=new-to-old`
|
|
||||||
То же самое, но в обратном порядке.
|
|
||||||
}
|
|
||||||
* {
|
|
||||||
`/recent-changes-atom?period=1h&same=none`
|
|
||||||
Любые правки в течение одного часа будут обьединены.
|
|
||||||
}
|
|
||||||
* {
|
|
||||||
`/recent-changes-atom?same=author&same=message`
|
|
||||||
Правки от одного автора и с одинаковым описаниемм будут группироваться независимо от времени между ними.
|
|
||||||
}
|
|
||||||
@ -1,35 +0,0 @@
|
|||||||
# Справка: Гифа
|
|
||||||
**Гифа** (//англ.// hypha, //мн.// hyphae) — основная единица содержимого, используемая в Микоризе.
|
|
||||||
|
|
||||||
## Структура гифы
|
|
||||||
Гифа состоит из двух частей:
|
|
||||||
* **Вложение.** Определённый вид медиаданных. Гифа может содержать только одно вложение. См. [[/help/ru/attachment | Вложение]], чтобы узнать больше.
|
|
||||||
* **Текстовая часть.** Это либо описание вложения, либо самостоятельная единица текста, будь то статья, дневник или стих. Пишется с помощью специальной разметки, называемой [[/help/ru/mycomarkup | микоразметкой]].
|
|
||||||
|
|
||||||
Эти части сами по себе необязательны. Вы можете разместить картинку без описания, статью без вложения и т.д. Можете использовать обе части вместе. Но минимум одна из них обязана присутствовать.
|
|
||||||
|
|
||||||
## Как создать гифу?
|
|
||||||
Некоторые ссылки в вики окрашены красным. Это означает, что они ведут на ещё не существующую гифу. Если вы пройдёте по ссылке, вы увидите специальную страницу, на которой можно загрузить вложение или перейти в текстовый редактор. Таким образом и создаются гифы.
|
|
||||||
|
|
||||||
Вы можете создавать подобные красные ссылки и переходить по ним, чтобы создавать новые гифы.
|
|
||||||
|
|
||||||
Как вариант, можно прописать нужный адрес в браузере, чтобы перейти сразу на страницу создания.
|
|
||||||
|
|
||||||
## Названия гиф
|
|
||||||
Названия гиф регистронезависимы. Это значит, что названия //amanita muscaria// и //Amanita Muscaria// указывают на одну и ту же гифу. Также эквивалентны пробел и знак подчёркивания (//amanita muscaria// = //amanita_muscaria//). Канонические названия пишутся полностью в нижнем регистре и через подчёркивания.
|
|
||||||
|
|
||||||
Есть символы, которые нельзя использовать в названии: `?!:#@><*|"'&%{}\\` Остальные можно.
|
|
||||||
|
|
||||||
## Генеалогия
|
|
||||||
**Подгифа** — это гифа, название которой начинается с названия другой гифы, после чего через косую черту (слэш) следует собственная часть названия. Например, гифа //Фрукт/Яблоко// является подгифой для //Фрукт//. Подгиф может быть сколько угодно, а подгифы могут содержать свои подгифы.
|
|
||||||
|
|
||||||
Так, **надгифа** (superhypha) — обратное подгифе: //Фрукт// — надгифа для //Фрукт/Яблоко//. Существует лишь одна надгифа.
|
|
||||||
|
|
||||||
**Гифы-сиблинги** — гифы, являющиеся подгифами одной и той же гифы. Например, //Фрукт/Яблоко// и //Фрукт/Груша// приходятся сиблингами.
|
|
||||||
|
|
||||||
## Слово
|
|
||||||
Английское слово //hypha// произносится как /ˈhaɪfə/. Множественная форма — //hyphae//. Произносите её как /ˈhaɪfi/.
|
|
||||||
|
|
||||||
Слово «гифа» происходит из микологии, науки о грибах. Им обозначают тонкие белые нити, формирующие мицелий. См. [[https://en.wikipedia.org/wiki/Hypha | эту статью на Википедии]], чтобы узнать больше о настоящих гифах.
|
|
||||||
|
|
||||||
Рассматривайте гифы Микоризы как малые элементы, из которых строится ваша вики.
|
|
||||||
@ -1,27 +0,0 @@
|
|||||||
# Блокировка
|
|
||||||
//Эта статья предназначена для администраторов вики.//
|
|
||||||
|
|
||||||
Иногда вы можете захотеть, чтобы доступ к вики имели только авторизованные пользователи. В таких случаях пригодится **блокировка**.
|
|
||||||
|
|
||||||
## Включение
|
|
||||||
Чтобы включить блокировку, в `config.ini` поменяйте значение `Locked` на `true`. `UseAuth` также должен быть `true`.
|
|
||||||
```ini
|
|
||||||
...
|
|
||||||
[Authorization]
|
|
||||||
UseAuth = true
|
|
||||||
Locked = true
|
|
||||||
...
|
|
||||||
```
|
|
||||||
|
|
||||||
Перезагрузите вики.
|
|
||||||
|
|
||||||
## Применение
|
|
||||||
Когда неавторизованные гости зайдут на вашу вики, они увидят что-то похожее на это:
|
|
||||||
img {
|
|
||||||
https://mycorrhiza.wiki/binary/release/1.3/lock_screenshot
|
|
||||||
}
|
|
||||||
|
|
||||||
После авторизации они смогут просматривать вики. Но зарегистрироваться отсюда они не могут. Поддерживается авторизация через [[/help/ru/telegram | Телеграм]].
|
|
||||||
|
|
||||||
## См. также
|
|
||||||
=> /help/ru/whitelist Белый список
|
|
||||||
@ -1,397 +0,0 @@
|
|||||||
# Микоразметка
|
|
||||||
**Микоразметка** — это собственный язык разметки в Микоризе.
|
|
||||||
|
|
||||||
Это единственная поддерживаемая разметка; другие разметки, будь то Markdown, Creole и прочие, не поддерживаются.
|
|
||||||
|
|
||||||
Документ в микоразметке (чаще всего это текстовая часть гифы) состоит из //блоков//. Для разных задач существуют разные блоки.
|
|
||||||
|
|
||||||
## Содержание
|
|
||||||
=> /help/ru/mycomarkup#Абзац Абзац
|
|
||||||
=> /help/ru/mycomarkup#Внутритекстовая_ссылка Внутритекстовая ссылка
|
|
||||||
=> /help/ru/mycomarkup#Ссылка_ракета Ссылка-ракета
|
|
||||||
=> /help/ru/mycomarkup#Заголовок Заголовок
|
|
||||||
=> /help/ru/mycomarkup#Код_блок Код-блок
|
|
||||||
=> /help/ru/mycomarkup#Горизонтальная_черта Горизонтальная черта
|
|
||||||
=> /help/ru/mycomarkup#Галерея_изображений Галерея изображений
|
|
||||||
=> /help/ru/mycomarkup#Список Список
|
|
||||||
=> /help/ru/mycomarkup#Цитата Цитата
|
|
||||||
=> /help/ru/mycomarkup#Таблица Таблица
|
|
||||||
=> /help/ru/mycomarkup#Трансклюзия Трансклюзия
|
|
||||||
|
|
||||||
## Абзац
|
|
||||||
**Абзацы** — самые распространённые блоки. Вы будете использовать их чаще остальных.
|
|
||||||
|
|
||||||
Чтобы создать абзац, просто напишите текст. Абзацы отделяются друг от друга пустыми строками.
|
|
||||||
|
|
||||||
* {```
|
|
||||||
Первый абзац
|
|
||||||
|
|
||||||
Второй абзац
|
|
||||||
Вторая строка второго абзаца
|
|
||||||
```}
|
|
||||||
* {
|
|
||||||
Первый абзац
|
|
||||||
|
|
||||||
Второй абзац
|
|
||||||
Вторая строка второго абзаца
|
|
||||||
}
|
|
||||||
|
|
||||||
Вы можете применять стили к содержимому абзаца.
|
|
||||||
* {```
|
|
||||||
Вы можете использовать //курсив//, **жирный**, `моноширинный`, ++выделенный++, ^^надстрочный^^, __подчёркнутый__, ,,подстрочный,, или ~~зачёркнутый~~ текст. А также вы можете их ++**//сочетать//**++!
|
|
||||||
```}
|
|
||||||
* Вы можете использовать //курсив//, **жирный**, `моноширинный`, ++выделенный++, ^^надстрочный^^, __подчёркнутый__, ,,подстрочный,, или ~~зачёркнутый~~ текст. А также вы можете их ++**//сочетать//**++!
|
|
||||||
|
|
||||||
Используйте обратный слэш (`\`), чтобы отменить стиль.
|
|
||||||
* {```
|
|
||||||
Это не \//курсив\//
|
|
||||||
```}
|
|
||||||
* Это не \//курсив\//
|
|
||||||
|
|
||||||
Вы можете не закрывать декоратор, и тогда стиль будет действовать до конца строки.
|
|
||||||
* {```
|
|
||||||
Это //курсив
|
|
||||||
А это — нет
|
|
||||||
```}
|
|
||||||
* {
|
|
||||||
Это //курсив
|
|
||||||
А это — нет
|
|
||||||
}
|
|
||||||
|
|
||||||
Вы можете добавлять ссылки.
|
|
||||||
* {```
|
|
||||||
Просто абзац с парой [[https://example.org | ссылок]], ведущих [[никуда]].
|
|
||||||
```}
|
|
||||||
* Просто абзац с парой [[https://example.org | ссылок]], ведущих [[никуда]].
|
|
||||||
|
|
||||||
## Ссылка
|
|
||||||
### Внутритекстовая ссылка
|
|
||||||
**Внутритекстовые ссылки** размещаются внутри абзацев.
|
|
||||||
|
|
||||||
Внешние ссылки можно помещать как есть, если они содержат протокольную часть. Такие ссылки называются автоссылками. Но иногда они могут работать не совсем, как от них ожидается. Автоссылки поддерживаются для протоколов https, http, gemini, gopher и ftp.
|
|
||||||
* {```
|
|
||||||
https://example.org
|
|
||||||
```}
|
|
||||||
* https://example.org
|
|
||||||
|
|
||||||
Оборачивайте ссылки на гифы и внешние ресурсы в `[\[` и `]]`.
|
|
||||||
* {```
|
|
||||||
По ссылкам откроются [[гифа]] и [[https://example.org]].
|
|
||||||
```}
|
|
||||||
* По ссылкам откроются [[гифа]] и [[https://example.org]].
|
|
||||||
|
|
||||||
Если вы хотите поменять отображаемый текст у ссылки, пропишите его после `|`.
|
|
||||||
* {```
|
|
||||||
Ссылка на [[гифа | другую гифу]] и [[https://example.org | какой-то сайт]].
|
|
||||||
```}
|
|
||||||
* Ссылка на [[гифа | другую гифу]] и [[https://example.org | какой-то сайт]].
|
|
||||||
|
|
||||||
Так как названия гиф не чувствительны к регистру, эти ссылки функционально одинаковы: `[[гифа]]`, `[[Гифа]]`, `[[ГИФА]]`.
|
|
||||||
|
|
||||||
### Ссылка-ракета
|
|
||||||
**Ссылки-ракеты** — особые ссылки. Они занимают целую строку. Они не согласуются с обычными внутритекстовыми ссылками. Ссылки-ракеты взяты из разметки [[https://gemini.circumlunar.space/docs/gemtext.gmi | gemtext]].
|
|
||||||
|
|
||||||
Отображаемый текст пишется после первого пробела, не `|`. Если вы пишете ссылку на гифу с пробелами в названии, замените пробелы на _.
|
|
||||||
|
|
||||||
* {```
|
|
||||||
=> гифа
|
|
||||||
=> гифа_с_пробелами
|
|
||||||
=> https://example.org
|
|
||||||
=> https://example.org Отображаемый текст
|
|
||||||
```}
|
|
||||||
* {
|
|
||||||
=> гифа
|
|
||||||
=> гифа_с_пробелами
|
|
||||||
=> https://example.org
|
|
||||||
=> https://example.org Отображаемый текст
|
|
||||||
}
|
|
||||||
|
|
||||||
### Относительная адресация
|
|
||||||
Необязательно писать полное название гифы в каждой ссылке, достаточно использовать **относительные** ссылки.
|
|
||||||
|
|
||||||
Допустим, вы редактируете гифу под названием //фрукт/яблоко//.
|
|
||||||
|
|
||||||
Чтобы сослаться на //фрукт/груша// (гифа-сиблинг), можно написать `[\[../груша]]`. Чтобы сослаться на //фрукт/яблоко/красный// (подгифа), можно написать `[\[./красный]]`. То же самое можно делать с ссылками-ракетами, галереями, трансклюзиями и прочими местами, использующими названия гиф.
|
|
||||||
|
|
||||||
Также есть возможность ссылаться на страницы вики, не являющиеся гифами. Например, чтобы сделать ссылку на страницу с недавними изменениями, вы можете написать `[\[/recent-changes]]`. Лучше писать так вместо того, чтобы указывать полный адрес сайта, так как в будущем он может поменяться.
|
|
||||||
|
|
||||||
### Цвета ссылок
|
|
||||||
Ссылки могут иметь разные цвета. Синие ссылки ведут на //существующие// страницы, когда как красные ведут на //отсутствующие//. Все внешние ссылки считаются существующими, следовательно, они всегда синие. Внутренние ссылки на гифы всегда проверяются на существование.
|
|
||||||
|
|
||||||
Заметьте, что посещённые синие ссылки окрашиваются в пурпурный, но всё равно называются синими. Более того, синие ссылки имеют жёлтый цвет в стандартной тёмной теме.
|
|
||||||
|
|
||||||
## Заголовок
|
|
||||||
Есть шесть уровней **заголовков**. Они начинаются с одного или более знака решётки, после через пробел пишется текст заголовка. Вы можете оформлять заголовок также, как абзац. Желательно не использовать заголовки 1 уровня, потому что на этом уровне уже находится название гифы.
|
|
||||||
|
|
||||||
```
|
|
||||||
# уровень 1
|
|
||||||
## уровень 2
|
|
||||||
### уровень 3
|
|
||||||
#### уровень 4
|
|
||||||
##### уровень 5
|
|
||||||
###### уровень 6
|
|
||||||
```
|
|
||||||
|
|
||||||
Рядом с каждым заголовком (сразу после его текста) есть невидимая ссылка в виде знака §. Она появляется при наведении курсора. Если вы нажмёте на ссылку, URL в адресной строке заменится на URL, ведущий на соответствующий заголовок этой страницы. Попробуйте проделать это с заголовками в этой статье.
|
|
||||||
|
|
||||||
## Код-блок
|
|
||||||
Используйте **код-блоки** для отображения кода или иного преформатированного текста. Код-блоки начинаются с трёх обратных кавычек в начале строки и заканчиваются тем же образом. После обратных кавычек в пределах строки можно писать любой текст, он игнорируется. Преформатированный текст пишется между строк с кавычками.
|
|
||||||
|
|
||||||
Примерно так, но без пробела в начале:
|
|
||||||
```
|
|
||||||
```
|
|
||||||
оно преформатированное
|
|
||||||
видите?
|
|
||||||
```
|
|
||||||
```
|
|
||||||
|
|
||||||
```
|
|
||||||
оно преформатированное
|
|
||||||
видите?
|
|
||||||
```
|
|
||||||
|
|
||||||
## Горизонтальная черта
|
|
||||||
Пропишите четыре дефиса, чтобы вставить **горизонтальную черту**.
|
|
||||||
|
|
||||||
* {```
|
|
||||||
----
|
|
||||||
```}
|
|
||||||
* ----
|
|
||||||
|
|
||||||
## Галерея изображений
|
|
||||||
Используйте **галереи изображений**, чтобы встраивать изображения в страницу. Изображения могут быть гифами или внешними файлами. В примере ниже вы можете заменить URL названием гифы. Если эта гифа — изображение, оно появится в галерее.
|
|
||||||
|
|
||||||
Для изображения можно задать описание и определить размер.
|
|
||||||
|
|
||||||
* {```
|
|
||||||
img {
|
|
||||||
https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg
|
|
||||||
https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg {
|
|
||||||
Описание //здесь//
|
|
||||||
}
|
|
||||||
https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg | 100 { Размер }
|
|
||||||
https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg | 50*50
|
|
||||||
}
|
|
||||||
```}
|
|
||||||
* {
|
|
||||||
img {
|
|
||||||
https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg
|
|
||||||
https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg {
|
|
||||||
Описание //здесь//
|
|
||||||
}
|
|
||||||
https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg | 100 { Размер }
|
|
||||||
https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg | 50*50 { Квадрат }
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
Если вы встраиваете гифу под названием //гифа-изображение//, разметка будет выглядеть так:
|
|
||||||
* {```
|
|
||||||
img {
|
|
||||||
гифа-изображение
|
|
||||||
}
|
|
||||||
```}
|
|
||||||
|
|
||||||
Если вы пропишете одно единственное изображение, оно будет отображаться без декораций:
|
|
||||||
* {```
|
|
||||||
img { https://mycorrhiza.wiki/static/favicon.ico }
|
|
||||||
```}
|
|
||||||
* {img { https://mycorrhiza.wiki/static/favicon.ico }}
|
|
||||||
|
|
||||||
## Список
|
|
||||||
**Списки** используются отображения упорядоченных или древовидных данных. Они весьма распространены.
|
|
||||||
|
|
||||||
Каждый пункт списка начинается со звёздочки и пробела:
|
|
||||||
* {```
|
|
||||||
* раз
|
|
||||||
* два
|
|
||||||
* три
|
|
||||||
```}
|
|
||||||
* {
|
|
||||||
* раз
|
|
||||||
* два
|
|
||||||
* три
|
|
||||||
}
|
|
||||||
|
|
||||||
Если после звёздочки прописать точки, список становится нумерованным:
|
|
||||||
* {```
|
|
||||||
*. раз
|
|
||||||
*. два
|
|
||||||
*. три
|
|
||||||
```}
|
|
||||||
* {
|
|
||||||
*. раз
|
|
||||||
*. два
|
|
||||||
*. три
|
|
||||||
}
|
|
||||||
|
|
||||||
Если вы пропишете `x` или `v`, вы превратите пункты в соответственно незавершённные и завершённые пункты списка дел (T\ODO).
|
|
||||||
* {```
|
|
||||||
*v Готово
|
|
||||||
*x Не готово
|
|
||||||
**v Очень готово
|
|
||||||
** Круто
|
|
||||||
```}
|
|
||||||
* {
|
|
||||||
*v Готово
|
|
||||||
*x Не готово
|
|
||||||
**v Очень готово
|
|
||||||
** Круто
|
|
||||||
}
|
|
||||||
|
|
||||||
В пунктах списка поддерживается вся микоразметка. Если вы хотите прописать многострочный пункт, оберните его содержимое в фигурные скобки.
|
|
||||||
|
|
||||||
* {```
|
|
||||||
* {
|
|
||||||
## Заголовок
|
|
||||||
Текст
|
|
||||||
}
|
|
||||||
* Не многострочное
|
|
||||||
```}
|
|
||||||
* {
|
|
||||||
* {
|
|
||||||
## Заголовок
|
|
||||||
Текст
|
|
||||||
}
|
|
||||||
* Не многострочное
|
|
||||||
}
|
|
||||||
|
|
||||||
## Цитата
|
|
||||||
Начните строку с `>`, чтобы поместить её в цитату.
|
|
||||||
|
|
||||||
* {```
|
|
||||||
> ## Заголовок
|
|
||||||
>
|
|
||||||
> Абзац
|
|
||||||
> > Вложенная цитата
|
|
||||||
```}
|
|
||||||
* {
|
|
||||||
> ## Заголовок
|
|
||||||
>
|
|
||||||
> Абзац
|
|
||||||
> > Вложенная цитата
|
|
||||||
}
|
|
||||||
|
|
||||||
## Таблица
|
|
||||||
**Таблицы** прописываются в блоке вида `table {...}`. Обе ограничивающие части блока должны размещаться на своих строках. На первой строке вы можете прописать заголовок таблицы.
|
|
||||||
|
|
||||||
```
|
|
||||||
Пустая таблица:
|
|
||||||
table {
|
|
||||||
}
|
|
||||||
```
|
|
||||||
Пустая таблица:
|
|
||||||
table {
|
|
||||||
}
|
|
||||||
|
|
||||||
```
|
|
||||||
table { Пустая таблица с заголовком
|
|
||||||
}
|
|
||||||
```
|
|
||||||
table { Пустая таблица с заголовком
|
|
||||||
}
|
|
||||||
|
|
||||||
Ячейки-заголовки начинаются с !, обычные — с |. Ряды таблицы отделяются переносами строки:
|
|
||||||
|
|
||||||
```
|
|
||||||
table {
|
|
||||||
! Понедельник ! Пятница
|
|
||||||
| день тяжёлый | день весёлый
|
|
||||||
}
|
|
||||||
```
|
|
||||||
table {
|
|
||||||
! Понедельник ! Пятница
|
|
||||||
| день тяжёлый | день весёлый
|
|
||||||
}
|
|
||||||
|
|
||||||
Ячейки таблицы поддерживают всё форматирование абзаца:
|
|
||||||
|
|
||||||
```
|
|
||||||
table {
|
|
||||||
! Понедельник ! Пятница
|
|
||||||
| день тяжёлый | //день весёлый//
|
|
||||||
}
|
|
||||||
```
|
|
||||||
table {
|
|
||||||
! Понедельник ! Пятница
|
|
||||||
| день тяжёлый | //день весёлый//
|
|
||||||
}
|
|
||||||
|
|
||||||
Если вы хотите, чтобы ячейка занимала несколько столбцов, пропишите символ начала этой ячейки нужное число раз подряд (без пробелов):
|
|
||||||
|
|
||||||
```
|
|
||||||
table {
|
|
||||||
! Понедельник ! Пятница
|
|
||||||
|| нормальный день
|
|
||||||
}
|
|
||||||
```
|
|
||||||
table {
|
|
||||||
! Понедельник ! Пятница
|
|
||||||
|| нормальный день
|
|
||||||
}
|
|
||||||
|
|
||||||
Пока что объединение ячеек по вертикали не поддерживается.
|
|
||||||
|
|
||||||
Если вы хотите прописать многострочную ячейку, оберните её содержимое в `{}` и продолжите таблицу после этого блока:
|
|
||||||
```
|
|
||||||
table {
|
|
||||||
| a | b
|
|
||||||
| { в этой ячейке
|
|
||||||
целых //два// абзаца! } | d
|
|
||||||
}
|
|
||||||
```
|
|
||||||
table {
|
|
||||||
| a | b
|
|
||||||
| { в этой ячейке
|
|
||||||
целых //два// абзаца! } | d
|
|
||||||
}
|
|
||||||
|
|
||||||
Вертикальные черты в начале строки можно опустить, они будут вставлены автоматически:
|
|
||||||
```
|
|
||||||
table {
|
|
||||||
a | b
|
|
||||||
c | d
|
|
||||||
}
|
|
||||||
```
|
|
||||||
table {
|
|
||||||
a | b
|
|
||||||
c | d
|
|
||||||
}
|
|
||||||
|
|
||||||
## Трансклюзия
|
|
||||||
**Трансклюзия** — механизм включения содержимого других гиф в одну гифу.
|
|
||||||
|
|
||||||
Чтобы включить гифу под названием `йогурт`, напишите строку такого вида:
|
|
||||||
```
|
|
||||||
<= йогурт
|
|
||||||
```
|
|
||||||
|
|
||||||
Строки-трансклюзии начинаются с перевёрнутой ракеты (`<=`), после которой пишется ноль или более пробелов. Текст до переноса строки или вертикальной черты (`|`) называется //целью// или //целевой гифой//. Если есть вертикальная черта, текст после неё называется //селектором//. Если черты нет, //селектор// пустой. И //цель//, и //селектор// проходят обрезку непечатных символов (strip) с обеих сторон перед дальнейшей обработкой.
|
|
||||||
|
|
||||||
```
|
|
||||||
<= целевая гифа
|
|
||||||
<= целевая гифа |
|
|
||||||
<= целевая гифа | селектор
|
|
||||||
```
|
|
||||||
|
|
||||||
Заметьте, с релиза 1.2 семантика и синтаксис трансклюзии изменились. Если вы ранее использовали трансклюзию, обновите ваши гифы. Пока что движок будет предупреждать о трансклюзиях со старым синтаксисом через двоеточие.
|
|
||||||
|
|
||||||
### Селектор
|
|
||||||
//Селектор// определяет, какая часть //целевой гифы// транклюзируется. Парсер распознаёт следующие ключевые слова:
|
|
||||||
|
|
||||||
* **full.** Транклюзировать весь документ.
|
|
||||||
* **text.** Транклюзировать весь текст.
|
|
||||||
* **attachment.** Транклюзировать только вложение.
|
|
||||||
* **description.** Транклюзировать только первый абзац.
|
|
||||||
* **overview.** Объединяет **attachment** и **description**.
|
|
||||||
|
|
||||||
Если найдено только одно из них, транклюзируется соответствующая часть. Если найдено несколько, производится б__о__льшая трансклюзия. Если не найдено ни одно, неявно подразумевается **overview**.
|
|
||||||
|
|
||||||
К этому же, если прописано слово **blend**, трансклюзия отображается без стандартных серой рамки и ссылки на //целевую гифу//.
|
|
||||||
|
|
||||||
Ниже приведена настоящая трансклюзия гифы. Она выдаст ошибку, если в вашей вики нет такой гифы.
|
|
||||||
<= u
|
|
||||||
|
|
||||||
Рекурсивная трансклюзия поддерживается, но ограничена тремя итерациями.
|
|
||||||
|
|
||||||
## См. также
|
|
||||||
=> https://mycorrhiza.wiki/hypha/essay/why_mycomarkup Почему была создана микоразметка
|
|
||||||
@ -1,19 +0,0 @@
|
|||||||
# Назад/далее
|
|
||||||
Под каждой гифой есть раздел **«назад/далее»** с быстрыми ссылками на предыдущую и следующую гифы по алфавитному порядку.
|
|
||||||
|
|
||||||
Эта функция подталкивает вас именовать гифы так, чтобы использование этих ссылок имело смысл. Например, если вы храните страницы книги, вам стоит проименовать их //p01//, //p02//, //p03// и т.д.
|
|
||||||
|
|
||||||
Невозможно изменить гифы, на которую ведут ссылки этого раздела. Если вы хотите предоставить другой способ последовательной навигации, проставьте собственные ссылки.
|
|
||||||
|
|
||||||
## Горячие клавиши
|
|
||||||
Нажмите `n` (**n**ext), чтобы перейти на следующую страницу. Для перехода на предыдущую, нажмите `p` (**p**revious).
|
|
||||||
|
|
||||||
## Для администраторов: как убрать эти ссылки
|
|
||||||
Для некоторых вики эти ссылки несут мало смысла или не несут вовсе. В таком случае лучше их скрыть.
|
|
||||||
|
|
||||||
В файле `your-wiki/static/custom.css` пропишите следующее:
|
|
||||||
```css
|
|
||||||
.prevnext { display: none; }
|
|
||||||
```
|
|
||||||
|
|
||||||
Раздел останется на месте, но никто его не увидит. Горячие клавиши всё ещё будут работать.
|
|
||||||
@ -1,20 +0,0 @@
|
|||||||
# Недавние изменения
|
|
||||||
**Недавние изменения** — это специальная страница, которая содержит список последних правок в вики. По умолчанию ссылка на эту страницу помещена в [[/help/ru/top_bar | верхнюю панель]]. Также вы можете быстро перейти сюда, нажав горячие клавиши `g r`.
|
|
||||||
|
|
||||||
Обычно увлечённые и ответственные вики-редакторы регулярно заходят на эту страницу.
|
|
||||||
|
|
||||||
=> /recent-changes Посмотреть недавние изменения на этой вики
|
|
||||||
|
|
||||||
По умолчанию на странице приводится 20 последних правок. Там же вы можете выбрать другое число: 50 или 100.
|
|
||||||
|
|
||||||
Правки сгруппированы по дате.
|
|
||||||
|
|
||||||
Каждая правка имеет следующие свойства:
|
|
||||||
* **Время по UTC.**
|
|
||||||
* **Хэш коммита.** Играет роль идентификатора правки.
|
|
||||||
* **Автор,** если есть.
|
|
||||||
* **Затронутые гифы.** Большая часть действий затрагивает одну гифу (например, само редактирование), но некоторые затрагивают больше (например, рекурсивное редактирование или переименование).
|
|
||||||
* **Сообщение.** Оно поясняет, что это за правка. Формат сообщения относительно регулярен и его можно пропарсить.
|
|
||||||
|
|
||||||
## См. также
|
|
||||||
=> /help/ru/feeds Ленты
|
|
||||||
@ -1,13 +0,0 @@
|
|||||||
# Раздел с гифами-сиблингами
|
|
||||||
В правой (или нижней на небольших экранах) части страницы с гифой размещается особый раздел, перечисляющий **гифы-сиблинги**.
|
|
||||||
|
|
||||||
> **Гифы-сиблинги** — гифы, являющиеся подгифами одной и той же гифы. Например, //Фрукт/Яблоко// и //Фрукт/Груша// приходятся сиблингами.
|
|
||||||
|
|
||||||
Гифы-сиблинги приводятся в алфавитном порядке. Название гифы, которую вы просматриваете, также входит в список. Остальные пункты списка – ссылки на другие гифы.
|
|
||||||
|
|
||||||
Иногда рядом с ссылками приводятся числа:
|
|
||||||
* **Нет числа.** У гифы нет подгиф.
|
|
||||||
* **Одно число.** Оно обозначает, сколько у гифы прямых подгиф.
|
|
||||||
* **Два числа.** Первое – количество прямых подгиф. Второе, в скобках – количество непрямых подгиф.
|
|
||||||
|
|
||||||
Для гифы //Фрукт//, подгифы //Фрукт/Яблоко// и //Фрукт/Груша// будут прямыми, а подгифы //Фрукт/Яблоко/Красное// и //Фрукт/Яблоко/Зелёное// – непрямыми.
|
|
||||||
@ -1,40 +0,0 @@
|
|||||||
# Авторизация через Телеграм
|
|
||||||
//Эта статья предназначена для администраторов вики.//
|
|
||||||
|
|
||||||
Если вы хотите, можете разрешить пользователям входить на вашу вики с помощью **Телеграм**.
|
|
||||||
|
|
||||||
Телеграм (Telegram) — проприетарное приложение для обмена сообщениями с полмиллиарда пользователей по всему миру. Узнайте больше на [[https://telegram.org]].
|
|
||||||
|
|
||||||
## Настройка интеграции с Телеграм
|
|
||||||
Чтобы включить Телеграм-авторизацию, необходимо создать Телеграм-бота и связать его с вашей вики.
|
|
||||||
|
|
||||||
### Создание бота
|
|
||||||
Откройте чат с [[https://t.me/botfather | @BotFather]], ботом для создания других ботов. Создайте в нём бота. В следующих шагах вам понадобятся его имя (username) и ключ (token). Также вы можете задать его аватар, будет здорово, если он будет совпадать с логотипом вашей вики.
|
|
||||||
|
|
||||||
Создав бота, отправьте команду `/setdomain` и пропишите домен вашей вики.
|
|
||||||
|
|
||||||
Вам не нужно будет //размещать// этого бота. Достаточно лишь того, что он будет создан в BotFather. Вы также можете переиспользовать ранее созданного бота.
|
|
||||||
|
|
||||||
### Конфигурация
|
|
||||||
В секции `[Telegram]` файла `config.ini` впишите имя бота (без @) и его ключ:
|
|
||||||
|
|
||||||
```
|
|
||||||
[Telegram]
|
|
||||||
TelegramBotName = your_bot
|
|
||||||
TelegramBotToken = 0000000000:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
|
|
||||||
```
|
|
||||||
|
|
||||||
Затем перезагрузите вики.
|
|
||||||
|
|
||||||
Если обе опции прописаны, движок включит авториазцию через Telegram.
|
|
||||||
|
|
||||||
## Использование
|
|
||||||
На страницах входа и регистрации появится синяя кнопка. После её нажатия пользователю предложат связаться с вашим ботом, чтобы подтвердить авторизацию. Имя пользователя в Телеграм (@username) будет переиспользовано в качестве имени в вики. По умолчанию пользователи Телеграм принадлежат к группе //редакторов (editor)//. Они могут использовать вики наравне с остальными.
|
|
||||||
|
|
||||||
## Ограничения
|
|
||||||
* Ваша вики должна размещаться на публичном домене или белом IP-адресе. Приватно размещённые вики (например, в localhost или локальной сети) не поддерживаются.
|
|
||||||
* Телеграм не поддерживает вики на HTTP, вы //обязаны// использовать HTTPS.
|
|
||||||
** Один из способов настроить HTTPS — использовать [[https://certbot.eff.org | certbot]] в связке с обратным прокси, например, [[https://nginx.org | nginx]].
|
|
||||||
* Телеграм-пользователи без @имени не смогут авторизоваться.
|
|
||||||
* Телеграм-пользователи с именем, уже занятым на вики, также не смогут авторизоваться.
|
|
||||||
* В целом, это экспериментальная функция. Применяйте её на свой страх и риск.
|
|
||||||
@ -1,54 +0,0 @@
|
|||||||
# Верхняя панель
|
|
||||||
**Верхняя панель** есть абсолютно на каждой странице вики. Это главный способ навигации.
|
|
||||||
|
|
||||||
На больших экранах панель разделена на две строки.
|
|
||||||
* Первая строка
|
|
||||||
** Ссылка на [[/ | главную страницу]]
|
|
||||||
** Поисковая строка
|
|
||||||
** //Если включена авторизация,//
|
|
||||||
*** //Если произведён вход,//
|
|
||||||
**** Ссылка на гифу с профилем вашего пользователя
|
|
||||||
**** //Для админов,// ссылка на панель администратора
|
|
||||||
*** //Если входа не было,//
|
|
||||||
**** Ссылка на вход
|
|
||||||
**** Ссылка на регистрацию
|
|
||||||
* Вторая строка, часто используемые ссылки. По умолчанию содержит:
|
|
||||||
** Недавние изменения
|
|
||||||
** Все гифы
|
|
||||||
** Случайная гифа
|
|
||||||
** Справка
|
|
||||||
|
|
||||||
На небольших экранах, раздел авторизации и часто используемые ссылки спрятаны в меню. Нажмите на кнопку, чтобы их увидеть. Если ваш браузер не поддерживает JavaScript, они будут перечислены как есть.
|
|
||||||
|
|
||||||
## Использование верхней панели
|
|
||||||
Предполагается, что администраторы вики сконфигурируют ссылки верхней панели под себя. Вот что вам стоит туда поместить:
|
|
||||||
* Популярные статьи
|
|
||||||
* Списки чего-либо
|
|
||||||
* Недавние изменения
|
|
||||||
* Что вам угодно, но не так много, конечно. Пространство панели ограничено.
|
|
||||||
|
|
||||||
## Конфигурация ссылок
|
|
||||||
//Этот раздел предназначен для администраторов вики.//
|
|
||||||
|
|
||||||
Чтобы поменять стандартные ссылки, сначала нужно выбрать гифу, где вы собираетесь хранить конфигурацию. Хорошим выбором может быть подгифа гифы с профилем администратора. Пропишите адрес гифы в разделе `[Hyphae]` файла `config.ini`:
|
|
||||||
```ini
|
|
||||||
...
|
|
||||||
[Hyphae]
|
|
||||||
HeaderLinksHypha = u/admin/header_links
|
|
||||||
...
|
|
||||||
```
|
|
||||||
|
|
||||||
Затем перезагрузите вики.
|
|
||||||
|
|
||||||
----
|
|
||||||
|
|
||||||
Отредактируйте гифу. Вы можете поместить в неё любую разметку. Для генерации верхней панели используются ссылки-ракеты:
|
|
||||||
|
|
||||||
```myco
|
|
||||||
=> /recent-changes История правок
|
|
||||||
=> Хайлайты
|
|
||||||
=> Философия Наши взгляды на жизнь
|
|
||||||
=> Статьи
|
|
||||||
```
|
|
||||||
|
|
||||||
Пока что, чтобы изменения вступили в силу, модератор или администратор должен открыть [[/update-header-links]].
|
|
||||||
@ -1,17 +0,0 @@
|
|||||||
# Белый список
|
|
||||||
//Эта статья предназначена для администраторов вики.//
|
|
||||||
|
|
||||||
Если вы хотите ограничить круг лиц, способных авторизоваться на вашей вики, вам пригодится **белый список**.
|
|
||||||
|
|
||||||
Чтобы его включить, в секции `[Authorization]` файла `config.ini` пропишите значение `true` в `UseWhiteList`, а в поле `WhiteList` перечислите все разрешённые имена пользователей через запятую:
|
|
||||||
```
|
|
||||||
...
|
|
||||||
[Authorization]
|
|
||||||
UseWhiteList = true
|
|
||||||
WhiteList = fish,pesce,рыба
|
|
||||||
...
|
|
||||||
```
|
|
||||||
|
|
||||||
Затем перезагрузите вики.
|
|
||||||
|
|
||||||
С этого момента можно использовать только указанные имена, т.е. регистрироваться и заходить можно только под ними. С остальными именами этого не получится.
|
|
||||||
Loading…
Reference in New Issue
Block a user