A-Wiki Как писать и оформлять статьи

Общее описание

A-Wiki работает на платформе BookStack. Статьи — это страницы внутри книг. Каждая страница может содержать текст, таблицы, изображения, схемы, вложения и ссылки на другие страницы.

Редактор поддерживает два режима: визуальный (WYSIWYG) и Markdown. Переключаться между ними можно при создании или редактировании страницы.

1. Создание новой страницы

Откройте нужную книгу (например, «Инструкции»)
Нажмите кнопку Создать страницу (зелёная, справа вверху)
Введите Название страницы (оно станет заголовком H1)
Выберите Главу, если страница должна быть в составе главы
Начните редактирование

2. Режимы редактора

Визуальный редактор (WYSIWYG)

Режим по умолчанию. Форматирование — как в Word или Google Документах. Панель инструментов содержит кнопки:

Заголовки (Large / Medium / Small / Tiny)
Жирный, Курсив, Подчёркнутый
Нумерованные и маркированные списки
Таблицы
Ссылки
Изображения
Цитаты, кодовые блоки
Выноски (Callout) — цветные блоки для важной информации

Горячие клавиши (Windows):

Действие	Клавиши
Сохранить черновик	Ctrl + S
Сохранить и продолжить	Ctrl + Enter
Жирный	Ctrl + B
Курсив	Ctrl + I
Заголовок Large	Ctrl + 1
Заголовок Medium	Ctrl + 2
Заголовок Small	Ctrl + 3
Заголовок Tiny	Ctrl + 4
Обычный текст	Ctrl + 5 / Ctrl + D
Цитата	Ctrl + 6 / Ctrl + Q
Блок кода	Ctrl + 7 / Ctrl + E
Выноска (Callout)	Ctrl + 9
Нумерованный список	Ctrl + O
Маркированный список	Ctrl + P
Вставить ссылку	Ctrl + K
Ссылка на контент BookStack	Ctrl + Shift + K

Markdown-редактор

Для точного контроля разметки. Поддерживается стандартный синтаксис:

# Заголовок H1
## Заголовок H2
### Заголовок H3

**Жирный текст**
*Курсив*

- Элемент списка
- Элемент списка

1. Первый
2. Второй

| Колонка 1 | Колонка 2 |
|-----------|-----------|
| Значение  | Значение  |

> Цитата

`Код`

3. Оформление текста

Заголовки

Первый заголовок (H1) формируется автоматически из названия страницы. Используйте H2–H4 для структурирования:

Общее описание (H2) — вводная часть
1. Раздел (H2) — крупные разделы
Подраздел (H3) — уточнения
Детали (H4) — при необходимости

Списки

Маркированные — для перечислений без порядка
Нумерованные — для пошаговых инструкций

Таблицы

Используйте для параметров, сравнений, регламентов. В визуальном редакторе таблицы создаются через кнопку на панели инструментов.

Выноски (Callout)

Для выделения важной информации. Циклически переключаются по нажатию Ctrl + 9:

Информация (синяя)
Предупреждение (жёлтая)
Опасность (красная)

Код

Встроенный код — для упоминания команд, путей, имён файлов
Блок кода — для многострочных примеров

4. Работа с изображениями

Установите курсор в нужное место текста
Нажмите кнопку Изображение на панели инструментов
Выберите:
- Загрузить новый — выберите файл со своего компьютера
- Из галереи — выберите ранее загруженное изображение
После вставки можно изменить размер, добавить подпись, выравнивание

Изображения сохраняются в галерее книги и могут быть повторно использованы.

5. Схемы и диаграммы

A-Wiki поддерживает создание и редактирование схем через интеграцию с diagrams.net (draw.io).

В визуальном редакторе:

Нажмите кнопку Drawing на панели инструментов (в меню расширенных действий)
Создайте схему во встроенном редакторе
Нажмите Сохранить и выйти

Редактирование существующей схемы:

Дважды кликните по схеме в редакторе
Или нажмите кнопку Drawing, выделив схему

Схемы сохраняются в формате PNG с внедрёнными исходными данными diagrams.net — их можно редактировать в любом экземпляре draw.io.

6. Ссылки

Внешние ссылки

Выделите текст → нажмите Ctrl + K → вставьте URL.

Внутренние ссылки на страницы A-Wiki

Нажмите Ctrl + Shift + K (или кнопку Link to BookStack content)
Начните вводить название книги или страницы
Выберите нужный результат из списка

Постоянная ссылка (Permalink)

Каждая страница имеет ID, по которому к ней можно обратиться напрямую независимо от изменения названия:

Выделите любой блок текста на странице
Во всплывающем окне появится ссылка с #якорем
Скопируйте её (кнопка Copy рядом)
Если нужна ссылка на страницу без прокрутки — удалите # и всё после него

Пример: https://a-wiki.aventin.spb.ru/link/126

Подробнее — на странице «Постоянная ссылка» в этой же книге.

7. Теги

Теги — дополнительная категоризация контента. У тега есть название (обязательно) и значение (опционально).

Как добавить теги:

Откройте страницу на редактирование
В боковой панели найдите раздел Теги страницы
Введите название тега (например, Статус)
При необходимости укажите значение (например, Черновик)
Для удаления тега нажмите крестик рядом с ним

Поиск по тегам:

[Статус] — все страницы с тегом «Статус»
[Статус=Черновик] — страницы, где значение тега «Черновик»
[Статус!=Готово] — страницы, где значение не «Готово»

Теги отображаются на странице в боковой панели и в результатах поиска.

8. Вложения

К странице можно прикрепить файлы (PDF, DOCX, XLSX и др.):

Откройте страницу в режиме просмотра
В боковой панели найдите раздел Вложения
Нажмите Загрузить вложение и выберите файл
После загрузки файл появится в списке вложений

Вложения можно отсортировать, переименовать или удалить.

9. Сохранение и публикация

Действие	Как сделать
Сохранить черновик	Ctrl + S — изменения сохраняются без публикации
Сохранить и продолжить	Ctrl + Enter — страница опубликована, остаётесь в редакторе
Завершить редактирование	Нажмите «Сохранить» и закройте редактор
Отменить изменения	Закройте редактор без сохранения

Статусы страницы:

Опубликована — видна всем читателям
Черновик — видна только автору и редакторам

10. Чек-лист перед публикацией

Название отражает суть статьи
Использованы заголовки разных уровней (H2–H4)
Инструкции оформлены нумерованными списками
Изображения загружены и имеют подписи
Ссылки рабочие (внешние и внутренние)
Теги проставлены
Орфография проверена
Статья сохранена (не осталась в черновиках, если не требуется)

Часто задаваемые вопросы

В: Не вижу кнопку «Создать страницу»
О: У вас нет прав на редактирование в этой книге. Обратитесь к администратору A-Wiki.

В: Случайно закрыл редактор — изменения пропали?
О: A-Wiki автоматически сохраняет черновик. При повторном открытии редактора будет предложено восстановить несохранённые изменения.

В: Могу ли я переключаться между визуальным и Markdown-редактором?
О: Да, если у вас есть права. Переключение доступно в меню редактора. Содержимое будет сконвертировано автоматически.

В: Как удалить страницу?
О: Откройте страницу → нажмите «...» (меню действий) → «Удалить». Страница переместится в корзину.