]> CyberLeo.Net >> Repos - SourceForge/phpwiki.git/blob - pgsrc/Help%2FTranscludePlugin
Harmonize documentation
[SourceForge/phpwiki.git] / pgsrc / Help%2FTranscludePlugin
1 Date: Mon, 16 Jun 2008 14:15:24 +0000
2 Mime-Version: 1.0 (Produced by PhpWiki 1.3.14-20080124)
3 X-Rcs-Id: $Id: Help%2FTranscludePlugin,v 1.4 2008-06-18 01:12:39 vargenau Exp $
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 =src= |
17   The URL of the page to transclude
18 =height= |
19   The (initial) height of the transclusion frame.
20   If, possible, after the transcluded page is loaded,
21   the frame is resized via javascript so that it
22   fits the entire transcluded page.  (See below for more.)
23
24 !!! Bugs / Caveats
25
26 o Pages are transcluded using =<iframe>= tags.  Older browsers do not
27   support ''iframe''s.  In that case the user will be presented with a
28   link to the trancluded material.
29
30 o When possible, JavaScript code is used to adjust the height of the
31   _iframe_ so that it fits the entire transcluded page.
32   Unfortunately, this seems possible only when the transcluded page
33   comes from the same server as the wiki page.  (This restriction is
34   due to security checks built in to the JavaScript language.)
35
36 o The recursion detection code does not currently work.  Be careful to
37   avoid recursive transclusions, or you'll be sorry (or at least
38   amused.)
39
40 !!! Example
41
42 <verbatim>
43 <?plugin Transclude src="http://phpwiki.sourceforge.net/demo/ChangeLog" ?>
44 </verbatim>
45
46 will get you
47
48 <?plugin Transclude src="http://phpwiki.sourceforge.net/demo/ChangeLog" ?>
49
50 ----
51 [PhpWikiDocumentation] [CategoryWikiPlugin]