Reutilizar conteúdo em várias páginas

Este guia tem informações sobre como compartilhar conteúdo entre artigos no DevSite.

Para reutilizar conteúdo em várias páginas, use variáveis e inclusões, que é a versão do DevSite para usar snippets em vários artigos no Composer.

Observação:não é possível fazer publicação cruzada de conteúdo compartilhado com as Centrais de Ajuda em support.google.com. É possível vincular páginas de qualquer domínio na navegação, mas não é possível usar uma única fonte para um artigo ou seção com domínios que não sejam do DevSite.

Quando usar inclusões e variáveis

• Use uma variável quando quiser reutilizar uma string curta de texto de origem única. Por exemplo, nomes de produtos e recursos.

• Use um include quando quiser reutilizar texto formatado ou HTML de origem única. Por exemplo, uma tabela de comparação de recursos ou uma observação importante.

Crie uma variável

1. Abra google3/third_party/devsite/workspace/en/_globalvars.html.
   1. No canto superior direito, clique em Editar no Cider.

2. Adicione uma nova definição de variável.

   • Tente encaixar sua nova variável em um dos cabeçalhos de categoria existentes no arquivo. Se necessário, podemos adicionar mais.
   • Mantenha cada categoria em ordem alfabética, por nome de variável.

   • Verifique se o novo nome de variável ainda não está sendo usado em um dos seguintes arquivos:

     • google3/googledata/devsite/_common/en/_shared/_product_names.html

   • google3/googledata/devsite/_common/en/_shared/workspace/_product_names.html

   • google3/googledata/devsite/_common/en/_shared/cloud/_product_names.html

   {% setvar YOUR_VARIABLE_NAME %}TEXT_TO_DISPLAY{% endsetvar %}

   • Substitua YOUR_VARIABLE_NAME pela variável que você quer usar.
   • Substitua TEXT_TO_DISPLAY pelo texto que será mostrado ao usuário.

3. Salve as mudanças e envie uma CL para workspace-content-configs para revisão e aprovação.

4. Depois que a CL for enviada, você poderá publicar conteúdo usando o novo nome de variável.

Adicionar uma variável ao conteúdo

Para adicionar uma variável à página, use uma variável Jinja. Essa construção simples de {{ ... }} insere o conteúdo da variável especificada no local da tag na sua página.

**Note:** You can buy {{ workspace_name }} from a reseller.

<table>
  <tr>
    <th>Edition</th>
    <th>Cost</th>
  </tr>
  <tr>
    <td>{{ business_plus_sku_name }}</td>
    <td>$50 / month</td>
  </tr>
  <tr>
    <td>{{ business_standard_sku_name }}</td>
    <td>$20 / month</td>
  </tr>
  <tr>
    <td>{{ business_starter_sku_name }}</td>
    <td>No additional cost</td>
  </tr>
</table>

Criar um arquivo de inclusão

Importante:os arquivos de inclusão precisam estar sempre no formato HTML. Isso acontece porque o formato HTML funciona em contextos de bloco de código HTML e Markdown, mas as inclusões de Markdown funcionam apenas em contextos de bloco de código Markdown.

Assista um tutorial em vídeo

Para criar um arquivo de inclusão, siga estas etapas:

1. Abra o Cider.

2. Use a Pesquisa de código ou o Explorador de arquivos para encontrar a pasta third_party/devsite/workspace/en/_shared/includes/.

3. Clique com o botão direito do mouse na pasta includes e clique em New File (captura de tela).

   • Se a inclusão for relevante apenas para o conjunto de conteúdo, crie uma subpasta para ele na pasta /includes e adicione o arquivo de inclusão lá. Por exemplo, …/workspace/en/shared/includes/cloud-search/_my-niche-snippet.html

4. Dê um nome ao arquivo e adicione seu conteúdo. Siga as seguintes diretrizes:

   • Comece o nome do arquivo com um sublinhado. Por exemplo, _my-new-include.html. Isso impede que o arquivo de inclusão se torne uma página externa.
   • Seja descritivo com o nome do arquivo. Isso facilita a localização e o uso da inclusão para todos.
   • Todas as inclusões precisam ser arquivos HTML. A extensão do arquivo precisa ser .html e ele não pode incluir elementos escritos em Markdown. Isso garante que o conteúdo seja renderizado corretamente, seja incluído em um arquivo Markdown, HTML ou um elemento HTML em um arquivo Markdown.
   • Deixe o conteúdo versátil. O objetivo de uma inclusão é que ela se ajuste a várias páginas. Portanto, o conteúdo precisa ser o mais reutilizável possível. * Conteúdo ideal para incluir: etapas e observações ou dicas relacionadas que contenham detalhes de implementação, como limites, advertências ou como as coisas funcionam. * Evite: cabeçalhos ou visões gerais (queremos formatar e escrever esses itens nós mesmos, para casos de uso comerciais).

Exemplo:confira a seguir um arquivo de inclusão de exemplo com etapas para copiar o número de um projeto do Google Cloud:

third_party/devsite/workspace/en/_shared/includes/_copy-cloud-project-number-steps.html

Para mais informações, consulte a documentação de publicação do DevSite sobre Incluir arquivos.

Adicionar uma inclusão ao seu conteúdo

Para adicionar uma inclusão à sua página, use uma tag include. A tag include insere o conteúdo do arquivo especificado no local da tag na sua página.

Confira um exemplo de tag de inclusão para o arquivo de exemplo da seção anterior:

{% include "_shared/includes/_copy-cloud-project-number-steps.html" %}

Arquivos de snippet migrados

Os snippets do Composer foram migrados para a pasta third_party/devsite/workspace/en/_shared/snippets. Se o conteúdo usava snippets no Composer antes da migração para o DevSite, você vai encontrar tags de inclusão semelhantes ao exemplo a seguir:

{% include "_shared/snippets/_snippet-9393389.html" %}

Não adicione novos arquivos de inclusão à pasta _shared/snippets.

Publicação cruzada

No DevSite, cada página pertence a um conjunto de conteúdo. O Devsite não oferece suporte à publicação cruzada usada no Composer, em que uma página pode ser publicada em várias centrais de ajuda. Em vez disso, você pode vincular páginas em outros conjuntos de conteúdo no sumário (TOC).

Adicionar uma página de um conjunto de conteúdo diferente à sua navegação

Para vincular uma página de um conjunto de conteúdo diferente na sua navegação, siga estas etapas:

1. Abra o arquivo _book.yaml do seu conjunto de conteúdo. O arquivo _book.yaml é onde você gerencia a navegação do site.
2. Adicione o título da página e o caminho raiz à página que você quer vincular.

No exemplo a seguir, o arquivo _book.yaml do Cloud Search tem um link para um artigo do conjunto de conteúdo de Continuidade de Negócios.

    - name: "Guides"
      contents:
      - heading: "Getting started"
      - title: "What is Google Cloud Search?"
        path: /cloud-search/what-is-google-cloud-search 
      - title: "Deploy 2-Step Verification"
        path: /business-continuity/security-and-monitoring/deploy-2-step-verification
      

Quando um usuário clica no link "Implantar a verificação em duas etapas" na navegação do Cloud Search, ele é direcionado para a página na documentação de Continuidade de Negócios.

Para saber mais sobre como atualizar a navegação do seu site, consulte Atualizar a navegação.