1 ikiwiki (3.20100505) UNRELEASED; urgency=low
3 There is a new "comment()" pagespec, that can be used to match a comment
4 on a page. It is recommended it be used instead of the old
5 method of using a pagespec such as "internal(comment_*)" to match
6 things that looked like comments. The old pagespec will now also match
7 comments that are held for moderation; likely not what you want.
9 There is a significant change to the page.tmpl template in this version.
10 If you have locally modified versions of that template, you will need
11 to update it to contain the following in the HTML <head>:
14 <TMPL_IF FORCEBASEURL><base href="<TMPL_VAR FORCEBASEURL>" /><TMPL_ELSE>
15 <TMPL_IF BASEURL><base href="<TMPL_VAR BASEURL>" /></TMPL_IF>
18 -- Joey Hess <joeyh@debian.org> Wed, 05 May 2010 21:47:08 -0400
20 ikiwiki (3.20100427) unstable; urgency=low
22 This version of ikiwiki has a lot of changes that you need to know about.
24 Now you can include customised versions of templates in the source
25 of your wiki. (For example, templates/page.tmpl.) When these templates
26 are changed, ikiwiki will automatically rebuild pages that use them.
28 Allowing untrusted users to upload attachments with the ".tmpl"
29 extension is not recommended, as that allows anyone to change
32 The --getctime switch is renamed to --gettime, and it also gets the
33 file modification time. And it's a lot faster (when using git). But
34 the really important change is, you don't have to remember to use this
35 switch. Now ikiwiki will do it when it needs to.
37 At last, the "tagged()" pagespec only matches tags, not regular wikilinks.
38 If your wiki accidentially relied on the old, buggy behavior, you might
39 need to change its pagespecs to use "link()".
41 Many of your wishes have been answered: Now tag pages can automatically be
42 created when new tags are used. This feature is enabled by default if you
43 have configured a tagbase. It can be turned on or off using the
44 tag_autocreate setting.
46 These changes may also affect some users:
48 * The title_natural sort method (as used by the inline directive, etc)
49 has been moved to the new sortnaturally plugin, which is not enabled
50 by default since it requires the Sort::Naturally perl module.
52 * The add_templates option has been removed from the underlay plugin.
53 If you used this option, you can instead use templates/ subdirectories
54 inside underlay directories added by the add_underlays option.
56 Due to the above and other changes, all wikis need to be rebuilt on
57 upgrade to this version. If you listed your wiki in /etc/ikiwiki/wikilist
58 this will be done automatically when the Debian package is upgraded. Or
59 use ikiwiki-mass-rebuild to force a rebuild.
61 -- Joey Hess <joeyh@debian.org> Tue, 27 Apr 2010 00:00:00 -0400
63 ikiwiki (3.20091017) unstable; urgency=low
65 To take advantage of significant performance improvements, all
66 wikis need to be rebuilt on upgrade to this version. If you
67 listed your wiki in /etc/ikiwiki/wikilist this will be done
68 automatically when the Debian package is upgraded. Or use
69 ikiwiki-mass-rebuild to force a rebuild.
71 -- Joey Hess <joeyh@debian.org> Mon, 05 Oct 2009 16:48:59 -0400
73 ikiwiki (3.1415926) unstable; urgency=low
75 In order to fix a performance bug, all wikis need to be rebuilt on
76 upgrade to this version. If you listed your wiki in
77 /etc/ikiwiki/wikilist this will be done automatically when the
78 Debian package is upgraded. Or use ikiwiki-mass-rebuild to force
81 -- Joey Hess <joeyh@debian.org> Tue, 25 Aug 2009 17:24:43 -0400
83 ikiwiki (3.13) unstable; urgency=low
85 The `ikiwiki-transition deduplinks` command introduced in the
86 last release was buggy. If you followed the NEWS file instructions
87 and ran it, you should run `ikiwiki -setup` to rebuild your wiki
90 -- Joey Hess <joeyh@debian.org> Fri, 22 May 2009 13:04:02 -0400
92 ikiwiki (3.12) unstable; urgency=low
94 You may want to run `ikiwiki-transition deduplinks your.setup`
95 after upgrading to this version of ikiwiki. This command will
96 optimise your wiki's saved state, removing duplicate information
97 that can slow ikiwiki down.
99 -- Joey Hess <joeyh@debian.org> Wed, 06 May 2009 00:25:06 -0400
101 ikiwiki (3.01) unstable; urgency=low
103 If your wiki uses git, and you have a `diffurl` configured in
104 its setup file, you should be aware that gitweb has stopped
105 supporting the url form commonly used for the `diffurl`.
107 You can change your setup to use the newer gitweb url form:
109 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]]
111 The changes from the old form are the addition of the `hpb` parameter,
112 and the change to the value used for the `hb` parameter.
114 -- Joey Hess <joeyh@debian.org> Mon, 05 Jan 2009 18:18:05 -0500
116 ikiwiki (3.00) unstable; urgency=low
118 The 3.0 release of ikiwiki changes several defaults and finishes
119 some transitions. You will need to modify your wikis to work with
120 ikiwiki 3.0. A document explaining the process is available
121 in </usr/share/doc/ikiwiki/html/tips/upgrade_to_3.0.html>
123 -- Joey Hess <joeyh@debian.org> Tue, 23 Dec 2008 16:14:18 -0500
125 ikiwiki (2.62) unstable; urgency=low
127 TexImg standard preamble changed
129 The teximg plugin now has a configurable LaTeX preamble.
130 As part of this change the `mchem` LaTeX package has been removed from
131 the default LaTeX preamble as it wasn't included in many TeX installations.
133 The previous behaviour can be restored by adding the following to your
136 teximg_prefix => '\documentclass{scrartcl}
137 \usepackage[version=3]{mhchem}
139 \usepackage{amsfonts}
144 In addition, the rendering mechanism has been changed to use `dvipng` by
145 default, if available.
147 -- Joey Hess <joeyh@debian.org> Sun, 24 Aug 2008 15:00:40 -0400
149 ikiwiki (2.60) unstable; urgency=low
151 Admin preferences are moving from the web interface to the setup file.
152 There are three new options in the setup file: `locked_pages`, `banned_users`,
153 and `allowed_attachments`. The admin prefs page can still be used, but
154 that's deprecated, and the prefs will be hidden if a value is not already
155 set. If a value is set in the web interface, you're encouraged to move that
156 setting to your setup file now, since version 3.0 will remove the deprecated
157 admin prefs web interface.
159 Also, the layout of the setup file has changed in a significant way in this
160 release. Old setup files will continue to work, but new features, like the
161 new websetup interface, require a new format setup file. You can convert
162 old setup files into the new format by running
163 `ikiwiki-transition setupformat ikiwiki.setup`
165 -- Joey Hess <joeyh@debian.org> Fri, 01 Aug 2008 17:02:14 -0400
167 ikiwiki (2.52) unstable; urgency=low
169 All wikis need to be rebuilt on upgrade to this version. If you listed your
170 wiki in /etc/ikiwiki/wikilist this will be done automatically when the
171 Debian package is upgraded. Or use ikiwiki-mass-rebuild to force a rebuild.
173 -- Joey Hess <joeyh@debian.org> Sun, 06 Jul 2008 15:10:05 -0400
175 ikiwiki (2.49) unstable; urgency=low
177 The search plugin no longer uses hyperestraier. Instead, to use it you
178 will now need to install xapian-omega, and the Search::Xapian,
179 HTML::Scrubber, and Digest::SHA1 perl modules. Ie,
180 `apt-get install xapian-omega libsearch-xapian-perl libhtml-scrubber-perl libdigest-sha1-perl`
182 Also, wikis that use the search plugin will need to be rebuilt,
183 since the search form has changed. This will not be done automatically,
184 but can be done by running `ikiwiki-mass-upgrade` as root, or
185 running `ikiwiki -setup` on individual setup files.
187 -- Joey Hess <joeyh@debian.org> Wed, 04 Jun 2008 00:29:28 -0400
189 ikiwiki (2.48) unstable; urgency=high
191 If you allowed password based logins to your wiki, those passwords were
192 stored in cleartext in the userdb. To guard against exposing users'
193 passwords, I recommend you install the Authen::Passphrase perl module, and
194 then run `ikiwiki-transition hashpassword /path/to/srcdir` to replace all
195 existing cleartext passwords with strong (blowfish) hashes.
197 -- Joey Hess <joeyh@debian.org> Thu, 29 May 2008 14:39:34 -0400
199 ikiwiki (2.46) unstable; urgency=low
201 There were some significant template changes in ikiwiki 2.42 (and 1.33.5).
202 If you have locally modified versions of the templates, they need to be
203 updated. Most notably, the editpage.tmpl has a new FIELD-SID added to it,
204 without which web editing will fail.
206 -- Joey Hess <joeyh@debian.org> Tue, 06 May 2008 14:30:14 -0400
208 ikiwiki (2.40) unstable; urgency=low
210 ikiwiki now has an new syntax for preprocessor directives, using the
215 This new syntax no longer relies on spaces to distinguish between
216 wikilinks and preprocessor directives. Thus, wikilinks can use spaces
217 in their link text, and preprocessor directives without arguments (such
218 as "toc") need not use a trailing space.
220 To enable the new syntax, set prefix_directives to true in your ikiwiki
221 config. For backward compatibility with existing wikis,
222 prefix_directives currently defaults to false. In ikiwiki 3.0,
223 prefix_directives will default to true, and wikis which have not yet
224 converted to the new syntax will need to set prefix_directives to false
225 in their setup files.
227 To convert your wiki to the new syntax, ikiwiki provides a new script
230 Even with prefix_directives disabled, ikiwiki now allows an optional '!'
231 prefix on preprocessor directives (but still requires a space). Thus, a
232 directive which uses a '!' prefix and contains a space will work with
233 ikiwiki 2.40 and newer, regardless of the value of prefix_directives.
234 This allows the underlay to work with all ikiwikis.
236 -- Josh Triplett <josh@freedesktop.org> Sat, 26 Jan 2008 16:26:47 -0800
238 ikiwiki (2.30) unstable; urgency=low
240 Ever feel that ikiwiki's handling of RecentChanges wasn't truely in the
241 spirit of a wiki compiler? Well, that's changed. The RecentChanges page is
242 now a static page, not a CGI. Users can subscribe to its rss/atom feeds.
243 Custom RecentChanges pages can be easily set up that display only changes
244 to a subset of pages, or only changes by a subset of users.
246 All wikis need to be rebuilt on upgrade to this version. If you listed your
247 wiki in /etc/ikiwiki/wikilist this will be done automatically when the
248 Debian package is upgraded. Or use ikiwiki-mass-rebuild to force a rebuild.
250 With this excellent new RecentChanges support, the mail notification system
251 is its age (and known to be variously buggy and underimplemented for
252 various VCSes), and so ikiwiki's support for sending commit mails is REMOVED
253 from this version. If you were subscribed to commit mails, you should be
254 able to accomplish the same thing by subscribing to a RecentChanges feed.
256 The "notify" field in setup files is no longer used, and
257 silently ignored. You may want to remove it from your setup file.
259 -- Joey Hess <joeyh@debian.org> Tue, 29 Jan 2008 17:18:31 -0500
261 ikiwiki (2.20) unstable; urgency=low
263 The template plugin has begin to htmlize the variables passed to templates.
264 This is normally what you want, but to get the old behavior and get at the
265 raw value, you can use `<TMPL_VAR raw_variable>` in a template.
267 -- Joey Hess <joeyh@debian.org> Sat, 08 Dec 2007 16:04:43 -0500
269 ikiwiki (2.16) unstable; urgency=low
271 Many of the pages in ikiwiki's basewiki have been moved and renamed in this
272 release, to avoid the basewiki including pages with names like "blog".
273 Redirection pages have been left behind for these moved pages temporarily,
274 and will be removed later.
276 If you use the calendar plugin, ikiwiki is now smarter and your nightly
277 cron job to update the wiki doesn't need to rebuild everything. Just pass
278 --refresh to ikiwiki in the cron job and it will update only pages that
279 contain out of date calendars.
281 -- Joey Hess <joeyh@debian.org> Sat, 08 Dec 2007 16:04:43 -0500
283 ikiwiki (2.14) unstable; urgency=low
285 This version of ikiwiki is more picky about symlinks in the path leading
286 to the srcdir, and will refuse to use a srcdir specified by such a path.
287 This was necessary to avoid some potential exploits, but could potentially
288 break (semi-)working wikis. If your wiki has a srcdir path containing a
289 symlink, you should change it to use a path that does not.
291 -- Joey Hess <joeyh@debian.org> Mon, 26 Nov 2007 14:57:57 -0500
293 ikiwiki (2.9) unstable; urgency=low
295 Since ikiwiki 2.0 was released, some limitiations have been added to what
296 ikiwiki considers a WikiLink. In short, if there are any spaces in between
297 the brackets, ikiwiki no longer considers it to be a WikiLink. If your wiki
298 contains things meant to be WikiLinks that contain spaces, you will need to
299 fix them, by replacing the spaces with underscores.
301 WikiLink have always been documented to not contain spaces, but bugs in
302 ikiwiki made it treat some text with spaces as WikiLinks. Most of these
303 bugs were fixed in version 2.2, and a final bug was fixed in this 2.9
304 release. These fixes are necessary to avoid ambiguity between
305 WikiLinks and PreProcessorDirectives. Apologies for any inconvenience
306 these bugs (and their fixes) may have caused.
308 -- Joey Hess <joeyh@debian.org> Sat, 29 Sep 2007 14:37:18 -0400
310 ikiwiki (2.6) unstable; urgency=low
312 In this version the rst plugin allows raw html to be embedded in rst files.
313 As long as the htmlscrubber is enabled, this should be safe. If you are
314 using the rst plugin without the htmlscrubber in a publically writable wiki,
315 you should turn on the htmlscrubber.
317 -- Joey Hess <joeyh@debian.org> Sun, 29 Jul 2007 18:37:22 -0400
319 ikiwiki (2.5) unstable; urgency=low
321 Due to some config changes in this version, wrappers need to be rebuilt on
322 upgrade. If you listed your wiki in /etc/ikiwiki/wikilist this will be
323 one automatically when the Debian package is upgraded.
325 -- Joey Hess <joeyh@debian.org> Sun, 29 Jul 2007 17:54:40 -0400
327 ikiwiki (2.1) unstable; urgency=low
329 Some wikis need to be rebuilt on upgrade to this version, due to changes to
330 page templates and the style sheet. If you listed your wiki in
331 /etc/ikiwiki/wikilist this will be done automatically when the Debian
332 package is upgraded. Or use ikiwiki-mass-rebuild to force a rebuild.
334 -- Joey Hess <joeyh@debian.org> Thu, 26 Apr 2007 15:50:36 -0400
336 ikiwiki (2.00) unstable; urgency=low
338 With the 2.0 release of ikiwiki, some major changes have been made to the
339 default configuration:
341 * The 'usedirs' setting is enabled by default. This *will* break all URLs
342 to wikis that did not have 'usedirs' turned on before, unless you follow
343 the procedure described at <http://ikiwiki.info/tips/switching_to_usedirs>,
344 or edit your setup file to turn usedirs off:
347 * OpenID logins are now enabled by default, if the Net::OpenID::Consumer
348 perl module is available. Password logins are also still enabled
349 by default. If you like, you can turn either OpenID or password logins
350 off via the 'disable_plugins' setting.
352 -- Joey Hess <joeyh@debian.org> Sun, 29 Apr 2007 19:00:43 -0400
354 ikiwiki (1.51) unstable; urgency=low
356 Some wikis need to be rebuilt on upgrade to this version, due to changes to
357 page layout and the style sheet. If you listed your wiki in
358 /etc/ikiwiki/wikilist this will be done automatically when the Debian
359 package is upgraded. Or use ikiwiki-mass-rebuild to force a rebuild.
361 -- Joey Hess <joeyh@debian.org> Thu, 26 Apr 2007 15:50:36 -0400
363 ikiwiki (1.50) unstable; urgency=low
365 Permalinks and guids in rss and atom feeds for wikis using the usedirs
366 options will change in this release. If you have already enabled usedirs,
367 you may need to take steps to avoid flooding aggregators.
369 -- Joey Hess <joeyh@debian.org> Sat, 14 Apr 2007 16:08:46 -0400
371 ikiwiki (1.49) unstable; urgency=low
373 Third-party plugins that use htmlpage() or abs2rel() to generate links
374 may need changes to support the new "usedirs" option.
376 -- Joey Hess <joeyh@debian.org> Sun, 01 Apr 2007 16:20:09 -0400
378 ikiwiki (1.47) unstable; urgency=low
380 Due to a security fix, wikis that have the htmlscrubber enabled can no
381 longer use the meta plugin to insert html link and meta tags.
383 Some special case methods have been added for safely including stylesheets,
384 and for doing openid delegation. See the meta plugin docs for details.
386 -- Joey Hess <joeyh@debian.org> Wed, 21 Mar 2007 14:18:40 -0400
388 ikiwiki (1.45) unstable; urgency=low
390 Wikis need to be rebuilt on upgrade to this version. If you listed your wiki
391 in /etc/ikiwiki/wikilist this will be done automatically when the Debian
392 package is upgraded. Or use ikiwiki-mass-rebuild to force a rebuild.
394 -- Joey Hess <joeyh@debian.org> Wed, 7 Mar 2007 23:02:52 -0500
396 ikiwiki (1.44) unstable; urgency=low
398 The htmllink() function has changed slightly and plugins that use it may
399 need to change how they call it. This function's first three parameters
400 are unchanged, but additional options are now passed using named
401 parameters. If you used htmllink with more than 3 parameters, you will
402 need to change it. The plugin interface version has been increased to 1.02
403 to reflect this change.
405 -- Joey Hess <joeyh@debian.org> Mon, 19 Feb 2007 21:10:12 -0500
407 ikiwiki (1.42) unstable; urgency=low
409 The anonok setting in config files has been removed. To enable
410 httpauth support on your wiki, you should now enable the anonok plugin,
413 Third-party plugins that use pagespec_match() should be updated to pass
414 the new third parameter (from) to that function. This is needed for the
415 new relative glob matching to work.
417 -- Joey Hess <joeyh@debian.org> Thu, 1 Feb 2007 16:57:59 -0500
419 ikiwiki (1.34) unstable; urgency=low
421 The httpauth setting in config files has been removed. To enable
422 httpauth support on your wiki, you should now enable the httpauth plugin,
425 This release includes OpenID support that is enabled through the openid
426 plugin. I recommend turning this on to make it easier for users to sign
429 -- Joey Hess <joeyh@debian.org> Sun, 19 Nov 2006 20:53:05 -0500
431 ikiwiki (1.32) unstable; urgency=low
433 There is a change to the plugin interface in this version. Any plugins that
434 modify data in %links should pass scan => 1 when registering the hook that
437 -- Joey Hess <joeyh@debian.org> Sat, 28 Oct 2006 00:13:12 -0400
439 ikiwiki (1.29) unstable; urgency=low
441 Wikis need to be rebuilt on upgrade to this version. If you listed your wiki
442 in /etc/ikiwiki/wikilist this will be done automatically when the Debian
443 package is upgraded. Or use ikiwiki-mass-rebuild to force a rebuild.
445 There is a change to the plugin interface in this version. Plugins that use
446 %renderedfiles will need to be updated, as the hash's values are now arrays
447 of rendered files. Plugins that cause a page to render additional files
448 should use the new will_render function to register the files.
450 -- Joey Hess <joeyh@debian.org> Sun, 8 Oct 2006 17:27:56 -0400
452 ikiwiki (1.22) unstable; urgency=low
454 Due to some changes in the CSS, wikis should be rebuilt on upgrade to this
455 version. If you listed your wiki in /etc/ikiwiki/wikilist this will be done
456 automatically when the Debian package is upgraded. Or use ikiwiki-mass-rebuild
459 If you have modified versions of ikiwiki's html templates, you will need
460 to update your templates to link to the stylesheet file using
461 "<TMPL_VAR BASEURL>style.css" instead of the old method which used
464 There have also been some changes to the plugin interface:
465 Any plugins that use santize, htmlize, or format hooks will need to be
466 updated for this version of ikiwiki since these hooks have been changed
467 to use named parameters.
469 -- Joey Hess <joeyh@debian.org> Tue, 22 Aug 2006 15:33:12 -0400
471 ikiwiki (1.13) unstable; urgency=low
473 The GlobList format which was used for specifiying sets of pages, has been
474 replaced with a new, more expressive PageSpec format. While GlobLists will
475 continue to work, that format is deprecated, and you are encouraged to use
476 PageSpecs from now on, and also to change any GlobLists in your wiki to
477 PageSpecs. See the new PageSpec page for details.
479 You will need to rebuild your wiki when upgrading to this version. If you
480 listed your wiki in /etc/ikiwiki/wikilist this will be done automatically
481 when the Debian package is upgraded. Or use ikiiki-mass-rebuild to force a
484 -- Joey Hess <joeyh@debian.org> Tue, 1 Aug 2006 18:29:51 -0400
486 ikiwiki (1.11) unstable; urgency=low
488 Some changes to tags in this release, due to a new tag plugin. If you have
489 been using the meta plugin to tag pages, you'll want to enable the tag
490 plugin too, and change things like this:
492 [[meta link="foobar"]]
498 The new tags will appear at page footers, and are also easier to type.
500 There have also been some changes to the plugin interface, particularly the
501 interface of pagetemplate hooks has changed. See the changelog for details.
503 -- Joey Hess <joeyh@debian.org> Thu, 27 Jul 2006 17:03:09 -0400
505 ikiwiki (1.8) unstable; urgency=low
507 If your wiki is configured with a setup file, you should modify it to
508 stop setting the "plugin" list directly, and instead add or remove plugins
509 via the add_plugins and disable_plugins lines. For example, if you had:
511 plugin => [qw{inline smiley search}],
513 Change it to these lines, which disables the default htmlscrubber plugin
514 and adds the two additional plugins:
516 add_plugins => [qw{smiley search}],
517 disable_plugins => [qw{htmlscrubber}],
519 Making this change makes your ikiwiki setup file more future-proof since
520 new default plugins will be automatically used.
522 You will need to rebuild your ikiwiki wrappers when upgrading to this
523 version. If you listed your wiki in /etc/ikiwiki/wikilist this will be
524 done automatically when the Debian package is upgraded. Or use
525 ikiiki-mass-rebuild --refresh to force a refresh.
527 -- Joey Hess <joeyh@debian.org> Mon, 3 Jul 2006 16:59:29 -0400
529 ikiwiki (1.1) unstable; urgency=low
531 There have been several configuration changes in this release of ikiwiki:
533 The --svn and --no-svn switches are removed, instead you should use
534 --rcs=svn or --no-rcs. ikiwiki setup files that set svn => 1 should
535 be changed to set rcs => "svn"; if your setup file sets svn => 0
536 then change it to use rcs => "" to disable svn.
538 The --hyperestraier switch is gone too. To enable searching, turn on the
539 search plugin, by passing --plugin=search or through the plugin setting in
542 The --sanitize and --no-sanitize switches are also gone, replaced with the
543 htmlscrubber plugin. This plugin is enabled by default, to disable it,
544 use --disable-plugin=htmlscrubber, or modify the plugin setting in the
547 Discussion pages are enabled by default, but if your wiki is configured
548 with a setup file, you need to edit it to keep them enabled on upgrade
549 to this version. Add a line reading:
552 You will need to rebuild your wiki when upgrading to this version.
553 If you listed your wiki in /etc/ikiwiki/wikilist this will be done
554 automatically when the Debian package is upgraded. Or use
555 ikiiki-mass-rebuild to force a rebuild.
557 -- Joey Hess <joeyh@debian.org> Tue, 2 May 2006 14:13:59 -0400