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