Arquivos wiki e estrutura de arquivos

  • Artigo

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

Saiba mais sobre os arquivos e a estrutura de arquivos para wikis de projeto e wikis de código. A orientação a seguir pode especificar wikis de código, mas se aplica a ambos os tipos de wiki.

Quando você cria um projeto de equipe, um wiki não é criado por padrão. Para obter mais informações, consulte Criar um wiki, Criar um LEIA-ME ou Wikis provisionados versus código publicado como um wiki.

Cada wiki de código é alimentado por um repositório Git no back-end. Esse repositório armazena as páginas markdown, imagens, anexos e a sequência de páginas e subpáginas. Você cria seu wiki por meio da interface do usuário do Azure DevOps e, em seguida, pode editar o wiki por meio do caminho da URL do repositório Git. Para obter mais informações sobre como publicar wikis de código, consulte Publicar um repositório Git em um wiki.

Estrutura de arquivos e pastas do Wiki

Os repositórios Git wiki do projeto de equipe recebem os seguintes rótulos.

  • Repositório Wiki para um projeto de equipe: ProjectName.wiki
  • Filial principal: wikiMain

Gerencie seu repositório wiki da mesma forma que você gerencia qualquer outro repositório Git, definindo políticas de ramificação na ramificação wikiMain. Mas, você pode fazer alterações em sua ramificação wikiMain local e enviá-las diretamente para a ramificação remota sem definir nenhuma política.

O repositório wiki tem os seguintes arquivos e pastas:

  • Arquivo para cada página markdown inserida no nível raiz
  • Arquivo rotulado .order na raiz e em cada pasta
  • Pasta para cada página que tem subpáginas
  • .attachments pasta, armazenando todos os anexos do wiki

Convenções de nomenclatura de arquivo

Cada arquivo requer o uso de hifens em vez de espaços no título da página. Por exemplo, o título da página Como contribuir corresponde ao nome do How-to-contribute.md arquivo. O nome da página é adicionado à URL, garantindo que os links compartilhados permaneçam intactos conforme o wiki é alterado ao longo do tempo.

Cada página wiki corresponde a um arquivo no repositório Git wiki. Os nomes atribuídos a um título de página wiki devem estar em conformidade com as restrições a seguir.

Tipo de restrição Restrição
Nome do arquivo O caminho de página totalmente qualificado não deve exceder 235 caracteres.
Exclusividade Os títulos de página diferenciam maiúsculas de minúsculas e devem ser exclusivos dentro da hierarquia wiki.
Caracteres especiais – Não deve conter caracteres de controle Unicode ou caracteres alternativos.
- Não deve conter os seguintes caracteres imprimíveis: / \ #.
- Não deve iniciar ou terminar com um período ..
Tamanho do arquivo – Não deve exceder o máximo de 18 MB.
– ‏Tamanho do arquivo de anexo Não deve exceder o máximo de 19 MB.

Caracteres especiais em títulos de página wiki

Você pode especificar títulos de página que contêm um ou mais desses caracteres : < > * ? | -especiais. Por exemplo, você pode nomear um arquivo Markdown como "Perguntas frequentes?" ou "Guia de configuração". Os caracteres têm as seguintes cadeias de caracteres codificadas em URI:

Caractere Cadeia de caracteres codificada
: %3A
< %3C
> %3E
* %2A
? %3F
| %7C
- %2D
" %22

Arquivo .order

O arquivo .order define a sequência de páginas dentro do wiki. O visual a seguir mostra um exemplo de um TOC wiki e seu arquivo .order correspondente.

Wiki TOC Arquivo .order
Captura de tela do exemplo de WIKI TOC. Captura de tela do arquivo de ordem de exemplo Wiki.

A hierarquia padrão está em sequência alfabética, no entanto, você pode alterar essa hierarquia no arquivo .order . Para obter mais informações sobre como reordenar páginas wiki, consulte Adicionar e editar páginas wiki, Reordenar uma página wiki.

Excluir o arquivo .order para reverter para classificação alfabética

Quando não há nenhum arquivo .order , as páginas são classificadas em ordem alfabética. Para reverter à classificação alfabética, execute as seguintes etapas:

  1. Copie a URL do clone para o wiki e abra-a em um navegador. Isso abre o repositório Git (hub de arquivos), que apoia o wiki.
  2. Vá para o arquivo .order e exclua-o. O arquivo é automaticamente (re)criado após a exclusão, por exemplo, em uma ação de arrastar e soltar em um artigo.