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