Share via

Wikifájlok és fájlstruktúra

  • Cikk

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

Ismerje meg a projekt wikiinek és kód wikiinek fájljait és fájlstruktúráját. Az alábbi útmutató kód wikiket adhat meg, de mindkét wikitípusra vonatkozik.

Csapatprojekt létrehozásakor a rendszer alapértelmezés szerint nem hoz létre wikit. További információ: Wiki létrehozása, README létrehozása vagy kiépített wikik és közzétett kód wikiként.

Minden kód wikit egy Git-adattár működtet a háttérrendszerben. Ez az adattár tárolja a Markdown-oldalakat, képeket, mellékleteket, valamint a lapok és allapok sorozatát. A wikit az Azure DevOps felhasználói felületén hozhatja létre, majd a Git-adattár URL-címének elérési útján szerkesztheti a wikit. További információ a kód wikik közzétételéről: Git-adattár közzététele wikikben.

Wikifájl- és mappastruktúra

A csapatprojekt wiki Git-adattárai a következő címkéket kapják.

  • Csapatprojekt wiki-adattára: ProjectName.wiki
  • Főág: wikiMain

A wiki-adattár ugyanúgy kezelhető, mint bármely más Git-adattár, a wikiMain ág ág ágszabályzatainak definiálásával. Módosíthatja azonban a helyi wikiMain ágat, és közvetlenül a távoli ágba küldheti őket anélkül, hogy szabályzatokat határoz meg.

A wikiadattár a következő fájlokat és mappákat tartalmazza:

  • A gyökérszinten megadott minden Markdown-oldal fájlja
  • A gyökérkönyvtárban és az egyes mappák alatt címkézett .order fájl
  • Mappa minden olyan laphoz, amely allapokkal rendelkezik
  • .attachments mappában tárolja a wiki összes mellékletét

Fájlelnevezési konvenciók

Minden fájlhoz kötőjeleket kell használni szóközök helyett a lap címében. A Közreműködő lap címe például a How-to-contribute.md fájlnévnek felel meg. A rendszer hozzáadja a lap nevét az URL-címhez, így biztosítva, hogy a megosztott hivatkozások érintetlenek maradjanak, ahogy a wiki idővel változik.

Minden wikilap egy-egy fájlnak felel meg a wiki Git-adattárában. A wikilapokhoz rendelt neveknek az alábbi korlátozásoknak kell megfelelniük.

Korlátozás típusa Korlátozás
Fájlnév A teljes lapútvonal nem haladhatja meg a 235 karakter hosszúságot.
Egyediség A lapcímek megkülönböztetik a kis- és nagybetűket, és egyedinek kell lenniük a wikihierarchiában.
Speciális karakterek – Nem használhatók Unicode-vezérlőkarakterek vagy helyettesítő karakterek.
- Nem tartalmazhat a következő nyomtatható karaktereket: / \ #.
- Nem kezdődhet és nem végződhet ponttal ..
Fájlméret Nem lépheti túl a 18 MB-os maximális méretet.
Mellékletfájl mérete Nem lépheti túl a 19 MB-os maximális méretet.

Speciális karakterek a Wikilap címeiben

Megadhatja azokat a lapcímeket, amelyek egy vagy több speciális karaktert : < > * ? | -tartalmaznak. A Markdown-fájlokat például "GYIK" vagy "Beállítási útmutató" néven is elnevezheti. A karakterek a következő URI-kódolt sztringekkel rendelkeznek:

Karakter Kódolt sztring
: %3A
< %3C
> %3E
* %2A
? %3F
| %7C
- %2D
" 22%

.order fájl

A .order fájl határozza meg a wikin belüli oldalak sorrendjét. Az alábbi vizualizáció egy wiki TOC-ra és annak megfelelő .order fájlra mutat példát.

Wiki TOC .order fájl
Képernyőkép a wiki TOC-példáról. Képernyőkép a Wiki-példarendelési fájlról.

Az alapértelmezett hierarchia betűrendben van, de ezt a hierarchiát módosíthatja a .order fájlban. További információ a wikilapok átrendezéséről: Wikilapok hozzáadása és szerkesztése, wikilapok átrendezése.

A .order fájl törlése a betűrendes rendezésre való visszaállításhoz

Ha nincs .order fájl, a lapok betűrendbe vannak rendezve. Ha vissza szeretne térni az ábécérendezésre, hajtsa végre a következő lépéseket:

  1. Másolja ki a wiki klónozási URL-címét, és nyissa meg egy böngészőben. Ezzel megnyitja a Wikit háttérként szolgáló Git-adattárat (files hub).
  2. Lépjen a .order fájlra, és törölje azt. A fájl automatikusan (újra)jön létre a törlés után, például egy cikk húzási műveletében.