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