Condividi tramite


Struttura dei file e delle cartelle wiki in Git

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

Questo articolo descrive i file e la struttura di cartelle per wiki di cui è stato effettuato il provisioning e i wiki pubblicati come codice. Per entrambi i tipi di wiki, i file vengono archiviati in un repository Git. I file possono includere pagine Markdown, codice, immagini, allegati o altri artefatti. Per stabilire la sequenza di presentazione dei file, Git aggiunge un file speciale (con estensione order) in ogni cartella del repository.

Quando si crea un progetto, un wiki non viene creato per impostazione predefinita. È possibile effettuare il provisioning di un wiki, creare un file README o pubblicare il codice del progetto come wiki.

È possibile creare il wiki usando l'interfaccia utente di Azure DevOps. Puoi quindi modificare il wiki dal percorso URL del repository Git.

File del repository e struttura di cartelle

Il repository Git per un wiki ha due convenzioni di denominazione:

  • Il nome del repository wiki è <ProjectName>.wiki dove <ProjectName> è il nome del progetto.
  • Il nome del ramo radice per il repository wiki è wikiMain.

È possibile gestire un repository wiki nello stesso modo in cui si gestiscono altri repository Git definendo i criteri dei rami nel wikiMain ramo. È anche possibile apportare modifiche al ramo locale wikiMain ed eseguirne il push direttamente nel ramo remoto senza definire alcun criterio.

Un repository wiki è costituito dai file e dalle cartelle seguenti:

  • Un file per ogni pagina Markdown che si trova a livello radice
  • Un file denominato .order si trova nella directory principale e anche all'interno di ogni sottocartella
  • Sottocartella per ogni pagina wiki con pagine secondarie
  • Cartella denominata .attachments per archiviare tutti gli allegati usati nel wiki

Convenzioni di denominazione dei file

Il nome del file per ogni pagina wiki corrisponde al titolo della pagina wiki. Nel nome del file un trattino (-) rappresenta uno spazio nel titolo della pagina. Ad esempio, il titolo della pagina "Come contribuire" corrisponde al nome file How-to-contribute.md. Il percorso URL della pagina wiki include il nome del file. Ad esempio: https://github.com/ExampleWiki/How-To/How-to-contribute.md. Questo approccio consente di garantire che i collegamenti ai segnalibri alla pagina rimangano intatti man mano che il wiki cambia nel tempo.

Ogni pagina wiki corrisponde a un file nel repository Git wiki. Le restrizioni seguenti si applicano ai nomi dei file di pagina e alle dimensioni del file:

  • ** Nome file: Quando si sceglie un nome per il file di pagina, tenere presente che il percorso completo del file deve essere di 235 caratteri o meno. Il percorso completo della pagina è costituito dall'URL del repository, dal percorso della cartella al file di pagina e dal nome del file di pagina. Ad esempio: https://github.com/ExampleWiki/Contributors/Code/How-to-add-code-to-the-project.md.

  • Univocità: il nome del file di pagina deve essere univoco all'interno del percorso della cartella nella gerarchia del repository wiki. Il nome è sensibile al maiuscole/minuscole.

  • Caratteri speciali: il nome del file di pagina presenta restrizioni sui caratteri speciali seguenti:

    • Nessun carattere di controllo Unicode o caratteri surrogati
    • Nessun carattere stampabile: barra diagonale /, barra rovesciata \, cancelletto #
    • Nessun simbolo punto . all'inizio o alla fine del nome
  • Dimensioni file: la dimensione massima del file di pagina è 18 MB.

  • Dimensioni file allegato: la dimensione massima per qualsiasi allegato a un file di pagina è 19 MB.

Caratteri speciali consentiti

In un nome file di pagina sono consentiti diversi caratteri speciali, come i due punti : e il trattino -. Ad esempio, è possibile assegnare un nome a un file Markdown come FAQ:0525 o Setup-Guide.

Importante

Per evitare errori nella sintassi della pagina e nello spostamento nel browser, non usare lo spazio ( ) nei nomi dei file di pagina. Se si assegna un nome ai file di pagina in base al titolo della pagina, sostituire gli spazi nel titolo della pagina con un trattino (-) nel nome del file.

Nella tabella seguente sono elencati i caratteri speciali consentiti nei nomi dei file di pagine wiki e nella stringa con codifica URI corrispondente:

Personaggio Simbolo Stringa URI
Colon : %3A
Parentesi angolare sinistra < %3C
Parentesi angolare destra > %3E
Asterisco (carattere jolly) * %2A
Punto interrogativo ? %3F
pipe | %7C
Trattino (lineetta) - %2D
Virgolette doppie " 22%

Ad esempio, il nome file FAQ:0525 viene codificato come FAQ%3A0525.

Sequenza di pagine e file .order

Il file .order definisce la sequenza delle pagine wiki. Git cerca questo file in ogni cartella per identificare la sequenza in cui presentare i file in tale percorso. La sequenza di pagina predefinita è l'ordine alfabetico (da A a Z) in base al nome file.

Definire una sequenza di pagine personalizzata

Quando una cartella non ha un file .order, Git usa la sequenza alfabetica predefinita.

È possibile definire una sequenza personalizzata per qualsiasi cartella aggiornando il file con estensione order nella cartella, incluso a livello radice.

L'oggetto visivo seguente mostra un esempio di sommario wiki (TOC) e del file con estensione order corrispondente che crea il sommario.

Wiki TOC viene visualizzato nel Web browser

Screenshot dell'indice per un wiki con diverse cartelle espanse per mostrare le sottocartelle.

Il file order definisce la sequenza di pagine dell'Indice

Screenshot di una cartella wiki e dell'elenco dei file in un repository Git. Il file .order è aperto e mostra la definizione per la sequenza di pagine del sommario.

Il file .order cambia la sequenza da alfabetica a "Marketing" seguito da "Fabrikam Fiber".

Per altre informazioni su come riordinare le pagine wiki, vedere Aggiungere, modificare e riordinare le pagine wiki.

Ripristina sequenza alfabetica

Se una cartella ha una sequenza personalizzata, è possibile ripristinare il metodo di ordinamento in ordine alfabetico seguendo questa procedura:

  1. Copiare l'URL clone per il wiki e aprirlo in un browser. Viene aperto il repository Git per il wiki.

  2. Vai al file .order che vuoi annullare ed eliminalo. Dopo l'eliminazione del file, Git crea automaticamente un nuovo file con estensione order per tale percorso. Il nuovo file usa la sequenza predefinita.