Diff: Help/TranscludePlugin

Differences between current version and previous revision of Help/TranscludePlugin.

Other diffs: Previous Major Revision, Previous Author

Newer page: version 6 Last edited on 17 January 2022 3:00 by harold
Older page: version 5 Last edited on 9 September 2007 0:16 by harold Revert
@@ -1,38 +1,48 @@
-The Help:TranscludePlugin can be used to embed include whole (external) web  
- pages within a wiki page. 
+The **Transclude** [[ Help:WikiPlugin|plugin]] can be used to embed include whole (external) web pages within a wiki page. 
  
-! Plugin Arguments  
+Pages are transcluded using ##<iframe>## tags.  
  
-=src = |  
- The URL of the page to transclude  
- =height = |  
- The (initial) height of the transclusion frame.  
- If, possible, after the transcluded page is loaded,  
- the frame is resized via javascript so that it  
- fits the entire transcluded page. (See below for more.)  
+== Arguments == 
  
-! Bugs / Caveats  
+{| class="bordered"  
+|-  
+ ! Argument  
+! Description  
+! Default value  
+|-  
+| **src**  
+| The URL of the page to transclude  
+| //none//  
+|-  
+| **title**  
+| The title of the page to transclude  
+| //Transcluded page/ /  
+|-  
+| **height**  
+| The (initial) height of the transclusion frame. If, possible, after the transcluded page is loaded, the frame is resized via Javascript so that it fits the entire transcluded page. (See below for more.)  
+| 450  
+|-  
+| **quiet**  
+| If set, frame appears as normal content  
+| false  
+|}  
  
-o Pages are transcluded using =<iframe> = tags. Older browsers do not  
- support ''iframe''s. In that case the user will be presented with a  
- link to the trancluded material.  
+== Bugs / Caveats ==  
  
-o When possible, JavaScript code is used to adjust the height of the  
- _ iframe_ so that it fits the entire transcluded page.  
- Unfortunately, this seems possible only when the transcluded page  
- comes from the same server as the wiki page. (This restriction is  
- due to security checks built in to the JavaScript language.) 
+* When possible, Javascript code is used to adjust the height of the // iframe// so that it fits the entire transcluded page. Unfortunately, this seems possible only when the transcluded page comes from the same server as the wiki page. (This restriction is due to security checks built in to the Javascript language.)  
+* The recursion detection code does not currently work. Be careful to avoid recursive transclusions, or you'll be sorry (or at least amused .) 
  
-o The recursion detection code does not currently work. Be careful to  
- avoid recursive transclusions, or you'll be sorry (or at least  
- amused.)  
+== Example ==  
  
-! Example  
-  
-<verbatim>  
- <?plugin Transclude src="http ://phpwiki. sourceforge.net/demo /ChangeLog" ?>  
-</verbatim > 
+{{{  
+<<Transclude src="https ://sourceforge.net/p /phpwiki/code/HEAD/tree/trunk/pgsrc/ReleaseNotes ?view=markup" >>  
+}}}  
  
 will get you 
  
-<?plugin Transclude src="http ://phpwiki. sourceforge.net/demo /ChangeLog" ?> 
+<< Transclude src="https ://sourceforge.net/p /phpwiki/code/HEAD/tree/trunk/pgsrc/ReleaseNotes ?view=markup">>  
+  
+<noinclude>  
+----  
+[[PhpWikiDocumentation]] [[CategoryWikiPlugin]]  
+</noinclude > 

current version

The Transclude plugin can be used to embed include whole (external) web pages within a wiki page.

Pages are transcluded using <iframe> tags.

Arguments

Argument

Description

Default value

src

The URL of the page to transclude

none

title

The title of the page to transclude

Transcluded page

height

The (initial) height of the transclusion frame. If, possible, after the transcluded page is loaded, the frame is resized via Javascript so that it fits the entire transcluded page. (See below for more.)

450

quiet

If set, frame appears as normal content

false

Bugs / Caveats

  • When possible, Javascript code is used to adjust the height of the iframe so that it fits the entire transcluded page. Unfortunately, this seems possible only when the transcluded page comes from the same server as the wiki page. (This restriction is due to security checks built in to the Javascript language.)
  • The recursion detection code does not currently work. Be careful to avoid recursive transclusions, or you'll be sorry (or at least amused.)

Example

<<Transclude src="https://sourceforge.net/p/phpwiki/code/HEAD/tree/trunk/pgsrc/ReleaseNotes?view=markup">>

will get you

Transcluded from https://sourceforge.net/p/phpwiki/code/HEAD/tree/trunk/pgsrc/ReleaseNotes?view=markup