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:
Bahasa Indonesia • ‎Deutsch • ‎English • ‎Nederlands • ‎Türkçe • ‎eesti • ‎español • ‎français • ‎italiano • ‎português • ‎português do Brasil • ‎Ελληνικά • ‎فارسی • ‎हिन्दी • ‎বাংলা • ‎中文(台灣)‎ • ‎日本語

La documentation de Joomla! est alimentée par MediaWiki. Sa croissance et son succès dépendent de personnes comme vous. Merci de faire le premier pas pour contribuer au projet Joomla ! Cette page vous montrera comment commencer et plusieurs façons de contribuer à l'effort de documentation.

Bien commencer

Vous devez d'abord procéder à quelques vérifications.

Lire la politique du wiki

Vous devez consulter les documents de Joomla! Politique du wiki avant de commencer à les modifier.

Créer un compte d'utilisateur

Pour modifier le wiki de documentation de Joomla! vous aurez besoin d'un compte d'utilisateur. Vous pouvez s'inscrire ici. Ensuite, veillez à confirmer votre adresse e-mail. La confirmation de votre adresse e-mail vous donnera la permission d'éditer n'importe quelle page, à l'exception de quelques unes qui sont protégées.

Remarque : Si vous ne faites aucune modification dans les 5 jours suivant la création de votre compte, votre compte sera alors automatiquement supprimé pour des raisons de sécurité.

Créer une page utilisateur

Après avoir créé un compte, confirmé votre adresse électronique et vous être connecté, nous vous recommandons de prendre quelques instants pour créer une page utilisateur. La création d'une page utilisateur a plusieurs objectifs :

  • Elle permet aux utilisateurs d'en savoir plus sur vous.
  • Elle vous permet de faire quelques modifications initiales afin que le Filtre pour les spammeurs et les abus du wiki puisse voir que vous n'êtes pas un faux utilisateur. Notez que pour vos premières éditions, n'incluez pas de liens externes car c'est ce qui est le plus susceptible de déclencher les filtres.

Une astuce rapide pour démarrer votre page utilisateur :

  • Dans le menu utilisateur, allez sur votre page Nom d'utilisateur (ou utilisez le premier élément de menu sur le menu déroulant de droite).
  • Cliquez sur le bouton déroulant des actions
    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 les canaux de communication de la documentation

L'outil de communication officiel de Joomla est Mattermost. Voir cette page Vous y trouverez des informations sur la manière de participer à la conversation et, une fois que vous y serez, vous pourrez rejoindre le canal PD Documentation pour participer à la discussion sur la documentation de Joomla!

Par où dois-je commencer ?

Il y a plusieurs domaines de la documentation qui nécessitent toujours une attention particulière. Vous pouvez commencer par choisir celui sur lequel vous vous sentez le plus à l'aise ou vous pouvez vous impliquer davantage en travaillant sur plusieurs domaines à la fois. Une fois que vous avez un compte Wiki, vous êtes libre de travailler sur n'importe quel aspect de la documentation qui vous intéresse. Même les contributions les plus simples, telles que les corrections orthographiques et grammaticales, sont d'une aide précieuse !

  1. Aide au contenu de la documentation.
  2. Tâches de maintenance.
  3. Joindre ou démarrer un projet de documentation.
  4. Aide avec les écrans d'aide.
  5. La traduction de page expliquée.

Aider à gérer le contenu

  1. Édition, réécriture et réorganisation des pages. Consultez nos Pages en attente pour les domaines nécessitant une aide immédiate. Elles sont appelées "Pages en attente" parce qu'elles ont besoin d'être complétées par de petites tâches. Certaines d'entre elles sont aussi simples qu'une révision du contenu ou l'ajout d'une image. D'autres nécessitent plus de contenu ou des améliorations. Choisissez-en quelques-unes et donnez-leur un peu d'amour. C'est une aide précieuse pour les utilisateurs de Joomla ! qui se fient à notre documentation.
  2. Amusez-vous et cherchez les articles qui sont redondants, hors version (i.e. 1.0 et 1.5), ou qui ont besoin d'être séparés à cause d'informations spécifiques à la version. N'hésitez pas à utiliser les modèles {{delete}}, {{merge}} ou {{JSplit}} sur ces articles. Cliquez sur les liens des modèles précédents pour voir comment les utiliser et les appliquer aux articles qui, selon vous, ont besoin de ces modèles de marqueurs. Ajoutez-les tout en haut d'une page et la page sera marquée.
  3. Créer une nouvelle page ou un nouveau tutoriel.. 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 et l'organisation d'un wiki nécessitent un travail continu de la part des administrateurs, des éditeurs et des utilisateurs. Il y a toujours des tâches qui requièrent de l'attention, telles que : la catégorisation, s'occuper des pages qui nécessitent des interventions, qui sont en construction, ou en marquant des pages pour suppression, fusion ou division. Pour toutes les tâches de maintenance et des idées sur la façon dont vous pouvez aider, veuillez visiter notre page de documentation de 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 de Joomla ! 4.x ont besoin d'être révisés et mis à jour. Toute contribution que vous leur apporterez sera appréciée par de nombreux utilisateurs dans le monde entier et nous recherchons des volontaires pour nous aider dans cette tâche importante. Une matrice doit être 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 d'interrompre une page, si vous le faites et que quelque chose s'est vraiment mal passé, revenez sur votre modification. Cliquez sur l'onglet Historique de la page et vous verrez des liens pour annuler et revenir en arrière.
  • Rédigez des articles en pensant qu'ils seront traduits dans une autre langue. L'utilisation de l'argot ou du dialecte local risque de ne pas être traduit dans une autre langue ou de ne pas être compris. En savoir plus sur laTraduction de la documentation de Joomla.
  • N'hésitez pas à télécharger et lire le Guide des styles rédactionnels Joomla! en-GB qui s'applique à toute la documentation Joomla!. Vous y trouverez des conseils utiles sur la façon d'écrire pour la documentation Joomla!.
  • Mots à surveiller lors de l'écriture pour un retour d'information instantané, utilisez les navigateurs Google Chrome ou Mozilla Firefox. Ils disposent tous deux d'un correcteur orthographique intégré qui souligne les mots mal orthographiés.
  • N'oubliez pas d'ajouter le template {{inuse}} à un article sur lequel vous allez travailler pendant une longue période, plus d'une minute. Cela permet d'éviter les conflits d'édition.

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

Si vous êtes novice dans l'utilisation des wikis et du balisage simple pour créer des pages, utilisez ce qui suit pour vous aider.

  • Le nouveau WikiEditor contient des boutons et des liens rapides pour faciliter la construction des pages. Cliquez sur le mot Avancé pour obtenir une liste déroulante de boutons et de liens de formatage rapide.
  • Utilisez l'Aide-mémoire du Wiki de JDOC pour apprendre les commandes syntaxiques de base. Il y a aussi une liste déroulante des balises courantes dans l'éditeur. Il suffit de cliquer une fois sur le mot Aide pour qu'il apparaisse.
  • Vous avez encore peur ? Essayez ces outils pour vous aider à créer de superbes pages Wiki.
  • Microsoft Word Complément pour le balisage Wiki, enregistrez des documents Word dans Wiki Markup.
  • OpenOffice.org versions 2.4 et ultérieures ont un filtre d'exportation MediaWiki intégré. Il suffit d'ouvrir un document Writer et de cliquer sur Fichier - Exporter. Ensuite, changez le format de fichier en MediaWiki.

Il existe une liste des outils disponible pour convertir d'autres formats en balises Wiki, par exemple HTML, Excel, CSV. Certains d'entre eux sont des convertisseurs en ligne, qui permettent de couper et de coller du HTML pour obtenir une sortie en balisage Wiki.

  • Obtenez de l'aide sur Mattermost (Nous avons beaucoup de canaux sur ce site. Par exemple, un pour le groupe de traduction JDocs et un pour le groupe de travail JDocs).
  • Poser une question sur une page de discussion administrator's ou editor's.