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