Help310

Difference between revisions of "Extensions Module Manager Wrapper"

From Joomla! Documentation

m (→‎Quick Tips: updating Help screens relevant versions)
m (updated to automated style)
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
=Wrapper Module=
 
 
==Overview==
 
 
==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==
 
==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'''
+
==How to Access==
 +
{{Chunk30:ModuleManager-How-to-acces-module|module=Wrapper}}
 +
 
 +
{{Chunk30:Help-3x-module-site-wrapper}}
  
==Screenshot==
+
===Common Details===
Below, you see an image of the Wrapper in action.
+
{{Chunk30:Module Details}}
  
[[Image:Help30-Extensions-Module-Manager-Wrapper-screen.png]]
+
===Common Tabs===
 +
{{Chunk30:Help-3x-module-site-common-tabs}}
  
 
==Toolbar==
 
==Toolbar==
 
{{Chunk30:Help_screen_module_manager_edit_toolbar}}
 
{{Chunk30:Help_screen_module_manager_edit_toolbar}}
 
==Details==
 
 
==Basic Options==
 
[[Image:Help30-Extensions-Module-Manager-Wrapper-basic-options-parameters.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==
 
[[Image:Help30-Extensions-Module-Manager-Wrapper-advanced-options-parameters.png]]
 
*'''Alternative layout''' Apply an alternative layout or template override
 
*'''Module Class Suffix''' Apply a CSS suffix to the module
 
{{colheader|Caching}}
 
{{colheader|Cache Time}}
 
 
==Menu Assignment==
 
  
 
==Quick Tips==
 
==Quick Tips==
 
No tips have been added for the Wrapper module.
 
No tips have been added for the Wrapper module.
  
<noinclude>{{cathelp|3.0,3.1|Module Manager Help Screens|Extensions Help Screens}}</noinclude>
+
The module type is '''mod_wrapper'''
 +
 
 +
<noinclude>{{cathelp|3.0,3.1,3.2|Module Manager Help Screens|Extensions Help Screens}}</noinclude>

Revision as of 14:37, 11 December 2013

Description[edit]

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.

How to Access[edit]

Delete-icon.png
This Page is a Candidate for Deletion

This page is a candidate for deletion. The given reason is: No links here.

This notice should remain for a minimum of 1 week after it was placed on the page. If discussion is still ongoing, it should remain until a consensus is reached, after which the page will either be deleted or this notice removed. If you disagree with its deletion, please discuss your reasons on its associated talk page, as applicable.

Remember to check if anything links here and the page history before deleting.

Last edit by Tom Hutchison (talk · contrib) · Last edited on Wed, 11 Dec 2013 14:37:55 +0000


Screenshot[edit]

Help-3x-modules-site-module-manager-module-wrapper.png

Details[edit]

  • Title: Module must have a title

Module[edit]

This module shows an iFrame window to specified location.

  • URL: URL to site/file you wish to display within the iframe.
  • Auto Add: (Yes/No). By default, http:// will be added unless it detects http:// or https:// in the URL you provide. This allows you to switch this ability off.
  • Scroll Bars: (Auto/No/Yes). Show/Hide Horizontal & Vertical Scroll Bars.
  • Width: Width of the iFrame window. You can enter an absolute figure in pixels or a relative figure by adding a %.
  • Height: Height of the iFrame window
  • Auto Height: (Yes/No). The height will automatically be set to the size of the external page. This will only work for pages on your own domain.
  • Frame border: (Yes/No). Show frame border which wraps the iframe
  • Target Name: Name of the iFrame when used as Target

Common Details[edit]

Delete-icon.png
This Page is a Candidate for Deletion

This page is a candidate for deletion. The given reason is: No links here.

This notice should remain for a minimum of 1 week after it was placed on the page. If discussion is still ongoing, it should remain until a consensus is reached, after which the page will either be deleted or this notice removed. If you disagree with its deletion, please discuss your reasons on its associated talk page, as applicable.

Remember to check if anything links here and the page history before deleting.

Last edit by Tom Hutchison (talk · contrib) · Last edited on Wed, 11 Dec 2013 14:37:55 +0000


Common Tabs[edit]

Delete-icon.png
This Page is a Candidate for Deletion

This page is a candidate for deletion. The given reason is: No links here.

This notice should remain for a minimum of 1 week after it was placed on the page. If discussion is still ongoing, it should remain until a consensus is reached, after which the page will either be deleted or this notice removed. If you disagree with its deletion, please discuss your reasons on its associated talk page, as applicable.

Remember to check if anything links here and the page history before deleting.

Last edit by Tom Hutchison (talk · contrib) · Last edited on Wed, 11 Dec 2013 14:37:55 +0000


Toolbar[edit]

Delete-icon.png
This Page is a Candidate for Deletion

This page is a candidate for deletion. The given reason is: No links here.

This notice should remain for a minimum of 1 week after it was placed on the page. If discussion is still ongoing, it should remain until a consensus is reached, after which the page will either be deleted or this notice removed. If you disagree with its deletion, please discuss your reasons on its associated talk page, as applicable.

Remember to check if anything links here and the page history before deleting.

Last edit by Tom Hutchison (talk · contrib) · Last edited on Wed, 11 Dec 2013 14:37:55 +0000


Quick Tips[edit]

No tips have been added for the Wrapper module.

The module type is mod_wrapper