Wiki-Dateien und Dateistruktur

Azure DevOps Services | Azure DevOps Server 2020 | Azure DevOps Server 2019 | TFS 2018

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

Wenn Sie ein Teamprojekt erstellen, wird ein Wiki standardmäßig nicht erstellt. Weitere Informationen zum Erstellen von Wikis finden Sie unter Erstellen eines Wikis für Ihr Projekt.

Jedes Codewiki wird von einem Git-Repository im Back-End unterstützt. Dieses Repository speichert die Markdown-Seiten, Bilder, Anlagen und die Sequenz von Seiten und Unterseiten. Sie erstellen Ihr Wiki über die Azure DevOps Benutzeroberfläche, und dann können Sie das Wiki über ihren Git-Repository-URL-Pfad bearbeiten. Weitere Informationen zum Veröffentlichen von Codewikis finden Sie unter Veröffentlichen eines Git-Repositorys in einem Wiki.

Wiki-Datei- und Ordnerstruktur

Das Teamprojekt Wiki Git-Repositorys werden den folgenden Bezeichnungen zugewiesen.

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

Hinweis

Sie können Ihr Wiki-Repo auf dieselbe Weise verwalten, wie Sie alle anderen Git-Repo verwalten, indem Sie Verzweigungsrichtlinien in der WikiMain-Verzweigung definieren. Sie können jedoch Änderungen an Ihrem lokalen WikiMain-Zweig vornehmen und direkt an die Remotezweige pushen, ohne Richtlinien zu definieren.

Das Wiki-Repository verfügt über die folgenden Dateien und Ordner:

  • Datei für jede Markdown-Seite, die auf Stammebene eingegeben wurde
  • Dateibezeichnung .order am Stamm und unter jedem Ordner
  • Ordner für jede Seite mit Unterseiten
  • .attachments-Ordner , speichern alle Anlagen des Wikis

Benennungskonventionen für Dateien

Jede Datei erfordert die Verwendung von Strichen anstelle von Leerzeichen im Seitentitel. Der Titel der Seite "Mitwirken" entspricht z. B. dem How-to-contribute.md Dateinamen. Der Seitenname wird der URL hinzugefügt, um sicherzustellen, dass Links, die Sie freigeben, im Laufe der Zeit unverändert bleiben.

Jede Wiki-Seite entspricht einer Datei innerhalb des Wiki-Git-Repo. 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 Seitentitel sind Groß-/Kleinschreibungen und müssen innerhalb der Wiki-Hierarchie eindeutig sein.
Sonderzeichen
  1. Dürfen keine Unicode-Steuerzeichen oder Ersatzzeichen enthalten.
  2. Darf nicht die folgenden druckbaren Zeichen enthalten: / \ #
  3. Dürfen nicht mit einem Punkt (.) beginnen oder enden
Dateigröße Darf maximal 18 MB überschreiten
Anlagendateigröße Darf maximal 19 MB überschreiten

Sonderzeichen in Wiki-Seitentiteln

Sie können Seitentitel angeben, die mindestens eine dieser Sonderzeichen : < > * ? | -enthalten. Sie können beispielsweise eine Markdown-Datei als "HÄUFIG gestellte Fragen" oder "Einrichtungshandbuch" benennen. Die Zeichen verfügen über die folgenden URI-codierte Zeichenfolgen:

Zeichen Codierte Zeichenfolge
: %3A
< %3C
> %3E
* %2A
? %3F
| %7C
- %2D
" %22
Einschränkungstyp Einschränkung
Dateiname Der vollqualifizierte Seitenpfad sollte 235 Zeichen nicht überschreiten.
Eindeutigkeit Seitentitel sind Groß-/Kleinschreibungen und müssen innerhalb der Wiki-Hierarchie eindeutig sein.
Sonderzeichen
  1. Dürfen keine Unicode-Steuerzeichen oder Ersatzzeichen enthalten.
  2. Darf nicht die folgenden druckbaren Zeichen enthalten: / < : \ * ? \ | - #
  3. Dürfen nicht mit einem Punkt (.) beginnen oder enden
  4. Titel von Seiten, die offline hinzugefügt wurden, dürfen keinen leeren Leerraum enthalten.
Dateigröße Darf maximal 18 MB überschreiten
Anlagendateigröße Darf maximal 19 MB überschreiten

ORDER-Datei

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

Wiki-TOC ORDER-Datei
Wiki TOC example screenshot. Wiki example .order file screenshot.

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

Löschen der .order-Datei , um auf alphabetische Sortierung zurückzugeben

Wenn keine ORDER-Datei vorhanden ist, werden die Seiten alphabetisch sortiert. Führen Sie die folgenden Schritte aus, um zu alphabetischer Sortierung zurückzugesetzt werden:

  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 Bestelldatei , und löschen Sie sie. Die ORDER-Datei ruft nach dem Löschen automatisch (neu)erstellt, z. B. in einer Ziehen- und Drop-Aktion auf einem Artikel.