Actions

Help25

Difference between revisions of "Extensions Plugin Manager"

From Joomla! Documentation

(Amended toolbar section.)
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==Overview==
+
{{RightTOC}}{{page|needs images}}
 
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 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.
  
Line 9: Line 9:
  
 
==Screenshot==
 
==Screenshot==
[[Image:help25-plugin_manager-screen.png]]
+
[[Image:Help25-plugin-manager-screenshot.png]]
  
 
==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 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.
+
{{Chunk25:colheader|Status}}
 
* '''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.
 +
* '''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'
 
* '''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:
 
* '''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
 
** Public: Everyone has access including website visitors who have not logged in
 
** 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'.
+
{{Chunk25:colheader|Id}}
* '''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==
 
==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 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 Title===
  
'''Filter by Partial Name'''
+
You can filter the list of items by typing part of the plugins name or the ID number of the plugin.
 
+
[[Image:help25-banners-manage-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:
+
[[Image:help25-plugin_manager-filter-name.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.
 
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'''
+
===Filter by Published State, Client, Category, and Language===
 
+
In the upper right area, above the column headings, there are three drop-down list boxes as shown below:
In the upper right area, above the column headings, are 3 drop-down list boxes as shown below:
+
  
[[Image:help25-plugin_manager-filter-types.png]]
+
[[Image:Help25-plugin-manager-filter-attributes.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'
+
{{Chunk25:colheader|Select Access}}
* Select State. Select a state (Enabled or Disabled) from the drop-down list box to show only plug-ins with the selected state.
+
{{Chunk25:colheader|Select Status}}
* Select Type. Select a Type from the drop-down list box to show only plug-ins of the selected Type.
+
{{Chunk25:colheader|Select Type}}
  
 
==Toolbar==
 
==Toolbar==
Line 63: Line 59:
 
==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 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.
+
*Configurable plug-in settings are referred to as 'options'. In Joomla! 1.5 and lower 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==
Line 70: Line 66:
 
*To uninstall Plug-ins: [[Help25:Extensions_Extension_Manager_Manage|Extension Manager - Manage]]
 
*To uninstall Plug-ins: [[Help25:Extensions_Extension_Manager_Manage|Extension Manager - Manage]]
  
<noinclude>{{cathelp|2.5|Plugin Manager|Extensions}}</noinclude>
+
<noinclude>{{cathelp|2.5|Plugin Manager Help Screens|Extensions Help Screens}}</noinclude>

Revision as of 08:43, 21 March 2013

Contents

Copyedit.png
This Page Needs Your Help

This page is tagged because it NEEDS IMAGES. You can help the Joomla! Documentation Wiki by contributing to it.
More pages that need help similar to this one are here. NOTE-If you feel the need is satistified, please remove this notice.


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

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

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.

Screenshot

Help25-plugin-manager-screenshot.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 plug-in.
  • Status. (Published/Unpublished/Archived/Trashed) The published status of the item.
  • 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.
  • 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'
  • 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
  • ID. This is a unique identification number for this item assigned automatically by Joomla!. It is used to identify the item internally, and you cannot change this number. When creating a new item, this field displays 0 until you save the new entry, at which point a new ID is assigned to it.

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 Title

You can filter the list of items by typing part of the plugins name or the ID number of the plugin. Help25-banners-manage-filter-name.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 Published State, Client, Category, and Language

In the upper right area, above the column headings, there are three drop-down list boxes as shown below:

Help25-plugin-manager-filter-attributes.png

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

  • Filter by Viewing Access Level. Lets you show only items that have a specified viewing access level. The list box will show the access levels defined for your site, similar to the example below.
    Help25-chunk-colheader-select-access.png
    • - Select Access -: Show items with any viewing access level.
    • <your access level>: Show items only with this viewing access level.
  • Filter by Published Status. Lets you show only items with the selected published status.
    Help25-chunk-colheader-select-status.png
    • - Select Status -: Shows items that are Published and Unpublished. Does not show items that are Trashed or Archived.
    • Published: Shows only items that are Published.
    • Unpublished: Shows only items that are Unpublished.
    • Archived: Shows only items that are Archived.
    • Trashed: Shows only items that are Trashed. Important Note: To permanently delete items:
      1. Change the status of the items to Trashed.
      2. Change the Status filter to Trashed. At this point the trashed items will show and an icon called "Empty trash" will show in the toolbar.
      3. Select the desired trashed items and click on "Empty Trash" in the toolbar. The items will be permanently deleted.
    • All: Shows all items regardless of published status.
  • Select Type. Select a Type from the drop-down list box to show only plug-ins of the selected Type.

Toolbar

At the top right you will see the toolbar:

Help25-Toolbar-Edit-Enable-Disable-Checkin-Options-Help.png

The functions are:

  • Edit. Opens the editing screen for the selected plug-in. If more than one plug-in is selected (where applicable), only the first plug-in will be opened. The editing screen can also be opened by clicking on the Title or Name of the plug-in.
  • Enable. Makes the selected plug-in 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 plug-ins 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 plug-ins. Works with one or multiple plug-ins selected.
  • Options. Opens the Options window where settings such as default parameters or permissions can be edited.
  • Help. Opens this help screen.

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.
  • Configurable plug-in settings are referred to as 'options'. In Joomla! 1.5 and lower 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