Merge branch 'master' into aggregateinternal
[ikiwiki.git] / doc / ikiwiki-transition.mdwn
1 # NAME
2
3 ikiwiki-transition - transition ikiwiki pages to new syntaxes, etc
4
5 # SYNOPSIS
6
7 ikiwiki-transition type ...
8
9 # DESCRIPTION
10
11 `ikiwiki-transition` aids in converting wiki pages when
12 there's a major change in ikiwiki syntax. It also handles other transitions
13 not involving wiki pages.
14
15 # prefix_directives
16
17 The `prefix_directives` mode converts the specified ikiwiki page from
18 the old preprocessor directive syntax, requiring a space, to the new
19 syntax, prefixed by '!'.
20
21 Preprocessor directives which already use the new syntax will remain
22 unchanged.
23
24 Note that if the page contains wiki links with spaces, which some
25 older versions of ikiwiki accepted, the prefix_directives transition will
26 treat these as preprocessor directives and convert them.
27
28 # aggregateinternal
29
30 The `aggregateinternal` mode moves pages aggregated by the aggregate plugin
31 so that the `aggregateinternal` option can be endabled 
32
33 # indexdb
34
35 The `indexdb` mode handles converting a plain text `.ikiwiki/index` file to
36 a binary `.ikiwiki/indexdb`. In this mode, you should specify the srcdir of
37 the wiki as the second parameter. You do not normally need to run
38 `ikiwiki-transition indexdb`; ikiwiki will automatically run it as
39 necessary.
40
41 # hashpassword
42
43 The `hashpassword` mode forces any plaintext passwords stored in the
44 `.ikiwiki/userdb` file to be replaced with password hashes. (The
45 Authen::Passphrase perl module is needed to do this.) In this mode, you
46 should specify the srcdir of the wiki as the second parameter. 
47
48 If this is not done explicitly, a user's plaintext password will be
49 automatically converted to a hash when a user logs in for the first time
50 after upgrade to ikiwiki 2.48.
51
52 # AUTHOR
53
54 Josh Triplett <josh@freedesktop.org>, Joey Hess <joey@ikiwiki.info>
55
56 Warning: this page is automatically made into ikiwiki-transition's man page, edit with care