Actions

Help16

Difference between revisions of "Extensions Module Manager Wrapper"

From Joomla! Documentation

(Screenshot)
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
 
 
== How to access ==
 
== How to access ==
 
To add the Wrapper module, go to your site back-end.  Using the top menu, go to '''Extensions -> module manager''' and select "new". Then, select Wrapper.
 
To add the Wrapper module, go to your site back-end.  Using the top menu, go to '''Extensions -> module manager''' and select "new". Then, select Wrapper.
Line 6: Line 4:
 
== Description ==
 
== Description ==
 
The wrapper module allows you to display an external website in a module.  The functionality is the same to that of the 'iFrame Wrapper' you can add as a menu item.  If the page to which the wrapper is linked is too big, bars will be shown below and to the right of the wrapper, allowing you to "navigate" the page.
 
The wrapper module allows you to display an external website in a module.  The functionality is the same to that of the 'iFrame Wrapper' you can add as a menu item.  If the page to which the wrapper is linked is too big, bars will be shown below and to the right of the wrapper, allowing you to "navigate" the page.
 +
 +
The module type is '''mod_wrapper'''
  
 
== Screenshot ==
 
== Screenshot ==
  
Below, you see an image of the Wrapper in action. [[Image:J16_module_wrapper.png|frame|center]]   
 
  
This Module provides functionality similar to the Internal Link - Wrapper Layout in the [[Screen.menus.edit.15#Internal Link - Wrapper|Menu Item Manager - New/Edit]] screen. The Module Type name for this Module is "mod_wrapper". It is not related to any other component.
+
Below, you see an image of the Wrapper in action.  
  
'''Module Parameters'''
+
 
[[Image:Wrapper_module_parameters.png|frame|center]]
+
[[Image:J16_module_wrapper.png|frame|center]]
{{colheader|Module Class Suffix}}
+
 
 +
== Options ==
 +
 
 +
===Basic Options===
 +
 
 +
 
 +
[[Image:J16_module_wrapper_basic.png|frame|center]]
 
*'''URL.''' URL for the web site to be wrapped.
 
*'''URL.''' URL for the web site to be wrapped.
*'''Scroll Bars.''' Whether or not to provide scroll bars for the IFrame. If the setting is "Auto", scroll bars will be provided automatically if needed.
+
*'''Auto Add''' When enabled, 'http://' is added automatically to your URL,if needed. When disabled, 'http://' won't be added automatically.
 +
*'''Scroll Bars.''' Whether or not to provide scroll bars for the IFrame. If the setting is "Auto", scroll bars will be provided automatically if needed. When set to "no" scroll bars will never be shown.
 
*'''Width.''' Width of the IFrame, in pixels. If you add a "%" to the end of the number, it is read as a percentage instead of pixels.
 
*'''Width.''' Width of the IFrame, in pixels. If you add a "%" to the end of the number, it is read as a percentage instead of pixels.
 
*'''Height.''' Height of the IFrame, in pixels.
 
*'''Height.''' Height of the IFrame, in pixels.
 
*'''Auto Height.''' Whether or not to set the height automatically to the size of the external page.
 
*'''Auto Height.''' Whether or not to set the height automatically to the size of the external page.
*'''Auto Add.''' Whether or not to automatically add "http:" or "https:" to the beginning of the URL. This will be added only if it is missing.
 
 
*'''Target Name.''' Optional name of the IFrame when used as a target.
 
*'''Target Name.''' Optional name of the IFrame when used as a target.
  
'''Advanced Parameters'''
+
 
[[Image:most_read_advanced.png|frame|center]]
+
===Advanced Options===
 +
 
 +
 
 +
[[Image:j16_module_wrapper_advanced.png|frame|center]]
 +
*'''Alternative layout''' Apply an alternative layout or template override
 +
*'''Module Class Suffix''' Apply a CSS suffix to the module
 
{{colheader|Caching}}
 
{{colheader|Caching}}
 
{{colheader|Cache Time}}
 
{{colheader|Cache Time}}
 +
 +
==Quick Tips==
 +
 +
No tips have been added for the Wrapper module.

Latest revision as of 15:38, 3 May 2011

Contents

How to access

To add the Wrapper module, go to your site back-end. Using the top menu, go to Extensions -> module manager and select "new". Then, select Wrapper.

Description

The wrapper module allows you to display an external website in a module. The functionality is the same to that of the 'iFrame Wrapper' you can add as a menu item. If the page to which the wrapper is linked is too big, bars will be shown below and to the right of the wrapper, allowing you to "navigate" the page.

The module type is mod_wrapper

Screenshot

Below, you see an image of the Wrapper in action.


J16 module wrapper.png

Options

Basic Options

J16 module wrapper basic.png
  • URL. URL for the web site to be wrapped.
  • Auto Add When enabled, 'http://' is added automatically to your URL,if needed. When disabled, 'http://' won't be added automatically.
  • Scroll Bars. Whether or not to provide scroll bars for the IFrame. If the setting is "Auto", scroll bars will be provided automatically if needed. When set to "no" scroll bars will never be shown.
  • Width. Width of the IFrame, in pixels. If you add a "%" to the end of the number, it is read as a percentage instead of pixels.
  • Height. Height of the IFrame, in pixels.
  • Auto Height. Whether or not to set the height automatically to the size of the external page.
  • Target Name. Optional name of the IFrame when used as a target.


Advanced Options

J16 module wrapper advanced.png
  • Alternative layout Apply an alternative layout or template override
  • Module Class Suffix Apply a CSS suffix to the module
  • Caching. Use Global/No Caching. Whether or not to cache the content of this Module. A setting of "Use Global" will use the Cache Settings from the Global Configuration screen.
  • Cache Time. The length of time, in minutes, before the Module is re-cached.

Quick Tips

No tips have been added for the Wrapper module.