summaryrefslogtreecommitdiff
path: root/doc/plugins
diff options
context:
space:
mode:
authorJoey Hess <joey@kodama.kitenet.net>2008-09-27 14:14:36 -0400
committerJoey Hess <joey@kodama.kitenet.net>2008-09-27 14:27:42 -0400
commit9ec9d6901d444af48555abf7b4c26d1965c46017 (patch)
tree3139a86f4dcffaea5d90c6120b8b1d25edbc07e6 /doc/plugins
parentbfab23ce33c86f03bff6fb5c36f7bf082fe2cbcf (diff)
Export pagetitle, titlepage, linkpage.
Diffstat (limited to 'doc/plugins')
-rw-r--r--doc/plugins/write.mdwn17
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index 1cdea6a77..0e4f2fd6f 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -627,6 +627,23 @@ 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.
+#### `pagetitle($)`
+
+Give the name of a wiki page, returns a version suitable to be displayed as
+the page's title. This is accomplished by de-escaping escaped characters in
+the page name. "_" is replaced with a space, and '__NN__' is replaced by
+the UTF character with code NN.
+
+#### `titlepage($)`
+
+This performs the inverse of `pagetitle`, ie, it converts a page title into
+a wiki page name.
+
+#### `linkpage($)`
+
+This converts text that could have been entered by the user as a
+[[WikiLink]] into a wiki page name.
+
#### `srcfile($;$)`
Given the name of a source file in the wiki, searches for the file in