À propos des éléments réutilisables
Les éléments réutilisables sont de longues chaînes de texte réutilisable, par exemple des paragraphes ou des listes procédurales, qui peuvent être référencées dans plusieurs fichiers de contenu.
Nous utilisons le format Markdown (à la place du YAML) pour les éléments réutilisables. Markdown permet à notre pipeline de localisation de diviser les chaînes en segments à traduire plus petits, ce qui entraîne moins d’erreurs de traduction et moins de modifications à apporter quand le contenu anglais source change.
Chaque élément réutilisable réside dans son propre fichier Markdown.
Le chemin et le nom de fichier de chaque fichier Markdown déterminent son chemin dans l’objet de données. Par exemple, un fichier nommé /data/reusables/foo/bar.md est accessible en tant que {% data reusables.foo.bar %} dans les pages.
Les fichiers réutilisables sont généralement divisés en répertoires par tâche. Par exemple, si vous créez une chaîne réutilisable pour les articles sur les notifications GitHub, vous devez l’ajouter au répertoire data/reusables/notifications/, dans un fichier nommé data/reusables/notifications/YOUR-REUSABLE-NAME.md. La référence de contenu que vous ajoutez à la source ressemble à {% data reusables.notifications.YOUR-REUSABLE-NAME %}.
Application du versioning aux éléments réutilisables
Les éléments réutilisables peuvent inclure des instructions conditionnelles Liquid pour afficher du contenu de manière conditionnelle en fonction de la version actuelle visualisée.
À propos des variables
Les variables sont des chaînes courtes de texte réutilisable.
Nous utilisons des fichiers YAML pour les variables.
Le chemin, le nom de fichier et les clés dans chaque fichier YAML déterminent son chemin dans l’objet de données.
Par exemple, le fichier YAML data/variables/foo/bar.yml contient deux variables :
# the YAML file can contain multiple short strings in one file
meaning_of_life: 42
# the strings can also be nested if needed
nested:
values:
too: Yes!
Les valeurs sont accessibles en tant que {% data foo.bar.meaning_of_life %} et {% data foo.bar.nested.values.too %}.