Joomla! Documentation™

En tant que documentaliste, vous avez la tâche ingrate de créer du matériel pour un large éventail de lecteurs, de l'utilisateur débutant au développeur professionnel. Vous devrez savoir comment utiliser divers outils (comme ce wiki) et lire les directives et autres méta documents. Il vous faudra également probablement mettre à jour ces documents au fil du temps.

Général

La langue officielle du Projet est l'anglais britannique. L'orthographe américaine a tendance à se glisser dans la documentation. N'hésitez pas à apporter les corrections nécessaires.

Le matériel suivant est important pour les documentalistes travaillant dans tous domaines du Projet Joomla.

• Veuillez consulter le Guide des styles éditoriaux Joomla!.
• Termes à consulter

Documentation Wiki

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.

Écrans d'aide

Le Documentation Working Group (groupe de travail pour la documentation) est responsable de l'écriture et la maintenance des écrans d'aide officiels. Pour les versions jusqu'à Joomla! 1.5.x incluse, les écrans d'aide étaient hébergés sur une instance de Joomla. A partir de Joomla! 1.6, les écrans d'aide sont hébergés sur le présent wiki.

• Voir la catégorie sur les écrans d'aide.
• Configuration d'un serveur local d'aide
• Help screens SQL dump files for Joomla! versions up to 1.5.x.