Adicionar e editar páginas de wiki

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

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

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

Ao editar a página, salve-a inserindo 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	Descrição
az devops wiki show	Abrir um wiki
az devops wiki page show	Obter o conteúdo de uma página ou abrir uma página
az devops wiki page create	Adicionar uma nova página
az devops wiki page update	Editar uma página
az devops wiki page delete	Excluir uma página

Observação

Para adicionar ou editar páginas a um wiki que você publicou 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.

Abrir o Wiki

Navegador

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

Se você precisar mudar seu projeto de equipe, escolha Azure DevOps para navegar por todos os projetos e equipes da equipe.

CLI do Azure DevOps

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

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

Parâmetros

• --wiki: obrigatório. Nome ou ID do wiki.
• --open: opcional. Abra a página wiki no navegador da Web.
• --project -p: Opcional. Nome ou ID do projeto.
• --subscription: opcional. Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Exemplo

Abra um wiki chamado 'myprojectwiki'.

az devops wiki show --wiki myprojectwiki --open

Exibir uma página wiki

Para obter o conteúdo de uma página por meio da CLI do Azure DevOps, insira 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 do wiki.
• --include-content: opcional. Inclua o conteúdo da página.
• --open: opcional. Abra a página wiki no 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

Navegador

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 de página diferenciam maiúsculas de minúsculas. Para outras restrições de título, consulte Arquivos de repositório Git wiki e estrutura de arquivos, Convenções de nomenclatura de arquivo.

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, insira 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 do wiki.
• --comment: opcional. Comente no mensagem do commit da operação de adição de arquivo. Valor padrão: adicionada uma nova página usando a CLI do Azure DevOps.
• --content: opcional. Conteúdo da página wiki. Ignorado se --file-path for especificado.
• --encoding: opcional. Codificação do arquivo. Usado com --file-path parâmetro. valores aceitos: 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 selecionado por meio da configuração do git. Nome ou ID do projeto. Você pode configurar o projeto padrão usando o 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 nomenclatura de título de página wiki

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

Editar e excluir páginas wiki

Navegador

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 markdown para criar seu conteúdo. Essa 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 Repos.

Se o wiki de código tiver políticas de ramificação, selecione Editar em Repositórios para criar uma ramificação e continuar editando. A opção Editar em Repositórios está disponível especificamente para wikis de código.

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

Observação

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, insira 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 arquivo a ser editado.
• --wiki: obrigatório. Nome da ID do wiki.
• --comment: opcional. Comente no mensagem do commit 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.
• --subscription: opcional. Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

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, insira 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 do wiki.
• --comment: opcional. Comente na mensagem do commit 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. Obrigatório se não estiver configurado como padrão ou selecionado por meio da configuração git.
• --subscription: opcional. Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
• --yes -y: opcional. Não solicite confirmação.

Exemplo

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

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

Reordenar uma página wiki

Você pode reordenar páginas no modo de exibição de árvore wiki para que as páginas apareçam na ordem e na hierarquia desejadas. Você pode arrastar e soltar um título de página no modo de exibição de á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.

Observação

Mover uma página na hierarquia pode interromper links para ela de outras páginas. Você sempre pode corrigir os links manualmente depois de mover. Reordenar uma página dentro de uma hierarquia não afeta os 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 os pedidos de página. Para alterar a relação pai-filho de uma página, abra seu menu de contexto e selecione Mover. A caixa de diálogo Mover página é aberta. Selecione uma página pai na 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.

Criar uma página na home page wiki

Por padrão, a primeira página que você adiciona ao criar um wiki é definida como a home page wiki. Você poderá alterar sua home page wiki se outra página se tornar mais relevante arrastando e soltando a página na parte superior da árvore.

Próximas etapas

Exibir histórico e reverter de página wiki

Artigos relacionados

• Siga uma página wiki e receba notificações
• Wiki provisionado x publicado
• Atualizar wiki offline
• Diretrizes básicas do Markdown