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