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