JDOC

Guide pour le nommage des images

From Joomla! Documentation

This page is a translated version of the page JDOC:Image naming guidelines and the translation is 100% complete.

Other languages:
български • ‎Deutsch • ‎English • ‎español • ‎français • ‎Nederlands

Le guide pour le nommage des images a pour objectif d'offrir, aux contributeurs de la documentation, un ensemble de lignes directrices pour nommer correctement un fichier d'image à charger ne devant PAS être utilisé pour Les écrans d'aide Joomla!. Ces lignes directrices ne sont pas absolues mais données à titre indicatif. Elles doivent être utilisées comme référence pour aider les contributeurs à formater correctement le nom d'un fichier image. Le nommage d'une image devant être utilisée dans la documentation Joomla! n'est pas difficile une fois que vous comprenez la façon dont les images sont traitées et stockées. Certains des avantages de la méthode de stockage d'image Mediawiki sont l'historique des images, les données complémentaires des images et la facilité de la mise à jour des images.

Nommage et Chargement d'une Image

Mediawiki autorise le nommage des images chargées suivant deux méthodes.

  1. Chargement direct d'une image non référencée dans une page, mais qui sera utilisée ultérieurement. Le nom par défaut de l'image sera le nom en "local" (nom dans votre système de fichiers), mais il peut être modifié avant le chargement.
  2. En cliquant sur un lien rouge apparaissant dans une page avec un lien vers l'image du type : [[Image:Name of the image-en.png]] ou [[File:Name of the image-en.png]]
    Name of the image-en.png

Des deux méthodes, cette dernière est la plus simple à utiliser.

Suggestions de type de nommage

Les noms d'images doivent être composés par des mots descriptifs séparés par des tirets bas (underscore _) ou des traits d'union (-). Pensez aux mots comme étant une description sommaire de l'image.

Formats suggérés pour les images Joomla!

Il serait très appréciable que la première partie de toute image Joomla! fasse référence à sa version. Cela permet à toute personne de connaître instantanément quelle version de Joomla! est associée à l'image. Par exemple : j3x ou j25. Il n'est pas conseillé d'insérer le .(point) de la version, veuillez le supprimer.

<jver>-<admin>-<view>.<extension('png' | 'jpg' | 'jpeg' | 'gif')>

Exemples pour les images Joomla!

Une capture d'écran dans l'administration d'un Joomla! 3.x ou 2.5 du gestionnaire d'articles, peut être nommée comme ceci :

j3x_admin_content_article_manager_articles.png
j25-admin-content-article-manager-articles.png

Une capture d'écran d'une vue du module de connexion en front-end pour un Joomla! 3.x ou 2.5, peut être nommée comme ceci :

j3x_site_protostar_log_in_module.png
j25-frontent-beez-20-log_in_module.png

Formats suggérés pour des images autres que Joomla!

Le sens commun et un descriptif sommaire devraient être les guides pour le nommage des images autres que Joomla. Encore une fois, utilisez les tirets bas (underscore _) ou les traits d'union (-) pour séparer les éléments. Pour les images se rapportant à des personnes, veuillez utiliser le nom de cette même personne. Pour les images se rapportant à des logiciels ou des sites web, veuillez les nommer dans l'intitulé.

Exemples pour les images autres que Joomla!

Une demande de pull GitHub, une copie d'écran de l'outil Firebug ou d'autres peuvent être nommées comme ceci :

github-pull-request-how-to.png
eclipse_indigo_interface_egit_browsing_veiw.png
joomla-event-Nov-2013-John-Smith.png
firefox_addon_firebug_colour_picker.png

Ces intitulés sont courts, descriptifs et renseignent rapidement le lecteur sur le contenu de l'image.

Le nommage des images à traduire

Dans le cadre de la préparation à la traduction de la documentation, il est important de prendre en compte le nommage des images pour différentes langues. Depuis l’internationalisation de la documentation, il est nécessaire de proposer à l'utilisateur de la documentation des images dans sa propre langue. Il convient de ne pas utiliser la langue native pour le nommage et la description de l'image. Il est préférable d'ajouter les deux lettres du code langue à la fin du nom et de la description de votre fichier avant de charger l'image.

Les traducteurs de la documentation Joomla! sont invités à lire : Traduction des images. Les traducteurs y trouveront des informations détaillées se rapportant à la traduction des images. Voici les exemples de base :

<jver>-<admin>-<view>-<language code>.<extension('png' | 'jpg' | 'jpeg' | 'gif')>

En reprenant quelques exemples ci-dessus :

j3x_admin_content_article_manager_articles_es.png
j25-admin-content-article-manager-articles-fr.png

Une capture d'écran d'une vue du module de connexion en front-end pour un Joomla! 3.x ou 2.5 peut être nommée comme ceci :

j3x_site_protostar_log_in_module_fr.png
j25-frontent-beez-20-log_in_module-es.png