From 27d029113faf479464db289a71b98cbf5e672793 Mon Sep 17 00:00:00 2001
From: joey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>
Date: Thu, 23 Aug 2007 20:14:08 +0000
Subject: * Add embed plugin, which allows embedding content from google maps,
 video,   calendar, and youtube. Normally, the htmlsanitiser eats these since
 they   use unsafe tags, the embed plugin overrides it for trusted sites. *
 The googlecalendar plugin is now deprecated, and will be removed  
 eventually. Please switch to using the embed plugin.

---
 doc/plugins/embed.mdwn          | 45 +++++++++++++++++++++++++++++++++++++++++
 doc/plugins/googlecalendar.mdwn |  2 ++
 2 files changed, 47 insertions(+)
 create mode 100644 doc/plugins/embed.mdwn

(limited to 'doc')

diff --git a/doc/plugins/embed.mdwn b/doc/plugins/embed.mdwn
new file mode 100644
index 000000000..ba327da8d
--- /dev/null
+++ b/doc/plugins/embed.mdwn
@@ -0,0 +1,45 @@
+[[template id=plugin name=embed author="[[Joey]]"]]
+[[tag type/html]]
+
+This plugin allows embedding content from external sites on 
+wiki pages.
+
+Normally, the [[htmlscrubber]] does not allow the tags that are used for
+embedding content from external sites, since `<iframe>`, `<embed>`, and
+`<object>` tags can be used for various sorts of attacks. This plugin
+allows such tags to be put on a page, if they look like they are safe.
+
+In the examples below, the parts of the html that you can change are denoted
+with "XXX"; everything else must appear exactly as shown to be accepted by the
+plugin.
+
+## google maps
+
+Use html like this to embed a map:
+
+	<iframe width="XXX" height="XXX" frameborder="XXX" scrolling="XXXX" marginheight="XXXX" marginwidth="XXXX" src="http://maps.google.com/?XXX"></iframe>
+
+(This method only allows embeddeding a simple map. To use the full
+[Google Maps API](http://www.google.com/apis/maps/) from ikiwiki, including
+drawing points and GPS tracks on the map, try the [[contrib/googlemaps]]
+plugin.)
+
+## youtube
+
+Use html like this to embed a video:
+
+	<object width="XXX" height="XXX"><param name="movie" value="http://www.youtube.com/v/XXX"></param><param name="wmode" value="transparent"></param>
+	<embed src="http://www.youtube.com/v/XXX" type="application/x-shockwave-flash" wmode="transparent" width="XXX" height="XXX"></embed></object>
+
+## google video
+
+Use html like this to embed a video:
+
+	<embed style="width:XXXpx; height:XXXpx;" id="XXX" type="application/x-shockwave-flash" src="http://video.google.com/googleplayer.swf?XXX" flashvars=""></embed>
+
+## google calendar
+
+Use html like this to embed a calendar:
+
+	<iframe src="http://www.google.com/calendar/embed?XXX" style="border-width:XXX" width="XXX" frameborder="XXX" height="XXX"></iframe>
+
diff --git a/doc/plugins/googlecalendar.mdwn b/doc/plugins/googlecalendar.mdwn
index 940918078..6d7429d14 100644
--- a/doc/plugins/googlecalendar.mdwn
+++ b/doc/plugins/googlecalendar.mdwn
@@ -1,6 +1,8 @@
 [[template id=plugin name=googlecalendar author="[[Joey]]"]]
 [[tag type/special-purpose]]
 
+*Note*: This plugin is deprecated. Please switch to the [[embed]] plugin.
+
 This plugin allows embedding a google calendar iframe in the wiki.
 Normally, if the [[htmlscrubber]] is enabled, such iframes are scrubbed out
 of the wiki content since they're not very safe if created by malicious
-- 
cgit v1.2.3