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