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