Share via

Wikibestanden en bestandsstructuur

  • Artikel

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

Meer informatie over de bestanden en bestandsstructuur voor projectwiki's en codewiki's. De volgende richtlijnen kunnen codewiki's opgeven, maar deze zijn van toepassing op beide typen wiki's.

Wanneer u een teamproject maakt, wordt er niet standaard een wiki gemaakt. Zie Een wiki maken, Een LEESMIJ maken of Ingerichte wiki's versus gepubliceerde code als wiki voor meer informatie.

Elke codewiki wordt mogelijk gemaakt door een Git-opslagplaats in de back-end. In deze opslagplaats worden de Markdown-pagina's, afbeeldingen, bijlagen en de volgorde van pagina's en subpagina's opgeslagen. U maakt uw wiki via de Azure DevOps-gebruikersinterface en vervolgens kunt u de wiki bewerken via het URL-pad van uw Git-opslagplaats. Zie Een Git-opslagplaats publiceren naar een wiki voor meer informatie over het publiceren van codewiki's.

Wikibestands- en mapstructuur

De Git-opslagplaatsen van het teamproject worden toegewezen aan de volgende labels.

  • Wiki-opslagplaats voor een teamproject: ProjectName.wiki
  • Hoofdbranch: wikiMain

Beheer uw wiki-opslagplaats op dezelfde manier als u andere Git-opslagplaatsen beheert door vertakkingsbeleidsregels op de wikiMain-vertakking te definiëren. U kunt echter wijzigingen aanbrengen in uw lokale wikiMain-vertakking en deze rechtstreeks naar de externe vertakking pushen zonder beleid te definiëren.

De wikiopslagplaats heeft de volgende bestanden en mappen:

  • Bestand voor elke Markdown-pagina die is ingevoerd op hoofdniveau
  • Bestand gelabeld .order in de hoofdmap en onder elke map
  • Map voor elke pagina met subpagina's
  • .attachments map, alle bijlagen van de wiki opslaan

Naamconventies voor bestanden

Voor elk bestand moeten afbreekstreepjes worden gebruikt in plaats van spaties in de paginatitel. De titel van de pagina Bijdragen komt bijvoorbeeld overeen met de How-to-contribute.md bestandsnaam. De paginanaam wordt toegevoegd aan de URL, zodat de koppelingen die u deelt intact blijven als de wiki na verloop van tijd verandert.

Elke wikipagina komt overeen met een bestand in de Git-opslagplaats van de wiki. Namen die u aan een wikipaginatitel toewijst, moeten voldoen aan de volgende beperkingen.

Beperkingstype Beperking
Bestandsnaam Het volledig gekwalificeerde paginapad mag niet langer zijn dan 235 tekens.
Uniciteit Paginatitels zijn hoofdlettergevoelig en moeten uniek zijn binnen de wiki-hiërarchie.
Speciale tekens - Mag geen Unicode-besturingstekens of surrogaattekens bevatten.
- Mag niet de volgende afdrukbare tekens bevatten: / \ #.
- Mag niet beginnen of eindigen met een punt ..
Bestandsgrootte Mag niet groter zijn dan 18 MB.
Bestandsnaam van bijlage Mag niet groter zijn dan 19 MB.

Speciale tekens in wikipaginatitels

U kunt paginatitels opgeven die een of meer van deze speciale tekens : < > * ? | -bevatten. U kunt bijvoorbeeld een Markdown-bestand een naam geven als 'Veelgestelde vragen?' of 'Handleiding instellen'. De tekens hebben de volgende gecodeerde URI-tekenreeksen:

Teken Gecodeerde tekenreeks
: %3A
< %3C
> %3E
* %2A
? %3F
| %7C
- %2D
" 22%

.orderbestand

Het .orderbestand definieert de volgorde van pagina's in de wiki. In de volgende visual ziet u een voorbeeld van een wiki-inhoudsopdracht en het bijbehorende .orderbestand.

Wiki-toc .orderbestand
Schermopname van het wiki-toc-voorbeeld. Schermopname van het wiki-voorbeeldvolgordebestand.

De standaardhiërarchie bevindt zich in alfabetische volgorde, maar u kunt deze hiërarchie wijzigen in het .orderbestand . Zie Wikipagina's toevoegen en bewerken, een wikipagina opnieuw ordenen voor meer informatie over het opnieuw ordenen van wikipagina's.

Het .orderbestand verwijderen om terug te keren naar alfabetische sortering

Wanneer er geen .orderbestand is, worden de pagina's alfabetisch gesorteerd. Voer de volgende stappen uit om terug te keren naar alfabetische sortering:

  1. Kopieer de kloon-URL voor de wiki en open deze in een browser. Hiermee opent u de Git-opslagplaats (bestandenhub), die de wiki back-ups maakt.
  2. Ga naar het .orderbestand en verwijder het. Het bestand wordt automatisch (opnieuw) gemaakt na verwijdering, bijvoorbeeld in een actie slepen en neerzetten in een artikel.