Difference between revisions of "Developers"
From Joomla! Documentation
m (starting to rework) |
m (Typo) |
||
| (30 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
| − | {{: | + | <noinclude><languages /></noinclude> |
| − | == | + | {{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>}} |
| − | {{: | + | {{tip|<li>[[#Components|<translate><!--T:4--> |
| − | + | Components Development</translate>]]</li><li>[[#Plugins|<translate><!--T:5--> | |
| + | Plugins Development</translate>]]</li><li>[[#Templates|<translate><!--T:6--> | ||
| + | Templates Development</translate>]]</li><li>[[#Modules|<translate><!--T:7--> | ||
| + | Modules Development</translate>]]</li>|title=<translate><!--T:8--> | ||
| + | There is four types of extensions development:</translate>}} | ||
| + | <div class="large-6 column"> | ||
| + | {{section portal heading|icon=terminal|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>}} | ||
</div> | </div> | ||
| − | <div class=" | + | <div class="large-6 column"> |
| − | {{ | + | {{section portal heading|icon=plug|title=<translate><!--T:10--> |
| − | + | Plugins</translate>}}{{Portal:Developers/Plugins}} | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
</div> | </div> | ||
| − | {{:{{FULLPAGENAME}} | + | |
| + | <div class="large-12 column panel radius" style="background:none;"> | ||
| + | {{:{{FULLPAGENAME}}}} | ||
</div> | </div> | ||
| − | + | <div class="large-12 column panel radius" style="background:none;"> | |
| − | <div style=" | + | {{:{{FULLPAGENAME}}/Templates}} |
| − | |||
| − | |||
| − | |||
| − | |||
| − | {{:{{FULLPAGENAME}}/ | ||
</div> | </div> | ||
| − | + | <div class="large-12 column panel radius" style="background:none;"> | |
| − | <div class=" | + | {{:{{FULLPAGENAME}}/Modules}} |
| − | |||
| − | {{:{{FULLPAGENAME}}/ | ||
| − | |||
| − | |||
| − | |||
| − | |||
</div> | </div> | ||
{{-}} | {{-}} | ||
| − | + | ||
| + | == More Development Topics== | ||
| + | <div class="large-12 column panel radius" style="background:none;"> | ||
<div class="large-4 column"> | <div class="large-4 column"> | ||
{{:{{FULLPAGENAME}}/Database}} | {{:{{FULLPAGENAME}}/Database}} | ||
| Line 53: | Line 46: | ||
{{:{{FULLPAGENAME}}/Access Control}} | {{:{{FULLPAGENAME}}/Access Control}} | ||
</div> | </div> | ||
| + | </div> | ||
| + | <div class="large-12 column panel radius" style="background:none;"> | ||
| + | <div class="large-6 column"> | ||
| + | {{:{{FULLPAGENAME}}/Forms}} | ||
| + | </div> | ||
| + | <div class="large-6 column"> | ||
| + | {{:{{FULLPAGENAME}}/Security}} | ||
| + | </div> | ||
| + | </div> | ||
| + | {{-}} | ||
| + | <div class="large-12 column panel radius" style="background:none;"> | ||
| + | {{:{{FULLPAGENAME}}/Miscellaneous}} | ||
| + | </div>{{-}} | ||
| + | |||
| + | <div class="large-12 column panel radius"> | ||
| + | == Contributing to Documentation == | ||
| + | {{:{{FULLPAGENAME}}/Developer Documentation}} | ||
| + | {{:{{FULLPAGENAME}}/Projects}} | ||
| + | </div> | ||
| + | __NOTOC__ | ||
| + | <noinclude> | ||
[[Category:Development]] | [[Category:Development]] | ||
[[Category:JED]] | [[Category:JED]] | ||
[[Category:Joomla! user profiles]] | [[Category:Joomla! user profiles]] | ||
| + | [[Category:Needs to be marked for translation]] | ||
| + | </noinclude> | ||
Revision as of 10:03, 25 May 2015
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.
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.
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 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 
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).
See the Component Development Portal page.
{{Portal:Plugin_Development/Reading_list/<translate> en</translate>}}
{{Portal:Developers/Intro/<translate> en</translate>}}
{{Portal:Developers/Resources/<translate> en</translate>}}
{{Portal:Component_Development/Reading_list/<translate> en</translate>}}
<translate> See the Component Development Portal page.</translate>
{{Portal:Plugin_Development/Reading_list/<translate> en</translate>}}
Template loop detected: Portal:Developers
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]
- Changing the site favicon
- Using Firebug With Your Joomla Website
- Using Joomla's Default Icomoon Fonts
Intermediate[edit]
- jdoc statements
- How to cloak email addresses
- Understanding Output Overrides
- Layout Overrides in Joomla!
- Creating clickable background images using CSS
- Using Class Suffixes
More Development Topics[edit]
<translate>
- Accessing the database using JDatabase
- Using the JTable class
- Connecting to an external database
- Using nested sets</translate>
<translate>
Form Fields[edit]
</translate>
- <translate> Introduction to the Form classes in Joomla</translate>
- <translate> Joomla Core Form Fields</translate>
- <translate> Creating a custom form field type</translate>
- <translate> Overriding the "Rules" Form Field</translate>
<translate>
Form Rules & Validation[edit]
</translate>
<translate>
- How to add CSRF anti-spoofing to forms
- Securing Joomla! extensions
- Why do most of the Joomla! PHP files start with defined(' JEXEC')?
- Register Globals best practices (only relevant if your Joomla Site runs on PHP 5.3 or below)</translate>
Misc[edit]
- Retrieving request data using JInput
and newer - Retrieving data from GET and POST requests
- How to use the filesystem package
- Application execution order
- Accessing the current user object
- Adding JavaScript and CSS to the page
- Constants used in the Joomla Framework.
- Create a stand-alone application using the Joomla! Framework
- How to use user state variables
- Cache and Using caching to speed up your code
- Using the installer API to support package installation
- How to add tooltips to your Joomla! website
- Display error messages and notices.
- Sharing layouts across views or extensions with JLayout
- Using JLog
- JSON Responses with JResponseJson
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).
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]
- Changing the site favicon
- Using Firebug With Your Joomla Website
- Using Joomla's Default Icomoon Fonts
Intermediate[edit]
- jdoc statements
- How to cloak email addresses
- Understanding Output Overrides
- Layout Overrides in Joomla!
- Creating clickable background images using CSS
- Using Class Suffixes
More Development Topics[edit]
<translate>
- Accessing the database using JDatabase
- Using the JTable class
- Connecting to an external database
- Using nested sets</translate>
<translate>
Form Fields[edit]
</translate>
- <translate> Introduction to the Form classes in Joomla</translate>
- <translate> Joomla Core Form Fields</translate>
- <translate> Creating a custom form field type</translate>
- <translate> Overriding the "Rules" Form Field</translate>
<translate>
Form Rules & Validation[edit]
</translate>
<translate>
- How to add CSRF anti-spoofing to forms
- Securing Joomla! extensions
- Why do most of the Joomla! PHP files start with defined(' JEXEC')?
- Register Globals best practices (only relevant if your Joomla Site runs on PHP 5.3 or below)</translate>
Misc[edit]
- Retrieving request data using JInput and newer
- Retrieving data from GET and POST requests
- How to use the filesystem package
- Application execution order
- Accessing the current user object
- Adding JavaScript and CSS to the page
- Constants used in the Joomla Framework.
- Create a stand-alone application using the Joomla! Framework
- How to use user state variables
- Cache and Using caching to speed up your code
- Using the installer API to support package installation
- How to add tooltips to your Joomla! website
- Display error messages and notices.
- Sharing layouts across views or extensions with JLayout
- Using JLog
- JSON Responses with JResponseJson
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).