Parameters PDF Print E-mail
Written by Mike Reumer   
Friday, 18 March 2011 22:21

The plugin include component has the following paremeters to be used at the command:

Name Values Default Description
url

The url to the component.

Replace with the url to your component and include index.php?
For example:
url='index.php?option=com_component&Itemid=73&parameters....'

You maybe need to change the url when using an SEF component. If you get a component not found when using normal url then use the SEF url. So not:
index.php?option=com_contact&lang=en&view=category
but:
Contact-Us/category/

You can make a hidden menu item so you can configure components with their menu paramaters. You should add the menu id as a parmeter to the url for the plugin, for example:
index.php?option=com_contact&lang=en&view=category&Itemid=63

The plugin also has parameters in the configuration screen. Goto menu extensions, submenu plugin manager, search the plugin and click on the name.
There you have the following parameters:

Name
Values
Default
Description
Ignore scripts


Add here the scripts that has to be ignored. Enter each relative url on a new line.

Add the standard javascripts loaded by the template in the ignore fields of the plugin.
This should be the same url as in the generated source of the page or the file index.php in the template directory.
Every url on a new line.

So for example:
/templates/rt_replicant2_j15/js/rokmoomenu.js
/templates/rt_replicant2_j15/js/rokfonts.js

Ignore stylesheets

Add here the stylesheets that has to be ignored. Enter each relative url on a new line.

Add the standard stylesheets loaded by the template in the ignore fields of the plugin.
This should be the same url as in the generated source of the page or the file index.php in the template directory.
Every url on a new line.

So for example:
/templates/rt_versatility_iii_j15/css/template.css
/templates/rt_versatility_iii_j15/css/style15.css
Method file_get_contents
curl
file_get_contents

You can choose file_get_contents or curl. Curl has the best results, but requires curl library installed at PHP webserver.

Curl also has the ability to login and support http security and php authentication.

Close session

Yes
No

No

Close the session in Joomla to pass it to other component.
If a session is not closed the called component may not work correctly in retrieving session parameters.
(Experts only)

Ignore sef Yes
No
No Ignore sef and use normal parameter substitution so use ? and &
Sometimes helpfull when a component show full page with header, footer and modules when using sef urls.
CB Token replace Yes
No
No Replace the tokens that CB generated with new tokens based on the page where CB is included.
Remove print Yes
No
Yes Remove the print parameter in all links on the page (default) so links goto pages with template css include instead of only print.css.
Remove tmpl Yes
No
Yes Remove the tmpl parameter in all links on the page (default) so links goto pages with full layout (header/modules) instead of only the component output.
Last Updated on Friday, 18 March 2011 23:16
 

Advertisement