Difference between revisions of "Joomla! Doc Sprints/Start Here"

Revision as of 18:47, 14 January 2008

Instructions

Below is a list of tasks, categorised by intended audience. There will be overlap so treat this as a rough guide only. Please feel free to add new topics to this list.

To start writing on a topic, change the item in this list into a link (unless it's already a link of course!). To do this you simply surround the text by a pair of square brackets. For example, to make "text" into a link, change it to "[[text]]". Save your change. The link text should now appear in red. Click on this new link and you will be taken to an editor screen for the new page. Enter your new topic text and click save. Simple as that. If you encounter any problems, ask for help on the IRC channel.

When you begin editing a page please consider adding an {{inuse}} template call while you are working on it so that others do not create conflicting changes to the same page. And don't forget to remove it again when you've finished!

Reference Information

If you are new to MediaWiki then you should consult the User's Guide for information on using the wiki software.
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.
Please read the Joomla! Editorial Style Guide.

Audience: Users/Administrators[edit]

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.

Installation notes for specific platforms
Help screens.
Marketing Information such as features and benefits.
Create one or more demo/showcase sites then create tutorials explaining how each was put together. For inspiration see: [1]
Absolute Beginners Guide to Joomla!
Landing Pages for this wiki.

Audience: Web Designers[edit]

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.

Creating clickable background images using CSS.
There is quite a lot for web designers in the Joomla! 1.5 Template Tutorials Project.

Audience: Core Developers[edit]

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.
Routing: how it works and how to use it

Audience: Third-party Developers[edit]

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/review the wiki API reference (assumes this has been moved from DocuWiki to MediaWiki).
Update developer tutorials and how-to's currently on dev.joomla.org
How to debug your code.
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 (frontend and backend).
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.
How to Create an XML-RPC plugin
How and when to use the filesystem package
How to use the Filter Package
How to use the Registry Package
How to Use JSimpleXML
How to Use JDate
How to add CSRF Anti-Spoofing to Forms
How to Add Breadcrumbs
How to Use the JTable class
How to create Component Feeds (RSS/ATOM)
How to Create PDF Views
How to Send Email From Components
What's Available in the JFactory Class
How to Generate Paths for Client side and Server side
How to Access Information from the Request/Browser
How to Create a Search Plugin
How to Create a Content Plugin
How to Create an Editor Plugin
How to Create a System Plugin
What can be done with a User Plugin
How to Create a Module
How to Create a Stand-Alone Application Using the Joomla! Framework
How to Work With Parameters
How to Use the JToolBar Class in the Frontend
How to Create a Custom Button
How to use the Editor in a Custom Component
How to use the JPane Classes in a Custom Component
How to Cloak Email Addresses

Audience: Testers[edit]

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

Automated testing.

Audience: Various[edit]

Stuff that pertains to multiple audiences.

Joomla! 1.5 Template Tutorials Project
Integrate GHOP student work
Landing pages in this wiki
Pages that define terms can be added to the Glossary category by adding [[Category:Glossary]] at the end of the page.

Audience: Documentors[edit]

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

MediaWiki setup notes

License[edit]

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

@@ Line 38: / Line 38: @@
 * Creating clickable background images using CSS.
-* There will be quite a lot for web designers in the [http://www.developer.joomla.org/wiki/Joomla%21_1.5_Template_Tutorials_Project Joomla! 1.5 Template Tutorials Project].  This will be moved into this wiki soon, but please feel free to start filling in the missing pieces anyway.
+* There is quite a lot for web designers in the [[Joomla! 1.5 Template Tutorials Project]].
 ==Audience: Core Developers==

JDOC