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