- Dokumentation
- Locus
- Dokumente
Dokumente
Dokumente sind projekt-eigene Markdown-Dateien für ausführlicheres Projektwissen. Die .md-Datei ist immer maßgeblich und bleibt mit externen Texteditoren kompatibel.
Besitz und Speicher
Abschnitt betitelt „Besitz und Speicher“Alle Dokumente liegen unter <Project>/ProjectDocuments/. Es gibt keine gemeinsamen oder privaten Dokumentbereiche. Content-Browser-Ordner unter /Game/... werden passenden Pfaden unter ProjectDocuments/Content/... zugeordnet; ein Developers-Ordner ist weiterhin Projektkontext und kein privater Besitz.
Ein Dokument ist kein UAsset, Paket, Redirector, Laufzeitobjekt oder Besitzer gekochter Daten. Locus verpackt das Markdown niemals in ein anderes maßgebliches Format.
Locus-Dokumente und Content-Browser-Wurzeln
Abschnitt betitelt „Locus-Dokumente und Content-Browser-Wurzeln“Der Dokumentebaum hat zwei Präsentationswurzeln über demselben physischen Repository:
- Locus-Dokumente enthält gewöhnliche projekt-eigene Dokumente außerhalb des reservierten
Content/-Teilbaums. Diese Dokumente existieren nur in Locus und werden nicht in den Content Browser des Unreal Editors projiziert. - Inhaltsbrowser enthält nur Dokumente, deren maßgeblicher relativer Pfad mit
Content/beginnt. Locus blendet dieses interne Speicherpräfix im Baum aus:ProjectDocuments/Content/Blueprints/AI/Behavior.mderscheint als Content Browser > Blueprints > AI > Behavior und wird in den passenden/Game/Blueprints/AI-Kontext projiziert.
Die Content-Browser-Wurzel ist sparsam und dokumentgesteuert. Sie zeigt nur Ordner, die direkt ein projiziertes Locus-Dokument enthalten, sowie die zum Erreichen dieser Ordner erforderlichen Vorgänger. Sie spiegelt keine unabhängigen /Game-Ordner und das Entfernen eines abgeleiteten Präsentationsordners löscht oder ändert den entsprechenden Unreal-Ordner nicht.
Die Projektion folgt dem maßgeblichen relativen Pfad und nicht der UI, mit der die Datei erstellt wurde. Ein beim Start entdecktes, in Locus erstelltes, über Add > Locus > Locus Dokument erstelltes, importiertes oder über MCP erstelltes Dokument hat dieselbe indexierte Identität und dasselbe Projektionsverhalten.
Dokumente erstellen und finden
Abschnitt betitelt „Dokumente erstellen und finden“Erstellen Sie unter Locus-Dokumente ein nur in Locus verwendetes Dokument. Erstellen Sie unter Inhaltsbrowser ein zugeordnetes Dokument, das in den entsprechenden /Game-Kontext projiziert wird. Add > Locus > Locus Dokument in einem unterstützten Content-Browser-Ordner erstellt dieselbe zugeordnete Identität. Locus erstellt eine echte externe .md-Datei, blendet die Endung in der normalen UI aus und öffnet einen eigenen Editor-Tab. Markdown-Importe und über MCP erstellte Dokumente folgen derselben lokalen Erstellung mit Status Nicht verfolgt.
Organisieren Sie ein neues Dokument, bevor Sie es zur Quellcodeverwaltung hinzufügen:
Erstellen → umbenennen, verschieben und bearbeiten → Zum Hinzufügen markieren, sobald der Pfad feststeht.
Der Arbeitsbereich durchsucht physische Ordner und unterstützt Titel-/Pfadsuche, Statusfilter, Aktualisieren, Öffnen, Umbenennen, Verschieben, Löschen, Auschecken, Zum Hinzufügen markieren, Import und Export. Mehrere Dokumenttabs können gleichzeitig geöffnet sein; beim Öffnen eines bereits geöffneten Pfads wird der vorhandene Tab fokussiert.
Für den Import verwenden Sie die Locus-Aktion im Content Browser und wählen eine gültige UTF-8-.md-Datei. Locus bewahrt Quellbytes und Zeilenenden und verwendet einen sicheren nummerierten Namen, wenn das Ziel bereits existiert.
Die Dokumente-Symbolleiste bleibt eine Zeile. Aktionen mit niedrigerer Priorität werden nach und nach in Weitere Aktionen verschoben; Exportieren und Aktualisieren bleiben dort. Wenn kein Anbieter konfiguriert ist, gibt es keine Quellcodeverwaltungsaktionen.
Bearbeiten und speichern
Abschnitt betitelt „Bearbeiten und speichern“Neue oder leere Dokumente öffnen im Bearbeitungsmodus; gefüllte Dokumente im Lesemodus. Drücken Sie Ctrl+E für den Bearbeitungsmodus, Ctrl+R für den Lesemodus und Ctrl+S zum Speichern. Dokumente verwenden explizites Speichern statt der automatischen Speicherung von Notizen.
Der Quelleditor bietet Befehle für Überschriften, Hervorhebung, Inline- und umzäunten Code, geordnete und ungeordnete Listen, Aufgabenlisten, Blockzitate, Links, Tabellen, horizontale Linien, Asset-Referenzen und Pin-Referenzen. Die geteilte Vorschau zeigt den aktuellen ungespeicherten Puffer nach einer kurzen Aktualisierungsverzögerung neben der Quelle; das Öffnen oder Aktualisieren der Vorschau speichert die Datei nicht.
In Bearbeiten bietet die kompakte Symbolleiste Überschrift, Fett, Kursiv, Inline-Code, Ungeordnete Liste, Geordnete Liste, Externer Link, Asset-Referenz und Pin-Referenz; andere Befehle bleiben in Formatieren. Vorschau teilen rendert den aktuellen Puffer nach einer kurzen Entprellung ohne Speichern neben der Quelle; Sein Teiler, sein offener Zustand und sein Verhältnis sind persönliche Vorlieben.
Lesemodus und Markdown-Unterstützung
Abschnitt betitelt „Lesemodus und Markdown-Unterstützung“Der Lesemodus verwendet native Unreal-UI. Er unterstützt die für die Editor-Symbolleiste erforderlichen Markdown-Konstrukte, einschließlich Überschriften mit klarer visueller Hierarchie, Absätzen, Hervorhebung, fettem Text, verschachtelten und losen Listen mit ihren verfassten Markierungen, interaktiven Aufgabenelementen, Blockzitaten, Code, Links, Tabellen mit Ausrichtung, horizontalen Linien und Durchstreichungen.
Locus beansprucht weder browsergleiche noch vollständige Markdown-Darstellung. Rohes HTML bleibt inaktiver Quelltext, JavaScript wird nie ausgeführt, unsichere URL-Schemata werden nicht aktiviert und entfernte Inhalte werden nicht automatisch abgerufen. HTTP- und HTTPS-Links werden erst nach einer ausdrücklichen Benutzeraktion im Browser des Betriebssystems geöffnet.

Asset- und Pin-Referenzen verwenden in der Präsentation lesbare Bezeichnungen. Ein Pin der aktuellen Map kann fokussiert werden; ein Pin einer anderen Map kann sein zugehöriges Level lokalisieren, ohne es automatisch zu laden. Fehlende Referenzen bleiben inaktiv und diagnostizierbar.
Aufgelöste Asset-, Pin-, Notiz-, Dokument- und Actor-Referenzen verwenden lesbare Beschriftungen. Actor-Referenzen werden nur erstellt, indem ein berechtigter geladener World Outliner Actor in einen Dokument im Bearbeitungsmodus eingefügt wird; Sie werden von Referenz einfügen oder @ nicht angeboten. Rohes HTML und JavaScript werden nie ausgeführt und Remote-Inhalte werden nicht abgerufen.
Im Lesemodus bearbeiten
Abschnitt betitelt „Im Lesemodus bearbeiten“Das Dokument, das Sie lesen, ist das Dokument, das Sie bearbeiten. Im vollständigen Lesemodus können Sie unterstützte Änderungen direkt am gerenderten Dokument vornehmen, ohne zur Markdown-Quelle zu wechseln:
- Klicken Sie auf einen geeigneten Absatz, eine
#-Überschrift oder ein Listenelement, um seinen Text direkt zu bearbeiten. Der Entwurf bleibt lokal, bis Sie die Bearbeitung übernehmen: Wenn Sie den Fokus verlagern, wird die Bearbeitung übernommen, und Esc bricht sie ab. - Schalten Sie Aufgaben-Kontrollkästchen direkt um, wenn das Dokument bearbeitbar ist.
- Verwenden Sie die Blocktyp-Steuerung im Absatz- oder Überschrifteneditor, um zwischen Absatz und H1–H6 zu wechseln, ohne Markdown-Markierungen einzugeben.
- Wählen Sie Block löschen im ⋯-Menü eines geeigneten Absatzes oder einer geeigneten Überschrift oder Element löschen bei einem geeigneten einfachen Listenelement. Beide Aktionen erfordern eine Bestätigung.
- Während Sie einen geeigneten Absatz bearbeiten, bleiben gültige Locus-Referenzen native Referenz-Chips, und normale Markdown-Links bleiben vollständig und lesbar, statt ihre rohe Syntax anzuzeigen.
Jede unterstützte Bearbeitung ändert nur den passenden Teil der .md-Datei, die maßgeblich bleibt. Locus hält die umgebende Lesefläche und Ihre Leseposition stabil, wenn es nachweisen kann, dass die lokale Aktualisierung sicher ist.
Inline-Bearbeitung ist bewusst konservativ. Inhalte, die Locus nicht sicher auf ihre Quelle abbilden kann, behalten ihre normale Darstellung im Lesemodus ohne Bearbeitungsoption und werden nie neu geschrieben. Element löschen ist für ein Listenelement mit verschachteltem oder anderem strukturellem Inhalt nicht verfügbar. Verwenden Sie den Bearbeitungsmodus für umfangreichere oder nicht unterstützte Konstrukte. Die geteilte Vorschau bleibt schreibgeschützt.
Umbenennen, verschieben und löschen
Abschnitt betitelt „Umbenennen, verschieben und löschen“Umbenennen und Verschieben bleiben innerhalb der Dokumente-Wurzel. Verwenden Sie bei einem geeigneten nicht verfolgten Dokument Umbenennen in der Symbolleiste oder im Kontextmenü, drücken Sie F2, verwenden Sie Verschieben in der Symbolleiste oder ziehen Sie es auf einen gültigen vorhandenen Ordner. Der Dokumente-Arbeitsbereich ist die maßgebliche Stelle zum Umbenennen oder Verschieben; das Content-Browser-Element ist eine Projektion und direktes Umbenennen im Content Browser wird nicht unterstützt.
Nach Zum Hinzufügen markieren sind Umbenennen und Verschieben absichtlich nicht verfügbar. Das gilt auch für kontrollierte Dokumente, weil Locus keinen anbieterneutralen transaktionalen Verschiebevorgang der Quellcodeverwaltung garantieren kann. Diese Sicherheitsgrenze verhindert, dass eine Dateisystemänderung Dokument und Quellcodeverwaltung auseinanderlaufen lässt. Geöffnete Dokumente mit ungespeicherten oder widersprüchlichen Änderungen blockieren ebenfalls Umbenennen, Verschieben und Löschen.
Löschen ist dauerhaft, erfordert eine Bestätigung und kann über Unreal nicht rückgängig gemacht werden. Bei verfolgten Dateien prüft Locus den Status und leitet die Löschung über den aktiven Anbieter, bevor lokal bereinigt wird.
Pfadänderungen sind nur für lokale oder Untracked Dokumente verfügbar. Umbenennen und Verschieben sind nach Zum Hinzufügen markieren oder Anbietersteuerung deaktiviert, da Locus keine anbieterneutralen Depotverschiebungen durchführt oder den offenen Status zwischen Pfaden überträgt.
Exportieren Sie ein ausgewähltes Dokument, einen Ordner, alle Dokumente oder eine Editor-Kopie. Der Export bewahrt die aktuelle Quelle — einschließlich eines ungespeicherten Editor-Puffers beim Export einer Kopie — und kann die Ordnerstruktur bewahren. Das Ziel darf nicht innerhalb von ProjectDocuments liegen; bei Kollisionen stehen Überschreiben, Überspringen oder eine nummerierte Kopie zur Auswahl. Der Export ändert weder das Quelldokument, seinen Tab noch den Status der Quellcodeverwaltung.
Wiederherstellung und externe Bearbeitung
Abschnitt betitelt „Wiederherstellung und externe Bearbeitung“Locus speichert die Dokument-Wiederherstellung unter <Project>/Saved/Locus/Recovery/Dokumente/. Ein erfolgreicher Speichervorgang entfernt den zugehörigen Snapshot. Saubere externe Änderungen werden neu geladen; eine externe Änderung, die mit schmutzigem lokalem Text kollidiert, blockiert das Speichern, bis Sie eine sichere Auflösung wählen. Wenn sich die Datei auf der Festplatte ändert, während eine Inline-Bearbeitung im Lesemodus aktiv ist, meldet Locus einen Konflikt, statt den Entwurf durch Neuladen zu überschreiben; der Konflikt blockiert das Speichern veralteten Quelltexts.
Da .md maßgeblich ist, werden externe Editoren unterstützt. Aktualisieren Sie die Erkennung nach externen Dateioperationen, wenn der Arbeitsbereich nicht zeitnah aktualisiert wird. Editor-Tabs werden nach dem Neustart des Unreal Editors nicht automatisch wiederhergestellt.
Ein neuer Locus Dokument bevorzugt den aktiven oder zuletzt aktiven Tab-Stapel Locus Dokument; Derselbe normalisierte Pfad fokussiert seine vorhandene Registerkarte. Tabs bleiben frei andockbar, werden aber nach einem Neustart des Editors nicht wiederhergestellt.
Vorschau des ausgewählten Dokuments
Abschnitt betitelt „Vorschau des ausgewählten Dokuments“Bei der Auswahl eines Dokuments zeigt das Arbeitsbereich-Detailpanel eine schreibgeschützte Markdown-Vorschau. Sie stellt die gespeicherte maßgebliche Datei dar; zum Lesen oder Bearbeiten verwenden Sie den eigenen Dokumenteditor. Während eines normalen kurzen Auswahlwechsels bleibt die Vorschau neutral, bis der ausgewählte Inhalt bereit ist. Erst eine Wartezeit von ungefähr einer Sekunde zeigt eine kompakte native Ladeerklärung statt veralteten Inhalts.
Dateiname und Pfad des Dokuments bilden seine Arbeitsbereichsidentität. Eine Markdown-Überschrift ist Inhalt; beim Umbenennen der Datei wird daher der angezeigte Dateiname aktualisiert, nicht eine Überschrift wie # My Title umgeschrieben.
Im Menü Dokument Editor Ansicht wirkt sich Schriftgröße der Quelle auf den Quelleditor und Schriftgröße der Lesedarstellung auf die vollständige Lese- und Split-Vorschau aus. Ctrl+mouse wheel passt die entsprechende Ansicht an.
Quellcodeverwaltung
Abschnitt betitelt „Quellcodeverwaltung“Dokumente sind projekt-eigen. Ein neu erstelltes Dokument bleibt Nicht verfolgt, bis Sie ausdrücklich Zum Hinzufügen markieren wählen. So kann es organisiert werden, solange sich sein Pfad noch ändert. Ein lokales oder nicht verfolgtes Dokument bleibt im lokalen Modus legitim bearbeitbar. Wenn das Markieren zum Hinzufügen fehlschlägt, bleibt das gültige Markdown erhalten und kann erneut versucht werden.
Ein vorhandenes depotkontrolliertes Dokument bleibt lesbar, kann aber erst nach einem erfolgreichen ausdrücklichen Checkout in den maßgeblichen Bearbeitungsmodus wechseln oder gespeichert werden. Locus hält diese Aktionen nicht verfügbar, wenn das Dokument sauber und nicht ausgecheckt, von einem anderen Benutzer oder Client ausgecheckt, veraltet oder von seinem Anbieter getrennt ist. Es gibt keinen Umgehungsschalter zum Schreibbarmachen; Lesemodus und Kopie exportieren bleiben, wo anwendbar, verfügbar.
Nach der Wiederverbindung der Quellcodeverwaltung stellt Aktualisieren den kontrollierten Status wieder her. Das Dokument bleibt schreibgeschützt, bis der Checkout erfolgreich ist. Locus übermittelt nicht, synchronisiert nicht, verwaltet keine Changelists und ändert keine Typemaps. Siehe Quellcodeverwaltung, Projektauswirkungen und Abhängigkeiten und Fehlerbehebung.
Ohne konfigurierten Anbieter zeigt Dokumente keinen Quellcodeverwaltungs-spezifischen Status, Anleitung, Tooltip oder Aktion an. Ein konfigurierter, aber nicht verfügbarer Anbieter schützt bekannte kontrollierte Dateien.