Wiki-Dateien und Dateistruktur

  • Artikel

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

Erfahren Sie mehr über die Datei- und Dateistruktur für Projekt-Wikis und Code-Wikis. Die folgende Anleitung kann Codewikis angeben, gilt jedoch für beide Wiki-Typen.

Wenn Sie ein Teamprojekt erstellen, wird kein Wiki standardmäßig erstellt. Weitere Informationen finden Sie unter Erstellen eines Wikis, Erstellen einer INFODATEI oder bereitgestellter Wikis im Vergleich zu veröffentlichtem Code als Wiki.

Jedes Codewiki wird von einem Git-Repository im Back-End unterstützt. In diesem Repository werden die Markdownseiten, Bilder, Anlagen und die Reihenfolge der Seiten und Unterseiten gespeichert. Sie erstellen Ihr Wiki über die Azure DevOps-Benutzeroberfläche und können das Wiki dann über den URL-Pfad ihres Git-Repositorys bearbeiten. Weitere Informationen zum Veröffentlichen von Codewikis finden Sie unter Veröffentlichen eines Git-Repositorys in einem Wiki.

Wiki-Datei- und Ordnerstruktur

Den Git-Repositorys des Teamprojekt-Wikis werden die folgenden Bezeichnungen zugewiesen.

  • Wiki-Repository für ein Teamprojekt: ProjectName.wiki
  • Hauptzweig: wikiMain

Verwalten Sie Ihr Wiki-Repository auf die gleiche Weise wie jedes andere Git-Repository, indem Sie Verzweigungsrichtlinien für die WikiMain-Verzweigung definieren. Sie können jedoch Änderungen an Ihrer lokalen WikiMain-Verzweigung vornehmen und sie direkt an die Remoteverzweigung übertragen, ohne Richtlinien zu definieren.

Das Wiki-Repository enthält die folgenden Dateien und Ordner:

  • Datei für jede Markdownseite, die auf Stammebene eingegeben wird
  • Datei, die am Stamm und unter jedem Ordner beschriftet ist .order
  • Ordner für jede Seite mit Unterseiten
  • .attachments ordner, speichern alle Anlagen des Wikis

Namenskonventionen für Dateien

Jede Datei erfordert die Verwendung von Bindestrichen anstelle von Leerzeichen im Seitentitel. Der Seitentitel "Mitwirken" entspricht z. B. dem How-to-contribute.md Dateinamen. Der Seitenname wird der URL hinzugefügt, um sicherzustellen, dass die von Ihnen freigegebenen Links funktional bleiben, während sich das Wiki im Laufe der Zeit ändert.

Jede Wiki-Seite entspricht einer Datei innerhalb des Wiki-Git-Repositorys. Namen, die Sie einem Wiki-Seitentitel zuweisen, müssen den folgenden Einschränkungen entsprechen.

Einschränkungstyp Einschränkung
Dateiname Der vollqualifizierte Seitenpfad sollte 235 Zeichen nicht überschreiten.
Eindeutigkeit Bei Seitentiteln wird die Groß-/Kleinschreibung beachtet, und sie müssen innerhalb der Wiki-Hierarchie eindeutig sein.
Sonderzeichen - Darf keine Unicode-Steuerelementzeichen oder Ersatzzeichen enthalten.
– Darf die folgenden druckbaren Zeichen nicht enthalten: / \ #.
: Darf nicht mit einem Punkt beginnen oder enden ..
Dateigröße Sie dürfen die Maximalgröße von 18 MB nicht überschreiten.
Dateigröße von Anlagen Darf den Höchstwert von 19 MB nicht überschreiten.

Sonderzeichen in Wiki-Seitentiteln

Sie können Seitentitel angeben, die eines oder mehrere dieser Sonderzeichen : < > * ? | -enthalten. Beispielsweise können Sie eine Markdowndatei als "FAQ?" oder "Einrichtungsleitfaden" benennen. Die Zeichen weisen die folgenden URI-codierten Zeichenfolgen auf:

Zeichen Codierte Zeichenfolge
: %3A
< %3C
> %3E
* %2A
? %3F
| %7C
- %2D
" %22

ORDER-Datei

Die ORDER-Datei definiert die Reihenfolge der Seiten innerhalb des Wikis. Das folgende Visual zeigt ein Beispiel für ein Wiki-Inhaltsverzeichnis und die entsprechende ORDER-Datei .

Wiki-ToC ORDER-Datei
Screenshot des Wiki-ToC-Beispiels. Screenshot der Wiki-Beispielreihenfolgedatei.

Die Standardhierarchie ist in alphabetischer Reihenfolge angeordnet. Sie können diese Hierarchie jedoch in der ORDER-Datei ändern. Weitere Informationen zum Neuanordnen von Wiki-Seiten finden Sie unter Hinzufügen und Bearbeiten von Wiki-Seiten, Neuanordnen einer Wiki-Seite.

Löschen Sie die ORDER-Datei, um die alphabetische Sortierung zu rückgängig machen.

Wenn keine ORDER-Datei vorhanden ist, werden die Seiten alphabetisch sortiert. Führen Sie die folgenden Schritte aus, um die alphabetische Sortierung zu rückgängig machen:

  1. Kopieren Sie die Klon-URL für das Wiki, und öffnen Sie sie in einem Browser. Dadurch wird das Git-Repository (Files Hub) geöffnet, das das Wiki zurückgibt.
  2. Wechseln Sie zur ORDER-Datei , und löschen Sie sie. Die Datei wird automatisch (erneut) nach dem Löschen erstellt, z. B. in einer Zieh- und Ablageaktion für einen Artikel.