Como formatar XML com indentação ou minificação

Para que serve formatar XML

O XML Formatter serve para transformar texto XML num formato mais legível ou mais compacto. Pode ser útil quando precisa de rever a estrutura de um documento, verificar a hierarquia das etiquetas ou preparar o conteúdo para uma utilização em que os espaços entre etiquetas não sejam necessários.

A ferramenta trabalha com texto XML e permite escolher a largura da indentação. O formato legível é o comportamento predefinido; também existe um modo de minificação para reduzir a apresentação do documento.

Como formatar e minificar XML

1. Introduza o conteúdo XML como texto. O valor de entrada tem de ser uma cadeia de texto; uma entrada de outro tipo não produz um resultado bem-sucedido.

2. Escolha o formato pretendido. Para obter uma apresentação recuada e legível, mantenha o modo de embelezamento, que é o predefinido. Para retirar comentários e compactar o espaço entre etiquetas, selecione o modo de minificação.

3. Defina a largura da indentação, se necessário. O valor predefinido é de 2 espaços. Para texto XML com conteúdo não vazio, valores inferiores a 0, superiores a 8 ou que não possam ser convertidos num número inteiro regressam ao valor de 2 espaços.

4. Execute a formatação e reveja o resultado. No modo de embelezamento, o XML é analisado antes de ser formatado. No modo de minificação, o XML que contém caracteres diferentes de espaços também é validado antes do processamento.

5. Se o resultado falhar, confirme primeiro se o conteúdo é XML bem formado. Verifique também se não ultrapassa 1 000 000 de bytes UTF-8 quando contém texto não vazio. Uma entrada vazia ou composta apenas por espaços é tratada de forma diferente: é aceite e devolve um resultado vazio com sucesso.

Como interpretar o resultado

Um resultado bem-sucedido no modo de embelezamento indica que o texto XML foi analisado e devolvido com uma apresentação recuada. A largura da indentação influencia a leitura do resultado, respeitando as regras de normalização descritas acima.

No modo de minificação, espere uma saída mais compacta: os comentários XML são removidos, os espaços entre etiquetas são condensados e os espaços no início e no fim são retirados. Por isso, este modo não conserva comentários nem a separação visual entre etiquetas.

Um resultado sem sucesso não significa que o conteúdo tenha sido corrigido automaticamente. Pode indicar XML malformado, uma entrada que não é texto ou, para conteúdo não vazio, um tamanho superior ao limite indicado. Se introduzir apenas espaços, o resultado esperado é uma saída vazia bem-sucedida, e não uma versão embelezada.

Exemplo prático

Tem um documento XML com uma etiqueta principal e elementos aninhados numa única linha e quer obter uma versão mais fácil de ler.

Introduza o XML, mantenha o modo de embelezamento e defina uma largura de indentação adequada antes de executar a formatação.

O resultado bem-sucedido tem o XML devolvido como texto recuado, com as etiquetas organizadas em linhas; o número de espaços por nível segue a indentação escolhida.

Limitações

• A minificação não preserva comentários nem espaços entre etiquetas; além disso, entradas não textuais e texto não vazio superior a 1 000 000 de bytes UTF-8 podem falhar.

Erros comuns

• Um erro frequente é colar XML malformado, por exemplo, com uma etiqueta de abertura sem a correspondente etiqueta de fecho. Reveja a estrutura e corrija o texto antes de voltar a executar a operação.

Perguntas frequentes

Qual é o modo predefinido para formatar XML?

O modo de embelezamento é o predefinido e devolve o XML com uma apresentação recuada e legível, depois de analisar o conteúdo.

A minificação remove comentários XML?

Sim, desde que o XML com conteúdo não vazio seja bem formado. A minificação remove comentários, reduz os espaços entre etiquetas e retira os espaços no início e no fim.

O que acontece quando a entrada está vazia ou é demasiado grande?

Uma entrada vazia ou composta apenas por espaços devolve uma saída vazia com sucesso. Para texto não vazio, o tamanho superior a 1 000 000 de bytes UTF-8 é rejeitado.