Sdílet prostřednictvím

Struktura souborů a složek wikiwebu v Gitu

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

Tento článek popisuje strukturu souborů a složek pro zřízené wikiweby a wikiweby publikované jako kód. U obou typů wikiwebu jsou soubory uložené v úložišti Git. Soubory můžou zahrnovat stránky Markdownu, kód, obrázky, přílohy nebo jiné artefakty. Aby git vytvořil posloupnost prezentací souborů, přidá do každé složky úložiště speciální soubor (.order).

Když vytvoříte projekt, wikiweb se ve výchozím nastavení nevytvoří. Můžete zřídit wikiweb, vytvořit soubor README nebo publikovat kód projektu jako wikiweb.

Wikiweb vytvoříte pomocí uživatelského rozhraní Azure DevOps. Pak můžete upravit wiki z cesty URL úložiště Git.

Soubory úložiště a struktura složek

Úložiště Git pro wiki má dvě zásady vytváření názvů:

  • Název úložiště wiki je <ProjectName>.wiki, kde <ProjectName> je název vašeho projektu.
  • Název kořenové větve pro úložiště wikiwebu je wikiMain.

Úložiště wikiwebu spravujete stejným způsobem jako ostatní úložiště Git definováním zásad větví ve wikiMain větvi. Můžete také provádět změny místní wikiMain větve a odesílat je přímo do vzdálené větve bez definování zásad.

Úložiště wikiwebu se skládá z následujících souborů a složek:

  • Soubor pro každou stránku Markdownu umístěnou na kořenové úrovni
  • Soubor s názvem .order umístěný na kořenové úrovni a také v každé podsložce
  • Podsložka pro každou stránku wikiwebu, která obsahuje podstránky
  • Složka s názvem .attachments pro uložení všech příloh použitých na wikiwebu

Zásady vytváření názvů souborů

Název souboru pro každou stránku wikiwebu odpovídá názvu stránky wikiwebu. V názvu souboru představuje pomlčka (-) mezeru v názvu stránky. Například název stránky "Jak přispívat" odpovídá názvu souboru How-to-contribute.md. Cesta URL ke stránce wikiwebu obsahuje název souboru. Například: https://github.com/ExampleWiki/How-To/How-to-contribute.md. Tento přístup pomáhá zajistit, aby odkazy na záložky na stránku zůstaly nedotčené, protože wikiweb se v průběhu času mění.

Každá stránka wikiwebu odpovídá souboru v úložišti Git wikiwebu. Následující omezení platí pro názvy stránkových souborů a velikost souboru:

  • Název souboru: Při výběru názvu stránkového souboru mějte na paměti, že plně kvalifikovaná cesta k souboru by měla mít maximálně 235 znaků. Úplná cesta ke stránce se skládá z adresy URL úložiště, cesty ke složce k souboru stránky a názvu souboru stránky. Například: https://github.com/ExampleWiki/Contributors/Code/How-to-add-code-to-the-project.md.

  • Jedinečnost: Název stránkového souboru musí být jedinečný v rámci umístění složky v hierarchii úložiště wikiwebu. V názvu se rozlišují malá a velká písmena.

  • Speciální znaky: Název stránkového souboru má omezení týkající se následujících speciálních znaků:

    • Žádné znaky ovládacího prvku Unicode ani náhradní znaky
    • Žádné tisknutelné znaky: lomítko/, zpětné lomítko\, hash#
    • Na začátku nebo na konci názvu není žádný symbol tečky . .

  • Velikost souboru: Maximální velikost stránkového souboru je 18 MB.

  • Velikost souboru přílohy: Maximální velikost pro každou přílohu stránkového souboru je 19 MB.

Povolené speciální znaky

V názvu stránkového souboru je povoleno několik speciálních znaků, například dvojtečka : a spojovník -. Soubor Markdownu můžete například pojmenovat jako FAQ:0525 nebo Průvodce nastavením.

Důležité

Abyste se vyhnuli chybám v syntaxi stránky a navigaci v prohlížeči, nepoužívejte znak mezery ( ) v názvech stránkových souborů. Pokud pojmenujete soubory stránek na základě názvu stránky, nahraďte všechny mezery v názvu stránky pomlčkou (-) v názvu souboru.

Následující tabulka uvádí speciální znaky povolené v názvech souborů wikistránek a odpovídající řetězec kódovaný identifikátorem URI:

Znak Symbol Řetězec URI
Tračník : %3A
Levý úhlová závorka < %3C
Pravý úhlový závorka > %3E
Hvězdička (zástupný znak) * %2A
Otazník ? %3F
potrubí | %7C
Spojovník (pomlčka) - %2D
Dvojitá uvozovka " 22 %

Například název souboru FAQ:0525 je kódován jako FAQ%3A0525.

Sekvence stránek a soubor .order

Soubor .order definuje pořadí stránek wikiwebu. Git vyhledá tento soubor v každé složce, aby identifikoval posloupnost pro prezentaci souborů v daném umístění. Výchozí pořadí stránek je abecední pořadí (A až Z) podle názvu souboru.

Definování vlastní sekvence stránek

Pokud složka nemá soubor .order , Git použije výchozí abecední sekvenci.

Vlastní sekvenci můžete definovat pro libovolnou složku aktualizací souboru .order ve složce, včetně na kořenové úrovni.

Následující obrázek ukazuje příklad obsahu wiki a odpovídajícího souboru .order, který vytvoří tento obsah.

Obsah wiki se zobrazí ve webovém prohlížeči.

Snímek obrazovky obsahu wikiwebu s rozbalenými několika složkami pro zobrazení podsložek

Soubor .order určuje pořadí stránek v obsahu TOC

Snímek obrazovky s wiki složkou a seznamem souborů v úložišti Git. Soubor .order je otevřen a zobrazuje definici pořadí stránek obsahu TOC.

Soubor .order změní sekvenci z abecedy na Marketing následovaný textem Fabrikam Fiber.

Další informace o tom, jak změnit pořadí stránek wikiwebu, naleznete v tématu Přidání, úprava a změna pořadí stránek wikiwebu.

Obnovení abecedního pořadí

Pokud má složka vlastní sekvenci, můžete metodu řazení vrátit podle abecedy pomocí následujícího postupu:

  1. Zkopírujte adresu URL klonu wikiwebu a otevřete ji v prohlížeči. Otevře se úložiště Git pro wikiweb.

  2. Přejděte do souboru .order , který chcete vrátit a odstranit. Po odstranění souboru git automaticky vytvoří nový soubor .order pro dané umístění. Nový soubor používá výchozí sekvenci.

Související obsah