Freigeben über

Wiki-Datei- und Ordnerstruktur in Git

Azure DevOps Services | Azure DevOps Server 2022 – Azure DevOps Server 2019

In diesem Artikel werden die Dateien und Ordnerstruktur für bereitgestellte Wikis und Wikis beschrieben, die als Code veröffentlicht wurden. Bei beiden Wiki-Typen werden die Dateien in einem Git-Repository gespeichert. Dateien können Markdown-Seiten, Code, Bilder, Anlagen oder andere Artefakte enthalten. Um die Präsentationssequenz der Dateien einzurichten, fügt Git in jedem Repositoryordner eine spezielle Datei (.order) hinzu.

Wenn Sie ein Projekt erstellen, wird standardmäßig kein Wiki erstellt. Sie können ein Wiki bereitstellen, eine INFODATEI erstellen oder Projektcode als Wiki veröffentlichen.

Sie erstellen Ihr Wiki mithilfe der Azure DevOps-Benutzeroberfläche. Anschließend können Sie das Wiki aus Ihrem Git-Repository-URL-Pfad bearbeiten.

Repositorydateien und Ordnerstruktur

Das Git-Repository für ein Wiki hat zwei Namenskonventionen:

  • Der Name des Wiki-Repositorys ist <ProjectName>.wiki<ProjectName> der Name Ihres Projekts.
  • Der Name der Stammverzweigung für das Wiki-Repository lautet wikiMain.

Sie verwalten ein Wiki-Repository auf die gleiche Weise wie andere Git-Repositorys, indem Sie Verzweigungsrichtlinien für die wikiMain Verzweigung definieren. Sie können auch Änderungen an Ihrer lokalen wikiMain Verzweigung vornehmen und diese direkt an die Remote-Verzweigung übertragen, ohne Richtlinien zu definieren.

Ein Wiki-Repository besteht aus den folgenden Dateien und Ordnern:

  • Eine Datei für jede Markdown-Seite auf der Stammebene
  • Eine Datei mit dem Namen .order, die sich auf der Ebene des Stammverzeichnisses und auch innerhalb der einzelnen Unterordner befindet.
  • Ein Unterordner für jede Wiki-Seite mit Unterseiten
  • Ein Ordner mit dem Namen .attachments, um alle Anhänge zu speichern, die im Wiki verwendet werden.

Dateibenennungskonventionen

Der Dateiname für jede Wiki-Seite entspricht dem Wiki-Seitentitel. Im Dateinamen stellt ein Bindestrich (-) ein Leerzeichen im Seitentitel dar. Beispielsweise entspricht der Seitentitel "Mitwirken" dem Dateinamen How-to-contribute.md. Der URL-Pfad zur Wiki-Seite enthält den Dateinamen. Beispiel: https://github.com/ExampleWiki/How-To/How-to-contribute.md. Mit diesem Ansatz können Sie sicherstellen, dass Lesezeichenlinks zur Seite erhalten bleiben, wenn sich das Wiki im Laufe der Zeit ändert.

Jede Wiki-Seite entspricht einer Datei im Wiki-Git-Repository. Die folgenden Einschränkungen gelten für Seitendateinamen und die Dateigröße:

  • Dateiname: Beachten Sie beim Auswählen eines Namens für die Seitendatei, dass der vollqualifizierte Pfad zur Datei 235 Zeichen oder weniger sein sollte. Der vollständige Pfad zur Seite besteht aus der Repository-URL, dem Ordnerpfad zur Seitendatei und dem Seitendateinamen. Beispiel: https://github.com/ExampleWiki/Contributors/Code/How-to-add-code-to-the-project.md.

  • Eindeutigkeit: Der Name der Seitendatei muss innerhalb des Ordnerspeicherorts in der Wiki-Repositoryhierarchie eindeutig sein. Der Name ist groß-/kleinschreibungssensitiv.

  • Sonderzeichen: Der Dateiname der Seite hat Einschränkungen für die folgenden Sonderzeichen:

    • Keine Unicode-Steuerzeichen oder Ersatzzeichen
    • Keine druckbaren Zeichen: Schrägstrich /, Rückwärtsschrägstrich \, Raute #
    • Kein Punktzeichen . am Anfang oder am Ende des Namens

  • Dateigröße: Die maximale Seitendateigröße beträgt 18 MB.

  • Größe der Anlagendatei: Die maximale Größe einer Anlage einer Seitendatei beträgt 19 MB.

Zulässige Sonderzeichen

In einem Seitendateinamen sind mehrere Sonderzeichen zulässig, z. B. Doppelpunkt : und Bindestrich -. Sie können beispielsweise eine Markdown-Datei als FAQ:0525 oder Setup-Guide benennen.

Von Bedeutung

Um Fehler in seitensyntax und browsernavigation zu vermeiden, verwenden Sie nicht das Leerzeichen ( ) in Seitendateinamen. Wenn Sie Ihre Seitendateien basierend auf dem Seitentitel benennen, ersetzen Sie alle Leerzeichen im Seitentitel durch einen Bindestrich (-) im Dateinamen.

In der folgenden Tabelle sind die in Wiki-Seitendateinamen zulässigen Sonderzeichen und die entsprechende URI-codierte Zeichenfolge aufgeführt:

Charakter Symbol URI-Zeichenfolge
Doppelpunkt : %3A
Linke spitze Klammer < %3C
Eckige eckige Klammer rechts > %3E
Sternchen (Wildcard) * %2A
Fragezeichen ? %3F
Pipe- | %7C
Bindestrich (Strich) - %2D
Doppeltes Anführungszeichen " %22

Beispielsweise wird der Dateiname FAQ:0525 als FAQ%3A0525codiert.

Seitensequenz und die .order-Datei

Die ORDER-Datei definiert die Wiki-Seitensequenz. Git sucht in jedem Ordner nach dieser Datei, um die Reihenfolge zu identifizieren, in der Dateien an diesem Speicherort vorhanden sind. Die Standardseitensequenz ist alphabetische Reihenfolge (A bis Z) anhand des Dateinamens.

Definieren einer benutzerdefinierten Seitensequenz

Wenn ein Ordner nicht über eine ORDER-Datei verfügt, verwendet Git die standardmäßige alphabetische Sequenz.

Sie können eine benutzerdefinierte Sequenz für jeden Ordner definieren, indem Sie die ORDER-Datei im Ordner aktualisieren, einschließlich auf der Stammebene.

Die folgende Abbildung zeigt ein Beispiel für ein Wiki-Inhaltsverzeichnis und die entsprechende .order Datei, die das Inhaltsverzeichnis erstellt.

Wiki-Inhaltsverzeichnis wird im Webbrowser angezeigt

Screenshot des Inhaltsverzeichnisses für ein Wiki mit mehreren Ordnern, die erweitert wurden, um Unterordner anzuzeigen.

Die ORDER-Datei definiert die ToC-Seitensequenz.

Screenshot eines Wiki-Ordners und einer Dateiliste in einem Git-Repository. Die ORDER-Datei ist geöffnet und zeigt die Definition für die ToC-Seitensequenz an.

Die .order-Datei ändert die Reihenfolge von alphabetisch zu "Marketing" gefolgt von "Fabrikam Fiber".

Weitere Informationen zum Neuanordnen von Wiki-Seiten finden Sie unter Hinzufügen, Bearbeiten und Neuanordnen von Wiki-Seiten.

Wiederherstellen der alphabetischen Reihenfolge

Wenn ein Ordner eine benutzerdefinierte Sequenz aufweist, können Sie die Sortiermethode alphabetisch wiederherstellen, indem Sie die folgenden Schritte ausführen:

  1. Kopieren Sie die Klon-URL für das Wiki, und öffnen Sie sie in einem Browser. Das Git-Repository für das Wiki wird geöffnet.

  2. Wechseln Sie zur .order-Datei, die Sie zurücksetzen möchten, und löschen Sie die Datei. Nachdem die Datei gelöscht wurde, erstellt Git automatisch eine neue ORDER-Datei für diesen Speicherort. Die neue Datei verwendet die Standardsequenz.

Verwandte Inhalte