Actions

Help15

Screen.installer.15

From Joomla! Documentation

Revision as of 11:06, 24 June 2008 by Dextercowley (Talk | contribs)

Documentation all together tranparent small.png
Under Construction

This article or section is in the process of an expansion or major restructuring. You are welcome to assist in its construction by editing it as well. If this article or section has not been edited in several days, please remove this template.
This article was last edited by Dextercowley (talk| contribs) 6 years ago. (Purge)

Contents

How to Access

Select Extensions -> Install/Uninstall from the drop-down menu in the Back-end of your Joomla! installation.

Description

Extensions are add-ons to Joomla! that build on and expand the functionality of Joomla!. Extensions are used to add capabilities to Joomla! that do not exist in the base core code. Hundreds of Extensions are available for Joomla!, with more being developed all of the time.

Extensions are categorized into five types, as follows:

  • A Component is a mini-application that renders the main body of the page. Examples of components are Contacts, the Front Page, and News Feeds.
  • A Module is a smaller Extension typically used for rendering a small element that displays across multiple pages. Examples of Modules include Menus and Related Items.
  • A Plugin is a section of code that runs when a pre-defined event happens within Joomla!. For example, editors are plug-ins that run when an edit session is opened.
  • The Language Extension allows for the Front-end and Back-end of Joomla! to be presented in any language for which a language Extension exists. This way, Joomla! can be released in a new language with no changes to the core program.
  • A Template controls the way the content of a web site is displayed, including the location and layout of elements, colors, fonts, and so on. Templates allow the appearance of the web site to be separated from it's content.

This screen is organized into six sections as follows:

  • Install: Allows you to install all types of Extensions.
  • Components, Modules, Plugins, Languages, Templates: Allows you to enable, disable, and uninstall Extensions of each type.

Install Screen

Screenshot

Extension manager install.png

Details

The normal procedure for installing a Joomla! Extension is as follows:

  1. Download one or more archive files (normally ".zip" or "tar.gz" format) from the Extension provider's web site to a local directory on your computer. Note that some Extensions are installed as one file (for example, one Component or Module) while other Extensions might have two or more files (for example, a Component and a Module). If there are two or more parts, each one will have its own archive file.
  2. Use the "Browse" button in the "Upload Package File" to browse to each archive file.
  3. Use the "Upload Package File" button to install the Extension. Joomla! then unpacks the archive file and installs the Extension.
  4. Depending on the Extension, it may be necessary to enable the Extension (for example, in the Module Manager or Plugin Manager).
  • Upload Package File. Browse to the location where you downloaded the Extension's archive file. Then press "Upload File & Install". Joomla! will read the contents of the archive file and install the Extension. When it is finished, the screen will display the message "Install Component Success". If the installation is not successful, an error message will display.
  • Install from Directory. As an alternative to installing from an archive file, you can follow the steps below:
    1. Create a temporary directory on your local hard drive and unpack the Extension's archive file in this temporary directory.
    2. Using FTP, upload the contents of this directory (including files and subdirectories) to a directory on your server.
    3. In the Install Directory field specify the directory where you have uploaded the files and subdirectories of the package.
    4. Click on the Install button and Joomla! will install the contents of the given directory.

When it is finished, the screen will display the message "Install Component Success". If the installation is not successful, an error message will display.

  • Install from URL. A third alternative for installing an Extension is as follows. Instead of downloading the archive file to your local computer, just specify the URL of the target archive file. Then click the "Install" button and Joomla! automatically installs it directly from this URL. Again, the screen will display the message "Install Component Success". If the installation is not successful, an error message will display. Note that, with this method, you will not have a copy of the archive file on your local computer.

Components

Screenshot

Extension manager components.png

Column Headers

  • #. An indexing number automatically assigned by Joomla! for ease of reference.
  • Component. The name of the installed component.
  • Enabled. A green tick or a red X showing whether the use of the component is enabled/disabled. Click the icon to toggle the item between enabled and disabled.
  • Version. The version number of the Extension.
  • Date. The date this extension was released.
  • Author. The author of this extension.
  • Compatibility. A green tick in this column indicates that this extension is compatible with the current Joomla! version. A red "X" indicates that it is not compatible.
  • Display #. The number of items to display on one page. If there are more items than this number, you can use the page navigation buttons (Start, Prev, Next, End, and page numbers) to navigate between pages. Note that if you have a large number of items, it may be helpful to use the Filter options, located above the column headings, to limit which items display (where applicable).

Modules

Screenshot

Extension manager modules.png

Column Headers

  • All / Site Modules / Admin Modules. Optional filter to limit list to selected Modules.
    • All. List all Modules.
    • Site Modules. List only Site Modules.
    • Admin Modules. List only Admin Modules.
  • #. An indexing number automatically assigned by Joomla! for ease of reference.
  • Module. The name of the Module.
  • Client. "Site" indicates a Module that is used for the Joomla! Front-end site. "Admin" indicates a Module that is only used in the Joomla! Back-end of the web site.
  • Version. The version number of the Extension.
  • Date. The date this extension was released.
  • Author. The author of this extension.
  • Compatibility. A green tick in this column indicates that this extension is compatible with the current Joomla! version. A red "X" indicates that it is not compatible.
  • Display #. The number of items to display on one page. If there are more items than this number, you can use the page navigation buttons (Start, Prev, Next, End, and page numbers) to navigate between pages. Note that if you have a large number of items, it may be helpful to use the Filter options, located above the column headings, to limit which items display (where applicable).

Plugins

Screenshot

Extension manager plugins.png

Column Headers

  • All / specific type. Optional filter to limit list to Plugins of one Type. Select a Plugin type (for example, "authentication", "content", "editors", "editors-xtd", "search", "system", "user", or "xmlpc") from the drop-down list box to limit the list to Plugins of this Type.
  • #. An indexing number automatically assigned by Joomla! for ease of reference.
  • Plugin. The name of the Plugin.
  • Type. The Type of the Plugin.
  • Version. The version number of the Extension.
  • Date. The date this extension was released.
  • Author. The author of this extension.
  • Compatibility. A green tick in this column indicates that this extension is compatible with the current Joomla! version. A red "X" indicates that it is not compatible.
  • Display #. The number of items to display on one page. If there are more items than this number, you can use the page navigation buttons (Start, Prev, Next, End, and page numbers) to navigate between pages. Note that if you have a large number of items, it may be helpful to use the Filter options, located above the column headings, to limit which items display (where applicable).

Lanugages

Screenshot

Extension manager languages.png

Column Headers

  • All / Site Languages / Admin Languages. Optional filter to limit list to selected Languages.
    • All. List all Languages.
    • Site Languages. List only Site Languages. Site Languages are Languages applied to the Front-end of the web site.
    • Admin Languages. List only Admin Languages. Admin Languages are Languages applied to the Back-end of the web site.
  • #. An indexing number automatically assigned by Joomla! for ease of reference.
  • Language. The name of the Language.
  • Client. "Site" indicates a Language that is used for the Joomla! Front-end site. "Admin" indicates a Language that is only used in the Joomla! Back-end of the web site.
  • Version. The version number of the Extension.
  • Date. The date this extension was released.
  • Author. The author of this extension.
  • Display #. The number of items to display on one page. If there are more items than this number, you can use the page navigation buttons (Start, Prev, Next, End, and page numbers) to navigate between pages. Note that if you have a large number of items, it may be helpful to use the Filter options, located above the column headings, to limit which items display (where applicable).

Templates

Screenshot

Extension manager templates.png

Column Headers

  • All / Site Templates / Admin Templates. Optional filter to limit list to selected Templates.
    • All. List all Templates.
    • Site Templates. List only Site Templates. Site Templates are Templates applied to the Front-end of the web site.
    • Admin Templates. List only Admin Templates. Admin Templates are Templates applied to the Back-end of the web site.
  • #. An indexing number automatically assigned by Joomla! for ease of reference.
  • Template. The name of the Template.
  • Client. "Site" indicates a Templates that is used for the Joomla! Front-end site. "Admin" indicates a Template that is only used in the Joomla! Back-end of the web site.
  • Version. The version number of the Extension.
  • Date. The date this extension was released.
  • Author. The author of this extension.
  • Compatibility. A green tick in this column indicates that this extension is compatible with the current Joomla! version. A red "X" indicates that it is not compatible.
  • Display #. The number of items to display on one page. If there are more items than this number, you can use the page navigation buttons (Start, Prev, Next, End, and page numbers) to navigate between pages. Note that if you have a large number of items, it may be helpful to use the Filter options, located above the column headings, to limit which items display (where applicable).

Toolbar

At the top right you will see the toolbar:

Extension manager toolbar1.png

  • Uninstall. To uninstall an Extension, select the Extension by checking the radio button next to its name and click this button.
  • Help. Opens this Help Screen.


Extension manager links.png

Quick Tips

Think twice if you want to uninstall a Joomla addon. For example sometimes it is a good idea to unpublish the modules you don't want to show on frontend. Generally the bundled Joomla modules cannot be reinstalled without a hitch.

Disable a component

If you do not want to use a component, then switch to the Components tab and click the green tick in the Enabled column. The green tick will be replaced with a red X. The disabled component will disappear in the Components menu.

Support old Extensions in Legacy Mode

Some old 1.0.x Extensions support Joomla! 1.5 in Legacy Mode. To be able to install such Extensions please open the Plugin Manager screen from the Extensions menu and enable plugin System - Legacy as it is disabled by the default.

You can choose the mode of the installation. The mode used most frequently is the Upload Package File.

Some Core or System addons (Component, Module, Plugin) cannot be uninstalled so cannot be selected for uninstallation. Also the Default Template and Language are disabled for selection.

Important: Do not delete the Default Template and Languege files using FTP because it generates errors in error both front-end and back-end.

When you want to install a 3rd party developed module or plugin which belongs to a component, please keep in mind that you cannot use it unless you first install the related component.

When you uninstall a 3rd party developed component having its own module(s) or plugin(s), these modules cannot be used any more, so please uninstall them as well.

Some components coded by 3rd party developers may have their own modules and/or plugins included in the installer, so make sure the module/plugin directories are writable otherwise the Extension will not work properly.

SECURITY WARNING: Please use only those 3rd party Extensions on your site which you really need. Do not use your live site for testing purposes because it may compromise your site and server.

Please do not install Joomla! Extensions downloaded from warez sites because they may be infected by a virus or malware that cause damage on the server and can contaminate the computer of your visitors! Installing from remote URL can be dangerous as well.

Related Information

An installed component will be registered and listed in the Components menu.

You can assign a menu item to an installed component in the Menu Item Manager by clicking the New toolbar button. You can select it in the Internal Link branch.

An installed module will be added to the list of the Module Manager where you can enable/disable it or customize its parameters.

An installed plugin will be added to the list of the Plugin Manager where you can enable/disable it or customize its parameters.

An installed template will be added to the Site or Administrator list of the Template Manager where you can assign it to all of the pages or to the selected ones and customize its parameters, edit the HTML or CSS source or preview the available module positions.

An installed language will be added to the Site or Administrator list of the Language Manager depending on the client attribute where you can set it as the default language.

System - Legacy plugin should be enabled to be able to install the prepared Joomla! 1.0.x Extensions.