Isenção de responsabilidade: Este artigo foi gerado usando tradução automática.

Usando snippets

Prev Next

Planos que suportam este recurso: Professional Business Enterprise

Trechos é um conjunto predefinido de blocos de conteúdo que o gerenciador de conteúdo ou autor usa como conteúdo reutilizável. O conteúdo do Snippet pode variar de texto ou frases simples a parágrafos longos, tabelas, imagens e muito mais. No Document360, os snippets são armazenados em uma biblioteca e você pode inseri-los facilmente em artigos durante a edição com apenas um clique de um botão.

NOTA

O Snippet aparecerá como conteúdo normal para o leitor no site da base de conhecimento. O leitor não saberá que o conteúdo foi renderizado por meio do Snippet.


Acessando a página Snippets

Você pode exibir, editar ou excluir um snippet da Trechos página.

  1. Navegue até Documentação () na barra de navegação esquerda no Portal da base de conhecimento.

  2. No painel de navegação esquerdo, vá para Ferramentas de conteúdo > Reutilização de conteúdo > Trechos.

    A Trechos página exibe uma lista de todos os snippets que foram adicionados ao seu projeto.

Overview of snippets management interface with highlighted options and content categories.

  1.   Como exibir: Veja um tutorial sobre como usar snippets.

  2.   Docs: abra o artigo de documentação sobre snippets.

  3. Criar: crie um novo snippet.

  4. Idiomas: filtre a lista de snippets por Global ou um idioma específico.

  5. Pesquisar snippets: pesquise snippets por nome.

  6. Usado em: mostra onde o snippet é usado.

    • Se o snippet não for usado, o campo mostrará um traço -.

    • Se o snippet for usado, clique em Exibir para ver os artigos ou páginas de categoria em que ele foi inserido.

  7. Idioma: indica o idioma do snippet.

  8. Última modificação: exibe a data e a hora em que o snippet foi atualizado pela última vez.

  9. Visualizar: clique no nome do snippet para visualizar seu conteúdo.

  10. Progresso: visualize o progresso da tradução do snippet. Clique no ícone de globo () ao lado de cada variável. A indica que o snippet foi traduzido para esse idioma, enquanto o ícone indica que ele ainda não foi traduzido.

  11. Editar (): edite o conteúdo do snippet.

  12. Excluir (): clique para excluir um snippet. Para excluir vários snippets em uma instância, marque a caixa de seleção desejada e clique em Excluir na parte superior.


Criando um snippet

Para criar um novo snippet:

  1. Navegue até Documentação () na barra de navegação esquerda no Portal da base de conhecimento.

  2. No painel de navegação esquerdo, navegue até Ferramentas de conteúdo > Reutilização de conteúdo > Trechos.

    A Trechos página é exibida. Se você adicionou algum snippet anteriormente, poderá vê-lo listado aqui.

  3. Clique em Criar no canto superior direito.

  4. Na caixa de diálogo Criar novo snippet :

    1. Insira um Nome (até 50 caracteres). Você pode usar letras, números, hífens e sublinhados.

    2. Escolha um idioma (o padrão é Global). Você pode selecionar um idioma específico, se necessário.

    3. Expanda o menu suspenso Avançado e escolha seu editor (Markdown ou Advanced WYSIWYG). O editor padrão é baseado nas configurações gerais do projeto.

  5. Clique em Criar.

Depois de criado:

  1. Use o editor selecionado para inserir o conteúdo do snippet.

    1. Se estiver usando Markdown, o editor Markdown será exibido.

    2. Se estiver usando o Advanced WYSIWYG, a barra de ferramentas do editor, a visualização de código, o gerador de resumo do Eddy AI e o gerador de perguntas frequentes do Eddy AI estarão disponíveis.

NOTA

  • Depois de selecionar o editor WYSIWYG avançado, você não poderá voltar para Markdown.

  • Se você começar com Markdown, poderá converter para WYSIWYG avançado para fins de tradução (já que o Markdown não oferece suporte à tradução automática). Então você não pode voltar para Markdown.

  1. Você pode alternar o idioma no menu suspenso de idiomas na parte superior.

  2. Depois de redigir seu snippet, clique em Salvar ou pressione Ctrl+S para usar o atalho.

NOTA

Opções de formatação

  • Você pode aplicar formatação ao conteúdo do snippet usando a barra de ferramentas:

    • Editor Markdown: Para obter ajuda na formatação, leia o artigo sobre o Markdown editor.

    • Editor WYSIWYG avançado: para obter uma lista completa de recursos, leia o artigo sobre o Advanced WYSIWYG editor.

  • Você pode usar HTML personalizado nas exibições de código. No entanto, as tags não suportadas serão limpas automaticamente.

  • Selecionando o editor WYSIYWG avançado, você pode usar o menu Barra no editor de snippets para acessar ferramentas de formatação como Título 2, Título 3, Título 4, Lista numerada, Lista com marcadores, Lista de verificação, Código embutido e Bloco de código, e também pode inserir elementos como Imagem, Vídeo, Link, Tabela, Divisor, Acordeão, Texto explicativo, Guias, Perguntas frequentes, LaTeX e Emoji.

Creating a new snippet in Document360  

Usando o Eddy AI no conteúdo do Snippet

Ao redigir um snippet, você pode passar o mouse sobre o conteúdo desejado e usar o Eddy AI para tornar o texto mais longo ou mais curto, melhorá-lo, alterar o tom, converter fala, alterar a voz, dividir frases ou gerar elementos como tabelas, gráficos de pizza e fluxogramas.

No canto inferior direito, você também pode acessar as Perguntas frequentes do gerador e o resumo do gerador do Eddy AI (a opção de resumo está disponível apenas para trechos em inglês).

Document360 interface showcasing content tools and AI features for knowledge base management.


Inserindo um trecho no artigo

Você pode inserir snippet nos artigos em dois métodos:

Método 1: Usando a sintaxe (editor Markdown)

Método 2: Usando a barra de ferramentas (Markdown e WYSIWYG)

Método 3: Usando o menu Barra (editor WYSIWYG avançado)

No editor Markdown, digite um snippet. MergeCodeValue entre chaves duplas fechadas.

Exemplo: {{snippet.snippet name}}

Você deve saber o valor exato do código de mesclagem para adicionar o snippet desejado. O snippet não funcionará mesmo se uma única letra for alterada.

NOTA

Digitando em snippet. Merge_Code_Value só funcionará no editor Markdown. Se você estiver usando Advanced WYSIWYG editoro , poderá inserir snippet usando a barra de ferramentas.

Para inserir um snippet da barra de ferramentas do editor:

  1. Clique no ícone Reutilização de conteúdo () para Markdown e editor WYSIWYG.

  2. Selecione o snippet ou use a barra de snippets de pesquisa para restringir o nome do snippet.

  3. Selecione o snippet pretendido a ser inserido.

NOTA

Se a opção Inserir como cópia local estiver ativada, o conteúdo do snippet adicionado ao artigo permanecerá inalterado. O snippet no artigo não será afetado se o conteúdo do snippet selecionado for modificado ou removido no futuro.

Markdown editor interface showcasing content reuse and document management features.

Para inserir um snippet no menu de barra:

  1. Use o comando /snippets de barra para abrir a ferramenta Snippets no menu de barra.

  2. Use a barra de snippets de pesquisa para localizar o snippet que deseja inserir.

  3. Passe o mouse sobre o nome de um snippet para visualizar seu conteúdo completo.

  4. Clique no snippet para inseri-lo no artigo.

    O conteúdo do snippet será inserido diretamente dentro do editor dentro de um bloco de conteúdo destacado com um contorno pontilhado. Isso ajuda a distinguir o conteúdo do snippet do restante do artigo.

  5. Clique dentro do bloco de snippet para abrir o menu de bolhas:

    1. Use a lista suspensa para alternar para um snippet diferente.

    2. Clique em Inserir como texto para converter o snippet em conteúdo estático.

    3. Clique no ícone Excluir () para remover o bloco de snippet do artigo.

Inserting snippets in the Advanced WYSIWYG editor


Exibindo o uso do snippet (dependência de artigo/categoria)

Para ver onde um snippet é usado:

  1. Na coluna Usado em , clique em Exibir.

  2. O painel Exibir referências é exibido. Você verá:

    • A versão do artigo.

    • O espaço de trabalho e o idioma do projeto.

    • O nome da conta da equipe e a foto do perfil que adicionou o snippet.

    • O artigo afirma (Rascunho e Publicado).

    • As informações de hora/data em que o snippet foi inserido na página do artigo/categoria.

    • Clique no ícone para abrir a mesma versão do artigo em uma nova guia.

Document360 interface showing snippets and article revision details with highlighted elements.  


Editando um snippet

Para editar um snippet:

  1. Navegue até Documentação () na barra de navegação esquerda no Portal da base de conhecimento.

  2. No painel de navegação esquerdo, vá para Ferramentas de conteúdo > Reutilização de conteúdo > Trechos.

    A Trechos página é exibida. Você pode encontrar a lista de snippets que já adicionou.

  3. Passe o mouse sobre o snippet que deseja editar e clique no ícone Editar ().

  4. Atualize o conteúdo conforme necessário.

  5. Clique em Atualizar.

NOTA

Quando você atualiza um snippet, as alterações são refletidas automaticamente em todos os artigos e páginas de categoria em que ele é usado, incluindo os publicados, sem a necessidade de republicá-los.

Document360 interface showing snippets management and content tools for documentation.  


Excluindo um snippet

Para excluir um snippet:

  1. Navegue até Documentação () na barra de navegação esquerda no Portal da base de conhecimento.

  2. No painel de navegação esquerdo, navegue até Ferramentas de conteúdo > Reutilização de conteúdo > Trechos.

    A página Snippets aparecerá. Você pode encontrar a lista de snippets que já adicionou.

  3. Passe o mouse sobre o snippet desejado e clique no ícone Excluir ().

  4. Clique em Sim na caixa de diálogo Excluir confirmação.

  5. Para excluir em massa vários snippets, selecione vários snippets pretendidos na página Snippets e clique na opção Excluir () na parte superior da lista.

NOTA

  • Quando você exclui um snippet, ele é removido de todos os artigos em que é referenciado.

  • O artigo mantém sua versão atual.

  • No site da base de dados de conhecimento, o conteúdo ao redor é ajustado para que nenhum espaço vazio seja deixado onde o snippet foi removido.

  • No portal, um símbolo de carregamento aparece no bloco de conteúdo em que o snippet foi removido. Você pode selecionar esse bloco para inserir outro snippet ou excluir o bloco manualmente.

Document360 interface showing snippets management with delete option highlighted.


Traduzindo trechos

Você pode criar snippets em vários idiomas para garantir a localização em sua base de conhecimento.

NOTA

Os snippets globais não podem ser traduzidos.

Traduzindo novos snippets

Para traduzir um novo snippet durante a criação:

  1. Navegue até Documentação () na barra de navegação esquerda no Portal da base de conhecimento.

  2. No painel de navegação esquerdo, navegue até Ferramentas de conteúdo > Reutilização de conteúdo > Trechos.

  3. Clique em Criar.

  4. Na caixa de diálogo Criar novo snippet , insira o nome do snippet, selecione o idioma desejado e escolha o editor de sua preferência.

  5. Clique em Criar.

  6. No menu suspenso Idioma , selecione o idioma pretendido para o snippet.

  7. Insira o conteúdo no idioma desejado.

  8. Para traduzir o conteúdo para outros idiomas, clique no menu suspenso Traduzir para outros idiomas .

  9. Selecione os idiomas desejados na lista e clique em Traduzir.

NOTA

  • O idioma padrão será marcado como Principal.

  • Os idiomas traduzidos mostrarão uma marca verde (✔) assim que a tradução for concluída.

  • Você pode alternar manualmente para idiomas não traduzidos e adicionar traduções conforme necessário.

  1. Clique em Salvar para salvá-lo com todas as traduções.

Por exemplo, se você criar um snippet para uma mensagem de boas-vindas em inglês, poderá usar o recurso de tradução para adicionar a mesma mensagem em francês, espanhol, holandês etc.

Document360 interface showing translating new snippets  


Traduzindo snippets existentes

  1. Na página Snippets , clique no snippet existente desejado que você deseja traduzir.

  2. Navegue até Traduzir para outros idiomas e selecione o idioma desejado para o qual o snippet precisa ser traduzido.

  3. Clique em Traduzir.

  4. Se necessário, você pode navegar para outros idiomas e traduzir novamente para esses idiomas.

  5. Para traduzir o conteúdo novamente, clique em Traduzir novamente. Isso substituirá a tradução existente por uma nova.

  6. Se você precisar remover o snippet traduzido para um idioma específico, clique no ícone Mais () e selecione Remover idioma.

    Você pode retraduzir o conteúdo a qualquer momento, se necessário.

Document360 interface showing translating existing snippets  


Solucionando problemas

Os snippets não estão aparecendo no menu do editor

Esse problema geralmente ocorre quando um snippet é criado em um idioma, mas usado em um artigo escrito em um idioma diferente. No Document360, os snippets são específicos do idioma, a menos que sejam criados na configuração Idioma global .

Etapas para resolver:

  • Certifique-se de que o snippet seja criado no mesmo idioma do artigo em que você está trabalhando.

  • Se o snippet foi criado em um idioma diferente, use a opção Traduzir para outros idiomas disponível na seção Reutilização de conteúdo.

  • Depois de traduzido, mude para o idioma desejado no editor de artigos. O snippet agora deve aparecer quando você tentar inseri-lo no artigo.

NOTA

Os snippets criados em um idioma específico aparecerão apenas em artigos escritos no mesmo idioma.

Se os snippets ainda não estiverem aparecendo após seguir as etapas acima, entre em contato support@document360.com com os seguintes detalhes:

  • Uma captura de tela do snippet na seção Reutilização de conteúdo.

  • Uma captura de tela mostrando o snippet não aparecendo no editor de artigos.


Perguntas Freqüentes

Quantos snippets podem ser criados em um projeto?

Você pode criar até 200 snippets em um único projeto. Se precisar de mais, trechos adicionais podem ser adquiridos como um complemento.

Posso alterar o nome de um snippet depois que ele for criado?

Embora você possa editar o conteúdo de um snippet, seu nome não pode ser alterado após a criação.

Por que um snippet é inserido em uma nova linha?

Os snippets são projetados como novos blocos de conteúdo, permitindo que várias linhas sejam adicionadas a eles. Como tal, eles sempre começarão de uma nova linha para manter a estrutura e a clareza.