Fichiers Wiki et structure de fichiers

  • Article

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

Découvrez les fichiers et la structure de fichiers pour les wikis de projet et les wikis de code. Les instructions suivantes peuvent spécifier des wikis de code, mais elles s’appliquent aux deux types de wiki.

Lorsque vous créez un projet d’équipe, un wiki n’est pas créé par défaut. Pour plus d’informations, consultez Créer un wiki, créer un fichier README ou provisionner des wikis par rapport au code publié en tant que wiki.

Chaque wiki de code est alimenté par un dépôt Git dans le back-end. Ce référentiel stocke les pages Markdown, les images, les pièces jointes et la séquence de pages et de sous-pages. Vous créez votre wiki via l’interface utilisateur Azure DevOps, puis vous pouvez modifier le wiki via le chemin d’URL de votre dépôt Git. Pour plus d’informations sur la publication de wikis de code, consultez Publier un dépôt Git sur un wiki.

Structure de fichiers et de dossiers Wiki

Les étiquettes suivantes sont attribuées aux référentiels Git du projet d’équipe wiki.

  • Référentiel Wiki pour un projet d’équipe : ProjectName.wiki
  • Branche principale : wikiMain

Gérez votre dépôt wiki de la même façon que vous gérez n’importe quel autre dépôt Git, en définissant des stratégies de branche sur la branche wikiMain. Toutefois, vous pouvez apporter des modifications à votre branche wikiMain locale et les envoyer directement à la branche distante sans définir de stratégies.

Le dépôt wiki contient les fichiers et dossiers suivants :

  • Fichier pour chaque page Markdown entrée au niveau racine
  • Fichier étiqueté .order à la racine et sous chaque dossier
  • Dossier pour chaque page qui a des sous-pages
  • .attachments dossier, stockage de toutes les pièces jointes du wiki

Conventions de nommage de fichiers

Chaque fichier nécessite l’utilisation de traits d’union au lieu d’espaces dans le titre de la page. Par exemple, le titre de la page Comment contribuer correspond au nom de How-to-contribute.md fichier. Le nom de la page est ajouté à l’URL, ce qui garantit que les liens que vous partagez restent intacts à mesure que le wiki change au fil du temps.

Chaque page wiki correspond à un fichier dans le dépôt Git wiki. Les noms que vous affectez au titre d’une page wiki doivent être conformes aux restrictions suivantes.

Type de restriction Restriction
Nom de fichier Le chemin complet de la page ne doit pas dépasser 235 caractères.
Unicité Les titres de page respectent la casse et doivent être uniques au sein de la hiérarchie du wiki.
Caractères spéciaux - Ne doit pas contenir de caractères de contrôle Unicode ou de caractères de substitution.
- Ne doit pas contenir les caractères imprimables suivants : / \ #.
- Ne doit pas commencer ou se terminer par un point ..
Taille du fichier Ne doit pas dépasser le maximum de 18 Mo.
Taille du fichier de pièce jointe Ne doit pas dépasser le maximum de 19 Mo.

Caractères spéciaux dans les titres des pages Wiki

Vous pouvez spécifier des titres de page qui contiennent un ou plusieurs de ces caractères : < > * ? | -spéciaux . Par exemple, vous pouvez nommer un fichier Markdown « FAQ » ou « Guide de configuration ». Les caractères ont les chaînes encodées d’URI suivantes :

Caractère Chaîne encodée
: %3A
< %3C
> %3E
* %2A
? %3F
| %7C
- %2D
" %22

Fichier .order

Le fichier .order définit la séquence de pages dans le wiki. Le visuel suivant montre un exemple de table des matières wiki et son fichier .order correspondant.

Wiki TOC Fichier .order
Capture d’écran de l’exemple de code des matières wiki. Capture d’écran du fichier d’ordre d’exemple Wiki.

La hiérarchie par défaut est en ordre alphabétique, mais vous pouvez modifier cette hiérarchie dans le fichier .order . Pour plus d’informations sur la réorganisation des pages wiki, consultez Ajouter et modifier des pages wiki, Réorganiser une page wiki.

Supprimer le fichier .order pour revenir au tri alphabétique

Lorsqu’il n’y a pas de fichier .order , les pages sont triées par ordre alphabétique. Pour revenir au tri alphabétique, procédez comme suit :

  1. Copiez l’URL de clone pour le wiki et ouvrez-la dans un navigateur. Cela ouvre le dépôt Git (hub de fichiers), qui sauvegarde le wiki.
  2. Accédez au fichier .order et supprimez-le. Le fichier obtient automatiquement (re)créé après la suppression, par exemple, dans une action glisser-déplacer sur un article.