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