Extension:Iframe

Copyright & security issues
Embedding external webpage into MediaWiki has two issues:


 * Copyright violation: Embedding an external web page may violate copyrights. So, make sure that the domains that can be used in the extension are trusted!
 * Security issue: External web pages may contain malicious code. Again make sure that the domains that can be used in the extension are trusted!

The extension uses keys to select web servers which are given by the wiki administrator during installation. Therefore, behind the key should only be trusted domains.

Known problems

 * If you use the Visual Editor then iframe are not shown as code.
 * The extension does not work properly with the MobileFrontend extension.
 * Templates do not correctly pass keys and instead always use the  key.
 * Workaround:
 * Add  to LocalSettings.php.
 * Use  in the template page.
 * The downside is that only one domain can be targeted, as you only have one  key.

Download
You can obtain the extension from Github.

Installation
'''NOTE: A new version 0.10 is at Github. It should solve a problem on someone else server, but I could not reproduce his error. Therefore wait some days until the NOTE vanishes!'''


 * 1) Go to the extensions directory and
 * 2) clone it from GitHub
 * 3) for earlier MediaWiki versions than 1.36.1 you may use   if the current version does not work
 * 4) Add to the bottom of

The global variable  controls various aspects of the extensions, e.g. additional web adresses, delay of iframe loadings etc.

Adding other web addresses
If, for example, you want to embed a page with the address, then under the   statement in  add and then in the wiki page, add

Category
For easy finding of all wiki pages which have a  inside a category is added by    the name of the category can be controlled in  by setting

Notes:
 * The extension does NOT create the page  , that is left to the wiki administrator or user.
 * If you create the page   then it might be useful to use hidden categories.

Width and height of an iframe
The default width and height of an iframe is 800x600 pixel. This can be set in via

If no width and height is given then these defaults are used.

Delay of iframe loading
Usually a HTML document is shown if all parts of a document are loaded. If a iframe on a server, e.g. a Shiny server, triggers a lengthy computation then the document will appear only after all iframe(s) are loaded. Therefore a delay mechanism with JavaScript is included which starts the loading of the iframe(s) only after the document is ready. By  the delay is controlled:


 * 1) If in    (or any negative value) is set then the iframe(s) will be loaded immediately, no delay  will take place.
 * 2) If in    (the default) is set then the first iframe will be loaded 100 ms after the document is loaded, the second 200 ms, and so on.

Examples
1. Shows the test page of my shiny server

2. Shows the example app for R codes which I use (to load a file click on, select  and choose an example file).

3. As 2., but the iframe window has only VGA size (640x480).

Usage
The tag  has the following attributes

The final URL is build by  where   and   are given by the , e.g. the examples above will generate the URLs


 * and

Note: you can abbreviate the keys, e.g. for the examples above could be used

Usage in templates
Due to a bug, the below behavior is not accurate. Please see the "Known problems" section above for how to use IFrames in templates.

If you want to use the iframe tag in templates then use in the template:



This will also allow to embed parameters, e.g.



Wikis

 * Old MM-Stat wiki (development wiki) (in German)
 * New MM-Stat wiki (in German), Special page, Example page

Mailing list
There is a mailing list available: iframe.mediawiki@lists.hu-berlin.de. Note: as author of the extension I rarely read the discusson page but I read my e-mail every day ;)