Difference between revisions of "Developers"

Revision as of 05:25, 24 June 2014

<translate> The development of Joomla! itself is carried out by the Production Department and third party developers. This page is a starting point for developers interested in the development of components, modules, plugins and templates.</translate>

<translate> Have an Interest in Core Contributions?</translate>

Getting Started[edit]

<translate> There are several ways of setting up your workstation in for Joomla! development. Some suggestions can be found at Setting up your workstation for Joomla development.</translate>

<translate> Next, you should familiarise yourself with Joomla! Secure coding guidelines and the short article on Joomla! Development Best Practices.</translate>

<translate> Documentation on the Joomla! API can assist with becoming familiar with the foundations of the Joomla! code base.</translate>

<translate> Finally, Joomla! has many resources for developers. Our Joomla! Resources page will get you pointed in the right direction if you need help and solutions.</translate>

There are four types of extension development:

Component Development
Plugin Development
Template Development
Module Development

Components[edit]

<translate> Component Development</translate>

{{Portal:Component_Development/Intro/<translate> en</translate>}}

<translate> Intro to Component Development</translate>

{{Portal:Component_Development/Reading list/<translate> en</translate>}}

<translate> General Information</translate>

{{Portal:Component_Development/Information/<translate> en</translate>}}

<translate> FAQs</translate>

<translate> Tutorials</translate>

{{Portal:Component_Development/Tutorials/<translate> en</translate>}}

For more articles and information, see the Component Development Portal page.

{{Portal:Plugin_Development/Reading_list/<translate> en</translate>}}

Templates[edit]

Our template development documentation contains many articles, FAQs and tutorials. A first step to developing a template is understanding how templates are executed.

Beginners[edit]

Intermediate[edit]

Portal:Developers/Modules

Contributing to Documentation[edit]

<translate> The development of Joomla developer documentation is carried out primarily by the Documentation Working Group. There is currently one sub-projects of interest to developers:</translate> <translate>

Developer Tutorials Project</translate>

<translate> When creating a new page, ensure you place the following marker at the bottom of the page so it is included in the category list:</translate>

[[Category:Development]]

<translate> If you locate other articles you think are relevant to developers, please add this marker to those pages.</translate>

Suggested topics[edit]

This is a short list of articles that might be written to support developers. Please feel free to add further topic ideas.

Adding configuration objects to modules and plugins.
Storing data in the session between page loads.
Suppressing output of extra HTML.
Using the filter package.
Describe how and when to use the Filter package and explain what needs to be filtered for various situations (for queries, for URLs, etc)
Using the registry package
How to load and store XML files and how to work with them
Creating component feeds (RSS/ATOM)
Generating paths for client side and server side
Acessing information from the request
This focuses on using the JBrowser class to retrieve information about the features available in the user's browser.
Creating an editor plugin
What can be done with a user plugin
Cloaking email addresses
Using the caching system in your component. This might be enough (for now?) → Cache
Extending Joomla's MVC Architecture
How to release a distribution tarball.
Creating a library for your extension(s).

@@ Line 1: / Line 1: @@
-{{Developer profile}}
+__TOC__
+{{:{{FULLPAGENAME}}/Intro}}
-* Developer guidelines.
-* [[Participating in the community]]: a brief description of how people can get involved.
-* [[Coding style and standards]] (To be reviewed).
-* Secure coding guidelines.
-* Error message conventions.
-* Exception handling.
-* [[Patch submission guidelines]].
-* [[Filing bugs and 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
-* Complete/update/review the wiki API reference (assumes this has been moved from DocuWiki to MediaWiki).
+==Getting Started==
-* Update developer tutorials and how-to's currently on dev.joomla.org
+{{:{{FULLPAGENAME}}/Resources}}
-** Review all material under the tutorials heading at http://dev.joomla.org/component/option,com_jd-wiki/Itemid,32/
+There are four types of extension development:
-** Recommend material to be migrated over to docs.joomla.org
+*[[#Components|Component Development]]
-** Update material that is to be migrated over to docs.joomla.org
+*[[#Plugins|Plugin Development]]
-* [[How to debug your code]].
+*[[#Templates|Template Development]]
-** Write a tutorial giving debugging tips for new developers.  Perhaps list different kinds of problems code might have and suggested approaches to locating the problem and fixing it.
+*[[#Modules|Module Development]]
-* [[Using the core parameter types]] (To be reviewed)
+<div class="large-12 column panel radius" style="background:none;">
-* [[Creating custom XML parameter types]].
+{{:{{FULLPAGENAME}}/Components}}
-** Write a document detailing the steps to creating a custom XML Parameter type.  Explain how these types can be used in templates, modules, components and plugins.
+</div>
-* [[Creating component preferences]] (ready for review).
+<div class="large-12 column panel radius" style="background:none;">
-** Write a document describing how to create an xml file for modifying component preferences and how to add a Parameters button to an administrator toolbar.
+{{:{{FULLPAGENAME}}/Plugins}}
-* [[Adding JavaScript and CSS to the page]].
+</div>
-** Write a document describing how to add JavaScript and CSS to the page.  Explain how to decide whether JavaScript should go in the head block or in the page itself and how to insert the JavaScript.
+<div class="large-12 column panel radius" style="background:none;">
-* [[Accessing the current user object]].
+{{:{{FULLPAGENAME}}/Templates}}
-** Write a document describing how to access the current user object and also indicate what type of information can be found in the object, and how that data should be retrieved and/or set.
+</div>
-* [[Adding AJAX to your component]].
+<div class="large-12 column panel radius" style="background:none;">
-** Write a document describing how to add AJAX to an MVC component.  If desired, use the MVC Hello World tutorial as a base.  Describe where various elements should go in the MVC design pattern.  Also describe how to implement MVC in a module (these need supporting components to do AJAX).
+{{:{{FULLPAGENAME}}/Modules}}
-* [[Using JPagination in your component]] (frontend and backend).
+</div>
-** Describe the steps necessary to add pagination to a component using the JPagination class.  Describe the differences between frontend and backend.
+{{-}}
-* [[Creating a toolbar for your component]].
-* [[Adding configuration objects to modules and plugins]].
+== More Development Topics==
-* [[Storing data in the session between page loads]].
+<div class="large-12 column panel radius" style="background:none;">
-* [[Using the caching system in your component]].
+<div class="large-4 column">
-* [[Creating a file uploader in your component]].
+{{:{{FULLPAGENAME}}/Database}}
-* [[Suppressing output of extra HTML]].
+</div>
-* [[Supporting plugins in your component]] (Ready for review).
+<div class="large-4 column">
-** Explain how to add triggers so that your component can fire custom events.
+{{:{{FULLPAGENAME}}/Localisation}}
-* [[Adding multi-language support]].
+</div>
-* [[Retrieving data from GET and POST requests]] - the Joomla! way.
+<div class="large-4 column">
-* [[Adding view layout configuration parameters]].
+{{:{{FULLPAGENAME}}/Access Control}}
-** Explain how to create an XML file that will allow users to configure views.
+</div>
-* [[Using the installer API to support package installation]].
+</div>
-** Explain how to use the JInstaller API to install add-ons to components
+<div class="large-12 column panel radius" style="background:none;">
-* [[How to implement XML-RPC in a component]]
+<div class="large-6 column">
-** There are two ways to do this:
+{{:{{FULLPAGENAME}}/Forms}}
-*** Implement it using an XML-RPC plugin
+</div>
-*** Implement it in the component itself using raw views
+<div class="large-6 column">
-* [[How to use the filesystem package]]
+{{:{{FULLPAGENAME}}/Security}}
-* [[How to use the filter package]]
+</div>
-** Describe how and when to use the Filter package and explain what needs to be filtered for various situations (for queries, for URLs, etc)
+</div>
-* [[How to use the registry package]]
+{{-}}
-* [[How to use JSimpleXML]]
+<div class="large-12 column panel radius" style="background:none;">
-** How to load and store XML files and how to work with them
+{{:{{FULLPAGENAME}}/Miscellaneous}}
-* [[How to use JDate]]
+</div>{{-}}
-** What JDate does and how to use it...
-* [[How to add CSRF anti-spoofing to forms]]
+<div class="large-12 column panel radius">
-** How to use JHTML::_( 'form.token' ) and token checking to secure components
+== Contributing to Documentation ==
-* [[How to add breadcrumbs]]
+{{:{{FULLPAGENAME}}/Developer Documentation}}
-* [[How to use the JTable class]]
+{{:{{FULLPAGENAME}}/Projects}}
-* [[How to create component feeds]] (RSS/ATOM)
+</div>
-* [[How to create PDF views]]
-* [[How to send email from components]]
+[[Category:Development]]
-* [[What's available in the JFactory class]]
+[[Category:JED]]
-* [[How to generate paths for client side and server side]]
+[[Category:Joomla! user profiles]]
-* How to access information from the request/browser
-** This focuses on using the JBrowser class to retrieve information about the features available in the user's browser.
-* [[How to create a search plugin]] (To be reviewed)
-* [[How to create a content plugin]] (To be reviewed)
-* [[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 component]]
-* [[How to use the JPane classes in a component]]
-* [[How to cloak email addresses]]
-* [[JUser_example]]
-* [[Form validation]]

Portal

Difference between revisions of "Developers"

From Joomla! Documentation