File wiki e struttura di file

  • Articolo

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

Informazioni sui file e sulla struttura di file per wiki del progetto e wiki di codice. Le indicazioni seguenti potrebbero specificare wiki di codice, ma si applicano a entrambi i tipi di wiki.

Quando si crea un progetto team, un wiki non viene creato per impostazione predefinita. Per altre informazioni, vedere Creare un wiki, Creare un file README o Wiki con provisioning e codice pubblicato come wiki.

Ogni wiki di codice è basato su un repository Git nel back-end. Questo repository archivia le pagine Markdown, le immagini, gli allegati e la sequenza di pagine e pagine secondarie. Il wiki viene creato tramite l'interfaccia utente di Azure DevOps e quindi è possibile modificare il wiki tramite il percorso DELL'URL del repository Git. Per altre informazioni sulla pubblicazione di wiki di codice, vedere Pubblicare un repository Git in un wiki.

Struttura di file wiki e cartelle

Ai repository Git wiki del progetto team vengono assegnate le etichette seguenti.

  • Repository wiki per un progetto team: ProjectName.wiki
  • Ramo principale: wikiMain

Gestire il repository wiki nello stesso modo in cui si gestisce qualsiasi altro repository Git, definendo i criteri dei rami nel ramo wikiMain. Tuttavia, è possibile apportare modifiche al ramo wikiMain locale ed eseguirne il push direttamente nel ramo remoto senza definire criteri.

Il repository wiki include i file e le cartelle seguenti:

  • File per ogni pagina Markdown immessa a livello radice
  • File etichettato .order nella radice e in ogni cartella
  • Cartella per ogni pagina con pagine secondarie
  • .attachments cartella, archiviazione di tutti gli allegati del wiki

Convenzioni di denominazione dei file

Ogni file richiede l'uso di trattini al posto di spazi nel titolo della pagina. Ad esempio, il titolo della pagina Come contribuire corrisponde al nome del How-to-contribute.md file. Il nome della pagina viene aggiunto all'URL, assicurando che i collegamenti condivisi rimangano inalterati man mano che il wiki cambia nel tempo.

Ogni pagina di wiki corrisponde a un file all'interno del repository Git di wiki. I nomi assegnati a un titolo di pagina di wiki devono essere conformi alle restrizioni seguenti.

Tipo di restrizione Restrizione
Nome file Il percorso completo della pagina non deve superare 235 caratteri.
Univocità I titoli delle pagine fanno distinzione tra maiuscole e minuscole e devono essere univoci all'interno della gerarchia di wiki.
Caratteri speciali - Non devono contenere caratteri di controllo Unicode o caratteri surrogati.
- Non deve contenere i caratteri stampabili seguenti: / \ #.
- Non deve iniziare o terminare con un punto ..
Dimensione del file Non deve superare il massimo di 18 MB.
Dimensione dei file allegati Non deve superare il massimo di 19 MB.

Caratteri speciali nei titoli delle pagine wiki

È possibile specificare i titoli di pagina che contengono uno o più di questi caratteri : < > * ? | -speciali. Ad esempio, è possibile denominare un file Markdown come "Domande frequenti?" o "Guida di configurazione". I caratteri hanno le stringhe con codifica URI seguenti:

Carattere Stringa codificata
: %3A
< %3C
> %3E
* %2A
? %3F
| %7C
- %2D
" 22%

File con estensione order

Il file con estensione order definisce la sequenza di pagine all'interno del wiki. L'oggetto visivo seguente mostra un esempio di sommario wiki ed è il file con estensione order corrispondente.

Sommario wiki File con estensione order
Screenshot dell'esempio del sommario wiki. Screenshot del file di ordine di esempio wiki.

La gerarchia predefinita è in sequenza alfabetica, ma è possibile modificare questa gerarchia nel file con estensione order . Per altre informazioni su come riordinare le pagine wiki, vedere Aggiungere e modificare pagine wiki, Riordinare una pagina wiki.

Eliminare il file con estensione order per ripristinare l'ordinamento alfabetico

Quando non è presente alcun file con estensione order , le pagine vengono ordinate alfabeticamente. Per ripristinare l'ordinamento alfabetico, seguire questa procedura:

  1. Copiare l'URL clone per il wiki e aprirlo in un browser. In questo modo si apre il repository Git (hub dei file), che esegue il backup del wiki.
  2. Passare al file con estensione order ed eliminarlo. Il file viene creato automaticamente (ri)creato dopo l'eliminazione, ad esempio in un'azione di trascinamento della selezione in un articolo.