Joomla! Documentation - User contributions [en]

Configuring Komode Edit for Joomla Code Completion

2012-05-05T08:06:29Z

Oasisfleeting: Blanked the page

Configuring Komodo Edit for Joomla Code Completion

2012-05-05T08:06:24Z

Oasisfleeting: Created page with "{{inuse}} {{RightTOC}} == Introduction == This article provides instructions for setting up Komodo Edit and code completion for joomla. == Installation == 1.) Download and in..."

{{inuse}}
{{RightTOC}}

== Introduction ==

This article provides instructions for setting up Komodo Edit and code completion for joomla.

== Installation ==

1.) Download and install the latest version of Komodo Edit from here. http://www.activestate.com/komodo-edit
<br>
2.) Download the [http://www.joomla.org/ latest version]of Joomla.

== Put Joomla Somewhere Safe ==
Once you have downloaded the latest version of Joomla from the link above you'll want to put it somewhere on your drive where it won't get lost or deleted by accident. Unpack the Joomla file you just downloaded to this location.

== Adding Joomla Path To Komodo ==
Start the Komodo Edit software you just downloaded and installed and in the menu at the top you will see a menu option titled Edit. Go to Edit -> Preferences and a dialog will appear. Find Languages in the list on the left, expand it and you will see another list of languages, click PHP in the sublist.
<br>
On the right of the screen under PHP Directories you can specify any directories that you want Komodo to use for autocomplete and calltips. Komodo will recursibely scan these directories for information.
<br>
Press the green plus icon to add a new directory and point it at the Joomla package you unzipped and placed somewhere safe. Mine is in "C:\joomla\joomla2_5\Joomla_2.5.4-Stable-Full_Package" press okay and the editor will add the all the joomla code to it's database and you'll have code completion as soon as it's done scanning.
<br>
Now you're ready to start coding. Type "JFactory::" into your new php extension and Komodo will list all the methods available to JFactory.

[[Category:Development]]

Setting up your workstation for web development

2012-05-05T08:05:42Z

Oasisfleeting:

{{underconstruction}}

{{RightTOC}}

== Introduction ==
This article provides detailed instructions for setting up your workstation as a PHP development environment, not only for Joomla! it also should work fine for PHP development in general.

'''Note''' There are many possible configurations for doing PHP development environments. Any environment that supports the basic AMP stack (Apache, MySql, PHP), Subversion and/or Git should be fine.

== Choosing a code editor ==

The PHP language code represented just by plain text that can be edited with simple text editors like:

* Geany (opensource cross platform text editor)
* Gedit (opensource code editor for linux)
* Notepad++ (opensource code editor for Windows)
* Apple textEditor (Apple's basic text editor)
* Komodo Edit (Komodo Edit is a fast, smart, free and open-source code editor for Windows, Mac and Linux)

But when you are about to work in more advanced and complex projects and need some coding assistance there is a handful of development tools called IDEs (Integrated Development Environment) these are some of them:

* [[wikipedia:Eclipse_(software)|Elcipse IDE]] (opensource cross platform IDE)
* Netbeans IDE (opensource cross platform IDE)
* UltraEdit IDE (closed source cross platform IDE)
* Aptana IDE (opensource cross platform IDE)
* Shiftedit IDE

As new emerging technologies we got other kind of editors available as an alternative to the traditional simple editors or desktop IDEs applications, among them we got:

*Web based IDEs: editors that runs on the web
**Wiode
*Cloud based IDEs: editors that runs on the cloud
**Kodingen
**Codeita
**ShiftEdit
**jsFiddle
**PHPanywhere
*Browser based IDEs: editors that runs on your browser
**Cloud IDE (Google chrome extension)
**Cloud9 (Google Chrome extension)
**ShitEdit (Google Chrome extension)
**PHPanywhere (Google Chrome extension)
**Cloud IDE (Google Chrome extension)

To empathize some of the advantages of the use of IDEs over simple text editors we got:

*Some IDEs integrate and/or let you integrate more programming languages under the same tool such as PHP, Javascript, CSS, XML, etc...
*Some IDEs integrate and/or let you integrate assistive functions to develop code such as code completion, re-factoring, templates, advanced search/replace, syntax check, syntax coloring and more
*Some IDEs can analyze the project as a whole and build a map of relationships between the classes in use in your project giving you the opportunity to explore the project in a more comfortable and coherent way
*Some IDEs can analyse the current file under edition and give you a map of the different variables, functions and classes present on the file as a shortcut to navigate through the content
*Some IDEs integrate and/or let you integrate PHP debugging client under the same tool
*Some IDEs integrate and/or let you integrate several kind of source code revision control clients under the same tool

Some of the advantages of simple text editors are:

*This kind of editor are usually lightweight
*Some of these editors are great to do quick editions
*Some of these editors provide syntax coloring and basic code completion

All these options can be used for the development of PHP projects, but for this article we are going to focus on '''Eclipse IDE''', feel free to add more alternatives and document them in the following list.

* [[Configuring Eclipse IDE for PHP development]]
* [[Configuring Netbeans IDE for PHP development]]
* [[Configuring UltraEdit IDE for PHP development]]
* [[Configuring Komodo Edit for Joomla Code Completion]]

== Choosing a web server ==

To develop and test our PHP projects we need to execute the code in a web server capable of interpret PHP code and send the output to our browser, is good to know that we have a nice range of opensource tools to deploy a PHP webservers for our development environment such as:

*[[wikipedia:LAMP_(software_bundle)|LAMP]] (AMP stack on Linux)
*[http://www.apachefriends.org/en/xampp.html XAMPP] (Cross platform AMP stack implementation)
*[http://www.wampserver.com/en/ WAMP] (AMP stack for Windows)
Also there is other commercial closed-source options such as:
*[[wikipedia:Internet_Information_Services | IIS]] (Microsoft webserver, the PHP and MySQL services got to be installed manually)
*others

All these options can be used for the development of PHP projects, but for this article we are going to focus on '''LAMP server for Linux''' and a '''XAMPP server for windows''', feel free to add more alternatives and document them in the following list.

* [[Configuring a LAMPP server for PHP development]]
* [[Configuring a XAMPP server for PHP development]]
* [[Configuring a WAMP server for PHP development]]
* [[Configuring an IIS server for PHP development]]

== Choosing a Debugging tool ==

Debugging tools are quite useful when you are developing a PHP project and you want to study how your code behave step by step on each line execution of your code, also these debugging tools let you see the real values of variables and objects and set new values on the fly for testing purposes, you can also create expression to check the outcome without modify your code.

Old school and hardcore PHP programmers don't fraternize much with these kind of visual tools and they prefer to debug their code the old way using [[php:var_dump]] and other methods to display and analyze the output of the PHP code, is up to you what kind of tools you want to implement in your development workflow.

There is several alternatives for PHP debugging, some of these are:

*[[wikipedia:Xdebug|Xdebug]] (opensource debugging service for PHP)
*Zend Debugger (commercial debugging service for PHP)

To empathize some of the advantages of the use of this kind of debugging tools we got:

*You can stop (freeze) the execution of your PHP code any time placing a breakpoint
*You can inspect the current value of variables and objects without dumping the content
*You can execute the code step by step all the way from the beginning of the PHP code to the end of it and study how your application behaves under certain circumstances
*You can set or modify the value of variables and object on the fly and see the results of your changes without modify the original code at all

All these options can be used for the development of PHP projects, but for this article we are going to focus on '''Xdebug''', feel free to add more alternatives and document them in the following list.

* [[Configuring Xdebug for PHP development]]
* [[Configuring Zend Debugger for PHP development]]

== Choosing a Version Control System ==

Don't you hate when you are coding and suddenly by accident you just deleted a big chunk of text and there is no backups of that file to restore those important lines of code?, don't you hate when you are working with 2 or more developers in a project and everyone have a different copy of the project then comes the day of merge all those changes in one final project but everything goes wrong or the project does not want to run properly because someone did just overwrite some of your files?, for all this problems and many more exist some nice tools to bring you the solutions you need, some of these tools are:

*[[wikipedia:Git_(software)|GIT]] (Is a distributed revision control and source code management)
*[[wikipedia:Apache_Subversion|SVN]] (Is a software versioning and revision control system)

A Version Control System also known as VCS is a very important tool in the development of software projects, this tools keep track of all the changes you made in a file over the time, they also provide mechanisms to avoid version conflicts when 2 or more developers have made changes in the same files, another nice feature is that you can navigate back in time through the history of changes of a file and revert undesired changes if you want, tools like this make possible collaborative projects with thousand of developers around the world such as the Linux project were lot of people are constantly editing the project files every day and all the merging and revision process of thousand of files is automated by the VCS. Consider yourself some time to learn how to use this important tool.

All these options can be used for the development of PHP projects, but for this article we are going to focus on '''GIT''', feel free to add more alternatives and document them in the following list.

* [[Configuring GIT for PHP development]]
* [[Configuring SVN for PHP development]]

== Choosing a project build system ==
To read the full definition of a project build system you can go [[wikipedia:Build_automation|here]] but in short, the project build systems help you to automatize those tedious and repetitive tasks that developers got to do in several stages of the development of a project, some of this tasks are:

*Compiling source code
*Packaging (such as creating installers or final compressed files of individual libraries)
*Running tests
*Deployment to production systems (such as automatic upgrades and/or installation)
*Creating documentation and/or release notes

Looking at project build systems from another point of view we can say they are a tool to automate complex tasks or little tasks such as:
*Move a file from one place to another
*Compressing a folder with several files
*Upload a final build to a server
*Update the content of files such as XML files or some comment sections of PHP files to print the version of the last build

A simple thing like the development of a Joomla! extensions such as a simple module could need the use of a project build system to gather all the information dispersed about the module in the Joomla! folder structure and put it back to the typical package structure of a module package with a simple build command, this could save you several minutes and headaches when you try to build a module or any extension manually and misplace a file or skip one of then in the final package. Consider your self some time to learn the proper use of project build systems and make them part of your regular development workflow.

Exist several options for project build systems out there, some of those are:
*[http://www.phing.info/trac/ Phing Project] (Build tool that uses simple XML build files and extensible PHP "task" classes to describe the build process)
*[[wikipedia:Apache_Ant|Apache Ant]] (Build tool that uses simple XML build files to describe the build process, it needs JAVA to run)

All these options can be used for the development of PHP projects, but for this article we are going to focus on '''Phing''', feel free to add more alternatives and document them in the following list.

* [[Configuring Phing for PHP development]]
* [[Configuring Apache Ant for PHP development]]

== Choosing a project management system ==

Any decent project is complete without a project management system, this applications helps developers, users and community to the planning, organize and administrate the resources of the project such as time, developers, goals. More sophisticated and complete project management systems comes with issue tracking, documents & files management, wiki, forums, blogs, SCM integration and more, some of those tools are:

*Web based applications
**ProjectFork [http://www.projectfork.net/]
**Redmine [http://www.redmine.org/]
*Cloud based applications
**GitHub [https://github.com/]
**SourceForge [http://sourceforge.net/]
**BitBucket [https://bitbucket.org/]
*Desktop based applications
**OpenProj - Project Management [http://sourceforge.net/projects/openproj/]
**GanttProject [http://www.ganttproject.biz/]
**MS Project [http://www.ganttproject.biz/] (proprietary software)

Some of these options are tools to control the administrative part of a almost any project like planing, resources, etc, but not all the features like code tracking, bug tracking and issue tracking, other tools like redmine got lot of features even more that some small projects needs and online services like Github gives you lots of features for free without the need of setting up a server to install the project manager.

All these options can be used for the development of PHP projects, but for this article we are going to focus on '''ProjectFork''', feel free to add more alternatives and document them in the following list.

* [[Configuring ProjectFork to administrate a PHP development project]]
* [[Configuring GitHub to administrate a PHP development project]]
* [[Configuring SourceForge to administrate a PHP development project]]
* [[Configuring Redmine to administrate a PHP development project]]

== Considerations for your future as developer ==

Whether you plan or not to develop extensions for Joomla or any other PHP platform, this articles gives you nice initial vision on how configure your workstation and what tools you can use to organize yourself and your project, this are very important topics to study in detail to level up your professional skills.

There is no excuse to not use one of these tools explained in this article, not even for small projects, you should always try to be as much professional as you can and you will see that the amount of problems, building, bug tracking and other common an repetitive issues will be easy to manage with your client and coworker, imagine yourself creating copies of your project over and over, and no one have a control to which one is the last version, imagine your client sending you emails or chat messages constantly to tell you about a simple bug he/she found or just want to do a modification of some specific feature like the color or the size of a html object, that is a total pain, you better configure yourself project management system to keep all those bugs ans issue well organized.

As a final note for this article here are some other important consideration for your future as developer:

*Do '''not''' use [[wikipedia:Sneakernet|Sneakernet]] to handle the documents of your project
*Consider the possibility of host your project in the cloud with Github, SourceForge, Bitbucket and others, this services comes with a lot of nice features like, blogs, issue trackers, version control, forums and more.
*Subscribe to security forums or security mailing lists
*Collaborate with the documentation effort gives you direct and indirect benefits at short and long term during your career as developer
*Keep an open mind and always give a try to different and new alternatives for tools as much as you can to helps your self gain knowledge and confidence when you need to chose a tool or solve a problem
*Consider your self to invest some of your time as a novice developer to help others in support forums or support IRC channels, this will give you an invaluable experience to learn how to deal with real people with real problems from different parts of the world, and who knows some of them could be or will be your future clients, in other words this is a win win situation you win experience knowledge and future clients
*Conserve your mouth 'Ecologic', is a bad habit from some novice developers to say this or that tool 'sucks' or 'stinks' because they don't know how to use them correctly, is not fair says that a Jackhammer 'sucks' because is really hard to nail a photo portrait to the wall with it, so try to not emit 'destructive' comments if you don't really understand how the tool operate

== Documentation support and discussion ==

For suggestions, observations, report a bug in the code or errors in the configurations or procedures described in this document feel free to post a message in the discussion page or post a message in the following forum boards

*Topics related to the documentation: {{jforum|doc}}
*Any other topic: {{jforum}}

[[Category:Development]]

Configuring Komode Edit for Joomla Code Completion

2012-05-05T08:04:29Z

Oasisfleeting:

Configuring Komode Edit for Joomla Code Completion

2012-05-05T08:03:44Z

Oasisfleeting:

Configuring Komode Edit for Joomla Code Completion

2012-05-05T07:22:23Z

Oasisfleeting:

Configuring Komode Edit for Joomla Code Completion

2012-05-05T07:15:08Z

Oasisfleeting: Created page with "testing this page."

testing this page.

Setting up your workstation for web development

2012-05-05T07:13:12Z

Oasisfleeting:

{{underconstruction}}

{{RightTOC}}

== Introduction ==
This article provides detailed instructions for setting up your workstation as a PHP development environment, not only for Joomla! it also should work fine for PHP development in general.

'''Note''' There are many possible configurations for doing PHP development environments. Any environment that supports the basic AMP stack (Apache, MySql, PHP), Subversion and/or Git should be fine.

== Choosing a code editor ==

The PHP language code represented just by plain text that can be edited with simple text editors like:

* Geany (opensource cross platform text editor)
* Gedit (opensource code editor for linux)
* Notepad++ (opensource code editor for Windows)
* Apple textEditor (Apple's basic text editor)
* Komodo Edit (Komodo Edit is a fast, smart, free and open-source code editor for Windows, Mac and Linux)

But when you are about to work in more advanced and complex projects and need some coding assistance there is a handful of development tools called IDEs (Integrated Development Environment) these are some of them:

* [[wikipedia:Eclipse_(software)|Elcipse IDE]] (opensource cross platform IDE)
* Netbeans IDE (opensource cross platform IDE)
* UltraEdit IDE (closed source cross platform IDE)
* Aptana IDE (opensource cross platform IDE)
* Shiftedit IDE

As new emerging technologies we got other kind of editors available as an alternative to the traditional simple editors or desktop IDEs applications, among them we got:

*Web based IDEs: editors that runs on the web
**Wiode
*Cloud based IDEs: editors that runs on the cloud
**Kodingen
**Codeita
**ShiftEdit
**jsFiddle
**PHPanywhere
*Browser based IDEs: editors that runs on your browser
**Cloud IDE (Google chrome extension)
**Cloud9 (Google Chrome extension)
**ShitEdit (Google Chrome extension)
**PHPanywhere (Google Chrome extension)
**Cloud IDE (Google Chrome extension)

To empathize some of the advantages of the use of IDEs over simple text editors we got:

*Some IDEs integrate and/or let you integrate more programming languages under the same tool such as PHP, Javascript, CSS, XML, etc...
*Some IDEs integrate and/or let you integrate assistive functions to develop code such as code completion, re-factoring, templates, advanced search/replace, syntax check, syntax coloring and more
*Some IDEs can analyze the project as a whole and build a map of relationships between the classes in use in your project giving you the opportunity to explore the project in a more comfortable and coherent way
*Some IDEs can analyse the current file under edition and give you a map of the different variables, functions and classes present on the file as a shortcut to navigate through the content
*Some IDEs integrate and/or let you integrate PHP debugging client under the same tool
*Some IDEs integrate and/or let you integrate several kind of source code revision control clients under the same tool

Some of the advantages of simple text editors are:

*This kind of editor are usually lightweight
*Some of these editors are great to do quick editions
*Some of these editors provide syntax coloring and basic code completion

All these options can be used for the development of PHP projects, but for this article we are going to focus on '''Eclipse IDE''', feel free to add more alternatives and document them in the following list.

* [[Configuring Eclipse IDE for PHP development]]
* [[Configuring Netbeans IDE for PHP development]]
* [[Configuring UltraEdit IDE for PHP development]]
* [[Configuring Komode Edit for Joomla Code Completion]]

== Choosing a web server ==

To develop and test our PHP projects we need to execute the code in a web server capable of interpret PHP code and send the output to our browser, is good to know that we have a nice range of opensource tools to deploy a PHP webservers for our development environment such as:

*[[wikipedia:LAMP_(software_bundle)|LAMP]] (AMP stack on Linux)
*[http://www.apachefriends.org/en/xampp.html XAMPP] (Cross platform AMP stack implementation)
*[http://www.wampserver.com/en/ WAMP] (AMP stack for Windows)
Also there is other commercial closed-source options such as:
*[[wikipedia:Internet_Information_Services | IIS]] (Microsoft webserver, the PHP and MySQL services got to be installed manually)
*others

All these options can be used for the development of PHP projects, but for this article we are going to focus on '''LAMP server for Linux''' and a '''XAMPP server for windows''', feel free to add more alternatives and document them in the following list.

* [[Configuring a LAMPP server for PHP development]]
* [[Configuring a XAMPP server for PHP development]]
* [[Configuring a WAMP server for PHP development]]
* [[Configuring an IIS server for PHP development]]

== Choosing a Debugging tool ==

Debugging tools are quite useful when you are developing a PHP project and you want to study how your code behave step by step on each line execution of your code, also these debugging tools let you see the real values of variables and objects and set new values on the fly for testing purposes, you can also create expression to check the outcome without modify your code.

Old school and hardcore PHP programmers don't fraternize much with these kind of visual tools and they prefer to debug their code the old way using [[php:var_dump]] and other methods to display and analyze the output of the PHP code, is up to you what kind of tools you want to implement in your development workflow.

There is several alternatives for PHP debugging, some of these are:

*[[wikipedia:Xdebug|Xdebug]] (opensource debugging service for PHP)
*Zend Debugger (commercial debugging service for PHP)

To empathize some of the advantages of the use of this kind of debugging tools we got:

*You can stop (freeze) the execution of your PHP code any time placing a breakpoint
*You can inspect the current value of variables and objects without dumping the content
*You can execute the code step by step all the way from the beginning of the PHP code to the end of it and study how your application behaves under certain circumstances
*You can set or modify the value of variables and object on the fly and see the results of your changes without modify the original code at all

All these options can be used for the development of PHP projects, but for this article we are going to focus on '''Xdebug''', feel free to add more alternatives and document them in the following list.

* [[Configuring Xdebug for PHP development]]
* [[Configuring Zend Debugger for PHP development]]

== Choosing a Version Control System ==

Don't you hate when you are coding and suddenly by accident you just deleted a big chunk of text and there is no backups of that file to restore those important lines of code?, don't you hate when you are working with 2 or more developers in a project and everyone have a different copy of the project then comes the day of merge all those changes in one final project but everything goes wrong or the project does not want to run properly because someone did just overwrite some of your files?, for all this problems and many more exist some nice tools to bring you the solutions you need, some of these tools are:

*[[wikipedia:Git_(software)|GIT]] (Is a distributed revision control and source code management)
*[[wikipedia:Apache_Subversion|SVN]] (Is a software versioning and revision control system)

A Version Control System also known as VCS is a very important tool in the development of software projects, this tools keep track of all the changes you made in a file over the time, they also provide mechanisms to avoid version conflicts when 2 or more developers have made changes in the same files, another nice feature is that you can navigate back in time through the history of changes of a file and revert undesired changes if you want, tools like this make possible collaborative projects with thousand of developers around the world such as the Linux project were lot of people are constantly editing the project files every day and all the merging and revision process of thousand of files is automated by the VCS. Consider yourself some time to learn how to use this important tool.

All these options can be used for the development of PHP projects, but for this article we are going to focus on '''GIT''', feel free to add more alternatives and document them in the following list.

* [[Configuring GIT for PHP development]]
* [[Configuring SVN for PHP development]]

== Choosing a project build system ==
To read the full definition of a project build system you can go [[wikipedia:Build_automation|here]] but in short, the project build systems help you to automatize those tedious and repetitive tasks that developers got to do in several stages of the development of a project, some of this tasks are:

*Compiling source code
*Packaging (such as creating installers or final compressed files of individual libraries)
*Running tests
*Deployment to production systems (such as automatic upgrades and/or installation)
*Creating documentation and/or release notes

Looking at project build systems from another point of view we can say they are a tool to automate complex tasks or little tasks such as:
*Move a file from one place to another
*Compressing a folder with several files
*Upload a final build to a server
*Update the content of files such as XML files or some comment sections of PHP files to print the version of the last build

A simple thing like the development of a Joomla! extensions such as a simple module could need the use of a project build system to gather all the information dispersed about the module in the Joomla! folder structure and put it back to the typical package structure of a module package with a simple build command, this could save you several minutes and headaches when you try to build a module or any extension manually and misplace a file or skip one of then in the final package. Consider your self some time to learn the proper use of project build systems and make them part of your regular development workflow.

Exist several options for project build systems out there, some of those are:
*[http://www.phing.info/trac/ Phing Project] (Build tool that uses simple XML build files and extensible PHP "task" classes to describe the build process)
*[[wikipedia:Apache_Ant|Apache Ant]] (Build tool that uses simple XML build files to describe the build process, it needs JAVA to run)

All these options can be used for the development of PHP projects, but for this article we are going to focus on '''Phing''', feel free to add more alternatives and document them in the following list.

* [[Configuring Phing for PHP development]]
* [[Configuring Apache Ant for PHP development]]

== Choosing a project management system ==

Any decent project is complete without a project management system, this applications helps developers, users and community to the planning, organize and administrate the resources of the project such as time, developers, goals. More sophisticated and complete project management systems comes with issue tracking, documents & files management, wiki, forums, blogs, SCM integration and more, some of those tools are:

*Web based applications
**ProjectFork [http://www.projectfork.net/]
**Redmine [http://www.redmine.org/]
*Cloud based applications
**GitHub [https://github.com/]
**SourceForge [http://sourceforge.net/]
**BitBucket [https://bitbucket.org/]
*Desktop based applications
**OpenProj - Project Management [http://sourceforge.net/projects/openproj/]
**GanttProject [http://www.ganttproject.biz/]
**MS Project [http://www.ganttproject.biz/] (proprietary software)

Some of these options are tools to control the administrative part of a almost any project like planing, resources, etc, but not all the features like code tracking, bug tracking and issue tracking, other tools like redmine got lot of features even more that some small projects needs and online services like Github gives you lots of features for free without the need of setting up a server to install the project manager.

All these options can be used for the development of PHP projects, but for this article we are going to focus on '''ProjectFork''', feel free to add more alternatives and document them in the following list.

* [[Configuring ProjectFork to administrate a PHP development project]]
* [[Configuring GitHub to administrate a PHP development project]]
* [[Configuring SourceForge to administrate a PHP development project]]
* [[Configuring Redmine to administrate a PHP development project]]

== Considerations for your future as developer ==

Whether you plan or not to develop extensions for Joomla or any other PHP platform, this articles gives you nice initial vision on how configure your workstation and what tools you can use to organize yourself and your project, this are very important topics to study in detail to level up your professional skills.

There is no excuse to not use one of these tools explained in this article, not even for small projects, you should always try to be as much professional as you can and you will see that the amount of problems, building, bug tracking and other common an repetitive issues will be easy to manage with your client and coworker, imagine yourself creating copies of your project over and over, and no one have a control to which one is the last version, imagine your client sending you emails or chat messages constantly to tell you about a simple bug he/she found or just want to do a modification of some specific feature like the color or the size of a html object, that is a total pain, you better configure yourself project management system to keep all those bugs ans issue well organized.

As a final note for this article here are some other important consideration for your future as developer:

*Do '''not''' use [[wikipedia:Sneakernet|Sneakernet]] to handle the documents of your project
*Consider the possibility of host your project in the cloud with Github, SourceForge, Bitbucket and others, this services comes with a lot of nice features like, blogs, issue trackers, version control, forums and more.
*Subscribe to security forums or security mailing lists
*Collaborate with the documentation effort gives you direct and indirect benefits at short and long term during your career as developer
*Keep an open mind and always give a try to different and new alternatives for tools as much as you can to helps your self gain knowledge and confidence when you need to chose a tool or solve a problem
*Consider your self to invest some of your time as a novice developer to help others in support forums or support IRC channels, this will give you an invaluable experience to learn how to deal with real people with real problems from different parts of the world, and who knows some of them could be or will be your future clients, in other words this is a win win situation you win experience knowledge and future clients
*Conserve your mouth 'Ecologic', is a bad habit from some novice developers to say this or that tool 'sucks' or 'stinks' because they don't know how to use them correctly, is not fair says that a Jackhammer 'sucks' because is really hard to nail a photo portrait to the wall with it, so try to not emit 'destructive' comments if you don't really understand how the tool operate

== Documentation support and discussion ==

For suggestions, observations, report a bug in the code or errors in the configurations or procedures described in this document feel free to post a message in the discussion page or post a message in the following forum boards

*Topics related to the documentation: {{jforum|doc}}
*Any other topic: {{jforum}}

[[Category:Development]]

Deploying an Update Server

2012-01-12T05:21:53Z

Oasisfleeting: /* Extension */

{{RightTOC}}

This tutorial is for {{JVer|1.6}} and {{JVer|1.7}}

= Introduction =
This tutorial is designed to teach developers how to create an update server for integration with the update system introduced in Joomla! 1.6. By adding an update server listing to your extension's manifest, developers enable users to update their extensions via the [[Help16:Extensions Extension Manager Update|Extension Manager's Update]] view with only a few clicks.

= Defining an update server =
In order to use this feature, an update server must be defined in your extension's manifest. This definition can be used in all Joomla! 1.6 and 1.7 compatible extensions but is not available for templates. You can use two options for your server type; collection or extension. These will be explained in detail shortly. The update server is defined as follows for each type:

<code>
<updateservers>
<server type="collection">http://example.com/list.xml</server>
<server type="extension" priority="2" name="My Extension's Updates">http://example.com/extension.xml</server>
</updateservers>
</code>

Multiple servers can be defined within the <updateservers> tag.

= Server types =
== Collection ==
The collection server type allows developers to define an extension's manifest to pull updates from a collection. This type of server can be used if the developer wants to define all of their extension's updates in a single file (not recommended) or if their extension has multiple sub-extensions which are not distributed or updated at the same time (such as a package extension type). The below example is the collection definition used by the updater when processing core Joomla! updates:

<code>
<extensionset name="Joomla Core" description="Joomla! Core">
<extension name="Joomla" element="joomla" type="file" version="1.7.0" detailsurl="http://update.joomla.org/core/extension.xml"/>
</extensionset>
</code>

All definitions must be defined between <extensionset> tags in your collection manifest. The <extensionset> tag has two optional parameters; name and description. For each extension that this collection references, a separate <extension> tag is required. The <extension> tag has the following parameters, all of which are required for updates to properly process:

* '''name''' - The name of the extension
* '''element''' - The untranslated extension name i.e. mod_custom
* '''type''' - The extension type (component, module, plugin, etc.)
* '''version''' - The latest version of the extension
* '''detailsurl''' - The URL of the XML file which contains that extension's individual update definitions

== Extension ==
The extension server type allows developers to define an extension's manifest to pull updates from a single extension's manifest. All collection manifests eventually point to this XML file. All updates in this file must be defined after an <updates> tag at the beginning of the file. The below example is the update definition for the Joomla! 1.7.0 release:

<code>
<update>
<name>Joomla! 1.7</name>
<description>Joomla! 1.7 CMS</description>
<element>joomla</element>
<type>file</type>
<version>1.7.0</version>
<infourl title="Joomla!">http://www.joomla.org/</infourl>
<downloads>
<downloadurl type="full" format="zip">http://joomlacode.org/gf/download/frsrelease/15279/66552/Joomla_1.6.5_to_1.7.0_Package.zip</downloadurl>
</downloads>
<tags>
<tag>stable</tag>
</tags>
<maintainer>Sam Moffatt</maintainer>
<maintainerurl>http://sammoffatt.com.au</maintainerurl>
<section>Testing</section>
<targetplatform name="joomla" version="1.6"/>
</update>
</code>

The following section describes the elements of a single update entity.

* '''name''' - The name of the extension, this name will appear in the Name column of the Extension Manager's Update view (required)
* '''description''' - A short description of the extension (optional) -- if you choose to use <![CDATA[]]>, double-quotes will break the HTML formatting. Use single quotes with your HTML entities.
* '''element''' - The installed name of the extension (required)
* '''type''' - The type of extension (component, module, plugin, etc.) (required)
* '''folder''' - Specific to plugins, this tag describes the type of plugin being updated (content, system, etc.) (required for plugins)
* '''client_id''' - The client_id of the extension; 0 for site and 1 for administrator (required for plugins) (required for modules also in 1.7.3. Shouldn't be required once 2.5 is stable.)
* '''version''' - The version of the release (required)
* '''infourl''' - A URL to point users to containing information about the update (optional)
* '''downloads''' - The section which lists all download locations
** '''downloadurl''' - The URL to download the extension from; the <downloadurl> tag has two required parameters:
*** '''type''' - The type of package (full or upgrade)
*** '''format''' - The format of the package (zip, tar, etc.)
* '''tags''' - Optional (unknown use)
* '''maintainer''' - The name of the extension maintainer (similar to the <author> tag in a manifest) (optional)
* '''maintainerurl''' - The website of the extension maintainer (similar to the <authorUrl> tag in a manifest) (optional)
* '''section''' - Optional (unknown use)
* '''targetplatform''' - A tag to define platform requirements, requires the following elements
** '''name''' - The name of the platform dependency; as of this writing, it should ONLY be "joomla"
** '''version''' - The version of Joomla! the extension supports
*** '''Note:''' If your extension is both Joomla! 1.6 and 1.7 compatible, you will be required to have two <update> definitions; one with the targetplaform being 1.6 and the other being 1.7 due to the manner in which the updater checks the version

A separate <update> definition will be required for each version of your extension you release.

= Supporting Tools =
Maintaining your update server files can be difficult depending on the manner in which you set up your files. An extension which can help you to maintain this is the Akeeba Release System, available free of charge from https://www.akeebabackup.com

= Contributors =
*[[User:mbabker|Michael Babker]]