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