Help310

Difference between revisions of "Extensions Extension Manager Discover"

From Joomla! Documentation

(username removed)
 
m
 
(60 intermediate revisions by 7 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 discover and 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:82--> en</translate>}}
*Select '''Extensions → Extension Manager''' from the drop-down menu of the '''''Joomla! Administrator Panel'''''. Then select the '''Discover''' menu item in the '''''Extension manager''''' screen that appears.
+
<translate><!--T:2--> This screen allows you to discover extensions that have not gone through the normal installation process. This provides a method to install large extensions which are not possible to install using the normal process.</translate> <translate><!--T:3--> For example, some extensions are too large in file size to upload using the web interface due to limitations of the web hosting environment.</translate> <translate><!--T:4--> Using this feature you can upload extension files directly to your web server using some other means such as FTP or SFTP and place those extension files into the appropriate directory.</translate> <translate><!--T:5--> You can then use the discover feature to find the newly uploaded extension and activate it in your Joomla! installation. Using the discover operation you can also discover and install multiple extensions at the same time.</translate>
  
==Description==
+
<translate><!--T:6--> An extension can be installed with the discover function by doing the following steps:</translate>
This screen allows you to discover extensions that have not gone through the normal installation process. This provides a method to install large extensions which are not possible to install using the normal process. For example, some extensions are too large in file size to upload using the web interface due to limitations of the web hosting environment. Using this feature you can upload extension files directly to your web server using some other means such as FTP or SFTP and place those extension files into the appropriate directory. You can then use the discover feature to find the newly uploaded extension and activate it in your Joomla! installation. Using the discover operation you can also discover and install multiple extensions at the same time.
+
<translate><!--T:7--> # Upload the uncompressed extension files to the appropriate directory in your Joomla installation. For example, if you wanted to upload a site template extension to your Joomla installation you would create a directory for the template extension in the /templates sub-directory of your Joomla installation. Then you would upload the template extension files into that directory you created.</translate>
 +
<translate><!--T:8--> # After you have uploaded the extension files, go back to the Extension Manager Discover screen and click the '''Discover''' button in the toolbar. This will initiate the search function which will search your Joomla extension directories looking for uninstalled extensions.</translate>
 +
<translate><!--T:9--> # If the extension you uploaded is compatible with Joomla 3.x and is not already installed, it will appear in the listing of discovered extensions in this screen.</translate>
 +
<translate><!--T:10--> # Click the check-box to the left of the discovered extension and then click the '''Install''' button in the toolbar. This will install the extension into your Joomla installation.</translate>
  
==Screenshot==
+
{{Chunk30:Help_screen_How_To_Access_Header/<translate><!--T:83--> en</translate>}}
[[Image:Help30-Extensions-Extension-Manager-Discover-screen.png]]
+
{{Chunk30:Help_screen_How_To_Access_By_Menu/<translate><!--T:84--> en</translate>|<translate><!--T:85--> Extensions,Manage,Discover</translate>}}.
  
==Column Headers==
+
{{Chunk30:Help_screen_Screenshot_Header/<translate><!--T:86--> en</translate>}}
*'''Checkbox.''' Check this box to select one or more items. To select all items, check the box in the column heading. After one or more boxes are checked, click a toolbar button to take an action on the selected item or items.
+
[[File:Help30-Extensions-Extension-Manager-Discover-screen-<translate><!--T:14--> en</translate>.png|800px|border|none]]
*'''Name.''' The name of the extension.
 
*'''Extension Type.''' The extension type - module, plug-in, template, language.
 
*'''Version.''' The version number of the Extension.
 
*'''Date.''' The date this extension was released.
 
*'''Folder.''' If the extension is a plug-in, the subdirectory of your Joomla! installation's /plugins directory where the extension is located. By default Joomla! 3.0 has the following subdirectories in the plugins directory which each represent the different types of plug-ins that are defined by default: authentication, content, editors, editors-xtd, extension, search, system, user.
 
*'''Client.''' Specifies if this is a site or administrator extension.
 
*'''Author.''' The author of this extension.
 
*'''ID.''' The ID number. This is a unique identification number for this item assigned automatically by Joomla!. It is used to identify the item internally, for example in internal links. You cannot change this number.
 
  
==Toolbar==
+
{{Chunk30:Help_screen_Column_Header/<translate><!--T:87--> en</translate>}}
At the top right you will see the toolbar:
+
{{Chunk30:Help_screen_Column_Header_Description/<translate><!--T:95--> en</translate>|<translate><!--T:96--> extensions</translate>}}
 +
:[[File:Help30-Extensions-Extension-Manager-Discover-Columns-Header-<translate><!--T:16--> en</translate>.png|800px|border|none]]
 +
{{Chunk30:Help_screen_Column_Header_Checkbox/<translate><!--T:97--> en</translate>|<translate><!--T:98--> extensions</translate>}}
 +
{{Chunk30:Help_screen_Column_Header_Name/<translate><!--T:99--> en</translate>}}
  
[[Image:Help30-Install-Discover-PurgeCache-Options-Help-toolbar.png]]
+
<translate><!--T:19--> *'''Location'''. Specifies if this is a site or administrator extension.</translate>
  
The functions are:
+
<translate><!--T:20--> *'''Type'''. The extension type - module, plugin, template, language.</translate>
{{Chunk30:Help_screen_toolbar_icon_Install|extension}}
 
{{Chunk30:Help_screen_toolbar_icon_Discover}}
 
{{Chunk30:Help_screen_toolbar_icon_PurgeCache|uninstalled extensions}}
 
{{Chunk30:Help_screen_toolbar_icon_Options}}
 
{{Chunk30:Help_screen_toolbar_icon_Help}}
 
  
==Links to Other Screens==
+
<translate><!--T:21--> *'''Version'''. The version number of the extension.</translate>
At the top left, you will see the following five links:
 
  
[[Image:Help30-Extensions-Extension-Manager-Discover-submenu-subscreen.png‎]]
+
<translate><!--T:22--> *'''Date'''. The date this extension was released.</translate>
*'''Install.''' Links to the [[Help30:Extensions_Extension_Manager_Install|Install Screen]].
 
*'''Update.''' Links to the [[Help30:Extensions_Extension_Manager_Update|Update Screen]].
 
*'''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==
+
<translate><!--T:23--> *'''Author'''. The author of this extension.</translate>
An extension can be installed with the discover function by doing the following steps:
 
# Upload the uncompressed extension files to the appropriate directory in your Joomla! installation. For example, if you wanted to upload a site template extension to your Joomla! installation you would create a directory for the template extension in the /templates sub-directory of your Joomla! installation. Then you would upload the template extension files into that directory you created.
 
# After you have uploaded the extension files, go back to the Extension Manager Discover screen and click the '''Discover''' item in the toolbar. This will initiate the search function which will search your Joomla! extension directories looking for uninstalled extensions.
 
# If the extension you uploaded is compatible with Joomla! 3.0 and is not already installed, it will appear in the listing of discovered extensions in this screen.
 
# Click the check-box to the left of the discovered extension and then click the '''Install''' item in the toolbar. This will install the extension into your Joomla! installation.
 
  
==Quick Tips==
+
<translate><!--T:24--> *'''Folder'''. If the extension is a plugin, the subdirectory of your Joomla installation's /plugins directory where the extension is located. By default Joomla 3.x has the following subdirectories in the plugins directory which each represent the different types of plugins that are defined by default: authentication, content, editors, editors-xtd, extension, search, system, user.</translate>
* If you have many extensions you want to install you can upload them all into the appropriate directories of your Joomla! installation and then use this screen to discover all of them in one operation. You can then install all of the extensions in one step by selecting all of them and pressing the '''Install''' item in the toolbar.
+
{{Chunk30:Help_screen_Column_Header_Id/<translate><!--T:100--> en</translate>|<translate><!--T:101--> extension</translate>}}
 +
{{Chunk30:Help_screen_Column_Filtering_Header/<translate><!--T:88--> en</translate>}}
 +
{{Chunk30:Help_screen_Column_Filtering_Sort_Number/<translate><!--T:102--> en</translate>|<translate><!--T:103--> Name ascending</translate>}}
 +
:[[File:Help35-Column-Filter-Extensions-Manage-Name-Ascending-DisplayNum-<translate><!--T:28--> en</translate>.png|right]]
 +
{{Chunk30:Help_screen_Column_Filtering_Sort_Number_Description/<translate><!--T:104--> en</translate>}}
 +
{{Chunk30:Help_screen_Column_Filtering_Order/<translate><!--T:105--> en</translate>|<translate><!--T:106--> Name ascending</translate>}}
 +
{{Chunk30:Help_screen_Column_Filtering_Number/<translate><!--T:107--> en</translate>|<translate><!--T:108--> extensions</translate>}}
  
==Related Information==
+
{{Chunk30:Help_screen_List_Filters_Header/<translate><!--T:89--> en</translate>}}
*If you install a Component Extension, it will be listed as a new Menu Item in the ''Components'' menu.
+
{{Chunk30:Help_screen_List_Filters_Description/<translate><!--T:110--> en</translate>|<translate><!--T:111--> extensions</translate>}}
 +
{{Chunk30:Help_screen_List_Filters/<translate><!--T:112--> en</translate>}}
 +
{{Chunk30:Help_screen_List_Filters_Search_Tools/<translate><!--T:113--> en</translate>}}
 +
{{Chunk30:Help_screen_List_Filters_Search_Tools_Boxes/<translate><!--T:114--> en</translate>|3}}
 +
:[[File:Help30-list-filters-location-type-folder-<translate><!--T:115--> en</translate>.png|600px|none]]
 +
<translate>
 +
<!--T:77-->
 +
'''Filter by Location'''
 +
</translate>
 +
:[[File:Help35-colheader-select-location-<translate><!--T:39--> en</translate>.png|right]]
 +
<translate>
 +
<!--T:40-->
 +
*''- Select Location -:'' Select an extension client from the dropdown list box of available locations.</translate>
  
*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.
+
<translate>
 +
<!--T:41-->
 +
*''Site:'' Site extensions are extensions which are designed for use in areas outside of the administrator interface.</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.
+
<translate>
 +
<!--T:42-->
 +
*''Administrator:'' Administrator extensions are for the Backend administrative functions of your Joomla installation. Usually you would only directly interact with these extensions through the administrator web interface.</translate>
 +
{{-}}
 +
<translate>
 +
<!--T:78-->
 +
'''Filter by Type'''
 +
</translate>
 +
:[[File:Help35-colheader-select-extension-type-<translate><!--T:43--> en</translate>.png|right]]
 +
<translate>
 +
<!--T:44-->
 +
*''- Select Type -:'' Select the extension type from the dropdown list box of available types.</translate>
 +
{{-}}
 +
<translate>
 +
<!--T:79-->
 +
'''Filter by Folder'''
 +
</translate>
 +
:[[File:Help35-colheader-select-folder-<translate><!--T:45--> en</translate>.png|right]]
 +
<translate>
 +
<!--T:46-->
 +
*''- Select Folder -:'' Select a plugin folder from the dropdown list box of available folders. There is a separate folder for each type of plug-in defined in your installation of Joomla.</translate>
 +
{{-}}
 +
{{Chunk30:Help_screen_Automatic_Pagination_Header/<translate><!--T:90--> en</translate>}}
 +
{{Chunk30:Help_screen_Page_Controls/<translate><!--T:91--> en</translate>|<translate><!--T:109--> extensions</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.
+
{{Chunk30:Help_screen_Toolbar_Header/<translate><!--T:92--> en</translate>}}
 +
{{Chunk30:Help_screen_Toolbar_Position/<translate><!--T:116--> en</translate>}}
 +
:[[File:Help30-Install-Discover-PurgeCache-Options-Help-toolbar-<translate><!--T:51--> en</translate>.png|800px|none]]
 +
{{Chunk30:Help_screen_Toolbar_Function/<translate><!--T:117--> en</translate>}}
 +
<translate>
 +
<!--T:80-->
 +
*'''Install'''. Installs the selected extension.
 +
</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:81-->
 +
*'''Discover'''. Searches the Joomla installation directories for uninstalled extensions. Any uninstalled extensions found will be displayed in the extension listing. Caches the search results so they continue to be displayed on subsequent visits to this screen.</translate>
 +
{{Chunk30:Help_screen_toolbar_icon_Help/<translate><!--T:55--> en</translate>}}
 +
{{Chunk30:Help_screen_toolbar_icon_Options/<translate><!--T:56--> en</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.
+
{{Chunk30:Help_screen_Quick_Tips_Header/<translate><!--T:93--> en</translate>}}
 +
<translate>
 +
<!--T:69-->
 +
If you have many extensions you want to install you can upload them all into the appropriate directories of your Joomla installation and then use this screen to discover all of them in one operation. You can then install all of the extensions in one step by selecting all of them and pressing the '''Install''' button in the toolbar.</translate>
  
<noinclude>{{cathelp|3.0|Extension Management Help Screens|Discover}}</noinclude>
+
{{Chunk30:Help_screen_Related_Information_Header/<translate><!--T:94--> en</translate>}}
 +
<translate>
 +
<!--T:71-->
 +
*If you install a Component Extension, it will be listed as a new Menu Item in the ''Components'' menu.</translate>
 +
 
 +
<translate>
 +
<!--T:72-->
 +
*You can assign a Menu Item to an installed Component Extension in the [[S:MyLanguage/Help310: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:73-->
 +
*If you install a Module Extension, it will be added to the list of the Modules in the [[S:MyLanguage/Help310: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:74-->
 +
*An installed Plugin Extension will be added to the list of the [[S:MyLanguage/Help310:Extensions_Plugin_Manager|Plugin Manager]], where you can enable/disable it. You can also customize its parameters in the [[S:MyLanguage/Help310:Extensions_Plugin_Manager_Edit|Plugin Edit]] screen.</translate>
 +
 
 +
<translate>
 +
<!--T:75-->
 +
*An installed Template Extension will be added to the Site or Administrator list of the [[S:MyLanguage/Help310: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:76-->
 +
*An installed Language Extension will be added to the Site or Administrator list of the [[S:MyLanguage/Help310: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>
 +
 
 +
{{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 09:08, 26 March 2022

Other languages:
Deutsch • ‎English • ‎Nederlands


Description[edit]

This screen allows you to discover extensions that have not gone through the normal installation process. This provides a method to install large extensions which are not possible to install using the normal process. For example, some extensions are too large in file size to upload using the web interface due to limitations of the web hosting environment. Using this feature you can upload extension files directly to your web server using some other means such as FTP or SFTP and place those extension files into the appropriate directory. You can then use the discover feature to find the newly uploaded extension and activate it in your Joomla! installation. Using the discover operation you can also discover and install multiple extensions at the same time.

An extension can be installed with the discover function by doing the following steps:

  1. Upload the uncompressed extension files to the appropriate directory in your Joomla installation. For example, if you wanted to upload a site template extension to your Joomla installation you would create a directory for the template extension in the /templates sub-directory of your Joomla installation. Then you would upload the template extension files into that directory you created.
  2. After you have uploaded the extension files, go back to the Extension Manager Discover screen and click the Discover button in the toolbar. This will initiate the search function which will search your Joomla extension directories looking for uninstalled extensions.
  3. If the extension you uploaded is compatible with Joomla 3.x and is not already installed, it will appear in the listing of discovered extensions in this screen.
  4. Click the check-box to the left of the discovered extension and then click the Install button in the toolbar. This will install the extension into your Joomla installation.


How to Access[edit]

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


Screenshot[edit]

Help30-Extensions-Extension-Manager-Discover-screen-en.png


Column Headers[edit]

In the table containing extensions these are the different columns as shown below. Click on the column heading to sort the list by that column's value.

Help30-Extensions-Extension-Manager-Discover-Columns-Header-en.png
  • Checkbox. Check this box to select one or more extensions. To select all extensions, check the box in the column heading.
    Note: Many toolbar actions can work with multiple extensions.
  • Name. The name of the extension.
  • Location. Specifies if this is a site or administrator extension.
  • Type. The extension type - module, plugin, template, language.
  • Version. The version number of the extension.
  • Date. The date this extension was released.
  • Author. The author of this extension.
  • Folder. If the extension is a plugin, the subdirectory of your Joomla installation's /plugins directory where the extension is located. By default Joomla 3.x has the following subdirectories in the plugins directory which each represent the different types of plugins that are defined by default: authentication, content, editors, editors-xtd, extension, search, system, user.
  • ID. This is a unique identification number for this extension assigned automatically by Joomla. It is used to identify the extension internally, and you cannot change this number.

Column Filters[edit]

Above the column headers on the right, there are 2 dropdown input fields, Sort Table By: (preset to 'Name ascending') and a number (preset to '20') to display.

Help35-Column-Filter-Extensions-Manage-Name-Ascending-DisplayNum-en.png

These column sorting input fields shows the current method of sorting applied to the table. Use the dropdown field choices and click the column heading name. Alternatively, click on the column heading to sort the list by that column's value.

This will also change the value in the drop field to correspond with the column header name. The list will then be sorted in order by that column and a sort icon (up or down arrow) will show next to the column name. Click a second time to reverse the sort, which will change the corresponding drop field.

  • Name ascending (default). Shows ordering of selected column, ascending or descending.
  • Number of extensions to display. Shows the number of extensions to display on one page, default is 20 extensions. If there are more extensions than this number, you can use the page navigation buttons to navigate between pages.


List Filters[edit]

The List Filters are a series of controls that let you limit what extensions show in the screen. More than one filter may be entered. In this case, only extensions that meet all of the filter conditions will show on the list.

Filter by Partial Title or ID

In the upper left is a search field and 2 buttons.

Help30-colheader-filter-field-en.png
  • To filter by partial title, enter part of the title and click 'Search' Help30-Search-Button.png
  • To filter by ID number, enter "id:xx", where "xx" is the ID number (for example, "id:29").
  • Click 'Clear' to clear the Filter field and restore the list to its unfiltered state.

Search Tools[edit]

Above the column headings, there are 3 dropdown list boxes.

Help30-list-filters-location-type-folder-en.png

Filter by Location

Help35-colheader-select-location-en.png
  • - Select Location -: Select an extension client from the dropdown list box of available locations.
  • Site: Site extensions are extensions which are designed for use in areas outside of the administrator interface.
  • Administrator: Administrator extensions are for the Backend administrative functions of your Joomla installation. Usually you would only directly interact with these extensions through the administrator web interface.

Filter by Type

Help35-colheader-select-extension-type-en.png
  • - Select Type -: Select the extension type from the dropdown list box of available types.

Filter by Folder

Help35-colheader-select-folder-en.png
  • - Select Folder -: Select a plugin folder from the dropdown list box of available folders. There is a separate folder for each type of plug-in defined in your installation of Joomla.

Automatic Pagination[edit]

Page Controls. When the number of extensions is more than one page, you will see a page control bar as shown below. The current page number being viewed is shaded.

Help30-colheader-pagination-en.png
  • Start: Click to go to the first page.
  • Prev: Click to go to the previous page.
  • Page numbers: Click to go to the desired page.
  • Next: Click to go to the next page.
  • End: Click to go to the last page.


Toolbar[edit]

At the top left you will see the toolbar.

Help30-Install-Discover-PurgeCache-Options-Help-toolbar-en.png

The functions are:

  • Install. Installs the selected extension.
  • Discover. Searches the Joomla installation directories for uninstalled extensions. Any uninstalled extensions found will be displayed in the extension listing. Caches the search results so they continue to be displayed on subsequent visits to this screen.
  • Help. Opens this help screen.
  • Options. Opens the Options window where settings such as default parameters can be edited.


Quick Tips[edit]

If you have many extensions you want to install you can upload them all into the appropriate directories of your Joomla installation and then use this screen to discover all of them in one operation. You can then install all of the extensions in one step by selecting all of them and pressing the Install button in the toolbar.


Related Information[edit]

  • 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/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.