From 9ec9d6901d444af48555abf7b4c26d1965c46017 Mon Sep 17 00:00:00 2001
From: Joey Hess <joey@kodama.kitenet.net>
Date: Sat, 27 Sep 2008 14:14:36 -0400
Subject: Export pagetitle, titlepage, linkpage.

---
 doc/index/discussion.mdwn        |  2 +-
 doc/plugins/write.mdwn           | 17 +++++++++++++++++
 doc/todo/wikiwyg/discussion.mdwn |  1 +
 3 files changed, 19 insertions(+), 1 deletion(-)

(limited to 'doc')

diff --git a/doc/index/discussion.mdwn b/doc/index/discussion.mdwn
index e9993f512..89e12e6c2 100644
--- a/doc/index/discussion.mdwn
+++ b/doc/index/discussion.mdwn
@@ -411,7 +411,7 @@ I'm sure that this is documented somewhere but I've ransacked the wiki and I can
 > The default `wiki_file_regexp` matches filenames containing only
 > `[-[:alnum:]_.:/+]`
 > 
-> The IkiWiki::titlepage() function will convert freeform text to a valid
+> The titlepage() function will convert freeform text to a valid
 > page name. See [[todo/should_use_a_standard_encoding_for_utf_chars_in_filenames]]
 > for an example. --[[Joey]]
 
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
diff --git a/doc/todo/wikiwyg/discussion.mdwn b/doc/todo/wikiwyg/discussion.mdwn
index cbf969471..304b39620 100644
--- a/doc/todo/wikiwyg/discussion.mdwn
+++ b/doc/todo/wikiwyg/discussion.mdwn
@@ -90,6 +90,7 @@ changes.diff:
     I have to use the IkiWiki package instead of IkiWiki::Plugin::Wikiwyg? Or would a 
     better approach be to just copy that function into the Wikiwyg plugin?
     * You can just call `IkiWiki::pagetitle()`.
+      > Note: pagetitle is now exported.
 
 wikiwyg.tar.gz
 
-- 
cgit v1.2.3