format: New plugin, allows embedding differntly formatted text inside a page (ie...

[git.ikiwiki.info.git] / doc / plugins / format.mdwn

diff --git a/doc/plugins/format.mdwn b/doc/plugins/format.mdwn
new file mode 100644 (file)
index 0000000..91e707f
--- /dev/null
+++ b/doc/plugins/format.mdwn
@@ -0,0 +1,9 @@
+[[!template id=plugin name=format core=0 author="[[Joey]]"]]
+[[!tag type/format]]
+
+This plugin allows mixing different page formats together, by embedding
+text formatted one way inside a page formatted another way. This is done
+using the [[ikiwiki/directive/format]] [[ikiwiki/directive]].
+
+For example, it could be used to embed an [[otl]] outline inside a page
+that is formatted as [[mdwn]].