Pliki typu wiki i struktura plików

  • Artykuł

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

Dowiedz się więcej o plikach i strukturze plików dla witryn typu wiki projektu i witryn typu wiki kodu. Poniższe wskazówki mogą określać witryny typu wiki kodu, ale dotyczą obu typów stron typu wiki.

Podczas tworzenia projektu zespołowego witryna typu wiki nie jest domyślnie tworzona. Aby uzyskać więcej informacji, zobacz Tworzenie witryny typu wiki, Tworzenie pliku README lub aprowizowania witryn typu wiki w porównaniu z opublikowanym kodem jako witryną typu wiki.

Każda witryna typu wiki kodu jest obsługiwana przez repozytorium Git w zapleczu. To repozytorium przechowuje strony markdown, obrazy, załączniki oraz sekwencję stron i podstron. Witryna typu wiki jest tworzona za pośrednictwem interfejsu użytkownika usługi Azure DevOps, a następnie możesz edytować witrynę typu wiki za pośrednictwem ścieżki adresu URL repozytorium Git. Aby uzyskać więcej informacji na temat publikowania stron typu wiki kodu, zobacz Publikowanie repozytorium Git w witrynie typu wiki.

Struktura plików i folderów typu wiki

Do repozytoriów Git w witrynie typu wiki projektu zespołowego są przypisywane następujące etykiety.

  • Repozytorium wiki dla projektu zespołowego: ProjectName.wiki
  • Gałąź główna: wikiMain

Zarządzaj repozytorium wiki w taki sam sposób, jak w przypadku innych repozytoriów Git, definiując zasady gałęzi w gałęzi wikiMain. Możesz jednak wprowadzić zmiany w lokalnej gałęzi wikiMain i wypchnąć je bezpośrednio do gałęzi zdalnej bez definiowania żadnych zasad.

Repozytorium wiki zawiera następujące pliki i foldery:

  • Plik dla każdej strony markdown wprowadzonej na poziomie głównym
  • Plik oznaczony .order etykietą w katalogu głównym i pod każdym folderem
  • Folder dla każdej strony zawierającej podstrony
  • .attachments folder, przechowując wszystkie załączniki strony typu wiki

Konwencje nazewnictwa plików

W przypadku każdego pliku wymaga się używania łączników zamiast spacji w tytule strony. Na przykład tytuł strony Jak współtworzyć odpowiada How-to-contribute.md nazwie pliku. Nazwa strony jest dodawana do adresu URL, dzięki czemu udostępniane linki pozostają nienaruszone, gdy witryna typu wiki zmienia się wraz z upływem czasu.

Każda strona typu wiki odpowiada plikowi w repozytorium Git zawartości typu wiki. Nazwy przypisywane do tytułów stron typu wiki muszą być zgodne z następującymi ograniczeniami.

Typ ograniczenia Ograniczenie
Nazwa pliku Długość w pełni kwalifikowanej ścieżki strony nie powinna przekraczać 235 znaków.
Unikatowość W tytułach stron jest rozróżniana wielkość liter i tytuły te muszą być unikatowe w hierarchii stron typu wiki.
Znaki specjalne — Nie mogą zawierać żadnych znaków zastępczych ani znaków kontrolnych Unicode.
- Nie może zawierać następujących znaków drukowalnych: / \ #.
- Nie może rozpoczynać się lub kończyć kropką ..
Rozmiar pliku Nie może przekraczać 18 MB.
Rozmiar pliku załącznika Rozmiar nie może przekraczać 19 MB.

Znaki specjalne w tytułach stron typu wiki

Możesz określić tytuły stron, które zawierają co najmniej jeden z tych znaków : < > * ? | -specjalnych. Możesz na przykład nazwać plik Markdown jako "FAQ?" lub "Set-up guide". Znaki mają następujące ciągi zakodowane za pomocą identyfikatora URI:

Znak Zakodowany ciąg
: %3A
< %3C
> %3E
* %2A
? %3F
| %7C
- %2D
" 22%

Plik order

Plik order definiuje sekwencję stron w witrynie typu wiki. Poniższa wizualizacja przedstawia przykład spisu treści w witrynie typu wiki i odpowiada mu plik order.

Spis treści witryny typu wiki Plik order
Zrzut ekranu przedstawiający przykład spisu treści w witrynie typu wiki. Zrzut ekranu przedstawiający przykładowy plik zamówienia witryny Wiki.

Domyślna hierarchia jest w sekwencji alfabetycznej, ale można zmienić tę hierarchię w pliku order . Aby uzyskać więcej informacji na temat zmieniania kolejności stron typu wiki, zobacz Dodawanie i edytowanie stron typu wiki, Zmiana kolejności strony typu wiki.

Usuń plik order, aby przywrócić sortowanie alfabetyczne

Jeśli nie ma pliku order , strony są sortowane alfabetycznie. Aby przywrócić sortowanie alfabetyczne, wykonaj następujące czynności:

  1. Skopiuj adres URL klonowania witryny typu wiki i otwórz go w przeglądarce. Spowoduje to otwarcie repozytorium Git (centrum plików), które wspiera witrynę typu wiki.
  2. Przejdź do pliku order i usuń go. Plik zostanie automatycznie utworzony (ponownie) po usunięciu, na przykład w akcji przeciągania i upuszczania w artykule.