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