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