Joomla! Documentation™

Below is a list of tasks, categorised by intended audience. There will be overlap so treat this as a rough guide only.

Audience: Users/Administrators

Users are visitors to a Joomla! website; administrators are people who install and maintain the website. The assumption is that these people will not know how to write code.

• Help screens.

Audience: Web Designers

Web designers are those people tasked with creating a Joomla! website that will later be looked after by an administrator. These people can be assumed to know about HTML and CSS but may have only minimal knowledge of PHP.

Audience: Core Developers

By "core developers" we mean developers who are contributing to the Joomla! core distribution which includes the core extensions as well as the Framework.

• Developer guidelines.
• Participating in the community: a brief description of how people can get involved.
• Coding style and standards.
• Secure coding guidelines.
• Error message conventions.
• Exception handling.
• Patch submission guidelines.
• Filing bugs/issues.
• How to release a distribution tarball.
• Release numbering, compatibility and deprecation.
• Localisation (L18N): an explanation of how localisation is implemented in Joomla! 1.5 and how to use it.
• Creating custom XML Parameter Types.
• Creating component preferences.
• Adding JavaScript and CSS to the page.
• Accessing the current user object.
• Adding AJAX to your component.
• Using JPagination in your component.
• Creating a toolbar for your component.
• Adding configuration objects to modules and plugins.
• Storing data in the session between page loads.
• Using the caching system in your component.
• Creating a file uploader in your component.
• Suppressing output of extra HTML.
• Supporting plugins in your component.
• Adding Multi-language support.
• Retrieving data from the GET and POST requests - the Joomla! way.
• Adding view layout configuration parameters.
• Using the installer API to support package installation.

Audience: Third-party Developers

By "third-party developers" we mean developers who are working on extensions to Joomla! (components, modules, plugins and templates) which are made available separately from the Joomla! distribution.

• Complete/update the wiki API reference (assumes this has been moved from DocuWiki to MediaWiki).
• Create/update developer tutorials and how-to's (there's a list somewhere).
• How to debug your code.

Audience: Testers

These people may be testing functionality from a user perspective; or they may be developers testing the code itself.

• Automated testing.

Audience: Various

Stuff that pertains to multiple audiences.

• Template tutorials project.
• Integrate GHOP student work

Audience: Documentors

This is meta documentation for use by the Documentation Working Group and other documentors.

License

<translate> License</translate>

<translate> The contents of this wiki are subject to copyright law and are made available under the Joomla! Electronic Documentation License (JEDL) unless otherwise stated. You may find the JEDL Frequently Asked Questions useful in determining if your proposed use of this material is allowed. If you have any questions regarding licensing of this material please contact legal@opensourcematters.org. If you wish to report a possible violation of the license terms for the material on this site then please contact legal@opensourcematters.org.</translate>