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