Riutilizzare i contenuti in più pagine

Questa guida contiene informazioni su come condividere contenuti tra gli articoli di DevSite.

Per riutilizzare i contenuti in più pagine, puoi utilizzare variabili e include, che è la versione DevSite dell'utilizzo di snippet in più articoli in Composer.

Nota:la pubblicazione incrociata di contenuti condivisi con i Centri assistenza su support.google.com non è possibile. Puoi creare link a pagine di qualsiasi dominio nella navigazione, ma non puoi utilizzare un solo dominio non DevSite per un articolo o una sezione.

Quando utilizzare include e variabili

• Utilizza una variabile quando vuoi riutilizzare una stringa di testo breve e di una sola origine. Ad esempio, i nomi dei prodotti e delle funzionalità.

• Utilizza un include quando vuoi riutilizzare testo formattato o HTML di una singola origine. Ad esempio, una tabella di confronto delle funzionalità o una nota importante.

Crea una variabile

1. Apri google3/third_party/devsite/workspace/en/_globalvars.html.
   1. In alto a destra, fai clic su Modifica in Cider.

2. Aggiungi una nuova definizione della variabile.

   • Prova a inserire la nuova variabile in una delle intestazioni di categoria esistenti nel file. Se necessario, possiamo aggiungerne di nuovi.
   • Mantieni ogni categoria in ordine alfabetico, in base al nome della variabile.

   • Assicurati che il nuovo nome della variabile non sia già utilizzato in uno dei seguenti file di variabili:

     • 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 %}

   • Sostituisci YOUR_VARIABLE_NAME con la variabile che vuoi utilizzare.
   • Sostituisci TEXT_TO_DISPLAY con il testo che deve essere visualizzato dall'utente.

3. Salva le modifiche e invia un elenco di controllo a workspace-content-configs per la revisione e l'approvazione.

4. Una volta inviato il file CL, puoi pubblicare contenuti utilizzando il nuovo nome della variabile.

Aggiungere una variabile ai contenuti

Per aggiungere una variabile alla pagina, utilizza una variabile Jinja. Questa semplice costruzione {{ ... }} inserisce i contenuti della variabile specificata nella posizione del tag sulla pagina.

**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>

Creare un file di inclusione

Importante:i file includi devono essere sempre in formato HTML. Questo perché il formato HTML può funzionare sia nei contesti di blocchi di codice HTML che Markdown, mentre gli include Markdown funzionano solo nei contesti di blocchi di codice Markdown.

Guarda un tutorial video

Per creare un file di inclusione, segui questi passaggi:

1. Apri Cider.

2. Utilizza la ricerca di codice o Esplora file per trovare la cartella third_party/devsite/workspace/en/_shared/includes/.

3. Fai clic con il tasto destro del mouse sulla cartella includes e fai clic su Nuovo file (screenshot).

   • Se l'include è pertinente solo al tuo insieme di contenuti, puoi creare una sottocartella per l'insieme di contenuti all'interno della cartella /includes e aggiungere il file include. Ad esempio, …/workspace/en/shared/includes/cloud-search/_my-niche-snippet.html

4. Assegna un nome al file e aggiungi i contenuti. Procedi nel seguente modo:

   • Inizia il nome del file con un trattino basso. Ad esempio, _my-new-include.html. Ciò impedisce al file di inclusione di diventare una pagina autonoma esternamente.
   • Utilizza un nome file descrittivo. In questo modo, l'include è più facile da trovare e utilizzare per tutti.
   • Tutti gli include devono essere file HTML. L'estensione del file deve essere .html e il file non deve includere elementi scritti in Markdown. In questo modo, il rendering dei contenuti verrà eseguito correttamente indipendentemente dal fatto che siano inclusi in un file Markdown, in un file HTML o in un elemento HTML all'interno di un file Markdown.
   • Rendi i contenuti versatili. L'obiettivo di un include è quello di adattarsi a più pagine, quindi i contenuti devono essere il più riutilizzabili possibile. * Contenuti da includere ideali: passaggi e note o suggerimenti correlati contenenti eventuali dettagli di implementazione come limiti, avvertenze o il funzionamento. * Evita: titoli o panoramiche (vogliamo formattarli e scriverli noi stessi per i casi d'uso aziendali).

Esempio: di seguito è riportato un esempio di file di inclusione con i passaggi per copiare il numero di progetto di un progetto Google Cloud:

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

Per saperne di più, consulta la documentazione sulla pubblicazione di DevSite per includere file.

Aggiungere un include ai contenuti

Per aggiungere un include alla pagina, utilizza un tag include. Il tag include inserisce i contenuti del file specificato nella posizione del tag nella pagina.

Ecco un esempio di tag include per il file di esempio della sezione precedente:

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

File degli snippet migrati

Gli snippet di Composer sono stati migrati nella cartella third_party/devsite/workspace/en/_shared/snippets. Se i tuoi contenuti utilizzavano snippet in Composer prima della migrazione a DevSite, vedrai tag include nei tuoi contenuti simili al seguente esempio:

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

Non aggiungere nuovi file di inclusione alla cartella _shared/snippets.

Pubblicazione incrociata

In DevSite, ogni pagina appartiene a un insieme di contenuti. Devsite non supporta la pubblicazione incrociata utilizzata in Composer, in cui una pagina può essere pubblicata in più centri assistenza. In alternativa, puoi creare un link alle pagine di altri insiemi di contenuti dall'interno del sommario.

Aggiungere una pagina di un altro insieme di contenuti al menu di navigazione

Per creare un link a una pagina di un altro set di contenuti nella navigazione, segui questi passaggi:

1. Apri il file _book.yaml per il set di contenuti. Il file _book.yaml è dove gestisci la navigazione del tuo sito.
2. Aggiungi il titolo e il percorso principale della pagina a cui vuoi creare un link.

Nell'esempio seguente, il file _book.yaml per Cloud Search rimanda a un articolo del set di contenuti Business Continuity.

    - 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 un utente fa clic sul link Implementa la verifica in due passaggi nella navigazione di Cloud Search, viene reindirizzato alla pagina della documentazione di Business Continuity.

Per scoprire di più sull'aggiornamento della navigazione del sito, consulta Aggiornare la navigazione.