Wikifájl- és mappastruktúra a Gitben

Azure DevOps Services | Azure DevOps Server | Azure DevOps Server 2022

Ez a cikk a kódként közzétett kiépített wikik és wikik fájljait és mappastruktúráját ismerteti. Mindkét wikitípus esetében egy Git-adattár tárolja a fájlokat. A fájlok tartalmazhatnak Markdown-oldalakat, kódot, képeket, mellékleteket vagy egyéb összetevőket. A fájlok bemutatósorozatának létrehozásához a Git egy speciális fájlt (.order) ad hozzá az egyes adattármappákhoz.

Projekt létrehozásakor alapértelmezés szerint nem hoz létre wikit. Wikit építhet ki, README-t hozhat létre, vagy wikiként közzéteheti a projektkódot.

A wikit az Azure DevOps felhasználói felületén hozhatja létre. Ezután szerkesztheti a wikit a Git-adattár URL-címének elérési útján.

Adattárfájlok és mappastruktúra

A wiki Git-adattára két elnevezési konvencióval rendelkezik:

  • A wiki-adattár neve <ProjectName>.wiki, ahol a <ProjectName> a projekt neve.
  • A wiki-adattár gyökérágának neve.wikiMain

A wikiadattárat ugyanúgy kezelheti, mint a többi Git-adattárat az ág ágszabályzatainak wikiMain definiálásával. Módosíthatja a helyi wikiMain ágat is, és közvetlenül a távoli ágba küldheti őket szabályzatok definiálása nélkül.

A wiki-adattár a következő fájlokból és mappákból áll:

  • A gyökérszinten található minden Markdown-oldal fájlja
  • A gyökérszinten és az egyes almappákban található .order nevű fájl
  • Almappák minden olyan wikilaphoz, amely allapokat tartalmaz
  • A wikiben használt összes melléklet tárolására szolgáló .attachments nevű mappa

Fájlelnevezési konvenciók

Az egyes wikilapok fájlneve a wikilap címének felel meg. A fájlnévben a kötőjel (-) egy szóközt jelöl a lap címében. A lap címe például a "How to contribute" (Közreműködési útmutató) a How-to-contribute.md fájlnévnek felel meg. A wikilap URL-címe tartalmazza a fájl nevét. Például: https://github.com/ExampleWiki/How-To/How-to-contribute.md. Ez a módszer segít biztosítani, hogy a lapra mutató könyvjelzőhivatkozások érintetlenek maradjanak, ahogy a wiki idővel megváltozik.

Minden wikilap egy-egy fájlnak felel meg a Wiki Git-adattárban. A lapfájlnevekre és a fájlméretre az alábbi korlátozások vonatkoznak:

  • Fájlnév: Amikor kiválasztja a lapfájl nevét, ne feledje, hogy a fájl teljes elérési útja legfeljebb 235 karakter lehet. A lap teljes elérési útja az adattár URL-címéből, a lapfájl mappaútvonalából és a lapfájl nevéből áll. Például: https://github.com/ExampleWiki/Contributors/Code/How-to-add-code-to-the-project.md.

  • Egyediség: A lapfájl nevének egyedinek kell lennie a wiki-adattár hierarchiájában található mappahelyen belül. A név kis- és nagybetűérzékeny.

  • Speciális karakterek: A lapfájl nevének korlátozásai a következő speciális karakterekre vonatkoznak:

    • Nincs Unicode-vezérlőkarakterek vagy helyettesítő karakterek
    • Nincs nyomtatható karakter: perjel /, fordított perjel \, kivonat #
    • Nincs pont . szimbólum a név elején vagy végén

  • Fájlméret: A maximális oldalméret 18 MB.

  • Mellékletfájl mérete: Az oldalfájl mellékleteinek maximális mérete 19 MB.

Engedélyezett speciális karakterek

A lapfájl neve több speciális karaktert is tartalmazhat, például a kettőspontot : és a kötőjelet -. Egy Markdown-fájlt például gyik:0525-nek vagy beállítási útmutatónak is nevezhet.

Fontos

A lapszintaxis és a böngészőnavigáció hibáinak elkerülése érdekében ne használja a szóköz karaktert ( ) az oldalfájlnevekben. Ha a lapcím alapján adja meg a lap fájljait, cserélje le a lap címében lévő szóközöket a fájlnév kötőjelére (-).

Az alábbi táblázat a wikilap fájlneveiben engedélyezett speciális karaktereket és a megfelelő URI-kódolt sztringet sorolja fel:

Karakter Szimbólum URI-karakterlánc
Kettőspont : %3A
Bal háromszögletes zárójel < %3C
Szögletes zárójel > %3E
Csillagjel (helyettesítő karakter) * %2A
Kérdőjel ? %3F
cső | %7C
Kötőjel (kötőjel) - %2D
Dupla idézőjel " 22%

A GYIK:0525 fájlnév például a következőképpen van kódolva FAQ%3A0525: .

Oldalsorrend és a .order fájl

A .order fájl határozza meg a wikilapsorozatot. A Git minden mappában megkeresi ezt a fájlt, hogy azonosítsa azt a sorrendet, amely az adott helyen jeleníti meg a fájlokat. Az alapértelmezett oldalütemezés betűrend (A–Z) fájlnév szerint.

Fontos

Ha egy szülőmappa csak almappákat tartalmaz, és nincsenek saját fájljai, a wiki üresként jeleníti meg a szülőmappát , még akkor is, ha az almappák markdown-fájlokat tartalmaznak. A Markdown-fájlok almappákon belüli láthatóságának biztosítása érdekében mindig helyezzen el legalább egy fájlt (például egy .order fájlt vagy bármilyen más tartalmat tartalmazó fájlt) a szülőmappába.

|- parent-folder
|-- sub-folder1
|   |-- file1.md
|   |-- file2.md
|-- sub-folder2
|   |-- file3.md
|   |-- file4.md
|-- .order

Egyéni oldal sorrend meghatározása

Ha egy mappa nem rendelkezik .order fájllal, a Git az alapértelmezett betűrendes sorrendet használja.

Bármely mappához megadhat egyéni sorrendet a mappában lévő .order fájl frissítésével, beleértve a gyökérszintet is.

Az alábbi vizualizáció egy példa egy wiki tartalomjegyzékre (TOC) és a TOC-t létrehozó megfelelő .order fájlra.

A Wiki tartalomjegyzék megjelenik a webböngészőben

Képernyőkép egy wiki tartalomjegyzékéről, amelyen több mappa ki van bontva, hogy almappákat jelenítsen meg.

A .order fájl határozza meg a TOC-oldalütemezést

Képernyőkép egy Git-adattárban lévő wikimappáról és fájllistáról. A .order fájl meg van nyitva, és megjeleníti a TOC-oldalütemezés definícióját.

A .order fájl a sorrendet betűrendiről először "Marketing", majd "Fabrikam Fiber" értékre módosítja.

A wikilapok átrendezéséről további információt a Wikilapok hozzáadása, szerkesztése és átrendezése című témakörben talál.

Betűrendes sorrend visszaállítása

Ha egy mappa egyéni sorrendben van, az alábbi lépések végrehajtásával visszaállíthatja a rendezési módszert betűrendesre:

  1. Másolja ki a wiki klónozási URL-címét, és nyissa meg egy böngészőben. Megnyílik a wiki Git-adattára.

  2. Lépjen a visszaállítani kívánt .order fájlra, és törölje a fájlt. A fájl törlése után a Git automatikusan létrehoz egy új .order fájlt az adott helyhez. Az új fájl az alapértelmezett sorrendet használja.

Kapcsolódó tartalom

  • Last updated on