Как править вики
Как править вики — как получить доступ к этой вики, создать новую страницу и что писать не надо.
Коротко
| Адрес | wiki.inbicst.ru |
|---|---|
| Кто читает | Все: вики открыта без входа |
| Кто правит | Участники отдела с аккаунтом |
| Аккаунт | Создаёт глава отдела — Nepike. Самостоятельной регистрации нет. |
| Редактор | Визуальный — как в обычном текстовом редакторе, вики-разметку знать не обязательно |
Как получить аккаунт
Напишите главе отдела — Nepike. Он создаст аккаунт и передаст вам логин и временный пароль. После первого входа смените пароль: Служебная:Настройки → «Изменить пароль».
Почта в вики не настроена, поэтому восстановить забытый пароль по письму нельзя — тоже пишите главе отдела.
Как создать страницу
Введите название и нажмите кнопку — откроется редактор с заготовкой, в которой уже есть все нужные разделы:
- Название — коротко, как предмет, о котором страница: «Роутер на М4», «Студсайт», «Принтеры».
- Заполните разделы заготовки, а неподходящие удалите. Все страницы вики устроены одинаково, чтобы нужное было легко найти:
- плашка «ответственный и дата проверки» (см. ниже);
- одна-две фразы: что это и зачем;
- Коротко — таблица с главным: где находится, модель, адрес;
- Как устроено, Доступ, Как пользоваться;
- Если сломалось — только если есть что сказать;
- Чего пока нет — пометки TODO.
- Категория — в конце страницы уже стоит категория «М4». Если страница про другое, поменяйте её (в визуальном редакторе: меню ☰ → «Категории»): «Сайт и онлайн-сервисы», «М4», «Общежитие» или «Участникам отдела».
- Запишите страницу кнопкой в правом верхнем углу редактора.
- Добавьте ссылку на новую страницу на главную — в раздел нужной области. Пункт в боковом меню добавляет глава отдела: меню могут править только администраторы.
Как править
- Кнопка «Править» открывает визуальный редактор. «Править код» — редактор вики-разметки; переключиться между ними можно и внутри редактора (кнопка «Переключить редактор»).
- Команды, конфиги и код оформляйте блоком кода: в визуальном редакторе «Вставить» → «Фрагмент кода», в разметке —
<syntaxhighlight lang="bash">…</syntaxhighlight>. Так они подсвечиваются и их удобно копировать. - Картинки: перетащите файл прямо в визуальный редактор или загрузите через Служебная:Загрузка. Можно png, jpg, gif, webp и pdf до 20 МБ.
- Если, пока вы писали, кто-то уже поменял ту же страницу, вики предупредит о конфликте правок и покажет обе версии.
Плашка статуса
В начале каждой статьи стоит плашка — кто отвечает за страницу и когда её последний раз сверяли с реальностью:
В визуальном редакторе щёлкните по плашке → «Править»: откроется форма с двумя полями. Дата — в формате ГГГГ-ММ-ДД.
Проверили страницу — обновите дату, даже если ничего не поменялось. Если с проверки прошло больше полугода, плашка сама предупреждает, что информация могла устареть. Подробнее — Шаблон:Статус страницы.
Пометка TODO
Если чего-то не знаете — не выдумывайте, а поставьте пометку {{TODO|чего не хватает}}. На странице она выглядит как жёлтая плашка — пример на Шаблон:TODO. В визуальном редакторе: «Вставить» → «Шаблон» → TODO. Все страницы с такими пометками собираются в Категория:Страницы с TODO — оттуда удобно брать, что дописать.
Правила
- Никаких паролей, токенов и ключей — вики публичная. Пишите только, у кого или где их получить. Логины, адреса и технические подробности писать можно и нужно.
- Не выдумывайте. Не уверены — ставьте TODO.
- Одна страница — один предмет (сервис, устройство, помещение), по заготовке.
- Обновляйте дату проверки в плашке, когда сверили страницу.
Полезные страницы
- Служебная:Свежие правки — что меняли недавно.
- Категория:Страницы с TODO — где не хватает информации.
- Категория:Страницы без ответственного — у каких страниц не заполнена плашка.
- Служебная:Все страницы — список всех страниц.
Для администраторов
- Создать аккаунт: Служебная:Создать учётную запись — задайте пароль сразу (письмо с паролем не уйдёт: почта не настроена). Права администратора выдаются на Special:UserRights.
- Главная и меню: главная страница задаётся в MediaWiki:Mainpage, боковое меню — в MediaWiki:Sidebar.
- Техническая часть (сервер, обновление MediaWiki, бэкапы, восстановление) — в README репозитория github.com/Nepike/knt-wiki; вики работает на сервере сайта.
- Часть страниц пишется черновиками в том же репозитории и публикуется скриптом через API (README, раздел «Статьи»). Скрипт не перезаписывает страницы, которые поменяли в браузере, так что править в браузере можно спокойно.