]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blob - doc/ikiwiki-transition.mdwn
response
[git.ikiwiki.info.git] / doc / ikiwiki-transition.mdwn
1 # NAME
3 ikiwiki-transition - transition ikiwiki pages to new syntaxes, etc
5 # SYNOPSIS
7 ikiwiki-transition type ...
9 # DESCRIPTION
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.
15 # prefix_directives
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 '!'.
21 Preprocessor directives which already use the new syntax will remain
22 unchanged.
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.
28 # setupformat
30 The `setupformat` mode converts a setup file from using a single `wrappers` block
31 to using `cgi_wrapper`, `git_wrapper`, etc.
33 Note that all comments and any unusual stuff like perl code in the setup
34 file will be lost, as it is entirely rewritten by the transition.
36 # aggregateinternal
38 The `aggregateinternal` mode moves pages aggregated by the aggregate plugin
39 so that the `aggregateinternal` option can be enabled.
41 # indexdb
43 The `indexdb` mode handles converting a plain text `.ikiwiki/index` file to
44 a binary `.ikiwiki/indexdb`. In this mode, you should specify the srcdir of
45 the wiki as the second parameter. You do not normally need to run
46 `ikiwiki-transition indexdb`; ikiwiki will automatically run it as
47 necessary.
49 # hashpassword
51 The `hashpassword` mode forces any plaintext passwords stored in the
52 `.ikiwiki/userdb` file to be replaced with password hashes. (The
53 Authen::Passphrase perl module is needed to do this.) In this mode, you
54 should specify the srcdir of the wiki as the second parameter. 
56 If this is not done explicitly, a user's plaintext password will be
57 automatically converted to a hash when a user logs in for the first time
58 after upgrade to ikiwiki 2.48.
60 # AUTHOR
62 Josh Triplett <josh@freedesktop.org>, Joey Hess <joey@ikiwiki.info>
64 Warning: this page is automatically made into ikiwiki-transition's man page, edit with care