Adicionar e editar páginas wiki

Serviços de DevOps do Azure | Azure DevOps Server 2022 - Azure DevOps Server 2019

Você pode adicionar um título e conteúdo a uma página, depois que o repositório Git wiki for provisionado para seu projeto de equipe. Há uma experiência de edição e visualização lado a lado, onde você pode editar a página e visualizar o conteúdo à medida que avança.

Ao criar páginas usando o formato Markdown, você também pode usar o painel de formato para formatação rich-text e inserção de imagens, anexos e links.

Ao editar a página, salve-a digitando Ctrl+S. Para salvar com uma mensagem de revisão personalizada, selecione ao lado de Salvar. Para obter mais atalhos, consulte Atalhos de teclado para gerenciar páginas wiki.

Ferramentas de linha de comando Wiki

Comandos	Description
az devops wiki show	Abrir um wiki
AZ DevOps Wiki Página Show	Obter o conteúdo de uma página ou abrir uma página
az devops wiki página criar	Adicionar uma nova página
Atualização da página wiki do AZ DevOps	Editar uma página
az devops página wiki excluir	Eliminar uma página

Nota

Para adicionar ou editar páginas a um wiki que você publicou a partir de um repositório Git, consulte Publicar um repositório Git em um wiki. Este artigo aborda como adicionar e editar páginas de um wiki que você provisionou para um projeto de equipe.

Pré-requisitos

• Você deve ter um wiki provisionado.
• Você deve ser um membro do projeto de equipe como um contribuidor para adicionar ou atualizar páginas wiki.
• Você deve ter o nível de acesso Básico para editar o wiki do projeto.

Abra o Wiki

Browser

Conecte-se ao seu projeto usando um navegador da Web suportado e escolha Wiki.

Se você precisar alternar seu projeto de equipe, escolha Azure DevOps para procurar todos os projetos de equipe e equipes.

CLI do Azure DevOps

Você pode visualizar e abrir uma página wiki definida para um projeto usando o az devops wiki show comando. Para começar, consulte Introdução à CLI do Azure DevOps.

az devops wiki show --wiki
                      [--open]
                      [--project]
                      [--subscription]

Parâmetros

• --wiki: Obrigatório. Nome ou ID da wiki.
• --open: Opcional. Abra a página wiki no seu navegador da web.
• --project -p: Opcional. Nome ou ID do projeto.
• --assinatura: Opcional. o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

Exemplo

Abra um wiki chamado 'myprojectwiki'.

az devops wiki show --wiki myprojectwiki --open

Ver uma página wiki

Para obter o conteúdo de uma página por meio da CLI do Azure DevOps, digite o az devops wiki show comando.

az devops wiki page show --path
                         --wiki
                         [--include-content]
                         [--open]
                         [--project]
                         [--subscription]
                         [--version]

Parâmetros

• --path: Obrigatório. Caminho da página wiki.
• --wiki: Obrigatório. Nome ou ID da wiki.
• --include-content: Opcional. Inclua o conteúdo da página.
• --open: Opcional. Abra a página wiki no seu navegador da web.
• --project -p: Opcional. Nome ou ID do projeto.
• --version -v: Opcional. Versão (ETag) da página wiki.

Exemplo

Obtenha o conteúdo da página wiki com o caminho 'my wiki' em um wiki chamado 'myprojectwiki'.

az devops wiki page show --path 'my wiki' --wiki 'myprojectwiki' --content "Hello World"

Adicionar uma página wiki

Browser

Para adicionar outra página, escolha Nova página. Ou, para adicionar uma subpágina, abra o menu de contexto de uma página existente e selecione Adicionar subpágina.

Especifique um título exclusivo de 235 caracteres ou menos. Os títulos das páginas diferenciam maiúsculas de minúsculas. Para outras restrições de título, consulte Arquivos de repositório Wiki Git e estrutura de arquivos, Convenções de nomenclatura de arquivos.

Você também pode usar atalhos de teclado para adicionar uma nova página pressionando n ou adicionar uma subpágina pressionando c. Para obter uma lista completa de atalhos de teclado, consulte Atalhos de teclado para gerenciar páginas wiki.

CLI do Azure DevOps

Para adicionar uma página wiki, digite o az devops wiki page create comando.

az devops wiki page create --path
                           --wiki
                           [--comment]
                           [--content]
                           [--encoding {ascii, utf-16be, utf-16le, utf-8}]
                           [--file-path]
                           [--project]
                           [--subscription]

Parâmetros

• --path: Obrigatório. Caminho da página wiki.
• --wiki: Obrigatório. Nome ou ID da wiki.
• --comment: Opcional. Comente na mensagem de confirmação da operação de adição de arquivo. Valor padrão: adicionada uma nova página usando a CLI do Azure DevOps.
• --conteúdo: Opcional. Conteúdo da página wiki. Ignorado se --file-path for especificado.
• --codificação: Opcional. Codificação do ficheiro. Usado com --file-path parâmetro. valores aceites: ascii, utf-16be, utf-16le, utf-8
• --file-path: Opcional. Caminho da entrada do arquivo se o conteúdo for especificado no arquivo.
• --project -p: Obrigatório se não estiver configurado como padrão ou captado via git config. Nome ou ID do projeto. Você pode configurar o projeto padrão usando az devops configure -d project=NAME_OR_ID.

Exemplos

Crie uma nova página com o caminho 'minha página' em um wiki chamado 'myprojectwiki' com conteúdo embutido.

az devops wiki page update --path 'my page' --wiki myprojectwiki --content "Hello World"

Atualize o conteúdo da página com o caminho 'minha página' em um wiki com conteúdo de um arquivo.

az devops wiki page update --path 'my page' --wiki myprojectwiki --file-path a.txt --encoding utf-8

Restrições de nomeação de título de página Wiki

Cada página wiki corresponde a um ficheiro no repositório Git de wikis. Os nomes que atribuir a um título de página wiki têm de estar em conformidade com as seguintes restrições.

Tipo de restrição	Restrição
Nome de ficheiro	O caminho de página completamente qualificado não deve exceder 235 carateres.
Singularidade	Os títulos das páginas são sensíveis às maiúsculas e minúsculas e têm de ser exclusivos na hierarquia de wikis.
Carateres especiais	- Não pode conter carateres de controlo Unicode ou carateres de substituição. - Não deve conter os seguintes caracteres imprimíveis: / \ #. - Não deve começar ou terminar com um período ..
Tamanho dos ficheiros	Não pode exceder o máximo de 18 MB.
Tamanho do ficheiro de anexo	Não pode exceder o máximo de 19 MB.

Caracteres especiais nos títulos das páginas Wiki

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

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

Editar e excluir páginas wiki

Browser

Para editar uma página wiki existente, abra a página e selecione Editar ou abra o menu de contexto e selecione Editar. Você também pode usar o atalho de teclado e para ir para a edição da página atual rapidamente.

Para wikis de código, você pode editar uma página no editor lado a lado, usando a barra de ferramentas de marcação para criar seu conteúdo. Esta experiência é idêntica ao processo em um wiki de projeto. Você também pode editar páginas wiki no hub Repos também usando a opção Editar em repositórios.

Se o seu wiki de código tiver políticas de ramificação, selecione Editar no repositório para criar uma ramificação e continuar a editar. A opção Editar no repositório está especificamente disponível para wikis de código.

Para excluir uma página, abra o menu de contexto da árvore ou dentro da página e selecione Excluir. Confirme a exclusão na caixa de diálogo que se abre.

Nota

Ao excluir uma página, você também exclui todos os metadados e todas as suas subpáginas (se houver) na hierarquia.

CLI do Azure DevOps

Editar página wiki

Para editar uma página wiki, digite o az devops wiki page update comando.

az devops wiki page update --path
                           --version
                           --wiki
                           [--comment]
                           [--content]
                           [--file-path]
                           [--project]
                           [--subscription]

Parâmetros

• --path: Obrigatório. Caminho da página wiki.
• --version -v: Obrigatório. Versão (ETag) do ficheiro a editar.
• --wiki: Obrigatório. Nome do ID da wiki.
• --comment: Opcional. Comente na mensagem de confirmação da operação de exclusão.
• --file-path: Opcional. Caminho da entrada do arquivo se o conteúdo for especificado no arquivo.
• --project -p: Opcional. Nome ou ID do projeto.
• --assinatura: Opcional. o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

Exemplos

Atualize o conteúdo da página com o caminho 'minha página' em um wiki chamado 'myprojectwiki' com conteúdo embutido.

az devops wiki page update --path 'my page' --wiki myprojectwiki --content "Hello World" --version 4ae78ad5835cb7dd55072fe210c9ee7eb6d6413b

Atualize o conteúdo da página com o caminho 'minha página' em um wiki com conteúdo de um arquivo.

az devops wiki page update --path 'my page' --wiki myprojectwiki --file-path a.txt --encoding utf-8 --version 4ae78ad5835cb7dd55072fe210c9ee7eb6d6413b

Excluir página wiki

Para excluir uma página wiki, digite o az devops wiki page delete comando.

az devops wiki page delete --path
                           --wiki
                           [--comment]
                           [--project]
                           [--subscription]
                           [--yes]

Parâmetros

• --path: Obrigatório. Caminho da página wiki.
• --wiki: Obrigatório. Nome ou ID da wiki.
• --comment: Opcional. Comente na mensagem de confirmação da operação de exclusão.
• --project -p: Opcional. Nome ou ID do projeto. Você pode configurar o projeto padrão usando az devops configure -d project=NAME_OR_ID. Necessário se não configurado como padrão ou captado via git config.
• --assinatura: Opcional. o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .
• --yes -y: Opcional. Não solicite confirmação.

Exemplo

Exclua uma página wiki com o caminho 'my wiki' em um wiki chamado 'myprojectwiki'.

az devops wiki page delete --path 'my wiki' --wiki 'myprojectwiki'

Reordenar uma página wiki

Você pode reordenar as páginas dentro da visualização de árvore wiki para que as páginas apareçam na ordem e hierarquia desejadas. Você pode arrastar e soltar um título de página na visualização em árvore para executar as seguintes operações:

• Altere a relação pai-filho de uma página.
• Altere a ordem da página dentro da hierarquia.

Nota

Mover uma página na hierarquia pode quebrar links de outras páginas para ela. Você sempre pode corrigir os links manualmente depois de mover. Reordenar uma página dentro de uma hierarquia não tem impacto nos links de página.

Você também pode usar atalhos de teclado para reordenar páginas. Selecione uma página e pressione CTRL + SETA PARA CIMA ou CTRL + SETA PARA BAIXO para alterar as ordens das páginas. Para alterar a relação pai-filho de uma página, abra o menu de contexto e selecione Mover. A caixa de diálogo Mover página é aberta. Selecione uma página pai sob a qual você pode mover a página atual.

Para obter uma lista completa de atalhos de teclado, consulte Atalhos de teclado para gerenciar páginas wiki.

Tornar uma página na página inicial do wiki

Por padrão, a primeira página que você adiciona quando cria um wiki é definida como a página inicial do wiki. Você pode alterar sua página inicial wiki se outra página se tornar mais relevante, arrastando e soltando a página no topo da árvore.

Próximos passos

Ver histórico da página wiki e reverter

Artigos relacionados

• Siga uma página wiki e receba notificações
• Wiki provisionado vs. publicado
• Atualizar wiki offline
• Documentação de orientação do wiki sobre Markdown