ikiwiki (3.20130711) unstable; urgency=low
[ikiwiki.git] / doc / tips / switching_to_usedirs.mdwn
1 As of version 2.0, ikiwiki will switch to enabling the 'usedirs' setting by
2 default. This *will* break all URLs to wikis that did not have 'usedirs'
3 turned on before. You can either follow this procedure to convert your wiki
4 to usedirs, or edit your setup file and turn usedirs back off.
5
6 * Upgrade ikiwiki to 2.0.
7 * Force ikiwiki to rebuild your wiki, by using `ikiwiki-mass-rebuild`,
8   or manually.
9 * Since usedirs is enabled, ikiwiki will have created a bunch of new
10   html files. Where before ikiwiki generated a `dest/foo.html`, now it will
11   generate `dest/foo/index.html`. The old html files will be removed.
12 * If you have a blog that is aggregated on a Planet or similar, all the
13   items in the RSS or atom feed will seem like new posts, since their URLs
14   have changed. See [[howto_avoid_flooding_aggregators]] for a workaround.
15 * Now all the URLs to pages in your wiki have changed. See
16   [[redirections_for_usedirs]] for instructions on setting up redirections
17   to keep the old URLs working.
18
19 Why usedirs?
20 ------------
21 There are several advantages to `usedirs`, including simpler URLs, URLs that
22 aren't dependent on the underlying implementation (`.html`), and being able to
23 use URLs as tags as described in the [rel-tag
24 microformat](http://microformats.org/wiki/rel-tag).
25
26 The main disadvantage is that it is harder to browse using `file://` URIs,
27 since `file:///dir/` doesn't automatically translate to `dir/index.html`. This
28 is something one could fix in the browser though.