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