Documentation Working Group
From Joomla! Documentation
The Documentation Team is Part of the Production Working Group. It 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 English. Translations of the official documentation into other languages are the responsibility of the Documentation Translation Team (JDT).
Joomla! Documentation Wiki
The bulk of the documentation effort now revolves around this wiki.
- 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.
- Try to use the Image naming convention.
- Try to observe the convention for labelling pages with Joomla! version numbers.
- You might want to take a look at
- 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)
- 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.
- 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.
- List of local wiki templates that can be used in your wiki pages. Templates reduce repetition and are the basis of modular documentation.
- List of local wiki extensions that have been installed on this wiki. Extensions provide additionally functionality to the wiki such as syntax highlighting and conditional expressions.
- List of local interwiki links that are available on this wiki. These provide useful shortcuts to creating URLs to other websites including the Joomla! forum, help screens and issue tracker; as well as links to the PHP documentation or Wikipedia.
All Documentation Websites
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 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.
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.
Other Public Resources
- Public discussion forum
- Documentation Working Group mailing list
- Developer documentation mailing list
- The Documentation Working Group on the Joomla! Volunteers Portal™
- The Documentation Translation Team on the Joomla! Volunteers Portal™
- Documentation Translators
- MediaWiki setup notes
- Documentors profile in this wiki.