1 ikiwiki (2.40) unstable; urgency=low
3 ikiwiki now has an new syntax for preprocessor directives, using the
8 This new syntax no longer relies on spaces to distinguish between
9 wikilinks and preprocessor directives. Thus, wikilinks can use spaces
10 in their link text, and preprocessor directives without arguments (such
11 as "toc") need not use a trailing space.
13 To enable the new syntax, set prefix_directives to true in your ikiwiki
14 config. For backward compatibility with existing wikis,
15 prefix_directives currently defaults to false. In ikiwiki 3.0,
16 prefix_directives will default to true, and wikis which have not yet
17 converted to the new syntax will need to set prefix_directives to false
20 To convert your wiki to the new syntax, ikiwiki provides a new script
21 ikiwiki-transition. It will convert preprocessor directives in
22 all files given on the command line. To convert an entire wiki:
24 find wikidir/ -type f -name '*.mdwn' -print0 | xargs -0 ikiwiki-transition prefix_directives
26 Even with prefix_directives disabled, ikiwiki now allows an optional '!'
27 prefix on preprocessor directives (but still requires a space). Thus, a
28 directive which uses a '!' prefix and contains a space will work with
29 ikiwiki 2.40 and newer, regardless of the value of prefix_directives.
30 This allows the underlay to work with all ikiwikis.
32 -- Josh Triplett <josh@freedesktop.org> Sat, 26 Jan 2008 16:26:47 -0800
34 ikiwiki (2.30) unstable; urgency=low
36 Ever feel that ikiwiki's handling of RecentChanges wasn't truely in the
37 spirit of a wiki compiler? Well, that's changed. The RecentChanges page is
38 now a static page, not a CGI. Users can subscribe to its rss/atom feeds.
39 Custom RecentChanges pages can be easily set up that display only changes
40 to a subset of pages, or only changes by a subset of users.
42 All wikis need to be rebuilt on upgrade to this version. If you listed your
43 wiki in /etc/ikiwiki/wikilist this will be done automatically when the
44 Debian package is upgraded. Or use ikiwiki-mass-rebuild to force a rebuild.
46 With this excellent new RecentChanges support, the mail notification system
47 is its age (and known to be variously buggy and underimplemented for
48 various VCSes), and so ikiwiki's support for sending commit mails is REMOVED
49 from this version. If you were subscribed to commit mails, you should be
50 able to accomplish the same thing by subscribing to a RecentChanges feed.
52 The "svnrepo" and "notify" fields in setup files are no longer used, and
53 silently ignored. You may want to remove them from your setup file.
55 -- Joey Hess <joeyh@debian.org> Tue, 29 Jan 2008 17:18:31 -0500
57 ikiwiki (2.20) unstable; urgency=low
59 The template plugin has begin to htmlize the variables passed to templates.
60 This is normally what you want, but to get the old behavior and get at the
61 raw value, you can use `<TMPL_VAR raw_variable>` in a template.
63 -- Joey Hess <joeyh@debian.org> Sat, 08 Dec 2007 16:04:43 -0500
65 ikiwiki (2.16) unstable; urgency=low
67 Many of the pages in ikiwiki's basewiki have been moved and renamed in this
68 release, to avoid the basewiki including pages with names like "blog".
69 Redirection pages have been left behind for these moved pages temporarily,
70 and will be removed later.
72 If you use the calendar plugin, ikiwiki is now smarter and your nightly
73 cron job to update the wiki doesn't need to rebuild everything. Just pass
74 --refresh to ikiwiki in the cron job and it will update only pages that
75 contain out of date calendars.
77 -- Joey Hess <joeyh@debian.org> Sat, 08 Dec 2007 16:04:43 -0500
79 ikiwiki (2.14) unstable; urgency=low
81 This version of ikiwiki is more picky about symlinks in the path leading
82 to the srcdir, and will refuse to use a srcdir specified by such a path.
83 This was necessary to avoid some potential exploits, but could potentially
84 break (semi-)working wikis. If your wiki has a srcdir path containing a
85 symlink, you should change it to use a path that does not.
87 -- Joey Hess <joeyh@debian.org> Mon, 26 Nov 2007 14:57:57 -0500
89 ikiwiki (2.9) unstable; urgency=low
91 Since ikiwiki 2.0 was released, some limitiations have been added to what
92 ikiwiki considers a WikiLink. In short, if there are any spaces in between
93 the brackets, ikiwiki no longer considers it to be a WikiLink. If your wiki
94 contains things meant to be WikiLinks that contain spaces, you will need to
95 fix them, by replacing the spaces with underscores.
97 WikiLink have always been documented to not contain spaces, but bugs in
98 ikiwiki made it treat some text with spaces as WikiLinks. Most of these
99 bugs were fixed in version 2.2, and a final bug was fixed in this 2.9
100 release. These fixes are necessary to avoid ambiguity between
101 WikiLinks and PreProcessorDirectives. Apologies for any inconvenience
102 these bugs (and their fixes) may have caused.
104 -- Joey Hess <joeyh@debian.org> Sat, 29 Sep 2007 14:37:18 -0400
106 ikiwiki (2.6) unstable; urgency=low
108 In this version the rst plugin allows raw html to be embedded in rst files.
109 As long as the htmlscrubber is enabled, this should be safe. If you are
110 using the rst plugin without the htmlscrubber in a publically writable wiki,
111 you should turn on the htmlscrubber.
113 -- Joey Hess <joeyh@debian.org> Sun, 29 Jul 2007 18:37:22 -0400
115 ikiwiki (2.5) unstable; urgency=low
117 Due to some config changes in this version, wrappers need to be rebuilt on
118 upgrade. If you listed your wiki in /etc/ikiwiki/wikilist this will be
119 one automatically when the Debian package is upgraded.
121 -- Joey Hess <joeyh@debian.org> Sun, 29 Jul 2007 17:54:40 -0400
123 ikiwiki (2.1) unstable; urgency=low
125 Some wikis need to be rebuilt on upgrade to this version, due to changes to
126 page templates and the style sheet. If you listed your wiki in
127 /etc/ikiwiki/wikilist this will be done automatically when the Debian
128 package is upgraded. Or use ikiwiki-mass-rebuild to force a rebuild.
130 -- Joey Hess <joeyh@debian.org> Thu, 26 Apr 2007 15:50:36 -0400
132 ikiwiki (2.00) unstable; urgency=low
134 With the 2.0 release of ikiwiki, some major changes have been made to the
135 default configuration:
137 * The 'usedirs' setting is enabled by default. This *will* break all URLs
138 to wikis that did not have 'usedirs' turned on before, unless you follow
139 the procedure described at <http://ikiwiki.info/tips/switching_to_usedirs>,
140 or edit your setup file to turn usedirs off:
143 * OpenID logins are now enabled by default, if the Net::OpenID::Consumer
144 perl module is available. Password logins are also still enabled
145 by default. If you like, you can turn either OpenID or password logins
146 off via the 'disable_plugins' setting.
148 -- Joey Hess <joeyh@debian.org> Sun, 29 Apr 2007 19:00:43 -0400
150 ikiwiki (1.51) unstable; urgency=low
152 Some wikis need to be rebuilt on upgrade to this version, due to changes to
153 page layout and the style sheet. If you listed your wiki in
154 /etc/ikiwiki/wikilist this will be done automatically when the Debian
155 package is upgraded. Or use ikiwiki-mass-rebuild to force a rebuild.
157 -- Joey Hess <joeyh@debian.org> Thu, 26 Apr 2007 15:50:36 -0400
159 ikiwiki (1.50) unstable; urgency=low
161 Permalinks and guids in rss and atom feeds for wikis using the usedirs
162 options will change in this release. If you have already enabled usedirs,
163 you may need to take steps to avoid flooding aggregators.
165 -- Joey Hess <joeyh@debian.org> Sat, 14 Apr 2007 16:08:46 -0400
167 ikiwiki (1.49) unstable; urgency=low
169 Third-party plugins that use htmlpage() or abs2rel() to generate links
170 may need changes to support the new "usedirs" option.
172 -- Joey Hess <joeyh@debian.org> Sun, 01 Apr 2007 16:20:09 -0400
174 ikiwiki (1.47) unstable; urgency=low
176 Due to a security fix, wikis that have the htmlscrubber enabled can no
177 longer use the meta plugin to insert html link and meta tags.
179 Some special case methods have been added for safely including stylesheets,
180 and for doing openid delegation. See the meta plugin docs for details.
182 -- Joey Hess <joeyh@debian.org> Wed, 21 Mar 2007 14:18:40 -0400
184 ikiwiki (1.45) unstable; urgency=low
186 Wikis need to be rebuilt on upgrade to this version. If you listed your wiki
187 in /etc/ikiwiki/wikilist this will be done automatically when the Debian
188 package is upgraded. Or use ikiwiki-mass-rebuild to force a rebuild.
190 -- Joey Hess <joeyh@debian.org> Wed, 7 Mar 2007 23:02:52 -0500
192 ikiwiki (1.44) unstable; urgency=low
194 The htmllink() function has changed slightly and plugins that use it may
195 need to change how they call it. This function's first three parameters
196 are unchanged, but additional options are now passed using named
197 parameters. If you used htmllink with more than 3 parameters, you will
198 need to change it. The plugin interface version has been increased to 1.02
199 to reflect this change.
201 -- Joey Hess <joeyh@debian.org> Mon, 19 Feb 2007 21:10:12 -0500
203 ikiwiki (1.42) unstable; urgency=low
205 The anonok setting in config files has been removed. To enable
206 httpauth support on your wiki, you should now enable the anonok plugin,
209 Third-party plugins that use pagespec_match() should be updated to pass
210 the new third parameter (from) to that function. This is needed for the
211 new relative glob matching to work.
213 -- Joey Hess <joeyh@debian.org> Thu, 1 Feb 2007 16:57:59 -0500
215 ikiwiki (1.34) unstable; urgency=low
217 The httpauth setting in config files has been removed. To enable
218 httpauth support on your wiki, you should now enable the httpauth plugin,
221 This release includes OpenID support that is enabled through the openid
222 plugin. I recommend turning this on to make it easier for users to sign
225 -- Joey Hess <joeyh@debian.org> Sun, 19 Nov 2006 20:53:05 -0500
227 ikiwiki (1.32) unstable; urgency=low
229 There is a change to the plugin interface in this version. Any plugins that
230 modify data in %links should pass scan => 1 when registering the hook that
233 -- Joey Hess <joeyh@debian.org> Sat, 28 Oct 2006 00:13:12 -0400
235 ikiwiki (1.29) unstable; urgency=low
237 Wikis need to be rebuilt on upgrade to this version. If you listed your wiki
238 in /etc/ikiwiki/wikilist this will be done automatically when the Debian
239 package is upgraded. Or use ikiwiki-mass-rebuild to force a rebuild.
241 There is a change to the plugin interface in this version. Plugins that use
242 %renderedfiles will need to be updated, as the hash's values are now arrays
243 of rendered files. Plugins that cause a page to render additional files
244 should use the new will_render function to register the files.
246 -- Joey Hess <joeyh@debian.org> Sun, 8 Oct 2006 17:27:56 -0400
248 ikiwiki (1.22) unstable; urgency=low
250 Due to some changes in the CSS, wikis should be rebuilt on upgrade to this
251 version. If you listed your wiki in /etc/ikiwiki/wikilist this will be done
252 automatically when the Debian package is upgraded. Or use ikiwiki-mass-rebuild
255 If you have modified versions of ikiwiki's html templates, you will need
256 to update your templates to link to the stylesheet file using
257 "<TMPL_VAR BASEURL>style.css" instead of the old method which used
260 There have also been some changes to the plugin interface:
261 Any plugins that use santize, htmlize, or format hooks will need to be
262 updated for this version of ikiwiki since these hooks have been changed
263 to use named parameters.
265 -- Joey Hess <joeyh@debian.org> Tue, 22 Aug 2006 15:33:12 -0400
267 ikiwiki (1.13) unstable; urgency=low
269 The GlobList format which was used for specifiying sets of pages, has been
270 replaced with a new, more expressive PageSpec format. While GlobLists will
271 continue to work, that format is deprecated, and you are encouraged to use
272 PageSpecs from now on, and also to change any GlobLists in your wiki to
273 PageSpecs. See the new PageSpec page for details.
275 You will need to rebuild your wiki when upgrading to this version. If you
276 listed your wiki in /etc/ikiwiki/wikilist this will be done automatically
277 when the Debian package is upgraded. Or use ikiiki-mass-rebuild to force a
280 -- Joey Hess <joeyh@debian.org> Tue, 1 Aug 2006 18:29:51 -0400
282 ikiwiki (1.11) unstable; urgency=low
284 Some changes to tags in this release, due to a new tag plugin. If you have
285 been using the meta plugin to tag pages, you'll want to enable the tag
286 plugin too, and change things like this:
288 [[meta link="foobar"]]
294 The new tags will appear at page footers, and are also easier to type.
296 There have also been some changes to the plugin interface, particularly the
297 interface of pagetemplate hooks has changed. See the changelog for details.
299 -- Joey Hess <joeyh@debian.org> Thu, 27 Jul 2006 17:03:09 -0400
301 ikiwiki (1.8) unstable; urgency=low
303 If your wiki is configured with a setup file, you should modify it to
304 stop setting the "plugin" list directly, and instead add or remove plugins
305 via the add_plugins and disable_plugins lines. For example, if you had:
307 plugin => [qw{inline smiley search}],
309 Change it to these lines, which disables the default htmlscrubber plugin
310 and adds the two additional plugins:
312 add_plugins => [qw{smiley search}],
313 disable_plugins => [qw{htmlscrubber}],
315 Making this change makes your ikiwiki setup file more future-proof since
316 new default plugins will be automatically used.
318 You will need to rebuild your ikiwiki wrappers when upgrading to this
319 version. If you listed your wiki in /etc/ikiwiki/wikilist this will be
320 done automatically when the Debian package is upgraded. Or use
321 ikiiki-mass-rebuild --refresh to force a refresh.
323 -- Joey Hess <joeyh@debian.org> Mon, 3 Jul 2006 16:59:29 -0400
325 ikiwiki (1.1) unstable; urgency=low
327 There have been several configuration changes in this release of ikiwiki:
329 The --svn and --no-svn switches are removed, instead you should use
330 --rcs=svn or --no-rcs. ikiwiki setup files that set svn => 1 should
331 be changed to set rcs => "svn"; if your setup file sets svn => 0
332 then change it to use rcs => "" to disable svn.
334 The --hyperestraier switch is gone too. To enable searching, turn on the
335 search plugin, by passing --plugin=search or through the plugin setting in
338 The --sanitize and --no-sanitize switches are also gone, replaced with the
339 htmlscrubber plugin. This plugin is enabled by default, to disable it,
340 use --disable-plugin=htmlscrubber, or modify the plugin setting in the
343 Discussion pages are enabled by default, but if your wiki is configured
344 with a setup file, you need to edit it to keep them enabled on upgrade
345 to this version. Add a line reading:
348 You will need to rebuild your wiki when upgrading to this version.
349 If you listed your wiki in /etc/ikiwiki/wikilist this will be done
350 automatically when the Debian package is upgraded. Or use
351 ikiiki-mass-rebuild to force a rebuild.
353 -- Joey Hess <joeyh@debian.org> Tue, 2 May 2006 14:13:59 -0400