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