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