Réutiliser du contenu sur plusieurs pages

Ce guide explique comment partager du contenu entre les articles de DevSite.

Pour réutiliser du contenu sur plusieurs pages, vous pouvez utiliser des variables et des inclusions, qui sont l'équivalent DevSite de l'utilisation d'extraits dans plusieurs articles de Composer.

Remarque : Il n'est pas possible de publier du contenu partagé dans les centres d'aide sur support.google.com. Vous pouvez créer des liens vers des pages de n'importe quel domaine dans la navigation, mais vous ne pouvez pas utiliser un article ou une section provenant de domaines autres que DevSite comme source unique.

Quand utiliser les inclusions et les variables ?

• Utilisez une variable lorsque vous souhaitez réutiliser une courte chaîne de texte à source unique. Par exemple, les noms de produits et de fonctionnalités.

• Utilisez une inclusion lorsque vous souhaitez réutiliser du texte ou du code HTML mis en forme à partir d'une source unique. Par exemple, un tableau comparatif des fonctionnalités ou une note importante.

Créer une variable

1. Ouvrez google3/third_party/devsite/workspace/en/_globalvars.html.
   1. En haut à droite, cliquez sur Modifier dans Cider.

2. Ajoutez une définition de variable.

   • Essayez d'insérer votre nouvelle variable sous l'un des titres de catégorie existants dans le fichier. Si nécessaire, nous pouvons en ajouter.
   • Classez chaque catégorie par ordre alphabétique, selon le nom de la variable.

   • Assurez-vous que le nom de votre nouvelle variable n'est pas déjà utilisé dans l'un des fichiers de variables suivants :

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

   • Remplacez YOUR_VARIABLE_NAME par la variable que vous souhaitez utiliser.
   • Remplacez TEXT_TO_DISPLAY par le texte qui doit s'afficher pour l'utilisateur.

3. Enregistrez vos modifications et envoyez une CL à workspace-content-configs pour examen et approbation.

4. Une fois la CL envoyée, vous pouvez publier du contenu en utilisant votre nouveau nom de variable.

Ajouter une variable à votre contenu

Pour ajouter une variable à votre page, utilisez une variable Jinja. Cette construction simple {{ ... }} insère le contenu de la variable spécifiée à l'emplacement de la balise sur votre page.

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

Créer un fichier include

Important : Les fichiers à inclure doivent toujours être au format HTML. En effet, le format HTML peut fonctionner dans les contextes de blocs de code HTML et Markdown, mais les inclusions Markdown ne fonctionnent que dans les contextes de blocs de code Markdown.

Regarder un tutoriel vidéo

Pour créer un fichier d'inclusion, procédez comme suit :

1. Ouvrez Cider.

2. Utilisez la recherche de code ou l'explorateur de fichiers pour trouver le dossier third_party/devsite/workspace/en/_shared/includes/.

3. Effectuez un clic droit sur le dossier includes, puis cliquez sur New File (capture d'écran).

   • Si votre inclusion ne concerne que votre ensemble de contenus, vous pouvez créer un sous-dossier pour votre ensemble de contenus dans le dossier /includes et y ajouter votre fichier d'inclusion. Par exemple, …/workspace/en/shared/includes/cloud-search/_my-niche-snippet.html.

4. Donnez un nom au fichier et ajoutez votre contenu. Suivez les instructions ci-dessous :

   • Commencez le nom du fichier par un trait de soulignement. Exemple : _my-new-include.html. Cela empêche le fichier d'inclusion de devenir sa propre page en externe.
   • Choisissez un nom de fichier descriptif. Cela permet à tous de trouver et d'utiliser plus facilement l'inclusion.
   • Toutes les inclusions doivent être des fichiers HTML. L'extension du fichier doit être .html et le fichier ne doit inclure aucun élément écrit en Markdown. Cela garantit que le contenu s'affichera correctement, qu'il soit inclus dans un fichier Markdown, un fichier HTML ou un élément HTML dans un fichier Markdown.
   • Rendez votre contenu polyvalent. L'objectif d'une inclusion est de s'adapter à plusieurs pages. Le contenu doit donc être aussi réutilisable que possible. * Contenu idéal à inclure : étapes et notes ou conseils associés contenant des détails d'implémentation tels que des limites, des mises en garde ou des informations sur le fonctionnement. * Évitez les titres ou les aperçus (nous souhaitons les mettre en forme et les rédiger nous-mêmes, pour les cas d'utilisation professionnels).

Exemple : Voici un exemple de fichier include pour savoir comment copier le numéro d'un projet Google Cloud :

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

Pour en savoir plus, consultez la documentation DevSite Publishing sur l'inclusion de fichiers.

Ajouter une inclusion à votre contenu

Pour ajouter une inclusion à votre page, utilisez une balise include. La balise include insère le contenu du fichier spécifié à l'emplacement de la balise sur votre page.

Voici un exemple de balise d'inclusion pour le fichier exemple de la section précédente :

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

Fichiers de composants migrés

Les extraits de Composer ont été migrés vers le dossier third_party/devsite/workspace/en/_shared/snippets. Si votre contenu utilisait des extraits dans Composer avant d'être migré vers DevSite, vous verrez des balises d'inclusion dans votre contenu, comme dans l'exemple suivant :

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

N'ajoutez pas de nouveaux fichiers include au dossier _shared/snippets.

Publication croisée

Dans DevSite, chaque page appartient à un ensemble de contenu. Devsite ne prend pas en charge la publication croisée utilisée dans Composer, où une page peut être publiée dans plusieurs centres d'aide. Vous pouvez, à la place, créer des liens vers des pages d'autres ensembles de contenus à partir de votre table des matières.

Ajouter une page d'un autre ensemble de contenus à votre navigation

Pour créer un lien vers une page d'un autre ensemble de contenus dans votre navigation, procédez comme suit :

1. Ouvrez le fichier _book.yaml pour votre ensemble de contenus. Le fichier _book.yaml vous permet de gérer la navigation sur votre site.
2. Ajoutez le titre et le chemin racine de la page vers laquelle vous souhaitez créer un lien.

Dans l'exemple suivant, le fichier _book.yaml pour Cloud Search renvoie à un article de l'ensemble de contenus "Continuité des activités".

    - 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
      

Lorsqu'un utilisateur clique sur le lien "Déployer la validation en deux étapes" dans le panneau de navigation Cloud Search, il est redirigé vers la page de la documentation sur la continuité des activités.

Pour savoir comment mettre à jour la navigation sur votre site, consultez Mettre à jour la navigation.