1 ikiwiki (3.20100422) unstable; urgency=low
3 This version of ikiwiki has a lot of changes that you need to know about.
5 Now you can include customised versions of templates in the source
6 of your wiki. (For example, templates/page.tmpl.) When these templates
7 are changed, ikiwiki will automatically rebuild pages that use them.
9 Allowing untrusted users to upload attachments with the ".tmpl"
10 extension is not recommended, as that allows anyone to change
13 The --getctime switch is renamed to --gettimes, and it also gets the
14 file modification time. And it's a lot faster (when using git). But
15 the really important change is, you don't have to remember to use this
16 switch. Now ikiwiki will do it when it needs to.
18 At last, the "tagged()" pagespec only matches tags, not regular wikilinks.
19 If your wiki accidentially relied on the old, buggy behavior, you might
20 need to change its pagespecs to use "link()".
22 Many of your wishes have been answered: Now tag pages can automatically be
23 created when new tags are used. This feature is enabled by default if you
24 have configured a tagbase. It can be turned on or off using the
25 tag_autocreate setting.
27 These changes may also affect some users:
29 * The title_natural sort method (as used by the inline directive, etc)
30 has been moved to the new sortnaturally plugin, which is not enabled
31 by default since it requires the Sort::Naturally perl module.
33 * TMPL_INCLUDE is no longer supported in any template used by ikiwiki.
34 It used to be allowed in certian templates, but not in others.
36 * The add_templates option has been removed from the underlay plugin.
37 If you used this option, you can instead use templates/ subdirectories
38 inside underlay directories added by the add_underlays option.
40 Due to the above and other changes, all wikis need to be rebuilt on
41 upgrade to this version. If you listed your wiki in /etc/ikiwiki/wikilist
42 this will be done automatically when the Debian package is upgraded. Or
43 use ikiwiki-mass-rebuild to force a rebuild.
45 -- Joey Hess <joeyh@debian.org> Wed, 21 Apr 2010 20:31:29 -0400
47 ikiwiki (3.20091017) unstable; urgency=low
49 To take advantage of significant performance improvements, all
50 wikis need to be rebuilt on upgrade to this version. If you
51 listed your wiki in /etc/ikiwiki/wikilist this will be done
52 automatically when the Debian package is upgraded. Or use
53 ikiwiki-mass-rebuild to force a rebuild.
55 -- Joey Hess <joeyh@debian.org> Mon, 05 Oct 2009 16:48:59 -0400
57 ikiwiki (3.1415926) unstable; urgency=low
59 In order to fix a performance bug, all wikis need to be rebuilt on
60 upgrade to this version. If you listed your wiki in
61 /etc/ikiwiki/wikilist this will be done automatically when the
62 Debian package is upgraded. Or use ikiwiki-mass-rebuild to force
65 -- Joey Hess <joeyh@debian.org> Tue, 25 Aug 2009 17:24:43 -0400
67 ikiwiki (3.13) unstable; urgency=low
69 The `ikiwiki-transition deduplinks` command introduced in the
70 last release was buggy. If you followed the NEWS file instructions
71 and ran it, you should run `ikiwiki -setup` to rebuild your wiki
74 -- Joey Hess <joeyh@debian.org> Fri, 22 May 2009 13:04:02 -0400
76 ikiwiki (3.12) unstable; urgency=low
78 You may want to run `ikiwiki-transition deduplinks your.setup`
79 after upgrading to this version of ikiwiki. This command will
80 optimise your wiki's saved state, removing duplicate information
81 that can slow ikiwiki down.
83 -- Joey Hess <joeyh@debian.org> Wed, 06 May 2009 00:25:06 -0400
85 ikiwiki (3.01) unstable; urgency=low
87 If your wiki uses git, and you have a `diffurl` configured in
88 its setup file, you should be aware that gitweb has stopped
89 supporting the url form commonly used for the `diffurl`.
91 You can change your setup to use the newer gitweb url form:
93 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]]
95 The changes from the old form are the addition of the `hpb` parameter,
96 and the change to the value used for the `hb` parameter.
98 -- Joey Hess <joeyh@debian.org> Mon, 05 Jan 2009 18:18:05 -0500
100 ikiwiki (3.00) unstable; urgency=low
102 The 3.0 release of ikiwiki changes several defaults and finishes
103 some transitions. You will need to modify your wikis to work with
104 ikiwiki 3.0. A document explaining the process is available
105 in </usr/share/doc/ikiwiki/html/tips/upgrade_to_3.0.html>
107 -- Joey Hess <joeyh@debian.org> Tue, 23 Dec 2008 16:14:18 -0500
109 ikiwiki (2.62) unstable; urgency=low
111 TexImg standard preamble changed
113 The teximg plugin now has a configurable LaTeX preamble.
114 As part of this change the `mchem` LaTeX package has been removed from
115 the default LaTeX preamble as it wasn't included in many TeX installations.
117 The previous behaviour can be restored by adding the following to your
120 teximg_prefix => '\documentclass{scrartcl}
121 \usepackage[version=3]{mhchem}
123 \usepackage{amsfonts}
128 In addition, the rendering mechanism has been changed to use `dvipng` by
129 default, if available.
131 -- Joey Hess <joeyh@debian.org> Sun, 24 Aug 2008 15:00:40 -0400
133 ikiwiki (2.60) unstable; urgency=low
135 Admin preferences are moving from the web interface to the setup file.
136 There are three new options in the setup file: `locked_pages`, `banned_users`,
137 and `allowed_attachments`. The admin prefs page can still be used, but
138 that's deprecated, and the prefs will be hidden if a value is not already
139 set. If a value is set in the web interface, you're encouraged to move that
140 setting to your setup file now, since version 3.0 will remove the deprecated
141 admin prefs web interface.
143 Also, the layout of the setup file has changed in a significant way in this
144 release. Old setup files will continue to work, but new features, like the
145 new websetup interface, require a new format setup file. You can convert
146 old setup files into the new format by running
147 `ikiwiki-transition setupformat ikiwiki.setup`
149 -- Joey Hess <joeyh@debian.org> Fri, 01 Aug 2008 17:02:14 -0400
151 ikiwiki (2.52) unstable; urgency=low
153 All wikis need to be rebuilt on upgrade to this version. If you listed your
154 wiki in /etc/ikiwiki/wikilist this will be done automatically when the
155 Debian package is upgraded. Or use ikiwiki-mass-rebuild to force a rebuild.
157 -- Joey Hess <joeyh@debian.org> Sun, 06 Jul 2008 15:10:05 -0400
159 ikiwiki (2.49) unstable; urgency=low
161 The search plugin no longer uses hyperestraier. Instead, to use it you
162 will now need to install xapian-omega, and the Search::Xapian,
163 HTML::Scrubber, and Digest::SHA1 perl modules. Ie,
164 `apt-get install xapian-omega libsearch-xapian-perl libhtml-scrubber-perl libdigest-sha1-perl`
166 Also, wikis that use the search plugin will need to be rebuilt,
167 since the search form has changed. This will not be done automatically,
168 but can be done by running `ikiwiki-mass-upgrade` as root, or
169 running `ikiwiki -setup` on individual setup files.
171 -- Joey Hess <joeyh@debian.org> Wed, 04 Jun 2008 00:29:28 -0400
173 ikiwiki (2.48) unstable; urgency=high
175 If you allowed password based logins to your wiki, those passwords were
176 stored in cleartext in the userdb. To guard against exposing users'
177 passwords, I recommend you install the Authen::Passphrase perl module, and
178 then run `ikiwiki-transition hashpassword /path/to/srcdir` to replace all
179 existing cleartext passwords with strong (blowfish) hashes.
181 -- Joey Hess <joeyh@debian.org> Thu, 29 May 2008 14:39:34 -0400
183 ikiwiki (2.46) unstable; urgency=low
185 There were some significant template changes in ikiwiki 2.42 (and 1.33.5).
186 If you have locally modified versions of the templates, they need to be
187 updated. Most notably, the editpage.tmpl has a new FIELD-SID added to it,
188 without which web editing will fail.
190 -- Joey Hess <joeyh@debian.org> Tue, 06 May 2008 14:30:14 -0400
192 ikiwiki (2.40) unstable; urgency=low
194 ikiwiki now has an new syntax for preprocessor directives, using the
199 This new syntax no longer relies on spaces to distinguish between
200 wikilinks and preprocessor directives. Thus, wikilinks can use spaces
201 in their link text, and preprocessor directives without arguments (such
202 as "toc") need not use a trailing space.
204 To enable the new syntax, set prefix_directives to true in your ikiwiki
205 config. For backward compatibility with existing wikis,
206 prefix_directives currently defaults to false. In ikiwiki 3.0,
207 prefix_directives will default to true, and wikis which have not yet
208 converted to the new syntax will need to set prefix_directives to false
209 in their setup files.
211 To convert your wiki to the new syntax, ikiwiki provides a new script
214 Even with prefix_directives disabled, ikiwiki now allows an optional '!'
215 prefix on preprocessor directives (but still requires a space). Thus, a
216 directive which uses a '!' prefix and contains a space will work with
217 ikiwiki 2.40 and newer, regardless of the value of prefix_directives.
218 This allows the underlay to work with all ikiwikis.
220 -- Josh Triplett <josh@freedesktop.org> Sat, 26 Jan 2008 16:26:47 -0800
222 ikiwiki (2.30) unstable; urgency=low
224 Ever feel that ikiwiki's handling of RecentChanges wasn't truely in the
225 spirit of a wiki compiler? Well, that's changed. The RecentChanges page is
226 now a static page, not a CGI. Users can subscribe to its rss/atom feeds.
227 Custom RecentChanges pages can be easily set up that display only changes
228 to a subset of pages, or only changes by a subset of users.
230 All wikis need to be rebuilt on upgrade to this version. If you listed your
231 wiki in /etc/ikiwiki/wikilist this will be done automatically when the
232 Debian package is upgraded. Or use ikiwiki-mass-rebuild to force a rebuild.
234 With this excellent new RecentChanges support, the mail notification system
235 is its age (and known to be variously buggy and underimplemented for
236 various VCSes), and so ikiwiki's support for sending commit mails is REMOVED
237 from this version. If you were subscribed to commit mails, you should be
238 able to accomplish the same thing by subscribing to a RecentChanges feed.
240 The "notify" field in setup files is no longer used, and
241 silently ignored. You may want to remove it from your setup file.
243 -- Joey Hess <joeyh@debian.org> Tue, 29 Jan 2008 17:18:31 -0500
245 ikiwiki (2.20) unstable; urgency=low
247 The template plugin has begin to htmlize the variables passed to templates.
248 This is normally what you want, but to get the old behavior and get at the
249 raw value, you can use `<TMPL_VAR raw_variable>` in a template.
251 -- Joey Hess <joeyh@debian.org> Sat, 08 Dec 2007 16:04:43 -0500
253 ikiwiki (2.16) unstable; urgency=low
255 Many of the pages in ikiwiki's basewiki have been moved and renamed in this
256 release, to avoid the basewiki including pages with names like "blog".
257 Redirection pages have been left behind for these moved pages temporarily,
258 and will be removed later.
260 If you use the calendar plugin, ikiwiki is now smarter and your nightly
261 cron job to update the wiki doesn't need to rebuild everything. Just pass
262 --refresh to ikiwiki in the cron job and it will update only pages that
263 contain out of date calendars.
265 -- Joey Hess <joeyh@debian.org> Sat, 08 Dec 2007 16:04:43 -0500
267 ikiwiki (2.14) unstable; urgency=low
269 This version of ikiwiki is more picky about symlinks in the path leading
270 to the srcdir, and will refuse to use a srcdir specified by such a path.
271 This was necessary to avoid some potential exploits, but could potentially
272 break (semi-)working wikis. If your wiki has a srcdir path containing a
273 symlink, you should change it to use a path that does not.
275 -- Joey Hess <joeyh@debian.org> Mon, 26 Nov 2007 14:57:57 -0500
277 ikiwiki (2.9) unstable; urgency=low
279 Since ikiwiki 2.0 was released, some limitiations have been added to what
280 ikiwiki considers a WikiLink. In short, if there are any spaces in between
281 the brackets, ikiwiki no longer considers it to be a WikiLink. If your wiki
282 contains things meant to be WikiLinks that contain spaces, you will need to
283 fix them, by replacing the spaces with underscores.
285 WikiLink have always been documented to not contain spaces, but bugs in
286 ikiwiki made it treat some text with spaces as WikiLinks. Most of these
287 bugs were fixed in version 2.2, and a final bug was fixed in this 2.9
288 release. These fixes are necessary to avoid ambiguity between
289 WikiLinks and PreProcessorDirectives. Apologies for any inconvenience
290 these bugs (and their fixes) may have caused.
292 -- Joey Hess <joeyh@debian.org> Sat, 29 Sep 2007 14:37:18 -0400
294 ikiwiki (2.6) unstable; urgency=low
296 In this version the rst plugin allows raw html to be embedded in rst files.
297 As long as the htmlscrubber is enabled, this should be safe. If you are
298 using the rst plugin without the htmlscrubber in a publically writable wiki,
299 you should turn on the htmlscrubber.
301 -- Joey Hess <joeyh@debian.org> Sun, 29 Jul 2007 18:37:22 -0400
303 ikiwiki (2.5) unstable; urgency=low
305 Due to some config changes in this version, wrappers need to be rebuilt on
306 upgrade. If you listed your wiki in /etc/ikiwiki/wikilist this will be
307 one automatically when the Debian package is upgraded.
309 -- Joey Hess <joeyh@debian.org> Sun, 29 Jul 2007 17:54:40 -0400
311 ikiwiki (2.1) unstable; urgency=low
313 Some wikis need to be rebuilt on upgrade to this version, due to changes to
314 page templates and the style sheet. If you listed your wiki in
315 /etc/ikiwiki/wikilist this will be done automatically when the Debian
316 package is upgraded. Or use ikiwiki-mass-rebuild to force a rebuild.
318 -- Joey Hess <joeyh@debian.org> Thu, 26 Apr 2007 15:50:36 -0400
320 ikiwiki (2.00) unstable; urgency=low
322 With the 2.0 release of ikiwiki, some major changes have been made to the
323 default configuration:
325 * The 'usedirs' setting is enabled by default. This *will* break all URLs
326 to wikis that did not have 'usedirs' turned on before, unless you follow
327 the procedure described at <http://ikiwiki.info/tips/switching_to_usedirs>,
328 or edit your setup file to turn usedirs off:
331 * OpenID logins are now enabled by default, if the Net::OpenID::Consumer
332 perl module is available. Password logins are also still enabled
333 by default. If you like, you can turn either OpenID or password logins
334 off via the 'disable_plugins' setting.
336 -- Joey Hess <joeyh@debian.org> Sun, 29 Apr 2007 19:00:43 -0400
338 ikiwiki (1.51) unstable; urgency=low
340 Some wikis need to be rebuilt on upgrade to this version, due to changes to
341 page layout and the style sheet. If you listed your wiki in
342 /etc/ikiwiki/wikilist this will be done automatically when the Debian
343 package is upgraded. Or use ikiwiki-mass-rebuild to force a rebuild.
345 -- Joey Hess <joeyh@debian.org> Thu, 26 Apr 2007 15:50:36 -0400
347 ikiwiki (1.50) unstable; urgency=low
349 Permalinks and guids in rss and atom feeds for wikis using the usedirs
350 options will change in this release. If you have already enabled usedirs,
351 you may need to take steps to avoid flooding aggregators.
353 -- Joey Hess <joeyh@debian.org> Sat, 14 Apr 2007 16:08:46 -0400
355 ikiwiki (1.49) unstable; urgency=low
357 Third-party plugins that use htmlpage() or abs2rel() to generate links
358 may need changes to support the new "usedirs" option.
360 -- Joey Hess <joeyh@debian.org> Sun, 01 Apr 2007 16:20:09 -0400
362 ikiwiki (1.47) unstable; urgency=low
364 Due to a security fix, wikis that have the htmlscrubber enabled can no
365 longer use the meta plugin to insert html link and meta tags.
367 Some special case methods have been added for safely including stylesheets,
368 and for doing openid delegation. See the meta plugin docs for details.
370 -- Joey Hess <joeyh@debian.org> Wed, 21 Mar 2007 14:18:40 -0400
372 ikiwiki (1.45) unstable; urgency=low
374 Wikis need to be rebuilt on upgrade to this version. If you listed your wiki
375 in /etc/ikiwiki/wikilist this will be done automatically when the Debian
376 package is upgraded. Or use ikiwiki-mass-rebuild to force a rebuild.
378 -- Joey Hess <joeyh@debian.org> Wed, 7 Mar 2007 23:02:52 -0500
380 ikiwiki (1.44) unstable; urgency=low
382 The htmllink() function has changed slightly and plugins that use it may
383 need to change how they call it. This function's first three parameters
384 are unchanged, but additional options are now passed using named
385 parameters. If you used htmllink with more than 3 parameters, you will
386 need to change it. The plugin interface version has been increased to 1.02
387 to reflect this change.
389 -- Joey Hess <joeyh@debian.org> Mon, 19 Feb 2007 21:10:12 -0500
391 ikiwiki (1.42) unstable; urgency=low
393 The anonok setting in config files has been removed. To enable
394 httpauth support on your wiki, you should now enable the anonok plugin,
397 Third-party plugins that use pagespec_match() should be updated to pass
398 the new third parameter (from) to that function. This is needed for the
399 new relative glob matching to work.
401 -- Joey Hess <joeyh@debian.org> Thu, 1 Feb 2007 16:57:59 -0500
403 ikiwiki (1.34) unstable; urgency=low
405 The httpauth setting in config files has been removed. To enable
406 httpauth support on your wiki, you should now enable the httpauth plugin,
409 This release includes OpenID support that is enabled through the openid
410 plugin. I recommend turning this on to make it easier for users to sign
413 -- Joey Hess <joeyh@debian.org> Sun, 19 Nov 2006 20:53:05 -0500
415 ikiwiki (1.32) unstable; urgency=low
417 There is a change to the plugin interface in this version. Any plugins that
418 modify data in %links should pass scan => 1 when registering the hook that
421 -- Joey Hess <joeyh@debian.org> Sat, 28 Oct 2006 00:13:12 -0400
423 ikiwiki (1.29) unstable; urgency=low
425 Wikis need to be rebuilt on upgrade to this version. If you listed your wiki
426 in /etc/ikiwiki/wikilist this will be done automatically when the Debian
427 package is upgraded. Or use ikiwiki-mass-rebuild to force a rebuild.
429 There is a change to the plugin interface in this version. Plugins that use
430 %renderedfiles will need to be updated, as the hash's values are now arrays
431 of rendered files. Plugins that cause a page to render additional files
432 should use the new will_render function to register the files.
434 -- Joey Hess <joeyh@debian.org> Sun, 8 Oct 2006 17:27:56 -0400
436 ikiwiki (1.22) unstable; urgency=low
438 Due to some changes in the CSS, wikis should be rebuilt on upgrade to this
439 version. If you listed your wiki in /etc/ikiwiki/wikilist this will be done
440 automatically when the Debian package is upgraded. Or use ikiwiki-mass-rebuild
443 If you have modified versions of ikiwiki's html templates, you will need
444 to update your templates to link to the stylesheet file using
445 "<TMPL_VAR BASEURL>style.css" instead of the old method which used
448 There have also been some changes to the plugin interface:
449 Any plugins that use santize, htmlize, or format hooks will need to be
450 updated for this version of ikiwiki since these hooks have been changed
451 to use named parameters.
453 -- Joey Hess <joeyh@debian.org> Tue, 22 Aug 2006 15:33:12 -0400
455 ikiwiki (1.13) unstable; urgency=low
457 The GlobList format which was used for specifiying sets of pages, has been
458 replaced with a new, more expressive PageSpec format. While GlobLists will
459 continue to work, that format is deprecated, and you are encouraged to use
460 PageSpecs from now on, and also to change any GlobLists in your wiki to
461 PageSpecs. See the new PageSpec page for details.
463 You will need to rebuild your wiki when upgrading to this version. If you
464 listed your wiki in /etc/ikiwiki/wikilist this will be done automatically
465 when the Debian package is upgraded. Or use ikiiki-mass-rebuild to force a
468 -- Joey Hess <joeyh@debian.org> Tue, 1 Aug 2006 18:29:51 -0400
470 ikiwiki (1.11) unstable; urgency=low
472 Some changes to tags in this release, due to a new tag plugin. If you have
473 been using the meta plugin to tag pages, you'll want to enable the tag
474 plugin too, and change things like this:
476 [[meta link="foobar"]]
482 The new tags will appear at page footers, and are also easier to type.
484 There have also been some changes to the plugin interface, particularly the
485 interface of pagetemplate hooks has changed. See the changelog for details.
487 -- Joey Hess <joeyh@debian.org> Thu, 27 Jul 2006 17:03:09 -0400
489 ikiwiki (1.8) unstable; urgency=low
491 If your wiki is configured with a setup file, you should modify it to
492 stop setting the "plugin" list directly, and instead add or remove plugins
493 via the add_plugins and disable_plugins lines. For example, if you had:
495 plugin => [qw{inline smiley search}],
497 Change it to these lines, which disables the default htmlscrubber plugin
498 and adds the two additional plugins:
500 add_plugins => [qw{smiley search}],
501 disable_plugins => [qw{htmlscrubber}],
503 Making this change makes your ikiwiki setup file more future-proof since
504 new default plugins will be automatically used.
506 You will need to rebuild your ikiwiki wrappers when upgrading to this
507 version. If you listed your wiki in /etc/ikiwiki/wikilist this will be
508 done automatically when the Debian package is upgraded. Or use
509 ikiiki-mass-rebuild --refresh to force a refresh.
511 -- Joey Hess <joeyh@debian.org> Mon, 3 Jul 2006 16:59:29 -0400
513 ikiwiki (1.1) unstable; urgency=low
515 There have been several configuration changes in this release of ikiwiki:
517 The --svn and --no-svn switches are removed, instead you should use
518 --rcs=svn or --no-rcs. ikiwiki setup files that set svn => 1 should
519 be changed to set rcs => "svn"; if your setup file sets svn => 0
520 then change it to use rcs => "" to disable svn.
522 The --hyperestraier switch is gone too. To enable searching, turn on the
523 search plugin, by passing --plugin=search or through the plugin setting in
526 The --sanitize and --no-sanitize switches are also gone, replaced with the
527 htmlscrubber plugin. This plugin is enabled by default, to disable it,
528 use --disable-plugin=htmlscrubber, or modify the plugin setting in the
531 Discussion pages are enabled by default, but if your wiki is configured
532 with a setup file, you need to edit it to keep them enabled on upgrade
533 to this version. Add a line reading:
536 You will need to rebuild your wiki when upgrading to this version.
537 If you listed your wiki in /etc/ikiwiki/wikilist this will be done
538 automatically when the Debian package is upgraded. Or use
539 ikiiki-mass-rebuild to force a rebuild.
541 -- Joey Hess <joeyh@debian.org> Tue, 2 May 2006 14:13:59 -0400