aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins/getsource.mdwn
diff options
context:
space:
mode:
authorSimon McVittie <smcv@ http://smcv.pseudorandom.co.uk/>2009-08-01 12:31:34 +0100
committerSimon McVittie <smcv@ http://smcv.pseudorandom.co.uk/>2009-08-01 12:31:34 +0100
commit3f39e69b13851d3bed8e1cae0525d6ad8ac768cf (patch)
tree45e966d6537a0928f30cc3fa6f5b3ced0c7d71e4 /doc/plugins/getsource.mdwn
parent70b1c2aabd0d591cbdb30765c5a7e000e993f343 (diff)
downloadikiwiki-3f39e69b13851d3bed8e1cae0525d6ad8ac768cf.tar
ikiwiki-3f39e69b13851d3bed8e1cae0525d6ad8ac768cf.tar.gz
Document the getsource plugin
Diffstat (limited to 'doc/plugins/getsource.mdwn')
-rw-r--r--doc/plugins/getsource.mdwn13
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/plugins/getsource.mdwn b/doc/plugins/getsource.mdwn
new file mode 100644
index 000000000..4fbf4be98
--- /dev/null
+++ b/doc/plugins/getsource.mdwn
@@ -0,0 +1,13 @@
+[[!template id=plugin name=getsource author="[[Will_Uther|Will]]"]]
+
+This plugin adds a `getsource` action to the IkiWiki CGI, and a "Source" link
+that uses it to display pages' source.
+
+Configuration for this plugin in the setup file:
+
+* `getsource_mimetype => "text/plain; charset=utf-8"`
+
+ Sets the MIME type used when page source is requested. The default is
+ usually appropriate, but you could set this to `application/octet-stream`
+ to encourage browsers to download the source to a file rather than showing
+ it in the browser.