Actions

Help33

Extensions Module Manager Wrapper

From Joomla! Documentation

Revision as of 09:24, 4 April 2013 by JoomlaWikiBot (Talk | contribs)

Contents

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

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.

File:Help30-Extensions-Module-Manager-Wrapper-screen.png

Toolbar

At the top left you will see the toolbar:

Help30-Save-SaveClose-SaveNew-SaveCopy-Close-Help-toolbar.png

The functions are:

  • Save. Saves the module and stays in the current screen.
  • Save & Close. Saves the module and closes the current screen.
  • Save & New. Saves the module and keeps the editing screen open and ready to create another module.
  • Save as Copy. Saves your changes to a copy of the current module. Does not affect the current module. This toolbar icon is not shown if you are creating a new module.
  • Cancel/Close. Closes the current screen and returns to the previous screen without saving any modifications you may have made.
  • Help. Opens this help screen.

Details

Basic Options

File: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

File: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
  • 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.

Menu Assignment

Quick Tips

No tips have been added for the Wrapper module.