Help310

Difference between revisions of "Extensions Plugin Manager"

From Joomla! Documentation

m (categorisation for 3.2 help screens)
m
 
(67 intermediate revisions by 5 users not shown)
Line 1: Line 1:
==Overview==
+
<noinclude><languages /></noinclude>
The plug-in manager is accessed from the back-end Joomla! administrator panel. It is used to edit an installed plug-in's details and options.
 
  
==How to Access==
+
{{Chunk30:Help_screen_Description_Header/<translate><!--T:62--> en</translate>}}
Select '''Extensions → Plug-in Manager''' from the drop-down menu of the '''''Joomla! Administrator Panel'''''.
+
<translate><!--T:2--> The Plugin Manager allows you to enable and disable Joomla plugins and to edit a plugin's details and options. It is also useful for quickly enabling/disabling multiple plugins at once.</translate>
  
==Description==
+
{{Chunk30:Help_screen_How_To_Access_Header/<translate><!--T:63--> en</translate>}}
The Plug-in Manager allows you to enable and disable Joomla! plug-ins and to edit a plug-in's details and options. It is also useful for quickly enabling/disabling multiple plug-ins at once.
+
{{Chunk30:Help_screen_How_To_Access_By_Menu/<translate><!--T:64--> en</translate>|<translate><!--T:65--> Extensions,Plugins</translate>}}.
  
==Screenshot==
+
{{Chunk30:Help_screen_Screenshot_Header/<translate><!--T:66--> en</translate>}}
[[Image:Help30-Extensions-Plugin-Manager-screen.png]]
+
[[File:Help30-Extensions-Plugin-Manager-screen-<translate><!--T:6--> en</translate>.png|800px|border|none]]
  
==Column Headers==
+
{{Chunk30:Help_screen_Column_Header/<translate><!--T:68--> 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.
+
{{Chunk30:Help_screen_Column_Header_Description/<translate><!--T:82--> en</translate>|<translate><!--T:83--> plugin's</translate>}}
* '''Name.''' The name of the plug-in.
+
:[[File:Help30-extensions-plugins-columns-<translate><!--T:67--> en</translate>.png|800px|border|none]]
* '''Enabled.''' A green circle with a check mark or a red circle showing whether the use of the extension is enabled/disabled. Click the icon to toggle the item between enabled and disabled.
+
{{Chunk30:Help_screen_Column_Header_Ordering/<translate><!--T:57--> en</translate>|<translate><!--T:84--> plugin's</translate>}}
* '''Ordering.''' Ordering. The order to display items. If the list is sorted by this column, you can change the order by clicking the arrows or by entering the sequential order and clicking the 'Save Order' icon which looks like a little floppy disk. Note that the display order on a page is set in the 'Advanced Options' section for each menu item. If that order is set to use something other than 'Order' (for example, 'Title - Alphabetical'), then the order value in this screen will be ignored. If the menu item's order option is set to use 'Order', then the items will display on the page based on the order in this screen.
+
{{Chunk30:Help_screen_Column_Header_Checkbox/<translate><!--T:58--> en</translate>|<translate><!--T:85--> plugin's</translate>}}
* '''Access.''' Which user 'access levels' have access to this item. You can change an item's Access Level by clicking on its name to open it up for editing. The default user 'access levels' which come preconfigured with Joomla! are:
+
{{Chunk30:Help_screen_Column_Header_Status/<translate><!--T:86--> en</translate>|<translate><!--T:102--> plugins</translate>}}
** Public: Everyone has access including website visitors who have not logged in
+
{{Chunk30:Help_screen_Column_Header_Title/<translate><!--T:87--> en</translate>|<translate><!--T:88--> plugin</translate>|<translate><!--T:89--> Plugin Name</translate>}}
** Registered: Only users with registered status or higher will have access
 
** Special: Only users with author status or higher have access
 
* '''Type.''' The Type of the plug-in. Some possible types are: authentication, content, editors, editors-xtd, search, system, and user. These are also the names of the website sub-directories where the plug-in files are located. For example, plug-ins with a type of 'authentication' are located in the website directory 'plugins/authentication'.
 
* '''Element.''' The plug-in directory name which contains the plug-in's files. This directory will be located in the directory which corresponds to its type. For example, the 'Authentication - Joomla' plug-in is of type 'Authentication' and element 'joomla'. So the website directory it is located in is 'plugins/authentication/joomla'
 
* '''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.
 
* '''Display #.''' The number of items to display on one page. 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).
 
  
==List Filters==
+
<translate><!--T:12--> * '''Type'''. The Type of the plugin. Some possible types are: authentication, content, editors, editors-xtd, search, system, and user. These are also the names of the website sub-directories where the plugin files are located. For example, plugins with a type of 'authentication' are located in the website directory 'plugins/authentication'.</translate>
The list of plug-ins which appears on this screen may be very large. You can use one of the available filters or any combination of them to limit the number of plug-ins displayed to just the plug-ins which match your filter parameters.
 
  
 +
<translate><!--T:13--> * '''Element'''. The plugin directory name which contains the plugin's files. This directory will be located in the directory which corresponds to its type. For example, the 'Authentication - Joomla' plugin is of type 'Authentication' and element 'joomla'. So the website directory it is located in is 'plugins/authentication/joomla'.</translate>
 +
{{Chunk30:Help_screen_Column_Header_Access/<translate><!--T:61--> en</translate>|<translate><!--T:90--> plugin</translate>}}
 +
{{Chunk30:Help_screen_Column_Header_Id/<translate><!--T:60--> en</translate>|<translate><!--T:91--> plugin</translate>}}
 +
{{Chunk30:Help_screen_Column_Filtering_Header/<translate><!--T:69--> en</translate>}}
 +
{{Chunk30:Help_screen_Column_Filtering_Sort_Number/<translate><!--T:70--> en</translate>|<translate><!--T:71--> Type ascending</translate>}}
 +
:[[File:Help30-colheader-Column-filter-type-ascending-number-<translate><!--T:72--> en</translate>.png|right]]
 +
{{Chunk30:Help_screen_Column_Filtering_Sort_Number_Description/<translate><!--T:73--> en</translate>}}
 +
{{Chunk30:Help_screen_Column_Filtering_Order/<translate><!--T:74--> en</translate>|<translate><!--T:92--> Type ascending</translate>}}
 +
{{Chunk30:Help_screen_Column_Filtering_Number/<translate><!--T:75--> en</translate>|<translate><!--T:93--> plugin's</translate>}}
  
'''Filter by Partial Name'''
+
{{Chunk30:Help_screen_List_Filters_Header/<translate><!--T:76--> en</translate>}}
 +
{{Chunk30:Help_screen_List_Filters_Description/<translate><!--T:95--> en</translate>|<translate><!--T:96--> plugin's</translate>}}
 +
{{Chunk30:Help_screen_List_Filters/<translate><!--T:97--> en</translate>}}
 +
{{Chunk30:Help_screen_List_Filters_Search_Tools/<translate><!--T:98--> en</translate>}}
 +
{{Chunk30:Help_screen_List_Filters_Search_Tools_Boxes/<translate><!--T:99--> en</translate>|4}}
 +
:[[File:Help30-Extensions-Plugin-Manager-filter-types-subscreen-<translate><!--T:28--> en</translate>.png|800px|none]]
 +
<translate><!--T:30--> * '''- Select Status -'''. Select a Status (Disabled or Enabled) from the drop-down list box to show only plugin's with the selected status.</translate>
  
You can filter the list of items by typing in all of part of its name. Or you can select a combination of Access Level, Enable/Disable State and Type.
+
<translate><!--T:31--> * '''- Select Type -'''. Select a Type from the drop-down list box to show only plugin's of the selected Type.</translate>
* Filter. In the upper left corner just above the column headings is a Filter field and two buttons, as shown below:
 
[[Image:Help30-Extensions-Plugin-Manager-filter-name-subscreen.png]]
 
  
If you have a large number of items on the list, you can use this filter to find the desired item(s) quickly. Enter either all or part of the name and press 'Search' to display the matching items. You can enter in whole words or part of a word. For example, 'ooml' will match all titles with the word 'Joomla!' in them.
+
<translate><!--T:54--> * '''- Select Element -'''. Select a Element from the drop-down list box to show only plugin's of the selected Element.</translate>
  
'''Filter by Access, State and Type'''
+
<translate><!--T:32--> * '''- Select Access -'''. Select the 'Access Level' from the drop-down list box to only show plugin's accessible by uses of the selected 'Access Level'.</translate>
  
In the upper right area, above the column headings, are 3 drop-down list boxes as shown below:
+
{{Chunk30:Help_screen_Automatic_Pagination_Header/<translate><!--T:77--> en</translate>}}
 +
{{Chunk30:Help_screen_Page_Controls/<translate><!--T:78--> en</translate>|<translate><!--T:94--> plugin's</translate>}}
  
[[Image:Help30-Extensions-Plugin-Manager-filter-types-subscreen.png]]
+
{{Chunk30:Help_screen_Toolbar_Header/<translate><!--T:79--> en</translate>}}
 +
{{Chunk30:Help_screen_Toolbar_Position/<translate><!--T:100--> en</translate>}}
 +
:[[File:Help30-Edit-Enable-Disable-Checkin-Options-Help-toolbar-<translate><!--T:35--> en</translate>.png|800px|none]]
 +
{{Chunk30:Help_screen_Toolbar_Function/<translate><!--T:101--> en</translate>}}
 +
{{Chunk30:Help_screen_toolbar_icon_Edit/<translate><!--T:37--> en</translate>|<translate><!--T:38--> plugin</translate>}}
 +
{{Chunk30:Help_screen_toolbar_icon_Enable/<translate><!--T:39--> en</translate>|<translate><!--T:40--> plugin</translate>}} <translate><!--T:55--> You may also toggle between 'Enabled' and 'Disabled' by clicking on the icon in the 'Enabled' column.</translate>
 +
{{Chunk30:Help_screen_toolbar_icon_Disable/<translate><!--T:41--> en</translate>|<translate><!--T:42--> plugin's</translate>}} <translate><!--T:56--> You may also toggle between 'Enabled' and 'Disabled' by clicking on the icon in the 'Enabled' column.</translate>
 +
{{Chunk30:Help_screen_toolbar_icon_Checkin/<translate><!--T:43--> en</translate>|<translate><!--T:44--> plugin's</translate>}}
 +
{{Chunk30:Help_screen_toolbar_icon_Help/<translate><!--T:45--> en</translate>}}
 +
{{Chunk30:Help_screen_toolbar_icon_Options/<translate><!--T:46--> en</translate>}}
  
The selections may be combined. Only items matching all selections will display in the list.
+
{{Chunk30:Help_screen_Quick_Tips_Header/<translate><!--T:80--> en</translate>}}
* Select Access. Select the 'Access Level' from the drop-down list box to only show plug-ins accessible by uses of the selected 'Access Level'
+
<translate><!--T:48--> *To enable or disable a group of Plug-ins, check the check box for each desired Plug-in and then click the 'Enable' or 'Disable' toolbar button.</translate>
* Select State. Select a state (Enabled or Disabled) from the drop-down list box to show only plug-ins with the selected state.
 
* Select Type. Select a Type from the drop-down list box to show only plug-ins of the selected Type.
 
  
==Toolbar==
+
<translate><!--T:49--> *You may see the terms 'options' and 'parameters' used interchangeably in help documentation and tutorials you encounter.</translate>
At the top right you will see the toolbar:
 
  
[[Image:Help30-Edit-Enable-Disable-Checkin-Options-Help-toolbar.png]]
+
{{Chunk30:Help_screen_Related_Information_Header/<translate><!--T:81--> en</translate>}}
 +
<translate><!--T:51--> *To change the Details or Options for a Plugin: [[S:MyLanguage/Help310:Extensions_Plugin_Manager_Edit|Plugin - Edit]].</translate>
  
The functions are:
+
<translate><!--T:52--> *To install Plugins: [[S:MyLanguage/Help310:Extensions_Extension_Manager_Install|Extension - Install]].</translate>
{{Chunk30:Help_screen_toolbar_icon_Edit|plug-in}}
 
{{Chunk30:Help_screen_toolbar_icon_Enable|plug-in}} You may also toggle between Enabled and Disabled by clicking on the icon in the 'Enabled' column.
 
{{Chunk30:Help_screen_toolbar_icon_Disable|plug-ins}} You may also toggle between Enabled and Disabled by clicking on the icon in the 'Enabled' column.
 
{{Chunk30:Help_screen_toolbar_icon_Checkin|plug-ins}}
 
{{Chunk30:Help_screen_toolbar_icon_Options}}
 
{{Chunk30:Help_screen_toolbar_icon_Help}}
 
  
==Quick Tips==
+
<translate><!--T:53--> *To uninstall Plugins: [[S:MyLanguage/Help310:Extensions_Extension_Manager_Manage|Extension - Manage]].</translate>
*To enable or disable a group of Plug-ins, check the check box for each desired Plug-in and then click the Enable or Disable toolbar button.
 
*Starting with Joomla! 1.6, configurable plug-in settings are referred to as 'options'. In previous versions of Joomla! these configurable settings were referred to as 'parameters'. You may see the terms 'options' and 'parameters' used interchangeably in help documentation and tutorials you encounter.
 
  
==Related Information==
+
<noinclude>
*To change the Details or Options for a Plug-in: [[Help30:Extensions_Plugin_Manager_Edit|Plugin Manager - Edit]]
+
{{cathelp|3.0,3.1,3.2,3.3,3.4,3.5,3.6,3.7,3.8,3.9,3.10|Plugin Manager Help Screens|Extensions Help Screens}}
*To install Plug-ins: [[Help30:Extensions_Extension_Manager_Install|Extension Manager - Install]]
+
</noinclude>
*To uninstall Plug-ins: [[Help30:Extensions_Extension_Manager_Manage|Extension Manager - Manage]]
 
 
 
<noinclude>{{cathelp|3.0,3.1,3.2|Plugin Manager Help Screens|Extensions Help Screens}}</noinclude>
 

Latest revision as of 09:09, 26 March 2022

Other languages:
Deutsch • ‎English • ‎Nederlands • ‎português


Description[edit]

The Plugin Manager allows you to enable and disable Joomla plugins and to edit a plugin's details and options. It is also useful for quickly enabling/disabling multiple plugins at once.


How to Access[edit]

  • Select Extensions  Plugins from the dropdown menu of the Administrator Panel.


Screenshot[edit]

Help30-Extensions-Plugin-Manager-screen-en.png


Column Headers[edit]

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

Help30-extensions-plugins-columns-en.png
  • Ordering. Up-Down ArrowsHelp30-Ordering-colheader-icon.png. User specified ordering, default is order of plugin's creation. When active, drag and drop ordering by 'click and hold' on the bars iconHelp30-Ordering-colheader-grab-bar-icon.png then 'release' in desired position.
  • Checkbox. Check this box to select one or more plugin's. To select all plugin's, check the box in the column heading.
    Note: Many toolbar actions can work with multiple plugin's.
  • Status. Published Help30-Article-status-featured-published-feature-manager-en.png or Unpublished Help30-Article-status-not-published-feature-manager-en.png plugins are shown. Click on the green check mark or the red circle in the Status column to toggle between Published and Unpublished.
  • Plugin Name. The name of the plugin. You can open the plugin for editing by clicking on the Plugin Name.
  • Type. The Type of the plugin. Some possible types are: authentication, content, editors, editors-xtd, search, system, and user. These are also the names of the website sub-directories where the plugin files are located. For example, plugins with a type of 'authentication' are located in the website directory 'plugins/authentication'.
  • Element. The plugin directory name which contains the plugin's files. This directory will be located in the directory which corresponds to its type. For example, the 'Authentication - Joomla' plugin is of type 'Authentication' and element 'joomla'. So the website directory it is located in is 'plugins/authentication/joomla'.
  • ID. This is a unique identification number for this plugin assigned automatically by Joomla. It is used to identify the plugin 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 'Type ascending') and a number (preset to '20') to display.

Help30-colheader-Column-filter-type-ascending-number-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.

  • Type ascending (default). Shows ordering of selected column, ascending or descending.
  • Number of plugin's to display. Shows the number of plugin's to display on one page, default is 20 plugin's. If there are more plugin's 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 plugin's show in the screen. More than one filter may be entered. In this case, only plugin's 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 4 dropdown list boxes.

Help30-Extensions-Plugin-Manager-filter-types-subscreen-en.png
  • - Select Status -. Select a Status (Disabled or Enabled) from the drop-down list box to show only plugin's with the selected status.
  • - Select Type -. Select a Type from the drop-down list box to show only plugin's of the selected Type.
  • - Select Element -. Select a Element from the drop-down list box to show only plugin's of the selected Element.
  • - Select Access -. Select the 'Access Level' from the drop-down list box to only show plugin's accessible by uses of the selected 'Access Level'.


Automatic Pagination[edit]

Page Controls. When the number of plugin's 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-Edit-Enable-Disable-Checkin-Options-Help-toolbar-en.png

The functions are:

  • Edit. Opens the editing screen for the selected plugin. If more than one plugin is selected (where applicable), only the first plugin will be opened. The editing screen can also be opened by clicking on the Name of the plugin.
  • Enable. Makes the selected plugin available for use on your website. You may also toggle between 'Enabled' and 'Disabled' by clicking on the icon in the 'Enabled' column.
  • Disable. Makes the selected plugin's unavailable for use on your website. You may also toggle between 'Enabled' and 'Disabled' by clicking on the icon in the 'Enabled' column.
  • Check-in. Checks-in the selected plugin's. Works with one or multiple plugin's selected.
  • Help. Opens this help screen.
  • Options. Opens the Options window where settings such as default parameters can be edited.


Quick Tips[edit]

  • To enable or disable a group of Plug-ins, check the check box for each desired Plug-in and then click the 'Enable' or 'Disable' toolbar button.
  • You may see the terms 'options' and 'parameters' used interchangeably in help documentation and tutorials you encounter.


Related Information[edit]