1 ikiwiki (3.20100406) unstable; urgency=low
3 The title_natural sort method (as used by the inline directive, etc)
4 have been moved to the new sortnaturally plugin, which is not enabled
5 by default since it requires the Sort::Naturally perl module.
7 Starting from this version, the `tagged()` pagespec only matches tags,
8 not regular wikilinks. If your wiki accidentially relied on the old,
9 buggy behavior, you might need to change pagespecs to use `link()`.
11 To support the above change, all wikis need to be rebuilt on upgrade to
12 this version. If you listed your wiki in /etc/ikiwiki/wikilist this will
13 be done automatically when the Debian package is upgraded. Or use
14 ikiwiki-mass-rebuild to force a rebuild.
16 -- Simon McVittie <smcv@debian.org> Tue, 06 Apr 2010 20:53:07 +0100
18 ikiwiki (3.20091017) unstable; urgency=low
20 To take advantage of significant performance improvements, all
21 wikis need to be rebuilt on upgrade to this version. If you
22 listed your wiki in /etc/ikiwiki/wikilist this will be done
23 automatically when the Debian package is upgraded. Or use
24 ikiwiki-mass-rebuild to force a rebuild.
26 -- Joey Hess <joeyh@debian.org> Mon, 05 Oct 2009 16:48:59 -0400
28 ikiwiki (3.1415926) unstable; urgency=low
30 In order to fix a performance bug, all wikis need to be rebuilt on
31 upgrade to this version. If you listed your wiki in
32 /etc/ikiwiki/wikilist this will be done automatically when the
33 Debian package is upgraded. Or use ikiwiki-mass-rebuild to force
36 -- Joey Hess <joeyh@debian.org> Tue, 25 Aug 2009 17:24:43 -0400
38 ikiwiki (3.13) unstable; urgency=low
40 The `ikiwiki-transition deduplinks` command introduced in the
41 last release was buggy. If you followed the NEWS file instructions
42 and ran it, you should run `ikiwiki -setup` to rebuild your wiki
45 -- Joey Hess <joeyh@debian.org> Fri, 22 May 2009 13:04:02 -0400
47 ikiwiki (3.12) unstable; urgency=low
49 You may want to run `ikiwiki-transition deduplinks your.setup`
50 after upgrading to this version of ikiwiki. This command will
51 optimise your wiki's saved state, removing duplicate information
52 that can slow ikiwiki down.
54 -- Joey Hess <joeyh@debian.org> Wed, 06 May 2009 00:25:06 -0400
56 ikiwiki (3.01) unstable; urgency=low
58 If your wiki uses git, and you have a `diffurl` configured in
59 its setup file, you should be aware that gitweb has stopped
60 supporting the url form commonly used for the `diffurl`.
62 You can change your setup to use the newer gitweb url form:
64 http://git.example.com/gitweb.cgi?p=wiki.git;a=blobdiff;f=[[file]];h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_commit]];hpb=[[sha1_parent]]
66 The changes from the old form are the addition of the `hpb` parameter,
67 and the change to the value used for the `hb` parameter.
69 -- Joey Hess <joeyh@debian.org> Mon, 05 Jan 2009 18:18:05 -0500
71 ikiwiki (3.00) unstable; urgency=low
73 The 3.0 release of ikiwiki changes several defaults and finishes
74 some transitions. You will need to modify your wikis to work with
75 ikiwiki 3.0. A document explaining the process is available
76 in </usr/share/doc/ikiwiki/html/tips/upgrade_to_3.0.html>
78 -- Joey Hess <joeyh@debian.org> Tue, 23 Dec 2008 16:14:18 -0500
80 ikiwiki (2.62) unstable; urgency=low
82 TexImg standard preamble changed
84 The teximg plugin now has a configurable LaTeX preamble.
85 As part of this change the `mchem` LaTeX package has been removed from
86 the default LaTeX preamble as it wasn't included in many TeX installations.
88 The previous behaviour can be restored by adding the following to your
91 teximg_prefix => '\documentclass{scrartcl}
92 \usepackage[version=3]{mhchem}
99 In addition, the rendering mechanism has been changed to use `dvipng` by
100 default, if available.
102 -- Joey Hess <joeyh@debian.org> Sun, 24 Aug 2008 15:00:40 -0400
104 ikiwiki (2.60) unstable; urgency=low
106 Admin preferences are moving from the web interface to the setup file.
107 There are three new options in the setup file: `locked_pages`, `banned_users`,
108 and `allowed_attachments`. The admin prefs page can still be used, but
109 that's deprecated, and the prefs will be hidden if a value is not already
110 set. If a value is set in the web interface, you're encouraged to move that
111 setting to your setup file now, since version 3.0 will remove the deprecated
112 admin prefs web interface.
114 Also, the layout of the setup file has changed in a significant way in this
115 release. Old setup files will continue to work, but new features, like the
116 new websetup interface, require a new format setup file. You can convert
117 old setup files into the new format by running
118 `ikiwiki-transition setupformat ikiwiki.setup`
120 -- Joey Hess <joeyh@debian.org> Fri, 01 Aug 2008 17:02:14 -0400
122 ikiwiki (2.52) unstable; urgency=low
124 All wikis need to be rebuilt on upgrade to this version. If you listed your
125 wiki in /etc/ikiwiki/wikilist this will be done automatically when the
126 Debian package is upgraded. Or use ikiwiki-mass-rebuild to force a rebuild.
128 -- Joey Hess <joeyh@debian.org> Sun, 06 Jul 2008 15:10:05 -0400
130 ikiwiki (2.49) unstable; urgency=low
132 The search plugin no longer uses hyperestraier. Instead, to use it you
133 will now need to install xapian-omega, and the Search::Xapian,
134 HTML::Scrubber, and Digest::SHA1 perl modules. Ie,
135 `apt-get install xapian-omega libsearch-xapian-perl libhtml-scrubber-perl libdigest-sha1-perl`
137 Also, wikis that use the search plugin will need to be rebuilt,
138 since the search form has changed. This will not be done automatically,
139 but can be done by running `ikiwiki-mass-upgrade` as root, or
140 running `ikiwiki -setup` on individual setup files.
142 -- Joey Hess <joeyh@debian.org> Wed, 04 Jun 2008 00:29:28 -0400
144 ikiwiki (2.48) unstable; urgency=high
146 If you allowed password based logins to your wiki, those passwords were
147 stored in cleartext in the userdb. To guard against exposing users'
148 passwords, I recommend you install the Authen::Passphrase perl module, and
149 then run `ikiwiki-transition hashpassword /path/to/srcdir` to replace all
150 existing cleartext passwords with strong (blowfish) hashes.
152 -- Joey Hess <joeyh@debian.org> Thu, 29 May 2008 14:39:34 -0400
154 ikiwiki (2.46) unstable; urgency=low
156 There were some significant template changes in ikiwiki 2.42 (and 1.33.5).
157 If you have locally modified versions of the templates, they need to be
158 updated. Most notably, the editpage.tmpl has a new FIELD-SID added to it,
159 without which web editing will fail.
161 -- Joey Hess <joeyh@debian.org> Tue, 06 May 2008 14:30:14 -0400
163 ikiwiki (2.40) unstable; urgency=low
165 ikiwiki now has an new syntax for preprocessor directives, using the
170 This new syntax no longer relies on spaces to distinguish between
171 wikilinks and preprocessor directives. Thus, wikilinks can use spaces
172 in their link text, and preprocessor directives without arguments (such
173 as "toc") need not use a trailing space.
175 To enable the new syntax, set prefix_directives to true in your ikiwiki
176 config. For backward compatibility with existing wikis,
177 prefix_directives currently defaults to false. In ikiwiki 3.0,
178 prefix_directives will default to true, and wikis which have not yet
179 converted to the new syntax will need to set prefix_directives to false
180 in their setup files.
182 To convert your wiki to the new syntax, ikiwiki provides a new script
185 Even with prefix_directives disabled, ikiwiki now allows an optional '!'
186 prefix on preprocessor directives (but still requires a space). Thus, a
187 directive which uses a '!' prefix and contains a space will work with
188 ikiwiki 2.40 and newer, regardless of the value of prefix_directives.
189 This allows the underlay to work with all ikiwikis.
191 -- Josh Triplett <josh@freedesktop.org> Sat, 26 Jan 2008 16:26:47 -0800
193 ikiwiki (2.30) unstable; urgency=low
195 Ever feel that ikiwiki's handling of RecentChanges wasn't truely in the
196 spirit of a wiki compiler? Well, that's changed. The RecentChanges page is
197 now a static page, not a CGI. Users can subscribe to its rss/atom feeds.
198 Custom RecentChanges pages can be easily set up that display only changes
199 to a subset of pages, or only changes by a subset of users.
201 All wikis need to be rebuilt on upgrade to this version. If you listed your
202 wiki in /etc/ikiwiki/wikilist this will be done automatically when the
203 Debian package is upgraded. Or use ikiwiki-mass-rebuild to force a rebuild.
205 With this excellent new RecentChanges support, the mail notification system
206 is its age (and known to be variously buggy and underimplemented for
207 various VCSes), and so ikiwiki's support for sending commit mails is REMOVED
208 from this version. If you were subscribed to commit mails, you should be
209 able to accomplish the same thing by subscribing to a RecentChanges feed.
211 The "notify" field in setup files is no longer used, and
212 silently ignored. You may want to remove it from your setup file.
214 -- Joey Hess <joeyh@debian.org> Tue, 29 Jan 2008 17:18:31 -0500
216 ikiwiki (2.20) unstable; urgency=low
218 The template plugin has begin to htmlize the variables passed to templates.
219 This is normally what you want, but to get the old behavior and get at the
220 raw value, you can use `<TMPL_VAR raw_variable>` in a template.
222 -- Joey Hess <joeyh@debian.org> Sat, 08 Dec 2007 16:04:43 -0500
224 ikiwiki (2.16) unstable; urgency=low
226 Many of the pages in ikiwiki's basewiki have been moved and renamed in this
227 release, to avoid the basewiki including pages with names like "blog".
228 Redirection pages have been left behind for these moved pages temporarily,
229 and will be removed later.
231 If you use the calendar plugin, ikiwiki is now smarter and your nightly
232 cron job to update the wiki doesn't need to rebuild everything. Just pass
233 --refresh to ikiwiki in the cron job and it will update only pages that
234 contain out of date calendars.
236 -- Joey Hess <joeyh@debian.org> Sat, 08 Dec 2007 16:04:43 -0500
238 ikiwiki (2.14) unstable; urgency=low
240 This version of ikiwiki is more picky about symlinks in the path leading
241 to the srcdir, and will refuse to use a srcdir specified by such a path.
242 This was necessary to avoid some potential exploits, but could potentially
243 break (semi-)working wikis. If your wiki has a srcdir path containing a
244 symlink, you should change it to use a path that does not.
246 -- Joey Hess <joeyh@debian.org> Mon, 26 Nov 2007 14:57:57 -0500
248 ikiwiki (2.9) unstable; urgency=low
250 Since ikiwiki 2.0 was released, some limitiations have been added to what
251 ikiwiki considers a WikiLink. In short, if there are any spaces in between
252 the brackets, ikiwiki no longer considers it to be a WikiLink. If your wiki
253 contains things meant to be WikiLinks that contain spaces, you will need to
254 fix them, by replacing the spaces with underscores.
256 WikiLink have always been documented to not contain spaces, but bugs in
257 ikiwiki made it treat some text with spaces as WikiLinks. Most of these
258 bugs were fixed in version 2.2, and a final bug was fixed in this 2.9
259 release. These fixes are necessary to avoid ambiguity between
260 WikiLinks and PreProcessorDirectives. Apologies for any inconvenience
261 these bugs (and their fixes) may have caused.
263 -- Joey Hess <joeyh@debian.org> Sat, 29 Sep 2007 14:37:18 -0400
265 ikiwiki (2.6) unstable; urgency=low
267 In this version the rst plugin allows raw html to be embedded in rst files.
268 As long as the htmlscrubber is enabled, this should be safe. If you are
269 using the rst plugin without the htmlscrubber in a publically writable wiki,
270 you should turn on the htmlscrubber.
272 -- Joey Hess <joeyh@debian.org> Sun, 29 Jul 2007 18:37:22 -0400
274 ikiwiki (2.5) unstable; urgency=low
276 Due to some config changes in this version, wrappers need to be rebuilt on
277 upgrade. If you listed your wiki in /etc/ikiwiki/wikilist this will be
278 one automatically when the Debian package is upgraded.
280 -- Joey Hess <joeyh@debian.org> Sun, 29 Jul 2007 17:54:40 -0400
282 ikiwiki (2.1) unstable; urgency=low
284 Some wikis need to be rebuilt on upgrade to this version, due to changes to
285 page templates and the style sheet. If you listed your wiki in
286 /etc/ikiwiki/wikilist this will be done automatically when the Debian
287 package is upgraded. Or use ikiwiki-mass-rebuild to force a rebuild.
289 -- Joey Hess <joeyh@debian.org> Thu, 26 Apr 2007 15:50:36 -0400
291 ikiwiki (2.00) unstable; urgency=low
293 With the 2.0 release of ikiwiki, some major changes have been made to the
294 default configuration:
296 * The 'usedirs' setting is enabled by default. This *will* break all URLs
297 to wikis that did not have 'usedirs' turned on before, unless you follow
298 the procedure described at <http://ikiwiki.info/tips/switching_to_usedirs>,
299 or edit your setup file to turn usedirs off:
302 * OpenID logins are now enabled by default, if the Net::OpenID::Consumer
303 perl module is available. Password logins are also still enabled
304 by default. If you like, you can turn either OpenID or password logins
305 off via the 'disable_plugins' setting.
307 -- Joey Hess <joeyh@debian.org> Sun, 29 Apr 2007 19:00:43 -0400
309 ikiwiki (1.51) unstable; urgency=low
311 Some wikis need to be rebuilt on upgrade to this version, due to changes to
312 page layout and the style sheet. If you listed your wiki in
313 /etc/ikiwiki/wikilist this will be done automatically when the Debian
314 package is upgraded. Or use ikiwiki-mass-rebuild to force a rebuild.
316 -- Joey Hess <joeyh@debian.org> Thu, 26 Apr 2007 15:50:36 -0400
318 ikiwiki (1.50) unstable; urgency=low
320 Permalinks and guids in rss and atom feeds for wikis using the usedirs
321 options will change in this release. If you have already enabled usedirs,
322 you may need to take steps to avoid flooding aggregators.
324 -- Joey Hess <joeyh@debian.org> Sat, 14 Apr 2007 16:08:46 -0400
326 ikiwiki (1.49) unstable; urgency=low
328 Third-party plugins that use htmlpage() or abs2rel() to generate links
329 may need changes to support the new "usedirs" option.
331 -- Joey Hess <joeyh@debian.org> Sun, 01 Apr 2007 16:20:09 -0400
333 ikiwiki (1.47) unstable; urgency=low
335 Due to a security fix, wikis that have the htmlscrubber enabled can no
336 longer use the meta plugin to insert html link and meta tags.
338 Some special case methods have been added for safely including stylesheets,
339 and for doing openid delegation. See the meta plugin docs for details.
341 -- Joey Hess <joeyh@debian.org> Wed, 21 Mar 2007 14:18:40 -0400
343 ikiwiki (1.45) unstable; urgency=low
345 Wikis need to be rebuilt on upgrade to this version. If you listed your wiki
346 in /etc/ikiwiki/wikilist this will be done automatically when the Debian
347 package is upgraded. Or use ikiwiki-mass-rebuild to force a rebuild.
349 -- Joey Hess <joeyh@debian.org> Wed, 7 Mar 2007 23:02:52 -0500
351 ikiwiki (1.44) unstable; urgency=low
353 The htmllink() function has changed slightly and plugins that use it may
354 need to change how they call it. This function's first three parameters
355 are unchanged, but additional options are now passed using named
356 parameters. If you used htmllink with more than 3 parameters, you will
357 need to change it. The plugin interface version has been increased to 1.02
358 to reflect this change.
360 -- Joey Hess <joeyh@debian.org> Mon, 19 Feb 2007 21:10:12 -0500
362 ikiwiki (1.42) unstable; urgency=low
364 The anonok setting in config files has been removed. To enable
365 httpauth support on your wiki, you should now enable the anonok plugin,
368 Third-party plugins that use pagespec_match() should be updated to pass
369 the new third parameter (from) to that function. This is needed for the
370 new relative glob matching to work.
372 -- Joey Hess <joeyh@debian.org> Thu, 1 Feb 2007 16:57:59 -0500
374 ikiwiki (1.34) unstable; urgency=low
376 The httpauth setting in config files has been removed. To enable
377 httpauth support on your wiki, you should now enable the httpauth plugin,
380 This release includes OpenID support that is enabled through the openid
381 plugin. I recommend turning this on to make it easier for users to sign
384 -- Joey Hess <joeyh@debian.org> Sun, 19 Nov 2006 20:53:05 -0500
386 ikiwiki (1.32) unstable; urgency=low
388 There is a change to the plugin interface in this version. Any plugins that
389 modify data in %links should pass scan => 1 when registering the hook that
392 -- Joey Hess <joeyh@debian.org> Sat, 28 Oct 2006 00:13:12 -0400
394 ikiwiki (1.29) unstable; urgency=low
396 Wikis need to be rebuilt on upgrade to this version. If you listed your wiki
397 in /etc/ikiwiki/wikilist this will be done automatically when the Debian
398 package is upgraded. Or use ikiwiki-mass-rebuild to force a rebuild.
400 There is a change to the plugin interface in this version. Plugins that use
401 %renderedfiles will need to be updated, as the hash's values are now arrays
402 of rendered files. Plugins that cause a page to render additional files
403 should use the new will_render function to register the files.
405 -- Joey Hess <joeyh@debian.org> Sun, 8 Oct 2006 17:27:56 -0400
407 ikiwiki (1.22) unstable; urgency=low
409 Due to some changes in the CSS, wikis should be rebuilt on upgrade to this
410 version. If you listed your wiki in /etc/ikiwiki/wikilist this will be done
411 automatically when the Debian package is upgraded. Or use ikiwiki-mass-rebuild
414 If you have modified versions of ikiwiki's html templates, you will need
415 to update your templates to link to the stylesheet file using
416 "<TMPL_VAR BASEURL>style.css" instead of the old method which used
419 There have also been some changes to the plugin interface:
420 Any plugins that use santize, htmlize, or format hooks will need to be
421 updated for this version of ikiwiki since these hooks have been changed
422 to use named parameters.
424 -- Joey Hess <joeyh@debian.org> Tue, 22 Aug 2006 15:33:12 -0400
426 ikiwiki (1.13) unstable; urgency=low
428 The GlobList format which was used for specifiying sets of pages, has been
429 replaced with a new, more expressive PageSpec format. While GlobLists will
430 continue to work, that format is deprecated, and you are encouraged to use
431 PageSpecs from now on, and also to change any GlobLists in your wiki to
432 PageSpecs. See the new PageSpec page for details.
434 You will need to rebuild your wiki when upgrading to this version. If you
435 listed your wiki in /etc/ikiwiki/wikilist this will be done automatically
436 when the Debian package is upgraded. Or use ikiiki-mass-rebuild to force a
439 -- Joey Hess <joeyh@debian.org> Tue, 1 Aug 2006 18:29:51 -0400
441 ikiwiki (1.11) unstable; urgency=low
443 Some changes to tags in this release, due to a new tag plugin. If you have
444 been using the meta plugin to tag pages, you'll want to enable the tag
445 plugin too, and change things like this:
447 [[meta link="foobar"]]
453 The new tags will appear at page footers, and are also easier to type.
455 There have also been some changes to the plugin interface, particularly the
456 interface of pagetemplate hooks has changed. See the changelog for details.
458 -- Joey Hess <joeyh@debian.org> Thu, 27 Jul 2006 17:03:09 -0400
460 ikiwiki (1.8) unstable; urgency=low
462 If your wiki is configured with a setup file, you should modify it to
463 stop setting the "plugin" list directly, and instead add or remove plugins
464 via the add_plugins and disable_plugins lines. For example, if you had:
466 plugin => [qw{inline smiley search}],
468 Change it to these lines, which disables the default htmlscrubber plugin
469 and adds the two additional plugins:
471 add_plugins => [qw{smiley search}],
472 disable_plugins => [qw{htmlscrubber}],
474 Making this change makes your ikiwiki setup file more future-proof since
475 new default plugins will be automatically used.
477 You will need to rebuild your ikiwiki wrappers when upgrading to this
478 version. If you listed your wiki in /etc/ikiwiki/wikilist this will be
479 done automatically when the Debian package is upgraded. Or use
480 ikiiki-mass-rebuild --refresh to force a refresh.
482 -- Joey Hess <joeyh@debian.org> Mon, 3 Jul 2006 16:59:29 -0400
484 ikiwiki (1.1) unstable; urgency=low
486 There have been several configuration changes in this release of ikiwiki:
488 The --svn and --no-svn switches are removed, instead you should use
489 --rcs=svn or --no-rcs. ikiwiki setup files that set svn => 1 should
490 be changed to set rcs => "svn"; if your setup file sets svn => 0
491 then change it to use rcs => "" to disable svn.
493 The --hyperestraier switch is gone too. To enable searching, turn on the
494 search plugin, by passing --plugin=search or through the plugin setting in
497 The --sanitize and --no-sanitize switches are also gone, replaced with the
498 htmlscrubber plugin. This plugin is enabled by default, to disable it,
499 use --disable-plugin=htmlscrubber, or modify the plugin setting in the
502 Discussion pages are enabled by default, but if your wiki is configured
503 with a setup file, you need to edit it to keep them enabled on upgrade
504 to this version. Add a line reading:
507 You will need to rebuild your wiki when upgrading to this version.
508 If you listed your wiki in /etc/ikiwiki/wikilist this will be done
509 automatically when the Debian package is upgraded. Or use
510 ikiiki-mass-rebuild to force a rebuild.
512 -- Joey Hess <joeyh@debian.org> Tue, 2 May 2006 14:13:59 -0400