JDOC

Comment contribuer à la documentation Joomla! ?

From Joomla! Documentation

This page is a translated version of the page JDOC:How to Contribute to Joomla! Documentation and the translation is 100% complete.

Other languages:
বাংলা • ‎English • ‎español • ‎فارسی • ‎français • ‎हिन्दी • ‎Bahasa Indonesia • ‎Nederlands • ‎português • ‎português do Brasil • ‎Türkçe

La Documentation Joomla! est propulsée par le même logiciel utilisé par Wikipedia. Sa croissance et sa réussite dépendent uniquement de personnes comme vous. Merci de gravir cette première marche en contribuant ainsi au Projet Joomla. Cette page vous indique comment bien commencer et les différentes façons d'aider au travail de documentation.

Bien commencer

Il y a certaines choses qu'il convient de faire en premier lieu :

Lire les principes directeurs du Wiki

Pour participer à la documentation Joomla, il est indispensable de consulter les principes directeurs du Wiki avant même de commencer à contribuer.

Créer un compte utilisateur

Pour pouvoir éditer la documentation Wiki de Joomla, vous avez besoin d'un compte utilisateur. Vous pouvez vous enregistrer ici. Ensuite, assurez-vous de bien avoir confirmé votre adresse e-mail. Cette confirmation de votre adresse vous donnera la permission de modifier n'importe quelle page, sauf celles qui sont protégées.

Créer une page utilisateur

Après avoir créé un compte, avoir confirmé votre adresse e-mail et vous être connecté, il vous faut créer une page utilisateur. Quelques astuces pour accéder rapidement à votre page utilisateur :
  • Dans le menu utilisateur rendez-vous sur votre page utilisateur (ou utilisez le premier élément du menu déroulant de droite).
  • Cliquez sur le bouton du menu déroulant
    JDOCS-actions-create-page-fr.png
  • Cliquez sur Modifier
  • Ajoutez le code dans l'éditeur {{subst:Newuser}}
  • Renseignez le résumé (par exemple, "Ceci est ma nouvelle page utilisateur")
    JDOCS-summary-form-input-fr.png
  • Cliquez sur le bouton Enregistrer

Rejoignez la liste de diffusion pour la Documentation

Il est conseillé de rejoindre la liste de diffusion pour la Documentation. Ce n'est pas une obligation cependant vous pourrez y consulter les discussions qui sont relatives à la documentation.

Par où dois-je commencer ?

Il existe plusieurs domaines de la documentation qui nécessitent une attention particulière. Vous pouvez commencer en en choisissant un avec lequel vous vous sentez le plus à l'aise de travailler ou vous pouvez vous impliquer plus encore en travaillant sur plusieurs à la fois. Une fois que vous disposez d'un compte wiki et en fonction de vos désirs, vous êtes libre de travailler sur n'importe quel aspect de la documentation. Toutes les contributions, aussi simples soient-elles comme les corrections d'orthographe et de grammaire, sont d'une très grande aide !

  1. Aider à gérer le contenu.
  2. Participer à la maintenance Wiki.
  3. Rejoindre ou lancer un projet de documentation.
  4. Les écrans d'aide.

Aider à gérer le contenu

  1. Édition, réécriture et réorganisation des pages. Consultez notre catégorie Pages en attente pour connaitre les pages qui ont besoins d'être révisées au plus vite. Elles sont nommées 'Pages en attente' car elles nécessitent des tâches mineures afin d'être complètes. Certaines actions sont aussi simples que de relire le contenu ou d'ajouter d'une image. D'autres exigent plus de contenu ou des améliorations. Cherchez un peu et vous trouverez votre bonheur. C'est une aide inestimable pour les utilisateurs Joomla! qui comptent sur notre documentation.
  2. Amusez-vous à rechercher les articles redondants, qui ne sont plus concernés par les versions courantes (ceux pour 1.0 et 1.5), ou ceux qui doivent-être divisés en fonction d'informations spécifiques à certaines versions. Alors n'hésitez pas à faire usage des templates {{delete}}, {{merge}} ou {{JSplit}} des articles. Cliquez sur les liens de template précédents pour voir comment les utiliser et les appliquer à des articles qui ont besoin de ces marqueurs de templates. Ajoutez-les tout en haut de page et la page sera marquée.
  3. Créer une nouvelle page ou un didacticiel.. Avant de commencer une nouvelle page, faites quelques recherches approfondies. Essayez de ne pas créer un nouvel article s'il en existe déjà un en relation. Vous pouvez utiliser la fonction de recherche de la documentation Wiki pour voir si votre sujet est déjà traité dans un article. Les doublons seront fusionnés et/ou supprimés. N'ayez pas peur de modifier, de reformater et d'apporter des améliorations au travail de quelqu'un d'autre sur la Documentation Wiki pour Joomla. La documentation wiki est un outil collaboratif, assurez-vous de suivre nos lignes directrices et autres politiques.
    1. Utilisation des liens Wiki. Il est très facile de créer des liens vers d'autres pages wiki en utilisant une syntaxe standard. Si vous créez un lien vers un article qui n'existe pas encore, le lien sera de couleur rouge. En cliquant sur un lien rouge, vous arriverez sur la page de modification du nouvel article. Indiquez simplement votre texte, cliquez sur Publier et le nouvel article sera créé dans la foulée. Une fois l'article créé, le lien passera du rouge au bleu indiquant qu'un article existe dorénavant derrière ce lien.
    2. Utilisation d'une URL. A utiliser lorsque vous souhaitez créer une nouvelle page depuis 0. Vous pouvez utiliser l'URL du wiki pour créer un nouvel article. L'URL d'un article du wiki a généralement cette forme : https://docs.joomla.org/YOURTITLE. Si vous remplacez YOURTITLE avec le nom de la page que vous souhaitez créer, vous serez dirigé vers une page blanche qui indique qu'aucun article de ce nom existe à l'heure actuelle. En cliquant sur le lien créer cette page, vous basculerez sur la page d'édition de cet article, où vous pouvez créer la nouvelle page en tapant votre texte puis cliquer sur Enregistrer.
  4. Aider à mettre à jour les images des articles. Vérifiez la catégorie images ayant besoin de mises à jour pour obtenir une liste des pages qui ont besoin que leurs images soient mises à jour. Nos propositions de lignes directrices afin de vous aider sont disponibles dans l'article guide pour le nommage des images.


La maintenance Wiki

La maintenance d'un Wiki et notamment le fait de le conserver ordonné et organisé demande une masse de travail très importante et continue aux administrateurs, aux éditeurs et aux utilisateurs. Il y a toujours des tâches nécessitant une attention particulière telles que : la catégorisation, les pages nécessitant une action, qui sont en cours d'édition, ou encore pour le marquage des pages à supprimer, à fusionner ou à fractionner. Pour entreprendre toutes ces tâches de maintenance et avoir une idée sur comment aider vous pouvez consulter : Page de documentation pour la maintenance.

Les projets de documentation

Les écrans d'aide

Même si peu de personnes le savent, toutes les pages d'écran d'aide sont créées et diffusées à l'ensemble des installations de Joomla! dans le monde à partir du wiki ! Elles sont nécessaires aux débutants comme à ceux ayant une connaissance intermédiaire de Joomla.

Les écrans d'aide pour Joomla! 3.x sont complets mais ceux pour Joomla! 3.7 sont encore en cours d'élaboration ! Vos contributions seront appréciés par nombre d'utilisateurs de par le monde. Vous pouvez trouver la matrice des écrans d'aide 3.x ici. Certains nécessitent juste d'être relus ou marqués comme complétés, d'autres doivent être écrits, complétés, agrémentés d'images (800px largeur max.), etc.
  • Les écrans d'aide pour Joomla! 4.x doivent être créés. Toute contribution sera grandement appréciée par nombre d'utilisateurs de par le monde. Nous recherchons des bénévoles pour aider à cette importante tâche. Une matrice sera mise en place ainsi qu'un plan d'action.


Les choses à retenir

Voici quelques éléments à retenir en qualité de contributeur à la documentation Joomla.

  • N'ayez pas peur de casser une page, si cela vous arrive et que quelque chose s'est mal passé, annulez votre modification. Sur la page, cliquez sur l'onglet Historique et vous verrez les liens à annuler et revenir en arrière.
  • Écrivez des article en gardant à l'esprit qu'ils seront traduits dans d'autres langues. L'argot ou un dialecte local ne pourra probablement pas être traduit dans d'autres langues ou sera mal interprété.
  • N'hésitez pas à télécharger et lire le Guide des styles rédactionnels (PDF) qui s'applique à toute la documentation Joomla. Vous y trouverez des conseils utiles sur la façon d'écrire pour la documentation Joomla.
  • Lors de l'écriture, soyez attentif à la casse et l'orthographe de certains termes, lisez le guide complet … ou pour une vérification instantanée, utilisez les navigateurs Google Chrome ou Mozilla Firefox. Ils possèdent tous deux un correcteur d'orthographe intégré mettant en évidence les termes mal orthographiés.
  • N'oubliez pas d'ajouter template {{inuse}} à l'article sur lequel vous allez travailler pendant un certain temps, plus d'une minute. Cela évitera des conflits de modification.

Aidez-moi, je ne connais pas la syntaxe Wiki !

Si vous êtes débutant dans l'utilisation de Wikis et du balisage simple pour créer des pages, alors vous pouvez consulter ce qui suit pour obtenir de l'aide.

  • Le nouvel éditeur Wiki comporte des boutons et des liens rapides pour faciliter la mise en page. Cliquez sur le terme 'Avancé pour afficher une liste déroulante contenant plus de boutons et la mise en forme des liens rapides.
  • Utilisez l'antisèche Wiki de la JDOC pour apprendre les commandes de syntaxe de base. Vous trouverez également une liste déroulante contenant les balises communes de l'éditeur. Cliquez sur 'Aide' pour l'afficher.
  • Toujours effrayé ? Alors, essayez ces outils pour vous aider à créer de belles pages wiki.
  • Add-on pour Microsoft Word pour le Wiki Markup, sauvegarde des documents word au format Wiki Markup.
  • OpenOffice.org versions 2.4 et postérieures contient un filtre d'exportation natif MediaWiki. Ouvrez un document Texte et cliquez sur Fichier - Exporter. Puis, changez le format du fichier en MediaWiki.
  • Voici une liste des outils disponibles permettant de convertir d'autres formats en wiki markup, par exemple, HTML, Excel, CSV. Certains sont des convertisseurs en ligne, coupez et collez le HTML pour obtenir un rendu wiki markup.
  • Obtenez de l'aide sur Glip (il existe deux groupes : le Jdocs Translation Group et le JDocs Working group).
  • Postez une question sur une des pages de discussion de l'administrateur ou de l'éditeur.