summaryrefslogtreecommitdiff
path: root/doc/plugins/write.mdwn
diff options
context:
space:
mode:
authorJoey Hess <joey@kodama.kitenet.net>2008-01-29 00:07:55 -0500
committerJoey Hess <joey@kodama.kitenet.net>2008-01-29 00:07:55 -0500
commit2ff726e87595d7496245f7c01e2bb217004979c0 (patch)
treefdf75574a8d643ffdb06861b566cbff47e32100c /doc/plugins/write.mdwn
parent5921b86fccde90e5a9c77623d808be06f40cbe47 (diff)
don't render internal-use pages, and document them
Diffstat (limited to 'doc/plugins/write.mdwn')
-rw-r--r--doc/plugins/write.mdwn5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index 0da425402..76fa3f0d7 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -143,6 +143,11 @@ specifies the filename extension that a file must have to be htmlized using
this plugin. This is how you can add support for new and exciting markup
languages to ikiwiki.
+Note that if you choose a filename extension that starts with "_",
+ikiwiki will not render the page, or allow the page to be edited with the
+web interface. This is useful for certian types of internal-use pages, but
+should generally be avoided.
+
The function is passed named parameters: "page" and "content" and should
return the htmlized content.