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|Help:WikiPlugin] 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 | title
  27 | The title of the page to transclude
  28 | ''Transcluded page''
  29 |-
  30 | height
  31 | 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.)
  32 | 450
  33 |-
  34 | quiet
  35 | If set, frame appears as normal content
  36 | false
  37 |}
  38
  39 !!! Bugs / Caveats
  40
  41 o Pages are transcluded using =<iframe>= tags.  Older browsers do not
  42   support ''iframe''s.  In that case the user will be presented with a
  43   link to the transcluded material.
  44
  45 o When possible, Javascript code is used to adjust the height of the
  46   _iframe_ so that it fits the entire transcluded page.
  47   Unfortunately, this seems possible only when the transcluded page
  48   comes from the same server as the wiki page.  (This restriction is
  49   due to security checks built in to the Javascript language.)
  50
  51 o The recursion detection code does not currently work.  Be careful to
  52   avoid recursive transclusions, or you'll be sorry (or at least
  53   amused.)
  54
  55 !!! Example
  56
  57 <verbatim>
  58 <?plugin Transclude src="http://phpwiki.sourceforge.net/demo/ChangeLog" ?>
  59 </verbatim>
  60
  61 will get you
  62
  63 <?plugin Transclude src="http://phpwiki.sourceforge.net/demo/ChangeLog" ?>
  64
  65 ----
  66 [PhpWikiDocumentation] [CategoryWikiPlugin]