Documentation Working Group

From Joomla! Documentation

Revision as of 14:37, 19 August 2008 by Marieke92 (Talk | contribs)

The Documentation Working Group is responsible for creating and maintaining all the official Joomla! documentation including that for end-users, administrators and third-party developers. We also maintain the help screens for the Joomla! releases.

The official documentation language is British/Australian. Translations of the official documentation into other languages are the responsibility of the Translations Working Group.


The Documentation Working Group currently maintains the following websites:

This entire site is automatically generated by the phpDocumentor package from an analysis of the Joomla! source code and making use of specially formatted comments embedded in the source code itself. It is an invaluable tool for all Joomla! developers.

The concept behind is that it will become the central resource for developing single-source modular documentation within the Joomla! project. The idea is that we write stuff once then re-use it in a somewhat analogous way to modern OOP software development. In the future we expect that other sites, such as and will contain some, or even most, of their content derived from sources here. By building a central database of document "chunks" we gain maximum benefit from the efforts of a limited number of authors and we produce "agile" documents where a single change is rapidly propagated to all the derived documents affected.

Those interested in the techniques will find more information here.

The official help site houses much of our early documentation, including that for Joomla! 1.0.x, the help screens for all Joomla! versions and the Joomla! 1.5 Installation Guide.

Documentation wiki

<translate> The bulk of the documentation effort now revolves around this wiki. </translate> <translate>

  • Please refer to the Docs Wiki Roadmap for a complete overview of tasks.
  • If you are new to MediaWiki then you should consult the User's Guide for information on using the wiki software.
  • There are some conventions for making sure the Wiki remains organized.

</translate> <translate>

</translate> <translate>

  • You might want to take a look at

</translate> <translate>

</translate> <translate>

</translate> <translate>

  • Pages that define terms can be added to the Glossary, but not by adding [[Category:Glossary]] to the page. Please see Talk:Glossary for more information.

</translate> <translate>

Internal References

</translate> {{JDOC:Local wiki references/<translate> en</translate>}}

Other public resources