]> sipb.mit.edu Git - ikiwiki.git/blob - doc/todo/utf8.mdwn
latex version of logo
[ikiwiki.git] / doc / todo / utf8.mdwn
1 ikiwiki should support utf-8 pages, both input and output
2
3 Currently ikiwiki is belived to be utf-8 clean itself; it tells perl to use
4 binmode when reading possibly binary files (such as images) and it uses
5 utf-8 compatable regexps etc.
6
7 utf-8 IO is not enabled by default though. While you can probably embed
8 utf-8 in pages anyway, ikiwiki will not treat it right in the cases where
9 it deals with things on a per-character basis (mostly when escaping and
10 de-escaping special characters in filenames).
11
12 To enable utf-8, edit ikiwiki and add -CSD to the perl hashbang line.
13 (This should probably be configurable via a --utf8 or better --encoding=
14 switch.)
15
16 The following problems have been observed when running ikiwiki this way:
17
18 * If invalid utf-8 creeps into a file, ikiwiki will crash rendering it as
19   follows:
20
21         Malformed UTF-8 character (unexpected continuation byte 0x97, with no preceding start byte) in substitution iterator at /usr/bin/markdown line 1317.
22         Malformed UTF-8 character (fatal) at /usr/bin/markdown line 1317.
23
24   In this example, a literal 0x97 character had gotten into a markdown
25   file.