Portal

Developers: Difference between revisions

From Joomla! Documentation

mNo edit summary
 
(219 intermediate revisions by 48 users not shown)
Line 1: Line 1:
{{Developer profile}}
<noinclude><languages /></noinclude>
{{Top portal heading|color=white-bkgd|icon=code|icon-color=#5091cd|size=5x|text-color=#333|title=
<translate><!--T:45--> Joomla! Developers Portal</translate>}}
__TOC__
{{Portal:Developers/Intro/<translate><!--T:1-->
en</translate>}}
{{section portal heading|icon=book|title=<translate><!--T:2-->
Getting Started!</translate>}}{{Portal:Developers/Resources/<translate><!--T:3-->
en</translate>}}


== Participation ==
<translate>==There are four types of extensions development== <!--T:25--></translate>
<br />
{{section portal heading|icon=code|title=<translate><!--T:9-->
Components</translate>}}
{{Portal:Component_Development/Reading_list/<translate><!--T:11-->
en</translate>}}{{tip|<translate><!--T:12-->
See the [[S:MyLanguage/Portal:Component_Development|Component Development Portal page]].</translate>|title=<translate><!--T:13-->
For more articles and information:</translate>}}
<br />
{{section portal heading|icon=plug|title=<translate><!--T:10-->
Plugins</translate>}}{{Portal:Plugin_Development/Reading_list/<translate><!--T:14-->
en</translate>}}{{tip|<translate><!--T:40-->
See the [[S:MyLanguage/Portal:Plugin_Development|Plugin Development Portal page]].</translate>|title=<translate><!--T:41-->
For more articles and information:</translate>}}
<br />
{{section portal heading|icon=cubes|title=<translate><!--T:21-->
Modules</translate>}}{{Portal:Module_Development/Reading_list/<translate><!--T:22-->
en</translate>}}{{tip|<translate><!--T:23-->
See the [[S:MyLanguage/Portal:Module_Development|Module Development Portal page]].</translate>|title=<translate><!--T:24-->
For more articles and information:</translate>}}
<br />
{{section portal heading|icon=desktop|title=<translate><!--T:17-->
Templates</translate>}}{{Portal:Template_Development/Reading_list/<translate><!--T:18-->
en</translate>}}{{tip|<translate><!--T:19-->
See the [[S:MyLanguage/Portal:Template_Development|Template Development Portal page]].</translate>|title=<translate><!--T:20-->
For more articles and information:</translate>}}
{{-}}


* [[Participating in the community]]: a brief description of how people can get involved.
<translate>==More Development Topics== <!--T:33--></translate>
* [[Coding style and standards]] (To be reviewed).
<div class="large-4 column">
* [[Patch submission guidelines]].
{{section portal heading|icon=database|title=<translate><!--T:27-->
* [[Filing bugs and issues]].
Database</translate>}}{{Portal:Developers/Database/<translate><!--T:28-->
* [[How to release a distribution tarball]].
en</translate>}}
</div>
<div class="large-4 column">
{{section portal heading|icon=language|title=<translate><!--T:29-->
Localisation</translate>}}{{Portal:Developers/Localisation/<translate><!--T:31-->
en</translate>}}
</div>
<div class="large-4 column">
{{section portal heading|icon=users|title=<translate><!--T:30-->
ACL Topics</translate>}}{{Portal:Developers/Access Control/<translate><!--T:32-->
en</translate>}}
</div>
{{-}}
<div class="large-4 column">
{{section portal heading|icon=edit|title=<translate><!--T:34-->
Forms</translate>}}{{Portal:Developers/Forms/<translate><!--T:35-->
en</translate>}}
</div>
<div class="large-4 column">
{{section portal heading|icon=book|title=<translate><!--T:46--> API Guides</translate>}}
<translate><!--T:47--> The Joomla API Guides provide explanations and sample code relating to the Joomla API functions, to help you understand how to use the APIs in your own extensions. [[S:MyLanguage/API Guides|Click here]] to get to the index of these guides.</translate>
</div>
<div class="large-4 column">
{{section portal heading|icon=lock|title=<translate><!--T:36-->
Security</translate>}}{{Portal:Developers/Security/<translate><!--T:37-->
en</translate>}}{{tip|<translate><!--T:42-->
See the [[S:MyLanguage/Security|Security Portal page]].</translate>|title=<translate><!--T:43-->
For more articles and information:</translate>}}
</div>
{{-}}
{{section portal heading|icon=user-plus|title=<translate><!--T:38-->
Contributing to Documentation</translate>}}
{{Portal:Developers/Developer_Documentation/<translate><!--T:44-->
en</translate>}}


== Reference Pages ==
__NOTOC__
 
<noinclude>
Peruse all pages in the [[:Category:Development]] category.
[[Category:Development{{#translation:}}]]
 
[[Category:Joomla! user profiles{{#translation:}}]]
When creating a new page, ensure you place the following marker at the top of the page so it is included in the category list:
</noinclude>
 
<pre><nowiki>[[Category:Development]]
</nowiki></pre>
 
If you locate other articles you thing that are relevant to developer, please add this marker to those pages.
 
== Articles and Tutorials on developer.joomla.org ==
 
[http://community.joomla.org/magazine/article/508-developer-localization-advancements-in-joomla-15.html Localization Advancements in Joomla! 1.5]
 
[http://developer.joomla.org/component/content/article/33-tutorials/165-understanding-output-overrides-in-joomla.html Understanding Output Overrides in Joomla! 1.5]
 
[http://developer.joomla.org/tutorials/33-tutorials/181-preventing-sql-injections.html Preventing SQL Injections]
 
[http://developer.joomla.org/tutorials/33-tutorials/184-how-to-create-a-joomla-plugin.html How to create a Joomla! Plugin]
 
== Cookie Jar ==
 
Articles that need to be written.
 
* Developer guidelines.
* Secure coding guidelines.
* Error message conventions.
* Exception handling.
* Release numbering, compatibility and deprecation.
* 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
** Review all material under the tutorials heading at http://dev.joomla.org/component/option,com_jd-wiki/Itemid,32/
** Recommend material to be migrated over to docs.joomla.org
** Update material that is to be migrated over to docs.joomla.org
* [[Adding AJAX to your component]].
** 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).
* [[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]].
* [[Adding view layout configuration parameters]].
** Explain how to create an XML file that will allow users to configure views.
* [[How to implement XML-RPC in a component]]
** There are two ways to do this:
*** Implement it using an XML-RPC plugin
*** Implement it in the component itself using raw views
* [[How to use the filesystem package]]
* [[How to use 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)
* [[How to use the registry package]]
* [[How to use JSimpleXML]]
** How to load and store XML files and how to work with them
* [[How to add breadcrumbs]]
* [[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
** This focuses on using the JBrowser class to retrieve information about the features available in the user's browser.
* [[How to create an editor plugin]]
* [[What can be done with a user plugin]]
* [[How to work with parameters]]
* [[How to use the JToolBar class in the frontend]]
* [[How to use the editor in a component]]
* [[How to cloak email addresses]]
 
[[Category:Development]]

Latest revision as of 21:27, 18 April 2020

Joomla! Developers Portal

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.

Have an Interest in Core Contributions?

The development of Joomla itself is carried out by Production Department and third party developers. For more information about Joomla! core development, how to contribute to code to core, or becoming more involved with the core code, you should go to Joomla! Code Contributors.


Getting Started!

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.

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

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

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.


There are four types of extensions development


Components


There are many articles, tutorials, references and FAQs which focus on component development. If this is your first time developing a component for Joomla, you should start with the Absolute Basics of How a Component Functions. If needed, you can visualise the control flow of a component with these diagrams.

Next, you will want to read our  Joomla 3.x MVC tutorial    Developing a Model-View-Controller Component. Remember to familiarise yourself with Joomla! Secure coding guidelines and Development Best Practices.

Once you have read the tutorial and/or tried the example component, you can focus more on the specifics of your component with additional articles. These are listed on the Component Development Portal or any of the supporting Portals for Development(Plugins, Modules or Templates).

For more articles and information:

See the Component Development Portal page.


Plugins

The following articles will help familiarise you with Joomla! plugins. They are a good starting point to understanding and then developing plugins.

Beginner

To understand how to install and use a plugin in Joomla it is recommended to read Administration of a Plugin in Joomla!

Intermediate

To understand plugins better it is advised that you create a basic plugin for Joomla!.

To read on how to run a basic content plugin in a custom module or component you may have already developed it is recommended to read Triggering content plugins in your extension.

Advanced

To understand the principles on which the Plugin system works Plugin Developer Overview. To then implement this in a component you have designed it is recommended to read Supporting plugins in your component.

For more articles and information:

See the Plugin Development Portal page.


Modules


For more articles and information:

See the Module Development Portal page.


Templates

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

Beginners

Intermediate

For more articles and information:

See the Template Development Portal page.

More Development Topics

API Guides

The Joomla API Guides provide explanations and sample code relating to the Joomla API functions, to help you understand how to use the APIs in your own extensions. Click here to get to the index of these guides.

Contributing to Documentation


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:

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:

[[Category:Development]]

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