Joomla! Documentation™

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.

Websites

The Documentation Working Group currently maintains the following websites:

api.joomla.org

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.

docs.joomla.org

The concept behind docs.joomla.org 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 help.joomla.org and developer.joomla.org 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.

help.joomla.org

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.

• Joomla! 1.5.x help screens are created on this wiki before being moved to help.joomla.org
• Joomla! 1.0.x help screens Note: These are no longer being maintained.
• Creating a Joomla! 1.5 help screens SQL dump
• Help screens SQL dump files for Joomla! versions up to 1.5.x.

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 you should consult the MediaWiki Handbook for information on using the Wiki software.
• There are some conventions for making sure the Wiki remains organized.

</translate> <translate>

• • Use the Image naming guidelines.
  • Observe the convention for labeling pages with Joomla! version numbers.

</translate> <translate>

• You might want to take a look at

</translate> <translate>

• • the requested but yet empty pages
  • the Cookie jar: a list of pages that have been categorised as being small, well-defined tasks that require minimal commitment to complete
  • Articles that require a review (also awaiting a copy editor)

</translate> <translate>

• • Articles for which information is required: you may be the one that knows certain details
  • Landing pages: pages that match important keywords used by people using search engines to find documentation.

</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

• Documentation Working Group blog
• Public discussion forum
• Developer wiki Note: All useful material has now been moved from this wiki to here.
• Documentation Working Group mailing list
• Developer documentation mailing list
• MediaWiki setup notes
• Help screens white paper proposal for Joomla! 1.6 onwards
• Documentors profile in this wiki.