summaryrefslogtreecommitdiff
path: root/doc/plugins
diff options
context:
space:
mode:
authorJoey Hess <joey@kodama.kitenet.net>2008-05-02 13:02:07 -0400
committerJoey Hess <joey@kodama.kitenet.net>2008-05-02 13:02:07 -0400
commitb2dea99417ebfee3d448ab6b49ca58cb2780258d (patch)
tree2ef858a5bd85d9fb500554933c002eb805e43d94 /doc/plugins
parent9fca7f2f8b64f4caded4a0099cef1f4d152dabee (diff)
Fix ugly display when editing a page that has vanished.
srcfile now has an optional second parameter to avoid it throwing an error if the source file does not exist.
Diffstat (limited to 'doc/plugins')
-rw-r--r--doc/plugins/write.mdwn6
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index ea2d00630..183675c53 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -529,12 +529,16 @@ a type that ikiwiki knowns how to htmlize. Otherwise, returns undef.
Given the name of a source file, returns the name of the wiki page
that corresponds to that file.
-#### `srcfile($)`
+#### `srcfile($;$)`
Given the name of a source file in the wiki, searches for the file in
the source directory and the underlay directories (most recently added
underlays first), and returns the full path to the first file found.
+Normally srcfile will fail with an error message if the source file cannot
+be found. The second parameter can be set to a true value to make it return
+undef instead.
+
#### `add_underlay($)`
Adds a directory to the set of underlay directories that ikiwiki will