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