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