Merge branch 'master' of ssh://git.ikiwiki.info
[ikiwiki] / doc / plugins / embed.mdwn
1 [[!template id=plugin name=embed author="[[Joey]]"]]
2 [[!tag type/html]]
3
4 This plugin allows embedding content from external sites on 
5 wiki pages.
6
7 Normally, the [[htmlscrubber]] does not allow the tags that are used for
8 embedding content from external sites, since `<iframe>`, `<embed>`, and
9 `<object>` tags can be used for various sorts of attacks. This plugin
10 allows such tags to be put on a page, if they look like they are safe.
11
12 In the examples below, the parts of the html that you can change are denoted
13 with "XXX"; everything else must appear exactly as shown to be accepted by the
14 plugin.
15
16 **This plugin is deprecated.** Rather than relying on these complex lists
17 of safe content, which constantly fall out of date, you're recommended to
18 configure the [[htmlscrubber]] to not scrub some pages, which only trusted
19 users can edit. Then you can embed anything from anywhere on those pages.
20 See [[tips/embedding_content]] for details and examples.
21 This plugin's lists of safe embedded content will not be maintained, and 
22 the plugin will be removed in a future  release.
23
24 ## google maps
25
26 Use html like this to embed a map:
27
28         <iframe width="XXX" height="XXX" frameborder="XXX" scrolling="XXXX" marginheight="XXXX" marginwidth="XXXX" src="http://maps.google.com/?XXX"></iframe>
29
30 (This method only allows embeddeding a simple map. To use the full
31 [Google Maps API](http://www.google.com/apis/maps/) from ikiwiki, including
32 drawing points and GPS tracks on the map, try the [[contrib/googlemaps]]
33 plugin.)
34
35 ## youtube
36
37 Use html like this to embed a video:
38
39         <object width="XXX" height="XXX"><param name="movie" value="http://www.youtube.com/v/XXX"></param><param name="wmode" value="transparent"></param>
40         <embed src="http://www.youtube.com/v/XXX" type="application/x-shockwave-flash" wmode="transparent" width="XXX" height="XXX"></embed></object>
41
42 ## google video
43
44 Use html like this to embed a video:
45
46         <embed style="width:XXXpx; height:XXXpx;" id="XXX" type="application/x-shockwave-flash" src="http://video.google.com/googleplayer.swf?XXX" flashvars=""></embed>
47
48 ## google calendar
49
50 Use html like this to embed a calendar:
51
52         <iframe src="http://www.google.com/calendar/embed?XXX" style="border-width:XXX" width="XXX" frameborder="XXX" height="XXX"></iframe>
53