[2nd Revision]: Module: Wrapper 1.5x

[Michelle Bisson]

Please edit and proof-read this text. I will then update the admin manual.  Please read: Guidelines for Editing and Proof-reading:

http://forum.joomla.org/index.php/topic,437.0.html

Please publish your work here in this thread.

Thanks!
============================================
Module: Wrapper
http://help.joomla.org/content/view/437/153/

[rdb]

*** Checked out for proof reading/editing ***

[Michelle Bisson]

Great!  Thanks!

[rdb]

*** Checked back in ***

The Wrapper Module provides a means of displaying external web page pages within an existing Joomla! site. These external pages are displayed by using an “Inline frame” (also called an Iframe) in the main content area of the running site.

The features of this module are quite useful. It not only provides the capability of transparently displaying external sites, it also provides a means of including specialized HTML content that cannot be easily created using the Joomla! frame work. (e.g. Pure DHTML pages that require the use of a specialized Web Editor.) 

The Wrapper Module may also be used to integrate specialized scripts and applications without the overhead of writing code that uses the Joomla! API. These external applications are rendered seamlessly within a running site giving the appearance of a native Joomla! component.

Type: mod_wrapper

Details:

Title: Enter or edit (if needed) the title that will be displayed in the title bar of the module on the displayed page.

Show title: Select "Yes" to have the title displayed. Select "No" to hide the title.

Position: Select the position from this drop-down list to place this module in a specific position on the displayed page. For example selecting "left" position places the module in the displayed page's left column. Selecting "right" position places the module in the displayed page's right column. These positions are determined by it's location in the template.

Module order: Select the order from this drop-down list to determine the order this module will appear relative to other modules listed in the same "Position" (e.g. "left" or "right"). See "Position" in this document.

Access Level: Select the access level (which is the site’s user groups) from the multi-item select box to determine which sets of users have access to this module.

Published: Select "Yes" to publish this module; Select "No" to unpublish. Published modules are displayed on the pages selected in the "Pages / Items " menu on this page. Unpublished modules are hidden from view, even if there are selections made in "Pages/Items".

ID: This is a unique identification number assigned to this module by the Joomla! system. This is automatically generated and cannot be changed.

Pages / Items: Select one or more items in this multi-item select box to determine the pages this module will be displayed on. The position that the module is actually displayed is affected by the choices made in the "Position" menu mentioned on this page.

Parameters:

Module Class Suffix: Enter the suffix for the CSS class of this module. (e.g .moduletable-poll). In this example, the "-poll" is the suffix. This suffix class must currently be in the template CSS Style file. This allows individual CSS classes to be applied to certain modules independent of the site's default Template CSS classes.

URL : Enter the URL for the site/file you wish to display within the IFrame.
URL : Enter the URL of the site or web page to be displayed by the Wrapper Module.

Scroll Bars: Choose whether horizontal and vertical scroll bars are added to your page. 'No' means scroll bars are never shown even when content extends beyond the inline frame, 'Yes' means scroll bars are always used even when content does not extend beyond the inline frame, and 'Auto' means scrolls bars are shown only when necessary.
Scroll Bars: Select the “No” radio button to never display horizontal and/or vertical scroll bars with the inline frame. This means that no scroll bars will be shown, even if the displayed content extends beyond the inline frame’s borders. Select the “Yes” radio button to always display scroll bars with the inline frame. Select the “Auto” radio button to display scroll bars only when necessary. In this case scroll bars are dynamically displayed based on the dimensions of the content returned for each page.

Width: Type in a value for the width of the Iframe window, either in pixels or in percentage. Percentage is relative to the html element where the tag is placed in the template.
Width: Type in a value for the width of the inline frame. This value may be entered as a number that represents the fixed width of the frame in pixels. It may also be entered as a percentage. In this case the percentage value is relative to the width of the content area that contains the inline frame.

Height: Type in a value for the height of the Iframe window, either in pixels or in percentage (see above).
Height: Type in a value for the height of the inline frame. This value may be entered as a number that represents the width of the frame in pixels. It may also be entered as a percentage. In this case the percentage value is relative to the height of the content area that contains the inline frame.

Auto Height:  Choose "Yes" if you desire the height of the Wrapper page to be set to the size of the external Web page.  Choose "No" if you do not.
Auto Height:  Select the "Yes" radio button to allow the height of the inline frame to be determined by the height of the external web page.  Select the "No" radio button if you do not want to apply this behavior.

Note: The value entered for the “Height” parameter overrides this setting (see “Height” above.)

Auto Add: Choose "Yes"  if you wish  'http://' to be automatically added to the URL that you type in the Wrapper Link field in the Details tab.  If you already have typed in the "http://"  in the  link field then Joomla will recognize this and not put a second "http:" in the link field.  If set to 'No,' then you must type 'http://' or 'https://' at the beginning of the URL in the URL field, or else the link in the URL field will be treated as a link relative to the URL of your site.
Auto Add: Select the "Yes" radio button if you wish  the 'http://' prefix to be automatically added to the URL entered (see the “URL” parameter above.)  Select the “No” radio button if you wish to manually add the “http://” (or “https://”) prefix to the URL. Turning this off is also useful if you need to display a URL that is relative to your site's root. For example if you entered "local_non_joomla_content" and your site's root URL is "http://www.mysite.com", Joomla! will display the relative URL "http://www.mysite.com/local_non_joomla_content/"

[Michelle Bisson]

Thanks! 

[Michelle Bisson]

rdb,

This text is ready to be published to the help site.  Please update the change log and let me know when it is finished.

[charlwillia6]

rdb,

I am posting here to make sure that you are aware that the changelog has not been updated yet.  I didn't want it to get buried. 

Charles

[rdb]

Thanks Charles, I totally missed this one.

-- Richard

[Michelle Bisson]

rdb,

Has the changelog now been updated?

[charlwillia6]

Michelle,

I checked, the changelog has indeed been updated.

[Michelle Bisson]

Would someone from the community mind to another proof-read.  It is always good to have fresh eyes review our work.

Thanks!

[day]

michelle, i just want to comment on this

Auto Height:  Choose "Yes" if you desire the height of the Wrapper page to be set to the size of the external Web page

when i started using joomla, it was working well ... until version 1.0.7 ... but no more.
i think it was due to some bug in joomla version. 1.0.8

[bmw]

If I might suggest, that it is not intuitive for a general user or even an expert to know where the wrapper exists.  It would be good to both include the default in the documentation AND in a tooltip in the menu section where one would create a link in a menu.

Bruce

[nathandiehl]

first paragraph, first paragraph, Details: ID, last paragraph : Joomla should be Joomla!
first paragraph: i think it confusing, perhaps, so say the wrapper 'integrates' into Joomla! site. 'integration' seems to me to be more intertwined, using 1 login. just my opinion here, though.

There is not consistance use of Iframe or inline frame on this page. Both are used in different places. Should be uniform to avoid confusion.

Details:
Title: "Title :' should be "Title:'
Access Level: the list format is not consistant with what i've seen elsewhere, i.e. no comma before 'or' (should be Public, Registered, or Special)
Published: second line states "NOTE: The Position of this module must be available in your template." This doesn't belong under the published section but under the 'Position' section instead.
Pages / Items: "Choose which pages" could be clarified by "Choose on which pages'


Parameters:
Auto Heigh: contains extra space after initial 'Auto Height:  "
Auto Add: extra space after first ' "Yes"  '

Auto Heitht/Auto Add: There is inconsistant use of quote mark and double-quote mark in these two sections.

[Michelle Bisson]

Thanks Day and BMW for your comments!

[nathandiehl]

one question: is it normal for there to be months between proofing and updating the content? I'm getting a bit discouraged that i've spent time proofreading and nothing gets updated. I just dont' want to be wasting my time proofing if you really don't need/want this assistance. But i'm certainly willing to copyedit if there is a purpose and reason...

Just found 1 more:
Parameters: Auto-Height: There are 3 spaces between sentances here.

[Michelle Bisson]

Hello Nathan,

I just dont' want to be wasting my time proofing if you really don't need/want this assistance. But i'm certainly willing to copyedit if there is a purpose and reason...

I now assume that you did not get my pm inviting you to join our team.  I did not transfer any of your corrections to the help site because I was planning for you to do the transfer.

Please contact me by pm.