Skip to content

Help dock knowledge ru

Alex Miarsky edited this page Nov 10, 2026 · 1 revision

База знаний

База знаний хранит документацию проекта деревом разделов и статей Markdown. Открывается через Рабочие панели → Просмотр → База знаний. Структура страницы, навигация, чтение, редактор, библиотека вложений и окно истории перенесены из текущего Handler. Управление компоновкой использует общие controls доков.

Загрузка интерфейса и ошибки скачивания отображаются внутри дока. После обновления frontend перезагрузите уже открытую вкладку браузера, если интерфейс не загрузился; локальные черновики статей сохраняются. CSS с постоянными именами проверяется по текущей серверной сборке вместо бессрочного кэширования.

Начало работы и права

В проекте без базы знаний администратор запускает явную инициализацию. Чтение не создаёт таблицы. Действуют правила доступа к проекту и Search Type; создавать и упорядочивать материалы могут администраторы и supervisors. Опубликованные статьи доступны допущенным читателям. Серверные черновики видит их автор; чужие черновики скрыты также при открытии skey и снапшота напрямую.

Навигация, поиск и связь с объектами

Стрелка раскрывает раздел, его заголовок открывает содержание раздела. Поиск учитывает название, краткое описание и полный текст. У статьи есть оглавление; при небольшой ширине оно переносится внутрь страницы. Рядом доступны история, автор, даты создания/обновления и примерное время чтения.

Связать выбранные объекты добавляет текущее выделение рабочего пространства к статье. У связанных объектов появляется действие с книгой для опубликованных материалов. Превью ресурса открывает объект, а skey статьи — её страницу. В адресной строке используется реальный проект и ключ native-записи. Ключ статьи можно скопировать в заметку или сообщение.

Создание, редактирование и публикация

Создайте раздел или статью из панели навигации. Сначала задаются название, краткое описание и родительский раздел; Перейти к содержимому открывает редактор. Метаданные существующей статьи доступны через Показать название и описание.

Режимы Визуальный и Markdown редактируют одно каноническое содержимое Markdown. Панель поддерживает заголовки, оформление текста, списки и чек-листы, ссылки, изображения, цитаты, таблицы, разделители, выравнивание, отмену и повтор. Остальные действия при уменьшении ширины переходят в меню. Блоки Python, JavaScript и XML используют общую подсветку синтаксиса. Выберите изображение, чтобы задать ширину, потянуть за угол или растянуть по ширине текста. При наведении на текстовую ссылку доступно редактирование.

Сохранить как черновик записывает неопубликованный серверный черновик. Опубликовать публикует его; Сохранить обновляет существующую публикацию. Загрузка старого HTML не меняет запись до явного сохранения. Проверка ревизии предотвращает перезапись чужих изменений на сервере.

Локальные черновики сохраняются в браузере отдельно для пользователя и проекта. Они восстанавливаются после переходов и перезагрузки при доступном хранилище. Очередь загрузки держит File-объекты только до перезагрузки страницы: ещё не загруженные файлы после неё нужно выбрать повторно. Ошибка хранилища показывается и запрещает незаметно покинуть несохранённый редактор.

Вложения

Откройте Показать вложенные файлы в меню форматирования. Файлы можно выбрать, перетащить или вставить из буфера в редактор. Вставить вложение зависит от разрешения браузера и доступности Clipboard API, часто требующей HTTPS. Для новой статьи перед загрузкой резервируется серверный черновик.

Используются native FileCheckin, Snapshot, File и FileUndo. Изображения получают отдельные web/icon-производные; исходные имена остаются в metadata файла. Нажатие карточки вставляет постоянный URL оригинала. Производная используется только как запасной вариант отображения и не заменяет сохранённую ссылку оригинала. Библиотека позволяет копировать URL, убирать вложение через retire и повторять неудавшуюся загрузку. Добавление вложений не снимает опубликованную статью с публикации.

Порядок, история и удаление

Перетащите страницу до/после другой строки или внутрь раздела; в меню доступны явные команды перемещения. Сохранить порядок применяет изменения, Отменить изменения возвращает серверный порядок. Циклы запрещены; ревизия каталога защищает от перезаписи параллельной перестановки.

История изменений по запросу читает native-транзакции. Выбор ревизии показывает прежние название, описание и текст; Вернуться к текущей статье выходит без изменения публикации. ID транзакций сохраняют порядок изменений, сделанных в одну секунду.

Удаление использует общий выбор native-зависимостей и DeleteCmd. Раздел с дочерними страницами сначала нужно освободить или реорганизовать. У статьи можно удалить её снапшоты/файлы с откатом через FileUndo; связанные справочные объекты автоматически к удалению не выбираются.

Внутренние контракты

Исходная серверная процедура — thlib/ui/knowledge_api.py, перенесённая в server/knowledge_query.py. Адаптер server/knowledge.py обслуживает транспорт, native-загрузки/удаление, права и конкурентную запись. Явная инициализация регистрирует {project}/th_knowledge_article; дополнительные поля: kind, parent_code, content, content_text, sort_order, updated_by, linked_skeys. Вложения и история используют штатные записи TACTIC, без отдельной веб-базы.

Авторизованные JSON-запросы идут в /admin/knowledge/{action}, загрузка — multipart /admin/knowledge/upload. Native-операции: list/load, save/save_draft/reserve, organize, history/history_revision, attachments/delete_attachment, link_index. Адаптер также добавляет upload и удаление с зависимостями. Префикс /admin/ здесь относится к backend endpoint, а не к адресу рабочего пространства в браузере.

Блок проверен на изолированных native SQLite-fixtures, свежих кадрах исходного QML и сценариях Chromium. Рабочие PostgreSQL/MySQL, физические телефоны и произвольные desktop-форматы буфера в эту проверку не входят. Подключение TH/DCC, Repository Sync и S3 исключены.

Общее представление и смена проекта

Навигация, оглавление, команды чтения и редактирования и панель форматирования используют одни описания Frame в Handler и Stream. На узкой панели команды переходят на следующую строку; дополнительные действия доступны через Другие действия форматирования. Qt и браузер сохраняют собственные редакторы Markdown, выделение, работу с изображениями и вложениями; отрисовка текста может отличаться.

При первом запуске Инициализировать открывает подтверждение с описанием изменений метаданных сообщений и таблицы статей проекта. Отмена ничего не записывает. Подтверждение сохраняет существующие столбцы и данные. Смена проекта закрывает подтверждение; запоздалые ответы предыдущего проекта не меняют статьи и права нового. Уже отправленная серверная запись остаётся операцией исходного проекта.

Clone this wiki locally