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