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