pgsrc/Help%2FTranscludePlugin

   1 Date: Thu, 15 Apr 2010 16:32:58 +0000
   2 Mime-Version: 1.0 (Produced by PhpWiki 1.4.0RC-20100415)
   3 X-Rcs-Id: $Id$
   4 Content-Type: application/x-phpwiki;
   5   pagename=Help%2FTranscludePlugin;
   6   flags=PAGE_LOCKED%2CEXTERNAL_PAGE;
   7   markup=2;
   8   charset=UTF-8
   9 Content-Transfer-Encoding: binary
  10
  11 The **Transclude** [[Help:WikiPlugin|plugin]] can be used to embed include whole (external) web pages within a wiki page.
  12
  13 == Arguments
  14
  15 {| class="bordered"
  16 |-
  17 ! Argument
  18 ! Description
  19 ! Default value
  20 |-
  21 | **src**
  22 | The URL of the page to transclude
  23 | //none//
  24 |-
  25 | **title**
  26 | The title of the page to transclude
  27 | //Transcluded page//
  28 |-
  29 | **height**
  30 | 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.)
  31 | 450
  32 |-
  33 | **quiet**
  34 | If set, frame appears as normal content
  35 | false
  36 |}
  37
  38 == Bugs / Caveats
  39
  40 * 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 transcluded material.
  41 * 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.)
  42 * The recursion detection code does not currently work.  Be careful to avoid recursive transclusions, or you'll be sorry (or at least amused.)
  43
  44 == Example
  45
  46 {{{
  47 <<Transclude src="http://phpwiki.svn.sourceforge.net/viewvc/phpwiki/trunk/pgsrc/ReleaseNotes?view=markup">>
  48 }}}
  49
  50 will get you
  51
  52 <<Transclude src="http://phpwiki.svn.sourceforge.net/viewvc/phpwiki/trunk/pgsrc/ReleaseNotes?view=markup">>
  53
  54 <noinclude>
  55 ----
  56 [[PhpWikiDocumentation]] [[CategoryWikiPlugin]]
  57 </noinclude>