Dokumenty

Dokumenty to należące do projektu pliki Markdown przeznaczone do obszerniejszych informacji o projekcie. Plik .md jest zawsze źródłem podstawowym i pozostaje zgodny z zewnętrznymi edytorami tekstu.

Własność i przechowywanie

Wszystkie Dokumenty znajdują się pod <Project>/ProjectDocuments/. Nie ma zakresów Dokumentów Współdzielone ani Prywatne. Foldery Przeglądarki zawartości pod /Game/... odwzorowują odpowiadające im ścieżki pod ProjectDocuments/Content/...; folder Developers nadal oznacza kontekst projektu, a nie własność prywatną.

Dokument nie jest UAssetem, pakietem, przekierowaniem, obiektem uruchomieniowym ani właścicielem danych przygotowanych do gry. Locus nigdy nie opakowuje Markdownu w inny autorytatywny format.

Korzenie Dokumentów Locus i Przeglądarki zawartości

Drzewo Dokumentów ma dwa korzenie prezentacji nad jednym fizycznym repozytorium:

Dokumenty Locus zawierają zwykłe należące do projektu Dokumenty przechowywane poza zarezerwowanym poddrzewem Content/. Te Dokumenty istnieją tylko w Locus i nie są odwzorowywane w Przeglądarce zawartości Unreal.
Przeglądarka zawartości zawiera tylko Dokumenty, których autorytatywna ścieżka względna zaczyna się od Content/. Locus ukrywa ten wewnętrzny prefiks w drzewie, dlatego ProjectDocuments/Content/Blueprints/AI/Behavior.md pojawia się jako Przeglądarka zawartości > Blueprints > AI > Behavior i odwzorowuje się na /Game/Blueprints/AI.

Korzeń Przeglądarki zawartości jest rzadki i oparty na Dokumentach. Pokazuje tylko foldery zawierające bezpośrednio odwzorowany Dokument oraz przodków wymaganych, aby dotrzeć do tych folderów. Nie odzwierciedla niezwiązanych folderów /Game, a usunięcie pochodnego folderu prezentacji nie usuwa ani nie modyfikuje odpowiadającego mu folderu Unreal.

Odwzorowanie podąża za autorytatywną ścieżką względną, a nie za interfejsem użytym do utworzenia pliku. Dokument wykryty podczas uruchamiania, utworzony w Locus, utworzony przez Add > Locus > Locus dokument, zaimportowany lub utworzony przez MCP ma tę samą zindeksowaną tożsamość i zachowanie odwzorowania.

Tworzenie i znajdowanie Dokumentów

Twórz Dokument pod Dokumentami Locus, jeśli ma być dostępny tylko w Locus. Twórz go pod Przeglądarką zawartości, jeśli ma być odwzorowany do odpowiadającego mu kontekstu /Game. Akcja Add > Locus > Locus dokument w obsługiwanym folderze Przeglądarki zawartości tworzy tę samą odwzorowaną tożsamość. Locus tworzy prawdziwy zewnętrzny plik .md, ukrywa rozszerzenie w zwykłym interfejsie i otwiera dedykowaną kartę edytora. Import Markdownu i Dokumenty utworzone przez MCP korzystają z tej samej lokalnej zasady tworzenia jako Nieśledzone.

Organizuj nowy Dokument przed dodaniem go do kontroli wersji:

Utwórz → zmień nazwę, przenieś i edytuj → Oznacz do dodania, gdy ścieżka będzie ostateczna.

Obszar roboczy przegląda fizyczne foldery i obsługuje wyszukiwanie tytułu/ścieżki, filtry statusu, odświeżanie, otwieranie, zmianę nazwy, przenoszenie, usuwanie, pobieranie do edycji, oznaczanie do dodania, import i eksport. Jednocześnie może być otwartych wiele kart Dokumentów; otwarcie już otwartej ścieżki aktywuje istniejącą kartę.

Aby zaimportować plik, użyj akcji Locus w Przeglądarce zawartości i wybierz jeden prawidłowy plik .md w UTF-8. Locus zachowuje jego bajty źródłowe i zakończenia wierszy, a jeśli miejsce docelowe już istnieje, używa bezpiecznej numerowanej nazwy.

Pasek narzędzi dokument pozostaje jednym wierszem. Działania o niższym priorytecie stopniowo przechodzą do Więcej działań; Eksportuj i Odśwież pozostają tam. Jeśli nie skonfigurowano żadnego dostawcy, nie ma akcji kontroli źródła.

Edycja i zapis

Nowe lub puste Dokumenty otwierają się w Trybie edycji, a wypełnione Dokumenty w Trybie odczytu. Naciśnij Ctrl+E, aby włączyć Tryb edycji, Ctrl+R, aby włączyć Tryb odczytu, i Ctrl+S, aby zapisać. Dokumenty używają jawnego zapisu, a nie automatycznego zapisu Notatek.

Edytor źródła udostępnia polecenia dla nagłówków, wyróżnienia, kodu śródliniowego i bloków kodu, list uporządkowanych i nieuporządkowanych, list zadań, cytatów blokowych, linków, tabel, linii poziomych, Odwołań do zasobów i Odwołań do Pinezek. Podzielony Podgląd pokazuje bieżący niezapisany bufor obok źródła po krótkim opóźnieniu aktualizacji; otwieranie lub aktualizowanie Podglądu nie zapisuje pliku.

W Edycja kompaktowy pasek narzędzi udostępnia Nagłówek, Pogrubienie, Kursywa, Kod śródwierszowy, Lista nieuporządkowana, Lista uporządkowana, Odnośnik zewnętrzny, Odwołanie do zasobu i Odwołanie do pinezki; inne polecenia pozostają w Formatowanie. Podziel podgląd renderuje bieżący bufor obok źródła po krótkim odrzuceniu bez zapisywania; jego dzielnik, stan otwarty i stosunek są osobistymi preferencjami.

Tryb odczytu i obsługa Markdownu

Tryb odczytu używa natywnego interfejsu Unreal. Obsługuje konstrukcje Markdown potrzebne na pasku narzędzi edytora, w tym nagłówki, akapity, wyróżnienie, pogrubienie, listy, wyświetlane tylko elementy zadań, cytaty blokowe, kod, linki, tabele z wyrównaniem, linie poziome i przekreślenie.

Locus nie obiecuje renderowania równoważnego przeglądarce ani pełnej obsługi Markdownu. Surowy HTML pozostaje nieaktywnym tekstem źródłowym, JavaScript nigdy się nie wykonuje, niebezpieczne schematy URL nie są aktywowane, a zewnętrzna zawartość nie jest automatycznie pobierana. Linki HTTP i HTTPS otwierają się dopiero po jawnym działaniu użytkownika w przeglądarce systemowej.

Edytor Dokumentów Locus pokazujący Dokument Markdown projektu w Trybie odczytu z nagłówkami, listą i tabelą — Dokumenty zachowują Markdown jako źródło, a Tryb odczytu prezentuje obsługiwaną strukturę w natywnym interfejsie edytora.

Odwołania do zasobów i Pinezek używają czytelnych etykiet w prezentacji. Pinezkę bieżącej mapy można skupić; Pinezkę z innej mapy można zlokalizować na należącym do niej poziomie bez automatycznego ładowania tego poziomu. Brakujące odwołania pozostają nieaktywne i możliwe do zdiagnozowania.

Rozwiązane odniesienia do zasobu, pinezka, notatka, dokument i Actor korzystają z czytelnych etykiet. Odniesienia do Actor są tworzone wyłącznie poprzez upuszczenie jednego kwalifikującego się załadowanego World Outliner Actor do dokument w trybie edycji; nie są one oferowane przez Wstaw odniesienie ani @. Surowy kod HTML i JavaScript nigdy nie są wykonywane, a zawartość zdalna nie jest pobierana.

Zmiana nazwy, przenoszenie i usuwanie

Zmiana nazwy i przenoszenie pozostają w obrębie korzenia Dokumentów. W przypadku kwalifikującego się Nieśledzonego Dokumentu użyj Zmień nazwę na pasku narzędzi lub w menu kontekstowym, naciśnij F2, użyj Przenieś na pasku narzędzi albo przeciągnij go do prawidłowego istniejącego folderu. Obszar roboczy Dokumentów Locus jest autorytatywnym miejscem zmiany nazwy lub przenoszenia; element w Przeglądarce zawartości jest projekcją i bezpośrednia zmiana nazwy w Przeglądarce zawartości nie jest obsługiwana.

Po Oznacz do dodania zmiana nazwy i przenoszenie są celowo niedostępne. Pozostają niedostępne także dla kontrolowanych Dokumentów, ponieważ Locus nie może zagwarantować neutralnego względem dostawcy transakcyjnego przeniesienia przez kontrolę wersji. Ta granica bezpieczeństwa zapobiega rozdzieleniu Dokumentu i kontroli wersji przez zmianę pliku. Otwarte Dokumenty ze zmianami lub konfliktem również blokują zmianę nazwy, przenoszenie i usuwanie w obszarze roboczym.

Usunięcie jest trwałe, wymaga potwierdzenia i nie może zostać cofnięte przez Unreal. W przypadku śledzonych plików Locus sprawdza stan i kieruje usunięcie przez aktywnego dostawcę przed lokalnym czyszczeniem.

Zmiany ścieżki są dostępne tylko dla lokalnych lub Untracked dokument. Zmiana nazwy i przenoszenie są wyłączone po kontroli Oznacz do dodania lub dostawcy, ponieważ Locus nie wykonuje ruchów składu neutralnych dla dostawcy ani nie przesyła stanu otwartego między ścieżkami.

Eksport

Eksportuj wybrany Dokument, folder, wszystkie Dokumenty lub kopię edytora. Eksport zachowuje bieżące źródło — w tym niezapisany bufor edytora podczas eksportowania kopii — i może zachować strukturę folderów. Miejsce docelowe nie może znajdować się w ProjectDocuments; przy kolizji dostępne są opcje zastąpienia, pominięcia lub utworzenia numerowanej kopii. Eksport nie zmienia źródłowego Dokumentu, jego karty ani stanu kontroli wersji.

Odzyskiwanie i edycja zewnętrzna

Locus przechowuje odzyskiwanie Dokumentów w <Project>/Saved/Locus/Recovery/dokumenty/. Udany zapis usuwa odpowiadającą migawkę. Czyste zmiany zewnętrzne są wczytywane ponownie; zewnętrzna zmiana kolidująca z lokalnym tekstem ze zmianami blokuje zapis, dopóki nie wybierzesz bezpiecznego rozwiązania.

Ponieważ autorytatywny jest plik .md, obsługiwane są zewnętrzne edytory. Odśwież wykrywanie po zewnętrznych operacjach na plikach, jeśli obszar roboczy nie aktualizuje się szybko. Karty edytora nie są automatycznie przywracane po ponownym uruchomieniu Unreal Editor.

Nowy Locus dokument preferuje aktywny lub ostatnio aktywny stos zakładek Locus dokument; ta sama znormalizowana ścieżka skupia istniejącą kartę. Karty można swobodnie dokować, ale nie można ich przywrócić po ponownym uruchomieniu Edytora.

Podgląd wybranego Dokumentu

Wybranie Dokumentu pokazuje tylko do odczytu podgląd Markdownu w panelu szczegółów obszaru roboczego. Prezentuje on zapisany, autorytatywny plik; do czytania lub edycji użyj dedykowanego edytora Dokumentów. Podczas zwykłego krótkiego przejścia między wyborami podgląd pozostaje neutralny do czasu przygotowania wybranej zawartości. Dopiero oczekiwanie dłuższe niż około jedna sekunda pokazuje zwięzłe natywne wyjaśnienie ładowania zamiast nieaktualnej zawartości.

Nazwa pliku i ścieżka Dokumentu określają jego tożsamość w obszarze roboczym. Nagłówek Markdown jest treścią, więc zmiana nazwy pliku aktualizuje wyświetlaną nazwę bez przepisywania nagłówka takiego jak # My Title.

W menu dokument Editor Widok, Rozmiar czcionki źródła wpływa na edytor źródłowy, a Rozmiar czcionki tekstu do czytania wpływa na pełny podgląd odczytu i podziału. Ctrl+mouse wheel dostosowuje odpowiedni widok.

Kontrola wersji

Dokumenty należą do projektu. Nowo utworzony Dokument pozostaje Nieśledzony, dopóki jawnie nie wybierzesz Oznacz do dodania, dzięki czemu można go organizować, gdy ścieżka wciąż się zmienia. Lokalny lub nieśledzony Dokument pozostaje prawidłowo edytowalny w Trybie lokalnym. Jeśli oznaczenie do dodania się nie powiedzie, prawidłowy Markdown pozostaje na miejscu i można ponowić działanie.

Istniejący kontrolowany przez depot Dokument pozostaje dostępny do odczytu, ale nie może wejść w autorytatywny Tryb edycji ani zostać Zapisany, dopóki jawne pobranie do edycji się nie powiedzie. Locus pozostawia te działania niedostępne, gdy Dokument jest czysty i nie został pobrany do edycji, został pobrany przez innego użytkownika lub klienta, jest nieaktualny albo dostawca jest odłączony. Nie oferuje obejścia Make Writable; Tryb odczytu i Eksportuj kopię pozostają dostępne, gdy ma to zastosowanie.

Po ponownym połączeniu kontroli wersji odświeżenie przywraca stan kontrolowany. Dokument pozostaje tylko do odczytu do czasu udanego pobrania do edycji. Locus nie przesyła zmian, nie synchronizuje, nie zarządza changelistami i nie zmienia typemap. Zobacz Kontrola wersji, Wpływ na projekt i zależności i Rozwiązywanie problemów.

Bez skonfigurowanego dostawcy dokumenty nie wyświetla żadnego statusu, wskazówek, podpowiedzi ani akcji specyficznych dla kontroli źródła. Skonfigurowany, ale niedostępny dostawca zapewnia ochronę znanych kontrolowanych plików.