Документация

Редактор

Редактор блочный, в духе Notion: документ — это последовательность блоков, каждый можно перетащить за ручку слева. Полный перечень блоков и разметки — Справочник по разметке; здесь про то, как им пользоваться.

Чтобы писать — режим «Изменения»

Страница открывается на чтение. Что делают ввод и выделение, зависит от режима документа — переключателя в строке над страницей: «Чтение», «Комментировать», «Предлагать правки», «Изменения». Выше вашего уровня доступа подняться нельзя, выбор запоминается для проекта. См. Комментарии и предложения правок.

Слэш-команда

/ в пустой строке открывает меню вставки. Дальше печатайте название нужного — список отфильтруется. Пункты сгруппированы: заголовки, базовые блоки, продвинутые (таблица), медиа, а ниже — то, чего в обычном редакторе нет:

Группа Что там
Диаграммы пять видов схем — классы, последовательность, состояния, схема данных, блок-схема. Вход в группу целиком — /uml или /диаграмма
Плашки пять видов цветных врезок с заголовком — заметка, совет, важно, предупреждение, осторожно
Вставки карточка Google-документа, презентации, доски Miro; ссылка на секрет в менеджере паролей — /секрет; новая задача — /task Что надо сделать
Задачи проекта ссылка на уже заведённую задачу — начните печатать её название
Шаблоны пункт на каждый шаблон проекта, тело подставляется по месту курсора

Блоки со своим полем ввода

Диаграмма, блок кода и плашка правятся не как обычный текст, и это стоит знать заранее.

Диаграмма показана картинкой; исходник открывается переключателем «Схема | Код» в её полосе сверху. Пока вы в этом поле, [[, # и прочая разметка страницы не срабатывают — внутри схемы квадратные скобки означают своё. Выйти обратно в текст — Escape. Клик по картинке открывает схему на весь экран; её можно скопировать картинкой или скачать PNG.

Блок кода принимает язык селектом в правом верхнем углу и подсвечивает синтаксис. Селект приглушён, пока на блок не навели мышь.

Плашка держит заголовок отдельной строкой сверху — это тоже поле, а не текст документа, и разметка в нём не срабатывает по той же причине. Enter в заголовке переводит курсор в тело плашки, где всё работает как в обычном абзаце.

Подробности по всем трём — Справочник по разметке.

Панель форматирования

Выделенный текст показывает панель: жирный, курсив, подчёркнутый, зачёркнутый, код, ссылка, цвет текста и фона, выравнивание. Там же две кнопки, которых обычно не бывает:

  • «Комментировать» — обсуждение привязывается к выделенному фрагменту, см. Комментарии и предложения правок;
  • «Задача» — выделенное становится заголовком задачи, а в тексте остаётся живой чип со ссылкой, см. Задачи.

На телефоне и планшете эта панель не всплывает над выделением, а прижимается полосой к нижнему краю экрана: сверху стоит системное меню браузера, из-под которого её было бы не достать.

Ссылки, которые становятся карточками

Одинокая ссылка на Google-документ, презентацию или доску Miro разворачивается в карточку внешнего документа, см. Google Docs, Miro и другие внешние документы. Ссылка на запись в менеджере паролей становится ключом — пароль остаётся в хранилище, см. Хранение паролей.

Если вы набрали пароль прямо в тексте, редактор заметит это и предложит заменить его ссылкой на менеджер паролей. Проверка идёт в браузере, наружу не уходит ничего.

Название и оглавление

Название страницы — поле над телом, а не первая строка. Из заголовков внутри текста собирается оглавление — полоской справа; у каждого заголовка есть якорь, и ссылка на раздел открывает документ на нужном месте.

Правки не теряются

  • Автосохранение. Текст уезжает на сервер примерно через полсекунды после того, как вы перестали печатать. Кнопки «Сохранить» нет; точка над страницей показывает «Сохраняется», «Сохранено» или «Ошибка сохранения».
  • Индексация. Сохранённую страницу сервер сам отправляет в поиск, обычно это несколько секунд. Наведите на точку сохранения — подсказка скажет, в индексе ли страница. Кнопки «переиндексировать» нет намеренно: её легко забыть, и тогда ассистент отвечал бы по старой версии. См. Поиск по базе знаний.
  • Чужая правка не теряется тоже. Если страницу поменяли, пока она была открыта у вас, над ней появится «Страница изменилась — перед вами не самая свежая версия» с кнопкой «Обновить».
  • История. Каждая правка кладёт ревизию с автором и временем; откат — Корзина и история версий.

Что хранится

Тело страницы хранится в markdown — тем же текстом, каким его видит агент и каким страница выгружается. Это не «формат на выход»: разметка документа и есть markdown, поэтому выгруженный файл читается вне Hivelore, а написанное агентом попадает в документ без потерь.

Своей нотации у нас ровно столько, сколько нужно для того, чего в markdown нет: ссылка на страницу, #тег, чип задачи и карточка внешнего документа. Всё остальное — диаграммы, плашки, ключи секретов, блоки кода с языком, таблицы, списки — стандартный markdown, и в чужом редакторе оно откроется тем же самым.