pgsrc/Help%2FTranscludePlugin

   1 Date: Mon, 20 Oct 2008 14:15:24 +0000
   2 Mime-Version: 1.0 (Produced by PhpWiki 1.3.14-20080124)
   3 X-Rcs-Id: $Id$
   4 Content-Type: application/x-phpwiki;
   5   pagename=Help%2FTranscludePlugin;
   6   flags=PAGE_LOCKED;
   7   markup=2;
   8   charset=iso-8859-1
   9 Content-Transfer-Encoding: binary
  10
  11 The *Transclude* plugin can be used to embed include whole (external) web
  12 pages within a wiki page.
  13
  14 !!! Arguments
  15
  16 {| class="bordered"
  17 |-
  18 | Argument
  19 | Description
  20 | Default value
  21 |-
  22 | src
  23 | The URL of the page to transclude
  24 | ''none''
  25 |-
  26 | height
  27 | 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.)
  28 | 450
  29 |-
  30 | quiet
  31 | If set, frame appears as normal content
  32 | false
  33 |}
  34
  35 !!! Bugs / Caveats
  36
  37 o Pages are transcluded using =<iframe>= tags.  Older browsers do not
  38   support ''iframe''s.  In that case the user will be presented with a
  39   link to the transcluded material.
  40
  41 o When possible, Javascript code is used to adjust the height of the
  42   _iframe_ so that it fits the entire transcluded page.
  43   Unfortunately, this seems possible only when the transcluded page
  44   comes from the same server as the wiki page.  (This restriction is
  45   due to security checks built in to the Javascript language.)
  46
  47 o The recursion detection code does not currently work.  Be careful to
  48   avoid recursive transclusions, or you'll be sorry (or at least
  49   amused.)
  50
  51 !!! Example
  52
  53 <verbatim>
  54 <?plugin Transclude src="http://phpwiki.sourceforge.net/demo/ChangeLog" ?>
  55 </verbatim>
  56
  57 will get you
  58
  59 <?plugin Transclude src="http://phpwiki.sourceforge.net/demo/ChangeLog" ?>
  60
  61 ----
  62 [PhpWikiDocumentation] [CategoryWikiPlugin]