Joomla! Documentation™

Cet article explique comment utiliser des "chunks" lors de la rédaction d'écrans d'aide pour Joomla. Notez que nous n'utilisons qu'un seul jeu d'écrans d'aide pour toute la série. Cela signifie que les écrans d'aide utiliseront tous 'Chunk30', 'Chunk4x'. Les exemples montrent la version 3.

Qu'est-ce qu'un "chunk" ?

Dans le jargon de MediaWiki, un chunk est un élément de contenu réutilisable. Pour les écrans d'aide, nous utilisons des morceaux pour le texte qui apparaîtra plusieurs fois dans les écrans d'aide.

Par exemple, nous avons une colonne appelée "Catégorie" dans la rubrique

1. Articles
2. Bannières
3. Contacts
4. Flux d'informations
5. Notes de l'utilisateur
6. Liens web

Dans chacun de ces écrans, la colonne Catégorie indique la catégorie de l'élément. Ainsi, au lieu de copier et coller le même texte dans ces différents écrans d'aide, nous créons un "chunk" pour cela.

L'avantage de cette approche est que nous pouvons modifier et améliorer cette partie en un seul endroit et que la nouvelle version s'affichera automatiquement sur chaque écran.

Utilisation d'un Chunk existant

La syntaxe pour inclure un chunk existant est la suivante :

{{Chunk30:Help_screen_column_header_Category}}

La syntaxe pour rendre le chunk prêt à être traduit :

{{Chunk30:Help_screen_column_header_Category/<translate>en</translate>}}

==Création d'un nouveau chunk====.

Avant de créer un nouveau chunk, vérifiez s'il n'existe pas déjà. Vous pouvez obtenir une liste complète des chunk utilisés.

• Chunk30 page
• Chunk4x page.

Vous pouvez accéder à cette page en cliquant sur le lien "Pages spéciales" dans le menu de la boîte à outils :

1. Dans la 2ème section (Liste des pages) cliquez sur Toutes les pages avec préfixe
2. Sélectionnez l'espace de nommage souhaité (par exemple, "Chunk30", "Chunk4x") dans la zone de saisie déroulante.
3. Appuyez ensuite sur le bouton "Show" pour afficher la liste de toutes les pages de l'espace de noms.

Il est facile de créer un nouveau chunk. Cependant, veillez à respecter la convention de dénomination afin que d'autres puissent réutiliser vos chunks.

Les étapes de la création d'un nouveau chunk sont les suivantes :

1. Entrez le chunk dans un article, comme vous le feriez pour un chunk existant. Par exemple :
   {{Chunk30:Help_screen_column_header_My_New_Chunk}}
2. Pour prévisualiser l'article, faites défiler l'écran jusqu'en bas et cliquez sur 'Templates utilisés sur cette page'. Le nouveau chunk apparaîtra en rouge sous "Templates utilisés dans cet aperçu" comme dans l'exemple ci-dessous
   
3. Ouvrez le lien d'édition dans une nouvelle fenêtre de navigation. (Sinon, vous risquez de perdre vos modifications sur l'article que vous êtes en train d'éditer). Vous accéderez à un écran où vous pourrez saisir le texte de ce chunk. C'est comme pour l'édition de n'importe quel autre article du wiki.
4. Une fois que vous avez saisi et enregistré le texte du chunk, revenez à votre article original et cliquez à nouveau sur "Aperçu". Vous devriez maintenant voir le chunk s'afficher sous forme de texte normal.

Conventions de nommage

L'idée principale des conventions de nommage est d'être cohérent dans la manière de nommer les chunks afin d'éviter les doublons. Voici quelques lignes directrices :

• Pour les éléments qui apparaissent dans l'en-tête de colonne d'un écran de gestionnaire, utilisez le nom exact de l'en-tête de colonne (par exemple, "Accès", "Créé par", etc.).
• Utiliser généralement les initiales en majuscule.
• Dans de nombreux cas, nous avons le même nom pour une valeur dans un en-tête de colonne que lorsque nous saisissons la valeur dans un écran d'édition (par exemple, "Catégorie" ou "Titre"). Dans ces cas, nous avons besoin d'un texte d'aide différent pour la valeur en tant que colonne et la valeur en tant qu'entrée.
  La convention est d'utiliser le nom de la colonne lorsque la valeur apparaît dans une liste de gestionnaires (par exemple, Catégorie) et le mot "Entrée" devant lorsque la valeur est éditée (par exemple, Entrer Catégorie).

Astuces

• Si vous n'êtes pas sûr que ce bloc sera utilisé ailleurs, vous n'avez pas besoin de vous préoccuper de la création d'un chunk. Saisissez simplement le texte. Il est facile de revenir en arrière et de convertir le texte en chunks si nécessaire.
• Vérifiez les chunks existants avant d'en créer un nouveau. Utilisez également les chunks existants comme guide pour la dénomination et les autres conventions lors de la création de nouveaux chunks.
• N'ayez pas peur de faire des erreurs ! L'avantage du wiki, c'est que l'on peut facilement mettre de l'ordre plus tard. L'essentiel est d'avoir un contenu utile dans les écrans d'aide pour aider les utilisateurs avec Joomla.