Joomla! Documentation - User contributions [en]

Install from Web

2013-12-18T22:46:32Z

Beat: /* Plugin versions */

The Joomla Install from Web feature was added as part of {{JVer|3.2|Joomla! 3.2|long}} to make installing extensions from the [http://extensions.joomla.org Joomla Extensions Directory (JED)].

To enable it simply go into the Joomla Extension Manager and click on the notice at the top to install the extra plugin needed for it to function (Note there are known issues with Akeeba Backup hiding this message).

==Video Demo==
You can see a video walk through of the Install from web feature here: http://www.youtube.com/watch?v=P33D24gNEUk

{{#ev:youtube|P33D24gNEUk}}

==Information for Extension Developers==
If you already have an extension on JED then you need to make a few small changes to get your extension working on the Joomla Extension Finder. [[Install From Web For Developers|Click Here]] for more information.

==Plugin versions==
* 1.0.2 Initial released version with Joomla 3.2.0 Stable
* 1.0.3 Minor fix for translations escapings (server-side fix for "Sort by rating" to correspond to JED)
* 1.0.4 Minor addition for support of display of commercial/non-commercial "$" icon and for number of reviews and votes in category views (server-side: Same additions and fix of sorting in leaf-category view by rating to reflect JED sorting)
* 1.0.5 Mandatory upgrade for Joomla 3.2.1 to adapt to a change in Javascript introduced by Joomla 3.2.1

[[Category:Extensions]]
[[Category:Extension development]]
[[Category:Extension Installation]]

Install from Web

2013-12-09T15:52:58Z

Beat: /* Plugin versions */

The Joomla Install from Web feature was added as part of {{JVer|3.2|Joomla! 3.2|long}} to make installing extensions from the [http://extensions.joomla.org Joomla Extensions Directory (JED)].

To enable it simply go into the Joomla Extension Manager and click on the notice at the top to install the extra plugin needed for it to function (Note there are known issues with Akeeba Backup hiding this message).

==Video Demo==
You can see a video walk through of the Install from web feature here: http://www.youtube.com/watch?v=P33D24gNEUk

{{#ev:youtube|P33D24gNEUk}}

==Information for Extension Developers==
If you already have an extension on JED then you need to make a few small changes to get your extension working on the Joomla Extension Finder. [[Install From Web For Developers|Click Here]] for more information.

==Plugin versions==
* 1.0.2 Initial released version with Joomla 3.2.0 Stable
* 1.0.3 Minor fix for translations escapings (server-side fix for "Sort by rating" to correspond to JED)
* 1.0.4 Minor addition for support of display of commercial/non-commercial "$" icon and for number of reviews and votes in category views (server-side: Same additions and fix of sorting in leaf-category view by rating to reflect JED sorting)

[[Category:Extensions]]
[[Category:Extension development]]
[[Category:Extension Installation]]

Manifest files

2013-12-07T17:27:34Z

Beat: /* Script file */ Added statement that Joomla Libraries do not support scriptfiles (checked in Joomla 3.2.0 at least)

{{RightTOC}}{{version|2.5,3.x}}
==Introduction==
Within Joomla there are manifest files for all of the extensions. These files include the general installation information as well as parameters for the configuration of the [[extension]] itself. Since Joomla! 2.5 {{JVer|2.5}}, there are very few differences between the manifest file formats for the different [[Extension types (technical definitions)|types of extensions]], allowing each type to access the full power of the Joomla! installer.

==Naming conventions==
The file must be named <tt>manifest.xml</tt> or <tt><extension_name>.xml</tt> and located in the root directory of the installation package.

==Syntax==

=== Root element ===
The primary tag of the installation file is:
<source lang=xml><extension></extension></source>

This starting and closing tags are now valid for all extensions. The new tag <code><extension></code> replaces the old <code><install></install></code> from Joomla {{JVer|1.5}}. The following attributes are allowed within the tag:

{|class="wikitable"
|-
! style="width: 150px" | Attribute || style="width: 150px" | Values || Applicable to || Description
|-
| type || <code>component</code> <code>file</code> <code>language</code> <code>library</code> <code>module</code> <code>package</code> <code>plugin</code> <code>template</code> || All extensions
| This attribute describes the type of the extension for the installer. Based on this type further requirements to sub-tags apply.
|-
| version
| <code>2.5</code> <code>3.0</code> || All extensions
| String that identifies the version of Joomla for which this extension is developed.
|-
| method
| <code>install</code> <code>upgrade</code> || All extensions
| The default value <code>install</code> will be also used if the method attribute is not used. The <code>install</code> value means the installer will gracefully stop if it finds any existing file/folder of the new extension.
|-
| client
| <code>site</code> <code>administrator</code> || Modules
| The client attribute allows you to specify for which application client the new module is available.
|-
| group
| ''string'' || Plugins
| The group name specifies for which group of plugins the new plugin is available. The existing groups are the folder names within the directory <tt>/plugins</tt>. The installer will create new folder names for group names that do not exist yet.
|}

=== Metadata ===

The following elements can be used to insert metadata. None of these elements are required; if they are present, they must be a child of the root element.

<pre>
<name> – raw component name (e.g. com_banners).
<author> – author's name (e.g. Joomla! Project)
<creationDate> – date of creation or release (e.g. April 2006)
<copyright> – a copyright statement (e.g. (C) 2005 - 2011 Open Source Matters. All rights reserved.)
<license> – a license statement (e.g. NU General Public License version 2 or later; see LICENSE.txt)
<authorEmail> – author's email address (e.g. admin@joomla.org)
<authorUrl> – URL to the author's website (e.g. www.joomla.org)
<version> – the version number of the extension (e.g. 1.6.0)
<description> – the description of the component. This is a translatable field. (e.g. COM_BANNERS_XML_DESCRIPTION)
</pre>

Note: The <name> and <description> tags are also translatable fields so that the name and description of the extension can be shown to the user in their native language.

=== Front-end files ===

<source lang="xml">
<files folder="from-folder">
<filename>example.php</filename>
<folder>examples</folder>
</files>
</source>

Files to copy to the front-end directory should be placed in the <code><files></code> element. You can use the optional <code>folder</code> attribute to specify a directory '''in the ZIP package''' to copy '''from'''. Each file to copy must be represented by a <code><filename></code> element. If you want to copy an entire folder at once, you can define it as a <code><folder></code>.

=== Media files ===

<source lang="xml>
<media folder="media" destination="com_example">
<filename>com_example_logo.png</filename>
<folder>css</folder>
<folder>js</folder>
</media>
</source>

This example will copy the file(s) (<tt>/media/com_example_logo.png</tt>) and folders ( <tt>/media/css/</tt> and <tt>/media/js/</tt> ) listed to <tt>/media/com_example/</tt>, creating the <tt>com_example</tt> folder if required. You can use the optional <code>folder</code> attribute to specify a directory '''in the ZIP package''' to copy '''from''' (in this case, <tt>media</tt>).

Extensions should be storing assets they need to be web accessible (JS, CSS, images etc) in <code>media</code>. Amongst other things this feature was added as step in the progression to multi-site support and the eventual move of code files (PHP) out of the web accessible areas of the server.

Ref:
* [https://groups.google.com/forum/#!msg/joomla-dev-cms/4CAASJqFY-k/PvPj14gP29EJ Google Groups - joomla-dev-cms thread]
* [https://groups.google.com/forum/#!msg/joomla-dev-cms/uNmhX98sKbE/p8p68Jke680J Google Groups - joomla-dev-cms thread]

=== Administration section ===

<source lang="xml">
<administration>

</administration>
</source>

The administration section is defined in the <code><administration></code> element. Since only [[Component|components]] apply to both the [[Site (Application)|site]] and the [[Administrator (Application)|administrator]], '''only component manifests can include this element'''.

==== Back-end files ====

Files to copy to the back-end directory should be placed in the <code><files></code> element under the <code><administration></code>. You can use the optional <code>folder</code> attribute to specify a directory '''in the ZIP package''' to copy '''from'''. See ''Front-end files'' for further rules.

==== Menu links and submenus ====

<source lang="xml">
<menu>COM_EXAMPLE</menu>
<submenu>
<menu link="anoption=avalue">COM_EXAMPLE_SUBMENU_ANOPTION</menu>
<menu view="viewname">COM_EXAMPLE_SUBMENU_VIEWNAME</menu>
</submenu>
</source>

The text for the main menu item for the component is defined in the <code><menu></code> item, a child of <code><administration></code>. A <code><submenu></code> element may also be present (also a child of <code><administration></code>), which may contain more menu items defined by <code><menu></code>.

Additionally, each <code><menu></code> item can define the following attributes:

{| class="wikitable"
! style="width: 150px" | Attribute || Description
|-
| link || A link to send the user to when the menu item is clicked
|-
| img || The (relative) path to an image (16x16 pixels) to appear beside the menu item.
Must be an url compatible as a file too (e.g. no spaces) !
| alt ||
|-
| ''string'' || An URL parameter to add to the link. For example, <code><menu view="cpanel">COM_EXAMPLE</menu></code> in com_example's XML manifest would cause the URL of the menu item to be <tt>index.php?option=com_example&view=cpanel</tt>.
|-
|}

The value inside the tag is the menu's label. Unlike Joomla! 1.5, you can not use a natural language string. For example, if you would enter "Example Component" instead of COM_EXAMPLE, it would result in your component name appearing as example-component in the menu and you would be unable to provide a translation. In order to provide a translation you need to create a file named en-GB.com_example.sys.ini in administrator/languages/en-GB (you can use the manifest's <code><languages></code> tag to copy it during installation) or in administrator/components/com_example/language/en-GB. In the latter case, you must not include the translation file in the <code><languages></code> tag. As long as you have placed the language directory in your <code><files></code> tag, it will be copied along when the component is being installed.

The contents of that file should be:
<source>
COM_EXAMPLE="Example Component"
COM_EXAMPLE_SUBMENU_ANOPTION="Another Option"
COM_EXAMPLE_SUBMENU_VIEWNAME="Another View"

</source>

Please note that the language string must be enclosed in double quotes, as per Joomla!'s translation standards. Important note: Joomla! 1.6 and later sorts the Component menu items based on the actual translation of the key you supply in your XML manifest. This means that the sorting order is correct no matter what you call your translation key and no matter which language the site is being displayed in. Essentially, Joomla! 1.6 fixed the wrong sorting of the Components menu experienced under Joomla! 1.5 for the majority (non-English speaking!) of Joomla! users.

{{Needsinfo|In Platform 11.1 no alt attribute processed and if link provide in menu tag other provided attributes were ignore. The other tags are task, view, controller, act, layout, sub. Please confirm this, please.}}

=== Configuration ===
{{warning|Components '''do not support''' configuration definitions '''in the manifest'''. This is a way implemented in Joomla! 1.5. They can define configuration options for multiple levels using [[Component configuration metadata]].}}
The <code><config></code> element, a child of the root, describes the configuration options for the extension. If applicable, the options will be shown by the appropriate Manager (Plugin Manager, Module Manager or Template Manager). '''Configuration options can also be defined in a separate file named <code>config.xml</code>. Its root element should be <code><config></code>.'''

{{:XML JForm form definitions}}

=== SQL ===

<source lang="xml">
<install folder="admin">
<sql>
<file driver="mysql" charset="utf8">sql/example.install.sql</file>
</sql>
</install>
<uninstall folder="admin">
<sql>
<file driver="mysql" charset="utf8">sql/example.uninstall.sql</file>
</sql>
</uninstall>
</source>

In the above example, we put the SQL files in the "admin/sql" folder of the installation package. You have to include the "sql" folder in the administration files.

You can execute SQL during the installation and/or uninstallation using the <code><install></code> and <code><uninstall></code> elements, respectively. A <code><sql></code> element should appear as a child of these elements. <code><sql></code> can contain any number of <code><file></code> elements, each defining a single SQL file to execute. Their database driver types are described by the <code>driver</code> attribute, their character sets by the <code>charset</code> attribute.

==== Update of the SQL schema ====

<source lang="xml">
<update>
<schemas>
<schemapath type="mysql">sql/updates/mysql</schemapath>
<schemapath type="sqlsrv">sql/updates/sqlsrv</schemapath>
</schemas>
</update>
</source>

Since 1.6, there is also an <code><update></code> tag, which allows you to provide a series of SQL files to update the current schema.

=== Language files ===
In Joomla! 1.5, we put extension language files in the Joomla! main language file, using the <languages>..</languages> tag as shown below. '''This tag is considered to be deprecated since Joomla! 1.6.''' We encourage you to put extension 's language files in the extension folder and Joomla! is responsible for the loading of required language files.

<source lang="xml">

<languages folder="langfiles">
<language tag="en-GB">en-GB.com_example.ini</language>
</languages>
</source>

By storing extension language files in the extension folder, you gain benefits when removing a language from the Joomla! installation: As your language files will not be removed, when reinstall the language again you can use those files without installing them again.

The structure of the language folder for frontend and backend is the same. You put them in the language tag (e.g. '''en-GB''' ) of each language in your language folder i.e. '''language/en-GB/'''. You have to specify those folders in the front-end and back-end files too.

In your manifest you simply include the ''''language'''' folder in your files section, the sub-directories for each language automatically be copied. Inside the <files> group you simply add a <folder> element alongside the items in the '''<files>''' group as shown in this example:

<source lang="xml">
<files>
<filename plugin="alpha">alpha.php</filename>
<folder>sql</folder>
<folder>language</folder>
</files>
</source>

During development you can turn on language debugging in the Joomla! global configuration. So you can investigate if the problems arise.

=== Script file ===

<source lang="xml">
<scriptfile>example.script.php</scriptfile>
</source>

An optional '''script file''' (PHP code that is run before, during and/or after installation, uninstallation and upgrading) can be defined using a <code><scriptfile></code> element. This file should contain a class named "<element_name>IntallerScript" where <element_name> is the name of your extension (e.g. com_componentname, mod_modulename, etc.). Plugins requires to state the group (e.g. plgsystempluginname). Library packages do not support scriptfiles. The structure of the class is as follows:

<source lang="php">

class com_componentnameInstallerScript
{
/**
* Constructor
*
* @param JAdapterInstance $adapter The object responsible for running this script
*/
public function __construct(JAdapterInstance $adapter);

/**
* Called before any type of action
*
* @param string $route Which action is happening (install|uninstall|discover_install|update)
* @param JAdapterInstance $adapter The object responsible for running this script
*
* @return boolean True on success
*/
public function preflight($route, JAdapterInstance $adapter);

/**
* Called after any type of action
*
* @param string $route Which action is happening (install|uninstall|discover_install|update)
* @param JAdapterInstance $adapter The object responsible for running this script
*
* @return boolean True on success
*/
public function postflight($route, JAdapterInstance $adapter);

/**
* Called on installation
*
* @param JAdapterInstance $adapter The object responsible for running this script
*
* @return boolean True on success
*/
public function install(JAdapterInstance $adapter);

/**
* Called on update
*
* @param JAdapterInstance $adapter The object responsible for running this script
*
* @return boolean True on success
*/
public function update(JAdapterInstance $adapter);

/**
* Called on uninstallation
*
* @param JAdapterInstance $adapter The object responsible for running this script
*/
public function uninstall(JAdapterInstance $adapter);
}

</source>

=== Update servers ===

<source lang="xml">
<updateservers>
<server type="extension" priority="1" name="Extension Update Site">http://example.com/extension.xml</server>
<server type="collection" priority="2" name="Collection Update Site">http://example.com/collection.xml</server>
</updateservers>
</source>

Update servers can be defined in the <code><updateservers></code> element, a child of the root. This element may contain one or more <code><server></code> element, each describing a location to fetch updates from. Each <code><server></code> item can define the following attributes:

{| class="wikitable"
! style="width: 150px" | Attribute || style="width: 150px" | Values || Description
|-
| type || <code>extension</code> <code>collection</code> || The update server type
|-
| priority || ''integer'' || The priority of the update server
|-
| name || ''string'' || The name of the update server
|}

More info:
* [[J2.5:Developing a MVC Component/Adding an update server|Building a Joomla! Extension - Adding an update server]]
* [[J2.5:Managing Component Updates|Managing Component Updates in Joomla 2.5]]

== Examples ==
For a real-life example, see [https://github.com/joomla/joomla-cms/blob/2.5.x/administrator/components/com_banners/banners.xml the manifest of the Banner component in the latest version of Joomla! 2.5].

The Joomla testing process uses several extensions to test whether the installer works correctly. The latest versions of the manifests of these extensions are:

* [http://svn.joomla.org/project/cms/development/trunk/tests/_data/installer_packages/com_alpha/alpha.xml com_alpha manifest]
* [http://svn.joomla.org/project/cms/development/trunk/tests/_data/installer_packages/mod_alpha/mod_alpha.xml mod_alpha manifest]
* [http://svn.joomla.org/project/cms/development/trunk/tests/_data/installer_packages/plg_system_alpha/alpha.xml plg_system_alpha manifest]
* [http://svn.joomla.org/project/cms/development/trunk/tests/_data/installer_packages/tpl_simple/templateDetails.xml tpl_simple manifest]
* [http://svn.joomla.org/project/cms/development/trunk/tests/_data/installer_packages/lng_xx-XX/xx-XX.xml lng_xx-XX manifest]

== Contributors ==
*[[User:akede|Alex Kempkens]]
*[[User:dperaza|Daniel Peraza]]
*[[User:nikosdion|Nicholas K. Dionysopoulos]]
*[[User:mrs.siam|Prasit Gebsaap]]
*[[User:cppl|Craig Phillips]]

[[Category:Extension development]]
[[Category:Specifications]]

Install from Web

2013-11-20T15:31:30Z

Beat:

Install from Web

2013-11-20T15:30:19Z

Beat:

Archived:Installing Joomla

2013-11-11T17:09:54Z

Beat: /* Hosting requirements */

=Intro=
=== Hosting requirements ===
Installing Joomla! for the first time is very easy. Joomla!’s built-in installer makes setting up your new site a breeze.

Before we start installing Joomla!, there are a couple prerequisites that need to be met to install successfully:

*Hosting - whether you have a dedicated server, or shared hosting plan, you’ll need some sort of web hosting that meets the following requirements:
**PHP v. 5.2.4+
**MySQL 5.0.4+
**Apache 1.3
*MySQL Database - you’ll need access to a MySQL database, as well as the following credentials.
**DB Name
**Host Name
**Username
**Password
*FTP Client - for transferring files to your server. If you don’t already have an FTP client that you use, we recommend [http://filezilla-project.org/download.php?type=client Filezilla] (ensure transfers are set to Binary)
*Latest Release of Joomla! 2.5.X - you can find that here [http://www.joomla.org/download.html Download] .

=== Installation ===

With these requirements met, and resources in place, we are ready to install Joomla

To begin our installation, we’ll first need to move our Joomla installation package to the server. This can be accomplished by simply moving the downloaded package to your server, then unpacking it. Or you can unpack the files on your local computer, then move the Joomla installation over to your server. Either way, the Joomla installation needs to be unpacked in the root of your site.

Caution - if you unpack the files on your own computer, then copy them to your server, be sure to move only the files contained INSIDE the Joomla package. If you transfer the Joomla folder as well, your site will be accessed at ''yoursite.com/''Joomla instead of ''yoursite.com''.

The Joomla installer now makes it very easy to install Joomla.
With the files transferred to your server, access the Joomla installation through your web browser by entering the address of your site, for example ''http://www.example.com''.

=Step 1=
'''Step 1''' is to select your language in the screen above, then press the 'Next' button in the upper right corner.

[[File:J17installscreen1.png|700px]]

=Step 2=
'''Step 2''' runs a series of system and server checks to ensure that Joomla will be able to install, and function correctly. The top section of items should all be green and 'Yes'. If any are not (they'll be red and say "No") then you will need to take action to correct them. The bottom section of items are not required, but are recommended to ensure that Joomla can operate smoothly.

[[File:J17installscreen2.png|700px]]

=Step 3=
'''Step 3''' is to review the GNU license. This is the software license agreement for Joomla use, and simply requires you to press 'Next' in the top right corner after reviewing.

[[File:J17installscreen5.png|700px]]

=Step 4=
'''Step 4''' is configuring the database connection for Joomla. Here you will need to enter the Database type, Hostname, User name, Database name and the Database prefix for the MySQL database you have set up. If your settings are not correct, you might be [[unable to connect to the database]]. An additional option is to change the Table prefix. (Note: Joomla 2.5.x now offers a random default prefix) This may be helpful for security purposes.

[[File:J17installscreen3.png|700px]]

=Step 5=
'''Step 5''' is the FTP Configuration. This step is unnecessary for most sites and its need is usually identified if you find you cannot upload media or images or install Extensions. The details can be added at a later time directly within the '''Global Configuration''' in the Joomla Administration pages. This step is '''not''' required on servers installed on a Windows operating system.

[[File:J17installscreen6.png|700px]]

=Step 6=
'''Step 6''', and the last to installing Joomla, is the '''Site Configuration'''. Here you must add a '''Site Name''', '''Admin User Name''', '''Admin Password''', and '''Admin e-mail address'''. If you are new to Joomla you should also CLICK '''Install the Sample Content''', this will help with learning about Joomla.

[[File:J17installscreen7.png|700px]]

=Step 7=
'''Step 7''' Is the final step. Joomla is now installed! You must now remove the installation directory, this needs to be removed for security reasons to prevent anyone else from coming along and reinstalling Joomla over your existing site.
Click the '''Remove Installation Directory''' button.

[[File:J17installscreen10.png|700px]]
<headertabs/>
[[Category:Installation]]
[[Category:Joomla! 2.5]]

Archived:Installing Joomla

2013-11-11T17:09:31Z

Beat: /* Hosting requirements */

=Intro=
=== Hosting requirements ===
Installing Joomla! for the first time is very easy. Joomla!’s built-in installer makes setting up your new site a breeze.

Before we start installing Joomla!, there are a couple prerequisites that need to be met to install successfully:

*Hosting - whether you have a dedicated server, or shared hosting plan, you’ll need some sort of web hosting that meets the following requirements:
**PHP v. 5.2.4+
**MySQL 5.04+
**Apache 1.3
*MySQL Database - you’ll need access to a MySQL database, as well as the following credentials.
**DB Name
**Host Name
**Username
**Password
*FTP Client - for transferring files to your server. If you don’t already have an FTP client that you use, we recommend [http://filezilla-project.org/download.php?type=client Filezilla] (ensure transfers are set to Binary)
*Latest Release of Joomla! 2.5.X - you can find that here [http://www.joomla.org/download.html Download] .

=== Installation ===

With these requirements met, and resources in place, we are ready to install Joomla

To begin our installation, we’ll first need to move our Joomla installation package to the server. This can be accomplished by simply moving the downloaded package to your server, then unpacking it. Or you can unpack the files on your local computer, then move the Joomla installation over to your server. Either way, the Joomla installation needs to be unpacked in the root of your site.

Caution - if you unpack the files on your own computer, then copy them to your server, be sure to move only the files contained INSIDE the Joomla package. If you transfer the Joomla folder as well, your site will be accessed at ''yoursite.com/''Joomla instead of ''yoursite.com''.

The Joomla installer now makes it very easy to install Joomla.
With the files transferred to your server, access the Joomla installation through your web browser by entering the address of your site, for example ''http://www.example.com''.

=Step 1=
'''Step 1''' is to select your language in the screen above, then press the 'Next' button in the upper right corner.

[[File:J17installscreen1.png|700px]]

=Step 2=
'''Step 2''' runs a series of system and server checks to ensure that Joomla will be able to install, and function correctly. The top section of items should all be green and 'Yes'. If any are not (they'll be red and say "No") then you will need to take action to correct them. The bottom section of items are not required, but are recommended to ensure that Joomla can operate smoothly.

[[File:J17installscreen2.png|700px]]

=Step 3=
'''Step 3''' is to review the GNU license. This is the software license agreement for Joomla use, and simply requires you to press 'Next' in the top right corner after reviewing.

[[File:J17installscreen5.png|700px]]

=Step 4=
'''Step 4''' is configuring the database connection for Joomla. Here you will need to enter the Database type, Hostname, User name, Database name and the Database prefix for the MySQL database you have set up. If your settings are not correct, you might be [[unable to connect to the database]]. An additional option is to change the Table prefix. (Note: Joomla 2.5.x now offers a random default prefix) This may be helpful for security purposes.

[[File:J17installscreen3.png|700px]]

=Step 5=
'''Step 5''' is the FTP Configuration. This step is unnecessary for most sites and its need is usually identified if you find you cannot upload media or images or install Extensions. The details can be added at a later time directly within the '''Global Configuration''' in the Joomla Administration pages. This step is '''not''' required on servers installed on a Windows operating system.

[[File:J17installscreen6.png|700px]]

=Step 6=
'''Step 6''', and the last to installing Joomla, is the '''Site Configuration'''. Here you must add a '''Site Name''', '''Admin User Name''', '''Admin Password''', and '''Admin e-mail address'''. If you are new to Joomla you should also CLICK '''Install the Sample Content''', this will help with learning about Joomla.

[[File:J17installscreen7.png|700px]]

=Step 7=
'''Step 7''' Is the final step. Joomla is now installed! You must now remove the installation directory, this needs to be removed for security reasons to prevent anyone else from coming along and reinstalling Joomla over your existing site.
Click the '''Remove Installation Directory''' button.

[[File:J17installscreen10.png|700px]]
<headertabs/>
[[Category:Installation]]
[[Category:Joomla! 2.5]]

Install from Web

2013-11-08T18:01:12Z

Beat: /* Information for Extension Developers */

Install from Web

2013-11-08T18:00:34Z

Beat: put user info before developers information section

GSOC 2013 Project Ideas

2013-03-05T08:49:11Z

Beat: /* Ideas */

{{RightTOC}}

==Welcome!==
Welcome to the Joomla! Google Summer of Code (GSoC) 2013 project ideas page. As we move forward with the 2013 version of the Joomla! GSoC, we will use this page to develop possible project ideas. Please note that anyone who is interested can participate in this process. You do not have to be a GSoC student or mentor to suggest possible project ideas. Please keep in mind that projects need to be realistically something that is able to be functionally completed by a student working full time for about eight weeks. Thanks!

Discussion of ideas and other GSoC related items is welcome on our Google Group: https://groups.google.com/forum/?fromgroups#!forum/joomla-gsoc-2013

If you are interested in participating as a student please review the materials on applying that are available at [http://www.google-melange.com/gsoc/document/show/gsoc_program/google/gsoc2013/help_page]. We strongly encourage you to ask questions about process and ideas on the mailing list.

If you are interested in serving as a mentor, please fill out the [https://docs.google.com/a/community.joomla.org/spreadsheet/viewform?formkey=dHA2V1lJbThYQXpwMERiRG1FOTZlV3c6MA Mentor Application Form 2013].

==Ideas==

Opportunities exist for students to work with projects from either the Joomla CMS, the Joomla Platform or in some cases a combination of both.

In addition to this ideas list, the Joomla! Community is able to voice their opinion on features they would like to see via the [http://ideas.joomla.org/ Joomla! Idea Pool]. Those wishing to add ideas to this listing are encouraged to review the Idea Pool and base their idea on the input received there. You can also view the past lists for [http://docs.joomla.org/GSOC_2012_Project_Ideas 2012] [http://docs.joomla.org/Summer_of_Code_2010_Project_Ideas 2010] and [http://docs.joomla.org/Summer_of_Code_2009_Project_Ideas 2009], which may be useful for reference. We ask that you keep ideas realistic for the time frame that students will have to complete their projects.

Unless a mentor has proposed a specific project, mentors from the mentor pool will be matched with student projects. However members of the mentor pool are available to answer questions on the Joomla GSoC mailing list.

===Joomla CMS===

* [http://github.com/joomla/joomla-cms Source Code]
* [http://groups.google.com/d/forum/joomla-dev-cms Developer Mailing List]

====Project: Refactor Media Manager====

:'''Brief Explanation:''' The current media manager is outdated and limited. Refactor the media manager to include a better user interface, more robust functionality, and seemless integration for extensions to use. The improvements could include: add other not yet supported medias (PDF, MP·,...), providing a folder tree, file property information, upload capabilities, move/rename files and folders, use of JImage for image basic processing (resize, crop).

:'''Expected Results:''' Refactor the Media Manager to improve the usability, functionality, and reusability of the extension.

:'''Knowledge Prerequisite:''' Joomla Platform, PHP, MySQL, Javascript

:'''Difficulty:''' Medium

====Project: Convert JavaScript from MooTools to jQuery====

:'''Brief explanation:''' Version 3 of the CMS introduced [http://twitter.github.com/bootstrap Twitter Bootstrap] and [http://jquery.com jQuery] to the core code base. Previous versions of the CMS had been using MooTools as the preferred JavaScript library. Currently, both JavaScript libraries are shipped and used within the CMS, which occasionally causes conflicts with a user's JavaScript functionality. The CMS would like to reduce the dependency on MooTools by converting its core JavaScript behaviors from MooTools to jQuery.

:'''Expected Results:''' Dependency on MooTools is reduced within the CMS.

:'''Knowledge Prerequisite:''' Joomla CMS, PHP, JavaScript

:'''Difficulty:''' Medium

====Project: html contenteditable front-end editor for content, categories and modules====

:'''Brief explanation:''' Allow seamless ajax-driven content-editing in the fronted of existing content and allowing to insert new modules.

:'''Expected Results:''' Authors with ACL permissions should be able to directly edit the content (content and categories descriptions and titles) and modules (titles and content/settings, and inserting new modules as well from the front-end. The modules and content parameters editing should not be re-invented but just use the administration interface, if possible in front-end, otherwise with links to the corresponding administration page. This would at least allow to remove the guesswork of which module outputs what result. Using an open-source html-contenteditable javascript editor would help here in the formatting.

:'''Knowledge Prerequisite:''' A good knowledge of Joomla, of jQuery and Ajax techniques would help a lot here.

:'''Difficulty:''' Medium to Hard

{{dablink|Please add your project ideas here, you can use this '''[[GSOC 2013 Project template]]'''}}

===Joomla Platform===

The Joomla Platform allows for ideas that can work within the Joomla CMS, or could be completely separate applications that have no connection at all. The Joomla Platform allows for applications to be built for the command line, process daemons and the web. The follow list outlines some ideas that will be immediately useful for the Joomla Platform project that a student may consider taking on. In addition to PHP libraries, the Joomla Platform also ships with MooTools and project ideas can be related to client-side operations as well as server-side. One emphasis on this year's list is on the incorporation of packages for accessing web services, however other ideas for libraries and packages are welcome. In some instances multiple students may work on different aspects of the project. Two examples of this are unit testing and JStemmer.

References:
*[http://github.com/joomla/joomla-platform github Source Code]
*[http://developer.joomla.org/strategy.html Development Strategy]
*[http://groups.google.com/d/forum/joomla-dev-platform Developer Mailing List]

All code contributions must follow Joomla coding standards and include full unit test coverage.

====Project: Platform Unit Testing====

:'''Brief explanation:''' The Joomla Platform has a good suite of automated Unit Tests, but code coverage is lacking in some areas. The goal of this project is to improve the code coverage by writing unit tests for the Joomla Platform.

:'''Expected Results:''' The student will be expected to review the current [http://developer.joomla.org/coverage/ code coverage report] for the Joomla Platform and write and agreed-upon number of unit tests with particular attention to packages that are below 50% coverage. Preference should be given to non-deprecated classes but the student may choose from either the core tree (/libraries/joomla) or the legacy tree (/libraries/legacy).

:'''Knowledge Prerequisite:''' PHP, PHPUnit

:'''Difficulty:''' Medium

====Project: Object Relational Mapping (ORM) in Joomla====

:'''Explanation:''' Joomla uses an Active Record implementation. Via JTable and JTableNested data are CRUDded in models to and from database tables. Tables for different content types share the same kind of data and therefore code is duplicated. There are plans to solve this with a Unified Content Model (UCM), which would use a shared table for all content and a specialised table per content type. In order to implement that the MVC was simplified and decoupled from several dependecies. A JData class was made to store data in and a JDataMapper to map the database tables (the general content table and the specialised table for the content type) to the data. In terms of Martin Fowler's Patterns of Enterprise Architecture Patterns (PEAA, page 285-292): Class Table Inheritance. This UCM would be a replacement for the current JTable classes.

:This new model still has aspects of the Active Record pattern. A more general Data Mapper would make some implementations easier, especially when one-to-many and many-to-many relations are in play. A lot of this has already been worked out in the PHP-world with ORM-frameworks like Propel and Doctrine. No need to reinvent a complete new wheel; nowadays you can easily integrate other frameworks using Composer/Packagist. Some work has been done to use Doctrine ORM in Joomla extensions, but a more general approach would be great. The JDataMapper-class could eventually be a special case of this, or, as intended, be an interface between JData and a full blown ORM. The UCM-plans would be realised, but in a more general, object oriented and extendible way.

:'''Expected Results:''' The focus for a GSOC-project could be on a more general ORM interface in which specific ORM packages could fit, or could be a specific implementation (like Doctrine) with which core CMS extensions could be refactored. Both the Joomla Platform and the CMS would benefit from this project.

:'''Knowledge Prerequisite:''' Object Relational Mapping theory.

:'''References:'''
:* http://martinfowler.com/eaaCatalog/ and http://www.martinfowler.com/books/eaa.html
:* http://propelorm.org/documentation/
:* http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/index.html
:* https://github.com/eBaySF/joomla-platform/blob/data-package/docs/manual/en-US/chapters/packages/data.md#jdatamapper
:* https://github.com/joomla/joomla-platform/pull/1746

"As I'm using Doctrine when building complex Joomla extensions, I'd love to mentor this project" ~ Herman Peeren

{{dablink|Please add your project ideas here, you can use this '''[[GSOC 2013 Project template]]'''}}

<noinclude>[[Category:Google Summer of Code 2013]]</noinclude>

Upgrading 1.6.5 to 1.7

2011-07-20T07:07:57Z

Beat: Added step 0 to check that installed extensions are Joomla 1.7-compatible, and put word Backup in bold.

{{JVer|1.6}}{{JVer|1.7}}

Joomla! 1.7 introduces a [[#Quick_Update | Quick Update]] for sites already up-to-date with Joomla 1.6.5.

If your site is not already at 1.6.5, or you prefer not to use the [[#Quick_Update | Quick Update]], there are several other options:

* [[#Installation_Manager | Traditional Update using the Installation Manager]]
* [[Upgrading 1.6 from an existing 1.6x version|Sites on 1.6, but not on 1.6.5]]
* [[#Manual_Upload.2FInstallation | Manual Update for 1.6.5]]
* [[Migrating from Joomla 1.5 to Joomla_1.6+]]

== Quick Update ==

For sites already up-to-date running Joomla 1.6.5, upgrading to Joomla 1.7 is now very easy.

0. '''Before you begin, check that all your installed extensions are compatible with Joomla 1.7'''. '''[[Backup | Backup]]''' your website files and database and update first all your extensions to Joomla 1.7-compatible versions. '''This is important'''.

1. In the Administrator, select the '''Extensions-Extensions Manager''' Menu item.

[[Image:1-Extensions-ExtensionManager.png]]

2. Click the '''Update''' Sub menu.

[[Image:2-Extension-Update.png]]

3. Click the '''Purge Cache''', then '''Find Updates''' Buttons in the Button Bar located in the upper right of the page.

[[Image:3-Extension-Manager-Update.png]]

4. Click the checkbox to the left of the Joomla line containing the latest Version Number and, next, press the Update Button in the Button Bar.

'''Be patient while the system downloads and replaces the necessary files.''' This can take several minutes or could update very quickly, depending on your system.

[[Image:4-Update-Joomla.png]]

5. When the update has finished, you will be presented with this page.

[[Image:6-Final.png]]

'''That's it!''' Follow these simple instructions next time you upgrade. Now, it's to keep your Joomla website up-to-date and safe!

==Installation Manager ==

If you aren’t yet comfortable with using the Update Manager to update your site, you’re still ok! There are more easy options to update your site. The second method to update your Joomla! 1.6.5 site to 1.7.0 is to use the extension installer, just as if you were installing a component, module, plugin, or template in your site. This method is specially handy for users updating localized distributions made available by Language Communities.

To update your site using this method, first, download the update package from JoomlaCode. The 1.6.5 > 1.7.0 package can be found [http://joomlacode.org/gf/project/joomla/frs/?action=FrsReleaseBrowse&frs_package_id=5986 here].

{{ambox|image=notice|style=notice|text=If you are not currently on Joomla! 1.6.5, use [[Upgrading 1.6 from an existing 1.6x version|this tutorial]] to update your site to 1.6.5, then resume the process of updating to 1.7}}

After you download the update package, access your Joomla! installer by logging in to your adminstrator control panel, and navigating to the '''Extensions''' > '''Extension Manager''' option in your administrator menu. From here you can select the file you just downloaded, and install it. The Joomla! installer will upload the package, and install it, making any changes to files or the database as needed.

== Manual Upload/Installation ==

The last method available to update your site, involves a little more technical expertise, and should probably only be used if the previous methods won’t work due to a highly complex site or hosting issues (shared hosting for example). ''' As usual back-up your site and your database.''' For most Joomla! sites, the first two methods will successfully update your site. However, updating is still fairly easily, and should not be a problem.

Before you begin, go to global configuration and on the server tab and in the Database Settings area find the database table prefix used by your site.

To update your site manually, you will need to download the 1.6.5 > 1.7.0 update package from JoomlaCode. You can download it [http://joomlacode.org/gf/project/joomla/frs/?action=FrsReleaseBrowse&frs_package_id=5986 here]. Unpack the package and you will find two zip files in it. You will only need the large zip file called <tt>Joomla_1.7.0-Stable-Update_Package.zip</tt> for your update. Using an ftp client, upload the zip file to your server into the root directory of your website, and unpack the files. This will over-write any modified files with new, updated files for 1.7.0. Alternatively, you can unpack the <tt>Joomla_1.7.0-Stable-Update_Package.zip</tt> on your local computer, then copy the un-packed files into your websites root, overwriting the modified files.

After unpacking the files to your website you need to manually delete the files and folders listed in administrator/components/com_admin/script.php.

This is the list of files:

*<tt>/templates/atomic/css/blueprint/src/blueprintcss-0-9-1-cheatsheet-3-5-3-gjms.pdf</tt>
*<tt>/administrator/manifests/packages/joomla.xml</tt>
*<tt>/administrator/templates/bluestork/css/rounded.css</tt>
*<tt>/administrator/templates/bluestork/css/norounded.css</tt>
*<tt>/administrator/templates/bluestork/images/j_corner_bl.png</tt>
*<tt>/administrator/templates/bluestork/images/j_header_right_rtl.png</tt>
*<tt>/administrator/templates/bluestork/images/j_crn_br_dark.png</tt>
*<tt>/administrator/templates/bluestork/images/j_crn_br_black.png</tt>
*<tt>/administrator/templates/bluestork/images/j_crn_tr_black.png</tt>
*<tt>/administrator/templates/bluestork/images/j_crn_bl_dark.png</tt>
*<tt>/administrator/templates/bluestork/images/j_crn_tr_med.png</tt>
*<tt>/administrator/templates/bluestork/images/j_crn_bl_light.png</tt>
*<tt>/administrator/templates/bluestork/images/j_header_right.png</tt>
*<tt>/administrator/templates/bluestork/images/j_crn_br_light.png</tt>
*<tt>/administrator/templates/bluestork/images/j_crn_tl_black.png</tt>
*<tt>/administrator/templates/bluestork/images/j_crn_bl_black.png</tt>
*<tt>/administrator/templates/bluestork/images/j_crn_tr_dark.png</tt>
*<tt>/administrator/templates/bluestork/images/j_crn_bl_med.png</tt>
*<tt>/administrator/templates/bluestork/images/j_header_left.png</tt>
*<tt>/administrator/templates/bluestork/images/j_crn_tl_med.png</tt>
*<tt>/administrator/templates/bluestork/images/j_crn_tl_dark.png</tt>
*<tt>/administrator/templates/bluestork/images/j_crn_br_med.png</tt>
*<tt>/administrator/templates/bluestork/images/j_crn_tl_light.png</tt>
*<tt>/administrator/templates/bluestork/images/j_crn_tr_light.png</tt>
*<tt>/administrator/templates/bluestork/images/j_corner_br.png</tt>
*<tt>/administrator/templates/bluestork/images/j_header_left_rtl.png</tt>
*<tt>/administrator/templates/hathor/html/com_modules/module/modal.php</tt>
*<tt>/administrator/templates/hathor/html/com_modules/module/edit_assignment.php</tt>
*<tt>/administrator/templates/hathor/html/com_menus/item/edit_modules.php</tt>
*<tt>/administrator/templates/hathor/html/com_menus/items/default_batch.php</tt>
*<tt>/administrator/templates/hathor/html/com_languages/language/edit.php</tt>
*<tt>/administrator/templates/hathor/html/com_content/article/edit_metadata.php</tt>
*<tt>/administrator/templates/hathor/html/com_categories/category/edit_metadata.php</tt>
*<tt>/administrator/templates/hathor/html/com_categories/categories/default_batch.php</tt>
*<tt>/administrator/components/com_menus/models/forms/item_options.xml</tt>
*<tt>/administrator/language/overrides/xx-XX.override.ini</tt>
*<tt>/administrator/help/helpsites-16.xml</tt>
*<tt>/administrator/help/en-GB/Components_Content_Categories_Edit.html</tt>
*<tt>/administrator/help/en-GB/Components_Weblinks_Categories_Edit.html</tt>
*<tt>/administrator/help/en-GB/Components_Newsfeeds_Categories_Edit.html</tt>
*<tt>/administrator/help/en-GB/Components_Banners_Categories_Edit.html</tt>
*<tt>/administrator/help/en-GB/Components_Contact_Categories_Edit.html</tt>
*<tt>/media/editors/codemirror/css/docs.css</tt>
*<tt>/media/editors/tinymce/jscripts/tiny_mce/tiny_mce_gzip.js</tt>
*<tt>/media/editors/tinymce/jscripts/tiny_mce/tiny_mce_gzip.php</tt>
*<tt>/media/editors/tinymce/jscripts/tiny_mce/plugins/media/css/content.css</tt>
*<tt>/media/mod_languages/images/ta.gif</tt>
*<tt>/libraries/joomla/config.php</tt>
*<tt>/libraries/joomla/import.php</tt>
*<tt>/libraries/joomla/version.php</tt>

And these folders:

*<tt>/plugins/authentication/example</tt>
*<tt>/plugins/user/example</tt>
*<tt>/plugins/content/example</tt>
*<tt>/plugins/extension/example</tt>
*<tt>/administrator/templates/hathor/html/com_modules/select</tt>
*<tt>/administrator/templates/hathor/html/com_media</tt>
*<tt>/administrator/templates/hathor/html/mod_popular</tt>
*<tt>/administrator/templates/hathor/html/mod_status</tt>
*<tt>/administrator/templates/hathor/html/mod_latest</tt>
*<tt>/administrator/components/com_weblinks/helpers/html</tt>
*<tt>/media/editors/tinymce/jscripts/tiny_mce/plugins/pagebreak/css</tt>
*<tt>/media/editors/tinymce/jscripts/tiny_mce/plugins/pagebreak/img</tt>
*<tt>/media/editors/tinymce/jscripts/tiny_mce/plugins/example</tt>

After you have done this you need to manually update your site's database. To do so locate the file <tt>installation/sql/mysql/joomla_update_17ga.sql</tt>, or the files <tt>/administrator/components/com_admin/sql/updates/mysql/1.7.0-2011-06-06.sql and administrator/components/com_admin/sql/updates/mysql/1.7.0-2011-06-06-2.sql</tt>.

As of July 16th 2011 the file(s) contains:

<source lang="sql">ALTER TABLE `#__languages` ADD COLUMN `ordering` int(11) NOT NULL default 0 AFTER `published`;
ALTER TABLE `#__languages` ADD INDEX `idx_ordering` (`ordering`);
</source>
<source lang="sql">CREATE TABLE IF NOT EXISTS `#__associations` (
`id` VARCHAR(50) NOT NULL COMMENT 'A reference to the associated item.',
`context` VARCHAR(50) NOT NULL COMMENT 'The context of the associated item.',
`key` CHAR(32) NOT NULL COMMENT 'The key for the association computed from an md5 on associated ids.',
PRIMARY KEY `idx_context_id` (`context`, `id`),
INDEX `idx_key` (`key`)
) DEFAULT CHARSET=utf8;

</source>

Inside you will find parts like <code>#__languages</code> and <code>#__associations</code>. Replace the pound sign and the first underscore (<code>#_</code>) with your [[Database Table Prefix|database tables prefix]]. By default this is <code>jos</code>. If you didn't get the prefix before starting, open your site's <tt>configuration.php</tt> and search for <code>$dbprefix</code>. The string inside the single quotes behind it is what you're looking for. So you need to change <code>#__languages</code> to <code>jos_languages</code> and so on.

Once you've done this go to your site's phpmyadmin (or any way you usually manage your database) and open the database your site uses. There will be a tab called SQL, open this. Paste the content of your modified <tt>joomla_update_17ga.sql</tt> inside the text area and press go.

Your site is now updated to Joomla 1.7.

[[Category:Joomla! 1.6]]
[[Category:Joomla! 1.7]]