Joomla! Documentation - User contributions [en]

J1.5:Component parameters

2009-04-02T07:50:39Z

Wene: /* 2. Menu item specific parameters */

{{review}}

==Background==
One thing that sets Joomla! Components apart from other types of Extension (i.e. Modules and Plugins) is the ability to store significant quantities of data in the Joomla! MySQL database. Typically, this data will be content for displaying on a page (such as the content of an article, or its title) or data about how that content should be displayed (e.g. a setting specifying whether or not the title should be shown). A Component normally creates at least one table in the database to store this data - for example, data for articles associated with the <code>com_content</code> Component are stored in the <code>jos_content</code> table (where ''jos'' is the table prefix for the site).

However, choosing exactly how to store each item of data requires a little more thought. There are essentially two choices: each data item may be stored in its own field, or a collection of data items may be stored within a single parameters field. (Of course, there is nothing to stop you making use of both methods, for different data items, within the same component). Which approach you use for a given data item is largely a matter of personal choice, although there are some factors to consider:
* Core code included in the Joomla! installation makes it very easy to produce the appropriate form elements for entering data into '''parameters''' in the Back-end. If you choose to save the data in separate fields, you will need to code the appropriate form elements yourself.
* Again, Joomla! core code allows you to set default values for '''parameters''' across the whole component. Individual component items (e.g. individual articles) can then choose to use the default values, or to override them with values specific to that item. See below for details of how to do this.
* It is not possible to extract individual parameter values directly from the database. Instead, the whole parameters field must be extracted and parsed to obtain the different parameter values. This means that it is not very easy, for example, to run MySQL queries that search for a parameter with a particular value. Any data that you want to run queries against should be given its '''own table field'''.
* Similarly, it is not possible to run data validation on parameter fields before saving data.
In general, parameters are conventionally used to store data relating to the ''presentation'' of information. The information itself is generally stored in separate fields.

==Types of Component parameter==

===1. Component-wide default parameters===

These parameters are set once for the whole Component, and are generally used to provide the 'default' parameter settings for the Component on that particular site.

===2. Menu item specific parameters===

A menu link to an individual Component item (e.g. an article) can also have parameters associated with it, which can affect the way the Component item is displayed ''using that link''. The types of parameters available will depend on the way that the Component item is displayed (the 'view' in MVC terms, but don't worry if this doesn't mean anything to you!). However, the precise values of those parameters can be set for each menu link individually. If there is another menu link to that same Component item, then it is important to realise each menu link may have different parameter values, and so the same article may be displayed differently in the two cases.

A menu link can also override the Component-wide default parameters, so that the override values (if set) are used in place of the default values ''for that Component item when accessed via that menu link''. As you would expect, when no override value is set, the default value is used instead, in the normal manner.

===3. 'Article' specific parameters===

Finally, each Component item (e.g. article) can have parameters which apply to that item, regardless of how it is accessed (i.e. via any available menu link, or even without reference to a menu at all!). If the Component designer wants, the article specific parameters can also be set up to use the 'override' behaviour, so that they default to the current values of the corresponding Component-wide parameters, though this is not essential. Again, this is described further below.

==Storing the parameters and their values.==

In general, a set of parameters is stored within the database in a single <code>text</code> field. Different parameters are separated by <code>newline</code> characters ('<code>/n</code>' in MySQL - each parameter will appear on a different line when you look at the data in something like phpMyAdmin). Each parameter consists of the parameter name and value, separated by an equals sign (=). As an example:

<source lang="text">
parameter1=parameter1value
parameter2=
parameter3=parameter3value
parameter4=parameter4value
</source>

Here, parameter1, parameter3, and parameter4 have all been assigned values, whilst parameter2 has no value. Typically, a parameter will be given no value where it is set up to allow override of a default value, but 'no override is required' - i.e. it is desired to use the default value.

===1. Component-wide default parameters===

These are stored in the <code>params</code> field of the jos_components table, in the row corresponding to the particular component to which they apply.

===2. Menu item specific parameters===

These are stored in the <code>params</code> field of the jos_menu table, in the row corresponding to the particular menu item to which they apply.

===3. 'Article' specific parameters===

These are stored in a text field in the table created by the Component. Whilst there is no strict rule for naming the field, it is common to extend the above pattern using the <code>params</code> name. However, com_content stores article parameters in a field called <code>attribs</code>.

==Accessing the parameters - Back-end==

Joomla! includes some shortcuts to enable component creators to easily add parameter forms to the Back-end of their component. These forms allow a site administrator to enter a parameter value by, for example, entering some text in a box, choosing from a drop-down list, or selecting a radio button. To create these forms, each parameter needs to have an associated <code><param /></code> object in an XML file. The type of <code><nowiki><param /></nowiki></code> object determines the form elements that will be shown in the Back-end. A list of the available form elements is given [[Standard_parameter_types|here]]. More information is given below about the XML file names, structure and location required for each set of parameters.

===1. Component-wide default parameters===

These can be created at installation of the Component, by including <code><param /></code> elements in the installation XML file (typically called COMPONENT_NAME.xml, and located in the root folder of the Component package. As far as the parameters are concerned, this XML file has the following structure:
<source lang="xml">
<install>
...
<params>
<param />


<param name="font_size" default="16" />

...
</params>
...
</install>
</source>
Each <code><param /></code> element must be given the attributes <code>name</code> and <code>default</code>, which define the parameter name and value respectively. These values are then copied to the jos_components table in the database.

However, on its own this is not very useful, as it doesn't allow users to change the values of the parameters. To do this, parameter form elements need to be defined in a file named <code>config.xml</code> which is located in <code>/PATH_TO_JOOMLA/administrator/components/com_COMPONENT_NAME/</code>. The file should have the following structure:
<source lang="xml">
<root>
<params>
<param type="type" name="name" description="description" />



<param type="text" name="font_size" size="3" label="Font size:" description="Please enter the required font size" />

...
</params>
</root>
</source>
Note that the <code><root></code> element can have any name you wish, but there must be one element at the root of the document (this is a requirement for a well-formed XML document). You can have more than one <code><params></code> element, but only the first one will be considered. It is not currently possible to group certain parameter form elements together.

So that administrators to access these parameters, you will need to add a button to the toolbar in the Back-end of your component. This can be done using the code:
<source lang="php">
JToolBarHelper::preferences( 'com_COMPONENT_NAME' );
// e.g. for the core Content component, you would use JToolBarHelper::preferences( 'com_content' );
</source>
which is typically placed in the PHP file responsible for the Back-end output. (For example, using an MVC structure, you might place this code at the top of <code>/PATH_TO_JOOMLA/administrator/components/com_COMPONENT_NAME/views/VIEW_NAME/tmpl/default.php</code>.

This adds a <code>Parameters</code> button to the toolbar:

[[Image:Toolbar_newsfeed.png]]

Clicking on the toolbar button produces a pop-up window containing the form fields for each parameter defined in <code>config.xml</code>.

Note that there is no need to define <code>default</code> attributes for the <code><param /></code> elements in the <code>config.xml</code> file, since the default values will already have been saved in the installation of the Component.

===2. Menu item specific parameters===

A menu item is associated with a particular view from your Component's Front-end - following the menu link in the Front-end will display that view. Joomla! 1.5 allows you to define parameters for a particular view, so that a copy of those parameters can be associated with each menu item using the view. In addition, you can also choose to override the Component-wide default parameters defined as above, so that the override values will apply to the particular menu item.

The view parameters are defined in an XML file stored in the ''Front-end'' view output template (not to be confused with the site Template, which is different!) directory and with the same name as the template, i.e. <code>/PATH_TO_JOOMLA/components/com_COMPONENT_NAME/views/VIEW_NAME/tmpl/TEMPLATE_NAME.xml</code>. The structure of the file is:
<source lang="xml">
<metadata>
...
<state>
...
<params>
<param />
...
</params>
<advanced>
<param />
...
</advanced>
</state>
</metadata>
</source>

A list of parameter types can be found here: [http://help.joomla.org/content/view/28/125/] or here [http://docs.joomla.org/Standard_parameter_types]

Displaying the forms for these parameters is handled automatically by the core <code>com_menus</code> component, which creates a number of slider panes on the right hand side (at least when viewed using the default Khepri backend site Template) of the menu item edit screen. Any parameters defined within the <code><params></code> tag will appear in the <code>Parameters - Basic</code> slider pane. Any parameters defined within the <code><advanced></code> tag will appear in the <code>Parameters - Advanced</code> slider pane.

The following screenshot shows the menu admin page for the Category 'List' layout. You can see that the <code>Parameters - Basic</code> slider pane is open, and contains form elements for five parameters. There are no 'Advanced' parameters for this view, and so the <code>Parameters - Advanced</code> slider pane is not shown:

[[Image:Menu items edit.png]]

For the override of the Component-wide default parameters, <code>com_menus</code> uses the same <code>config.xml</code> file as above, so there is no need to define these parameters again. The override forms are automatically added to a slider pane named <code>Parameters - Component</code>. However, there are a number of changes from the forms used in the Preferences pop-up window (despite being based on the same <code>config.xml</code> file):
* Any <code><param type="radio" /></code> parameter is shown not as a radio button form field, but by a drop-down list.
* All drop-down lists (both those defined as such in <code>config.xml</code>, and those defined as radio buttons) are given an extra option. This extra option displays the text "Use Global" but has an associated value of an empty string. The "Use Global" option is set as the default option for the list. Thus, by default, these parameters will use the Component-wide default values, rather than overriding them. (However, note that any text box fields defined with a default value in <code>config.xml</code> retain that default value, and so will override the component-wide default value if that is different).

===3. 'Article' specific parameters===

These are defined in an XML file which can be stored anywhere you like, but is typically placed within the <code>models</code> folder of the Component Back-end (if you are using an MVC structure) and named according to the model to which they apply, i.e. <code>PATH_TO_JOOMLA/administrator/components/com_COMPONENT_NAME/models/MODEL_NAME.xml</code>. The XML file has the following structure:

<source lang="xml">
<root>
<params>
<param />
...
</params>
<params group="GROUP_NAME">
<param />
...
</params>
...
</root>
</source>

As above, you can give the <code><root></code> element whatever name you wish. You can also have as many <code><params></code> groups as you like, though each group must have a <code>group</code> attribute with a different <code>GROUP_NAME</code>. If there are two or more <code><params></code> groups with the same <code>GROUP_NAME</code>, only the last one in the list will be considered.

To display the forms for these parameters in the Back-end of your Component, you will need to do a little work yourself. Firstly, you need to access the saved parameter data from the database. For this, you will need to identify both the location of the stored parameters data in the database, and the XML file that you are using to define the parameter form fields. Assuming that you have already created a <code>$row</code> variable to hold your component item (i.e. 'article') data, that the parameters data is stored in the <code>params</code> field of the <code>$row</code>, and that the XML file is located in the models folder as specified above, you could use the following code:
<source lang="php">
$paramsdata = $row->params;
$paramsdefs = JPATH_COMPONENT.DS.'models'.DS.'MODEL_NAME.xml';
$params = new JParameter( $paramsdata, $paramsdefs );

$this->assignRef('params', $params);
</source>
This code is typically placed in the View file (e.g. view.html.php) within the corresponding folder.

To display the parameters forms in slider panes (in the same way that they are displayed in the menu item Back-end), you should use the following code in the template file (e.g. <code>PATH_TO_JOOMLA/administrator/com_COMPONENT_NAME/views/VIEW_NAME/tmpl/default.php</code>):
<source lang="php">
$pane =& JPane::getInstance( 'sliders' );

echo $pane->startPane( 'content-pane' );

// First slider panel
// Create a slider panel with a title of SLIDER_PANEL_1_TITLE and a title id attribute of SLIDER_PANEL_1_NAME
echo $pane->startPanel( JText::_( 'SLIDER_PANEL_1_TITLE' ), 'SLIDER_PANEL_1_NAME' );
// Display the parameters defined in the <params> group with no 'group' attribute
echo $this->params->render( 'params' );
echo $pane->endPanel();

//Second slider panel
// Create a slider panel with a title of SLIDER_PANEL_2_TITLE and a title id attribute of SLIDER_PANEL_2_NAME
echo $pane->startPanel( JText::_( 'SLIDER_PANEL_2_TITLE' ), 'SLIDER_PANEL_2_NAME' );
// Display the parameters defined in the <params> group with the 'group' attribute of 'GROUP_NAME'
echo $this->params->render( 'params', 'GROUP_NAME' );
echo $pane->endPanel();

// Repeat for each additional slider panel required

echo $pane->endPane();
</source>
In order to save the parameters to the database you have to overload the bind() function which can be found in
<code>PATH_TO_JOOMLA/administrator/com_COMPONENT_NAME/tables/COMPONENT_NAME.php</code>
<source lang="php">
function bind($array, $ignore = '')
{
if (key_exists( 'params', $array ) && is_array( $array['params'] ))
{
$registry = new JRegistry();
$registry->loadArray($array['params']);
$array['params'] = $registry->toString();
}
return parent::bind($array, $ignore);
}
</source>

==Accessing the parameters - frontend==

The Front-end situation is a bit more complex than the Back-end. The 'standard' way to deal with parameters in the Front-end is to set up a cascade of overrides, as described above:
<blockquote>Item-specific ''overrides'' Menu-specific ''overrides'' Component-default</blockquote>
If you '''don't''' want to do this, then a little extra work is required

===With overrides===

The following code will access the Component-wide default parameters, ''already overridden'' with those for the menu item (if applicable):

<source lang="php">
<?php
$params = &JComponentHelper::getParams( 'COMPONENT_NAME' );

// e.g. for the com_weblinks component, you would use:
// $params = &JComponentHelper::getParams( 'com_weblinks' )
?>
</source>

In an MVC structure, this code would be placed in the <code>view.html.php</code> file for the particular view required.

Assuming that the item parameters are stored in the <code>params</code> field, and that the particular item has been loaded into the <code>$row</code> object by the method, you would then add in the item parameters to the <code>$params</code> object using:

<source lang="php">
<?php
$params->merge( &$row->params );
?>
</source>

Note that, in both cases (i.e. overrides by menu-specific parameters, and overrides by item-specific parameters), we aren't ''just'' doing overrides - we also add in any new parameters that weren't found in the defaults. In other words, the <code>$params</code> object ends up with all the parameters we need!

To access the value of a specific parameter, we would use:

<source lang="php">
<?php
$params->get( 'PARAMETER_NAME' );

// e.g. to obtain the value of 'parameter1', we use:
// $params->get( 'parameter1' );
?>
</source>

It is important to realise that any <code>merge</code> carried out is persistent, so the following code (where for example you have an array containing the parameters sets for several items, and you want the parameters for each item to individually override the defaults) would not produce the result you might expect:

<source lang="php">
<?php
foreach ($itemparamsgroup as $itemparams)
{
$params = &JComponentHelper::getParams( 'COMPONENT_NAME' );
$params->merge( $itemparams );
echo $params->get( 'PARAMETER_NAME' );
}
?>
</source>

In such cases, you will need to use the non-override method, and then force the overrides manually, as described below.

===Without overrides===

There will be cases where you don't want to use the default override pattern. For example, you may want to ignore the menu-specific parameters, and have only the item-specific parameters overriding the defaults. This is a little more difficult to accomplish, although it can still be done.

You can access the Component-wide default parameter values, ''without the menu overrides'', as follows:

<source lang="php">
<?php
$component = JComponentHelper::getComponent( 'COMPONENT_NAME' );
$params = new JParameter( $component->params );
?>
</source>

If you want to override these with the menu parameters, but ''without'' the 'persistence' effect described above, you can:

<source lang="php">
<?php
$menuitemid = JRequest::getInt( 'Itemid' );
if ($menuitemid)
{
$menu = JSite::getMenu();
$menuparams = $menu->getParams( $menuitemid );
$params->merge( $menuparams );
}
?>
</source>

You can access the item parameters as before, and choose whether to merge them in using the code above, or simply store them in a separate object:

<source lang="php">
<?php
$itemparams = new JParameter( $row->params );
?>
</source>

You can combine this code to achieve the effect that you want. For example, you could override the Component-wide defaults with the item-specific parameters, but ignore those for the menu. Or you could use the menu-specific parameters in some circumstances, and the item-specific ones in others. [Whenever you depart from the standard approach, though, you should be careful that you inform your users how your Component works. Users will expect your component to work the same way as those from the Joomla! core, so you should have a good reason for departing from this approach.]

Accessing the value of a particular parameter is done in the same way as described above.

[[Category:Development]]

J3.x talk:Adding JavaScript and CSS to the page

2009-03-11T22:29:36Z

Wene:

Hello there.. I was about to pitch in and add on a whole other section on basically doing the exact same thing you did with $document.. except using the JHTML class. I wasn't exactly sure why you'd use one over the other and thought I'd ask if you knew why this redunacy exists and if one is in some way more helpful. Any ideas?
[[User:Haelix|Haelix]] 23:45, 8 November 2008 (EST)

Haelix, I agree. It appears that the JHTML classes wrap the $document methods, and take care of anything else you might need (like mootools). I have updated the article to reflect this.[[User:Mike dowler|Mike]] 21:24, 17 February 2009 (UTC)

what page should we keep ?
this one
http://docs.joomla.org/Adding_JavaScript
or this one
http://docs.joomla.org/Adding_JavaScript_and_CSS_to_the_page
?

Talk:Adding JavaScript

2009-03-11T22:29:19Z

Wene: New page: what page should we keep ? this one http://docs.joomla.org/Adding_JavaScript or this one http://docs.joomla.org/Adding_JavaScript_and_CSS_to_the_page ?

what page should we keep ?
this one
http://docs.joomla.org/Adding_JavaScript
or this one
http://docs.joomla.org/Adding_JavaScript_and_CSS_to_the_page
?

Help15:Screen.plugins.edit.15

2009-03-11T14:22:33Z

Wene: /* Content - Code Hightlighter (GeSHi) */

==How to Access==
Navigate to the [[screen.plugins.15|Plugin Manager]]. Click on the Plugin's Name or click on the Plugin's checkbox and press the Edit button in the toolbar.

==Description==
This is where you can edit details and parameters for Plugins. Some Plugins have several parameters, while others don't have any.

==Screenshot==
[[Image:Plugin_edit.png]]

==Details==
The Details section is the same for all Plugins, as follows:
*'''Name.''' The Name of the Plugin.
*'''Enabled.''' Whether or not this Plugin is enabled.
*'''Type.''' The Type of the Plugin. This value cannot be changed.
*'''Plugin File.''' The name of the Plugin file. Each Plugin has two files with this name. One has the file extension ".php" and the other has the file extension ".xml".
{{colheader|Enter Access Level}}
{{colheader|Enter Order}}
*'''Description.''' The description of what this Plugin does. This cannot be changed.

==Plugin Description and Parameters==
When Joomla! is installed, 32 Plugins are included in the installation. These are described below, along with any parameters for the Plugin.

===Authentication - Joomla===
This Plugin processes the default User Authentication in Joomla!. It has no parameters.

===Authentication - LDAP===
This Plugin processes User Authentication against an LDAP server. It has the following parameters:

[[Image:Plugin_ldap_parameters.png]]
*'''Host.''' The host URL. For example, "openklap.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.
*'''Users 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:E-mail.''' The LDAP attribute that contains the User's e-mail address.
*'''Map: User ID.''' The LDAP attribute that contains the User's login ID. For Active Directory, this is "sAMAccountName".

===Authentication - OpenID===
This Plugin processes user authentication with an OpenID. It requires PHP version 5 or above. This Plugin has no parameters.

===Authentication - GMail===
This Plugin processes User Authentication with a GMail account. It requires that the cURL software package be installed.

To use the GMail plugin:
* Create a Joomla! User with the same name as a GMail account user.
* Enable the GMail Plugin.
* Logout of Joomla!.
* Login using the GMail username (without "@gmail.com) and the GMail password.

===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:
*"Show Navigation" in the [[screen.content.15#Global_Configuration|Article Manager - Global_Configuration]] screen
*"Show Navigation" in the Parameters - Component section of the [[screen.menus.edit.15#Parameters_-_Component_for_Articles|Menu Item Manager - New/Edit - Parameters - Component for Articles]] screen for Article layouts.
Note that, if the Page Navigation plugin is disabled in this screen, no Page Navigation will show and the parameter settings above will have no effect.

This plugin has the following parameter:

[[Image:Plugin_page_nav_parameters.png]]
*'''Position.''' Position of the navigation link. Options are "Above" the Article or "Below" the Article.

===Content - Rating===
This Plugin adds the Voting functionality to Articles. It has no Parameters.

===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 <code>{emailcloak=off}</code> anywhere in the text of the article. In this case, no e-mail addresses in the article will be cloaked by this Plugin.

Email Cloaking has the following parameter:

[[Image:Plugin_email_cloaking_parameters.png]]
*'''Mode.''' How the e-mails will be displayed. Options are "As linkable mailto address" or as "Non-Linkable text".

===Content - Code Hightlighter (GeSHi)===
This Plugin displays formatted code in Articles based on the GeSHi highlighting engine. It has no parameters.
<pre>
Syntax usage :
<pre xml:lang="php">
echo $test;
</pre>
</pre>

===Content - Load Module===
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. See [[Screen.modules.edit.15#Quick_Tips|Module Manager - New/Edit]] for more information about showing Modules inside Articles.

This Plugin has the following parameters:

[[Image:Plugin_load_module_parameters.png]]
*'''Enable Plugin.''' Whether or not to enable this Plugin.
*'''Style.''' The Style for the loaded Module.

===Content - Pagebreak===
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.
<pre>
Syntax: Usage: <hr class="system-pagebreak" />
<hr class="system-pagebreak" title="The page title" /> or
<hr class="system-pagebreak" alt="The first page" /> or
<hr class="system-pagebreak" title="The page title" alt="The first page" /> or
<hr class="system-pagebreak" alt="The first page" title="The page title" />
</pre>
This Plugin has the following parameters:

[[Image:Plugin_pagebreak_parameters.png]]
*'''Enable Plugin.''' Whether or not to enable this Plugin.
*'''Site Title.''' Whether or not the title and heading attributes from the Plugin will be added to the Site Title tag.
*'''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.

===Editor - No Editor===
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 Parameters.

===Editor - TinyMCE 2.0===
This Plugin loads the TinyMCE 2.0 editor. This is the default editor in Joomla!.
[[Image:Plugin.Tinymce_Output.png]]

This Plugin has the following Plugin parameters:

[[Image:Plugin_tinymce_parameters.png]]
*'''Functionality.''' Select "Advanced" or "Simple" functionality. With "Simple" selected, the User has only 9 toolbar buttons: Bold, Italic, Underline, Strikethrough, Undo, Re-do, Clean up messy code, Bullets, and Numbering. With "Advanced" selected, the User has all of the TinyMCE toolbar buttons. "Advanced" is the default setting.
*'''Code Cleanup on Startup.''' Whether or not to automatically clean up the HTML code when the editor first loads. Default value is "Off".
*'''Code Cleanup on save.''' Whether to run HTML code cleanup when a file is saved. Options are "Never", "Front Only", and "Always". The default setting is "Always".
*'''Do not clean HTML entities.''' Whether or not to skip cleaning of HTML entities. The default value is "No", which means that HTML entities will be stripped from the file.
*'''Save Warning.''' Whether or not to give a warning if the User cancels without saving the file. The default value is "Off".
*'''Compressed Version.''' Whether or not to use the compressed version of TinyMCE. Note that this does not work reliably with Windows IE, so "Off" is the recommended setting and is the default.
*'''URLs.''' Whether to use Relative or Absolute URLs for links. The default is "Relative".
*'''Text Direction.''' Whether the language reads "Left to Right" or "Right to Left" (for example, like Arabic). Default is "Left to Right".
*'''Automatic Language Selection.''' Whether or not to match the selected UI language. Do not set to "Yes" unless the appropriate editor languages are installed. Default is "No".
*'''Language Code.''' Editor UI language code. This must be entered if Automatic Language Selection is "Off". Default is "en" for British English.
*'''Prohibited Elements.''' The elements that will be cleaned from the text. Default is "applet", which will remove applet elements from the text.
*'''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.
*'''New Lines.''' Whether to interpret new lines as "P Elements" or "BR Elements". Default is "P Elements".
*'''Extended Valid Elements.''' Optional list of valid HTML elements to add to the existing rule set.

This Plugin has the following advanced parameters:

[[Image:Plugin_tinymce_advanced.png]]
*'''Toolbar.''' Whether show the toolbar above or below the editor window.

The following settings only apply if the editor is in Advanced mode.

*'''Horizontal Rule.''' Hide or Show the 'Horizontal Rule' button.
*'''Smilies.''' Hide or Show the 'Smilies' button.
*'''Table.''' Hide or Show the Table buttons.
*'''Style.''' Hide or Show the 'CSS Style' button.
*'''Layer.''' Hide or Show the Layer buttons.
*'''XHTMLxtras.''' Hide or Show the additional XHTML features.
*'''Template.''' Hide or Show the 'Template' button.
*'''Directionality.''' Hide or Show the 'Directionality' button.
*'''Fullscreen.''' Hide or Show the 'Fullscreen' button.
*'''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.
*'''Preview.''' Hide or Show the 'Preview' button.
*'''Element Path.''' If set to "On", show the 'Set Classes' button for the marked text.
*'''Insert Date.''' Hide or Show the 'Insert Date' button.
*'''Date Format.''' The Date format to use for Insert Date.
*'''Insert Time.''' Hide or Show the 'Insert Time' button.
*'''Time Format.''' The Time format to use for Insert Time.

===Editor - XStandard Lite 2.0===
This Plugin provides the XStandard editor.

''Note'': after enabling this plugin, the editor itself must be downloaded and installed from the XStandard Website http://xstandard.com/

[[Image:Plugin.Xstandardlite_Output.png]]

It has the following parameters:

[[Image:Plugin_xstandard_parameters.png]]
*'''Editor Mode.''' Three modes of operation are possible: WYSIWYG, Source, or Screen Reader.
*'''Word Wrap.''' Whether to have Word Wrap turned Off or On.

===Editor Button - Image===
This Plugin displays the Image button below the editor box when you are using a Joomla! editor (for example, when writing an Article). It allows you to insert an image into an Article. This Plugin has no parameters.

===Editor Button - Pagebreak===
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 parameters.

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

===Search - Content===
This Plugin enables searching for Articles. It has the following parameters:

[[Image:Plugin_search_parameters.png]]
{{colheader|Search Limit}}
*'''Articles.''' Whether or not to search Articles.
*'''Uncategorized Articles.''' Whether or not to search Uncategorized Articles.
*'''Archived Articles.''' Whether or not to search Archived Articles.

===Search - Weblinks===
This Plugin enables searching for Web Links. It has the following parameters:

[[Image:Plugin_search_weblinks_parameters.png]]
{{colheader|Search Limit}}

===Search - Contacts===
This Plugin enables searching for Contacts. It has the following parameters:

[[Image:Plugin_search_weblinks_parameters.png]]
{{colheader|Search Limit}}

===Search - Categories===
This Plugin enables searching for Category information. It has the following parameters:

[[Image:Plugin_search_weblinks_parameters.png]]
{{colheader|Search Limit}}

===Search - Sections===
This Plugin enables searching for Section information. It has the following parameters:

[[Image:Plugin_search_weblinks_parameters.png]]
{{colheader|Search Limit}}

===Search - Newsfeeds===
This Plugin enables searching for News Feeds. It has the following parameters:

[[Image:Plugin_search_weblinks_parameters.png]]
{{colheader|Search Limit}}

===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. This Plugin has no parameters.

===System - Debug===
This Plugin provides debugging information. The report is shown below the mainscreen (front- & backend). It has the following parameters:

[[Image:Plugin.Debug_Params.png]]

*'''Display Profiling Information''' Whether or not to display the time profiling information.
*'''Display SQL query log.''' Whether or not to include the SQL query log in the debug information.
*'''Display memory usage.''' Whether or not to include memory usage data in the debug information.
*'''Display undefined language strings.''' Whether or not to include undefined language strings in the debug information.
*'''Display loaded language files''' Whether or not to display the language files that have been loaded to generate the page. This has two modes: diagnostic and designer. Diagnostic mode displays the untranslated string and the likely file location whether the JText call was made. Designer mode displays the strings in a format that can be copy-pasted into a .ini language file (displays the list in KEY=String format).
*'''Strip Key Prefix''' When untranslated strings are displayed in Designer mode, this allows you to strip a prefix from the string to form the key. This is useful if the designer uses a common prefix for their extension(s) when using JText methods.

Note that the display of untranslated strings will only display the value passed to the appropriate JText method. For example, with the following code:
<source lang="php"><?php echo JText::_( 'Reports Import Configuration' ); ?></source>

If untranslated, Designer mode will display this as:

# /administrator/components/com_reports/views/reports/tmpl/default.php
REPORTS IMPORT CONFIGURATION=Reports Import Configuration

If the Strip Key Prefix is set to "Reports", then the display would change slightly to:

# /administrator/components/com_reports/views/reports/tmpl/default.php
REPORTS IMPORT CONFIGURATION=Import Configuration

Finally, the path shown is only a best guess based on a call to the PHP debug_backtrace function. Sometimes it is accurate, sometimes it is not and there are also cases where no file could be determined. In those cases you have to use your best judgement.

===System - Legacy===
This Plugin allows you to use Extensions in "1.5 Legacy" mode. Note that this Plugin is disabled by default and must be enabled before you can use this type of Extension. This Plugin has the following parameter:

[[Image:Plugin_legacy_parameters.png]]
*'''Use Legacy URL Routing.''' Whether or not to use the legacy URL routing mechanism for legacy Extensions. The default value is "No".

===System - 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 parameters:

[[Image:Plugin_cache_parameters.png]]
*'''Use Browser Caching.''' Whether or not to use the mechanism for storing a page cache in the local browser. Default is "No".
*'''Cache Lifetime.''' The time, in minutes, to save a cached page. Default is 15 minutes.

===System - Log===
This Plugin enables system logging. A log is a file that contains information about the web site activity. It can be used to see a history of activity and to troubleshoot problems on the site. This Plugin has no parameters.

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

===System - Backlink===
The Backlink Plugin provides support for legacy Joomla! 1.0.x links. It redirects old style URL and document links to the correct Joomla! 1.5 targets. It has the following parameters:

[[Image:Plugin_backlink_parameters.png]]
*'''Search Query Strings.''' If "Yes", the system will search for version 1.0 query strings that might match and then redirects to the new URL. Default is "Yes".
*'''Search SEF.''' If "Yes", the system will use the Joomla! 1.0 style SEF format and will redirect to the new link. Default is "Yes".
*'''Attempt Legacy SEF.''' If "Yes", the system will use the Joomla! 1.0 style of SEF format and will attempt to generate a valid link. Default is "Yes".

===User - Joomla!===
This Plugin handles the default User synchronisation. It has the following paramemters:

[[Image:Plugin_user_joomla_parameters.png]]
*'''Auto-create Users.''' Whether or not to automatically create registered Joomla! users where possible. Default is "Yes".

===XML-RPC - Joomla===
This Plugin provides the XML-RPC API to Joomla! users. It has no parameters.

===XML-RPC - Blogger API===
This Plugin enables the Blogger XML-RPC API protocol for your Joomla! web site. If enabled, this allows bloggers to add Articles to the site from any application that supports this API. This Plugin has the following parameters:

[[Image:Plugin_xmlrpc_parameters.png]]
*'''New posts.''' The Category in which to place new posts received via this API. Select from the drop-down list of Categories.
*'''Edit posts.''' The Section from which to retrieve new posts from. Select from the drop-down list of Sections.

==Toolbar==
At the top right you will see the toolbar:

[[Image:Plugin_edit_toolbar.png]]
{{toolbaricon|Save}}
{{toolbaricon|Apply}}
{{toolbaricon|Close}}
{{toolbaricon|Help}}

==Quick Tips==
*If you want to use any Extensions in "1.5 Legacy" mode, you need to enable the "System - Legacy" Plugin. This Plugin is disabled by default.
*If you are using the TinyMCE 2.0 editor, you can control which options appear on the editor's toolbar by setting the parameters in the "Editor - TinyMCE 2.0" Plugin.

==Related Information==
*To install new Plugin Extensions: [[screen.installer.15#Install Screen|Extension Manager - Install Screen]]
*To uninstall third-party Plugins: [[screen.installer.15#Plugins Screen|Extension Manager - Plugins Screen]]

<noinclude>{{cathelp|1.5|Plugin Manager|Extensions}}</noinclude>

Help15:Screen.plugins.edit.15

2009-03-11T14:17:54Z

Wene: /* Content - Code Hightlighter (GeSHi) */

J3.x:Adding JavaScript and CSS to the page

2009-03-07T15:18:19Z

Wene:

{{stub}}

To have a well-formed XHTML document, you must put all references to Javascript and CSS files within the <code><head></code> portion. Since Joomla! generates all of the HTML that makes up a page before output, it is possible to add these references to the <head> tag from your extension. The simplest way to do this is to make use of the functionality built in to Joomla!:
<source lang="php">
// Add a reference to a javascript file
// The default path is 'media/system/js/'
JHTML::script($filename, $path, $mootools);

// Add a reference to a CSS file
// The default path is 'media/system/css/'
JHTML::stylesheet($filename, $path);
</source>

Using these functions, Joomla! will take care of any additional requirements. For example, if your javascript requires Mootools, setting <code>$mootools = true</code> will automatically ensure that Mootools is loaded, if it has not already been done.

However, the above functions will not be flexible enough for every scenario, and so it is possible to tap into the underlying functionality instead. (Of course, this means that you will also need to manually code some of the steps that would be done automatically using the functions above!)

Firstly, you will need to get a reference to the current document object:
<source lang="php">
$document =& JFactory::getDocument();
</source>

To add a javascript file, use this code:
<source lang="php">
$document->addScript($url);
</source>
Note that this will '''not''' automatically include Mootools. If your script requires Mootools, you should also include the line:
<source lang="php">
JHTML::_("behavior.mootools");
</source>

For a stylesheet, use this code:
<source lang="php">
$document->addStyleSheet($url);
</source>

However, your javascript or CSS might not be located in a separate file - you might want to generate them using PHP. In this case you can write the script/stylesheet directly into the head of your document:
<source lang="php">
// Add javascript
$document->addScriptDeclaration($javascript, $type);

// Add styles
$document->addStyleDeclaration($styles, $type);
</source>

For example, the following code is used to define a custom tool tip that takes advantage of mootools.
<source lang="php">
function getToolTipJS($toolTipVarName, $toolTipClassName){
$javascript = 'window.addEvent(\"domready\", function(){' ."\n";
$javascript .= "\t" .'var $toolTipVarName = new Tips($$("' . $toolTipVarName .'"), {' ."\n";
$javascript .= "\t\t" .'className: "' .$toolTipClassName .'",' ."\n";
$javascript .= "\t\t" .'initialize: function(){' ."\n";
$javascript .= "\t\t\t" .'this.fx = new Fx.Style(this.toolTip, "opacity", {duration: 500, wait: false}).set(0);' ."\n";
$javascript .= "\t\t" .'},' ."\n";
$javascript .= "\t\t" .'onShow: function(toolTip){' ."\n";
$javascript .= "\t\t\t" .'this.fx.start(1);' ."\n";
$javascript .= "\t\t" .'},' ."\n";
$javascript .= "\t\t" .'onHide: function(toolTip) {' ."\n";
$javascript .= "\t\t\t" .'this.fx.start(0);' ."\n";
$javascript .= "\t\t" .'}' ."\n";
$javascript .= "\t" .'});' ."\n";
$javascript .= '});' ."\n\n";
return $javascript;
}

$document =& JFactory::getDocument();
$document->addStyleSheet("/joomla/components/com_mycustomcomponent/css/mytooltip.css",'text/css',"screen");
$document->addScriptDeclaration(getToolTipJS("mytool","MyToolTip"));
</source>
(Note that, in order for this javascript to be functionally useful, it would be necessary to include the appropriate class name in the HTML, as well as providing the <code>mytooltip.css</code> file. Both are outside the scope of this article.)

There will be some occasions where even these functions are not flexible enough, as they are limited to writing the contents of <code><script /></code> or <code><style /></code> tags, and cannot add anything outside those tags. One example would be the inclusion of a stylesheet link within conditional comments, so that it is picked up only by Internet Explorer 6 and earlier. To do this, we can use <code>$document->addCustomTag</code>:
<source lang="php">
$stylelink = '' ."\n";

$document =& JFactory::getDocument();
$document->addCustomTag($stylelink);
</source>

[[Category:Development]]

Adding JavaScript

2009-03-07T12:28:28Z

Wene: /* Adding Javascript Files Using JHTML */

{{cookiejar}}
===Adding JavaScript===
----
This chunk should describe in detail how to add JavaScript to the head of
a template using the Joomla! 1.5 API calls. It should be aimed at
people who have only minimal knowledge of PHP, HTML and JavaScript.
----
[[Category:Templates]]
[[Category:Modules]]
[[Category:Components]]
[[Category:Plugins]]

Add the following code to have the javascript library /media/system/js/sample.js included in your template.

<?php
$document = &JFactory::getDocument();
$document->addScript( '/media/system/js/sample.js' );
?>

==Explanation==

Ultimately you are trying to have the resulting HTML page have in the <head> ... </head> area have a javascript include:

For Example:
<script type="text/javascript" src="/media/system/js/sample.js"></script>

Ensure that the javascript you want to include is in the directory, from the above example:
/media/system/js/sample.js

When you are able to load both your page and see the <script> tag in the <head> area, and be able to load the javascript from the address

Again, using the example:
<nowiki>http://www.example.com/media/system/js/sample.js</nowiki>

Then the script is integrated into your page, and you can proceed to using javascript in your HTML.

Do not directly add the <script> to your template's index.php.

The code will insert the the <script> line where your index.php has the following line:

<jdoc:include type="head" />

Add this PHP code to your page, in the head, or next to the javascript code you will use, depending on your preference.

<?php
$document = &JFactory::getDocument();
$document->addScript( '/media/system/js/sample.js' );
?>

Reload your template and view the page, and ensure that the sample.js is included in the <head>

== Adding Javascript Files Using JHTML ==

You may also use the [http://api.joomla.org/Joomla-Framework/HTML/JHTML.html JHTML] [http://api.joomla.org/Joomla-Framework/HTML/JHTML.html#script script] method to add a javascript file to the head of your document.

<?php
$filename = 'filename.js';
$path = 'path/to/file/'; // add the path parameter if the path is different than : 'media/system/js/'
JHTML::script($filename, $path);
?>

There is a third parameter that can be passed to the script method. The parameter is a boolean (true/false). You would set this to true if you wanted MooTools loaded as well.

<?php
$filename = 'filename.js';
$path = 'path/to/file/'; // add the path parameter if the path is different than : 'media/system/js/'
JHTML::script($filename, $path, true); // MooTools will load if it is not already loaded
?>

'''Please Note: Joomla 1.6+ may or may not handle MooTools differently than in previous versions.'''<ref>[http://forum.joomla.org/viewtopic.php?f=502&t=273960 Whitepaper] Upgrade to mootools 1.2</ref>

== References ==
<references/>

Help15:Screen.plugins.edit.15

2008-10-30T22:14:01Z

Wene: /* Authentication - GMail */

==How to Access==
Navigate to the [[screen.plugins.15|Plugin Manager]]. Click on the Plugin's Name or click on the Plugin's checkbox and press the Edit button in the toolbar.

==Description==
This is where you can edit details and parameters for Plugins. Some Plugins have several parameters, while others don't have any.

==Screenshot==
[[Image:Plugin_edit.png]]

==Details==
The Details section is the same for all Plugins, as follows:
*'''Name.''' The Name of the Plugin.
*'''Enabled.''' Whether or not this Plugin is enabled.
*'''Type.''' The Type of the Plugin. This value cannot be changed.
*'''Plugin File.''' The name of the Plugin file. Each Plugin has two files with this name. One has the file extension ".php" and the other has the file extension ".xml".
{{colheader|Enter Access Level}}
{{colheader|Enter Order}}
*'''Description.''' The description of what this Plugin does. This cannot be changed.

==Plugin Description and Parameters==
When Joomla! is installed, 32 Plugins are included in the installation. These are described below, along with any parameters for the Plugin.

===Authentication - Joomla===
This Plugin processes the default User Authentication in Joomla!. It has no parameters.

===Authentication - LDAP===
This Plugin processes User Authentication against an LDAP server. It has the following parameters:

[[Image:Plugin_ldap_parameters.png]]
*'''Host.''' The host URL. For example, "openklap.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.
*'''Users 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:E-mail.''' The LDAP attribute that contains the User's e-mail address.
*'''Map: User ID.''' The LDAP attribute that contains the User's login ID. For Active Directory, this is "sAMAccountName".

===Authentication - OpenID===
This Plugin processes user authentication with an OpenID. It requires PHP version 5 or above. This Plugin has no parameters.

===Authentication - GMail===
This Plugin processes User Authentication with a GMail account. It requires that the cURL software package be installed.

how to use the gmail plugin ? :
* create a user account with the same name as a gmail account.
* enable the gmail plugin
* logout
* login using the gmail username and gmail password ( no need to add @gmail.com at the end )

===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:
*"Show Navigation" in the [[screen.content.15#Global_Configuration|Article Manager - Global_Configuration]] screen
*"Show Navigation" in the Parameters - Component section of the [[screen.menus.edit.15#Parameters_-_Component_for_Articles|Menu Item Manager - New/Edit - Parameters - Component for Articles]] screen for Article layouts.
Note that, if the Page Navigation plugin is disabled in this screen, no Page Navigation will show and the parameter settings above will have no effect.

This plugin has the following parameter:

[[Image:Plugin_page_nav_parameters.png]]
*'''Position.''' Position of the navigation link. Options are "Above" the Article or "Below" the Article.

===Content - Rating===
This Plugin adds the Voting functionality to Articles. It has no Parameters.

===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 <code>{emailcloak=off}</code> anywhere in the text of the article. In this case, no e-mail addresses in the article will be cloaked by this Plugin.

Email Cloaking has the following parameter:

[[Image:Plugin_email_cloaking_parameters.png]]
*'''Mode.''' How the e-mails will be displayed. Options are "As linkable mailto address" or as "Non-Linkable text".

===Content - Code Hightlighter (GeSHi)===
This Plugin displays formatted code in Articles based on the GeSHi highlighting engine. It has no parameters.

===Content - Load Module===
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. See [[Screen.modules.edit.15#Quick_Tips|Module Manager - New/Edit]] for more information about showing Modules inside Articles.

This Plugin has the following parameters:

[[Image:Plugin_load_module_parameters.png]]
*'''Enable Plugin.''' Whether or not to enable this Plugin.
*'''Style.''' The Style for the loaded Module.

===Content - Pagebreak===
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.
<pre>
Syntax: Usage: <hr class="system-pagebreak" />
<hr class="system-pagebreak" title="The page title" /> or
<hr class="system-pagebreak" alt="The first page" /> or
<hr class="system-pagebreak" title="The page title" alt="The first page" /> or
<hr class="system-pagebreak" alt="The first page" title="The page title" />
</pre>
This Plugin has the following parameters:

[[Image:Plugin_pagebreak_parameters.png]]
*'''Enable Plugin.''' Whether or not to enable this Plugin.
*'''Site Title.''' Whether or not the title and heading attributes from the Plugin will be added to the Site Title tag.
*'''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.

===Editor - No Editor===
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 Parameters.

===Editor - TinyMCE 2.0===
This Plugin loads the TinyMCE 2.0 editor. This is the default editor in Joomla!. This Plugin has the following Plugin parameters:

[[Image:Plugin_tinymce_parameters.png]]
*'''Functionality.''' Select "Advanced" or "Simple" functionality. With "Simple" selected, the User has only 9 toolbar buttons: Bold, Italic, Underline, Strikethrough, Undo, Re-do, Clean up messy code, Bullets, and Numbering. With "Advanced" selected, the User has all of the TinyMCE toolbar buttons. "Advanced" is the default setting.
*'''Code Cleanup on Startup.''' Whether or not to automatically clean up the HTML code when the editor first loads. Default value is "Off".
*'''Code Cleanup on save.''' Whether to run HTML code cleanup when a file is saved. Options are "Never", "Front Only", and "Always". The default setting is "Always".
*'''Do not clean HTML entities.''' Whether or not to skip cleaning of HTML entities. The default value is "No", which means that HTML entities will be stripped from the file.
*'''Save Warning.''' Whether or not to give a warning if the User cancels without saving the file. The default value is "Off".
*'''Compressed Version.''' Whether or not to use the compressed version of TinyMCE. Note that this does not work reliably with Windows IE, so "Off" is the recommended setting and is the default.
*'''URLs.''' Whether to use Relative or Absolute URLs for links. The default is "Relative".
*'''Text Direction.''' Whether the language reads "Left to Right" or "Right to Left" (for example, like Arabic). Default is "Left to Right".
*'''Automatic Language Selection.''' Whether or not to match the selected UI language. Do not set to "Yes" unless the appropriate editor languages are installed. Default is "No".
*'''Language Code.''' Editor UI language code. This must be entered if Automatic Language Selection is "Off". Default is "en" for British English.
*'''Prohibited Elements.''' The elements that will be cleaned from the text. Default is "applet", which will remove applet elements from the text.
*'''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.
*'''New Lines.''' Whether to interpret new lines as "P Elements" or "BR Elements". Default is "P Elements".
*'''Extended Valid Elements.''' Optional list of valid HTML elements to add to the existing rule set.

This Plugin has the following advanced parameters:

[[Image:Plugin_tinymce_advanced.png]]
*'''Horizontal Rule.''' Whether to Hide or Show the Horizontal Rule button.

The following settings only apply if the editor is in Advanced mode.

*'''Smilies.''' Hide or Show the 'Smilies' button.
*'''Table.''' Hide or Show the Table buttons.
*'''Style.''' Hide or Show the 'CSS Style' button.
*'''Layer.''' Hide or Show the Layer buttons.
*'''XHTMLxtras.''' Hide or Show the additional XHTML features.
*'''Template.''' Hide or Show the 'Template' button.
*'''Directionality.''' Hide or Show the 'Directionality' button.
*'''Fullscreen.''' Hide or Show the 'Fullscreen' button.
*'''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.
*'''Preview.''' Hide or Show the 'Preview' button.
*'''Element Path.''' If set to "On", show the 'Set Classes' button for the marked text.
*'''Insert Date.''' Hide or Show the 'Insert Date' button.
*'''Date Format.''' The Date format to use for Insert Date.
*'''Insert Time.''' Hide or Show the 'Insert Time' button.
*'''Date Format.''' The Time format to use for Insert Time.

===Editor - XStandard Lite 2.0===
This Plugin provides the XStandard editor. It has the following parameters:

[[Image:Plugin_xstandard_parameters.png]]
*'''Editor Mode.''' Three modes of operation are possible: WYSIWYG, Source, or Screen Reader.
*'''Word Wrap.''' Whether to have Word Wrap turned Off or On.

===Editor Button - Image===
This Plugin displays the Image button below the editor box when you are using a Joomla! editor (for example, when writing an Article). It allows you to insert an image into an Article. This Plugin has no parameters.

===Editor Button - Pagebreak===
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 parameters.

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

===Search - Content===
This Plugin enables searching for Articles. It has the following parameters:

[[Image:Plugin_search_parameters.png]]
{{colheader|Search Limit}}
*'''Articles.''' Whether or not to search Articles.
*'''Uncategorized Articles.''' Whether or not to search Uncategorized Articles.
*'''Archived Articles.''' Whether or not to search Archived Articles.

===Search - Weblinks===
This Plugin enables searching for Web Links. It has the following parameters:

[[Image:Plugin_search_weblinks_parameters.png]]
{{colheader|Search Limit}}

===Search - Contacts===
This Plugin enables searching for Contacts. It has the following parameters:

[[Image:Plugin_search_weblinks_parameters.png]]
{{colheader|Search Limit}}

===Search - Categories===
This Plugin enables searching for Category information. It has the following parameters:

[[Image:Plugin_search_weblinks_parameters.png]]
{{colheader|Search Limit}}

===Search - Sections===
This Plugin enables searching for Section information. It has the following parameters:

[[Image:Plugin_search_weblinks_parameters.png]]
{{colheader|Search Limit}}

===Search - Newsfeeds===
This Plugin enables searching for News Feeds. It has the following parameters:

[[Image:Plugin_search_weblinks_parameters.png]]
{{colheader|Search Limit}}

===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. This Plugin has no parameters.

===System - Debug===
This Plugin provides debugging information. It has the following parameters (note, screenshot needs updating):

[[Image:Plugin_debug_parameters.png]]

*'''Display Profiling Information''' (New in 1.5.4) Whether or not to display the time profiling information.
*'''Display SQL query log.''' Whether or not to include the SQL query log in the debug information.
*'''Display memory usage.''' Whether or not to include memory usage data in the debug information.
*'''Display undefined language strings.''' Whether or not to include undefined language strings in the debug information.
*'''Display loaded language files''' (New in 1.5.4) Whether or not to display the language files that have been loaded to generate the page. This has two modes: diagnostic and designer. Diagnostic mode displays the untranslated string and the likely file location whether the JText call was made. Designer mode displays the strings in a format that can be copy-pasted into a .ini language file (displays the list in KEY=String format).
*'''Strip Key Prefix''' (New in 1.5.4) When untranslated strings are displayed in Designer mode, this allows you to strip a prefix from the string to form the key. This is useful if the designer uses a common prefix for their extension(s) when using JText methods.

Note that the display of untranslated strings will only display the value passed to the appropriate JText method. For example, with the following code:
<source lang="php"><?php echo JText::_( 'Reports Import Configuration' ); ?></source>

If untranslated, Designer mode will display this as:

# /administrator/components/com_reports/views/reports/tmpl/default.php
REPORTS IMPORT CONFIGURATION=Reports Import Configuration

If the Strip Key Prefix is set to "Reports", then the display would change slightly to:

# /administrator/components/com_reports/views/reports/tmpl/default.php
REPORTS IMPORT CONFIGURATION=Import Configuration

Finally, the path shown is only a best guess based on a call to the PHP debug_backtrace function. Sometimes it is accurate, sometimes it is not and there are also cases where no file could be determined. In those cases you have to use your best judgement.

===System - Legacy===
This Plugin allows you to use Extensions in "1.5 Legacy" mode. Note that this Plugin is disabled by default and must be enabled before you can use this type of Extension. This Plugin has the following parameter:

[[Image:Plugin_legacy_parameters.png]]
*'''Use Legacy URL Routing.''' Whether or not to use the legacy URL routing mechanism for legacy Extensions. The default value is "No".

===System - 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 parameters:

[[Image:Plugin_cache_parameters.png]]
*'''Use Browser Caching.''' Whether or not to use the mechanism for storing a page cache in the local browser. Default is "No".
*'''Cache Lifetime.''' The time, in minutes, to save a cached page. Default is 15 minutes.

===System - Log===
This Plugin enables system logging. A log is a file that contains information about the web site activity. It can be used to see a history of activity and to troubleshoot problems on the site. This Plugin has no parameters.

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

===System - Backlink===
The Backlink Plugin provides support for legacy Joomla! 1.0.x links. It redirects old style URL and document links to the correct Joomla! 1.5 targets. It has the following parameters:

[[Image:Plugin_backlink_parameters.png]]
*'''Search Query Strings.''' If "Yes", the system will search for version 1.0 query strings that might match and then redirects to the new URL. Default is "Yes".
*'''Search SEF.''' If "Yes", the system will use the Joomla! 1.0 style SEF format and will redirect to the new link. Default is "Yes".
*'''Attempt Legacy SEF.''' If "Yes", the system will use the Joomla! 1.0 style of SEF format and will attempt to generate a valid link. Default is "Yes".

===User - Joomla!===
This Plugin handles the default User synchronisation. It has the following paramemters:

[[Image:Plugin_user_joomla_parameters.png]]
*'''Auto-create Users.''' Whether or not to automatically create registered Joomla! users where possible. Default is "Yes".

===XML-RPC - Joomla===
This Plugin provides the XML-RPC API to Joomla! users. It has no parameters.

===XML-RPC - Blogger API===
This Plugin enables the Blogger XML-RPC API protocol for your Joomla! web site. If enabled, this allows bloggers to add Articles to the site from any application that supports this API. This Plugin has the following parameters:

[[Image:Plugin_xmlrpc_parameters.png]]
*'''New posts.''' The Category in which to place new posts received via this API. Select from the drop-down list of Categories.
*'''Edit posts.''' The Section from which to retrieve new posts from. Select from the drop-down list of Sections.

==Toolbar==
At the top right you will see the toolbar:

[[Image:Plugin_edit_toolbar.png]]
{{toolbaricon|Save}}
{{toolbaricon|Apply}}
{{toolbaricon|Close}}
{{toolbaricon|Help}}

==Quick Tips==
*If you want to use any Extensions in "1.5 Legacy" mode, you need to enable the "System - Legacy" Plugin. This Plugin is disabled by default.
*If you are using the TinyMCE 2.0 editor, you can control which options appear on the editor's toolbar by setting the parameters in the "Editor - TinyMCE 2.0" Plugin.

==Related Information==
*To install new Plugin Extensions: [[screen.installer.15#Install Screen|Extension Manager - Install Screen]]
*To uninstall third-party Plugins: [[screen.installer.15#Plugins Screen|Extension Manager - Plugins Screen]]

<noinclude>{{cathelp|1.5|Plugin Manager|Extensions}}</noinclude>