Actions

Help25

Difference between revisions of "Extensions Module Manager Wrapper"

From Joomla! Documentation

(Created page with "== 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. ==...")
 
m (removing needs images)
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
== How to access ==
+
{{RightTOC}}
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.
+
==How to Access==
 +
To ''''add'''' a new Wrapper or ''''edit'''' an existing Wrapper Module, navigate to the [[Help25:Extensions_Module_Manager|Module Manager]]:
 +
* Select {{rarr|Extensions,Module Manager}}
  
== Description ==
+
Click the ''''New'''' button and click on Wrapper in the modal popup window.
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'''
+
To ''''Edit'''' an existing Wrapper Module, in the Module Manager click on an '''Wrapper Modules Title''' or click the '''Wrapper Modules check box''' and then click the '''Edit''' button in the Toolbar.
  
== Screenshot ==
+
==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.
  
 +
==Screenshot==
 +
[[Image:Help25-module-manager-wrapper-screenshot.png]]
  
Below, you see an image of the Wrapper in action.
+
==Details and Options==
 
+
===Details===
 
+
{{Chunk25:Module Details}}
[[Image:J25_module_wrapper.png|frame|center]]
+
 
+
== Options ==
+
  
 
===Basic Options===
 
===Basic Options===
 +
[[Image:Help25-module-manager-wrapper-basic-options-screenshot.png]]
 +
{{chunk25:colheader|URL}} Generally, it is a good idea to always add http:// or https:// when providing a URL. There is a [[Help25:Menus Menu Item Wrapper#Advanced Options|Auto add]] function to prefix a URL with http:// unless it detects the prefix in the URL. ''NOTE - Use the relative path to a web page address on Joomla installation. If your Joomla! website is <code><nowiki>http://www.example.com</nowiki></code>, then use <code> /html_docs/example.html</code> omitting <code><nowiki>http://www.example.com</nowiki></code> and make sure the 'Auto add' function is disabled.
 +
{{Chunk25:colheader|Auto add}}
 +
{{Chunk25:colheader|Scroll Bars}}
 +
{{Chunk25:colheader|Width}}
 +
{{Chunk25:colheader|Height}}
 +
{{Chunk25:colheader|Auto height}}
 +
{{Chunk25:colheader|Frame border}}
 +
*'''Target Name.''' Optional name of the iFrame when used as a target.
  
 +
===Advanced Options===
 +
{{Chunk25:Module Advanced Options}}
  
[[Image:J25_module_wrapper_basic.png|frame|center]]
+
===Menu Assignment===
*'''URL.''' URL for the web site to be wrapped.
+
{{Chunk25:Menu Assignment}}
*'''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.
+
  
 +
==Toolbar==
 +
{{Chunk25:Help_screen_module_manager_edit_toolbar}}
  
===Advanced Options===
+
==Front End Screenshot==
 
+
{{Chunk25:Help screen screenshot disclaimer}}
 +
Wrapper module shown:
  
[[Image:j25_module_wrapper_advanced.png|frame|center]]
+
[[Image:Help25-module-manager-wrapper-frontend-screenshot.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}}
+
  
==Quick Tips==
+
The Module Type name for this Module is "mod_wrapper". It is not related to a component.
  
No tips have been added for the Wrapper module.
+
<noinclude>{{cathelp|2.5|Module Manager Help Screens|Extensions Help Screens}}</noinclude>

Latest revision as of 07:12, 12 April 2013

Contents

How to Access

To 'add' a new Wrapper or 'edit' an existing Wrapper Module, navigate to the Module Manager:

  • Select Extensions  Module Manager

Click the 'New' button and click on Wrapper in the modal popup window.

To 'Edit' an existing Wrapper Module, in the Module Manager click on an Wrapper Modules Title or click the Wrapper Modules check box and then click the Edit button in the Toolbar.

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.

Screenshot

Help25-module-manager-wrapper-screenshot.png

Details and Options

Details

Help25-module-manager-details-screenshot.png

  • Title. The title of the module. This is also the title displayed in the front end for the module depending on the Show Title Form Field
  • Show Title. (Show/Hide) Choose whether to show or hide the modules title in the front end. The title will be the one in the Form Field above.
  • Module Position. Choose the module position you wish this module to be displayed in. A custom module position can be entered for use with the load position plugin or the position button can be pressed to select a module position from the template.
  • Status. (Published/Unpublished/Archived/Trashed) The published status of the item.
  • Access. The viewing level access for this item.
  • Module Ordering. This shows a drop down of every module in the position that the current module is in. This is the order that the modules will display in when displayed on in the front end as well as in the Module Manager.
  • Start Publishing. Date and time to start publishing. Use this field if you want to enter content ahead of time and then have it published automatically at a future time.
  • Finish Publishing. Date and time to finish publishing. Use this field if you want to have content automatically changed to Unpublished state at a future time (for example, when it is no longer applicable).
  • Language. Item language.
  • Note. Item note. This is normally for the site administrator's use (for example, to document information about this item) and does not show in the front end of the site.

Basic Options

Help25-module-manager-wrapper-basic-options-screenshot.png

  • URL. Field to enter a URL (web page address). Generally, it is a good idea to always add http:// or https:// when providing a URL. There is a Auto add function to prefix a URL with http:// unless it detects the prefix in the URL. NOTE - Use the relative path to a web page address on Joomla installation. If your Joomla! website is http://www.example.com, then use /html_docs/example.html omitting http://www.example.com and make sure the 'Auto add' function is disabled.
  • Auto add. Automatically prefix web address with http://. This feature will automatically detect and not prefix a URL with http:// or https:// already used in the URL.
  • Scroll Bars. (No/Yes/Auto) Whether or not to include horizontal and vertical scroll bars, no or yes. Auto will add the scroll bars automatically when needed because of embedded page size.
  • Width. Width of the iFrame Window. Enter in a number of pixels or enter in a percentage (%). For example, "550" means 550 pixels. "75%" means 75% of the page width.
  • Height. Height of the iFrame Window. Enter in a number of pixels or enter in a percentage (%). For example, "550" means 550 pixels. "75%" means 75% of the page height.
  • Auto height. Automatically set height to height of external page. Note - this will only work if the external page is on the same domain. For example, http://www.example.com the external html must be in the example.com root file structure. Sub domains will not work, as a sub domain is considered a separate domain.
  • Frame border. Add a border around the IFrame window.
  • Target Name. Optional name of the iFrame when used as a target.

Advanced Options

Help25-module-manager-advanced-options-screenshot.png

  • Alternative Layout. If you have defined one or more alternative layouts for a module either in the template or Joomla! Core, you can select the layout to use for this module. See Layout Overrides in Joomla 2.5 for more information about alternative layouts.
  • Module Class Suffix. Setting this parameter causes Joomla! to either add a new CSS class or modify the existing CSS class for the div element for this specific module. See here for more information
  • Caching. (Use Global/No Caching) Choose whether you wish to cache the contents of the module.
  • Cache Time. The time before a module is recached.

Menu Assignment

Help25-module-manager-menu-assignment-screenshot.png

On the left there is a list of menu items. You can chose between None, All and Select Menu Item(s) from the List. To assign to some but not all pages choose the third option and select the menu links that you want the module associated with. See How do you assign a module to specific pages? for more information

Toolbar

At the top right you will see the toolbar:

Help25-Toolbar-Save-SaveClose-SaveNew-SaveCopy-Close-Help.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.

Front End Screenshot

Example Front End Site images are generic images using Joomla! core installation supplied free Front End Templates. The actual view can depend on the installed custom template used and the template's style for those views on a Joomla! website. Wrapper module shown:

Help25-module-manager-wrapper-frontend-screenshot.png

The Module Type name for this Module is "mod_wrapper". It is not related to a component.