Документы

Документы — это принадлежащие проекту файлы Markdown для подробных сведений о проекте. Файл .md всегда является основным источником и остаётся совместимым с внешними текстовыми редакторами.

Владение и хранение

Все документы находятся под <Project>/ProjectDocuments/. Областей документов Общие или Личные нет. Папки Браузера контента под /Game/... отображаются на соответствующие пути под ProjectDocuments/Content/...; папка Developers также является контекстом проекта, а не личным владением.

Документ не является UAsset, пакетом, редиректором, объектом выполнения или владельцем данных, подготовленных для игры. Locus никогда не оборачивает Markdown в другой авторитетный формат.

Корни Документов Locus и Браузера контента

Дерево документов имеет два корня представления над одним физическим хранилищем:

Документы Locus содержат обычные принадлежащие проекту документы вне зарезервированного поддерева Content/. Эти документы существуют только в Locus и не проецируются в Браузер контента Unreal.
Браузер контента содержит только документы, авторитетный относительный путь которых начинается с Content/. Locus скрывает этот внутренний префикс в дереве, поэтому ProjectDocuments/Content/Blueprints/AI/Behavior.md отображается как Браузер контента > Blueprints > AI > Behavior и проецируется в /Game/Blueprints/AI.

Корень Браузера контента разрежен и строится по документам. В нём отображаются только папки, непосредственно содержащие проецируемый документ, и необходимые предки для пути к этим папкам. Он не зеркалит несвязанные папки /Game, а удаление производной папки представления не удаляет и не изменяет соответствующую папку Unreal.

Проекция следует авторитетному относительному пути, а не интерфейсу, использованному для создания файла. Документ, обнаруженный при запуске, созданный в Locus, созданный через Add > Locus > Locus документ, импортированный или созданный через MCP, имеет одну и ту же индексированную идентичность и поведение проекции.

Создание и поиск документов

Создавайте документ под Документами Locus, если он должен существовать только в Locus. Создавайте его под Браузером контента, если документ должен проецироваться в соответствующий контекст /Game. Действие Add > Locus > Locus документ в поддерживаемой папке Браузера контента создаёт ту же проецируемую идентичность. Locus создаёт настоящий внешний файл .md, скрывает расширение в обычном интерфейсе и открывает отдельную вкладку редактора. Импорт Markdown и документы, созданные через MCP, используют ту же локальную политику создания как Неотслеживаемые.

Организуйте новый документ до добавления его в систему контроля версий:

Создать → переименовать, переместить и изменить → Пометить для добавления, когда путь окончателен.

Рабочая область просматривает физические папки и поддерживает поиск по заголовку и пути, фильтры состояния, обновление, открытие, переименование, перемещение, удаление, получение для редактирования, пометку для добавления, импорт и экспорт. Одновременно можно открыть несколько вкладок документов; открытие уже открытого пути переводит фокус на существующую вкладку.

Для импорта используйте действие Locus в Браузере контента и выберите один корректный файл .md в UTF-8. Locus сохраняет исходные байты и окончания строк, а если место назначения уже существует, использует безопасное нумерованное имя.

Панель инструментов документы остается одной строкой. Действия с более низким приоритетом постепенно переходят в Дополнительные действия; Экспортировать и Обновить остаются там. Действия по управлению исходным кодом отсутствуют, если поставщик не настроен.

Редактирование и сохранение

Новые или пустые документы открываются в Режиме редактирования, а заполненные — в Режиме чтения. Нажмите Ctrl+E для Режима редактирования, Ctrl+R для Режима чтения и Ctrl+S для сохранения. Документы используют явное сохранение, а не автоматическое сохранение заметок.

Редактор исходного текста предоставляет команды для заголовков, выделения, встроенного и fenced-кода, нумерованных и ненумерованных списков, списков задач, цитат, ссылок, таблиц, горизонтальных линий, ссылок на ассеты и ссылок на метки. Разделённый Предпросмотр показывает текущий несохранённый буфер рядом с исходным текстом после небольшой задержки обновления; открытие или обновление Предпросмотра не сохраняет файл.

В Редактировать компактная панель инструментов содержит Заголовок, Полужирный, Курсив, Встроенный код, Маркированный список, Нумерованный список, Внешняя ссылка, Ссылка на ассет и Ссылка на метку; остальные команды остаются в Формат. Разделить предпросмотр визуализирует текущий буфер рядом с исходным кодом после короткого дребезга без сохранения; его разделитель, открытое состояние и соотношение являются личными предпочтениями.

Режим чтения и поддержка Markdown

Режим чтения использует нативный интерфейс Unreal. Он поддерживает конструкции Markdown, необходимые для панели инструментов редактора: заголовки, абзацы, выделение, полужирный текст, списки, отображаемые только для чтения элементы задач, цитаты, код, ссылки, таблицы с выравниванием, горизонтальные линии и зачёркивание.

Locus не обещает рендеринг, эквивалентный браузеру, и полную поддержку Markdown. Необработанный HTML остаётся неисполняемым исходным текстом, JavaScript никогда не выполняется, небезопасные схемы URL не активируются, а удалённое содержимое не загружается автоматически. Ссылки HTTP и HTTPS открываются только после явного действия пользователя в системном браузере.

Редактор документов Locus показывает документ Markdown проекта в Режиме чтения с заголовками, списком и таблицей — Документы сохраняют Markdown как исходный текст, а Режим чтения показывает поддерживаемую структуру в нативном интерфейсе редактора.

Ссылки на ассеты и метки используют понятные подписи в представлении. На метке текущей карты можно сфокусироваться; метку другой карты можно найти на принадлежащем ей уровне без автоматической загрузки этого уровня. Отсутствующие ссылки остаются неактивными и пригодными для диагностики.

В ссылках разрешенного актива, метка, заметка, документ и Actor используются читаемые метки. Ссылки Actor создаются только путем добавления одного подходящего загруженного World Outliner Actor в документ в режиме редактирования; они не предлагаются Вставить ссылку или @. Необработанный HTML и JavaScript никогда не выполняются, а удаленный контент не извлекается.

Переименование, перемещение и удаление

Переименование и перемещение остаются внутри корня документов. Для подходящего Неотслеживаемого документа используйте Переименовать на панели инструментов или в контекстном меню, нажмите F2, используйте Переместить на панели инструментов или перетащите документ в существующую допустимую папку. Рабочая область Документов Locus — авторитетное место для переименования и перемещения; элемент в Браузере контента является проекцией, поэтому прямое переименование в Браузере контента не поддерживается.

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

Удаление необратимо, требует подтверждения и не может быть отменено средствами Unreal. Для отслеживаемых файлов Locus проверяет состояние и направляет удаление через активного поставщика перед локальной очисткой.

Изменения пути доступны только для локальных Untracked или документ. Переименование и перемещение отключены после Пометить для добавления или управления поставщиком, поскольку Locus не выполняет нейтральные для поставщика перемещения складов или не передает открытое состояние между путями.

Экспорт

Экспортируйте выбранный документ, папку, все документы или копию редактора. Экспорт сохраняет текущий исходный текст, включая несохранённый буфер при экспорте копии, и может сохранить структуру папок. Место назначения не может находиться внутри ProjectDocuments; при совпадении доступны варианты перезаписи, пропуска или нумерованной копии. Экспорт не изменяет исходный документ, его вкладку или состояние системы контроля версий.

Восстановление и внешнее редактирование

Locus хранит восстановление документов в <Project>/Saved/Locus/Recovery/документы/. После успешного сохранения соответствующий снимок удаляется. Чистые внешние изменения загружаются заново; внешнее изменение, конфликтующее с локальным изменённым текстом, блокирует сохранение, пока вы не выберете безопасное разрешение.

Поскольку авторитетным является .md, поддерживаются внешние редакторы. Обновите обнаружение после внешних операций с файлами, если рабочая область не обновилась вовремя. Вкладки редактора не восстанавливаются автоматически после перезапуска Unreal Editor.

Новый Locus документ предпочитает активный или последний активный стек вкладок Locus документ; тот же нормализованный путь фокусирует существующую вкладку. Вкладки остаются свободно закрепляемыми, но не восстанавливаются после перезапуска редактора.

Предпросмотр выбранного документа

При выборе документа на панели сведений рабочей области показывается доступный только для чтения предпросмотр Markdown. Он представляет сохранённый авторитетный файл; для чтения или редактирования используйте отдельный редактор документов. Во время обычного короткого перехода между выбранными элементами предпросмотр остаётся нейтральным, пока выбранное содержимое не будет готово. Только ожидание дольше примерно одной секунды показывает краткое нативное объяснение загрузки вместо устаревшего содержимого.

Имя файла и путь документа определяют его идентичность в рабочей области. Заголовок Markdown является содержимым, поэтому переименование файла меняет отображаемое имя, не переписывая заголовок вроде # My Title.

В меню редактора документ Вид Размер шрифта исходного текста влияет на редактор исходного кода, а Размер шрифта для чтения влияет на полное чтение и предварительный просмотр. Ctrl+mouse wheel настраивает соответствующий вид.

Система контроля версий

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

Существующий контролируемый depot документ остаётся доступным для чтения, но не может войти в авторитетный Режим редактирования или выполнить Сохранить, пока не завершится явное получение для редактирования. Locus оставляет эти действия недоступными, когда документ чистый и не получен для редактирования, получен другим пользователем или клиентом, устарел или поставщик отключён. Обхода Make Writable нет; Режим чтения и Экспортировать копию остаются доступными, если применимо.

После восстановления подключения к системе контроля версий обновление возвращает контролируемое состояние. Документ остаётся доступным только для чтения до успешного получения для редактирования. Locus не отправляет изменения, не синхронизирует, не управляет changelist и не изменяет typemap. См. разделы Система контроля версий, Влияние на проект и зависимости и Устранение неполадок.

Без настроенного поставщика документы не отображает состояние, рекомендации, подсказки или действия, специфичные для системы управления версиями. Настроенный, но недоступный поставщик обеспечивает защиту известных контролируемых файлов.