Joomla! Documentation™

Groupe de Travail de la Documentation

L'équipe pour la documentation (Documentation Team) fait partie intégrante du Département de la Production. Elle est responsable de la création et du suivi de toute la documentation officielle de Joomla! et y compris pour les utilisateurs finaux, les administrateurs et/ou les développeurs tiers, ainsi que des écrans d'aide du backend du CMS Joomla.

L'équipe sur Joomla! Volunteers Portal.

Sous-équipes de la Documentation

Equipes des écrans d'aide de la documentation

L'équipe de la documentation pour les écrans d'aide est en charge du suivi et de la mise à jour des écrans d'aide pour les différentes versions de Joomla.

Equipe de traduction de la Documentation

La langue officielle de la documentation est l'anglais britannique. Les traductions de la documentation officielle dans d'autres langues sont de la responsabilité de l'équipe pour la traduction de la documentation : Documentation Translation Team (JDT).

Groupe de travail sur les textes en-GB d'interfaces utilisateurs

L'équipe Joomla! en-GB User Interface Text Guidelines est en charge d'établir et maintenir les lignes directrices de style pour écrire les textes de langue en-GB (anglaise) et d'assurer une cohérence dans Joomla!.

Documentation Wiki Joomla!

La majeure partie de l'effort du groupe de travail pour la documentation s’oriente désormais autour de ce wiki.

• Veuillez vous référer à la feuille de route Wiki pour la documentation pour un aperçu complet des tâches.
• Si vous débutez avec MediaWiki, il serait intéressant de consulter le guide de l'utilisateur pour plus d'informations sur le logiciel wiki.
• Il existe certaines conventions pour que le Wiki reste organisé correctement.

• • Essayez de respecter le Guide pour le nommage des images.
  • Ainsi que la convention de nommage pour les versions Joomla!.

• Vous pourriez souhaiter jeter un œil à :
  • les pages demandées mais actuellement vides,
  • la boîte à Cookies qui est une liste d’articles catégorisés comme nécessitant des actions simples et définies pour qu'ils soient complets,
  • Articles ayant besoin d'une révision,
  • Articles pour lesquels des informations complémentaires sont requises : vous pouvez être celui qui détient ces information,
  • les Pages de destination qui sont celles contenant des mots clés importants utilisés dans les moteurs de recherche de la documentation.
• Les pages qui définissent des termes peuvent être ajoutées au Glossaire, mais non pas en ajoutant [[Category:Glossary]] à la page. Veuillez consulter Talk:Glossary pour plus d'informations.

Références internes

• Liste des local wiki templates pouvant être utilisés dans les pages du Wiki. Les templates réduisent le nombre de répétitions et sont la base d'une documentation modulaire.
• Liste des local wiki extensions ayant été installées sur ce Wiki. Les extensions permettent de fournir des fonctionnalités supplémentaires au Wiki de base comme la syntax highlighting ou link search.
• Liste des local interwiki links disponibles sur le Wiki. Ceux-ci fournissent des raccourcis très utiles pour créer des URLs vers d'autres sites web, y compris ceux du Forum de la Communauté Joomla, les écrans d'aide et l'outil de suivi pour les anomalies, ainsi que les liens vers la documentation PHP ou encore Wikipedia.

Les sites de documentation

Le groupe de travail pour la documentation (Documentation Working Group) gère actuellement les sites suivants :

api.joomla.org

L'ensemble de ce site est généré automatiquement par le package phpDocumentor à partir d'une analyse du code source Joomla! et en utilisant le formatage des commentaires incorporés dans le code source lui-même. C'est un outil inestimable pour tous les développeurs Joomla.

docs.joomla.org

Le concept derrière docs.joomla.org est d'offrir un outil de ressource centrale pour le développement de ressources uniques modulaires pour l'ensemble du Projet Joomla. L'idée est de rédiger une seule fois un élément pouvant être ré-utilisé dans une autre entité, de façon analogue à la programmation orientée objet dans nos logiciels modernes. Dans un avenir proche, nous souhaitons que d'autres sites, tels que developer.joomla.org, s'enrichiront en grande partie du contenu provenant de ce site. Par la construction d'une base de données centrale pour la documentation en la sectorisant en "morceaux" nous pouvons bénéficier au maximum des efforts d'un nombre limité d'auteurs où un seul changement sera rapidement propagé à tous les documents dérivés et affectés.

Les personnes intéressées par les techniques trouveront plus d'informations ici.

Those of you, who are not very experienced in image editing and might want to improve the quality of their screenshots should read the tutorial Taking Screenshots – How To Enhance.

Le site officiel d'aide abrite une grande partie de notre documentation de départ incluant celle pour la version 1.0.x de Joomla, les écrans d'aide pour toutes les versions Joomla! et le guide d'installation pour Joomla! 1.5.

• Écrans d'aide pour Joomla! 1.5.x sont créés en premier lieu sur ce wiki avant d'être transférés sur help.joomla.org
• Écrans d'aide pour Joomla! 1.0.x Remarque : ces versions ne font plus l'objet de maintenance.

Les autres ressources publiques

• Forum de discussion
• liste de diffusion du Documentation Working Group
• liste de diffusion de la Documentation pour les développeurs
• Le Documentation Working Group sur le Joomla! Volunteers Portal™
• La Documentation Translation Team sur le Joomla! Volunteers Portal™
• Documentation Translators
• Notes de configuration pour MediaWiki
• Documentalistes profile pour ce wiki.