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