web commit by joey
[ikiwiki.git] / doc / news / version_1.1.mdwn
1 ikiwiki 1.1 is now released.
2
3 There have been several configuration changes in this release of ikiwiki:
4
5 * The --svn and --no-svn switches are removed, instead you should use
6    --rcs=svn or --no-rcs. ikiwiki setup files that set svn => 1 should
7   be changed to set rcs => "svn"; if your setup file sets svn => 0
8   then change it to use rcs => "" to disable svn.
9
10 * The --hyperestraier switch is gone too. To enable searching, turn on the
11   search plugin, by passing --plugin=search or through the plugin setting in
12   the setup file.
13
14 * The --sanitize and --no-sanitize switches are also gone, replaced with the
15   htmlscrubber plugin. This plugin is enabled by default, to disable it,
16   use --disable-plugin=htmlscrubber, or modify the plugin setting in the
17   setup file.
18
19 * Discussion pages are enabled by default, but if your wiki is configured
20   with a setup file, you need to edit it to keep them enabled on upgrade
21   to this version. Add a line reading:
22         discussion => 1,
23
24 You will need to rebuild your wiki when upgrading to this version.
25 If you listed your wiki in /etc/ikiwiki/wikilist this will be done
26 automatically when the Debian package is upgraded. Or use
27 ikiiki-mass-rebuild to force a rebuild.
28
29 Here's the full list of changes in ikiwiki 1.1:
30
31    * Rename inlinepage to depends, so that it can be used to refer to more
32      dependency relationships than just inlining. This will require a rebuild
33      on upgrade to this version.
34    * Move the rss link, put it in the blogpost form if there is one and at the
35      top if not. This is both nicer because easier to find, and it cleans up
36      the code which had used inlinepage as a flag for adding the link later.
37    * Allow the depends GlobList to be built up from multiple sources (such as
38      plugins) during a page render.
39    * Which means that more than one blog is now supported to appear on a
40      single page. (With some limitations, like only the last one getting an
41      rss file.)
42    * Added a plugin system.
43    * Added a pagecount plugin, enabled by default.
44    * Support PreProcessorDirectives with no parameters, ie "[[pagecount ]]".
45    * Fixed/optimised backlinks code, to avoid rebuilding pages to update
46      backlinks when the backlinks hadn't really changed.
47    * Moved inline page support, rss generation etc into the inline plugin,
48      enabled by default.
49    * Added brokenlinks plugin, not enabled by default, but rather handy.
50    * Fix several broken links in the doc wiki.
51    * Smarter behavior when creating a page and a page of the same name (but
52      different location) already exists.
53    * Add an orphans plugin for finding pages that nothing links to.
54    * Removed backlinks page, which it turns out nothing used.
55    * Split off an IkiWiki.pm out of ikiwiki and have all the other modules use
56      it, this will allow for adding a unit test suite.
57    * Add unit tests for several core functions, including globlist\_match,
58      dirname, basename, bestlink, linkify, pagetitle, titlepage.
59    * Smart globlist merging.
60    * Patch from Thomas Schwinge to switch from --svn to --rcs=svn, etc,
61      to pave the way for adding other RCS support. This also changes the
62      setup files, where before they had svn => 1 or svn => 0, now they have
63      rcs => "svn" or rcs => "".
64    * Add a debian/NEWS file with upgrade notes.
65    * Load whatever rcs module is specified, so new ones can be just dropped in
66      as plugins and work. (Well, in theory.)
67    * Add some basic docs about writing RCS modules.
68    * Broke search capability out into a plugin, removed the --hyperestraier
69      switch.
70    * Added smiley plugin, nicely controlled and documented by the smileys page.
71    * Copied in some smileys from Moin Moin.
72    * Allow links of the form \\[[some page|page]], with whitespace in the link
73      text.
74    * Removed --sanitize and --no-sanitize, replaced with --plugin htmlscrubber
75      and --disable-plugin htmlscrubber.
76    * Allow discussion links on pages to be turned off with --no-discussion.
77    * Add ikiwiki-mass-rebuild script, ripped out of the postinst.
78    * Add some new config items to the estseek.conf template, which are needed
79      by hyperestraier 1.2.3.