aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/news/now_with_style.mdwn4
-rw-r--r--doc/plugins/haiku.mdwn4
-rw-r--r--doc/roadmap.mdwn4
-rw-r--r--doc/sandbox/test.mdwn2
-rw-r--r--doc/todo/done/utf8.mdwn13
-rw-r--r--doc/todo/multiple_templates.mdwn3
-rw-r--r--doc/todo/pageindexes.mdwn3
-rw-r--r--doc/todo/plugin.mdwn4
-rw-r--r--doc/todo/utf8.mdwn41
9 files changed, 29 insertions, 49 deletions
diff --git a/doc/news/now_with_style.mdwn b/doc/news/now_with_style.mdwn
index 9f4237683..f04530163 100644
--- a/doc/news/now_with_style.mdwn
+++ b/doc/news/now_with_style.mdwn
@@ -1 +1,3 @@
-Ikiwiki also supports style sheets now. I've not done too much with the default style sheet, but you can customise [[style.css]] to do whatever you like with the look of your wiki. \ No newline at end of file
+Ikiwiki also supports style sheets now. I've not done too much with the
+default style sheet, but you can customise [[style.css]] to do whatever you
+like with the look of your wiki.
diff --git a/doc/plugins/haiku.mdwn b/doc/plugins/haiku.mdwn
index 5a9f89c6f..be462645b 100644
--- a/doc/plugins/haiku.mdwn
+++ b/doc/plugins/haiku.mdwn
@@ -8,7 +8,9 @@ what to write the haiku about. If no hint is given, it might base it on the
page name. Since the vocabulary it knows is very small, many hints won't
affect the result at all.
-This plugin is included in ikiwiki, but is not enabled by default.
+This plugin is included in ikiwiki, but is not enabled by default. As a
+special bonus, enabling this plugin makes any error messages ikiwiki should
+display be written in haiku.
You need to have the Coy module installed for this plugin to do anything
interesting. That does all the heavy lifting.
diff --git a/doc/roadmap.mdwn b/doc/roadmap.mdwn
index 338ccd0be..8e9c5b462 100644
--- a/doc/roadmap.mdwn
+++ b/doc/roadmap.mdwn
@@ -13,8 +13,8 @@ Released 29 April 2006.
* Unit test suite (with tests of at least core stuff like
[[GlobList]]).
-* [[todo/Plugin]] mechanism.
-* Should have fully working [[todo/utf8]] support.
+* [[Plugins]]
+* Should have fully working [[todo/done/utf8]] support.
* [[Optimised_rendering|todo/optimisations]] if possible. Deal with other scalability issues.
* improved [[todo/html]] stylesheets and templates
* A version of the logo in a different font, possibly with the dots on the i's highlighted in some other color.
diff --git a/doc/sandbox/test.mdwn b/doc/sandbox/test.mdwn
index 3b53e07e0..3bbc982de 100644
--- a/doc/sandbox/test.mdwn
+++ b/doc/sandbox/test.mdwn
@@ -1 +1 @@
-This is a [[SubPage]] of the [[SandBox]]. \ No newline at end of file
+This page, [[test]], is a [[SubPage]] of the [[SandBox]].
diff --git a/doc/todo/done/utf8.mdwn b/doc/todo/done/utf8.mdwn
new file mode 100644
index 000000000..b49bb3376
--- /dev/null
+++ b/doc/todo/done/utf8.mdwn
@@ -0,0 +1,13 @@
+ikiwiki should support utf-8 pages, both input and output. To test, here's a
+utf-8 smiley:
+
+# ☺
+
+Currently ikiwiki is belived to be utf-8 clean itself; it tells perl to use
+binmode when reading possibly binary files (such as images) and it uses
+utf-8 compatable regexps etc.
+
+Notes:
+
+* Apache "AddDefaultCharset on" settings will not play well with utf-8
+ pages. Turn it off.
diff --git a/doc/todo/multiple_templates.mdwn b/doc/todo/multiple_templates.mdwn
index 809a089eb..459a5fa4f 100644
--- a/doc/todo/multiple_templates.mdwn
+++ b/doc/todo/multiple_templates.mdwn
@@ -4,3 +4,6 @@
Well, that would probably be fairly easy to add if it used globlists to
specify which pages use the non-default template.
+
+Hmm, I think the pagetemplate hook should allow one to get close enough to
+this in a plugin now.
diff --git a/doc/todo/pageindexes.mdwn b/doc/todo/pageindexes.mdwn
index ac4c460ae..c4a9df9a3 100644
--- a/doc/todo/pageindexes.mdwn
+++ b/doc/todo/pageindexes.mdwn
@@ -1,2 +1,3 @@
Might be nice to support automatically generating an index based on headers
-in a page, for long pages. The question is, how to turn on such an index? Well, make it a [[plugin]] enabled by a [[preprocessordirective]].
+in a page, for long pages. The question is, how to turn on such an index?
+Well, make it a [[plugin]] enabled by a [[preprocessordirective]].
diff --git a/doc/todo/plugin.mdwn b/doc/todo/plugin.mdwn
index fc0107b6f..03183d119 100644
--- a/doc/todo/plugin.mdwn
+++ b/doc/todo/plugin.mdwn
@@ -1,8 +1,8 @@
Suggestions of ideas for plugins:
* list of registered users - tricky because it sorta calls for a way to rebuild the page when a new user is registered. Might be better as a cgi?
-* a [[todo/link_map]]
-* [[todo/sigs]] ?
+* a [[link_map]]
+* [[sigs]] ?
* [[pageindexes]]
* Wiki stats, such as total number of links, most linked to pages
diff --git a/doc/todo/utf8.mdwn b/doc/todo/utf8.mdwn
deleted file mode 100644
index b905e4633..000000000
--- a/doc/todo/utf8.mdwn
+++ /dev/null
@@ -1,41 +0,0 @@
-ikiwiki should support utf-8 pages, both input and output. To test, here's a
-utf-8 smiley:
-
-# ☺
-
-Currently ikiwiki is belived to be utf-8 clean itself; it tells perl to use
-binmode when reading possibly binary files (such as images) and it uses
-utf-8 compatable regexps etc.
-
-utf-8 IO is not enabled by default though. While you can probably embed
-utf-8 in pages anyway, ikiwiki will not treat it right in the cases where
-it deals with things on a per-character basis (mostly when escaping and
-de-escaping special characters in filenames).
-
-To enable utf-8, edit ikiwiki and add -CSD to the perl hashbang line.
-(This should probably be configurable via a --utf8 or better --encoding=
-switch.)
-
-The following problems have been observed when running ikiwiki this way:
-
-* If invalid utf-8 creeps into a file, ikiwiki will crash rendering it as
- follows:
-
- Malformed UTF-8 character (unexpected continuation byte 0x97, with no preceding start byte) in substitution iterator at /usr/bin/markdown line 1317.
- Malformed UTF-8 character (fatal) at /usr/bin/markdown line 1317.
-
- In this example, a literal 0x97 character had gotten into a markdown
- file.
-
- Running this before markdown can avoid it:
-
- $content = Encode::encode_utf8($content);
-
- I'm not sure how, or what should be done after markdown to get the string
- back into a form that perl can treat as utf-8.
-
-* Apache "AddDefaultCharset on" settings will not play well with utf-8
- pages.
-
-* CGI::FormBuilder needs to be told to set `charset => "utf-8"` so that
- utf-8 is used in the edit form. (done)