pgsrc/Help%2FTranscludePlugin

   1 Date: Sun, 22 Feb 2009 19:16:30 +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* [[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 o Pages are transcluded using =<iframe>= tags.  Older browsers do not
  41   support ''iframe''s.  In that case the user will be presented with a
  42   link to the transcluded material.
  43
  44 o When possible, Javascript code is used to adjust the height of the
  45   _iframe_ so that it fits the entire transcluded page.
  46   Unfortunately, this seems possible only when the transcluded page
  47   comes from the same server as the wiki page.  (This restriction is
  48   due to security checks built in to the Javascript language.)
  49
  50 o The recursion detection code does not currently work.  Be careful to
  51   avoid recursive transclusions, or you'll be sorry (or at least
  52   amused.)
  53
  54 == Example
  55
  56 {{{
  57 <<Transclude src="http://phpwiki.sourceforge.net/demo/ChangeLog">>
  58 }}}
  59
  60 will get you
  61
  62 <<Transclude src="http://phpwiki.sourceforge.net/demo/ChangeLog">>
  63
  64 <noinclude>
  65 ----
  66 [[PhpWikiDocumentation]] [[CategoryWikiPlugin]]
  67 </noinclude>