Opções do editor no Document360

Planos de apoio ao uso de editores

O uso do editor de texto no Document360 é essencial para criar e gerenciar artigos da base de conhecimento com eficiência.

O Document360 permite que você esboce artigos em três opções versáteis de editor:

1. O Markdown editor permite que os escritores usem sintaxe e HTML para personalizar artigos.

2. O editor WYSIWYG (What You See Is What You Get) usa formatação rich text e inclui uma extensa barra de ferramentas de formatação; No entanto, você não pode usar código personalizado em artigos.

3. O Advanced WYSIWYG editor é a adição mais recente às opções do editor no Document360 e atua como um híbrido entre os editores Markdown e WYSIWYG.

O Document360 garante uma experiência amigável que aprimora a clareza, a consistência e o envolvimento do conteúdo.

Editor de Markdown

O editor Markdown tem um espaço de trabalho em tela dividida e recursos para ajudá-lo a gerenciar um artigo enquanto o escreve.

1. O lado esquerdo da tela é onde você digita e aplica a sintaxe Markdown.

2. A tela de visualização no lado direito permite que você veja como seu artigo ficará antes de publicá-lo.

3. A rolagem para ligar indica que ambas as seções rolam simultaneamente. Clique em Rolar para desativar a rolagem automática.

4. Clique em visualizar para ver como seu artigo será exibido no site da base de conhecimento.

5. Após a publicação, você pode encontrar o ícone Copiar link () próximo ao ícone Exibir na Base de conhecimento ().

Use as setas no divisor para recolher qualquer janela do editor.

Cenários em que o editor Markdown é recomendado

O editor Markdown fornece flexibilidade guiada para criação e personalização de artigos e impõe um estilo de escrita e formatação consistentes em toda a documentação. Essa consistência é crucial para manter uma aparência profissional na documentação do produto.

Por exemplo, você pode inserir imagens usando a barra de ferramentas, que injeta o seguinte Markdown:

![Image Alt Text] (Image URL){height="" width=""}.

Você pode ajustar o tamanho da imagem adicionando os valores desejados (por exemplo, height="600px", width="400px"). A formatação avançada, como sombras e bordas, pode ser obtida com trechos de personalização HTML.

Editor WYSIWYG

O WYSIWYG, que significa What You See Is What You Get, é um editor baseado em HTML que difere do editor Markdown. Ele permite que você visualize a formatação real do artigo à medida que digita ou insere conteúdo.

Cenários em que o editor WYSIWYG é recomendado

Se os membros da equipe que contribuem para os artigos estiverem familiarizados com editores baseados em HTML como o WordPress, este editor é relativamente fácil de usar. Além disso, se seus artigos de documentação contiverem muito código e mídia, o editor WYSIWYG fornecerá amplas opções de formatação para texto, imagens, vídeos e muito mais.

NOTA

Para mais informações, leia o artigo sobre WYSIWYG editor.

Editor WYSIWYG avançado

O leve e poderoso 'Editor WYSIWYG avançado' oferece recursos de edição de rich text e suporta a sintaxe Markdown, proporcionando uma experiência mais visual e intuitiva em comparação com o editor Markdown, mantendo a flexibilidade semelhante ao editor WYSIWYG.

Digite / o editor e uma lista de opções será exibida. Você pode pesquisar as opções digitando nomes de comando. Clique no comando desejado ou pressione a tecla Enter para selecionar o comando.

Cenários em que o editor WYSIWYG avançado é recomendado

Suponha que você tenha artigos da base de conhecimento com artigos centrados em texto, com muito código e ricos em mídia. Nesses casos, o editor WYSIWYG avançado é uma alternativa flexível ao Markdown e ao WYSIWYG. Isso fornece edição rápida baseada em sintaxe semelhante ao Markdown e opções amplas de formatação de texto e imagem, como o editor WYSIWYG.

NOTA

Para obter mais informações, consulte o artigo de ajuda do Document360 sobre Advanced WYSIWYG editor.

Alterando o editor padrão no nível do projeto

Para tornar o editor WYSIWYG/WYSIWYG avançado o editor padrão:

1. Navegue até Configurações () > portal da base de conhecimento > Geral no portal da base de conhecimento.

2. Na seção Editor , escolha o editor desejado.

3. Clique em Salvar.

NOTA

Se você alterar o editor padrão do seu projeto, todos os novos artigos que você criar estarão na escolha do seu respectivo editor.

Alternando entre Markdown - WYSIWYG - Editor WYSIWYG avançado

O editor Markdown é o editor padrão para todos os novos projetos e artigos no Document360. Se você quiser usar o editor WYSIWYG ou WYSIWYG avançado, poderá alternar para ele em um nível de projeto ou artigo.

Mudança de editor no nível do artigo

Para alternar editores em uma página individual /category, siga as etapas abaixo

1. Na página de artigo/categoria, clique no ícone Mais (•••) e selecione Mais opções de artigo.

   O painel Configurações do artigo será exibido.

2. Na guia Editor , selecione o editor desejado.

3. Marque a caixa de seleção Tem certeza de que deseja continuar? .

4. Clique em Salvar.

   As mesmas etapas se aplicam à documentação da API.

   5_Screenshot-Switching_editors

   

NOTA

Depois de mudar para o editor WYSIWYG avançado no nível do artigo, você não pode reverter o tipo de editor para esse artigo específico. No entanto, para artigos futuros, o usuário com a permissão Configurações do Projeto - Atualizar pode definir o editor padrão no portal Configurações > Base de Dados de Conhecimento > Editor Geral >.

Manipulando tags e atributos HTML não suportados no editor WYSIWYG avançado

O editor WYSIWYG avançado no Document360 garante a segurança do conteúdo gerenciando tags e atributos HTML não suportados. Em vez de removê-los, o editor sinaliza e preserva esses elementos para que os usuários revisem e corrijam.

Quando isso acontece?

1. Migrando do editor WYSIWYG para o Advanced WYSIWYG

   Ao alternar entre os editores, o conteúdo não suportado é automaticamente identificado e sinalizado para que os usuários resolvam possíveis problemas.

2. Editando conteúdo no editor WYSIWYG avançado

   Quando marcas ou atributos não suportados são adicionados na Visualização de código, o editor os detecta, sinaliza e marca visualmente para correção.

O que acontece quando elementos não suportados são detectados?

• O editor detecta tags HTML não suportadas (por exemplo, <marquee>, <blink>) e atributos (por exemplo, onmouseover, ) style="text-decoration:blink"durante a análise.

• Esses elementos são sinalizados visualmente no conteúdo usando indicadores personalizados, como dicas de ferramentas e destaques de bloco, sem interromper a estrutura do conteúdo.

• No editor, você não pode editar o bloco do elemento não suportado desejado. No entanto, os usuários podem interagir com elementos sinalizados, recebendo opções para modificá-los, removê-los ou corrigi-los na visualização de código.