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