Actions

Help34

Difference between revisions of "Extensions Plugin Manager"

From Joomla! Documentation

m (1 revision: Initial import of 3.0 help screens (derived from 2.5 help screens))
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
==Overview==
 
==Overview==
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.
+
The plugin manager is accessed from the back-end Joomla! administrator panel. It is used to edit an installed plugin's details and options.
  
 
==How to Access==
 
==How to Access==
Select '''Extensions → Plug-in Manager''' from the drop-down menu of the '''''Joomla! Administrator Panel'''''.
+
Select '''Extensions → Plugin Manager''' from the drop-down menu of the '''''Joomla! Administrator Panel'''''.
  
 
==Description==
 
==Description==
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.
+
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.
  
 
==Screenshot==
 
==Screenshot==
Line 13: Line 13:
 
==Column Headers==
 
==Column Headers==
 
* '''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.
 
* '''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.
* '''Name.''' The name of the plug-in.
+
* '''Name.''' The name of the plugin.
 
* '''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.
 
* '''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.
 
* '''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.
 
* '''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.
Line 20: Line 20:
 
** Registered: Only users with registered status or higher will have access
 
** Registered: Only users with registered status or higher will have access
 
** Special: Only users with author status or higher 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'.
+
* '''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 plugin files are located. For example, plugins 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'
+
* '''Element.''' The plug-in 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.''' 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.
+
* '''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).
 
* '''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==
 
==List Filters==
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.
+
The list of plugins 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.
  
  
Line 39: Line 39:
 
'''Filter by Access, State and Type'''
 
'''Filter by Access, State and Type'''
  
In the upper right area, above the column headings, are 3 drop-down list boxes as shown below:
+
In the upper left area, are 3 drop-down list boxes as shown below:
  
 
[[Image:Help30-Extensions-Plugin-Manager-filter-types-subscreen.png]]
 
[[Image:Help30-Extensions-Plugin-Manager-filter-types-subscreen.png]]
  
 
The selections may be combined. Only items matching all selections will display in the list.
 
The selections may be combined. Only items matching all selections will display in the list.
* 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'
+
* Select Status. Select a status (Enabled or Disabled) from the drop-down list box to show only plugins with the selected state.
* 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 plugins of the selected Type.
* Select Type. Select a Type from the drop-down list box to show only plug-ins of the selected Type.
+
* Select Access. Select the 'Access Level' from the drop-down list box to only show plugins accessible by uses of the selected 'Access Level'
  
 
==Toolbar==
 
==Toolbar==
At the top right you will see the toolbar:
+
At the top of the screen, you will see the toolbar:
  
 
[[Image:Help30-Edit-Enable-Disable-Checkin-Options-Help-toolbar.png]]
 
[[Image:Help30-Edit-Enable-Disable-Checkin-Options-Help-toolbar.png]]
  
 
The functions are:
 
The functions are:
{{Chunk30:Help_screen_toolbar_icon_Edit|plug-in}}
+
{{Chunk30:Help_screen_toolbar_icon_Edit|plugin}}
{{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_Enable|plugin}} 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_Disable|plugins}} 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_Checkin|plugins}}
 
{{Chunk30:Help_screen_toolbar_icon_Options}}
 
{{Chunk30:Help_screen_toolbar_icon_Options}}
 
{{Chunk30:Help_screen_toolbar_icon_Help}}
 
{{Chunk30:Help_screen_toolbar_icon_Help}}
  
 
==Quick Tips==
 
==Quick Tips==
*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.
+
*To enable or disable a group of Plugins, check the check box for each desired Plugin 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.
+
*Starting with Joomla! 1.6, configurable plugin 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==
 
==Related Information==
*To change the Details or Options for a Plug-in: [[Help30:Extensions_Plugin_Manager_Edit|Plugin Manager - Edit]]
+
*To change the Details or Options for a Plugin: [[Help30:Extensions_Plugin_Manager_Edit|Plugin Manager - Edit]]
*To install Plug-ins: [[Help30:Extensions_Extension_Manager_Install|Extension Manager - Install]]
+
*To install Plugins: [[Help30:Extensions_Extension_Manager_Install|Extension Manager - Install]]
*To uninstall Plug-ins: [[Help30:Extensions_Extension_Manager_Manage|Extension Manager - Manage]]
+
*To uninstall Plugins: [[Help30:Extensions_Extension_Manager_Manage|Extension Manager - Manage]]
  
<noinclude>{{cathelp|3.0|Plugin Manager Help Screens|Extensions Help Screens}}</noinclude>
+
<noinclude>{{cathelp|3.0,3.1,3.2,3.3|Plugin Manager Help Screens|Extensions Help Screens}}</noinclude>

Latest revision as of 14:21, 17 August 2015

Overview

The plugin manager is accessed from the back-end Joomla! administrator panel. It is used to edit an installed plugin's details and options.

How to Access

Select Extensions → Plugin Manager from the drop-down menu of the Joomla! Administrator Panel.

Description

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.

Screenshot

Help30-Extensions-Plugin-Manager-screen.png

Column Headers

  • 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.
  • Name. The name of the plugin.
  • 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.
  • 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.
  • 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:
    • Public: Everyone has access including website visitors who have not logged in
    • 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 plugin files are located. For example, plugins with a type of 'authentication' are located in the website directory 'plugins/authentication'.
  • Element. The plug-in 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. 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

The list of plugins 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.


Filter by Partial Name

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.

  • Filter. In the upper left corner just above the column headings is a Filter field and two buttons, as shown below:

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.

Filter by Access, State and Type

In the upper left area, are 3 drop-down list boxes as shown below:

Help30-Extensions-Plugin-Manager-filter-types-subscreen.png

The selections may be combined. Only items matching all selections will display in the list.

  • Select Status. Select a status (Enabled or Disabled) from the drop-down list box to show only plugins with the selected state.
  • Select Type. Select a Type from the drop-down list box to show only plugins of the selected Type.
  • Select Access. Select the 'Access Level' from the drop-down list box to only show plugins accessible by uses of the selected 'Access Level'

Toolbar

At the top of the screen, you will see the toolbar:

Help30-Edit-Enable-Disable-Checkin-Options-Help-toolbar.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 Title or 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 plugins 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 plugins. Works with one or multiple plugins selected.
  • Options. Opens the Options window where settings such as default parameters can be edited.

<translate>

  • Help. Opens this help screen.</translate>

Quick Tips

  • To enable or disable a group of Plugins, check the check box for each desired Plugin and then click the Enable or Disable toolbar button.
  • Starting with Joomla! 1.6, configurable plugin 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