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