Chunk4x

Chunk4x:List of Plugins

From Joomla! Documentation


Other languages:
Deutsch • ‎English • ‎Nederlands

When Joomla! is installed, many plugins are included in the installation. These are described below, along with any options for the plugin.


Contents

Action Log Group

Action Log - Joomla

Record the actions of users on the site for Joomla core extensions so they can be reviewed if required. If this plugin is enabled the latest actions appear in a module in the Home Dashboard:

Help-4x-modules-manager-admin-module-latest-actions-panel-en.png

If the plugin is disabled then the Home Dashboard module does not change. It displays the most recently logged actions.

To view all User Actions Log entries select Users  User Actions Log in the Administrator menu.



API Authentication Group

Authentication is required for access to the API with a url of the form http://example.com/api/index.php/v1/article. For more information see the article on Joomla Core APIs.

API Authentication - Basic Authentication

Used to allow basic authentication to Web Services in Joomla. This plugin has no options.

API Authentication - Joomla Token

Used to allow token-based authentication to Web Services in Joomla. This plugin has no options.



Authentication Group

The plugins in this group are used for standard user login to the Site or Administrator interfaces. The default is Joomla Authentication. The Cookie method is used in conjunction with the Remember Me function for Site login only. The cookie is set after first login with one of the other methods.

Authentication - Cookie

Help4x-Extensions-Plugin-Manager-Edit-Cookie-options-screen-en.png

  • Cookie Lifetime. The number of days until the authentication cookie will expire. Other factors mat cause it to expire before this. Longer lengths are less secure.
  • Key Length. The legth of the key to use to encrypt the cookie. Longer lengths are more secure, but they will slow performance.

Authentication - Joomla

This plugin processes the default User Authentication method in Joomla. It has no options.

Authentication - LDAP

This plugin processes User Authentication against an LDAP server. It has the following options:

Help-4x-Extensions-Plugin-Manager-Edit-ldap-options-screen-en.png

  • Host. The host URL. For example, "openldap.mycompany.org".
  • Port. The port number. The default is 389.
  • LDAP V3. Whether or not this host uses LDAP version 3. The default is LDAP v2.
  • Negotiate TLS. Whether or not to use TLS encryption with this host. If set to "Yes", all traffic to and from this server must be encrypted.
  • Follow Referrals. Whether to set the LDAP_OPT_REFERRALS flag to Yes or No. For Windows 2003 hosts this must be set to No.
  • Authorization Method. "Bind Directly as User" or "Bind and Search".
  • Base DN. The Base DN of your LDAP server.
  • Search String. A query string used to search for a given User. The [search] keyword is replaced by the login typed by the User. For example: "uid=[search]". More than one Search String can be entered. Separate each by a semi-colon ";" character. This is only used when searching.
  • User's DN. The [username] keyword is dynamically replaced by the username typed by the User. An example string is: "uid=[username], dc=[my-domain], dc=[com]". More than one string can be entered. Separate each with a semi-colon ";" character. This is only used if the Authorization Method above is set to "Bind Directly as User".
  • Connect Username and Connect Password. These define connection parameters for the DN lookup phase. For anonymous lookup, leave both of these fields blank. For an Administrative Connection, the "Connect Username" is the username of an administrative account (for example, "Administrator"). In this case, the "Connect password" is the actual password to this administrative account.
  • Map: Full Name. The LDAP attribute that contains the User's full name.
  • Map: Email. The LDAP attribute that contains the User's email address.
  • Map: User ID. The LDAP attribute that contains the User's login ID. For Active Directory, this is "sAMAccountName".
  • Debug. Enables debug hardcoded to level 7.



Behaviour Group

These plugins take care of automatic management of Tags and Versions when a component adds, saves or deletes an item that uses these features. They must be enabled for the functionality to work.

Behaviour - Taggable

Allows content items to be tagged. This plugin has no parameters.

Behaviour - Versionable

Allows content items to be versioned. This plugin has no parameters.



CAPTCHA Group

Captcha is a method to protect forms from submission by robots using Google API Version 2.

Invisible reCAPTCHA requires no user interaction unless the algorithm suspects that the user is a robot. It places an icon with slider at the bottom left or bottom right of the screen, or icon with open slider directly in the form.

Help-4x-Extensions-Plugin-Manager-Edit-captcha-v3-example-en.png

reCAPTCHA places a box requiring user selection directly in the form. It responds with a green tick unless the algorithm suspects that the user is a robot.

Help-4x-Extensions-Plugin-Manager-Edit-captcha-v2-example-en.png

In either case, a suspect response will invoke a puzzle to solve.

After enabling one of the Captcha plugins you need to select a Default Captcha in Global Configuration.

More information: Developer's Guide. You will need a Google account. If you have a Production site and a Development site you can include both domains and localhost in the key registration.

CAPTCHA - Invisible ReCAPTCHA

Help-4x-Extensions-Plugin-Manager-Edit-captcha-invisiblerecaptcha-options-screen-en.png

  • Site key. Used in the JavaScript code that is served to your users.
  • Secret key. Used in the communication between your server and the reCAPTCHA server. Be sure to keep it a secret.
  • Badge. Positioning of the reCAPTCHA badge.
  • Tabindex. The tabindex of the challenge.
  • Callback. (Optional) JavaScript callback, executed after succesful reCAPTCHA response.
  • Expired Callback. (Optional) JavaScript callback, executed when the reCAPTCHA is expired.
  • Error Callback. (Optional) JavaScript callback, executed when the reCAPTCHA encounters an error.

CAPTCHA - ReCAPTCHA

This CAPTCHA plugin uses the reCAPTCHA service to prevent spammers while it helps to digitize books, newspapers and old radio shows. The fields "Site key" and "Secret key" must be filled in before activating.

Help-4x-Extensions-Plugin-Manager-Edit-captcha-recaptcha-options-screen-en.png

This plugin has following options:

  • Version. Version of reCaptcha. It is recommended to all new site to use version 2.0 as version 1.0 has no longer supported by Google.
  • Site key. Used in the JavaScript code that is served to your users.
  • Secret key. Used in the communication between your server and the reCaptcha server. Be sure to keep it a secret.
  • Theme. Defines which theme to use for reCaptcha.
  • Size. Size of reCaptcha view. You can choose either 'Normal' or 'Compact' size to fit in your template.
  • Tabindex. The tabindex of the challenge.
  • Callback. (Optional) JavaScript callback, executed after succesful reCAPTCHA response.
  • Expired Callback. (Optional) JavaScript callback, executed when the reCAPTCHA is expired.
  • Error Callback. (Optional) JavaScript callback, executed when the reCAPTCHA encounters an error.


Content Group

Content - Confirm Consent

Help-4x-Extensions-Plugin-Manager-Edit-confirm-consent-options-screen-en.png

  • Short Privacy Policy. Brief notice of the text which will be displayed above the Privacy Consent Checkbox.
  • Privacy Article. If needed, select/create your Privacy Article to link to your form.

For more information, see Privacy Consent - Plugin Configuration

Content - Contact

Help-4x-Extensions-Plugin-Manager-Edit-content-contact-options-screen-en.png

  • Redirection. You can link the author name to: - Associated contact page, Webpage specified in the associated contact profile, Email specified in the associated contact profile.
  • Apply link also to allias name. Link to the real user data even if an author alias is set in article options.

Content - Email Cloaking

This plugin cloaks all e-mails in content from spambots using JavaScript. This helps prevent e-mails contained in articles from being added to spam e-mail lists. You can disable Email Cloaking inside an article by inserting {emailcloak=off} anywhere in the text of the article. In this case, no e-mail addresses in the article will be cloaked by this plugin.

Help-4x-Extensions-Plugin-Manager-Edit-email-cloaking-options-screen-en.png

  • Mode. How the e-mails will be displayed. Options are "As linkable mailto address" or as "Non-linkable text".

Content - Fields

This plugin allows you to display a custom field which has been inserted with the 'Button - Fields' plugin or using Syntax: {field #} directly into the editor area. Syntax:

  • {field 1} will display the field with the ID 1.
  • {field 1,foo} will display the selected field using the alternative layout 'foo'.
  • {fieldgroup 2} will display all fields within the fieldgroup with the ID 2.

Content - Joomla

Help-4x-Extensions-Plugin-Manager-Joomla-options-screen-en.png

This plugin has following options:

  • Check Category Deletion. Check that categories are fully empty before they are deleted.
  • Email on New Site Article. Email users if 'Send email' is on when there is a new article submitted via the Frontend.

Content - Load Modules

This plugin allows you to place a Module inside an Article with the syntax: {loadposition xx}, where "xx" is a user-defined position code. For example, if you create a Module with the Position value of "myposition1", then typing the text "{loadposition myposition1}" inside an Article will cause that Module to show at that point in the Article. This plugin has the following option:

Help-4x-Extensions-Plugin-Manager-Edit-load-modules-options-screen-en.png

  • Style. The Style for the loaded Module.

Content - Page Break

This plugin adds table of contents functionality to a paginated Article. This is done automatically through the use of the Pagebreak button added to the lower part of the text panel in an Article. The HTML code is included here as a reference of what is available. The Pagebreak will itself display in the text window as a simple horizontal line. This plugin has the following options:

Help-4x-Extensions-Plugin-Manager-Edit-pagebreak-options-screen-en.png

  • Show Site Title. Whether or not the title and heading attributes from the plug-in will be added to the Site Title tag.
  • Article Index Heading. Show or hide Article Index Heading. The Headig displays on top of the Table of Content.
  • Custom Article Index Heading. Enter a custom text for the Article Index Heading. If empty, standard will be used.
  • Table of Contents. Whether to Hide or Show a table of contents for multi-page Articles.
  • Show all. Whether or not to give Users the option to show all pages of an Article.
  • Presentation Style. Display the article with separate pages, tabs or sliders.

Help-4x-Extensions-Plugin-Manager-Edit-pagebreak-description-options-screen-en.png

Content - Page Navigation

This plugin allows you to add Next & Previous navigation links to Articles, for example when using a blog or list layout. This feature can be controlled with the following Joomla! parameters:

Note that, if the Page Navigation plug-in is disabled in this screen, no Page Navigation will show and the parameter settings above will have no effect. This plugin has the following option:

Help-4x-Extensions-Plugin-Manager-Edit-page-navigation-options-screen-en.png

  • Position. Position of the navigation link. Options are "Above" the Article or "Below" the Article.
  • Relative To. Assigns the relative location for the Position parameters. Text will place it directly above or below the article content. Full Article will place it above or below the full display including title and readmore.
  • Link Text. Choose what to display as the link text.

Content - Smart Search

Changes to content will not update the Smart Search index if you do not enable this plugin.

Content - Vote

Help-4x-Extensions-Plugin-Manager-Edit-vote-options-screen-en.png

  • Position. Position of the voting.


Editor Group

Editor plugins help users enter text with markup or layouts for special purposes, such as fragments of html or code. To use an Editor the software developer marks the data entry field as type editor. If no editor plugins are enabled that is displayed as a simple textarea field. With one or more edit plugins enabled the site default plugin is used, set in Global Configuration, unless overridden by the user preferred plugin, set in the User Profile. Joomla has the three core editor plugins listed below. Additional third party editor plugins may be available. Some editors have a very large selection of options.

Editor - CodeMirror

This plugin loads the CodeMirror editor. CodeMirror is a code editor which provides an editor more suited for source code. It provides code syntax highlighting for many programming languages. It can show you mismatched tags and also helps you maintain consistent indenting of your code. It has the following options:

Help-4x-Extensions-Plugin-Manager-Edit-codemirror-options-screen-en.png

  • List numbers. Display line numbers in the editor.
  • Code Folding. Allow blocks of code to be folded.
  • Gutters. Code Marker and Code Folding.
  • Highlight Active Line. Adds a highlight to the line the cursor is on.
  • Highlight Selection Matches. Highlight instances of the selected word throughout the document.
  • Match Tags. Highlight matching tags.
  • Match Brackets. Highlight matching brackets.
  • Tag Completion. Automatic tag completion.
  • Bracket Completion. Automatic bracket completion.
  • Key Map. Make CodeMirror work like other populair editors.
  • Toggle Fullscreen . ASelect the functon key to use to toggle fullscreen mode.
  • Use Modifiers . Slect any modifier keys to use with the fullscreen toggle key.

Help-4x-Extensions-Plugin-Manager-Edit-codemirror-Appearance-options-screen-en.png

  • Theme. Sets the colours for the editor.
  • Active Line Colour. The colour to use for highlighting the active line. Will be displayed at 50% opacity.
  • Matching Tag Colour. The background colour to use for highlighting matching tags. Will be displayed at 50% opacity.
  • Font. The font to use in the editor. If not installed, will be loaded from https://www.google.com/fonts/.
  • Font Size (px) . The size of the font in the editor.
  • Line Height (em) . The height of one line of text. This is in ems, meaning that 1.0 is equal to the font size and 2.0 is equal to 2x the font size.
  • Scrollbar Style . Select the scrollbar style you'd like CodeMirror to use.
  • Preview . An example of what your CodeMirror editor fields will look like with the current settings (save to update).

Editor - None

This plugin loads a basic text editor. This option can be used when you are pasting HTML code from another source and you don't want the HTML to be altered by a WYSIWYG editor. This plugin has no options.

Editor - TinyMCE

This plugin loads the TinyMCE editor. This is the default editor in Joomla!. This plugin has the following options:

Help-4x-Extensions-Plugin-Manager-Edit-tinymce-sets-options-subscreen-en.png

  • Set selection tab. Select "Set 2", "Set 1" or "Set 0" functionality. With "Set 2" selected, you see the editor for "Public" use. "Set 1" selected, is default for Managers and Registered, "Set 0" selected, is default for Administrators, Editors and Super Users.

Each Tab has a long list of options that are not illustrated here. The following list is a selection.

  • Site Skin. Choose the skin which will be applied to the TinyMCE editor when displayed in your website.
  • Administrator Skin. Choose the skin which will be applied to the TinyMCE editor when displayed in your Administrator Backend.
  • Toolbar Mode. Controls how to display the toolbar buttons that are not on the first row.
  • Images Drag and Drop. Enable drag and drop for uploading images.
  • Images Directory. The directory with the images files to be listed relative to the default images folder (set in Media > Options).
  • Entity Encoding. Controls how HTML entities are encoded. Recommended setting is 'raw'. 'named' = used named entity encoding (for example, '<'). 'numeric' = use numeric HTML encoding (for example, '%03c'). raw = Do not encode HTML entities. Note that searching content may not work properly if setting is not 'raw'.
  • Automatic Language Selection. If Yes, editor language will automatically match selected UI language. If the tiny language does not exist, the editor language will default to English.
  • Text Direction. Whether the language reads "Left to Right" or "Right to Left" (for example, like Arabic). Default is "Left to Right".
  • Template CSS Classes. Whether or not to load the "editor.css" file. If no such file is found for the default template, the "editor.css" file from the system template is used. Default is "Yes".
  • Custom CSS Classes. Optional full URL path to a custom CSS file. If entered, this overrides the Template CSS classes setting.
  • URLs. Whether to use Relative or Absolute URLs for links. The default is "Relative".
  • New Lines. Whether to interpret new lines as "P Elements" or "BR Elements". Default is "P Elements".
  • Use Joomla Text Filter. If on, the text filter from the Joomla Global Configuration for every user group is applied. If off, the filters as defined here are used for all user groups.
  • Prohibited Elements. The elements that will be cleaned from the text. Default is "applet", which will remove applet elements from the text.
  • Valid Elements. Defines which elements will stay in the edited text when the editor saves (the default rule set for this option is a mixture of the full HTML5 and HTML4 specification).
  • Extended Valid Elements. Optional list of valid HTML elements to add to the existing rule set.
  • Resizing. Enable/disable the resizing of the editor area (vertically and also horizontally if 'Horizontal Resizing' is enabled).
  • Horizontal Resizing. Enable/disable the horizontal resizing.
  • Element Path. If set to ON, it displays the set classes for the marked text.
  • Word Count. Turn on/off word count.
  • Markdown. Allows the use of Markdown style syntax to create links, lists and other styles. This special syntax is converted and saved as regular html. For example the user can type # text to produce a header or **text** to make text bold.
  • Advanced Image. Turn on/off a more advanced image dialog box.
  • Advanced List. Turn on/off the ability to set number formats and bullet types in ordered and unordered lists.
  • Context Menu. Turn on/off the context menu.
  • Custom Plugin. Add custom TinyMCE plug-ins to the editor by specifying them here.
  • Custom Button. Add custom TinyMCE buttons to the editor by specifying them here.

This plug-in has the following advanced options:

Help-4x-Extensions-Plugin-Manager-Edit-tinymce-advanced-options-subscreen-en.png

  • Number of Sets. Number of sets that can be created. Minimum 3.
  • HTML Height. The height, in pixels, of the HTML mode pop-up window.
  • HTML Width. The width, in pixels, of the HTML mode pop-up window.


Editors-Extended Group

These plugins add items to the CMS Content drop-down list in the TinyMCE editor.

Help-4x-editors-xtd-button-group-list-en.png

Button - Article

Displays a button to insert links to articles into an Article. Displays a popup allowing you to choose the article. This plugin has no options.

Button - Contact

Displays a button to insert links to Contacts in an article. Displays a popup allowing you to choose the contact. This plugin has no options.

Button - Field

Displays a button to insert a custom field into an editor area. Displays a popup allowing you to choose the field. This plugin has no options. Warning!: the custom field will not be rendered if the Content - Fields plugin is not enabled.

Button - Image

Displays a button to insert images into an Article. Displays a popup allowing you to configure an image's properties and upload new image files. This plugin has no options.

Button - Menu

Displays a button to insert menu item links into an Article. Displays a popup allowing you to choose the menu item. This plugin has no options.

Button - Module

Displays a button to insert a module into an Article. Displays a popup allowing you to choose the module. This plugin has no options.

Button - Page Break

This plugin displays the Pagebreak button below the editor box when you are using a Joomla! editor (for example, when writing an Article). It inserts a page break in the Article. This plugin has no options.

Button - Readmore

This plugin displays the "Read more..." button below the editor box when you are using a Joomla! editor (for example, when writing an Article). It inserts a "Read more..." break in the Article that allows you to display just the first portion of an Article on a page. This plugin has no options.


Extension Group

Plugins in this group are called after extension install, update or uninstall to manage various extension-related properties.

Extension - Finder

Manage the common words in Smart Search. This plugin has no options.

Extension - Joomla

Manage the update sites for extensions. This plugin has no options.

Extension - Namespace Updater

Build and update the administrator/cache/autoload_psr4.php file that is used to autoload extensions. Warning! This plugin must be enabled as it runs on extension install, update and deletion. This plugin has no options.



Fields Group

To learn how to use Custom Fields see the tutorial on Adding Custom Fields.

Fields - Calendar

This plugin lets you create new fields of type 'calendar' in any extensions where custom fields are supported.

Fields - Checkboxes

Help-4x-Extensions-Plugin-Manager-Fields-checkboxes-options-subscreen-en.png

  • Checkbox Values. The values of the checkboxes.

Fields - Colour

This plugin lets you create new fields of type 'color' in any extensions where custom fields are supported.

Fields - Editor

Help-4x-Extensions-Plugin-Manager-Fields-editor-options-subscreen-en.png

  • Show Buttons. Should the editors-xtd plugin buttons be shown.
  • Hide Buttons. Select some options.
  • Width. Defines the width (in pixels) of the WYSIWYG editor and defaults to 100%.
  • Height. Defines the height (in pixels) of the WYSIWYG editor and defaults to 250%.
  • Filter. Allow the system to save certain html tags or raw data.

Fields - Imagelist

Help-4x-Extensions-Plugin-Manager-Fields-imagelist-options-subscreen-en.png

  • Directory. The directory with the images files to be listed relative to the default image folder (set in Media > Options).
  • Multiple. Allow multiple values to be selected.
  • Image Class. The class which is added to the image (src tag).

Fields - Integer

Help-4x-Extensions-Plugin-Manager-Fields-integer-options-subscreen-en.png

  • Multiple. Allow multiple values to be selected.
  • First. This value is the lowest on the list.
  • Last. This value is the highest on the list.
  • Step. Each option will be the previous option incremented by this integer, starting with the first value until the last value is reached.

Fields - List

Help-4x-Extensions-Plugin-Manager-Fields-list-options-subscreen-en.png

  • Multiple. Allow multiple values to be selected.
  • List Values. The values of the list.

Fields - Media

Help-4x-Extensions-Plugin-Manager-Fields-media-options-subscreen-en.png

  • Directory. The directory with the images files to be listed relative to the default image folder (set in Media > Options).
  • Preview. Shows or hides the preview of the selected image.
  • Image Class. The class which is added to the image (src tag).

Fields - Radio

Help-4x-Extensions-Plugin-Manager-Fields-radio-options-subscreen-en.png

  • Radio Values. The values of the radio list.

Fields - Repeatable

Plugin to create a repeatable form with customizable fields

Fields - SQL

Help-4x-Extensions-Plugin-Manager-Fields-sql-options-subscreen-en.png

  • Query. The SQL query which will provide the data for the dropdown list. The query must return two columns; one called 'value' which will hold the values of the list items; the other called 'text' with the text in the dropdown list.
  • Multiple. Allow multiple values to be selected.

Fields - Text

Help-4x-Extensions-Plugin-Manager-Fields-text-options-subscreen-en.png

  • Filter. Allow the system to save certain html tags or raw data.
  • Maximum Length. The maximum number of characters that can be entered.

Fields - Textarea

Help-4x-Extensions-Plugin-Manager-Fields-textarea-options-subscreen-en.png

  • Rows. The height of the visible text area in lines. If omitted the height is determined by the browser. The value does not limit the number of lines that may be entered.
  • Colomns. The width of the visible text area in characters. If omitted the width is determined by the browser. The value does not limit the number of characters that may be entered.
  • Maximum Length. The maximum number of characters that can be entered.
  • Filter. Allow the system to save certain html tags or raw data.

Fields - URL

Help-4x-Extensions-Plugin-Manager-Fields-url-options-subscreen-en.png

  • Schemes. The allowed schemes.
  • Relative. Are relative URLs allowed.

Fields - User

This plugin lets you create new fields of type 'user' in any extensions where custom fields are supported.

Fields - Usergrouplist

Help-4x-Extensions-Plugin-Manager-Fields-usergrouplist-options-subscreen-en.png

  • Multiple. Allow multiple values to be selected.


File System Group

File System - Local

Filesystem plugin to define one or multiple local directories to store your media files.

Help-4x-Extensions-Plugin-Manager-Edit-filesystem-local-options-screen-en.png

  • Directories. Select or add directories where images may be stored.



Finder Group

Smart Search - Categories

This plugin indexes Joomla! Categories.

Smart Search - Contacts

This plugin indexes Joomla! Contacts.

Smart Search - Content

Updates the indexes of Joomla! Articles whenever an article is created, modified or deleted. NOTE the Content - Smart Search plugin must be enabled.

Smart Search - News Feeds

This plugin indexes Joomla! News feeds.

Smart Search - Tags

This plugin indexes Joomla! Tags.


Installer Group

These plugins control which tabs appear in the System  Install Panel  Extensions page.

Installer - Install from Folder

This plugin allows you to install packages from a folder.

Installer - Install from URL

This plugin allows you to install packages from a URL.

Installer - Install from Upload

This plugin allows you to install packages from your local computer.

Installer - Install from Web

Help-4x-Extensions-Plugin-Manager-Installer-install-from-web-options-subscreen-en.png

  • Tab Position. Place the Install from Web tab first or last.

Installer - Override

This plugin enables notifications and handling of overrides after an update in case of changes.


Media Action Group

This group of plugins allow image crop, resize and rotate functions. In the media manager hover over a thumbnail, select the menu symbol (...) and then the edit symbol (pencil). That opens the image edit screen:

Help-4x-Content-Media-Manager-Edit-screen-en.png

Media Action - Crop

Adds crop functionality for images. This plugin has no options.

Media Action - Resize

Resize functionality for images. This plugin has no options.

Media Action - Rotate

Adds rotate functionality for images. This plugin has no options.



Privacy Group

The Privacy plugins collect and organise date that are seen in Privacy components and modules. For more information see the Privacy Tutorial.

Privacy - Action Logs

This plugin is responsible for exporting the action log data for a user's privacy request. This plugin has no options.

Privacy - Contacts

This plugin processes privacy related requests for the core Joomla contact data. This plugin has no options.

Privacy - Content

This plugin has no options.

Privacy - User Accounts

This plugin processes privacy related requests. This plugin has no options.

Privacy - User Messages

This plugin processes privacy related requests for the core Joomla user messages data. This plugin has no options.


Quick Icon Group

Quick Icons appear in panels in the Home Dashboard to provide easy visual access to Joomla features as an alternative to using the Administrator Menus. Some of the Quick Icons obtain additional information after initial display. The plugins are used to obtain that additional information. For example, this is the Update Checks panel showing that two Extension updates are available.

Help-4x-Extensions-Plugin-Manager-QuickIcon-ExtensionsUpdatesNotification-example-en.png

If you watch page load or reload carefully you will see the icons change colour from blue to green or red, signifying up to date or not up to date. If you disable a plugin it will not appear on the Home Dashboard.

Quick Icon - Joomla! Extensions Updates Notification

Checks for updates of your installed third-party extensions and notifies you when you visit the Home Dashboard page.

Help-4x-Extensions-Plugin-Manager-QuickIcon-ExtensionsUpdatesNotification-options-subscreen-en.png

  • Group. The group of this plugin (this value is compared with the group used in Quick Icons modules to inject icons).

Quick Icon - Joomla! Overrides Update Notification

Checks overrides on update and enables notifications when you visit the Home Dashboard page. Warning! You must have installer override plugin enabled to see results.

  • Group. The group of this plugin (this value is compared with the group used in Quick Icons modules to inject icons).

Quick Icon - Joomla! Privacy Requests Notification

Checks for privacy requests that need to be handled and notifies you when you visit the Control Panel page.

Quick Icon - Joomla! Update Notification

Checks for Joomla updates and notifies you when you visit the Home Dashboard page.

Help-4x-Extensions-Plugin-Manager-QuickIcon-UpdateNotification-options-subscreen-en.png

  • Group. The group of this plugin (this value is compared with the group used in Quick Icons modules to inject icons).

Quick Icon - Joomla! Missing Download Key Notification

Checks which update sites of (paid download) extensions are missing the corresponding Download Key information and notifies you when you visit the Home Dashboard page.

  • Group. The group of this plugin (this value is compared with the group used in Quick Icons modules to inject icons).

Quick Icon - PHP Version Check

Checks the support status of your installation's PHP version and raises a warning if not fully supported. This plugin has no options.


Sample Data Group

These plugins provide sample data for the Sample Data module that may be displayed on the Home Dashboard. If a plugin is disabled it will not appear there.

Help-4x-modules-site-module-manager-module-sample-data-module-example-en.png

Sample Data - Blog

Provides the blog sample data. Can be installed using the sample data module. This plugin has no options.

Sample Data - Multilingual

Provides the multilingual sample data. Can be installed using the sample data module. This plugin has no options.



System Group

System - Additional Accessibility Features

This plugin adds an accessibility toolbar to your site with additional accessibility options.

Help-4x-Extensions-Plugin-Manager-Edit-additional-accessibility-features-screen-en.png

System - Debug

This plugin provides debugging information. The report is shown below the main screen of the front and backend interfaces of your Joomla! installation. It has the following options:

Help-4x-Extensions-Plugin-Manager-Edit-debug-options-screen-en.png

  • Allowed Groups. User groups that will see the debug information when enabled.
  • Show Profiling Whether or not to display the profiling waypoints information.
  • Show Queries. Whether or not to include the SQL query log in the debug information.
  • Show Memory Usage. Whether or not to include memory usage data in the debug information.

Language Debug Options:

Help-4x-Extensions-Plugin-Manager-Edit-debug-language-options-screen-en.png

  • Show errors when parsing language files. Whether or not to display a list of language files with errors due to their not being in compliance with the Joomla! language file specification.
  • Show Language Files. Whether or not to display the language files that have been loaded to generate the page.
  • Show Language String. Whether or not to include undefined language strings in the debug information.
  • Strip First Word. Whether or not to always strip the first word in multi-word strings.
  • Strip From Start. Strips the specified words from the beginning of the language string. For multiple words separate each word with the pipe ( | ) character like so: word1|word2
  • Strip From End. Strips the specified words from the end of the language string. For multiple words separate each word with the pipe ( | ) character like so: word1|word2

Logging Debug options:

Help-4x-Extensions-Plugin-Manager-Edit-debug-logging-options-screen-en.png

System - Fields

The system fields plugin that is required to display the custom fields.

System - HTTP Headers

This Plugin can set some Security HTTP Headers.

Help-4x-Extensions-Plugin-Manager-Edit-http-headers-screen-en.png

System - Highlight

System plugin to highlight specified terms.

System - Job Scheduler

This plugin looks for job plugin tasks to run.

Help-4x-Extensions-Plugin-Manager-Edit-system-Job-Scheduler-options-screen-en.png

  • Frequency (in minutes). Set to zero to run on every page load (for testing).
  • Webcron. Set to Yes to call as a CLI command. For more information see Writing A CLI Application.
  • Activation Key The key to be passed in a Webcron command.

System - Joomla! Statistics

Help-4x-Extensions-Plugin-Manager-Edit-system-JoomlaStatistics-options-screen-en.png

  • Unique ID. An identifier that allows the Joomla! project to count unique installs of the plugin. This is sent with the statistics back to the server.
  • Interval (hours). Statistics will be sent every X hours. The default is 12.
  • Mode. Select the way that you want the statistics to be sent.

System - Joomla! Update Notification

Help-4x-Extensions-Plugin-Manager-Edit-system-JoomlaUpdateNotification-options-screen-en.png

  • Super User Emails. A comma separated list of the email addresses which will receive the update notification emails. The addresses in the list MUST belong to existing users of your site who have the Super User privilege. If none of the listed emails belongs to Super Users, or if it's left blank, all Super Users of this site will receive the update notification email.
  • Email Language. If you choose Auto (default), the update notification email to Super Users will be in the site language at the time the plugin is triggered. By selecting a language here you are forcing the update notification emails to be sent in this specific language.

System - Language Code

Provides the ability to change the language code in the generated HTML document to improve SEO. The fields will appear when the plugin is enabled and saved. More information at W3.org.

System - Language Filter

Help-4x-Extensions-Plugin-Manager-Edit-system-language-filter-options-screen-en.png

  • Language Selection for new Visitors. Whether to choose site default language or detect browser settings automatically.
  • Automatic Language Change. This option will automatically change the content language used in the Frontend when a user site language is changed.
  • Associations. Allows item association when switching from one language to another.
  • Add Alternate Meta Tags. Add alternative meta tags for menu items with associated menu items in other languages.
  • Add x-default Meta Tag. Add x-default meta tag to improve SEO.
  • x-default Language. Choose your x-default language.
  • Remove URL Language Code. Whether to remove or not the defined URL Language Code (eg. your_domain_name/en) of your Content Language that corresponds to the default site language when SEF URL is set to "Yes".
  • Cookie Lifetime. Language cookies can be set to expire at the end of the "Session" or after a "Year".

System - Log Rotation

Help-4x-Extensions-Plugin-Manager-Edit-LogRotation-options-screen-en.png

  • Log Rotation (in days). How often should the logs be rotated.
  • Maximum Logs. The maximum number of old logs to keep.

System - Logout

The system logout plugin enables Joomla to redirect the user to the home page if they choose to logout while they are on a protected access page.

System - Page Cache

This plugin enables page caching. Page caching allows the web server to save snapshots of pages and use them when serving web pages. This improves the performance of your web site and reduces the workload of the server. This plugin has the following options:

Help-4x-Extensions-Plugin-Manager-Edit-cache-options-screen-en.png

  • Use Browser Caching. Whether or not to use the mechanism for storing a page cache in the local browser. Default is "No".
  • Exclude Menu Items. Select which menu items you want to exclude from caching.

System - Privacy Consent

This plugin allows to collect the consent of your users to the site's privacy policy and to manage the consent expiration.

Help-4x-Extensions-Plugin-Manager-Edit-privacyconsent-options-screen-en.png

  • Short Privacy Policy. Allows you to enter a summary of your privacy policy or keep the existing one
  • Privacy Type. Choose between Article and Menu Item. Depending on choice, one or other of the two following fields will be present.
  • Privacy Article. Select or Create an Article for your privacy policy to link to your user's form.
  • Privacy Menu Item. Select or Create a Menu Item linked to an Article containing your privacy policy.
    • Note: Take extra care with multilingual sites. Best to ensure the Article or Menu Item occur as Associations in all languages.
  • Redirect Message. The message which will be displayed on redirectEnter your own message or keep the existing one.

Help-4x-Extensions-Plugin-Manager-Edit-privacyconsent-expiration-screen-en.png

  • Enable. (Yes/No) Expiration is disable by default. Enable it if you want to perform checks for the expiration of privacy consents.
  • Periodic check (days). (0 to 120 days) 30 days by default. If Expiration is enable, define the number of days to perform the check.
  • Expiration. (180 to 720 days) 360 days by default. If Expiration is enable, define the number of days when the privacy consent expires.
  • Remind. (0 to 120 days) 30 days by default. If Expiration is enable, define the number of days when a reminder should be sent before the expiration of the privacy consent.

System - Redirect

Help-4x-Extensions-Plugin-Manager-Edit-redirect-options-screen-en.png

  • Collect URLs. This options controls the collection of URLs. This is useful to avoid unnecessary load on the database.
  • Include Domain Name in Expired URLs. Save the expired URL as absolute (include domain) or relative (exclude domain).
  • Exclude URLs. Define regular expressions or terms which should be excluded in saving.

System - Remember Me

This plugin provides "Remember Me" functionality. This allows the website to "remember" your username and password so that you can automatically be logged in when you return to the site. This plugin has no options.

System - SEF

This plugin adds SEF support to links in the document. It operates directly on the HTML and does not require a special tag. It has the following options:

Help-4x-Extensions-Plugin-Manager-Edit-sef-options-screen-en.png

  • Site Domain. If your site can be accessed through more than one domain enter the preferred (sometimes referred to as canonical) domain here. Note: https://example.com and https://www.example.com are different domains.

System - Session Data Purge

Help-4x-Extensions-Plugin-Manager-Edit-SessionDataPurge-options-screen-en.png

  • Enable Session Data Cleanup. When enabled, this plugin wil attempt to purge expired data based on the frequency calculated by the probability and divisor.
  • Enable Session Metadata Cleanup. When enabled, this plugin wil clean optional session metadata from the database. Note that this operation will not run when the database handler is in use as that data is cleared as part of the Session Data Cleanup operation.
  • Probability. In combination with the divisor field, these two fields are used to determine the frequency of the session data cleanup operation being triggered on a request.
  • Divisor. In combination with the probability field, these two fields are used to determine the frequency of the session data cleanup operation being triggered on a request. The probability is calculated by using probability/divisor, e.g. 1/100 means there is a 1% chance that the process runs on each request.

System - Skip To Navigation

The plugin creates a dropdown menu consisting of the links to the important places on a given web page. This makes it easier for keyboard and screen reader users to quickly jump to the desired location by choosing it from the list of options.

Help-4x-Extensions-Plugin-Manager-Edit-skip-to-navigation-screen-en.png

System - User Actions Log

Help-4x-Extensions-Plugin-Manager-Edit-ActionsLog-options-screen-en.png

  • Days to delete logs after. Enter how many days logs should be kept before they are deleted. Enter 0 if you don't want to delete the logs.

System - User Log

Help-4x-Extensions-Plugin-Manager-Edit-UserLog-options-screen-en.png

  • Log Usernames. This option will log the username used when an authentication fails.


Two Factor Authentication Group

Two Factor Authentication - Google Authenticator

Help-4x-Extensions-Plugin-Manager-Edit-GoogleAuth-options-screen-en.png

  • Site section. (Site / Administrator / Both) In which section of your site do you want to enable two factor authentication.

Two Factor Authentication - YubiKey

Help-4x-Extensions-Plugin-Manager-Edit-YubiKey-options-screen-en.png

  • Site section. (Site / Administrator / Both) In which section of your site do you want to enable two factor authentication.



User Group

User - Contact Creator

Help-4x-Extensions-Plugin-Manager-Edit-contact-creator-options-screen-en.png

  • Automatic Webpage. A formatted string to automatically generate a contact's web page. [name] is replaced with the name, [username] is replaced with the username, [userid] is replaced with the user ID and [email] is replaced with the email.
  • Category. Category to assign contacts to by default.
  • Automatically Publish the Contact. Optionally have the automatically created contact set to the published state and visible to your website visitors.

User - Joomla API Token

Allows the management of security tokens used for authenticating to the Joomla API application (remote access to your site). These tokens are strictly personal. You can view your own token but you can only disable or reset other users' tokens.

Help-4x-Extensions-Plugin-Manager-Edit-joomla-api-token-options-screen-en.png

  • Allowed User Groups. Select one or more to allow a group to use Joomla Tokens to authenticate to the Joomla API application.

User - Joomla!

Help-4x-Extensions-Plugin-Manager-Edit-joomla-options-screen-en.png

  • Auto-create Users. Whether or not to automatically create registered Joomla! users where possible. Default is "Yes".
  • Notification Mail to User. When an administrator creates a user account, this determinates if an email, which has their username and password, is sent to the user.
  • Force Logout for all Sessions?. Set to No to disable this.

User - Profile

This plugin adds user profile capability to your website. Website users will be able to fill out profile fields that you enable in the options section of this plugin. You can control what profile fields are shown in the new user registration form and/or each user's editable profile screen. To control what fields are shown in the new user registration form, set the field options in the section labeled User profile information required at registration. For profile fields shown in the user's profile screen which it editable after login, set the field option in the options section labeled Required user profile information. For each field you have the following options:

  • Required. The field is visible in user profiles and users are required to fill it out.
  • Optional. The field is visible in user profiles but is optional and users do not need to fill it out.
  • Disabled. The field is disabled and not visible in user profiles.

Help-4x-Extensions-Plugin-Manager-Edit-profile-options-screen-en.png

  • All fields you can choose the three options with the exception of the Terms of Service field. The Terms of Service field is a choice between 'Required' and 'Disabled' that the user can click on to signify their agreement with the website's terms of service.

User - Terms and Conditions

This plugin allows to collect the consent of your users to the site's terms and conditions.

Help-4x-Extensions-Plugin-Manager-Edit-termsandconditions-options-screen-en.png

  • Short Terms & Conditions. Allows you to enter a summary of your Terms & Conditions or keep the existing one.
  • Terms & Conditions Article. Select or Create an article for your Terms & Conditions to link to your user's form.


Web Services Group

For information on how to use Web Services see the article on Joomla Core APIs.

Each of the following plugins adds privacy routes to the API for your website and has no options.

  • Web Services - Banners.
  • Web Services - Config.
  • Web Services - Contact.
  • Web Services - Content.
  • Web Services - Languages.
  • Web Services - Menus.
  • Web Services - Messages.
  • Web Services - Modules.
  • Web Services - Newsfeeds.
  • Web Services - Plugins.
  • Web Services - Privacy.
  • Web Services - Redirect.
  • Web Services - Tags.
  • Web Services - Templates.
  • Web Services - Users.



Workflow Group

For more information see the Workflow Tutorial.

Workflow - Featuring

Add featuring actions to the workflow transitions for your items.

Help-4x-Extensions-Plugin-Manager-Edit-workflow-featuring-options-screen-en.png

  • Extension Whitelist.
  • Extension Blacklist.

Workflow - Notification

Send Notification if a Transition has been performed in a Workflow

  • Extension Whitelist.
  • Extension Blacklist.

Workflow - Publishing

Add publishing actions to the workflow transitions for your items.

  • Extension Whitelist.
  • Extension Blacklist.