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