Перейти к содержанию

Документы

Требуется FEATURE_DOCUMENTS=true. После ./deploy.sh в меню появляется пункт «Документы».

Раздел хранит рабочие файлы отдельно от разовой вычитки: папки, версии, архив. Вычитка по-прежнему запускается из раздела «Вычитка»; репозиторий нужен, когда один и тот же документ возвращается несколько раз и нельзя терять предыдущий файл.

Репозиторий документов: дерево папок и список файлов

Обзор экрана

Слева дерево: «Все документы», созданные папки, «Архив». Справа список текущей папки и хлебные крошки. Поиск ищет по названию и ключу Jira, начиная с двух символов.

Пустой репозиторий показывает состояние «Здесь пока пусто» и кнопку «Загрузить документ».

Загрузка

«Загрузить» или перетаскивание файла в основную область (не в архив). Диалог:

  • файл
  • название (если пусто, берётся имя файла без расширения)
  • ключ Jira, например DOC-123
  • комментарий к версии

Документ получает версии: повторная загрузка с тем же смыслом оформляется как «Новая версия» в карточке, а не как второй независимый файл.

«Папка» создаёт каталог в текущем уровне. Название не длиннее 80 символов. Хлебные крошки возвращают на уровень выше.

Карточка документа

Щелчок по строке файла открывает карточку: число версий, кто загрузил, дата, ключ Jira.

  • «Новая версия» добавляет файл, Jira и комментарий
  • «В архив» переносит документ в папку «Архив»; «Восстановить» возвращает
  • «Удалить» удаляет документ и все версии
  • «Скачать» у строки версии отдаёт этот файл

Архивные документы видны только в «Архиве». Загрузка и создание папки там недоступны.

Связка OpenAPI берёт файлы именно из этого репозитория. Если планируется раздел «API», включите оба флага: FEATURE_DOCUMENTS и FEATURE_API.

Включение флага: дополнительные разделы.