Observação
O acesso a essa página exige autorização. Você pode tentar entrar ou alterar diretórios.
O acesso a essa página exige autorização. Você pode tentar alterar os diretórios.
Azure DevOps Services | Azure DevOps Server 2022 – Azure DevOps Server 2019
Este artigo descreve os arquivos e a estrutura de pastas para wikis provisionados e wikis publicados como código. Para ambos os tipos de wiki, os arquivos são armazenados em um repositório Git. Os arquivos podem incluir páginas markdown, código, imagens, anexos ou outros artefatos. Para estabelecer a sequência de apresentação dos arquivos, o Git adiciona um arquivo especial (.order) em cada pasta de repositório.
Quando você cria um projeto, um wiki não é criado por padrão. Você pode provisionar um wiki, criar um README ou publicar o código do projeto como um wiki.
Crie seu wiki usando a interface do usuário do Azure DevOps. Em seguida, você pode editar o wiki a partir da URL do caminho do repositório Git.
Arquivos de repositório e estrutura de pastas
O repositório Git para um wiki tem duas convenções de nomenclatura:
- O nome do repositório wiki é
<ProjectName>.wikionde<ProjectName>está o nome do seu projeto. - O nome do branch raiz do repositório wiki é
wikiMain.
Você gerencia um repositório wiki da mesma forma que gerencia outros repositórios Git definindo políticas de branch no wikiMain branch. Você também pode fazer alterações no branch local wikiMain e efetuar push delas diretamente para o branch remoto sem definir nenhuma política.
Um repositório wiki consiste nos seguintes arquivos e pastas:
- Um arquivo para cada página markdown localizada no nível raiz
- Um arquivo chamado .order localizado no nível raiz e também dentro de cada subpasta
- Uma subpasta para cada página wiki que tem subpáginas
- Uma pasta chamada .attachments para armazenar todos os anexos usados no wiki
Convenções de nomenclatura de arquivo
O nome do arquivo para cada página wiki corresponde ao título da página wiki. No nome do arquivo, um hífen (-) representa um espaço no título da página. Por exemplo, o título da página "Como contribuir" corresponde ao nome do arquivo How-to-contribute.md. O caminho da URL para a página wiki inclui o nome do arquivo. Por exemplo, https://github.com/ExampleWiki/How-To/How-to-contribute.md. Essa abordagem ajuda a garantir que os links de favoritos para a página permaneçam intactos à medida que o wiki muda ao longo do tempo.
Cada página wiki corresponde a um arquivo no repositório Git wiki. As seguintes restrições se aplicam aos nomes de arquivo de página e ao tamanho do arquivo:
Nome do arquivo: ao escolher um nome para o arquivo de página, tenha em mente que o caminho totalmente qualificado para o arquivo deve ter 235 caracteres ou menos. O caminho completo para a página consiste na URL do repositório, no caminho da pasta para o arquivo de página e no nome do arquivo de página. Por exemplo,
https://github.com/ExampleWiki/Contributors/Code/How-to-add-code-to-the-project.md.Exclusividade: o nome do arquivo de página deve ser exclusivo em seu local de pasta na hierarquia de repositório wiki. O nome diferencia maiúsculas de minúsculas.
Caracteres especiais: o nome do arquivo de página tem restrições sobre os seguintes caracteres especiais:
- Sem caracteres de controle Unicode ou caracteres alternativos
- Sem caracteres imprimíveis: barra
/para frente, barra traseira\, hash# - Nenhum símbolo de ponto
.no início ou no final do nome
Tamanho do arquivo: o tamanho máximo do arquivo de página é de 18 MB.
Tamanho do arquivo de anexo: o tamanho máximo de qualquer anexo a um arquivo de página é de 19 MB.
Caracteres especiais permitidos
Vários caracteres especiais são permitidos no nome de arquivo de uma página, como dois-pontos : e hífen -. Por exemplo, você pode nomear um arquivo Markdown como Perguntas Frequentes:0525 ou Guia de Instalação.
Importante
Para evitar erros na sintaxe da página e na navegação do navegador, não use o caractere de espaço ( ) em nomes de arquivo de página. Se você nomear seus arquivos de página com base no título da página, substitua todos os espaços no título da página por um hífen (-) no nome do arquivo.
A tabela a seguir lista os caracteres especiais permitidos em nomes de arquivo de página wiki e a cadeia de caracteres codificada em URI correspondente:
| Personagem | Símbolo | Cadeia de caracteres de URI |
|---|---|---|
| Cólon | : |
%3A |
| Colchete de ângulo esquerdo | < |
%3C |
| Colchete de ângulo reto | > |
%3E |
| Asterisco (curinga) | * |
%2A |
| Ponto de interrogação | ? |
%3F |
| Tubo | | |
%7C |
| Hífen (traço) | - |
%2D |
| Aspas duplas | " |
%22 |
Por exemplo, o nome do arquivo FAQ:0525 é codificado como FAQ%3A0525.
Sequência de páginas e o arquivo .order
O arquivo .order define a sequência de páginas wiki. O Git procura esse arquivo em cada pasta para identificar a sequência para apresentar arquivos nesse local. A sequência de páginas padrão é a ordem alfabética (A a Z) pelo nome do arquivo.
Definir sequência de páginas personalizada
Quando uma pasta não tem um arquivo .order , o Git usa a sequência alfabética padrão.
Você pode definir uma sequência personalizada para qualquer pasta atualizando o arquivo .order na pasta, inclusive no nível raiz.
O visual a seguir mostra um exemplo de um TOC (sumário wiki) e o arquivo .order correspondente que cria o TOC.
O WIKI TOC é exibido no navegador da Web
O arquivo .order define a sequência de páginas TOC
O arquivo .order altera a sequência de alfabético para "Marketing" seguido por "Fabrikam Fiber".
Para obter mais informações sobre como reordenar páginas wiki, consulte Adicionar, editar e reordenar páginas wiki.
Restaurar sequência alfabética
Se uma pasta tiver uma sequência personalizada, você poderá reverter o método de classificação para alfabético seguindo estas etapas:
Copie a URL do clone para o wiki e abra-a em um navegador. O repositório Git para o wiki é aberto.
Vá para o arquivo .order que você deseja reverter e excluir o arquivo. Depois que o arquivo é excluído, o Git cria automaticamente um novo arquivo .order para esse local. O novo arquivo usa a sequência padrão.