Actions

Help15

Screen.installer.15

From Joomla! Documentation

Revision as of 12:25, 9 January 2009 by Mic (Talk | contribs)

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 that expand the functionality of Joomla!. Extensions are used to add capabilities to Joomla! that do not exist in the standard package. 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 Plugins 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: Allow you to enable, disable, and uninstall Extensions of each type.

Install Screen

Screenshot

Extension manager install.png

Details

Joomla! Extensions can be installed using one of three methods, as indicated below. Only one method is needed to install a given Extension.

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. Choose one of the methods describe below (usually Package File)
  3. When it is finished, the screen will display the message "Install Component Success". If the installation is not successful, an error message will display.
  4. Depending on the Extension, it may be necessary to enable the Extension (for example, in the Module Manager or Plugin Manager).


  • Package File. (the common way)
  1. Browse to the location where you downloaded the Extension's archive file.
  2. Then press "Upload File & Install". Joomla! will read the contents of the archive file and install the Extension.
  • Install 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.
  • Install 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. Note that, with this method, you will not have a copy of the archive file on your local computer.

Components Screen

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 Screen

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 Screen

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).

Languages Screen

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 Screen

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. Joomla! will uninstall the item and show a message that says "Uninstall Success".
  • Help. Opens this Help Screen.

Links to Other Screens At the top left, you will see the following six links:

Extension manager links.png

Quick Tips

  • Normally it is not necessary or desirable to uninstall a Component, Module, or Plugin that comes with the standard Joomla! installation. If you don't want something to be available on the Front-end, you can just Disable it instead of uninstalling it. Uninstalling core Joomla! Components, Modules, or Plugins can have unintended and undesirable consequences.
  • You can disable a Component just by clicking the green tick in the Enabled column of the Components Screen. This makes the Component unavailable to the web site without having to uninstall it.
  • Some 1.0.x Extensions support Joomla! 1.5 in Legacy Mode. To use this feature, you need to open the Plugin Manager screen from the Extensions menu and enable the Plugin called System - Legacy. Note that this Plugin is disabled by the default.
    • Only Extensions that are supported by the authors in "1.5 Legacy" mode should be operated in this way.
    • Extensions run in "1.5 Legacy" mode will run slightly slower than "1.5 Native" Extensions. In most situations, the performance is not noticeable. However, if there is a choice, "1.5 Native" Extensions are generally preferred.
  • Three alternate installation methods are available, as indicated above in the Install Screen. The most common one is the "Upload Package File" method.
  • Some Core or System Components, Modules, and Plugins cannot be uninstalled, so they cannot be selected to be uninstalled. Also the Default Template and Language are cannot be selected to be uninstalled.
  • Important: Do not delete the Default Template and Languege files using FTP because it generates errors in both the Front-end and Back-end.
  • If you want to install a third-party Module or Plugin that belongs to a Component, you will generally need to install the Component as well as the Module or Plugin in order to use the Module or Plugin. This is normally documented in the Extension's installation instructions on the author's web site.
  • Similarly, if you uninstall a third-party Component that also has its own Modules or Plugins, these Modules and Plugins can no longer be used. So it is normally recommended to uninstall these dependent Modules and Plugins as well.
  • Some Components developed by third party developers may have their own Modules or Plugins included in the installer. In this case, make sure these Module or Plugin directories are writable. Otherwise the Extension will not work properly.
  • SECURITY WARNING: It is recommended that you use only those third-party Extensions on your site that you really need. Do not use your live site for testing purposes because it may compromise your site and server. Test new extensions on a local test web site before deploying them on your live site.
  • 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. For this reason, it is generally recommended that you use the "Upload Package File" or "Install from Directory" options when installing new Extensions.

Related Information

  • If you install a Component Extension, it will be listed as a new Menu Item in the Components menu.
  • You can assign a Menu Item to an installed Component Extension in the Menu Item Manager by clicking the New toolbar button. The new Component will show in the Internal Link list of Menu Item Types.
  • If you install a Module Extension, it will be added to the list of the Modules in the Module Manager, where you can enable/disable it. You can also customize it's parameters in the Module Edit screen.
  • An installed Plugin Extension will be added to the list of the Plugin Manager, where you can enable or disable it. You can also customize its parameters in the Plugin Edit screen.
  • An installed Template Extension 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. You can also customize its parameters, edit the HTML or CSS source, or preview the available Module positions.
  • An installed Language Extension will be added to the Site or Administrator list of the Language Manager, depending on the client attribute of the Extension. This screen let's you assign it as the default language, if desired.
  • The System - Legacy Plugin must be enabled to be able to use Joomla! 1.0.x Extensions in "1.5 Legacy" mode.