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