Dela via

Wiki-fil- och mappstruktur i Git

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

I den här artikeln beskrivs fil- och mappstrukturen för etablerade wikis och wikis som publicerats som kod. För båda typerna av wiki lagras filerna på en Git-lagringsplats. Filer kan innehålla Markdown-sidor, kod, bilder, bifogade filer eller andra artefakter. För att upprätta presentationssekvensen för filerna lägger Git till en särskild fil (.order) i varje lagringsplatsmapp.

När du skapar ett projekt skapas inte en wiki som standard. Du kan etablera en wiki, skapa en README eller publicera projektkod som en wiki.

Du skapar din wiki med hjälp av Azure DevOps-användargränssnittet. Sedan kan du redigera wikin från url-sökvägen till git-lagringsplatsen.

Lagringsplatsfiler och mappstruktur

Git-lagringsplatsen för en wiki har två namngivningskonventioner:

  • Namnet på wiki-lagringsplatsen är <ProjectName>.wiki där <ProjectName> är namnet på projektet.
  • Namnet på rotgrenen för wiki-lagringsplatsen är wikiMain.

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

En wiki-lagringsplats består av följande filer och mappar:

  • En fil för varje Markdown-sida som finns på rotnivå
  • En fil med namnet .order som finns på rotnivå och även inom varje undermapp
  • En undermapp för varje wiki-sida som har undersidor
  • En mapp med namnet .attachments för att lagra alla bifogade filer som används i wikin

Namngivningskonventioner för filer

Filnamnet för varje wiki-sida motsvarar wiki-sidrubriken. I filnamnet representerar ett bindestreck (-) ett mellanrum i sidtiteln. Sidrubriken "How to contribute" motsvarar till exempel filnamnet How-to-contribute.md. URL-sökvägen till wiki-sidan innehåller filnamnet. Till exempel https://github.com/ExampleWiki/How-To/How-to-contribute.md. Den här metoden hjälper till att se till att bokmärkeslänkarna till sidan förblir intakta när wikin ändras över tid.

Varje wiki-sida motsvarar en fil på Wiki Git-lagringsplatsen. Följande begränsningar gäller för sidfilnamn och filstorlek:

  • Filnamn: När du väljer ett namn på sidfilen bör du tänka på att den fullständigt kvalificerade sökvägen till filen ska vara högst 235 tecken. Den fullständiga sökvägen till sidan består av lagringsplatsens URL, mappsökvägen till sidfilen och sidfilens namn. Till exempel https://github.com/ExampleWiki/Contributors/Code/How-to-add-code-to-the-project.md.

  • Unikhet: Sidfilens namn måste vara unikt inom dess mappplats i wiki-lagringsplatsens hierarki. Namnet är skiftlägeskänsligt.

  • Specialtecken: Sidfilens namn har begränsningar för följande specialtecken:

    • Inga Unicode-kontrolltecken eller surrogattecken
    • Inga utskrivbara tecken: snedstreck/, bakstreck\, hashtag#
    • Ingen punktsymbol . i början eller slutet av namnet

  • Filstorlek: Den maximala sidfilstorleken är 18 MB.

  • Filstorlek för bifogade filer: Den maximala storleken för alla bifogade filer till en sidfil är 19 MB.

Tillåtna specialtecken

Flera specialtecken tillåts i ett sidfilnamn, till exempel kolon : och bindestreck -. Du kan till exempel namnge en Markdown-fil som faq:0525 eller installationsguide.

Viktigt!

Om du vill undvika fel i sidsyntaxen och webbläsarnavigering ska du inte använda blankstegstecknet ( ) i sidfilnamnen. Om du namnger dina sidfiler baserat på sidrubriken ersätter du alla blanksteg i sidrubriken med ett bindestreck (-) i filnamnet.

I följande tabell visas de specialtecken som tillåts i wiki-sidfilnamn och motsvarande URI-kodade sträng:

Karaktär Symbol URI-sträng
Kolon : %3A
Vänster vinkelparentes < %3C
Höger vinkelparentes > %3E
Asterisk (jokertecken) * %2A
Frågetecken ? %3F
Rör | %7C
Bindestreck (bindestreck) - %2D
Dubbelt citat " 22 %

Till exempel kodas filnamnet FAQ:0525 som FAQ%3A0525.

Sidsekvens och .order-filen

.order-filen definierar wiki-sidsekvensen. Git söker efter den här filen i varje mapp för att identifiera sekvensen för att presentera filer på den platsen. Standardsidans sekvens är alfabetisk ordning (A till Z) efter filnamn.

Definiera anpassad sidsekvens

När en mapp inte har någon .order-fil använder Git den alfabetiska standardsekvensen.

Du kan definiera en anpassad sekvens för valfri mapp genom att uppdatera .order-filen i mappen, inklusive på rotnivå.

Följande visuella objekt visar ett exempel på en wiki-innehållsförteckning (TOC) och motsvarande .order-fil som skapar innehållsförteckningen.

Wiki TOC visas i webbläsaren

Skärmbild av TOC för en wiki med flera mappar utökade för att visa undermappar.

.order-filen definierar TOC-sidsekvensen

Skärmbild av en wiki-mapp och fillista på en Git-lagringsplats. .order-filen är öppen och visar definitionen för TOC-sidsekvensen.

.order-filen ändrar sekvensen från alfabetisk till "Marknadsföring" följt av "Fabrikam Fiber".

Mer information om hur du ordnar om wiki-sidor finns i Lägga till, redigera och ordna om wiki-sidor.

Återställa alfabetisk sekvens

Om en mapp har en anpassad sekvens kan du återställa sorteringsmetoden till alfabetisk genom att följa dessa steg:

  1. Kopiera klonings-URL:en för wikin och öppna den i en webbläsare. Git-lagringsplatsen för wikin öppnas.

  2. Gå till den .order-fil som du vill återställa och ta bort filen. När filen har tagits bort skapar Git automatiskt en ny .order-fil för den platsen. Den nya filen använder standardsekvensen.

Relaterat innehåll