]> CyberLeo.Net >> Repos - SourceForge/phpwiki.git/blob - pgsrc/Help%2FTranscludePlugin
Harmonize documentation
[SourceForge/phpwiki.git] / pgsrc / Help%2FTranscludePlugin
1 Date: Wed, 28 May 2008 19:06:31 +0200
2 Mime-Version: 1.0 (Produced by PhpWiki 1.3.14-20080124)
3 Content-Type: application/x-phpwiki;
4   pagename=Help%2FTranscludePlugin;
5   flags="";
6   markup=2;
7   charset=iso-8859-1
8 Content-Transfer-Encoding: binary
9
10 The Help:TranscludePlugin can be used to embed include whole (external) web
11 pages within a wiki page.
12
13 ! Plugin Arguments
14
15 =src= |
16   The URL of the page to transclude
17 =height= |
18   The (initial) height of the transclusion frame.
19   If, possible, after the transcluded page is loaded,
20   the frame is resized via javascript so that it
21   fits the entire transcluded page.  (See below for more.)
22
23 ! Bugs / Caveats
24
25 o Pages are transcluded using =<iframe>= tags.  Older browsers do not
26   support ''iframe''s.  In that case the user will be presented with a
27   link to the trancluded material.
28
29 o When possible, JavaScript code is used to adjust the height of the
30   _iframe_ so that it fits the entire transcluded page.
31   Unfortunately, this seems possible only when the transcluded page
32   comes from the same server as the wiki page.  (This restriction is
33   due to security checks built in to the JavaScript language.)
34
35 o The recursion detection code does not currently work.  Be careful to
36   avoid recursive transclusions, or you'll be sorry (or at least
37   amused.)
38
39 !!! Example
40
41 <verbatim>
42 <?plugin Transclude src="http://phpwiki.sourceforge.net/demo/ChangeLog" ?>
43 </verbatim>
44
45 will get you
46
47 <?plugin Transclude src="http://phpwiki.sourceforge.net/demo/ChangeLog" ?>