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