Help16

Difference between revisions of "Extensions Plugin Manager"

From Joomla! Documentation

m
Line 1: Line 1:
 +
==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 parameters.
 +
 
==How to Access==
 
==How to Access==
−
Select '''Extensions → Plugin Manager''' from the drop-down menu on the Back-end of your Joomla! installation.
+
Select '''Extensions → Plug-in Manager''' from the drop-down menu of the '''''Joomla! Administrator Panel'''''.
  
 
==Description==
 
==Description==
−
The Plugin Manager allows you to enable and disable Joomla! Plugins and to edit a Plugin's Details and Parameters.
+
The Plug-in Manager allows you to enable and disable Joomla! plug-ins and to edit a plug-in's details and parameters. It is also useful for quickly enabling/disabling multiple plug-ins at once.
  
 
==Screenshot==
 
==Screenshot==
−
[[Image:Plugin_manager.png]]
+
[[Image:help16-plugin_manager-screen.png]]
  
 
==Column Headers==
 
==Column Headers==
−
{{colheader|Number}}
+
* '''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.
−
{{colheader|Checkbox}}
+
* '''Name.''' The name of the plug-in.
−
*'''Plugin Name.''' The Name of the Plugin. Click on the Name to open the Plugin for editing.
+
* '''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.
−
{{colheader|Enabled}}
+
* '''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 parameter is set to use 'Order', then the items will display on the page based on the order in this screen.
−
{{colheader|Order}}
+
* '''Access.''' Which "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 "access levels" which come configured with Joomla! are:
−
{{colheader|Access Level}}
+
** Public: Everyone has access
−
*'''Type.''' The Type of the Plugin. Possible types are: authentication, content, editors, editors-xtd, search, system, user, and xmlrpc. These are also the names of the subfolders where the Plugin files are located. For example, Plugins with a Type of "authentication" are located in the folder "plugins/authentication".  
+
** Registered: Only users with registered status or higher will have access
−
*'''File.''' The name of the Plugin files. Each Plugin has two files, a ".php" file and a ".xml" file. So, for example, the Authentication - Joomla! plugin has two files: "joomla.php" and "joomla.xml".
+
** Special: Only users with author status or higher have access
−
{{colheader|Id}}
+
* '''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".
−
{{colheader|Display #}}
+
* '''Element.''' The plug-in directory name which contains the plug-in's file. 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 can not 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 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.
 +
 
 +
 
 +
'''Filter by Partial Name'''
 +
 
 +
[[Image:help16-plugin_manager-filter-name.png]]
 +
 
 +
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:
 +
 
 +
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 right area, above the column headings, are 3 drop-down list boxes as shown below:
 +
 
 +
[[Image:help16-plugin_manager-filter-types.png]]
 +
 
 +
The selections may be combined. Only items matching all selections will display in the list.
 +
* Select Access. Select the "Access Level" from the dop-down list box to only show plug-ins accessible by uses of the selected "Access Level"
 +
* 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==
 
==Toolbar==
 
At the top right you will see the toolbar:
 
At the top right you will see the toolbar:
  
−
[[Image:Plugin_manager_toolbar.png]]  
+
[[Image:help16-plugin_manager-toolbar.png]]
−
{{toolbaricon|Enable}}
 
−
{{toolbaricon|Disable}}
 
−
{{toolbaricon|Edit}}
 
−
{{toolbaricon|Help}}
 
−
 
 
−
==List Filters==
 
−
'''Filter by Partial Title'''
 
−
 
 
−
You can filter the list of items by typing in part of the Title or the ID number. Or you can select a combination of Category and Published State.
 
−
{{colheader|List Filter}}
 
  
−
'''Filter by Type and State'''
+
*'''Edit.''' Select one item and click on this button to open it in edit mode. If you have more than one item selected (where applicable), the first item will be opened. You can also open an item for editing by clicking on its Title or Name.
−
In the upper right area, above the column headings, are 2 drop-down list boxes as shown below:[[Image:Plugin_manager_filter.png|center]] The selections may be combined. Only items matching both selections will display in the list.
+
*'''Enable.''' To enable one or more items, select them using the Checkbox and press this button. You may also toggle between Enabled and Disabled by clicking on the icon in the "Enabled" column.
−
*'''Select Type.''' Select a Type from the drop-down list box to select only Plugins of this Type.
+
*'''Disable.''' To disable one or more items, select them using the Checkbox and press this button. You may also toggle between Enabled and Disabled by clicking on the icon in the "Enabled" column.
−
*'''Select State.''' Select a state (Enabled or Disabled) from the drop-down list box to select only Plugins with this state.
+
*'''Check In.'''
 +
*'''Options.''' Opens the configuration window for the '''Plug-in Manager'''. In this window you can set '''Plug-in Manager''' access permissions for each user group specified in your Joomla! installation.
 +
*'''Help.''' Opens this Help Screen.
  
 
==Quick Tips==
 
==Quick Tips==

Revision as of 21:01, 5 July 2010

Overview[edit]

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

How to Access[edit]

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

Description[edit]

The Plug-in Manager allows you to enable and disable Joomla! plug-ins and to edit a plug-in's details and parameters. It is also useful for quickly enabling/disabling multiple plug-ins at once.

Screenshot[edit]

Help16-plugin manager-screen.png

Column Headers[edit]

  • 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.
  • 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 parameter is set to use 'Order', then the items will display on the page based on the order in this screen.
  • Access. Which "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 "access levels" which come configured with Joomla! are:
    • Public: Everyone has access
    • 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 file. 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 can not 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[edit]

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.


Filter by Partial Name

Help16-plugin manager-filter-name.png

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:

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 right area, above the column headings, are 3 drop-down list boxes as shown below:

Help16-plugin manager-filter-types.png

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

  • Select Access. Select the "Access Level" from the dop-down list box to only show plug-ins accessible by uses of the selected "Access Level"
  • 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[edit]

At the top right you will see the toolbar:

Help16-plugin manager-toolbar.png

  • Edit. Select one item and click on this button to open it in edit mode. If you have more than one item selected (where applicable), the first item will be opened. You can also open an item for editing by clicking on its Title or Name.
  • Enable. To enable one or more items, select them using the Checkbox and press this button. You may also toggle between Enabled and Disabled by clicking on the icon in the "Enabled" column.
  • Disable. To disable one or more items, select them using the Checkbox and press this button. You may also toggle between Enabled and Disabled by clicking on the icon in the "Enabled" column.
  • Check In.
  • Options. Opens the configuration window for the Plug-in Manager. In this window you can set Plug-in Manager access permissions for each user group specified in your Joomla! installation.
  • Help. Opens this Help Screen.

Quick Tips[edit]

  • To enable or disable a group of Plugins, check the check box for each desired Plugin and then click the Enable or Disable button.

Related Information[edit]

Retrieved from "https://docs.joomla.org/index.php?title=Help16:Extensions_Plugin_Manager&oldid=29110"