Dela via

Wiki-filer och filstruktur

  • Artikel

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

Lär dig mer om filer och filstruktur för projekt-wikis och kod-wikis. Följande vägledning kan ange kod-wikis, men den gäller för båda typerna av wiki.

När du skapar ett teamprojekt skapas inte en wiki som standard. Mer information finns i Skapa en wiki, Skapa en README eller etablerade wikis jämfört med publicerad kod som en wiki.

Varje kod-wiki drivs av en Git-lagringsplats i serverdelen. Den här lagringsplatsen lagrar Markdown-sidor, bilder, bifogade filer och sekvensen med sidor och undersidor. Du skapar din wiki via Azure DevOps-användargränssnittet och sedan kan du redigera wikin via url-sökvägen till din Git-lagringsplats. Mer information om hur du publicerar kod-wikis finns i Publicera en Git-lagringsplats till en wiki.

Wiki-fil- och mappstruktur

Git-lagringsplatser för teamprojektprojekt tilldelas följande etiketter.

  • Wiki-lagringsplats för ett teamprojekt: ProjectName.wiki
  • Huvudgren: wikiMain

Hantera din wiki-lagringsplats på samma sätt som du hanterar andra Git-lagringsplatser genom att definiera grenprinciper på wikiMain-grenen. Men du kan göra ändringar i din lokala wikiMain-gren och skicka dem direkt till fjärrgrenen utan att definiera några principer.

Wiki-lagringsplatsen har följande filer och mappar:

  • Fil för varje Markdown-sida som anges på rotnivå
  • Fil som är .order märkt i roten och under varje mapp
  • Mapp för varje sida som har undersidor
  • .attachments mapp, lagra alla bifogade filer i wikin

Namngivningskonventioner för filer

Varje fil kräver att du använder bindestreck i stället för blanksteg i sidrubriken. Sidrubriken Så här bidrar du till exempel med How-to-contribute.md filnamnet. Sidnamnet läggs till i URL:en, vilket säkerställer att länkarna du delar förblir intakta när wikin ändras över tid.

Varje wiki-sida motsvarar en fil i Git-lagringsplatsen för wikin. Namn som du tilldelar en wiki-sidrubrik måste överensstämma med följande begränsningar.

Begränsningstyp Begränsning
Filnamn Den fullständigt kvalificerade sidsökvägen får vara högst 235 tecken lång.
Unikhet Sidrubriker är skiftlägeskänsliga och måste vara unika i wiki-hierarkin.
Specialtecken – Får inte innehålla Unicode-kontrolltecken eller surrogattecken.
– Får inte innehålla följande utskrivbara tecken: / \ #.
– Får inte starta eller avsluta med en punkt ..
Filstorlek Får inte överskrida maxgränsen på 18 MB.
Storlek på bifogad fil Får inte överskrida 19 MB.

Specialtecken i Wiki-sidrubriker

Du kan ange sidrubriker som innehåller ett eller flera av dessa specialtecken : < > * ? | -. Du kan till exempel ge en Markdown-fil namnet "Faq?" eller "Set-up guide". Tecknen har följande URI-kodade strängar:

Tecken Kodad sträng
: %3A
< %3C
> %3E
* %2A
? %3F
| %7C
- %2D
" 22 %

.order-fil

. order-filen definierar sekvensen med sidor i wikin. Följande visuella objekt visar ett exempel på en wiki-toc och motsvarande .order-fil.

Wiki TOC .order-fil
Skärmbild av wiki TOC-exempel. Skärmbild av Wiki-exempelordningsfilen.

Standardhierarkin är i alfabetisk ordning, men du kan ändra den här hierarkin i .order-filen . Mer information om hur du ordnar om wiki-sidor finns i Lägga till och redigera wiki-sidor, Ändra ordning på en wiki-sida.

Ta bort .order-filen för att återgå till alfabetisk sortering

När det inte finns någon .order-fil sorteras sidorna alfabetiskt. Gör följande för att återgå till alfabetisk sortering:

  1. Kopiera klonings-URL:en för wikin och öppna den i en webbläsare. När du gör det öppnas Git-lagringsplatsen (filhubben), som stöder wikin.
  2. Gå till .order-filen och ta bort den. Filen skapas automatiskt (på nytt) efter borttagningen, till exempel i en dra och släpp-åtgärd i en artikel.