pgsrc/Help%2FTranscludePlugin

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