Help310

Difference between revisions of "Extensions Extension Manager Install"

From Joomla! Documentation

m (→‎Toolbar: toolbar location)
m
 
(41 intermediate revisions by 5 users not shown)
Line 1: Line 1:
== Overview ==
+
<noinclude><languages /></noinclude>
This screen is accessed from the back-end Joomla! administrator panel. It is used to install extensions into your Joomla! installation. Some examples of extensions are plug-ins, components, and site templates.
 
  
==How to Access==
+
{{Chunk30:Help_screen_Description_Header/<translate><!--T:67--> en</translate>}}
*Select '''Extensions → Extension Manager''' from the drop-down menu of the '''''Joomla! Administrator Panel'''''. Then select the '''Install''' menu item in the '''''Extension manager''''' screen that appears.
+
<translate>
 +
<!--T:2-->
 +
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.</translate>
  
==Description==
+
{{Chunk30:Help_screen_How_To_Access_Header/<translate><!--T:68--> en</translate>}}
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.
+
{{Chunk30:Help_screen_How_To_Access_By_Button/<translate><!--T:72--> en</translate>|<translate><!--T:73--> Install Extensions</translate>}}.
 +
{{Chunk30:Help_screen_How_To_Access_By_Menu/<translate><!--T:69--> en</translate>|<translate><!--T:70--> Extensions,Manage,Install</translate>}}.
  
Extensions are categorized into five types, as follows:
+
{{Chunk30:Help_screen_Screenshot_Header/<translate><!--T:71--> en</translate>}}
* 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.
+
[[File:Help35-Extensions-Extension-Manager-Install-screen-<translate><!--T:12--> en</translate>.png|800px|border|none]]
* 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 its content.
 
  
==Screenshot==
+
<translate>
[[Image:Help30-Extensions-Extension-Manager-Install-screen.png]]
+
<!--T:13-->
 +
Joomla Extensions can be installed using different methods, as indicated below. Only one method is needed to install a given Extension.</translate>
  
==Toolbar==
+
<translate>
At the top left you will see the toolbar:
+
<!--T:14-->
 +
The normal procedure for installing a Joomla Extension is as follows:</translate>
 +
<translate>
 +
<!--T:15-->
 +
# 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.</translate><translate> <!--T:16--> ''Note:'' 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.</translate>
 +
<translate>
 +
<!--T:17-->
 +
# Choose one of the methods describe below (usually 'Upload Package File')</translate>
 +
<translate>
 +
<!--T:18-->
 +
# When it is finished, the screen will display the message "Install Component Success". If the installation is not successful, an error message will display.</translate>
 +
<translate>
 +
<!--T:19-->
 +
# Depending on the Extension, it may be necessary to enable the Extension (for example, in the [[S:MyLanguage/Help30:Extensions_Module_Manager|Module Manager]] or [[S:MyLanguage/Help30:Extensions_Plugin_Manager|Plug-in Manager]]).</translate>
  
[[Image:Help30-Options-Help-toolbar.png]]
+
{{Chunk30:Help_screen_Form_Header/<translate><!--T:74--> en</translate>}}
 +
<translate>
 +
===Upload Package File=== <!--T:22-->
 +
</translate>
 +
<translate>
 +
<!--T:24-->
 +
# Drag and drop or browse to the location where you downloaded the Extension's archive file.</translate>
 +
<translate>
 +
<!--T:25-->
 +
# Joomla will read the contents of the archive file and install the Extension.</translate>
  
The functions are:
+
<translate>
{{Chunk30:Help_screen_toolbar_icon_Options}}
+
===Install from Folder=== <!--T:26-->
{{Chunk30:Help_screen_toolbar_icon_Help}}
+
</translate>
 +
:[[Image:Help38-Extensions-Manager-Install-InstallfromFolder-screen-<translate><!--T:27--> en</translate>.png]]
  
==Links to Other Screens==
+
<translate>
 +
<!--T:28-->
 +
#Create a temporary directory on your local hard drive and unpack the Extension's archive file in this temporary directory.</translate>
 +
<translate>
 +
<!--T:29-->
 +
#Using FTP, upload the contents of this directory (including files and subdirectories) to a directory on your server.</translate>
 +
<translate>
 +
<!--T:30-->
 +
#In the ''Install Directory'' field specify the server directory where you uploaded the files and subdirectories of the package.</translate>
 +
<translate>
 +
<!--T:31-->
 +
#Click on the ''Check and Install'' button and Joomla will install the contents of the given directory.</translate>
  
At the top left, you will see the following five links:
+
<translate>
 +
===Install from URL=== <!--T:32-->
 +
</translate>
 +
:[[Image:Help38-Extensions-Manager-Install-InstallfromUrl-screen-<translate><!--T:33--> en</translate>.png]]
  
[[Image:Help-Extensions-Extension-Manager-Install-submenu-subscreen.png]]
+
<translate>
*'''Install.''' Links to the [[Help30:Extensions_Extension_Manager_Install|Install Screen]].
+
<!--T:34-->
*'''Update.''' Links to the [[Help30:Extensions_Extension_Manager_Update|Update Screen]].
+
:Instead of downloading the archive file to your local computer, just specify the URL of the target archive file. Then click the 'Check and Install' button and Joomla automatically installs it directly from this URL.{{-}}''Note:'' With this method, you will not have a copy of the archive file on your local computer.</translate>
*'''Manage.''' Links to the [[Help30:Extensions_Extension_Manager_Manage|Manage Screen]].
 
*'''Discover.''' Links to the [[Help30:Extensions_Extension_Manager_Discover|Discover Screen]].
 
*'''Warnings.''' Links to the [[Help30:Extensions_Extension_Manager_Warnings|Warnings Screen]].
 
  
==Outline==
+
{{Chunk30:Help_screen_Toolbar_Header/<translate><!--T:75--> en</translate>}}
Joomla! Extensions can be installed using one of three methods, as indicated below. Only one method is needed to install a given Extension.
+
{{Chunk30:Help_screen_Toolbar_Position/<translate><!--T:78--> en</translate>}}
 +
:[[File:Help35-Help-Options-toolbar-<translate><!--T:37--> en</translate>.png|200px|none]]
 +
{{Chunk30:Help_screen_Toolbar_Function/<translate><!--T:79--> en</translate>}}
 +
{{Chunk30:Help_screen_toolbar_icon_Help/<translate><!--T:40--> en</translate>}}
 +
{{Chunk30:Help_screen_toolbar_icon_Options/<translate><!--T:39--> en</translate>}}
  
The normal procedure for installing a Joomla! Extension is as follows:
+
{{Chunk30:Help_screen_Quick_Tips_Header/<translate><!--T:76--> en</translate>}}
# 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.
+
<translate>
# Choose one of the methods describe below ('''usually Package File''')
+
<!--T:53-->
# When it is finished, the screen will display the message "Install Component Success". If the installation is not successful, an error message will display.
+
*If you want to install a third-party Module or Plug-in that belongs to a Component, you will generally need to install the Component as well as the Module or Plug-in in order to use the Module or Plug-in. This is normally documented in the Extension's installation instructions on the author's web site.</translate>
# Depending on the Extension, it may be necessary to enable the Extension (for example, in the [[Help30:Extensions_Module_Manager|Module Manager]] or [[Help30:Extensions_Plugin_Manager|Plugin Manager]]).
+
<translate>
 
+
<!--T:54-->
*'''Package File.''' (the common way)
+
*Similarly, if you uninstall a third-party Component that also has its own Modules or Plug-ins, these Modules and Plug-ins can no longer be used. So it is normally recommended to uninstall these dependent Modules and Plug-ins as well.</translate>
*# Browse to the location where you downloaded the Extension's archive file.
+
<translate>
*# Then press "Upload File & Install". Joomla! will read the contents of the archive file and install the Extension.
+
<!--T:55-->
 
+
*Some Components developed by third party developers may have their own Modules or Plug-ins included in the installer. In this case, make sure these Module or Plug-in directories are writable. Otherwise the Extension will not work properly.</translate>
*'''Install Directory.''' As an alternative to installing from an archive file, you can follow the steps below:
+
<translate>
*#Create a temporary directory on your local hard drive and unpack the Extension's archive file in this temporary directory.
+
<!--T:56-->
*#Using FTP, upload the contents of this directory (including files and subdirectories) to a directory on your server.
+
*<font color="#ff0000">'''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.</translate>
*#In the ''Install Directory'' field specify the server directory where you uploaded the files and subdirectories of the package.
+
<translate>
*#Click on the ''Install'' button and Joomla! will install the contents of the given directory.
+
<!--T:57-->
 
+
*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!</translate>
*'''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.''
+
<translate>
 
+
<!--T:58-->
==Quick Tips==
+
*Installing from remote URL can be dangerous. For this reason, it is generally recommended that you use the 'Upload Package File' or 'Install from Folder' options when installing new Extensions.</translate>
 
 
*Three alternate installation methods are available, as indicated above. The most common one is the "Upload Package File" method.
 
 
 
*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.
 
 
 
*<font color="#ff0000">'''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.
 
 
</font>
 
</font>
  
==Related Information==
+
{{Chunk30:Help_screen_Related_Information_Header/<translate><!--T:77--> en</translate>}}
*If you install a Component Extension, it will be listed as a new Menu Item in the ''Components'' menu.
+
<translate>
 
+
<!--T:5-->
*You can assign a Menu Item to an installed Component Extension in the [[Help30:Menus_Menu_Item_Manager|Menu Item Manager]] by clicking the ''New'' toolbar button. The new Component will show in the Internal Link list of Menu Item Types.
+
Extensions are categorized into 5 types, as follows:</translate>
 
+
<translate>
*If you install a Module Extension, it will be added to the list of the Modules in the [[Help30:Extensions_Module_Manager|Module Manager]], where you can enable/disable it. You can also customize it's parameters in the [[Help30:Extensions_Module_Manager_Edit|Module Edit]] screen.
+
<!--T:6-->
 
+
#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.</translate><br /><translate>
*An installed Plugin Extension will be added to the list of the [[Help30:Extensions_Plugin_Manager|Plugin Manager]], where you can enable/disable it. You can also customize its parameters in the [[Help30:Extensions_Plugin_Manager_Edit|Plugin Edit]] screen.
+
<!--T:60-->
 
+
If you install a Component Extension, it will be listed as a new Menu Item in the ''Components'' menu.</translate>
*An installed Template Extension will be added to the Site or Administrator list of the [[Help30:Extensions_Template_Manager_Styles|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.
+
<translate>
 +
<!--T:61-->
 +
You can assign a Menu Item to an installed Component Extension in the [[S:MyLanguage/Help30:Menus_Menu_Item_Manager|Menu Item Manager]] by clicking the ''New'' toolbar button. The new Component will show in the Internal Link list of Menu Item Types.</translate>
 +
<translate>
 +
<!--T:7-->
 +
#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.</translate><br /><translate>
 +
<!--T:62-->
 +
If you install a Module Extension, it will be added to the list of the Modules in the [[S:MyLanguage/Help30:Extensions_Module_Manager|Module Manager]], where you can enable/disable it. You can also customize it's parameters in the [[S:MyLanguage/Help30:Extensions_Module_Manager_Edit|Module Edit]] screen.</translate>
 +
<translate>
 +
<!--T:8-->
 +
#A '''Plug-in''' 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.</translate><br /><translate>
 +
<!--T:63-->
 +
An installed Plug-in Extension will be added to the list of the [[S:MyLanguage/Help30:Extensions_Plugin_Manager|Plug-in Manager]], where you can enable/disable it. You can also customize its parameters in the [[S:MyLanguage/Help30:Extensions_Plugin_Manager_Edit|Plug-in Edit]] screen.</translate>
 +
<translate>
 +
<!--T:10-->
 +
#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 its content.</translate><br /><translate>
 +
<!--T:64-->
 +
An installed Template Extension will be added to the Site or Administrator list of the [[S:MyLanguage/Help30:Extensions_Template_Manager_Styles|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.</translate>
 +
<translate>
 +
<!--T:9-->
 +
#The '''Language''' Extension allows for the frontend and backend 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.</translate><br /><translate>
 +
<!--T:65-->
 +
An installed Language Extension will be added to the Site or Administrator list of the [[S:MyLanguage/Help30:Extensions_Language_Manager_Installed|Language Manager]], depending on the client attribute of the Extension. This screen let's you assign it as the default language, if desired.</translate>
 +
<translate>
 +
<!--T:21-->
 +
If installed from [https://downloads.joomla.org/extensions/ Joomla Extensions], you will find the '''Install from Web''' component, to install an Extension direct from the [https://extensions.joomla.org/ Joomla Extension Directory].</translate>
  
*An installed Language Extension will be added to the Site or Administrator list of the [[Help30:Extensions_Language_Manager_Installed|Language Manager]], depending on the client attribute of the Extension. This screen let's you assign it as the default language, if desired.
 
  
<noinclude>{{cathelp|3.0|Extension Management Help Screens|Install}}</noinclude>
+
{{cathelp|3.0,3.1,3.2,3.3,3.4,3.5,3.6,3.7,3.8,3.9,3.10|Extension Management Help Screens|Extension Help Screens}}

Latest revision as of 06:28, 31 January 2022

Other languages:
Deutsch • ‎English • ‎Nederlands • ‎français • ‎português


Description[edit]

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.


How to Access[edit]

  • Select Extensions  Manage  Install from the dropdown menu of the Administrator Panel.


Screenshot[edit]

Help35-Extensions-Extension-Manager-Install-screen-en.png

Joomla Extensions can be installed using different 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: 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 'Upload 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 Plug-in Manager).


Form Fields[edit]

Upload Package File[edit]

  1. Drag and drop or browse to the location where you downloaded the Extension's archive file.
  2. Joomla will read the contents of the archive file and install the Extension.

Install from Folder[edit]

Help38-Extensions-Manager-Install-InstallfromFolder-screen-en.png
  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 server directory where you uploaded the files and subdirectories of the package.
  4. Click on the Check and Install button and Joomla will install the contents of the given directory.

Install from URL[edit]

Help38-Extensions-Manager-Install-InstallfromUrl-screen-en.png
Instead of downloading the archive file to your local computer, just specify the URL of the target archive file. Then click the 'Check and Install' button and Joomla automatically installs it directly from this URL.
Note: With this method, you will not have a copy of the archive file on your local computer.


Toolbar[edit]

At the top left you will see the toolbar.

Help35-Help-Options-toolbar-en.png

The functions are:

  • Help. Opens this help screen.
  • Options. Opens the Options window where settings such as default parameters can be edited.


Quick Tips[edit]

  • If you want to install a third-party Module or Plug-in that belongs to a Component, you will generally need to install the Component as well as the Module or Plug-in in order to use the Module or Plug-in. 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 Plug-ins, these Modules and Plug-ins can no longer be used. So it is normally recommended to uninstall these dependent Modules and Plug-ins as well.
  • Some Components developed by third party developers may have their own Modules or Plug-ins included in the installer. In this case, make sure these Module or Plug-in 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 Folder' options when installing new Extensions.


Related Information[edit]

Extensions are categorized into 5 types, as follows:

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

  1. 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.
    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.
  2. A Plug-in 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.
    An installed Plug-in Extension will be added to the list of the Plug-in Manager, where you can enable/disable it. You can also customize its parameters in the Plug-in Edit screen.
  3. 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 its content.
    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.
  4. The Language Extension allows for the frontend and backend 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.
    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.

If installed from Joomla Extensions, you will find the Install from Web component, to install an Extension direct from the Joomla Extension Directory.